rbrooks/WeatherBot

Watch

Fork 0

Migrate richer channels onto the shared notification formatter #14

New issue

Closed

opened 2026-06-23 23:15:17 +00:00 by rbrooks · 2 comments

rbrooks commented

2026-06-23 23:15:17 +00:00

Owner

Target release: v1.2.0

SMS already uses the shared formatter and 140-char budget. Gradually move the richer channels (Discord, Matrix, Signal, Pushover, Webex, Webhook) onto app/services/notification_formatting.py with per-channel budgets/profiles and truncation metadata.

Acceptance

Per-channel message budgets and formatting profiles defined.
Each richer notifier returns text + metadata (char count, link count, truncation status, omitted sections).
Verbose official text pushed to linked detail pages; compact "Details" link in a predictable place.

Source: docs/ROADMAP.md → Notification Message Budget and Compact Link System.

**Target release:** v1.2.0 SMS already uses the shared formatter and 140-char budget. Gradually move the richer channels (Discord, Matrix, Signal, Pushover, Webex, Webhook) onto `app/services/notification_formatting.py` with per-channel budgets/profiles and truncation metadata. **Acceptance** - [ ] Per-channel message budgets and formatting profiles defined. - [ ] Each richer notifier returns text + metadata (char count, link count, truncation status, omitted sections). - [ ] Verbose official text pushed to linked detail pages; compact "Details" link in a predictable place. Source: `docs/ROADMAP.md` → Notification Message Budget and Compact Link System.

rbrooks added the

area:notifications

type:feature

v1.2.0

labels

2026-06-23 23:16:44 +00:00

rbrooks added this to the v1.2.0 - Notification formatting & delivery reliability milestone

2026-06-23 23:23:18 +00:00

claude-bot referenced this issue

2026-07-18 05:31:16 +00:00

Notification delivery is at-most-once — failed dispatches are never retried (design + outbox) #50

claude-bot referenced this issue

2026-07-18 05:31:20 +00:00

Per-type channel config validation + defensive notifier parsing + schema length caps #55

claude-bot commented

2026-07-18 05:32:12 +00:00

Contributor

Audit note (2026-07-18)

From the 2026-07 codebase audit (docs/.internal/report-2026-07-17.md), finding F-32.

The shared formatter's budget math is codepoint-based — len() against a flat 140 (app/services/notification_formatting.py:35-43,95-117). A single non-GSM-7 character (em dash, curly quote — both common in NWS text, or in a free-text location.name) silently flips carrier encoding to UCS-2 (70 chars/segment), so a message the code considers "fits in budget" can span 2+ real SMS segments.

As part of the per-channel budgets in this issue, make the SMS budget segment-aware (detect GSM-7 vs UCS-2 and budget accordingly), or strip/replace non-GSM-7 characters before budgeting.

Related audit work now scheduled in this milestone (v1.2.0): delivery outbox (#50), pipeline concurrency (#53), per-type channel-config validation (#55), non-blocking Twilio (#56).

## Audit note (2026-07-18) From the 2026-07 codebase audit (`docs/.internal/report-2026-07-17.md`), finding **F-32**. The shared formatter's budget math is codepoint-based — `len()` against a flat 140 (`app/services/notification_formatting.py:35-43,95-117`). A single non-GSM-7 character (em dash, curly quote — both common in NWS text, or in a free-text `location.name`) silently flips carrier encoding to UCS-2 (70 chars/segment), so a message the code considers "fits in budget" can span 2+ real SMS segments. As part of the per-channel budgets in this issue, make the SMS budget **segment-aware** (detect GSM-7 vs UCS-2 and budget accordingly), or strip/replace non-GSM-7 characters before budgeting. Related audit work now scheduled in this milestone (v1.2.0): delivery outbox (#50), pipeline concurrency (#53), per-type channel-config validation (#55), non-blocking Twilio (#56).

claude-bot referenced this issue

2026-07-18 18:52:37 +00:00

Resolve notification formatter open questions #15

rbrooks referenced this issue from a commit

2026-07-18 19:47:19 +00:00

Notification formatter migration, segment-aware SMS, redirect short links, config validation

claude-bot referenced this issue from a pull request that will close it,

2026-07-18 19:47:34 +00:00

v1.2.0 Phase A: formatter migration, segment-aware SMS, redirect links, config validation #99

claude-bot closed this issue

2026-07-18 19:57:11 +00:00

claude-bot commented

2026-07-18 19:57:24 +00:00

Contributor

Done in #99 (merged). The six richer channels (Discord, Matrix, Signal, Pushover, Webex, webhook) now build messages through the shared formatter with per-channel-type budgets and a 3-tier compose() (required / droppable-optional / pinned) that keeps one compact "Details" link in a predictable place. FormattedMessage carries char/link/omitted/encoding/segment metadata. SMS budgeting is segment-aware (F-32: sanitize non-GSM-7 punctuation, else budget at the UCS-2 rate). Each channel's structural shape (Discord embed, Matrix HTML body, Pushover title/url, Webex markdown) is preserved.

Done in #99 (merged). The six richer channels (Discord, Matrix, Signal, Pushover, Webex, webhook) now build messages through the shared formatter with per-channel-type budgets and a 3-tier `compose()` (required / droppable-optional / pinned) that keeps one compact "Details" link in a predictable place. `FormattedMessage` carries char/link/omitted/encoding/segment metadata. SMS budgeting is segment-aware (F-32: sanitize non-GSM-7 punctuation, else budget at the UCS-2 rate). Each channel's structural shape (Discord embed, Matrix HTML body, Pushover title/url, Webex markdown) is preserved.

claude-bot referenced this issue

2026-07-18 19:57:26 +00:00

Resolve notification formatter open questions #15

No milestone

No project

No assignees

2 participants

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

rbrooks/WeatherBot#14

No description provided.

Rows
Columns