* refactor(hub): tighten Result<T> to typed-payload-per-kind discriminated union (#176) Each Hub error variant now carries only its own typed payload. The generic `errorKind` field is renamed to `kind`; `message`/`details` escape hatches are removed from Hub-emitted errors. Factory functions (makeUnknownCommand, makeInvalidArgs, makeHandlerRefusal, makeHandlerFailure) are exported and used in phase-command-router.cjs. Callers switch on `result.kind`. Part of ADR-0174 P1.2. <!-- docs-exempt: no docs/ changes; API is internal to Hub callers --> Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix(hub): act on P1.2 review findings (#176) Addresses 4 review findings on PR #221: - Hub now runtime-validates ok:false variants against the typed shape and coerces malformed returns to HandlerFailure with a contract- violation message (codex finding #1, code-review finding #1) - catch path now preserves the original throwable for non-Error throws via an Error wrapper with .thrown attached (codex finding #2) - All 4 factory returns are Object.freeze'd (review finding #9) - makeHandlerFailure validates cause is Error; non-Error causes are wrapped with .thrown attached (review finding #10) Tests added for each finding (TDD red → green). Refs #176. Part of #174. * fix(docs-lint): add docs-exempt markers to both P1.2 changeset fragments Both `176-typed-result-discriminated-union.md` and `176-hub-p1.2-review-findings.md` carry `type: Changed` which triggers the docs-required lint. Neither fragment had a `<!-- docs-exempt: <reason> -->` marker, causing `docs-lint` to fail with `FAIL_DOCS_MISSING`. Added the per-fragment exemption marker to both (the repo has no `no-docs` label). This is a purely internal SDK refactor (ADR-0174 P1.2) with no public docs surface. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
849 lines
31 KiB
JavaScript
849 lines
31 KiB
JavaScript
'use strict';
|
|
|
|
/**
|
|
* Behavioral contract tests for the CommandRoutingHub (issue #3788, #175).
|
|
*
|
|
* #175: mode/sdkLoader/SdkDispatchFailed dropped. Hub always routes CJS.
|
|
*
|
|
* Testing rules in force (CONTRIBUTING.md § Testing Standards):
|
|
* 1. No readFileSync of source files. All assertions are on return values
|
|
* from the hub's dispatch() function.
|
|
* 2. Stub cjsRegistry / manifest — the hub is the unit under test.
|
|
* No real SDK load, no real CJS handler invocation (except one integration
|
|
* path in the phase-command-router migration tests).
|
|
* 3. ERROR_KINDS is a frozen enum. Tests switch on its values, not string literals.
|
|
* 4. Hub must never throw. Every error surface arrives as { ok: false, ... }.
|
|
*/
|
|
|
|
const { describe, test } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
|
|
const {
|
|
createHub,
|
|
ERROR_KINDS,
|
|
makeUnknownCommand,
|
|
makeInvalidArgs,
|
|
makeHandlerRefusal,
|
|
makeHandlerFailure,
|
|
} = require('../get-shit-done/bin/lib/command-routing-hub.cjs');
|
|
|
|
// ─── Frozen taxonomy lock ─────────────────────────────────────────────────────
|
|
// #175: SdkDispatchFailed and SdkLoadFailed are removed from the closed enum.
|
|
// The set shrinks from 6 to 4 values.
|
|
const EXPECTED_ERROR_KINDS = Object.freeze(new Set([
|
|
'UnknownCommand',
|
|
'InvalidArgs',
|
|
'HandlerRefusal',
|
|
'HandlerFailure',
|
|
]));
|
|
|
|
describe('CommandRoutingHub — ERROR_KINDS taxonomy', () => {
|
|
test('exports a frozen ERROR_KINDS object', () => {
|
|
assert.ok(Object.isFrozen(ERROR_KINDS), 'ERROR_KINDS must be frozen');
|
|
});
|
|
|
|
test('ERROR_KINDS contains exactly the 4 documented values (SdkDispatchFailed and SdkLoadFailed removed)', () => {
|
|
const actual = new Set(Object.values(ERROR_KINDS));
|
|
assert.deepStrictEqual(actual, EXPECTED_ERROR_KINDS);
|
|
});
|
|
|
|
test('ERROR_KINDS does NOT contain SdkDispatchFailed', () => {
|
|
assert.ok(!Object.values(ERROR_KINDS).includes('SdkDispatchFailed'),
|
|
'SdkDispatchFailed must not be in ERROR_KINDS after #175');
|
|
});
|
|
|
|
test('ERROR_KINDS does NOT contain SdkLoadFailed', () => {
|
|
assert.ok(!Object.values(ERROR_KINDS).includes('SdkLoadFailed'),
|
|
'SdkLoadFailed must not be in ERROR_KINDS after #175');
|
|
});
|
|
|
|
test('ERROR_KINDS keys match their values (self-documenting enum)', () => {
|
|
for (const [key, value] of Object.entries(ERROR_KINDS)) {
|
|
assert.equal(key, value, `ERROR_KINDS.${key} should equal '${key}' but got '${value}'`);
|
|
}
|
|
});
|
|
});
|
|
|
|
// ─── createHub validation ──────────────────────────────────────────────────────
|
|
// #175: mode param is removed. Hub is constructed without mode.
|
|
|
|
describe('CommandRoutingHub — createHub validation', () => {
|
|
test('constructs successfully without any mode parameter', () => {
|
|
// Hub no longer requires mode — no throw when mode is absent
|
|
const hub = createHub({ cjsRegistry: {} });
|
|
assert.ok(typeof hub.dispatch === 'function');
|
|
});
|
|
|
|
test('mode parameter is ignored — passing mode: sdk does not route to SDK', () => {
|
|
// Even if a legacy caller passes mode:'sdk', the hub must use CJS dispatch.
|
|
const cjsCalls = [];
|
|
const hub = createHub({
|
|
mode: 'sdk',
|
|
cjsRegistry: {
|
|
phase: {
|
|
add: (_ctx) => { cjsCalls.push(true); return { ok: true, data: 'cjs-dispatched' }; },
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'add', args: [], cwd: '/', raw: false });
|
|
|
|
// Must route through CJS, not SDK
|
|
assert.ok(result.ok, `Expected ok:true but got: ${JSON.stringify(result)}`);
|
|
assert.equal(result.data, 'cjs-dispatched', 'Hub must dispatch through CJS regardless of mode parameter');
|
|
assert.equal(cjsCalls.length, 1, 'CJS handler must be called exactly once');
|
|
});
|
|
|
|
test('mode parameter is ignored — passing mode: cjs also routes through CJS', () => {
|
|
const cjsCalls = [];
|
|
const hub = createHub({
|
|
mode: 'cjs',
|
|
cjsRegistry: {
|
|
state: {
|
|
load: (_ctx) => { cjsCalls.push(true); return { ok: true, data: 'state-loaded' }; },
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'state', subcommand: 'load', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(result.ok);
|
|
assert.equal(result.data, 'state-loaded');
|
|
assert.equal(cjsCalls.length, 1);
|
|
});
|
|
|
|
test('sdkLoader parameter is inert — passing sdkLoader does not cause SDK dispatch', () => {
|
|
// sdkLoader is removed; passing it must not cause the Hub to call it
|
|
const sdkCalls = [];
|
|
const hub = createHub({
|
|
sdkLoader: () => { sdkCalls.push(true); return () => ({ ok: true, data: 'sdk-data' }); },
|
|
cjsRegistry: {
|
|
phase: {
|
|
add: (_ctx) => ({ ok: true, data: 'cjs-data' }),
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'add', args: [], cwd: '/', raw: false });
|
|
|
|
assert.equal(sdkCalls.length, 0, 'sdkLoader must never be called — it is removed in #175');
|
|
assert.ok(result.ok);
|
|
assert.equal(result.data, 'cjs-data');
|
|
});
|
|
|
|
test('constructs successfully with only cjsRegistry', () => {
|
|
const hub = createHub({ cjsRegistry: { phase: { add: () => ({ ok: true, data: null }) } } });
|
|
assert.ok(typeof hub.dispatch === 'function');
|
|
});
|
|
});
|
|
|
|
// ─── Happy path — always CJS ──────────────────────────────────────────────────
|
|
|
|
describe('CommandRoutingHub — happy path, CJS dispatch', () => {
|
|
test('dispatch returns { ok: true, data } from CJS handler result', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
phase: {
|
|
complete: (_ctx) => ({ ok: true, data: { completed: true } }),
|
|
},
|
|
},
|
|
manifest: { phase: ['complete'] },
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'complete', args: ['01'], cwd: '/tmp', raw: false });
|
|
|
|
assert.ok(result.ok);
|
|
assert.deepEqual(result.data, { completed: true });
|
|
});
|
|
|
|
test('dispatch passes full context to CJS handler', () => {
|
|
const received = [];
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
roadmap: {
|
|
analyze: (ctx) => { received.push(ctx); return { ok: true, data: null }; },
|
|
},
|
|
},
|
|
});
|
|
|
|
hub.dispatch({ family: 'roadmap', subcommand: 'analyze', args: ['--verbose'], cwd: '/myproj', raw: true });
|
|
|
|
assert.equal(received.length, 1);
|
|
assert.equal(received[0].family, 'roadmap');
|
|
assert.equal(received[0].subcommand, 'analyze');
|
|
assert.deepEqual(received[0].args, ['--verbose']);
|
|
assert.equal(received[0].cwd, '/myproj');
|
|
assert.equal(received[0].raw, true);
|
|
});
|
|
|
|
test('handler returning undefined is treated as ok:true with data:null', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
state: {
|
|
load: (_ctx) => undefined,
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'state', subcommand: 'load', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(result.ok);
|
|
assert.equal(result.data, null);
|
|
});
|
|
|
|
test('handler returning a plain value wraps it as data payload', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
verify: {
|
|
check: (_ctx) => 'all-good',
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'verify', subcommand: 'check', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(result.ok);
|
|
assert.equal(result.data, 'all-good');
|
|
});
|
|
});
|
|
|
|
// ─── kind: UnknownCommand ─────────────────────────────────────────────────────
|
|
|
|
describe('CommandRoutingHub — kind: UnknownCommand', () => {
|
|
test('unknown family in manifest returns UnknownCommand', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {},
|
|
manifest: { phase: ['add'] },
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'bogus', subcommand: 'add', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.UnknownCommand);
|
|
});
|
|
|
|
test('unknown subcommand in manifest returns UnknownCommand', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {},
|
|
manifest: { phase: ['add'] },
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'nonexistent', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.UnknownCommand);
|
|
});
|
|
|
|
test('missing family in cjsRegistry returns UnknownCommand (no manifest)', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: { state: { load: () => ({ ok: true, data: null }) } },
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'bogus-family', subcommand: 'sub', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.UnknownCommand);
|
|
});
|
|
|
|
test('missing subcommand in cjsRegistry returns UnknownCommand', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: { phase: { add: () => ({ ok: true, data: null }) } },
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'not-there', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.UnknownCommand);
|
|
});
|
|
});
|
|
|
|
// ─── kind: InvalidArgs ────────────────────────────────────────────────────────
|
|
|
|
describe('CommandRoutingHub — kind: InvalidArgs', () => {
|
|
test('handler returning InvalidArgs result propagates it', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
phase: {
|
|
insert: (_ctx) => ({
|
|
ok: false,
|
|
kind: ERROR_KINDS.InvalidArgs,
|
|
arg: 'phase-number',
|
|
reason: 'phase insert requires a phase number',
|
|
}),
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'insert', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.InvalidArgs);
|
|
assert.ok(result.reason.includes('phase number'));
|
|
});
|
|
});
|
|
|
|
// ─── kind: HandlerRefusal ─────────────────────────────────────────────────────
|
|
|
|
describe('CommandRoutingHub — kind: HandlerRefusal', () => {
|
|
test('handler returning HandlerRefusal result propagates it', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
phase: {
|
|
'list-plans': (_ctx) => ({
|
|
ok: false,
|
|
kind: ERROR_KINDS.HandlerRefusal,
|
|
reason: 'phase list-plans is SDK-only',
|
|
}),
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'list-plans', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.HandlerRefusal);
|
|
});
|
|
});
|
|
|
|
// ─── kind: HandlerFailure ─────────────────────────────────────────────────────
|
|
|
|
describe('CommandRoutingHub — kind: HandlerFailure', () => {
|
|
test('hub does not throw when CJS handler throws — returns HandlerFailure', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
phase: {
|
|
add: (_ctx) => { throw new Error('handler blew up'); },
|
|
},
|
|
},
|
|
});
|
|
|
|
let result;
|
|
assert.doesNotThrow(() => {
|
|
result = hub.dispatch({ family: 'phase', subcommand: 'add', args: ['desc'], cwd: '/', raw: false });
|
|
});
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.HandlerFailure);
|
|
assert.ok(result.message.includes('handler blew up'));
|
|
});
|
|
|
|
test('HandlerFailure cause carries the thrown error', () => {
|
|
const originalError = new Error('boom');
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
state: {
|
|
load: (_ctx) => { throw originalError; },
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'state', subcommand: 'load', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.HandlerFailure);
|
|
assert.strictEqual(result.cause, originalError);
|
|
});
|
|
});
|
|
|
|
// ─── hub never throws ─────────────────────────────────────────────────────────
|
|
|
|
describe('CommandRoutingHub — hub never throws', () => {
|
|
test('hub does not throw even when cjsRegistry is completely absent', () => {
|
|
const hub = createHub({});
|
|
|
|
let result;
|
|
assert.doesNotThrow(() => {
|
|
result = hub.dispatch({ family: 'phase', subcommand: 'add', args: [], cwd: '/', raw: false });
|
|
});
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.UnknownCommand);
|
|
});
|
|
|
|
test('hub does not throw when dispatch receives malformed request', () => {
|
|
const hub = createHub({ cjsRegistry: {} });
|
|
|
|
let result;
|
|
assert.doesNotThrow(() => {
|
|
// Missing family — would normally throw on string ops
|
|
result = hub.dispatch({ family: undefined, subcommand: 'add', args: [], cwd: '/', raw: false });
|
|
});
|
|
|
|
// Result is an error, not a thrown exception
|
|
assert.ok(!result.ok);
|
|
});
|
|
});
|
|
|
|
// ─── P1.2: Typed-payload discriminated union (#176) ──────────────────────────
|
|
// Each error variant carries ONLY its own typed payload.
|
|
// `errorKind` field renamed to `kind`; generic `message`/`details` removed
|
|
// from variants that have dedicated fields.
|
|
|
|
describe('CommandRoutingHub — P1.2 typed-payload discriminated union (#176)', () => {
|
|
// ── UnknownCommand: { ok, kind, command } — no message, no details ──────────
|
|
test('UnknownCommand has exactly { ok, kind, command } — nothing else', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {},
|
|
manifest: { phase: ['add'] },
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'bogus', subcommand: 'add', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.UnknownCommand);
|
|
assert.equal(typeof result.command, 'string');
|
|
assert.ok(result.command.length > 0, 'command field must be non-empty');
|
|
// Strict field set — no errorKind, no message, no details
|
|
const keys = Object.keys(result).sort();
|
|
assert.deepStrictEqual(keys, ['command', 'kind', 'ok']);
|
|
});
|
|
|
|
test('UnknownCommand for unknown subcommand carries the command string', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {},
|
|
manifest: { phase: ['add'] },
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'nonexistent', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.UnknownCommand);
|
|
assert.ok(result.command.includes('nonexistent'), `Expected command to include 'nonexistent', got: ${result.command}`);
|
|
});
|
|
|
|
test('UnknownCommand from missing cjsRegistry family carries the command string', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: { state: { load: () => ({ ok: true, data: null }) } },
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'bogus-family', subcommand: 'sub', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.UnknownCommand);
|
|
assert.ok(result.command.includes('bogus-family'), `Expected command to include 'bogus-family', got: ${result.command}`);
|
|
});
|
|
|
|
// ── InvalidArgs: { ok, kind, arg, reason } — no message, no details ─────────
|
|
test('InvalidArgs result from handler is propagated with kind/arg/reason fields', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
phase: {
|
|
insert: (_ctx) => ({
|
|
ok: false,
|
|
kind: ERROR_KINDS.InvalidArgs,
|
|
arg: '--dry-run',
|
|
reason: 'phase insert does not support --dry-run',
|
|
}),
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'insert', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.InvalidArgs);
|
|
assert.equal(result.arg, '--dry-run');
|
|
assert.ok(result.reason.includes('--dry-run'));
|
|
// Strict field set
|
|
const keys = Object.keys(result).sort();
|
|
assert.deepStrictEqual(keys, ['arg', 'kind', 'ok', 'reason']);
|
|
});
|
|
|
|
// ── HandlerRefusal: { ok, kind, reason } — no message, no details ────────────
|
|
test('HandlerRefusal result from handler is propagated with kind/reason fields', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
phase: {
|
|
'list-plans': (_ctx) => ({
|
|
ok: false,
|
|
kind: ERROR_KINDS.HandlerRefusal,
|
|
reason: 'phase list-plans is SDK-only',
|
|
}),
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'list-plans', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.HandlerRefusal);
|
|
assert.ok(result.reason.includes('SDK-only'));
|
|
// Strict field set
|
|
const keys = Object.keys(result).sort();
|
|
assert.deepStrictEqual(keys, ['kind', 'ok', 'reason']);
|
|
});
|
|
|
|
// ── HandlerFailure: { ok, kind, message, cause? } — cause carries the Error ──
|
|
test('HandlerFailure from throw has { ok, kind, message, cause } — no details', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
phase: {
|
|
add: (_ctx) => { throw new Error('handler blew up'); },
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'add', args: ['desc'], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.HandlerFailure);
|
|
assert.ok(result.message.includes('handler blew up'));
|
|
assert.ok(result.cause instanceof Error);
|
|
// Strict field set (cause present when Error thrown)
|
|
const keys = Object.keys(result).sort();
|
|
assert.deepStrictEqual(keys, ['cause', 'kind', 'message', 'ok']);
|
|
});
|
|
|
|
test('HandlerFailure cause carries the original thrown Error object', () => {
|
|
const originalError = new Error('boom');
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
state: {
|
|
load: (_ctx) => { throw originalError; },
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'state', subcommand: 'load', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.HandlerFailure);
|
|
assert.strictEqual(result.cause, originalError);
|
|
});
|
|
|
|
// ── ERROR_KINDS values used as `kind` discriminator — still work ─────────────
|
|
test('ERROR_KINDS.UnknownCommand === result.kind for UnknownCommand', () => {
|
|
const hub = createHub({ cjsRegistry: {} });
|
|
const result = hub.dispatch({ family: 'nope', subcommand: 'x', args: [], cwd: '/', raw: false });
|
|
assert.equal(result.kind, ERROR_KINDS.UnknownCommand);
|
|
});
|
|
|
|
test('ERROR_KINDS values are stable string constants matching their key names', () => {
|
|
assert.equal(ERROR_KINDS.UnknownCommand, 'UnknownCommand');
|
|
assert.equal(ERROR_KINDS.InvalidArgs, 'InvalidArgs');
|
|
assert.equal(ERROR_KINDS.HandlerRefusal, 'HandlerRefusal');
|
|
assert.equal(ERROR_KINDS.HandlerFailure, 'HandlerFailure');
|
|
});
|
|
});
|
|
|
|
// ─── No SDK path — single-dispatch invariant ──────────────────────────────────
|
|
// #175: Hub is always CJS. There is no SDK path to fall through to.
|
|
|
|
describe('CommandRoutingHub — single CJS dispatch invariant (#175)', () => {
|
|
test('two dispatches through the same hub produce consistent CJS results', () => {
|
|
const calls = [];
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
phase: {
|
|
add: (_ctx) => { calls.push('add'); return { ok: true, data: 'added' }; },
|
|
complete: (_ctx) => { calls.push('complete'); return { ok: true, data: 'done' }; },
|
|
},
|
|
},
|
|
});
|
|
|
|
const r1 = hub.dispatch({ family: 'phase', subcommand: 'add', args: [], cwd: '/', raw: false });
|
|
const r2 = hub.dispatch({ family: 'phase', subcommand: 'complete', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(r1.ok);
|
|
assert.equal(r1.data, 'added');
|
|
assert.ok(r2.ok);
|
|
assert.equal(r2.data, 'done');
|
|
assert.deepEqual(calls, ['add', 'complete']);
|
|
});
|
|
|
|
test('manifest check still applies in CJS-only hub', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: { phase: { add: () => ({ ok: true, data: null }) } },
|
|
manifest: { phase: ['add'] },
|
|
});
|
|
|
|
const known = hub.dispatch({ family: 'phase', subcommand: 'add', args: [], cwd: '/', raw: false });
|
|
const unknown = hub.dispatch({ family: 'phase', subcommand: 'nonexistent', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(known.ok);
|
|
assert.ok(!unknown.ok);
|
|
assert.equal(unknown.kind, ERROR_KINDS.UnknownCommand);
|
|
});
|
|
});
|
|
|
|
// ─── P1.2 Review Finding 1: Hub runtime-validates ok:false handler returns ────
|
|
// A handler that returns { ok: false, kind: 'InvalidArgs', message: 'oops' }
|
|
// (missing `reason`, has stray `message`) must NOT pass through unchanged.
|
|
// Hub must coerce it to a HandlerFailure with a contract-violation message.
|
|
|
|
describe('CommandRoutingHub — Finding 1: runtime-validation of handler ok:false returns', () => {
|
|
test('malformed InvalidArgs return (missing reason, has stray message) is coerced to HandlerFailure', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
phase: {
|
|
add: (_ctx) => ({
|
|
ok: false,
|
|
kind: 'InvalidArgs',
|
|
message: 'oops', // wrong: should be reason, not message
|
|
// missing: arg, reason
|
|
}),
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'add', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok, 'result must be an error');
|
|
assert.equal(result.kind, ERROR_KINDS.HandlerFailure,
|
|
`Expected HandlerFailure but got kind: ${result.kind}`);
|
|
assert.ok(
|
|
result.message.includes('malformed') || result.message.includes('contract') ||
|
|
result.message.includes('InvalidArgs') || result.message.includes('reason'),
|
|
`Expected contract-violation message, got: ${result.message}`
|
|
);
|
|
});
|
|
|
|
test('malformed HandlerRefusal return (missing reason) is coerced to HandlerFailure', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
phase: {
|
|
add: (_ctx) => ({
|
|
ok: false,
|
|
kind: 'HandlerRefusal',
|
|
message: 'refuse', // wrong: should be reason
|
|
// missing: reason
|
|
}),
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'add', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.HandlerFailure);
|
|
assert.ok(typeof result.message === 'string' && result.message.length > 0);
|
|
});
|
|
|
|
test('malformed HandlerFailure return (missing message) is coerced to HandlerFailure', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
phase: {
|
|
add: (_ctx) => ({
|
|
ok: false,
|
|
kind: 'HandlerFailure',
|
|
// missing: message
|
|
details: 'something', // extraneous
|
|
}),
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'add', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.HandlerFailure);
|
|
assert.ok(typeof result.message === 'string' && result.message.length > 0);
|
|
});
|
|
|
|
test('well-formed InvalidArgs return is NOT coerced — passes through unchanged', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
phase: {
|
|
add: (_ctx) => ({
|
|
ok: false,
|
|
kind: 'InvalidArgs',
|
|
arg: '--dry-run',
|
|
reason: 'not supported',
|
|
}),
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'add', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.InvalidArgs);
|
|
assert.equal(result.arg, '--dry-run');
|
|
assert.equal(result.reason, 'not supported');
|
|
});
|
|
|
|
test('unknown kind in ok:false return is coerced to HandlerFailure', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
phase: {
|
|
add: (_ctx) => ({
|
|
ok: false,
|
|
kind: 'SomeLegacyKind',
|
|
errorKind: 'SomeLegacyKind',
|
|
}),
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'add', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.HandlerFailure);
|
|
});
|
|
});
|
|
|
|
// ─── P1.2 Review Finding 2: Non-Error throws preserve the original throwable ──
|
|
// When a handler throws a non-Error (plain object, string, number), the Hub must
|
|
// wrap it in an Error and attach .thrown = originalValue.
|
|
|
|
describe('CommandRoutingHub — Finding 2: non-Error throws preserve original throwable', () => {
|
|
test('handler throwing a plain object → HandlerFailure with cause.thrown === original', () => {
|
|
const thrown = { custom: 'payload', code: 42 };
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
phase: {
|
|
add: (_ctx) => { throw thrown; },
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'add', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.HandlerFailure);
|
|
assert.ok(result.cause instanceof Error,
|
|
`result.cause must be an Error, got: ${typeof result.cause}`);
|
|
assert.strictEqual(result.cause.thrown, thrown,
|
|
'cause.thrown must be the original thrown object');
|
|
});
|
|
|
|
test('handler throwing a string → HandlerFailure with cause.thrown === original string', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
phase: {
|
|
add: (_ctx) => { throw 'just a string'; },
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'add', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.HandlerFailure);
|
|
assert.ok(result.cause instanceof Error,
|
|
`result.cause must be an Error, got: ${typeof result.cause}`);
|
|
assert.strictEqual(result.cause.thrown, 'just a string',
|
|
'cause.thrown must be the original thrown string');
|
|
});
|
|
|
|
test('handler throwing a number → HandlerFailure with cause.thrown === original number', () => {
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
phase: {
|
|
add: (_ctx) => { throw 404; },
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'add', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.HandlerFailure);
|
|
assert.ok(result.cause instanceof Error);
|
|
assert.strictEqual(result.cause.thrown, 404);
|
|
});
|
|
|
|
test('handler throwing a real Error still works — cause is the Error itself (no .thrown wrapping)', () => {
|
|
const original = new Error('real error');
|
|
const hub = createHub({
|
|
cjsRegistry: {
|
|
phase: {
|
|
add: (_ctx) => { throw original; },
|
|
},
|
|
},
|
|
});
|
|
|
|
const result = hub.dispatch({ family: 'phase', subcommand: 'add', args: [], cwd: '/', raw: false });
|
|
|
|
assert.ok(!result.ok);
|
|
assert.equal(result.kind, ERROR_KINDS.HandlerFailure);
|
|
assert.strictEqual(result.cause, original, 'Error throws must have cause === original Error');
|
|
// No .thrown on real Error cause
|
|
assert.equal(result.cause.thrown, undefined);
|
|
});
|
|
});
|
|
|
|
// ─── P1.2 Review Finding 3: Factory returns are Object.frozen ─────────────────
|
|
// Each makeXxx factory must return a frozen object so callers cannot mutate
|
|
// the variant invariant.
|
|
|
|
describe('CommandRoutingHub — Finding 3: factory returns are Object.frozen', () => {
|
|
test('makeUnknownCommand returns a frozen object', () => {
|
|
const result = makeUnknownCommand('phase bogus');
|
|
assert.ok(Object.isFrozen(result),
|
|
'makeUnknownCommand must return a frozen object');
|
|
});
|
|
|
|
test('makeInvalidArgs returns a frozen object', () => {
|
|
const result = makeInvalidArgs('--dry-run', 'not supported');
|
|
assert.ok(Object.isFrozen(result),
|
|
'makeInvalidArgs must return a frozen object');
|
|
});
|
|
|
|
test('makeHandlerRefusal returns a frozen object', () => {
|
|
const result = makeHandlerRefusal('SDK-only');
|
|
assert.ok(Object.isFrozen(result),
|
|
'makeHandlerRefusal must return a frozen object');
|
|
});
|
|
|
|
test('makeHandlerFailure returns a frozen object', () => {
|
|
const result = makeHandlerFailure('something broke', new Error('orig'));
|
|
assert.ok(Object.isFrozen(result),
|
|
'makeHandlerFailure must return a frozen object');
|
|
});
|
|
|
|
test('frozen factory results cannot be mutated', () => {
|
|
const result = makeUnknownCommand('phase bogus');
|
|
// In strict mode, mutation of a frozen object throws TypeError
|
|
assert.throws(
|
|
() => { result.command = 'tampered'; },
|
|
TypeError,
|
|
'Mutating a frozen factory result must throw TypeError'
|
|
);
|
|
});
|
|
});
|
|
|
|
// ─── P1.2 Review Finding 4: makeHandlerFailure wraps non-Error causes ─────────
|
|
// If cause is provided but is not an Error, wrap it so .cause instanceof Error.
|
|
// Attach .thrown = originalCause so it is not silently dropped.
|
|
|
|
describe('CommandRoutingHub — Finding 4: makeHandlerFailure wraps non-Error causes', () => {
|
|
test('makeHandlerFailure("msg", "string-cause") → cause instanceof Error', () => {
|
|
const result = makeHandlerFailure('msg', 'string-cause');
|
|
assert.ok(result.cause instanceof Error,
|
|
`cause must be an Error, got: ${typeof result.cause}`);
|
|
});
|
|
|
|
test('makeHandlerFailure("msg", "string-cause") → cause.thrown === "string-cause"', () => {
|
|
const result = makeHandlerFailure('msg', 'string-cause');
|
|
assert.strictEqual(result.cause.thrown, 'string-cause',
|
|
'cause.thrown must be the original non-Error cause');
|
|
});
|
|
|
|
test('makeHandlerFailure with a plain object cause → cause instanceof Error with .thrown', () => {
|
|
const obj = { code: 42, detail: 'bad' };
|
|
const result = makeHandlerFailure('msg', obj);
|
|
assert.ok(result.cause instanceof Error);
|
|
assert.strictEqual(result.cause.thrown, obj);
|
|
});
|
|
|
|
test('makeHandlerFailure with a real Error cause → cause is the original Error (no wrapping)', () => {
|
|
const original = new Error('real');
|
|
const result = makeHandlerFailure('msg', original);
|
|
assert.strictEqual(result.cause, original,
|
|
'Real Error causes must not be wrapped');
|
|
});
|
|
|
|
test('makeHandlerFailure without cause → result.cause is undefined', () => {
|
|
const result = makeHandlerFailure('msg');
|
|
assert.equal(result.cause, undefined);
|
|
});
|
|
|
|
test('makeHandlerFailure with null cause → behaves as no cause (undefined)', () => {
|
|
// null is not an Error, but "not provided" — treat as absent
|
|
const result = makeHandlerFailure('msg', null);
|
|
// null should not be wrapped into an Error — it's equivalent to "no cause"
|
|
assert.equal(result.cause, undefined);
|
|
});
|
|
});
|