wtclaude
5d7668d5ea
The first real module. It registers nothing, deliberately: what slice 0 proves
is the delivery path itself, end to end, before a single UO file moves into it.
Server half: module.json, an entry point that takes (ctx, api) and registers
nothing, a test suite built on a fake ctx, and scripts/checkImports.js -- the
MODULE_API.md §5.1 boundary check. Client half: the Vite library build, four
shims re-exporting react / react-dom/client / react-router-dom / jsx-runtime
from window.__rg, an entry that verifies each is identity-equal to core's copy,
and scripts/checkExternals.js. 29 server tests, 9 client tests, both new.
Verified against a real core: the module loads, mounts its zero routes, runs to
`started`, and is published by /api/v1/public/modules. Its chunk serves from
the entry's directory with `Cache-Control: no-cache` while the module's server
source, module.json and package.json all 404. In Chrome, under the enforced
`script-src 'self'`, the chunk evaluates and reports all four shared
dependencies OK, with zero CSP reports and no console errors.
Three findings, each of which had produced a green build that was wrong.
MODULE_API.md §3.6 shows `external` alongside the aliases and they do not
compose. Rollup asks `external` BEFORE Vite's alias resolver runs, so a
specifier in both is marked external and never aliased -- the chunk then ships
bare `import "react"`, which no browser can resolve without an import map, and
CSP forbids one. Built cleanly and emitted exactly that; checkExternals caught
it. So: alias only, `external` empty, and vite.config.js grows a resolution-time
guard that fails the build if a shared dependency resolves into node_modules.
That guard was wrong twice before it worked. Written against Rollup's `load`
hook it never ran -- `load` is first-wins and an earlier plugin had already
claimed the module -- so a deliberately-broken alias produced a 24 kB chunk with
react-router welded in, and a green build. And its forbidden-package list was
derived from the alias list "so the two cannot disagree", which meant deleting
an alias also deleted the guard against what that alias prevented. It states the
contract now, and a test asserts the aliases stay inside it.
checkImports failed on its own documentation the first time it ran: the comment
naming require("../../etc/passwd") as an example of what to catch, and index.js
explaining why the module must never require("express"). A boundary check that
cannot survive being described is one people stop writing comments around. It
strips comments and template literals with a character walk rather than a
regexp, because a URL in a string contains a comment opener and a comment
contains quotes -- and it has its own test suite, since a check never shown to
fail is a check nobody knows the state of.
Co-Authored-By: Claude <noreply@anthropic.com>
72 lines
2.9 KiB
JavaScript
72 lines
2.9 KiB
JavaScript
// The entry point's contract with core (MODULE_API.md §2.2).
|
|
//
|
|
// Slice 0 registers nothing, so there is very little behaviour to assert — and
|
|
// the rules that DO apply are the ones that would otherwise be discovered on an
|
|
// operator's install: registering synchronously, never awaiting, never touching
|
|
// a database, never mutating what it was handed. Those hold for every slice
|
|
// after this one too, which is why they are tested against the entry point
|
|
// rather than against whatever it happens to register today.
|
|
|
|
const test = require('node:test')
|
|
const assert = require('node:assert')
|
|
|
|
const register = require('../index')
|
|
const { fakeCtx, fakeApi } = require('./_fakes')
|
|
|
|
test('exports a single register function', () => {
|
|
assert.strictEqual(typeof register, 'function')
|
|
})
|
|
|
|
test('registers synchronously and returns nothing to await', () => {
|
|
const result = register(fakeCtx(), fakeApi())
|
|
// Not `assert.strictEqual(result, undefined)` alone: a module that returned a
|
|
// promise would be a module whose registration core silently never waits for.
|
|
assert.ok(!result || typeof result.then !== 'function', 'register() must not return a thenable')
|
|
})
|
|
|
|
test('touches no database at registration time', () => {
|
|
const ctx = fakeCtx()
|
|
register(ctx, fakeApi())
|
|
assert.deepStrictEqual(ctx.db.query.calls, [], 'register() queried the database')
|
|
})
|
|
|
|
test('registers nothing in slice 0', () => {
|
|
const api = fakeApi()
|
|
register(fakeCtx(), api)
|
|
assert.strictEqual(api.record.routes, null)
|
|
assert.strictEqual(api.record.streams, null)
|
|
assert.deepStrictEqual(api.record.extensions, [])
|
|
assert.deepStrictEqual(api.record.legs, [])
|
|
assert.deepStrictEqual(api.record.hooks, {})
|
|
})
|
|
|
|
test('takes a frozen ctx and does not try to write to it', () => {
|
|
const ctx = fakeCtx()
|
|
assert.ok(Object.isFrozen(ctx))
|
|
// Core freezes one level deep; a module that assigned to ctx would throw here
|
|
// in strict mode and fail silently outside it. Either way it must not.
|
|
assert.doesNotThrow(() => register(ctx, fakeApi()))
|
|
})
|
|
|
|
test('logs through ctx.log, never through console', () => {
|
|
const ctx = fakeCtx()
|
|
register(ctx, fakeApi())
|
|
assert.strictEqual(ctx.logs.length, 1, 'expected exactly one logger to be taken')
|
|
const { log } = ctx.logs[0]
|
|
assert.strictEqual(log.info.calls.length, 1)
|
|
assert.strictEqual(log.info.calls[0][0], 'registered')
|
|
})
|
|
|
|
test('carries no hidden state between calls', () => {
|
|
// Core calls register() exactly once, and the `once()` guard that enforces
|
|
// that lives in core's `api` — not here. What this asserts is the module's
|
|
// own half of it: registering into a second `api` produces the same result as
|
|
// the first, so nothing is memoised at file scope where a re-register would
|
|
// silently do less than it appears to.
|
|
const first = fakeApi()
|
|
const second = fakeApi()
|
|
register(fakeCtx(), first)
|
|
register(fakeCtx(), second)
|
|
assert.deepStrictEqual(second.record, first.record)
|
|
})
|