wtclaude
24a3cd85b3
ENGAGEMENT.md Phase 7. `user_notifications`, the in-app DeliveryChannel, the
four inbox routes, and the web surface — plus the two pieces earlier phases
assigned here that Phase 7's own acceptance line omits.
Four decisions settled by the org lead before any code:
1. `inapp` defaults to `instant` — the only channel that does. Push wakes a
device somebody is holding and email leaves the building, so both are asked
for; an inbox item is a row on a page the user chose to open. Left `off` the
channel ships dead.
2. The phase takes push's `deliver` (§2603) and the web per-channel preferences
screen (Phase 3's as-built), neither of which its own bullets mention.
3. The inbox takes `/auth/me/notifications` and `/account/notifications`; the
preferences screen moves to `…/settings`. The plain word belongs to the
content, which is what the bell opens.
4. `ctx.inbox.push` honours the user's in-app preference when `triggerId` names
a registered trigger, and writes when it does not.
Server
- `user_notifications` + `model/userNotifications/`. The dedupe UNIQUE is scoped
to the USER, narrower than the outbox's `(rule, user, channel)`: an inbox has
no channel dimension, so two rows for one event would be one item shown twice.
- `engagement/inappChannel.js` — renders by block ROLE (first heading → title,
first button → url, the rest → body) and inserts. `pushChannel.js` — a
content-free `{stream, ref}` tickle whose ref deep-links the inbox row.
- `engine.liveChannels` orders `inapp` first (`CHANNEL_ORDER`) so that ref
resolves on the first sweep. An ordering, not a dependency.
- `templates.renderInappByKey` + `resolveTemplate` extracted from `renderByKey`,
so both channels take the same fallback chain.
- `inapp.event` seed → seedVersion 2: it named `body`/`url`, which nothing
supplies. Renamed to the structural vocabulary the projection fills in.
- `utils/userNotificationsPrune.js` — nightly, READ items only, horizon in
`settings.user_notifications_retain_days` (default 90).
- `GET /auth/me/notifications`, `…/unread-count`, `POST …/:id/read`,
`POST …/read-all`. Swagger + route manifest + four component schemas.
Web
- `NotificationBell` in all three headers, polling its badge once a minute and
pausing while the tab is hidden. `PlayerInbox` at `/account/notifications`.
- The preferences screen becomes a channel matrix over
`/auth/me/notifications/channels` — a strict superset of the push-only stream
list it replaces. The two legacy endpoints are untouched, so the shipped
Android app keeps its wire shape.
- Staff get the same two screens at `/admin/notifications…`: `RequirePlayer`
keeps them out of `/account`, so without this the inbox was unreachable for
every non-player account. `lib/notificationPaths.js` is the one mapping.
Verified: 28 new server tests (5 of them against a real MariaDB, for the three
index/statement properties that are a server contract rather than a reading of
this code) + 3 client. Server suite green, client 327 green. A live rig walked
the whole path: two rules on one event produced three outbox rows and exactly
one inbox item, the tickle carried `ref: notification:2`, and the retention
sweep dropped an aged read row while keeping an equally aged unread one.
Docs: RunicGateway/docs#TBD, RunicGateway/runicgateway.com#TBD
Co-Authored-By: Claude <noreply@anthropic.com>
43 lines
2.0 KiB
JavaScript
43 lines
2.0 KiB
JavaScript
// ── Where each account's notification screens live ─────────────────────────
|
|
//
|
|
// ENGAGEMENT.md Phase 7. Three assertions for a nine-line module, because the
|
|
// defect they pin was invisible to every other check: `/auth/me/notifications`
|
|
// is role-agnostic (behind `requireAuth` only, like the rest of `/auth/me`), so
|
|
// the server, the tests and the API all agreed a staff member had an inbox —
|
|
// and on the web they could not reach it, because `RequirePlayer` sends anyone
|
|
// who is not a player back out of `/account`. The bell pointed at a redirect.
|
|
//
|
|
// Found in the Phase 7 rig, signed in as an admin. What stops it coming back is
|
|
// this file plus the two admin routes it maps onto.
|
|
|
|
import { test } from 'node:test'
|
|
import assert from 'node:assert/strict'
|
|
|
|
import { isStaff, inboxPath, notificationSettingsPath } from '../src/lib/notificationPaths.js'
|
|
|
|
test('a player gets the portal paths', () => {
|
|
const user = { role: 'player' }
|
|
assert.equal(isStaff(user), false)
|
|
assert.equal(inboxPath(user), '/account/notifications')
|
|
assert.equal(notificationSettingsPath(user), '/account/notifications/settings')
|
|
})
|
|
|
|
test('every non-player role gets the admin paths, not just admin', () => {
|
|
for (const role of ['admin', 'editor', 'moderator']) {
|
|
const user = { role }
|
|
assert.equal(isStaff(user), true, role)
|
|
assert.equal(inboxPath(user), '/admin/notifications', role)
|
|
assert.equal(notificationSettingsPath(user), '/admin/notifications/settings', role)
|
|
}
|
|
})
|
|
|
|
// The bell renders nothing when signed out, so these are never asked for a null
|
|
// user in practice — but a default that guessed "staff" would send a signed-out
|
|
// visitor at the admin area the moment that changed.
|
|
test('no user, or a user with no role, falls back to the player paths', () => {
|
|
for (const user of [null, undefined, {}, { role: '' }]) {
|
|
assert.equal(isStaff(user), false)
|
|
assert.equal(inboxPath(user), '/account/notifications')
|
|
}
|
|
})
|