Additive, v1-only backend contract for the Android app's opt-in push (Part 1 of
M7; docs/android/PLAN.md §11). The app is a pure consumer — this lands the
endpoints, fan-out, and relay it needs.
- Schema: push_devices (per-device endpoint) + notification_subscriptions
(per-user opted-in streams), FK→users ON DELETE CASCADE.
- Stream catalog + event→stream mapping (config/notificationStreams.js): public
streams (news.post, server.status, idoc.warning, champ.start, governor.election)
drawn ONLY from the SSE PUBLIC_KINDS allowlist; personal owner-keyed streams
(vendor.sale, house.idoc, account.login). Full-state upserts (champ/city) fire
only on a real transition via an injectable tracker.
- Fan-out (utils/pushDispatch.js): content-free tickles ({ stream, ref }) POSTed
to each subscribed device; never throws. Two producers — shardIngest.ingest
(beside the SSE broadcast) and the create/publish-post path (news.post).
Personal events resolve to the owner via shardLinks. SSRF guard: endpoints must
be HTTPS, non-private, and on the NTFY_BASE_URL/NTFY_ALLOWED_ORIGINS allow-set —
enforced at registration and every publish.
- Routes under the role-agnostic self surface (never /admin): POST|GET
/auth/me/devices, DELETE /auth/me/devices/:id, GET
/auth/me/notifications/streams, GET|PUT /auth/me/notifications/subscriptions.
Swagger regenerated (4 paths, PushDevice/NotificationStreams/etc. schemas).
- ntfy service in docker-compose.yml: pinned image, declarative ./ntfy/server.yml,
no published host port, anonymous unguessable topics (no accounts) — zero
interactive setup. No publish token required (content-free design); optional
NTFY_PUBLISH_TOKEN honored.
- Tests: pushDispatch (mapping, PUBLIC_KINDS gate, owner-keying, SSRF guard,
content-free payload) + notifications route auth gate. Full suite green (247).
Co-Authored-By: Claude <noreply@anthropic.com>
72 lines
3.3 KiB
JavaScript
72 lines
3.3 KiB
JavaScript
const { test, beforeEach } = require('node:test')
|
|
const assert = require('node:assert/strict')
|
|
|
|
const shardIngest = require('../src/utils/shardIngest')
|
|
|
|
// Build a set of stub deps that record the champ/page/state calls the dispatcher
|
|
// makes, plus a spy shardEvents.append and broadcast. Only the methods the tested
|
|
// kinds touch need to be real; the rest are no-op async so ingest() never throws.
|
|
function makeDeps() {
|
|
const calls = { champUpsert: [], champRemove: [], pageUpsert: [], pageRemove: [], appended: [], broadcast: [] }
|
|
const noop = async () => {}
|
|
return {
|
|
calls,
|
|
shardEvents: { append: async (row) => { calls.appended.push(row); return true } },
|
|
shardState: {
|
|
upsertChamp: async (ev) => { calls.champUpsert.push(ev) },
|
|
removeChamp: async (serial) => { calls.champRemove.push(serial) },
|
|
upsertPage: async (ev) => { calls.pageUpsert.push(ev) },
|
|
removePage: async (id) => { calls.pageRemove.push(id) },
|
|
// Unused by these kinds but present so any stray routing is a no-op.
|
|
clearOnline: noop, upsertOnline: noop, setOffline: noop, upsertHouse: noop, addEconomySample: noop,
|
|
},
|
|
uoLinkConfig: { recordStatus: noop },
|
|
broadcast: (ev) => { calls.broadcast.push(ev) },
|
|
// No-op push fan-out so ingest() stays hermetic (no real relay/DB).
|
|
pushDispatch: async () => {},
|
|
log: { warn() {}, info() {}, error() {} },
|
|
}
|
|
}
|
|
|
|
beforeEach(() => shardIngest.reset())
|
|
|
|
test('champ.update routes to shardState.upsertChamp and is not written to the event log', async () => {
|
|
const deps = makeDeps()
|
|
const ev = { kind: 'champ.update', serial: '0x1', category: 'champion', name: 'Abyss', status: 'active', t: 1 }
|
|
const r = await shardIngest.ingest(ev, deps)
|
|
assert.equal(deps.calls.champUpsert.length, 1)
|
|
assert.equal(deps.calls.champUpsert[0].serial, '0x1')
|
|
assert.equal(r.logged, false) // champ.* is state-only, not appended to shard_events
|
|
assert.equal(deps.calls.appended.length, 0)
|
|
assert.equal(deps.calls.broadcast.length, 1) // still broadcast live
|
|
})
|
|
|
|
test('champ.remove routes to shardState.removeChamp', async () => {
|
|
const deps = makeDeps()
|
|
await shardIngest.ingest({ kind: 'champ.remove', serial: '0x2', t: 2 }, deps)
|
|
assert.deepEqual(deps.calls.champRemove, ['0x2'])
|
|
})
|
|
|
|
test('page.new and page.updated upsert the page; page.closed removes it', async () => {
|
|
const deps = makeDeps()
|
|
await shardIngest.ingest({ kind: 'page.new', pageId: '0x24C', type: 'Bug', sender: { name: 'Al' }, t: 3 }, deps)
|
|
await shardIngest.ingest({ kind: 'page.updated', pageId: '0x24C', handled: true, t: 4 }, deps)
|
|
await shardIngest.ingest({ kind: 'page.closed', pageId: '0x24C', t: 5 }, deps)
|
|
assert.equal(deps.calls.pageUpsert.length, 2)
|
|
assert.deepEqual(deps.calls.pageRemove, ['0x24C'])
|
|
})
|
|
|
|
test('admin.audit is appended to the event log (moderation history)', async () => {
|
|
const deps = makeDeps()
|
|
const r = await shardIngest.ingest({ kind: 'admin.audit', action: 'ban', actor: 'web:jane', target: 'griefer', t: 6 }, deps)
|
|
assert.equal(r.logged, true)
|
|
assert.equal(deps.calls.appended.length, 1)
|
|
assert.equal(deps.calls.appended[0].kind, 'admin.audit')
|
|
})
|
|
|
|
test('champ.remove without a serial is a harmless no-op', async () => {
|
|
const deps = makeDeps()
|
|
await shardIngest.ingest({ kind: 'champ.remove', t: 7 }, deps)
|
|
assert.deepEqual(deps.calls.champRemove, [undefined])
|
|
})
|