wtclaude
7875848ee7
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>
86 lines
3.4 KiB
JavaScript
86 lines
3.4 KiB
JavaScript
// ── SQL for the clan tables ───────────────────────────────────────────────
|
|
//
|
|
// The same `.db.js` / `.model.js` split as `model/worldStatus/`, for the same
|
|
// reason: the file with the queries in it has no branching to test, and the file
|
|
// with the branching in it has no database to stand up.
|
|
//
|
|
// Everything here reads this module's OWN tables. **Nothing in a module ever
|
|
// reads or writes `teams`, `team_members`, `team_forum_*` or any other core
|
|
// table** — core owns the Team, this module owns the clan, and the whole of the
|
|
// traffic between them is the provider next door answering three questions
|
|
// (MODULE_API.md §2.6's prefix rule, and §2.7).
|
|
|
|
const core = require('../../core')
|
|
|
|
const CLANS = 'examplegame_clans'
|
|
const MEMBERS = 'examplegame_clan_members'
|
|
|
|
/** Every clan the game has told us about. */
|
|
async function listClans() {
|
|
return core.query(
|
|
`SELECT external_id AS externalId, name, abbr, member_count AS memberCount
|
|
FROM ${CLANS}
|
|
ORDER BY name`,
|
|
)
|
|
}
|
|
|
|
/** One clan, or `undefined`. */
|
|
async function findClan(externalId) {
|
|
const rows = await core.query(
|
|
`SELECT external_id AS externalId, name, abbr, member_count AS memberCount
|
|
FROM ${CLANS}
|
|
WHERE external_id = ?`,
|
|
[externalId],
|
|
)
|
|
return rows[0]
|
|
}
|
|
|
|
/**
|
|
* One clan's roster.
|
|
*
|
|
* Ordered so that a page rendering it directly does not have to sort: leaders
|
|
* first, then by name. Ordering in SQL rather than in the model is a judgement
|
|
* call and this is the case for it — the database is doing it on an index, and
|
|
* the alternative is every caller remembering to.
|
|
*/
|
|
async function listMembers(clanId) {
|
|
return core.query(
|
|
`SELECT member_key AS memberKey, display_name AS displayName, rank_label AS rankLabel,
|
|
is_leader AS isLeader, is_online AS isOnline, user_id AS userId
|
|
FROM ${MEMBERS}
|
|
WHERE clan_id = ?
|
|
ORDER BY is_leader DESC, display_name`,
|
|
[clanId],
|
|
)
|
|
}
|
|
|
|
/**
|
|
* Replace what we know about one clan, in one transaction-shaped pair of writes.
|
|
*
|
|
* Called by whatever ingests from your sidecar; here, by `boot.js`. Delete-then-
|
|
* insert rather than an upsert, because a roster is a SET and the members who
|
|
* left are as much a part of the update as the ones who joined — an upsert leaves
|
|
* departed characters on the roster forever, and core would keep syncing them
|
|
* into a Team as present members.
|
|
*/
|
|
async function replaceClan({ externalId, name, abbr, memberCount, members }) {
|
|
await core.query(
|
|
`INSERT INTO ${CLANS} (external_id, name, abbr, member_count, updated_at)
|
|
VALUES (?, ?, ?, ?, CURRENT_TIMESTAMP)
|
|
ON DUPLICATE KEY UPDATE name = VALUES(name), abbr = VALUES(abbr),
|
|
member_count = VALUES(member_count), updated_at = CURRENT_TIMESTAMP`,
|
|
[externalId, name, abbr || null, memberCount],
|
|
)
|
|
await core.query(`DELETE FROM ${MEMBERS} WHERE clan_id = ?`, [externalId])
|
|
for (const m of members) {
|
|
await core.query(
|
|
`INSERT INTO ${MEMBERS} (clan_id, member_key, display_name, rank_label, is_leader, is_online, user_id)
|
|
VALUES (?, ?, ?, ?, ?, ?, ?)`,
|
|
[externalId, m.memberKey, m.displayName || null, m.rankLabel || null,
|
|
m.leader ? 1 : 0, m.online ? 1 : 0, m.userId || null],
|
|
)
|
|
}
|
|
}
|
|
|
|
module.exports = { listClans, findClan, listMembers, replaceClan, CLANS, MEMBERS }
|