Phase 2 PR 4 of docs/website/MODULE_SYSTEM.md §2.7. Adds server/src/modules/registries.js and moves core's own notification streams, announce leg and users-detail routes behind it, so the three seams §1.8 and §1.9 named are exercised on every boot before any module depends on them. Registering is validate-then-commit per registrant: the loader stages what a module claims and the second pass commits it, so a module that throws halfway through register() — or fails checkDeclared after it — leaves nothing behind. That is the registry-side twin of PR 2's second-pass mount rule. Four decisions, all the recommended option: - announce legs became a child table. `announce_job_legs` replaces the towncrier_*/discord_* column groups, so the leg set is data: core registers `discord`, module-uo will register `towncrier`, and a module cannot ALTER a core table to add its own. Backfill is guarded on information_schema (a SELECT of a dropped column is a parse error, not a runtime one) and the columns go with DROP COLUMN IF EXISTS. Verified against the live dev DB: three legacy jobs migrated faithfully, three replays, no duplicates. - `mapEvent` dropped from registerNotificationStreams. §1.8 already inverts the push path so a module owns fromShardEvent and calls core's publish() with a stream id it resolved; a second mapping mechanism was a leftover. The public safety filter, the kinds it reads and the streams it protects now live in one file and move together. - core registers through the same staging area a module uses, via an explicit registries.registerCore() in app.js before modules.load(). - core's six /admin/users/:id/shard/* paths now go through the `admin.users.detail` slot, and getUser moved back to admin.controller.js. Found on the way, and the reason two build tools changed: - scripts/routeManifest.js could not decode a parameterised mount. Its unwinder expected `(?:([^\/]+?))`; express 4.22 emits `(?:\/([^/]+?))` with the separator inside the group. The branch had never run. It threw rather than guessing, which is what it is for. - swagger-autogen cannot follow a route into an extension slot — the slot's router is created by declareSlot() and filled later, so there is no literal mount for a static parse. Regenerating deleted 407 lines and printed `Swagger-autogen: Success`, the spike's exact failure (MODULE_API.md §7.4). swagger/slotSpecs.js generates a fragment per filled slot and re-roots it at the prefix the router actually hangs at in the live app — read from the express stack via routeManifest's own mountPath, so the manifest and the spec cannot disagree. swagger/mergeSpec.js is the merge helper core owes for module fragments anyway (§6.1a), proved here against core's own slot first. 884 tests pass (856 before). routes.manifest.json is unchanged at 229 routes. The OpenAPI spec diff is two lines of intent: the retry endpoint's summary, and its `leg` no longer being a fixed enum. Co-Authored-By: Claude <noreply@anthropic.com>
151 lines
5.9 KiB
JavaScript
151 lines
5.9 KiB
JavaScript
// Point the DB at a closed port BEFORE requiring anything that builds the pool,
|
||
// so any stray query fails fast instead of hanging the runner. These tests stub
|
||
// every model method the controller touches, so the DB is never actually hit.
|
||
process.env.DB_HOST = '127.0.0.1'
|
||
process.env.DB_PORT = '59999'
|
||
|
||
const { test, after, afterEach } = require('node:test')
|
||
const assert = require('node:assert/strict')
|
||
|
||
const ctrl = require('../src/router/v1/admin/usersShard.controller')
|
||
const users = require('../src/model/users/users.model')
|
||
const shardLinks = require('../src/model/shardLinks/shardLinks.model')
|
||
const shardState = require('../src/model/shardState/shardState.model')
|
||
const shardEvents = require('../src/model/shardEvents/shardEvents.model')
|
||
const { salesForAccounts } = require('../src/utils/shardSales')
|
||
const db = require('../src/utils/db')
|
||
|
||
after(() => db.close())
|
||
|
||
function mockRes() {
|
||
return {
|
||
statusCode: 200,
|
||
body: null,
|
||
status(c) {
|
||
this.statusCode = c
|
||
return this
|
||
},
|
||
json(b) {
|
||
this.body = b
|
||
return this
|
||
},
|
||
}
|
||
}
|
||
|
||
// Save/restore the originals so each test's monkeypatches don't leak.
|
||
const originals = {
|
||
getById: users.getById,
|
||
listForUser: shardLinks.listForUser,
|
||
listHousesForAccounts: shardState.listHousesForAccounts,
|
||
listOnlineForAccounts: shardState.listOnlineForAccounts,
|
||
eventsList: shardEvents.list,
|
||
}
|
||
afterEach(() => {
|
||
users.getById = originals.getById
|
||
shardLinks.listForUser = originals.listForUser
|
||
shardState.listHousesForAccounts = originals.listHousesForAccounts
|
||
shardState.listOnlineForAccounts = originals.listOnlineForAccounts
|
||
shardEvents.list = originals.eventsList
|
||
})
|
||
|
||
// ── salesForAccounts util ──────────────────────────────────────────────────
|
||
test('salesForAccounts returns [] for an empty account set without hitting the log', async () => {
|
||
let called = false
|
||
shardEvents.list = async () => {
|
||
called = true
|
||
return []
|
||
}
|
||
assert.deepEqual(await salesForAccounts([]), [])
|
||
assert.equal(called, false)
|
||
})
|
||
|
||
test('salesForAccounts keeps only sales owned by the given accounts, newest 50', async () => {
|
||
const events = []
|
||
// 60 sales owned by "mine", plus some owned by "other".
|
||
for (let i = 0; i < 60; i++) {
|
||
events.push({ t: i, payload: { ownerAcct: 'mine', itemType: 'sword', amount: 1, price: 10, commission: 1 } })
|
||
}
|
||
events.push({ t: 999, payload: { ownerAcct: 'other', itemType: 'shield', amount: 1, price: 5 } })
|
||
shardEvents.list = async () => events
|
||
|
||
const rows = await salesForAccounts(['mine'])
|
||
assert.equal(rows.length, 50) // capped
|
||
assert.ok(rows.every((r) => r.ownerAcct === 'mine')) // never leaks "other"
|
||
assert.deepEqual(Object.keys(rows[0]).sort(), ['amount', 'commission', 'itemType', 'ownerAcct', 'price', 't'])
|
||
})
|
||
|
||
// ── Controller: unknown user → 404 ─────────────────────────────────────────
|
||
for (const handler of ['listAccounts', 'getSales', 'getHouses', 'getOnline']) {
|
||
test(`${handler} returns 404 when the user does not exist`, async () => {
|
||
users.getById = async () => null
|
||
const res = mockRes()
|
||
await ctrl[handler]({ params: { id: '404' } }, res)
|
||
assert.equal(res.statusCode, 404)
|
||
})
|
||
}
|
||
|
||
// ── Controller: scoping to the user's accounts ─────────────────────────────
|
||
test('listAccounts returns the user’s linked accounts', async () => {
|
||
users.getById = async () => ({ id: 7, username: 'bob', role: 'player' })
|
||
shardLinks.listForUser = async (id) => {
|
||
assert.equal(id, 7)
|
||
return [{ account: 'acctA' }, { account: 'acctB' }]
|
||
}
|
||
const res = mockRes()
|
||
await ctrl.listAccounts({ params: { id: '7' } }, res)
|
||
assert.equal(res.statusCode, 200)
|
||
assert.deepEqual(res.body, [{ account: 'acctA' }, { account: 'acctB' }])
|
||
})
|
||
|
||
test('getHouses passes exactly the user’s accounts to the model', async () => {
|
||
users.getById = async () => ({ id: 7 })
|
||
shardLinks.listForUser = async () => [{ account: 'acctA' }, { account: 'acctB' }]
|
||
let received = null
|
||
shardState.listHousesForAccounts = async (accounts) => {
|
||
received = accounts
|
||
return [{ serial: '0x1', isIdoc: true }]
|
||
}
|
||
const res = mockRes()
|
||
await ctrl.getHouses({ params: { id: '7' } }, res)
|
||
assert.deepEqual(received, ['acctA', 'acctB'])
|
||
assert.deepEqual(res.body, [{ serial: '0x1', isIdoc: true }])
|
||
})
|
||
|
||
test('getOnline passes exactly the user’s accounts to the model', async () => {
|
||
users.getById = async () => ({ id: 7 })
|
||
shardLinks.listForUser = async () => [{ account: 'acctA' }]
|
||
let received = null
|
||
shardState.listOnlineForAccounts = async (accounts) => {
|
||
received = accounts
|
||
return [{ serial: '0x2', name: 'Zoe' }]
|
||
}
|
||
const res = mockRes()
|
||
await ctrl.getOnline({ params: { id: '7' } }, res)
|
||
assert.deepEqual(received, ['acctA'])
|
||
assert.deepEqual(res.body, [{ serial: '0x2', name: 'Zoe' }])
|
||
})
|
||
|
||
test('a user with no linked accounts yields empty sales/houses/online', async () => {
|
||
users.getById = async () => ({ id: 7 })
|
||
shardLinks.listForUser = async () => []
|
||
shardState.listHousesForAccounts = async (a) => (a.length ? [{}] : [])
|
||
shardState.listOnlineForAccounts = async (a) => (a.length ? [{}] : [])
|
||
shardEvents.list = async () => [{ payload: { ownerAcct: 'someoneElse' } }]
|
||
|
||
const sales = mockRes()
|
||
const houses = mockRes()
|
||
const online = mockRes()
|
||
await ctrl.getSales({ params: { id: '7' } }, sales)
|
||
await ctrl.getHouses({ params: { id: '7' } }, houses)
|
||
await ctrl.getOnline({ params: { id: '7' } }, online)
|
||
|
||
assert.deepEqual(sales.body, [])
|
||
assert.deepEqual(houses.body, [])
|
||
assert.deepEqual(online.body, [])
|
||
})
|
||
|
||
// getUser is NOT here any more: reading a user is core semantics that had ended
|
||
// up in this controller by proximity, and PR 4 moved it back to
|
||
// admin.controller.js behind the extension slot (MODULE_SYSTEM.md §1.9). It is
|
||
// covered by test/adminUsers.test.js.
|