Files
compass_teams_nhs/scripts/morning-brief.sh
Sam Rolfe 09639c5125 Phase 7: notify and send via Apprise (Email + WhatsApp)
The morning briefs go out through the house Apprise API on `.35:8210`: one
brief per boy and one combined brief to Jo and Sam (FR-9, FR-14). The service
names an Apprise tag (`harry_email`, `joanna_whatsapp`, ...) and never holds an
address, a phone number or an SMTP password (AGENTS.md §10 rule 3).

- internal/apprise: keyed and stateless client, tag filtering, and error
  redaction so nothing sensitive reaches a log, a row or a screen.
- internal/brief: builds the per-boy and the combined brief, delivers on email
  and WhatsApp, records every attempt in `notifications` (migration 004 adds
  scope, channel, tag, ok and error) and fails loudly.
- Send panel (§5 screen 4): recipients, channels, an exact preview, Send now,
  plus the Send action on a stored draft (FR-10). The dashboard shows a
  Morning briefs banner and the Sends list.
- POST /notify/morning: the bearer-token endpoint the 6:00am n8n schedule
  calls. 207 when a channel or a scan failed; `dry_run=1` checks the wiring
  without messaging the family.
- scripts/morning-brief.sh: scan both children, then send. It is the n8n job;
  deploy/n8n-morning-brief.json is the ready-to-import workflow (06:00 daily).
- FR-12: a failed scan is never "nothing due" -- the brief says so, and the run
  exits non-zero. A failed delivery is recorded with no sent_at.
- The long no-due-date tail is capped in the sent brief so it stays brief
  (§10 rule 6); overdue work is never capped.

Verified live: 8 deliveries recorded (4 email, 4 WhatsApp) with HTTP 200 and
sent_at, and the endpoint answers 401/200/207 as documented. Evidence in
docs/phase-7-notify-notes.md.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-10-15 19:28:05 +11:00

112 lines
4.3 KiB
Bash
Executable File

#!/usr/bin/env bash
# Phase 7: the morning run (AGENTS.md §4 FR-9, FR-14, §11 Phase 7).
#
# This is the bounded command the 6:00am n8n schedule runs:
# 1. scan Compass for both children (read-only; skipped with --no-scan),
# 2. build one brief per boy and one combined brief to Jo and Sam,
# 3. deliver them through the house Apprise API on `.35:8210`,
# 4. record every delivery in `notifications` and every exit code loudly.
#
# A failed scan is never reported as "nothing due" (FR-12): the brief opens with
# the failure, and this script exits non-zero so the n8n execution is visibly
# failed.
#
# Secrets: no address, phone number or password is passed on the command line.
# The Apprise configuration key comes from environment.d/school-service.env and
# is only exported into the container environment.
#
# Usage:
# scripts/morning-brief.sh # scan, then send
# scripts/morning-brief.sh --no-scan # send from the latest scan
# scripts/morning-brief.sh --dry-run # build and print, send nothing
# scripts/morning-brief.sh --channel email # limit the channels
#
# Environment overrides:
# IMAGE image tag (default 0.5.0-phase7)
# VOLUME SQLite volume (default compass-teams-nhs_compass-teams-nhs-data)
# ENV_FILE service env file (default environment.d/school-service.env)
# SCHOOL_TIMEZONE family timezone (default Australia/Sydney)
# DOCKER_TIMEOUT per docker command timeout (default 600)
set -euo pipefail
REPO_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
IMAGE="${IMAGE:-compass-teams-nhs/school:0.5.0-phase7}"
VOLUME="${VOLUME:-compass-teams-nhs_compass-teams-nhs-data}"
ENV_FILE="${ENV_FILE:-$REPO_ROOT/environment.d/school-service.env}"
SCHOOL_TIMEZONE="${SCHOOL_TIMEZONE:-Australia/Sydney}"
DOCKER_TIMEOUT="${DOCKER_TIMEOUT:-600}"
NO_SCAN=0
NOTIFY_ARGS=()
while [[ $# -gt 0 ]]; do
case "$1" in
--no-scan) NO_SCAN=1; shift ;;
--dry-run) NOTIFY_ARGS+=(--dry-run); shift ;;
--channel) NOTIFY_ARGS+=(--channel "$2"); shift 2 ;;
--only) NOTIFY_ARGS+=(--only "$2"); shift 2 ;;
*) echo "unknown argument: $1" >&2; exit 2 ;;
esac
done
# Take only the notification variables from the service env file, so the
# service's bcrypt hash (which contains "$$") is never re-expanded here.
if [[ -f "$ENV_FILE" ]]; then
while IFS= read -r line; do
case "$line" in
SCHOOL_APPRISE_URL=*|SCHOOL_APPRISE_KEY=*|SCHOOL_APPRISE_TOKEN=*|SCHOOL_APPRISE_TIMEOUT=*|\
SCHOOL_APPRISE_CHANNELS=*|SCHOOL_APPRISE_TAGS=*|SCHOOL_APPRISE_PARENTS=*|SCHOOL_NOTIFY_TOKEN=*)
key="${line%%=*}"
val="${line#*=}"
if [[ -z "${!key:-}" ]]; then
export "$key=$val"
fi
;;
esac
done < "$ENV_FILE"
fi
if [[ -z "${SCHOOL_APPRISE_KEY:-}" ]]; then
echo "SCHOOL_APPRISE_KEY is not set in $ENV_FILE: the briefs cannot be sent" >&2
exit 2
fi
run_school() {
timeout "$DOCKER_TIMEOUT" docker run --rm --network host \
-v "$VOLUME:/data" \
-e SCHOOL_DB_PATH=/data/school.db \
-e SCHOOL_TIMEZONE="$SCHOOL_TIMEZONE" \
-e SCHOOL_APPRISE_URL="${SCHOOL_APPRISE_URL:-}" \
-e SCHOOL_APPRISE_KEY="${SCHOOL_APPRISE_KEY:-}" \
-e SCHOOL_APPRISE_TOKEN="${SCHOOL_APPRISE_TOKEN:-}" \
-e SCHOOL_APPRISE_TIMEOUT="${SCHOOL_APPRISE_TIMEOUT:-}" \
-e SCHOOL_APPRISE_CHANNELS="${SCHOOL_APPRISE_CHANNELS:-}" \
-e SCHOOL_APPRISE_TAGS="${SCHOOL_APPRISE_TAGS:-}" \
-e SCHOOL_APPRISE_PARENTS="${SCHOOL_APPRISE_PARENTS:-}" \
"$IMAGE" "$@"
}
# 1. Scan both children. A failed scan is already loud in the scan log; keep
# going so the brief can carry the failure notice instead of silence.
scan_rc=0
if [[ "$NO_SCAN" -eq 0 ]]; then
echo "== scan both children =="
if ! IMAGE="$IMAGE" VOLUME="$VOLUME" timeout "$DOCKER_TIMEOUT" "$REPO_ROOT/scripts/scan-compass.sh"; then
scan_rc=$?
echo "scan reported a failure (exit $scan_rc); the briefs will say so" >&2
fi
fi
# 2. Build and send the briefs.
echo "== send the morning briefs =="
notify_rc=0
if ! run_school notify run "${NOTIFY_ARGS[@]+"${NOTIFY_ARGS[@]}"}"; then
notify_rc=$?
fi
if [[ "$scan_rc" -ne 0 || "$notify_rc" -ne 0 ]]; then
echo "morning brief FAILED: scan_rc=$scan_rc notify_rc=$notify_rc" >&2
exit 1
fi
echo "morning brief complete: both boys + the combined brief to Jo and Sam"