Files
msd-core/tests/state-document-generator.test.cjs
Tom Boucher bfd7ddbad3 feat(3530): STATE.md Document Module via generator (Phase 1 of #3524) (#3531)
* feat(3530): STATE.md Document Module via generator (Phase 1 of #3524)

Phase 1 of the CJS↔SDK hard-seam migration (parent #3524).
Converts the hand-synced state-document.cjs/state-document.ts pair
into a generator-driven seam, modeled on the existing
command-aliases.generated.* precedent.

What landed:
- sdk/src/query/state-document.ts is the source of truth.
- sdk/scripts/gen-state-document.ts emits
  get-shit-done/bin/lib/state-document.generated.cjs from the
  compiled SDK dist via Function.prototype.toString() inspection
  for the 7 public exports and 3 internal helpers.
- sdk/scripts/check-state-document-fresh.mjs is the CI freshness
  gate; pre-commit hook also runs it when relevant files change.
- get-shit-done/bin/lib/state-document.cjs is reduced to a one-line
  re-export from state-document.generated.cjs so existing callers
  (state.cjs, workstream-inventory.cjs, init.cjs) need no changes.
- New CI step in .github/workflows/test.yml after the existing alias
  drift check.
- sdk/package.json: gen:state-document, check:state-document-fresh
  scripts. tsx added as devDep.
- Root package.json: proxy script for the freshness check.
- CONTEXT.md: one-sentence amendment on STATE.md Document Module
  recording the source-of-truth file path.

Tests:
- sdk/src/query/state-document.test.ts: 34 vitest fixtures across
  the 7 public exports (TDD pinning safety net).
- tests/state-document-generator.test.cjs: 31 node:test parity
  assertions comparing SDK source vs generated CJS for every
  fixture.
- Full suite: 9177/9177 pass (baseline was 9146; +31 new tests).

One subtle behavior change worth flagging: the old hand-written
state-document.cjs used String(str) coercion inside escapeRegex,
which the SDK source does not. The generator faithfully matches
the SDK (the source of truth per ADR-3524), so the new CJS no
longer coerces non-string input to string before regex-escaping.
No current caller passes non-string input, so no observable
regression in the test suite. Flagged in the PR body for
reviewers.

Closes #3530.

* fix(3530): address state-document review findings
2026-05-14 22:17:20 -04:00

262 lines
9.7 KiB
JavaScript

'use strict';
/**
* Parity test — verifies that state-document.generated.cjs produces identical
* results to the compiled SDK ESM output for all exported functions.
*
* SDK side: require('../sdk/dist/query/state-document.js') via createRequire
* CJS side: require('../get-shit-done/bin/lib/state-document.generated.cjs')
*/
const { test, describe } = require('node:test');
const assert = require('node:assert/strict');
const { createRequire } = require('node:module');
// The SDK dist is ESM; wrap with createRequire targeting the project root so
// Node resolves the path correctly from this CJS context.
const requireFromRoot = createRequire(__filename);
// CJS side — direct require works fine
const cjs = requireFromRoot('../get-shit-done/bin/lib/state-document.generated.cjs');
describe('state-document-generator parity: stateReplaceFieldWithFallback', async () => {
const sdk = await import('../sdk/dist/query/state-document.js');
const fixtures = [
{
label: 'primary hit',
content: 'Status: old\nState: backup',
primary: 'Status',
fallback: 'State',
value: 'new',
expected: 'Status: new\nState: backup',
},
{
label: 'fallback hit',
content: 'Other: something\nState: backup',
primary: 'Status',
fallback: 'State',
value: 'new',
expected: 'Other: something\nState: new',
},
{
label: 'neither hit returns unchanged content',
content: 'Other: something\nAnother: value',
primary: 'Status',
fallback: 'State',
value: 'new',
expected: 'Other: something\nAnother: value',
},
];
for (const { label, content, primary, fallback, value, expected } of fixtures) {
test(label, () => {
const sdkResult = sdk.stateReplaceFieldWithFallback(content, primary, fallback, value);
const cjsResult = cjs.stateReplaceFieldWithFallback(content, primary, fallback, value);
assert.strictEqual(sdkResult, expected, `SDK: ${label}`);
assert.strictEqual(cjsResult, expected, `CJS: ${label}`);
assert.strictEqual(sdkResult, cjsResult, `SDK/CJS parity: ${label}`);
});
}
});
describe('state-document-generator parity: normalizeStateStatus', async () => {
const sdk = await import('../sdk/dist/query/state-document.js');
const fixtures = [
{ label: 'paused via "paused"', status: 'paused', expected: 'paused' },
{ label: 'paused via "stopped"', status: 'stopped', expected: 'paused' },
{ label: 'paused via non-null pausedAt', status: 'active', pausedAt: '2024-01-01', expected: 'paused' },
{ label: 'executing via "executing"', status: 'executing', expected: 'executing' },
{ label: 'executing via "in progress"', status: 'in progress', expected: 'executing' },
{ label: 'executing via "ready to execute"', status: 'ready to execute', expected: 'executing' },
{ label: 'planning via "planning"', status: 'planning', expected: 'planning' },
{ label: 'discussing via "discussing"', status: 'discussing', expected: 'discussing' },
{ label: 'verifying via "verif"', status: 'verifying', expected: 'verifying' },
{ label: 'completed via "complete"', status: 'completed', expected: 'completed' },
{ label: 'completed via "done"', status: 'done', expected: 'completed' },
{ label: 'unknown fallback', status: 'something-else', expected: 'something-else' },
{ label: 'null status', status: null, expected: 'unknown' },
];
for (const { label, status, pausedAt, expected } of fixtures) {
test(label, () => {
const sdkResult = sdk.normalizeStateStatus(status, pausedAt);
const cjsResult = cjs.normalizeStateStatus(status, pausedAt);
assert.strictEqual(sdkResult, expected, `SDK: ${label}`);
assert.strictEqual(cjsResult, expected, `CJS: ${label}`);
assert.strictEqual(sdkResult, cjsResult, `SDK/CJS parity: ${label}`);
});
}
});
describe('state-document-generator parity: computeProgressPercent', async () => {
const sdk = await import('../sdk/dist/query/state-document.js');
const fixtures = [
{ label: 'only plans data', cp: 3, tp: 10, cf: null, tf: null, expected: 30 },
{ label: 'only phases data', cp: null, tp: null, cf: 2, tf: 4, expected: 50 },
{ label: 'both present uses min', cp: 8, tp: 10, cf: 3, tf: 10, expected: 30 },
{ label: 'neither returns null', cp: null, tp: null, cf: null, tf: null, expected: null },
{ label: 'total of 0 treated as no data', cp: 0, tp: 0, cf: null, tf: null, expected: null },
];
for (const { label, cp, tp, cf, tf, expected } of fixtures) {
test(label, () => {
const sdkResult = sdk.computeProgressPercent(cp, tp, cf, tf);
const cjsResult = cjs.computeProgressPercent(cp, tp, cf, tf);
assert.strictEqual(sdkResult, expected, `SDK: ${label}`);
assert.strictEqual(cjsResult, expected, `CJS: ${label}`);
assert.strictEqual(sdkResult, cjsResult, `SDK/CJS parity: ${label}`);
});
}
});
describe('state-document-generator parity: shouldPreserveExistingProgress', async () => {
const sdk = await import('../sdk/dist/query/state-document.js');
const fixtures = [
{
label: 'existing exceeds derived on total_phases → true',
existing: { total_phases: 10 },
derived: { total_phases: 5 },
expected: true,
},
{
label: 'derived exceeds existing → false',
existing: { total_phases: 5 },
derived: { total_phases: 10 },
expected: false,
},
{
label: 'malformed input (non-object) → false',
existing: null,
derived: { total_phases: 5 },
expected: false,
},
{
label: 'both null → false',
existing: null,
derived: null,
expected: false,
},
];
for (const { label, existing, derived, expected } of fixtures) {
test(label, () => {
const sdkResult = sdk.shouldPreserveExistingProgress(existing, derived);
const cjsResult = cjs.shouldPreserveExistingProgress(existing, derived);
assert.strictEqual(sdkResult, expected, `SDK: ${label}`);
assert.strictEqual(cjsResult, expected, `CJS: ${label}`);
assert.strictEqual(sdkResult, cjsResult, `SDK/CJS parity: ${label}`);
});
}
});
describe('state-document-generator parity: normalizeProgressNumbers', async () => {
const sdk = await import('../sdk/dist/query/state-document.js');
const fixtures = [
{
label: 'coerces all five tracked keys to numbers',
input: { total_phases: '10', completed_phases: '3', total_plans: '5', completed_plans: '2', percent: '60' },
expected: { total_phases: 10, completed_phases: 3, total_plans: 5, completed_plans: 2, percent: 60 },
},
{
label: 'non-object null returned unchanged',
input: null,
expected: null,
},
{
label: 'extra keys preserved untouched',
input: { total_phases: '4', extra_key: 'hello' },
expected: { total_phases: 4, extra_key: 'hello' },
},
];
for (const { label, input, expected } of fixtures) {
test(label, () => {
const sdkResult = sdk.normalizeProgressNumbers(input);
const cjsResult = cjs.normalizeProgressNumbers(input);
assert.deepStrictEqual(sdkResult, expected, `SDK: ${label}`);
assert.deepStrictEqual(cjsResult, expected, `CJS: ${label}`);
assert.deepStrictEqual(sdkResult, cjsResult, `SDK/CJS parity: ${label}`);
});
}
});
// SDK ESM side — dynamically import so we can test both; wrap in a top-level
// async test suite.
describe('state-document-generator parity: stateExtractField', async () => {
const sdk = await import('../sdk/dist/query/state-document.js');
const fixtures = [
{
label: 'bold pattern',
content: 'Some content\n**FieldName:** the value\nMore content',
fieldName: 'FieldName',
expected: 'the value',
},
{
label: 'plain pattern',
content: 'Some content\nFieldName: the value\nMore content',
fieldName: 'FieldName',
expected: 'the value',
},
{
label: 'missing field returns null',
content: 'Some content\nOtherField: something\nMore content',
fieldName: 'FieldName',
expected: null,
},
];
for (const { label, content, fieldName, expected } of fixtures) {
test(label, () => {
const sdkResult = sdk.stateExtractField(content, fieldName);
const cjsResult = cjs.stateExtractField(content, fieldName);
assert.strictEqual(sdkResult, expected, `SDK: ${label}`);
assert.strictEqual(cjsResult, expected, `CJS: ${label}`);
assert.strictEqual(sdkResult, cjsResult, `SDK/CJS parity: ${label}`);
});
}
});
describe('state-document-generator parity: stateReplaceField', async () => {
const sdk = await import('../sdk/dist/query/state-document.js');
const fixtures = [
{
label: 'bold replace',
content: 'Some content\n**Status:** old value\nMore content',
fieldName: 'Status',
newValue: 'new value',
expected: 'Some content\n**Status:** new value\nMore content',
},
{
label: 'plain replace',
content: 'Some content\nStatus: old value\nMore content',
fieldName: 'Status',
newValue: 'new value',
expected: 'Some content\nStatus: new value\nMore content',
},
{
label: 'missing field returns null',
content: 'Some content\nOtherField: something\nMore content',
fieldName: 'Status',
newValue: 'new value',
expected: null,
},
];
for (const { label, content, fieldName, newValue, expected } of fixtures) {
test(label, () => {
const sdkResult = sdk.stateReplaceField(content, fieldName, newValue);
const cjsResult = cjs.stateReplaceField(content, fieldName, newValue);
assert.strictEqual(sdkResult, expected, `SDK: ${label}`);
assert.strictEqual(cjsResult, expected, `CJS: ${label}`);
assert.strictEqual(sdkResult, cjsResult, `SDK/CJS parity: ${label}`);
});
}
});