feat(kit): the two shapes Teams added, taught and built
MODULE_API 1.6.0 expands the contract this book teaches against, so the book
owes two shapes and one correction. Chapter 2 gains both and the template grows
a working version of each, because a reader following a snippet has no way to
find out whether it runs.
ONE SENTENCE WAS WRONG. Chapter 2 said, of extension slots, "Only core may
declare a slot; a module may only fill one". 1.6.0 inverted exactly that: a
module declares a place on its OWN page and core fills it. That is not a stale
detail - a new game's module cannot implement Teams at all without the inverted
direction, so it is the shape the reader needs and did not have.
THE TWO SHAPES
- The inverted slot. A new "Slots go the other way too" section: why the
direction has to invert (core owns the Team, not the word for one), the
namespace rule, one slot per PLACE, the optional { core } naming which of
core's three contributions goes there, and why asking for one core does not
offer throws when almost everything else in that registry fails open.
- registerTeamProvider, in "Becoming the source of Teams". The first
registration where core calls YOU and waits, which is where every rule in it
comes from: the envelope, the ten-second budget, refusing as a normal answer,
and the one mistake worth naming - answering with an empty list because the
game is unreachable, which core reads as authoritative and acts on.
projectRoster gets its own treatment because it is the exception that fails
CLOSED. pageUrlTemplate is a footnote beside it, as intended.
WHAT THE TEMPLATE GREW
model/clans/ - the provider over two tables, with the guards that matter: an
unreachable game refuses rather than reporting no clans, an empty roster is
refused unless the game says the clan is empty (which is why the schema keeps a
member count the rows cannot supply), and the audience rule lives in one file
that both projectRoster and the module's own page consult, because a second copy
drifts in the direction that publishes what core is withholding.
Its own /clans routes, deliberately not /teams - core mounts that itself, and
the loader would refuse the collision. A clan list page and a clan page that
declares three slots for core.
12 provider tests and three registration tests, 47 server and 20 client in
total. The purge test finally proves something: two of the three tables are now
a parent and its child.
WHAT IT DOES NOT DO. Enumerate the contract. The kit teaches one path end to end
and links out; it has never mentioned three pre-Teams registrations and that is
the design, not a gap.
FOUND WHILE WRITING IT: core filled three literal uo.guild.* slot names, so the
inverted direction reached exactly one module and every other game's page came
up empty with nothing logged. Fixed in website#160 / Module-uo#15 / docs#165
before this chapter could teach it - which is what this phase is for.
The ci/core-ref.json pin moves in a later commit on this branch: checkCoreApi is
an equality against a core on main, and 1.6.0 does not reach main until the
cutover.
Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -30,6 +30,7 @@
|
||||
const core = require('./core')
|
||||
|
||||
const worldStatusDb = require('./model/worldStatus/worldStatus.db')
|
||||
const clanDb = require('./model/clans/clanProvider.db')
|
||||
|
||||
const log = core.logger('boot')
|
||||
|
||||
@@ -57,6 +58,42 @@ async function refresh() {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Two clans, so that the Team provider has something to be authoritative about.
|
||||
*
|
||||
* A real module fills these tables from its sidecar — the roster arriving on its
|
||||
* own frames, separately from the clan itself. That separation is why
|
||||
* `member_count` is written from what the game SAYS the size is rather than from
|
||||
* the rows: the provider needs both numbers to tell an empty clan from one whose
|
||||
* roster has not landed, and a seeder that derives the count from its own array
|
||||
* quietly removes the case the provider's most important guard exists for.
|
||||
*
|
||||
* **Core is not called here and does not have to be.** Registration is a claim;
|
||||
* core reconciles on its own schedule, after `onBoot`, by calling the provider.
|
||||
* A module that tried to push Teams into core would be a module racing core's
|
||||
* reconciler for a table it does not own.
|
||||
*/
|
||||
async function seedClans() {
|
||||
try {
|
||||
await clanDb.replaceClan({
|
||||
externalId: 'clan-1', name: 'The Gilded Company', abbr: 'GC', memberCount: 3,
|
||||
members: [
|
||||
{ memberKey: 'char-001', displayName: 'Aldric', rankLabel: 'Warlord', leader: true, online: true },
|
||||
{ memberKey: 'char-002', displayName: 'Bryn', rankLabel: 'Member', online: false },
|
||||
{ memberKey: 'char-003', displayName: 'Cass', rankLabel: 'Member', online: true },
|
||||
],
|
||||
})
|
||||
await clanDb.replaceClan({
|
||||
externalId: 'clan-2', name: 'Ash and Ember', abbr: 'A&E', memberCount: 1,
|
||||
members: [
|
||||
{ memberKey: 'char-101', displayName: 'Dael', rankLabel: 'Warlord', leader: true, online: false },
|
||||
],
|
||||
})
|
||||
} catch (err) {
|
||||
log.warn('could not seed clans', { error: err.message })
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs once, after the schema and before the listener binds.
|
||||
*
|
||||
@@ -66,6 +103,7 @@ async function refresh() {
|
||||
*/
|
||||
async function onBoot() {
|
||||
await refresh()
|
||||
await seedClans()
|
||||
refreshTimer = setInterval(refresh, REFRESH_MS)
|
||||
// Node keeps the process alive for a pending timer. Core's own intervals are
|
||||
// unref'd for exactly this reason: a module that forgets turns `Ctrl-C` into a
|
||||
@@ -89,4 +127,4 @@ async function onShutdown() {
|
||||
log.info('shut down')
|
||||
}
|
||||
|
||||
module.exports = { onBoot, onShutdown, refresh, REFRESH_MS }
|
||||
module.exports = { onBoot, onShutdown, refresh, seedClans, REFRESH_MS }
|
||||
|
||||
Reference in New Issue
Block a user