Files
msd-core/tests/phase-command-router.test.cjs
Tom Boucher b533f71857 chore: introduce CommandRoutingHub and migrate phase-command-router (PoC) (#3828)
* feat(routing): add CommandRoutingHub with behavioral test suite (#3788)

Introduces createHub({ mode, sdkLoader, cjsRegistry, manifest }) and
hub.dispatch({ family, subcommand, args, cwd, raw }) -> Result with a
closed 6-value ERROR_KINDS frozen enum. Hub never throws, never prints,
and enforces no transparent fallback between sdk/cjs modes. 34 behavioral
tests cover all errorKind values, mode fixation, and the no-throw contract.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* refactor(routing): migrate phase-command-router to CommandRoutingHub (#3788)

Rewrites phase-command-router.cjs to dispatch through CommandRoutingHub.
Public entry point routePhaseCommand({ phase, args, cwd, raw, error }) is
unchanged. The adapter determines mode (sdk/cjs) from env + tryLoadSdk(),
constructs a hub, dispatches, and translates the pure Result back to
output()/error() calls. New behavioral test suite (23 tests) replaces the
old mock-heavy approach and includes two integration tests through the real hub.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs(routing): ADR + glossary + changeset for CommandRoutingHub (#3788)

Adds ADR-3788 documenting the hub's design contract (pure result, fixed mode,
closed 6-value errorKind enum, no transparent fallback). Adds Command Routing
Hub glossary entry to CONTEXT.md and a one-paragraph reference to
ARCHITECTURE.md. Changeset fragment records the Changed entry.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix(docs): rename ADR to sequential convention 0012 (#3788)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs(inventory): register CommandRoutingHub in INVENTORY (#3788)

Add command-routing-hub.cjs row to docs/INVENTORY.md CLI Modules table,
bump headline count from 72 to 73, and regenerate INVENTORY-MANIFEST.json
via scripts/gen-inventory-manifest.cjs --write.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs(adr): add 0012 to ADR index (#3788)

Add entry for 0012-command-routing-hub.md to the index table in
docs/adr/README.md so the enh-3271-sdk-adr-structure lint passes.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* chore(lint): bump phase test-file ceiling to accommodate command-router suite (#3788)

phase-command-router.test.cjs added by the CommandRoutingHub migration
pushes the phase prefix cluster from 4 to 5 test files. Bump the allowlist
ceiling from 4 to 5 (issue 3788) so lint-test-file-count passes.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix(routing): preserve phase.mvp-mode JSON error and ROADMAP scan through hub (#3788)

mvp-mode was never registered in the SDK; the pre-#3788 CJS router
always dispatched it via the CJS handler even when sdkAvailable was
true. After the hub migration, SDK-mode hubs (Docker, where the SDK
build exists) sent mvp-mode to the SDK bridge, which returned
SdkDispatchFailed with reason 'unknown' instead of the expected
'usage' code, and failed ROADMAP lookups. Fix by short-circuiting
mvp-mode to the CJS handler before hub construction, matching the
pre-migration observable behaviour.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs(adr): note SDK-incomplete subcommand limitation in ADR-0012 (#3788)

* fix(inventory): bump CLI Modules headline to 74 after rebase onto main (#3788)

Upstream added code-review-flags.cjs (72→73) at the same time our branch
added command-routing-hub.cjs. After rebase both modules exist (74 total)
but the headline stayed at 73; bump to 74.

* fix(routing): remove dead mvp-mode handler from cjsRegistry (#3788)

The cjsRegistry['phase']['mvp-mode'] handler (previously lines 65–68)
was unreachable: the early-return bypass at line 56 intercepts mvp-mode
before hub construction in CJS mode, and in SDK mode cjsRegistry is
passed as undefined. Remove the dead handler; all 57 tests still pass.

* docs(adr): correct router count in ADR-0012 (#3788)

The context section cited "eight" routers including "frontmatter" but
there is no frontmatter-command-router.cjs. The actual count is seven:
phase, phases, roadmap, state, verify, validate, init.

* fix(routing): guard missing subcommand + use ERROR_KINDS constant (#3788)

Two fixes in phase-command-router.cjs:

1. Add early-return for missing subcommand before hub construction.
   Pre-#3788 the routeCjsCommandFamily fell through to error() for
   undefined args[1]; post-#3788 the hub's manifest check skips falsy
   subcommands, which would have sent bare 'phase' into SDK dispatch
   in SDK mode instead of the expected "Available: ..." error message.

2. Switch on ERROR_KINDS.UnknownCommand instead of bare 'UnknownCommand'
   string, per ADR-0012's closed-enum contract ("callers switch on
   ERROR_KINDS values, not bare string literals").

* docs(routing): fix factual errors in ARCHITECTURE, ADR-0012, changeset (#3788)

Three corrections:

1. ARCHITECTURE.md: softened "All CJS command family routers dispatch
   through CommandRoutingHub" — only phase-command-router.cjs is
   migrated in this PR; remaining routers still use routeCjsCommandFamily
   and migrate in follow-up issues.

2. ADR-0012: corrected the SDK mvp-mode claim. The ADR said "the SDK
   has no equivalent entry" but sdk/src/query/command-static-catalog-
   domain.ts:104-105 registers phase.mvp-mode. The actual reason for
   the early-return bypass is divergent ROADMAP scan behaviour and
   error reason codes, not SDK absence.

3. .changeset/mellow-tigers-gather.md: corrected pr: 1 → pr: 3828.

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-21 23:32:10 -04:00

421 lines
14 KiB
JavaScript

'use strict';
/**
* Behavioral tests for the phase-command-router adapter (#3788).
*
* Shape:
* 1. Adapter translation — CLI args → hub dispatch shape
* 2. Result translation — hub result → stdout / error callback
* 3. Unsupported subcommands — SDK-only commands produce the documented error
* 4. Unknown subcommand — unmapped subcommands produce a well-formed error
* 5. Integration — real hub + real CJS phase handler invocation
*
* Testing rules in force (CONTRIBUTING.md § Testing Standards):
* - No readFileSync of source files.
* - No mocking of the hub itself — tests use the real CommandRoutingHub
* with stub cjsRegistry / sdkLoader entries.
* - All assertions on return values and captured call arguments.
*/
const { describe, test, before, after } = require('node:test');
const assert = require('node:assert/strict');
const { routePhaseCommand } = require('../get-shit-done/bin/lib/phase-command-router.cjs');
// Force CJS path throughout: set GSD_WORKSTREAM so tryLoadSdk() is bypassed.
// This makes unit-level assertions deterministic regardless of SDK build state.
let _prevWorkstream;
before(() => {
_prevWorkstream = process.env.GSD_WORKSTREAM;
process.env.GSD_WORKSTREAM = 'test-unit';
});
after(() => {
if (_prevWorkstream === undefined) delete process.env.GSD_WORKSTREAM;
else process.env.GSD_WORKSTREAM = _prevWorkstream;
});
// ─── Helper: build a minimal phase stub ──────────────────────────────────────
function makePhase(overrides = {}) {
return {
cmdPhaseMvpMode: () => {},
cmdPhaseNextDecimal: () => {},
cmdPhaseAdd: () => {},
cmdPhaseAddBatch: () => {},
cmdPhaseInsert: () => {},
cmdPhaseRemove: () => {},
cmdPhaseComplete: () => {},
...overrides,
};
}
// ─── 1. Adapter translation — CLI args → handler calls ───────────────────────
describe('phase-command-router — CLI arg translation (CJS path)', () => {
test('routes phase mvp-mode: passes cwd, args.slice(2), raw to handler', () => {
const calls = [];
const phase = makePhase({
cmdPhaseMvpMode: (cwd, slicedArgs, raw) => calls.push({ cwd, slicedArgs, raw }),
});
routePhaseCommand({ phase, args: ['phase', 'mvp-mode', '--enable'], cwd: '/proj', raw: false, error: (m) => { throw new Error(m); } });
assert.equal(calls.length, 1);
assert.equal(calls[0].cwd, '/proj');
assert.deepEqual(calls[0].slicedArgs, ['--enable']);
assert.equal(calls[0].raw, false);
});
test('routes phase next-decimal: passes cwd, args[2], raw to handler', () => {
const calls = [];
const phase = makePhase({
cmdPhaseNextDecimal: (cwd, label, raw) => calls.push({ cwd, label, raw }),
});
routePhaseCommand({ phase, args: ['phase', 'next-decimal', '5'], cwd: '/p', raw: true, error: (m) => { throw new Error(m); } });
assert.equal(calls[0].label, '5');
assert.equal(calls[0].raw, true);
});
test('routes phase add: strips --raw, passes joined description and no customId', () => {
const calls = [];
const phase = makePhase({
cmdPhaseAdd: (cwd, desc, raw, customId) => calls.push({ cwd, desc, raw, customId }),
});
routePhaseCommand({ phase, args: ['phase', 'add', 'My', 'phase', '--raw'], cwd: '/p', raw: true, error: (m) => { throw new Error(m); } });
assert.equal(calls[0].desc, 'My phase');
assert.equal(calls[0].customId, null);
});
test('routes phase add: captures --id value', () => {
const calls = [];
const phase = makePhase({
cmdPhaseAdd: (cwd, desc, raw, customId) => calls.push({ customId }),
});
routePhaseCommand({ phase, args: ['phase', 'add', '--id', '05', 'Desc'], cwd: '/p', raw: false, error: (m) => { throw new Error(m); } });
assert.equal(calls[0].customId, '05');
});
test('routes phase add-batch: --descriptions JSON array parses correctly', () => {
const calls = [];
const phase = makePhase({
cmdPhaseAddBatch: (cwd, descriptions, raw) => calls.push({ descriptions }),
});
routePhaseCommand({
phase,
args: ['phase', 'add-batch', '--descriptions', '["Phase A","Phase B"]'],
cwd: '/p',
raw: false,
error: (m) => { throw new Error(m); },
});
assert.deepEqual(calls[0].descriptions, ['Phase A', 'Phase B']);
});
test('routes phase add-batch: positional args used when --descriptions absent', () => {
const calls = [];
const phase = makePhase({
cmdPhaseAddBatch: (cwd, descriptions, raw) => calls.push({ descriptions }),
});
routePhaseCommand({
phase,
args: ['phase', 'add-batch', 'A', 'B', '--raw'],
cwd: '/p',
raw: true,
error: (m) => { throw new Error(m); },
});
assert.deepEqual(calls[0].descriptions, ['A', 'B']);
});
test('routes phase insert: passes cwd, phaseNum, trailing joined, raw', () => {
const calls = [];
const phase = makePhase({
cmdPhaseInsert: (cwd, phaseNum, desc, raw) => calls.push({ cwd, phaseNum, desc, raw }),
});
routePhaseCommand({ phase, args: ['phase', 'insert', '02', 'New', 'phase'], cwd: '/p', raw: false, error: (m) => { throw new Error(m); } });
assert.equal(calls[0].phaseNum, '02');
assert.equal(calls[0].desc, 'New phase');
});
test('routes phase remove: passes cwd, phaseNum, force:false, raw', () => {
const calls = [];
const phase = makePhase({
cmdPhaseRemove: (cwd, phaseNum, opts, raw) => calls.push({ cwd, phaseNum, opts, raw }),
});
routePhaseCommand({ phase, args: ['phase', 'remove', '03'], cwd: '/p', raw: false, error: (m) => { throw new Error(m); } });
assert.equal(calls[0].phaseNum, '03');
assert.deepEqual(calls[0].opts, { force: false });
});
test('routes phase remove: --force flag sets opts.force:true', () => {
const calls = [];
const phase = makePhase({
cmdPhaseRemove: (cwd, phaseNum, opts, raw) => calls.push({ opts }),
});
routePhaseCommand({ phase, args: ['phase', 'remove', '--force', '03'], cwd: '/p', raw: false, error: (m) => { throw new Error(m); } });
assert.deepEqual(calls[0].opts, { force: true });
});
test('routes phase complete: passes cwd, args[2], raw', () => {
const calls = [];
const phase = makePhase({
cmdPhaseComplete: (cwd, phaseNum, raw) => calls.push({ cwd, phaseNum, raw }),
});
routePhaseCommand({ phase, args: ['phase', 'complete', '04'], cwd: '/p', raw: false, error: (m) => { throw new Error(m); } });
assert.equal(calls[0].phaseNum, '04');
});
});
// ─── 2. Result translation — error callback on failure ───────────────────────
describe('phase-command-router — result translation (error path)', () => {
test('phase add with --id missing value calls error()', () => {
let msg = null;
const phase = makePhase();
routePhaseCommand({
phase,
args: ['phase', 'add', '--id'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null, 'error callback must be called');
assert.ok(msg.includes('--id requires a value'));
});
test('phase add with unknown flag calls error()', () => {
let msg = null;
const phase = makePhase();
routePhaseCommand({
phase,
args: ['phase', 'add', '--unknown-flag'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null);
assert.ok(msg.includes('phase add does not support'));
});
test('phase add-batch with non-JSON --descriptions calls error()', () => {
let msg = null;
const phase = makePhase();
routePhaseCommand({
phase,
args: ['phase', 'add-batch', '--descriptions', 'not-json'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null);
assert.ok(msg.includes('JSON array'));
});
test('phase insert with --dry-run calls error()', () => {
let msg = null;
const phase = makePhase();
routePhaseCommand({
phase,
args: ['phase', 'insert', '02', '--dry-run'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null);
assert.ok(msg.includes('does not support --dry-run'));
});
test('phase remove with unsupported flag calls error()', () => {
let msg = null;
const phase = makePhase();
routePhaseCommand({
phase,
args: ['phase', 'remove', '--quiet', '03'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null);
assert.ok(msg.includes('phase remove does not support'));
});
test('phase remove without a phase number calls error()', () => {
let msg = null;
const phase = makePhase();
routePhaseCommand({
phase,
args: ['phase', 'remove'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null);
assert.ok(msg.includes('exactly one phase number'));
});
});
// ─── 3. Unsupported (SDK-only) subcommands ────────────────────────────────────
describe('phase-command-router — SDK-only subcommands', () => {
test('phase list-plans calls error() with SDK-only message', () => {
let msg = null;
routePhaseCommand({
phase: makePhase(),
args: ['phase', 'list-plans'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null);
assert.ok(msg.includes('SDK-only'), `expected "SDK-only" in: ${msg}`);
assert.ok(msg.includes('list-plans'));
});
test('phase list-artifacts calls error() with SDK-only message', () => {
let msg = null;
routePhaseCommand({
phase: makePhase(),
args: ['phase', 'list-artifacts'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null);
assert.ok(msg.includes('SDK-only'));
assert.ok(msg.includes('list-artifacts'));
});
test('phase scaffold calls error() with redirect message', () => {
let msg = null;
routePhaseCommand({
phase: makePhase(),
args: ['phase', 'scaffold'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null);
assert.ok(msg.includes('scaffold'));
});
});
// ─── 4. Unknown subcommand ────────────────────────────────────────────────────
describe('phase-command-router — unknown subcommand', () => {
test('unknown phase subcommand calls error() listing available ones', () => {
let msg = null;
routePhaseCommand({
phase: makePhase(),
args: ['phase', 'frobnicate'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null);
assert.ok(msg.includes('Unknown phase subcommand'));
assert.ok(msg.includes('Available:'), `expected "Available:" in: ${msg}`);
});
test('unknown subcommand message lists canonical manifest commands like add and complete', () => {
// mvp-mode is NOT in the available list (not in PHASE_SUBCOMMANDS manifest),
// matching the pre-#3788 behaviour of routeCjsCommandFamily.
// The list does include the manifest-backed commands: add, complete, etc.
let msg = null;
routePhaseCommand({
phase: makePhase(),
args: ['phase', 'bogus'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg.includes('add'), `expected add in available list: ${msg}`);
assert.ok(msg.includes('complete'), `expected complete in available list: ${msg}`);
assert.ok(!msg.includes('list-plans'), `list-plans (SDK-only) must not appear in available list: ${msg}`);
});
});
// ─── 5. Integration — real hub + real CJS phase handler ──────────────────────
//
// This test exercises the full dispatch chain end-to-end:
// routePhaseCommand → createHub (cjs mode) → dispatch → cjsRegistry handler
// → phase stub → assert the call was received.
//
// No mocking of the hub. The phase stub is a real dependency collaborator.
describe('phase-command-router — integration: real hub + CJS phase handler', () => {
test('dispatches phase complete through real hub to real CJS handler chain', () => {
const calls = [];
const phase = makePhase({
cmdPhaseComplete: (cwd, phaseNum, raw) => calls.push({ cwd, phaseNum, raw }),
});
// No error should occur; handler should be called exactly once.
let errorMsg = null;
routePhaseCommand({
phase,
args: ['phase', 'complete', '07'],
cwd: '/integration',
raw: false,
error: (m) => { errorMsg = m; },
});
assert.equal(errorMsg, null, `unexpected error: ${errorMsg}`);
assert.equal(calls.length, 1);
assert.equal(calls[0].cwd, '/integration');
assert.equal(calls[0].phaseNum, '07');
assert.equal(calls[0].raw, false);
});
test('dispatches phase add-batch through real hub with --descriptions', () => {
const calls = [];
const phase = makePhase({
cmdPhaseAddBatch: (cwd, descriptions, raw) => calls.push({ descriptions }),
});
let errorMsg = null;
routePhaseCommand({
phase,
args: ['phase', 'add-batch', '--descriptions', '["Alpha","Beta"]'],
cwd: '/integration',
raw: false,
error: (m) => { errorMsg = m; },
});
assert.equal(errorMsg, null, `unexpected error: ${errorMsg}`);
assert.deepEqual(calls[0].descriptions, ['Alpha', 'Beta']);
});
});