Files
msd-core/tests/task-content-resolution.test.cjs
Tom Boucher dd4f179672 feat(#3970): per-task external-tracker content-resolution seam (#4000)
* feat(#3970): per-task external-tracker content-resolution seam

Implements ADR-3646 (Phase 1, #3970): a `<task tracker-id="...">` attribute
plus a new optional `taskContentResolver` capability-manifest field let a
capability resolve a task's action/verify/acceptance-criteria/read_first/done
content from an external issue tracker instead of PLAN.md's inline body.

- src/plan-document.cts: parses the `tracker-id` attribute into `PlanTask.trackerId`
- src/task-content-resolution.cts: new leaf module — split/find/build/resolve,
  with a hard-halt (throw) contract on ambiguous/failed/timeout/malformed
  resolution, never a silent fallback to possibly-stale inline text
- src/task-command-router.cts: new `task resolve-content --plan --task-id --raw`
  CLI verb wiring the module into a real process exit code
- gsd-core/bin/lib/capability-validator.cjs: validates the new
  `taskContentResolver` manifest field (feature-role only, cross-capability
  trackerPrefix uniqueness)
- gsd-core/workflows/execute-plan.md, gsd-core/references/loop-hook-dispatch.md,
  docs/reference/capability-manifest.md: wire the seam into the per-task loop
  and document it as a new `execute:task` point outside the existing
  contribution/step/gate vocabulary (unconditional in autonomous mode)

Closes #3970

* fix(#3970): gate checkpoint tasks out of content resolution, close trackerPrefix grammar parity gap, cover path-traversal guard

Standards/Spec code-review pass on the task-content-resolution seam (ADR-3646
Phase 1) found three defects:

1. execute-plan.md's task-content-resolution bullet fired on any
   tracker-id-bearing task with no check that it wasn't type="checkpoint:*",
   contradicting ADR-3646 Decision 1 (a checkpoint task must never enter
   resolve-content). plan-document.cts already parses trackerId: null
   unconditionally for checkpoint tasks; only the workflow prose needed the
   fix, so the bullet now explicitly excludes checkpoint tasks.

2. task-content-resolution.cts's parseResolverDeclaration accepted any
   non-empty trackerPrefix with no grammar check, while capability-
   validator.cjs's KEBAB_RE enforces kebab-case at install time — a
   Generative Fix Divergence gap. Added the same grammar (as a literal
   regex, documented as intentionally not shared across the .cts/.cjs build
   boundary) plus a parity test asserting the two surfaces agree across a
   valid/invalid trackerPrefix table.

3. task-command-router.cts's routeResolveContent path-traversal guard on
   --plan had zero test coverage. Added a test exercising a
   ../../../etc/passwit-shaped path and asserting the USAGE rejection names
   the offending path.

* fix(#3970): sanitize resolver diagnostics and cap resolver timeoutMs

Two findings caught by an isolated security-review pass on the task
content resolution seam:

- ResolverFailedError/ResolverMalformedOutputError embedded raw,
  unsanitized subprocess stderr/stdout (attacker/model-influenced via
  the tracker-id argv token) into .message. A hostile or buggy resolver
  could smuggle a newline plus a forged "Error: " line, or terminal
  escape sequences, into a diagnostic io.cjs's error() writes verbatim
  to stderr. Fixed at the constructor (task-content-resolution.cts) via
  io.cjs's existing formatDiagnosticToken(), so every caller of
  resolveTaskContent gets a safe .message by construction.

- capability-validator.cjs's validateTaskContentResolverFields had no
  upper bound on taskContentResolver.invoke.timeoutMs, letting a
  manifest declare an effectively unbounded value and defeat the
  "bounded subprocess" design intent. Added a 120000ms ceiling specific
  to this field, without touching the shared isPositiveIntegerMs()
  helper (still used unbounded by the reviewer lane's timeoutFloorMs
  and probe timeoutMs).

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

* fix(#3970): fix gsd-test failures — stale prose allowlist line and stderr-vs-message assertion

gsd-test (remote dockerized matrix) came back red with 5 failures on this
PR; all five are real defects, fixed here.

- tests/no-bare-gsd-tools-command-position.test.cjs: PROSE_ALLOWLIST's
  execute-plan.md entry pointed at line 415, which ffc190df4's
  checkpoint-exclusion caveat (added near line 221) shifted down by one
  line. The actual "validated downstream by gsd-tools uat
  classify-coverage" descriptive mention now sits at line 416. Updated
  the allowlist entry's line number to match.

- tests/task-command-router-resolve-content.test.cjs: the path-traversal
  test asserted the outside-project-scope diagnostic against the thrown
  ExitError's own .message. io.cts's error() (ADR-3889) writes its
  human-readable message to fd 2 via writeAllSync and then throws a bare
  `new ExitError(1)` with no message argument — by design, so the
  exception carries no duplicate text and the thrown ExitError's message
  defaults to "process exit 1" (cli-exit.cts's ExitError constructor).
  Root cause was the test, not the source: task-command-router.cjs's
  outside-project-scope rejection already calls error() correctly and the
  diagnostic text is genuinely emitted, just on fd 2, not on the
  exception. Fixed the test to capture fd-2 writes (mirroring
  tests/estimate-calibrate.test.cjs's runCalibrateExpectError and this
  same file's own captureStdout for fd 1) and assert against the captured
  stderr text instead of err.message. This was masked locally because a
  manual `node -e` sanity check that only inspects the caught exception's
  .message cannot see what the real node:test run actually failed on.

Emitted-Drift-Ack-Growth: execute-plan.md — adds the ADR-3646 task-content-resolution bullet and checkpoint-exclusion caveat to the per-task execute loop; a real behavioral prose addition, not incidental bloat.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* docs(#3970): backfill changeset PR number (pr:0 -> pr:4000)

---------

Co-authored-by: sim <sim@local>
Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
2026-08-28 13:17:04 -04:00

344 lines
14 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 m = require('../gsd-core/bin/lib/task-content-resolution.cjs');
const {
TASK_CONTENT_RESULT,
splitTrackerId,
findResolver,
buildInvocation,
resolveTaskContent,
ResolverAmbiguousError,
ResolverFailedError,
ResolverTimeoutError,
ResolverMalformedOutputError,
} = m;
function beadsCapability(overrides = {}) {
return {
id: 'beads-capability',
taskContentResolver: {
trackerPrefix: 'beads',
invoke: {
binary: 'bd',
args: ['show', '{{id}}', '--json'],
timeoutMs: 10000,
},
...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: 10000 } };
assert.deepStrictEqual(buildInvocation(resolver, 'GSD-42'), {
binary: 'bd',
args: ['show', 'GSD-42', '--json'],
timeoutMs: 10000,
});
});
test('buildInvocation does not touch args that merely contain {{id}} as a substring', () => {
const resolver = { invoke: { binary: 'bd', args: ['prefix-{{id}}-suffix'], timeoutMs: 1000 } };
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: 1000 } },
};
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: 1000 } } },
{ id: 'f', taskContentResolver: { trackerPrefix: 'beads', invoke: { binary: 'bd', args: ['{{id}}'], timeoutMs: 0 } } },
{ id: 'g', taskContentResolver: { trackerPrefix: 'beads', invoke: { binary: 'bd', args: ['{{id}}'], timeoutMs: -5 } } },
{ id: 'h', taskContentResolver: { trackerPrefix: 'beads', invoke: { binary: 'bd', args: ['{{id}}'], timeoutMs: 1.5 } } },
];
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, 10000);
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: 1000 } },
};
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");
});