Batch 13 of the ad hoc timeout literal migration (epic #4445). Replaces every bare numeric timeoutMs object-literal property in tests/task-content-resolution.test.cjs, tests/task-command-router-resolve-content.test.cjs, and tests/task-content-resolver-grammar-parity.test.cjs with a named constant, per eslint-rules/no-adhoc-timeout-literal.cjs. Removes these 3 files from the rule's allowlist. Every one of the 13 sites describes the same field -- a task-content- resolver manifest's invoke.timeoutMs -- as fixture/validation data; none is a real subprocess spawn timeout, verified by tracing each site to a pure function, a garbage-shape rejection path, or a fully-injected fake exec function. Adds one new shared constant, TASK_RESOLVER_INVOKE_TIMEOUT_MS, used by 2 files in this batch (crossing the promotion bar). Adds file-local constants for a value used by only 1 file, plus three deliberately-invalid values (zero, negative, non-integer) inside one findResolver garbage-shapes test proving the validator rejects a malformed manifest regardless of which way its timeout is invalid. Also fixes a review-caught defect outside the mechanical rule's own scope: a bare-literal duplicate of the new shared constant inside a ResolverTimeoutError assertion (a call argument, not an object-literal property, so the lint rule never flagged it) -- renamed in this same PR per the no-deferrals rule. No src/bin file touched, no numeric value changed anywhere. Co-authored-by: sim <sim@local> Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
361 lines
16 KiB
JavaScript
361 lines
16 KiB
JavaScript
'use strict';
|
|
|
|
// Task Content Resolution Module tests (ADR-3646 Phase 1, #3970).
|
|
// Covers test matrix rows 5-16 (.gsd/phase/feat-3970-task-content-resolution-seam/50-test-matrix.md).
|
|
// Every subprocess call is a fake execFn — never a real spawn, never a real
|
|
// timeout wait (CLAUDE.md's clock-seam rule).
|
|
|
|
const { test } = require('node:test');
|
|
const assert = require('node:assert');
|
|
const fc = require('fast-check');
|
|
const { TASK_RESOLVER_INVOKE_TIMEOUT_MS } = require('./helpers/timeouts.cjs');
|
|
|
|
const m = require('../gsd-core/bin/lib/task-content-resolution.cjs');
|
|
const {
|
|
TASK_CONTENT_RESULT,
|
|
splitTrackerId,
|
|
findResolver,
|
|
buildInvocation,
|
|
resolveTaskContent,
|
|
ResolverAmbiguousError,
|
|
ResolverFailedError,
|
|
ResolverTimeoutError,
|
|
ResolverMalformedOutputError,
|
|
} = m;
|
|
|
|
/**
|
|
* NOT a subprocess spawn timeout. Fixture DATA: a plausible-looking
|
|
* invoke.timeoutMs value used as filler in tests whose actual assertion is
|
|
* about something ELSE in the manifest (a substring-vs-placeholder
|
|
* distinction, a missing {{id}} placeholder, an empty binary field) -- the
|
|
* timeout value itself is never the thing under test at these sites.
|
|
*/
|
|
const TASK_RESOLVER_INVOKE_FILLER_TIMEOUT_MS = 1000;
|
|
|
|
/** NOT a subprocess spawn timeout. Fixture DATA: a deliberately-invalid (zero) invoke.timeoutMs value in a findResolver garbage-shapes test, proving a zero timeout is rejected. */
|
|
const INVALID_TIMEOUT_ZERO_MS = 0;
|
|
/** NOT a subprocess spawn timeout. Fixture DATA: a deliberately-invalid (negative) invoke.timeoutMs value in a findResolver garbage-shapes test, proving a negative timeout is rejected. */
|
|
const INVALID_TIMEOUT_NEGATIVE_MS = -5;
|
|
/** NOT a subprocess spawn timeout. Fixture DATA: a deliberately-invalid (non-integer) invoke.timeoutMs value in a findResolver garbage-shapes test, proving a non-integer timeout is rejected. */
|
|
const INVALID_TIMEOUT_NON_INTEGER_MS = 1.5;
|
|
|
|
function beadsCapability(overrides = {}) {
|
|
return {
|
|
id: 'beads-capability',
|
|
taskContentResolver: {
|
|
trackerPrefix: 'beads',
|
|
invoke: {
|
|
binary: 'bd',
|
|
args: ['show', '{{id}}', '--json'],
|
|
timeoutMs: TASK_RESOLVER_INVOKE_TIMEOUT_MS,
|
|
},
|
|
...overrides,
|
|
},
|
|
};
|
|
}
|
|
|
|
function timeoutError() {
|
|
const e = new Error('spawnSync bd ETIMEDOUT');
|
|
e.code = 'ETIMEDOUT';
|
|
return e;
|
|
}
|
|
|
|
// ─── splitTrackerId — pure ─────────────────────────────────────────────────────
|
|
|
|
test('splitTrackerId returns null for null and empty input', () => {
|
|
assert.strictEqual(splitTrackerId(null), null);
|
|
assert.strictEqual(splitTrackerId(''), null);
|
|
});
|
|
|
|
test('splitTrackerId splits on the first colon', () => {
|
|
assert.deepStrictEqual(splitTrackerId('beads:GSD-42'), { prefix: 'beads', id: 'GSD-42' });
|
|
});
|
|
|
|
test('splitTrackerId with no colon returns null (row 16 boundary partner)', () => {
|
|
assert.strictEqual(splitTrackerId('noprefix'), null);
|
|
});
|
|
|
|
test('id containing colons splits on first colon only (row 16)', () => {
|
|
assert.deepStrictEqual(
|
|
splitTrackerId('beads:issue:GSD-1'),
|
|
{ prefix: 'beads', id: 'issue:GSD-1' },
|
|
);
|
|
});
|
|
|
|
// ─── buildInvocation — pure ─────────────────────────────────────────────────────
|
|
|
|
test('buildInvocation replaces every {{id}} entry with the literal id', () => {
|
|
const resolver = { invoke: { binary: 'bd', args: ['show', '{{id}}', '--json'], timeoutMs: TASK_RESOLVER_INVOKE_TIMEOUT_MS } };
|
|
assert.deepStrictEqual(buildInvocation(resolver, 'GSD-42'), {
|
|
binary: 'bd',
|
|
args: ['show', 'GSD-42', '--json'],
|
|
timeoutMs: TASK_RESOLVER_INVOKE_TIMEOUT_MS,
|
|
});
|
|
});
|
|
|
|
test('buildInvocation does not touch args that merely contain {{id}} as a substring', () => {
|
|
const resolver = { invoke: { binary: 'bd', args: ['prefix-{{id}}-suffix'], timeoutMs: TASK_RESOLVER_INVOKE_FILLER_TIMEOUT_MS } };
|
|
assert.deepStrictEqual(buildInvocation(resolver, 'X').args, ['prefix-{{id}}-suffix']);
|
|
});
|
|
|
|
// ─── findResolver — pure ─────────────────────────────────────────────────────
|
|
|
|
test('findResolver returns null when zero capabilities match the prefix', () => {
|
|
assert.strictEqual(findResolver('beads', []), null);
|
|
assert.strictEqual(findResolver('beads', [{ id: 'other', taskContentResolver: undefined }]), null);
|
|
});
|
|
|
|
test('findResolver returns the single well-formed match', () => {
|
|
const cap = beadsCapability();
|
|
const result = findResolver('beads', [cap]);
|
|
assert.strictEqual(result.capabilityId, 'beads-capability');
|
|
assert.strictEqual(result.trackerPrefix, 'beads');
|
|
});
|
|
|
|
test('findResolver returns "ambiguous" for two matching capabilities (row 7)', () => {
|
|
const capA = beadsCapability();
|
|
const capB = { ...beadsCapability(), id: 'other-capability' };
|
|
assert.strictEqual(findResolver('beads', [capA, capB]), 'ambiguous');
|
|
});
|
|
|
|
test('findResolver ignores a declaration missing the {{id}} placeholder (row 15)', () => {
|
|
const bad = {
|
|
id: 'bad-capability',
|
|
taskContentResolver: { trackerPrefix: 'beads', invoke: { binary: 'bd', args: ['show'], timeoutMs: TASK_RESOLVER_INVOKE_FILLER_TIMEOUT_MS } },
|
|
};
|
|
assert.strictEqual(findResolver('beads', [bad]), null);
|
|
});
|
|
|
|
test('findResolver ignores garbage taskContentResolver shapes without throwing', () => {
|
|
const garbage = [
|
|
{ id: 'a', taskContentResolver: null },
|
|
{ id: 'b', taskContentResolver: 'not-an-object' },
|
|
{ id: 'c', taskContentResolver: [] },
|
|
{ id: 'd', taskContentResolver: { trackerPrefix: 'beads' } }, // no invoke
|
|
{ id: 'e', taskContentResolver: { trackerPrefix: 'beads', invoke: { binary: '', args: ['{{id}}'], timeoutMs: TASK_RESOLVER_INVOKE_FILLER_TIMEOUT_MS } } },
|
|
{ id: 'f', taskContentResolver: { trackerPrefix: 'beads', invoke: { binary: 'bd', args: ['{{id}}'], timeoutMs: INVALID_TIMEOUT_ZERO_MS } } },
|
|
{ id: 'g', taskContentResolver: { trackerPrefix: 'beads', invoke: { binary: 'bd', args: ['{{id}}'], timeoutMs: INVALID_TIMEOUT_NEGATIVE_MS } } },
|
|
{ id: 'h', taskContentResolver: { trackerPrefix: 'beads', invoke: { binary: 'bd', args: ['{{id}}'], timeoutMs: INVALID_TIMEOUT_NON_INTEGER_MS } } },
|
|
];
|
|
assert.strictEqual(findResolver('beads', garbage), null);
|
|
});
|
|
|
|
// ─── resolveTaskContent — orchestration ─────────────────────────────────────────
|
|
|
|
test('row 5: no tracker-id resolves not-applicable', () => {
|
|
const result = resolveTaskContent({ trackerId: null, capabilities: [beadsCapability()] });
|
|
assert.deepStrictEqual(result, { kind: TASK_CONTENT_RESULT.NOT_APPLICABLE });
|
|
});
|
|
|
|
test('row 6: unmatched prefix resolves no-resolver', () => {
|
|
const result = resolveTaskContent({ trackerId: 'unknownprefix:1', capabilities: [] });
|
|
assert.deepStrictEqual(result, { kind: TASK_CONTENT_RESULT.NO_RESOLVER });
|
|
});
|
|
|
|
test('row 7: ambiguous prefix registration throws, never silently picks one', () => {
|
|
const capA = beadsCapability();
|
|
const capB = { ...beadsCapability(), id: 'other-capability' };
|
|
assert.throws(
|
|
() => resolveTaskContent({ trackerId: 'beads:GSD-42', capabilities: [capA, capB], execFn: () => { throw new Error('must not be called'); } }),
|
|
ResolverAmbiguousError,
|
|
);
|
|
});
|
|
|
|
test('row 8: non-empty description resolves true with mapped content', () => {
|
|
const execFn = () => ({
|
|
status: 0,
|
|
stdout: JSON.stringify({
|
|
description: 'do X',
|
|
verify: 'run tests',
|
|
acceptance_criteria: ['a', 'b'],
|
|
read_first: ['docs/x.md'],
|
|
done: 'X is done',
|
|
}),
|
|
stderr: '',
|
|
});
|
|
const result = resolveTaskContent({ trackerId: 'beads:GSD-42', capabilities: [beadsCapability()], execFn });
|
|
assert.deepStrictEqual(result, {
|
|
kind: TASK_CONTENT_RESULT.RESOLVED,
|
|
content: {
|
|
action: 'do X',
|
|
verify: 'run tests',
|
|
acceptanceCriteria: ['a', 'b'],
|
|
readFirst: ['docs/x.md'],
|
|
done: 'X is done',
|
|
},
|
|
});
|
|
});
|
|
|
|
test('row 9: empty description string resolves empty', () => {
|
|
const execFn = () => ({ status: 0, stdout: JSON.stringify({ description: '' }), stderr: '' });
|
|
const result = resolveTaskContent({ trackerId: 'beads:GSD-42', capabilities: [beadsCapability()], execFn });
|
|
assert.deepStrictEqual(result, { kind: TASK_CONTENT_RESULT.EMPTY });
|
|
});
|
|
|
|
test('row 9b: whitespace-only description resolves empty', () => {
|
|
const execFn = () => ({ status: 0, stdout: JSON.stringify({ description: ' ' }), stderr: '' });
|
|
const result = resolveTaskContent({ trackerId: 'beads:GSD-42', capabilities: [beadsCapability()], execFn });
|
|
assert.deepStrictEqual(result, { kind: TASK_CONTENT_RESULT.EMPTY });
|
|
});
|
|
|
|
test('row 10: absent description resolves empty, same as empty string', () => {
|
|
const execFn = () => ({ status: 0, stdout: JSON.stringify({}), stderr: '' });
|
|
const result = resolveTaskContent({ trackerId: 'beads:GSD-42', capabilities: [beadsCapability()], execFn });
|
|
assert.deepStrictEqual(result, { kind: TASK_CONTENT_RESULT.EMPTY });
|
|
});
|
|
|
|
test('row 11: non-zero resolver exit throws ResolverFailedError, never falls back silently', () => {
|
|
const execFn = () => ({ status: 1, stdout: '', stderr: 'no such issue GSD-42' });
|
|
assert.throws(
|
|
() => resolveTaskContent({ trackerId: 'beads:GSD-42', capabilities: [beadsCapability()], execFn }),
|
|
(err) => {
|
|
assert.ok(err instanceof ResolverFailedError);
|
|
assert.strictEqual(err.exitCode, 1);
|
|
assert.match(err.stderrTail, /no such issue/);
|
|
return true;
|
|
},
|
|
);
|
|
});
|
|
|
|
test('row 11b: a spawn error (e.g. ENOENT) also throws ResolverFailedError', () => {
|
|
const enoent = new Error('spawnSync bd ENOENT');
|
|
enoent.code = 'ENOENT';
|
|
const execFn = () => ({ status: null, stdout: '', stderr: '', error: enoent });
|
|
assert.throws(
|
|
() => resolveTaskContent({ trackerId: 'beads:GSD-42', capabilities: [beadsCapability()], execFn }),
|
|
ResolverFailedError,
|
|
);
|
|
});
|
|
|
|
test('row 12: resolver exceeding timeoutMs throws ResolverTimeoutError (simulated, no real wait)', () => {
|
|
const execFn = () => ({ status: null, stdout: '', stderr: '', error: timeoutError() });
|
|
assert.throws(
|
|
() => resolveTaskContent({ trackerId: 'beads:GSD-42', capabilities: [beadsCapability()], execFn }),
|
|
(err) => {
|
|
assert.ok(err instanceof ResolverTimeoutError);
|
|
assert.strictEqual(err.timeoutMs, TASK_RESOLVER_INVOKE_TIMEOUT_MS);
|
|
return true;
|
|
},
|
|
);
|
|
});
|
|
|
|
test('row 13: malformed JSON stdout throws, is not conflated with empty content', () => {
|
|
const execFn = () => ({ status: 0, stdout: 'not json', stderr: '' });
|
|
assert.throws(
|
|
() => resolveTaskContent({ trackerId: 'beads:GSD-42', capabilities: [beadsCapability()], execFn }),
|
|
ResolverMalformedOutputError,
|
|
);
|
|
});
|
|
|
|
test('row 14: valid JSON non-object stdout (null/array/string/number/bool) throws', () => {
|
|
const cases = [null, [], 'x', 0, true];
|
|
for (const value of cases) {
|
|
const execFn = () => ({ status: 0, stdout: JSON.stringify(value), stderr: '' });
|
|
assert.throws(
|
|
() => resolveTaskContent({ trackerId: 'beads:GSD-42', capabilities: [beadsCapability()], execFn }),
|
|
ResolverMalformedOutputError,
|
|
`expected throw for JSON value ${JSON.stringify(value)}`,
|
|
);
|
|
}
|
|
});
|
|
|
|
test('row 15: invoke.args without {{id}} placeholder is rejected — resolves no-resolver, never spawns', () => {
|
|
const badCapability = {
|
|
id: 'bad-capability',
|
|
taskContentResolver: { trackerPrefix: 'beads', invoke: { binary: 'bd', args: ['show'], timeoutMs: TASK_RESOLVER_INVOKE_FILLER_TIMEOUT_MS } },
|
|
};
|
|
const execFn = () => { throw new Error('must not spawn a rejected declaration'); };
|
|
const result = resolveTaskContent({ trackerId: 'beads:GSD-42', capabilities: [badCapability], execFn });
|
|
assert.deepStrictEqual(result, { kind: TASK_CONTENT_RESULT.NO_RESOLVER });
|
|
});
|
|
|
|
test('row 16: id containing colons splits on first colon only, end to end', () => {
|
|
let capturedArgs = null;
|
|
const execFn = (binary, args) => {
|
|
capturedArgs = args;
|
|
return { status: 0, stdout: JSON.stringify({ description: 'do X' }), stderr: '' };
|
|
};
|
|
const result = resolveTaskContent({ trackerId: 'beads:issue:GSD-1', capabilities: [beadsCapability()], execFn });
|
|
assert.deepStrictEqual(capturedArgs, ['show', 'issue:GSD-1', '--json']);
|
|
assert.strictEqual(result.kind, TASK_CONTENT_RESULT.RESOLVED);
|
|
});
|
|
|
|
// ─── stderr-on-success is not an error (design.md negative space) ──────────────
|
|
|
|
test('stderr output on a successful (exit 0) run is not treated as a failure', () => {
|
|
const execFn = () => ({ status: 0, stdout: JSON.stringify({ description: 'do X' }), stderr: 'informational log line' });
|
|
const result = resolveTaskContent({ trackerId: 'beads:GSD-42', capabilities: [beadsCapability()], execFn });
|
|
assert.strictEqual(result.kind, TASK_CONTENT_RESULT.RESOLVED);
|
|
});
|
|
|
|
// ─── fast-check property test (row 14, gauntlet enumeration) ───────────────────
|
|
|
|
test('property: any valid-JSON-but-not-an-object stdout always throws ResolverMalformedOutputError, never resolves silently', () => {
|
|
fc.assert(
|
|
fc.property(
|
|
fc.oneof(
|
|
fc.constant(null),
|
|
fc.array(fc.anything()),
|
|
fc.string(),
|
|
fc.double(),
|
|
fc.boolean(),
|
|
),
|
|
(value) => {
|
|
const execFn = () => ({ status: 0, stdout: JSON.stringify(value), stderr: '' });
|
|
try {
|
|
resolveTaskContent({ trackerId: 'beads:GSD-42', capabilities: [beadsCapability()], execFn });
|
|
return false;
|
|
} catch (err) {
|
|
return err instanceof ResolverMalformedOutputError;
|
|
}
|
|
},
|
|
),
|
|
{ numRuns: 100 },
|
|
);
|
|
});
|
|
|
|
// ─── stderr/stdout sanitization in .message (security review, #3970) ───────
|
|
// `stderrTail`/`stdoutSample` are UNTRUSTED subprocess-sourced text (the
|
|
// resolver binary and its argv `{{id}}` token come from a PLAN.md
|
|
// `tracker-id` attribute, which is often LLM/agent-authored). Embedding them
|
|
// raw into `.message` would let a hostile or buggy resolver smuggle its own
|
|
// `\n` and forge a second `Error: ` line when a caller (task-command-
|
|
// router.cts's routeResolveContent) writes `.message` to stderr via
|
|
// io.cjs's error(). `formatDiagnosticToken()` (io.cts) is `JSON.stringify`
|
|
// under the hood: it wraps the value in quotes and escapes control
|
|
// characters, including `\n` -> the two-character sequence `\n`, so the
|
|
// result can never span more than one line.
|
|
|
|
test('ResolverFailedError.message has no raw literal newline even when stderrTail smuggles one', () => {
|
|
const hostileStderr = 'real failure text\nError: fake message forged by a hostile resolver';
|
|
const err = new ResolverFailedError('bd', 1, hostileStderr);
|
|
assert.ok(
|
|
!err.message.includes('\n'),
|
|
`expected no raw newline in .message, got: ${JSON.stringify(err.message)}`,
|
|
);
|
|
// The raw field is left untouched for programmatic callers — only the
|
|
// rendered .message is sanitized.
|
|
assert.strictEqual(err.stderrTail, hostileStderr);
|
|
// formatDiagnosticToken === JSON.stringify: the escaped '\n' (backslash-n,
|
|
// two characters) survives inside the JSON-quoted substring.
|
|
assert.ok(err.message.includes('\\n'));
|
|
assert.ok(err.message.includes(JSON.stringify(hostileStderr)));
|
|
});
|
|
|
|
test('ResolverMalformedOutputError.message has no raw literal newline even when stdoutSample smuggles one', () => {
|
|
const hostileStdout = '{"description":"x"\nError: fake message forged by a hostile resolver';
|
|
const err = new ResolverMalformedOutputError('bd', 'stdout is not valid JSON', hostileStdout);
|
|
assert.ok(
|
|
!err.message.includes('\n'),
|
|
`expected no raw newline in .message, got: ${JSON.stringify(err.message)}`,
|
|
);
|
|
assert.strictEqual(err.stdoutSample, hostileStdout);
|
|
assert.ok(err.message.includes('\\n'));
|
|
assert.ok(err.message.includes(JSON.stringify(hostileStdout)));
|
|
});
|
|
|
|
test('ResolverFailedError.message with an empty stderrTail omits the trailing colon segment', () => {
|
|
const err = new ResolverFailedError('bd', 1, '');
|
|
assert.strictEqual(err.message, "resolver command 'bd' exited 1");
|
|
});
|