70b5c1a1bf
* fix(#3354): preserve stored total_phases when milestone is unbounded * chore(#3354): backfill PR number in changeset fragment --------- Co-authored-by: sim <sim@local>
1326 lines
55 KiB
JavaScript
1326 lines
55 KiB
JavaScript
'use strict';
|
||
|
||
/**
|
||
* state-document.test.cjs
|
||
*
|
||
* Characterization tests for the STATE.md pipe-table branch of
|
||
* stateReplaceField / stateExtractField / stateReplaceFieldWithFallback
|
||
* (issue #2880, ADR-2143 §3/§4). These lock byte-identical behaviour across
|
||
* the migration of the table branch off a hand-rolled whole-document regex
|
||
* onto a line-scan + byte-range splice (see gsd-core/bin/lib/state-document.cjs
|
||
* locateFieldRow). Any future re-implementation of the table branch must keep
|
||
* every assertion below true.
|
||
*/
|
||
|
||
const { describe, test } = require('node:test');
|
||
const assert = require('node:assert/strict');
|
||
const fc = require('fast-check');
|
||
|
||
const {
|
||
stateReplaceField,
|
||
stateExtractField,
|
||
stateReplaceFieldWithFallback,
|
||
} = require('../gsd-core/bin/lib/state-document.cjs');
|
||
|
||
describe('stateReplaceField — table branch (characterization, #2880)', () => {
|
||
test('replaces a two-cell row in place', () => {
|
||
const input = '| Current Phase | 3 |';
|
||
const result = stateReplaceField(input, 'Current Phase', 7);
|
||
assert.equal(result, '| Current Phase | 7 |');
|
||
});
|
||
|
||
test('returns null for a three-cell row', () => {
|
||
const input = '| Current Phase | 3 | x |';
|
||
const result = stateReplaceField(input, 'Current Phase', 7);
|
||
assert.equal(result, null);
|
||
});
|
||
|
||
test('matches the field name case-insensitively and preserves its original casing', () => {
|
||
const input = '| current phase | 3 |';
|
||
const result = stateReplaceField(input, 'Current Phase', 7);
|
||
assert.equal(result, '| current phase | 7 |');
|
||
});
|
||
|
||
test('replaces a row that has a header and delimiter above it', () => {
|
||
const input = ['| F | V |', '| --- | --- |', '| Current Phase | 3 |'].join('\n');
|
||
const expected = ['| F | V |', '| --- | --- |', '| Current Phase | 7 |'].join('\n');
|
||
const result = stateReplaceField(input, 'Current Phase', 7);
|
||
assert.equal(result, expected);
|
||
});
|
||
|
||
test('replaces a header-less legacy row', () => {
|
||
const input = '| Current Phase | 3 |';
|
||
const result = stateReplaceField(input, 'Current Phase', 7);
|
||
assert.equal(result, '| Current Phase | 7 |');
|
||
});
|
||
|
||
test('replaces only the first of two rows naming the same field', () => {
|
||
const input = ['| Current Phase | 3 |', '| Current Phase | 9 |'].join('\n');
|
||
const expected = ['| Current Phase | 7 |', '| Current Phase | 9 |'].join('\n');
|
||
const result = stateReplaceField(input, 'Current Phase', 7);
|
||
assert.equal(result, expected);
|
||
});
|
||
|
||
test('returns null when the value cell contains a pipe', () => {
|
||
const input = '| Current Phase | a|b |';
|
||
const result = stateReplaceField(input, 'Current Phase', 7);
|
||
assert.equal(result, null);
|
||
});
|
||
|
||
test('inserts before the closing pipe when the value cell is all whitespace', () => {
|
||
const input = '| Current Phase | |';
|
||
const result = stateReplaceField(input, 'Current Phase', 7);
|
||
assert.equal(result, '| Current Phase | 7|');
|
||
});
|
||
|
||
test('never treats a delimiter row as a field', () => {
|
||
const input = '| --- | --- |';
|
||
const result = stateReplaceField(input, '---', 7);
|
||
assert.equal(result, null);
|
||
});
|
||
|
||
test('ignores an indented row', () => {
|
||
const input = ' | Current Phase | 3 |';
|
||
const result = stateReplaceField(input, 'Current Phase', 7);
|
||
assert.equal(result, null);
|
||
});
|
||
|
||
test('inserts a dollar-sign pattern verbatim', () => {
|
||
const input = '| Current Phase | 3 |';
|
||
const result = stateReplaceField(input, 'Current Phase', '$&X');
|
||
assert.equal(result, '| Current Phase | $&X |');
|
||
});
|
||
|
||
test("preserves the row's exact interior padding", () => {
|
||
const input = '| Current Phase | 3 |';
|
||
const result = stateReplaceField(input, 'Current Phase', 7);
|
||
assert.equal(result, '| Current Phase | 7 |');
|
||
});
|
||
|
||
test('returns null when the field is absent', () => {
|
||
const input = '| Other | 3 |';
|
||
const result = stateReplaceField(input, 'Current Phase', 7);
|
||
assert.equal(result, null);
|
||
});
|
||
|
||
test('returns null for empty content', () => {
|
||
const result = stateReplaceField('', 'Current Phase', 7);
|
||
assert.equal(result, null);
|
||
});
|
||
});
|
||
|
||
describe('stateReplaceField — CRLF (#2880)', () => {
|
||
test('preserves CRLF line endings byte-for-byte', () => {
|
||
const input = ['| F | V |', '| --- | --- |', '| Current Phase | 3 |', ''].join('\r\n');
|
||
const expected = ['| F | V |', '| --- | --- |', '| Current Phase | 7 |', ''].join('\r\n');
|
||
const result = stateReplaceField(input, 'Current Phase', 7);
|
||
assert.equal(result, expected);
|
||
});
|
||
|
||
test('replaces a bold field on a CRLF document', () => {
|
||
const input = ['**Status:** old', ''].join('\r\n');
|
||
const expected = ['**Status:** new', ''].join('\r\n');
|
||
const result = stateReplaceField(input, 'Status', 'new');
|
||
assert.equal(result, expected);
|
||
});
|
||
|
||
test('replaces a row terminated by a lone carriage return', () => {
|
||
const input = ['| Phase | 3 |', '| Other | 9 |'].join('\r');
|
||
const expected = ['| Phase | 5 |', '| Other | 9 |'].join('\r');
|
||
const result = stateReplaceField(input, 'Phase', 5);
|
||
assert.equal(result, expected);
|
||
});
|
||
});
|
||
|
||
describe('stateExtractField (#2880)', () => {
|
||
test('extracts from a two-cell row', () => {
|
||
const input = '| Current Phase | 3 |';
|
||
assert.equal(stateExtractField(input, 'Current Phase'), '3');
|
||
});
|
||
|
||
test('extracts from a CRLF document', () => {
|
||
const input = ['| F | V |', '| --- | --- |', '| Current Phase | 3 |', ''].join('\r\n');
|
||
assert.equal(stateExtractField(input, 'Current Phase'), '3');
|
||
});
|
||
|
||
test('returns null when absent', () => {
|
||
const input = '| Other | 3 |';
|
||
assert.equal(stateExtractField(input, 'Current Phase'), null);
|
||
});
|
||
|
||
test('round-trip: extract after replace returns the new value', () => {
|
||
const input = '| Current Phase | 3 |';
|
||
const replaced = stateReplaceField(input, 'Current Phase', '7');
|
||
assert.equal(stateExtractField(replaced, 'Current Phase'), '7');
|
||
});
|
||
|
||
test('matches a row terminated by a lone carriage return', () => {
|
||
const input = ['| Phase | 3 |', '| Other | 9 |'].join('\r');
|
||
assert.equal(stateExtractField(input, 'Phase'), '3');
|
||
});
|
||
|
||
test('does not match when the field name has more padding than the cell', () => {
|
||
const input = '| Phase | 3 |';
|
||
assert.equal(stateExtractField(input, ' Phase '), null);
|
||
});
|
||
});
|
||
|
||
describe('stateReplaceFieldWithFallback (#2880)', () => {
|
||
test('uses the primary when present', () => {
|
||
const input = '| Current Phase | 3 |';
|
||
const result = stateReplaceFieldWithFallback(input, 'Current Phase', 'Phase', 7);
|
||
assert.equal(result, '| Current Phase | 7 |');
|
||
});
|
||
|
||
test('falls back to the secondary name when the primary is absent', () => {
|
||
const input = '| Phase | 3 |';
|
||
const result = stateReplaceFieldWithFallback(input, 'Current Phase', 'Phase', 7);
|
||
assert.equal(result, '| Phase | 7 |');
|
||
});
|
||
|
||
test('returns the content UNCHANGED (not null) when both are absent', () => {
|
||
const content = '| Other | 3 |';
|
||
const result = stateReplaceFieldWithFallback(content, 'Current Phase', 'Phase', 7);
|
||
assert.equal(result, content);
|
||
});
|
||
});
|
||
|
||
describe('property: bounded mutation (#2880, ADR-2143 §4)', () => {
|
||
test('replacing one row leaves every other line byte-identical', () => {
|
||
const safeValue = fc
|
||
.array(fc.constantFrom(...'abcdefghijklmnopqrstuvwxyz0123456789 '.split('')), {
|
||
minLength: 1,
|
||
maxLength: 8,
|
||
})
|
||
.map((chars) => chars.join('').trim() || 'x');
|
||
|
||
fc.assert(
|
||
fc.property(
|
||
fc.integer({ min: 1, max: 6 }).chain((n) =>
|
||
fc.record({
|
||
n: fc.constant(n),
|
||
values: fc.array(safeValue, { minLength: n, maxLength: n }),
|
||
targetIndex: fc.integer({ min: 0, max: n - 1 }),
|
||
newValue: safeValue,
|
||
}),
|
||
),
|
||
({ n, values, targetIndex, newValue }) => {
|
||
const fieldNames = Array.from({ length: n }, (_, i) => `Field${i}`);
|
||
const lines = fieldNames.map((name, i) => `| ${name} | ${values[i]} |`);
|
||
const doc = lines.join('\n');
|
||
|
||
const result = stateReplaceField(doc, fieldNames[targetIndex], newValue);
|
||
assert.notEqual(result, null);
|
||
|
||
const resultLines = result.split('\n');
|
||
assert.equal(resultLines.length, lines.length);
|
||
for (let i = 0; i < lines.length; i++) {
|
||
if (i === targetIndex) continue;
|
||
assert.equal(resultLines[i], lines[i]);
|
||
}
|
||
assert.equal(resultLines[targetIndex], `| ${fieldNames[targetIndex]} | ${newValue} |`);
|
||
},
|
||
),
|
||
{ seed: 20880, numRuns: 200 },
|
||
);
|
||
});
|
||
});
|
||
|
||
describe('property: fieldNameMatchesRawCell case-fold semantics, via stateExtractField (FIX A)', () => {
|
||
test('match verdict agrees with an explicit ECMAScript non-unicode Canonicalize reference predicate', () => {
|
||
// Independent, obviously-correct reference for "are these two code units
|
||
// the same character under a non-`u`-flag `/i` RegExp": NOT
|
||
// `.toLowerCase()`, which incorrectly folds some non-ASCII characters
|
||
// (e.g. KELVIN SIGN U+212A) onto their ASCII counterparts ("k"), and
|
||
// also incorrectly folds multi-character uppercase mappings (e.g. "ß"
|
||
// toUpperCase()'s "SS") onto a two-character string. Per ECMAScript's
|
||
// non-unicode Canonicalize, a fold is REJECTED (the original character
|
||
// is kept as-is) whenever `ch.toUpperCase()` is not exactly one
|
||
// character, OR the original is non-ASCII (>= 128) while the uppercased
|
||
// result is ASCII (< 128).
|
||
function canonChar(ch) {
|
||
const upper = ch.toUpperCase();
|
||
if (upper.length !== 1) return ch;
|
||
if (ch.charCodeAt(0) >= 128 && upper.charCodeAt(0) < 128) return ch;
|
||
return upper;
|
||
}
|
||
function canonStringEqual(a, b) {
|
||
if (a.length !== b.length) return false;
|
||
for (let i = 0; i < a.length; i++) {
|
||
if (canonChar(a[i]) !== canonChar(b[i])) return false;
|
||
}
|
||
return true;
|
||
}
|
||
// Reference predicate for the whole field-name/cell match, stated
|
||
// independently of (and structured differently from) the scanner under
|
||
// test: `fieldName` matches `rawCell` iff `fieldName` occurs as a literal
|
||
// (Canonicalize-compared) substring of `rawCell` at SOME offset `j`, with
|
||
// everything BEFORE `j` and everything AFTER the occurrence consisting
|
||
// exclusively of ' '/'\t'. This is a full, unbounded substring scan with
|
||
// no "leading run" shortcut.
|
||
function referenceFieldMatchesCell(fieldName, rawCell) {
|
||
const n = fieldName.length;
|
||
for (let j = 0; j + n <= rawCell.length; j++) {
|
||
const before = rawCell.slice(0, j);
|
||
const after = rawCell.slice(j + n);
|
||
if (!/^[ \t]*$/.test(before)) continue;
|
||
if (!/^[ \t]*$/.test(after)) continue;
|
||
if (canonStringEqual(rawCell.slice(j, j + n), fieldName)) return true;
|
||
}
|
||
return false;
|
||
}
|
||
|
||
const padArb = fc.array(fc.constantFrom(' ', '\t'), { minLength: 0, maxLength: 3 }).map((chars) => chars.join(''));
|
||
// Deliberately includes the KELVIN SIGN (U+212A) and other non-ASCII
|
||
// characters whose `.toLowerCase()`/`.toUpperCase()` folds onto an ASCII
|
||
// character — exactly the class of character FIX A addresses.
|
||
const coreCharArb = fc.constantFrom('a', 'b', 'K', 'k', 'P', 'p', 'H', 'A', '\u212A', '\u1E9E', '\u00DF', '1', '_');
|
||
const coreArb = fc.array(coreCharArb, { minLength: 1, maxLength: 5 }).map((chars) => chars.join(''));
|
||
const fieldNameArb = fc
|
||
.record({ pre: padArb, core: coreArb, post: padArb })
|
||
.map(({ pre, core, post }) => pre + core + post);
|
||
|
||
fc.assert(
|
||
fc.property(
|
||
fieldNameArb,
|
||
fc.boolean(),
|
||
fc.constantFrom('same', 'upper', 'lower'),
|
||
padArb,
|
||
padArb,
|
||
coreArb,
|
||
(fieldName, deriveFromFieldName, caseMode, cellPre, cellPost, randomCore) => {
|
||
const fieldCore = fieldName.replace(/^[ \t]+|[ \t]+$/g, '');
|
||
let derivedCore = fieldCore;
|
||
if (caseMode === 'upper') derivedCore = fieldCore.toUpperCase();
|
||
else if (caseMode === 'lower') derivedCore = fieldCore.toLowerCase();
|
||
const cellCore = deriveFromFieldName ? derivedCore : randomCore;
|
||
const cellContent = cellPre + cellCore + cellPost;
|
||
// The template fixes exactly one literal space on each side of
|
||
// cellContent, so rawCell (as locateFieldRow computes it) is
|
||
// ` ${cellContent} ` byte-for-byte.
|
||
const doc = `| ${cellContent} | value |`;
|
||
const rawCell = ` ${cellContent} `;
|
||
const expected = referenceFieldMatchesCell(fieldName, rawCell);
|
||
const result = stateExtractField(doc, fieldName);
|
||
assert.equal(result, expected ? 'value' : null);
|
||
},
|
||
),
|
||
{ seed: 28801, numRuns: 300 },
|
||
);
|
||
});
|
||
});
|
||
|
||
// ────────────────────────────────────────────────────────────────────────
|
||
// Folded from tests/issue-2828-flat-roadmap-total-phases.test.cjs (H3 Wave 7, #3339)
|
||
// ────────────────────────────────────────────────────────────────────────
|
||
{
|
||
const { describe: __foldDescribe } = require('node:test');
|
||
__foldDescribe('folded:issue-2828-flat-roadmap-total-phases', () => {
|
||
'use strict';
|
||
|
||
// Regression guard for #2828: on a flat unmilestoned roadmap (no versioned milestone
|
||
// heading), `state-snapshot`/`state record-session` reported progress.total_phases as
|
||
// the on-disk phase-dir count (1) instead of the authoritative roadmap count (6). The
|
||
// read-path disk-scan cache fell back to phaseDirs.length when milestoneBounded was
|
||
// false, even though roadmapPhaseCount (6) was correct for a flat roadmap (no sibling
|
||
// milestones to conflate). Fix: use roadmapPhaseCount as the floor when > 0.
|
||
|
||
const { test, describe, beforeEach, afterEach } = require('node:test');
|
||
const assert = require('node:assert/strict');
|
||
const fs = require('fs');
|
||
const path = require('path');
|
||
const { runGsdTools, createTempProject, cleanup } = require('./helpers.cjs');
|
||
|
||
describe('#2828 — total_phases uses the roadmap count on a flat unmilestoned roadmap', () => {
|
||
let tmpDir;
|
||
|
||
beforeEach(() => {
|
||
tmpDir = createTempProject('gsd-2828-');
|
||
const planningDir = path.join(tmpDir, '.planning');
|
||
// Flat unmilestoned roadmap with 6 phases (no versioned milestone heading).
|
||
fs.writeFileSync(
|
||
path.join(planningDir, 'ROADMAP.md'),
|
||
[
|
||
'# Roadmap',
|
||
'',
|
||
'### Phase 1: Foundation',
|
||
'### Phase 2: Core API',
|
||
'### Phase 3: UI Layer',
|
||
'### Phase 4: Integration',
|
||
'### Phase 5: Polish',
|
||
'### Phase 6: Release',
|
||
'',
|
||
].join('\n'),
|
||
);
|
||
// Only phase 1 has been discussed → 1 phase dir on disk.
|
||
const phaseDir = path.join(planningDir, 'phases', '01-foundation');
|
||
fs.mkdirSync(phaseDir, { recursive: true });
|
||
fs.writeFileSync(path.join(phaseDir, 'CONTEXT.md'), '# Phase 1 Context\n');
|
||
// Minimal STATE.md with a milestone set (so milestoneBounded is computed) but no
|
||
// versioned heading to bound it to → the flat-roadmap unbounded case.
|
||
fs.writeFileSync(
|
||
path.join(planningDir, 'STATE.md'),
|
||
[
|
||
'---',
|
||
'status: executing',
|
||
'milestone: v1.0',
|
||
'milestone_name: milestone',
|
||
'---',
|
||
'',
|
||
'# Project State',
|
||
'',
|
||
'**Current Phase:** 01',
|
||
'**Status:** In progress',
|
||
'',
|
||
].join('\n'),
|
||
);
|
||
});
|
||
|
||
afterEach(() => cleanup(tmpDir));
|
||
|
||
test('state sync writes progress.total_phases === 6 (roadmap count), not 1 (phase-dir count) (#2828)', () => {
|
||
// `state sync` derives progress.total_phases from the disk-scan cache (the read path
|
||
// #2828 fixes) and writes it to STATE.md frontmatter. Pre-fix this wrote 1.
|
||
const result = runGsdTools(['state', 'sync'], tmpDir);
|
||
assert.ok(result.success, `state sync failed: ${result.error}`);
|
||
|
||
const stateMd = fs.readFileSync(path.join(tmpDir, '.planning', 'STATE.md'), 'utf8');
|
||
// Parse the `progress:` YAML block line-by-line (ReDoS-safe: avoids a nested-quantifier
|
||
// regex over the whole block). Find total_phases among the block's indented children.
|
||
const lines = stateMd.split(/\r?\n/);
|
||
let inProgress = false;
|
||
let totalPhases = null;
|
||
for (const line of lines) {
|
||
if (/^progress:\s*$/.test(line)) { inProgress = true; continue; }
|
||
if (inProgress) {
|
||
// A new top-level (column-0) key ends the progress block.
|
||
if (/^\S/.test(line)) { inProgress = false; continue; }
|
||
const tp = line.match(/^\s+total_phases:\s*(\d+)/);
|
||
if (tp) { totalPhases = Number(tp[1]); break; }
|
||
}
|
||
}
|
||
assert.ok(
|
||
totalPhases !== null,
|
||
`progress.total_phases must be written by state sync. STATE.md:\n${stateMd}`,
|
||
);
|
||
assert.strictEqual(
|
||
totalPhases,
|
||
6,
|
||
`progress.total_phases must be the roadmap count (6) for a flat unmilestoned roadmap, not the on-disk phase-dir count (1). Got: ${totalPhases}`,
|
||
);
|
||
});
|
||
});
|
||
});
|
||
}
|
||
|
||
// ────────────────────────────────────────────────────────────────────────
|
||
// Folded from tests/issue-3204-state-writer-phase-count.test.cjs (H3 Wave 7, #3339)
|
||
// ────────────────────────────────────────────────────────────────────────
|
||
{
|
||
const { describe: __foldDescribe } = require('node:test');
|
||
__foldDescribe('folded:issue-3204-state-writer-phase-count', () => {
|
||
// allow-test-rule: source-text-is-the-product, see #3204
|
||
// Reads STATE.md/ROADMAP.md fixture files whose deployed text IS what the
|
||
// runtime loads — testing text content tests the deployed contract.
|
||
|
||
/**
|
||
* #3204 / #3185 — failing-first regression suite for `buildStateFrontmatter`'s
|
||
* `total_phases` selection (`src/state.cts:1620`, guard at `:1795-1805`).
|
||
*
|
||
* `hasMilestoneSectioning` (`src/roadmap-parser.cts:195`) is
|
||
* /^#{2,3}\s+(?!Phase\s+\S)/mi
|
||
* — true for ANY non-Phase level-2/3 heading, so a FLAT roadmap carrying an
|
||
* ordinary structural heading (`## Progress`, `## Overview`, ...) is
|
||
* misclassified as milestone-sectioned. `safeToUseRoadmapCount` then goes
|
||
* false and the on-disk phase-directory count silently clobbers the
|
||
* ROADMAP-declared count — a regression of #2828, reported in #3204 as
|
||
* "roadmap declares 6 phases, 4 directories exist, state.record-session
|
||
* writes total_phases: 4".
|
||
*
|
||
* DO NOT fix src/state.cts or src/roadmap-parser.cts from this file. Rows 2,
|
||
* 3, and 14 below assert the CORRECT (post-fix) value and currently FAIL —
|
||
* that is the point of a failing-first suite. Every other row asserts
|
||
* behavior verified to already hold today (see phase-log for the manual CLI
|
||
* probes that established each expected value before this file was written).
|
||
*
|
||
* Rows and naming follow `.gsd/phase/fix-3185-state-writer-phase-count/50-test-matrix.md`
|
||
* verbatim (row numbers refer to that matrix, not the 8-row table in
|
||
* `40-design.md`).
|
||
*
|
||
* Driven via `state record-session` (the shape #3204's own report used),
|
||
* then read back with `state json --raw` — the product's own frontmatter
|
||
* parser — so `progress.total_phases` is asserted as a NUMBER, never a
|
||
* regex over rendered STATE.md text. `tests/helpers.cjs`'s `parseFrontmatter`
|
||
* only reads flat top-level keys (it does not descend into the nested
|
||
* `progress:` block), so `state json --raw` is the correct structured seam
|
||
* for a nested field — it is what `tests/state.test.cjs`'s own '#1761
|
||
* read-path' and 'milestone-scoped phase counting' suites already use for
|
||
* this exact assertion shape.
|
||
*/
|
||
|
||
const { test, describe, beforeEach, afterEach } = require('node:test');
|
||
const assert = require('node:assert/strict');
|
||
const fs = require('fs');
|
||
const path = require('path');
|
||
const { runGsdTools, createTempProject, cleanup } = require('./helpers.cjs');
|
||
|
||
// ─────────────────────────────────────────────────────────────────────────────
|
||
// Fixture builders
|
||
// ─────────────────────────────────────────────────────────────────────────────
|
||
|
||
/**
|
||
* Seed `.planning/phases/<padded>-phase-<n>` for each phase number in `nums`,
|
||
* each with a single PLAN.md so the directory is a recognizable phase dir.
|
||
*/
|
||
function seedPhaseDirs(tmpDir, nums) {
|
||
for (const n of nums) {
|
||
const padded = String(n).padStart(2, '0');
|
||
const dir = path.join(tmpDir, '.planning', 'phases', `${padded}-phase-${n}`);
|
||
fs.mkdirSync(dir, { recursive: true });
|
||
fs.writeFileSync(path.join(dir, `${padded}-01-PLAN.md`), '# Plan\n');
|
||
}
|
||
}
|
||
|
||
/** Seed one arbitrarily-named phase directory (sentinel / dup / pre-milestone cases). */
|
||
function seedNamedPhaseDir(tmpDir, dirName, planBase) {
|
||
const dir = path.join(tmpDir, '.planning', 'phases', dirName);
|
||
fs.mkdirSync(dir, { recursive: true });
|
||
fs.writeFileSync(path.join(dir, `${planBase}-01-PLAN.md`), '# Plan\n');
|
||
}
|
||
|
||
/**
|
||
* Build STATE.md frontmatter + minimal body. `milestone` is always set (the
|
||
* #3204 fixture needs it truthy — `getMilestoneInfo` defaults an absent
|
||
* `milestone:` field to 'v1.0' anyway, so this pins the same value
|
||
* explicitly for every row rather than relying on that fallback).
|
||
* Lines are joined with the caller-supplied `eol` (default '\n') — row 14
|
||
* reuses this to build the CRLF variant without a second copy.
|
||
*/
|
||
function buildStateMd({ milestone = 'v1.0', milestoneName = 'Test', totalPhases, currentPhase = '01', eol = '\n' }) {
|
||
const lines = [
|
||
'---',
|
||
'gsd_state_version: 1.0',
|
||
`milestone: ${milestone}`,
|
||
`milestone_name: ${milestoneName}`,
|
||
`current_phase: "${currentPhase}"`,
|
||
'status: executing',
|
||
'progress:',
|
||
` total_phases: ${totalPhases}`,
|
||
' completed_phases: 0',
|
||
' total_plans: 0',
|
||
' completed_plans: 0',
|
||
' percent: 0',
|
||
'---',
|
||
'',
|
||
'# GSD State',
|
||
'',
|
||
'## Current Position',
|
||
'',
|
||
`**Current Phase:** ${currentPhase}`,
|
||
'**Status:** Executing',
|
||
'',
|
||
];
|
||
return lines.join(eol);
|
||
}
|
||
|
||
/** Invoke `state record-session` (the #3204 entry point) then read back `state json --raw`. */
|
||
function recordSessionAndReadTotalPhases(tmpDir) {
|
||
const recordResult = runGsdTools(
|
||
['state', 'record-session', '--stopped-at', 'Phase 1, Plan 1', '--resume-file', 'none'],
|
||
tmpDir,
|
||
);
|
||
assert.ok(recordResult.success, `state record-session failed: ${recordResult.error}`);
|
||
|
||
const jsonResult = runGsdTools(['state', 'json', '--raw'], tmpDir);
|
||
assert.ok(jsonResult.success, `state json --raw failed: ${jsonResult.error}`);
|
||
return JSON.parse(jsonResult.output);
|
||
}
|
||
|
||
// ─────────────────────────────────────────────────────────────────────────────
|
||
// Rows 1-3, 14 — #3204 regression: flat roadmap + a structural heading
|
||
// ─────────────────────────────────────────────────────────────────────────────
|
||
|
||
describe('#3204 buildStateFrontmatter total_phases — flat roadmap misclassified as milestone-sectioned', () => {
|
||
let tmpDir;
|
||
|
||
beforeEach(() => {
|
||
tmpDir = createTempProject();
|
||
});
|
||
|
||
afterEach(() => {
|
||
cleanup(tmpDir);
|
||
});
|
||
|
||
test('flat roadmap with no structural headings keeps the roadmap count', () => {
|
||
// Row 1 (happy path / control) — no non-Phase heading anywhere, so
|
||
// hasMilestoneSectioning is false today and this already passes. Guards
|
||
// against a fix that overcorrects and breaks the trivial flat case.
|
||
const roadmap = [
|
||
'# Roadmap',
|
||
'',
|
||
'## Phase 1: One',
|
||
'## Phase 2: Two',
|
||
'## Phase 3: Three',
|
||
'## Phase 4: Four',
|
||
'## Phase 5: Five',
|
||
'## Phase 6: Six',
|
||
'',
|
||
].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'STATE.md'), buildStateMd({ totalPhases: 6 }));
|
||
seedPhaseDirs(tmpDir, [1, 2, 3, 4]);
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(Number(out.progress.total_phases), 6, `expected roadmap count 6, got ${out.progress && out.progress.total_phases}`);
|
||
});
|
||
|
||
test('#3204 flat roadmap with a Progress heading is not treated as milestone-sectioned', () => {
|
||
// Row 2 — the crux repro, transcribed from #3204's own report: 6
|
||
// declared phases, 4 directories, a flat '## Progress' heading. FAILS
|
||
// TODAY: hasMilestoneSectioning misclassifies '## Progress' as
|
||
// sectioning, safeToUseRoadmapCount goes false, and the write clobbers
|
||
// total_phases down to the disk count (4) instead of 6.
|
||
const roadmap = [
|
||
'# Roadmap',
|
||
'',
|
||
'## Phase 1: One',
|
||
'## Phase 2: Two',
|
||
'## Phase 3: Three',
|
||
'## Phase 4: Four',
|
||
'## Phase 5: Five',
|
||
'## Phase 6: Six',
|
||
'',
|
||
'## Progress',
|
||
'',
|
||
'Some progress notes.',
|
||
'',
|
||
].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'STATE.md'), buildStateMd({ totalPhases: 6 }));
|
||
seedPhaseDirs(tmpDir, [1, 2, 3, 4]);
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(
|
||
Number(out.progress.total_phases),
|
||
6,
|
||
`#3204: total_phases must stay 6 (roadmap-declared), not clobber to the disk count of 4. Got ${out.progress && out.progress.total_phases}`,
|
||
);
|
||
});
|
||
|
||
test('#3204 multiple structural headings still count as flat', () => {
|
||
// Row 3 — same shape as row 2 with TWO structural headings ('## Overview',
|
||
// '## Phase Details'); '## Phase Details' is correctly excluded by the
|
||
// heading's own '(?!Phase\s+\S)' lookahead, but '## Overview' still trips
|
||
// the misclassification. FAILS TODAY for the same reason as row 2.
|
||
const roadmap = [
|
||
'# Roadmap',
|
||
'',
|
||
'## Overview',
|
||
'',
|
||
'Some overview text.',
|
||
'',
|
||
'## Phase 1: One',
|
||
'## Phase 2: Two',
|
||
'## Phase 3: Three',
|
||
'## Phase 4: Four',
|
||
'## Phase 5: Five',
|
||
'## Phase 6: Six',
|
||
'',
|
||
'## Phase Details',
|
||
'',
|
||
'More detail prose.',
|
||
'',
|
||
].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'STATE.md'), buildStateMd({ totalPhases: 6 }));
|
||
seedPhaseDirs(tmpDir, [1, 2, 3, 4]);
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(
|
||
Number(out.progress.total_phases),
|
||
6,
|
||
`#3204: multiple structural headings must still count as flat (6), got ${out.progress && out.progress.total_phases}`,
|
||
);
|
||
});
|
||
|
||
test('#3204 repro under CRLF', () => {
|
||
// Row 14 — row 2's exact repro, all fixture content authored with CRLF
|
||
// line endings, proving the bug (and required fix) is not an artifact of
|
||
// LF-only fixtures. FAILS TODAY for the same reason as row 2.
|
||
const roadmapLines = [
|
||
'# Roadmap',
|
||
'',
|
||
'## Phase 1: One',
|
||
'## Phase 2: Two',
|
||
'## Phase 3: Three',
|
||
'## Phase 4: Four',
|
||
'## Phase 5: Five',
|
||
'## Phase 6: Six',
|
||
'',
|
||
'## Progress',
|
||
'',
|
||
'Some progress notes.',
|
||
'',
|
||
];
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmapLines.join('\r\n'));
|
||
fs.writeFileSync(
|
||
path.join(tmpDir, '.planning', 'STATE.md'),
|
||
buildStateMd({ totalPhases: 6, eol: '\r\n' }),
|
||
);
|
||
seedPhaseDirs(tmpDir, [1, 2, 3, 4]);
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(
|
||
Number(out.progress.total_phases),
|
||
6,
|
||
`#3204 under CRLF: total_phases must stay 6, got ${out.progress && out.progress.total_phases}`,
|
||
);
|
||
});
|
||
});
|
||
|
||
// ─────────────────────────────────────────────────────────────────────────────
|
||
// Rows 4-11 — negative space and boundaries (must hold both before and after the fix)
|
||
// ─────────────────────────────────────────────────────────────────────────────
|
||
|
||
describe('#3204 buildStateFrontmatter total_phases — negative space / boundaries (must not regress)', () => {
|
||
let tmpDir;
|
||
|
||
beforeEach(() => {
|
||
tmpDir = createTempProject();
|
||
});
|
||
|
||
afterEach(() => {
|
||
cleanup(tmpDir);
|
||
});
|
||
|
||
test('bounded milestone uses its own section count', () => {
|
||
// Row 4 — versioned roadmap with two sibling milestone sections ('## v1.0'
|
||
// owning phases 1-2, '## v2.0' owning phases 3-5). The asserted milestone
|
||
// ('v2.0') IS bound to its own heading, so `sliceMilestoneWindow`/
|
||
// `extractCurrentMilestoneScoped` narrow to that section and
|
||
// roadmapPhaseCount is the SECTION's count (3), not the whole-document
|
||
// count (5) and not the disk count (2 dirs seeded).
|
||
const roadmap = [
|
||
'# Roadmap',
|
||
'',
|
||
'## v1.0',
|
||
'## Phase 1: One',
|
||
'## Phase 2: Two',
|
||
'',
|
||
'## v2.0',
|
||
'## Phase 3: Three',
|
||
'## Phase 4: Four',
|
||
'## Phase 5: Five',
|
||
'',
|
||
].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
fs.writeFileSync(
|
||
path.join(tmpDir, '.planning', 'STATE.md'),
|
||
buildStateMd({ milestone: 'v2.0', milestoneName: 'Second', totalPhases: 3 }),
|
||
);
|
||
seedPhaseDirs(tmpDir, [3, 4]);
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(
|
||
Number(out.progress.total_phases),
|
||
3,
|
||
`a bounded milestone must use its own section's phase count (3), not the whole document (5) or the disk count (2). Got ${out.progress && out.progress.total_phases}`,
|
||
);
|
||
});
|
||
|
||
test('a single milestone section cannot conflate siblings', () => {
|
||
// Row 6 — exactly ONE '## v2.0' section owning phases, with the asserted
|
||
// milestone ('v9.9') absent from the roadmap entirely. One milestone
|
||
// heading can never satisfy hasMilestoneSectioning's >=2 threshold, so
|
||
// this is NOT sectioned and the roadmap-declared count is still used.
|
||
const roadmap = [
|
||
'# Roadmap',
|
||
'',
|
||
'## v2.0',
|
||
'## Phase 1: One',
|
||
'## Phase 2: Two',
|
||
'## Phase 3: Three',
|
||
'## Phase 4: Four',
|
||
'',
|
||
].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
fs.writeFileSync(
|
||
path.join(tmpDir, '.planning', 'STATE.md'),
|
||
buildStateMd({ milestone: 'v9.9', milestoneName: 'Absent', totalPhases: 4 }),
|
||
);
|
||
seedPhaseDirs(tmpDir, [1, 2]);
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(
|
||
Number(out.progress.total_phases),
|
||
4,
|
||
`a single milestone section cannot conflate siblings; expected the roadmap count (4), got ${out.progress && out.progress.total_phases}`,
|
||
);
|
||
});
|
||
|
||
test('#1761/#3354 sibling milestone sections preserve the stored total', () => {
|
||
// Row 5 — TWO sibling (unversioned) milestone sections, asserted
|
||
// milestone ('v3.0') absent from either. This is genuinely
|
||
// milestone-sectioned (2 phase-bearing sections would conflate if
|
||
// whole-doc counted), so neither the whole-doc count NOR the on-disk dir
|
||
// count is an authoritative total (#3354): the stored value must be
|
||
// preserved instead. Pre-#3354 this row asserted the disk count (3).
|
||
const roadmap = [
|
||
'# Roadmap',
|
||
'',
|
||
'## Milestone 1: First Milestone',
|
||
'### Phase 1: a',
|
||
'### Phase 2: b',
|
||
'### Phase 3: c',
|
||
'### Phase 4: d',
|
||
'',
|
||
'## Milestone 2: Second Milestone',
|
||
'### Phase 5: e',
|
||
'### Phase 6: f',
|
||
'### Phase 7: g',
|
||
'### Phase 8: h',
|
||
'',
|
||
].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
fs.writeFileSync(
|
||
path.join(tmpDir, '.planning', 'STATE.md'),
|
||
buildStateMd({ milestone: 'v3.0', milestoneName: 'Third', totalPhases: 8 }),
|
||
);
|
||
seedPhaseDirs(tmpDir, [1, 2, 3]);
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(
|
||
Number(out.progress.total_phases),
|
||
8,
|
||
`#1761/#3354: unbounded sibling milestones must preserve the stored total (8), not clobber to the disk count (3). Got ${out.progress && out.progress.total_phases}`,
|
||
);
|
||
});
|
||
|
||
test('zero phase directories keeps the declared count', () => {
|
||
// Row 7 — boundary limit-1: 0 dirs vs 6 declared.
|
||
const roadmap = [
|
||
'# Roadmap',
|
||
'',
|
||
'## Phase 1: One',
|
||
'## Phase 2: Two',
|
||
'## Phase 3: Three',
|
||
'## Phase 4: Four',
|
||
'## Phase 5: Five',
|
||
'## Phase 6: Six',
|
||
'',
|
||
].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'STATE.md'), buildStateMd({ totalPhases: 6 }));
|
||
// No phase dirs seeded.
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(Number(out.progress.total_phases), 6, `expected 6, got ${out.progress && out.progress.total_phases}`);
|
||
});
|
||
|
||
test('equal counts agree', () => {
|
||
// Row 8 — boundary limit: 6 dirs vs 6 declared.
|
||
const roadmap = [
|
||
'# Roadmap',
|
||
'',
|
||
'## Phase 1: One',
|
||
'## Phase 2: Two',
|
||
'## Phase 3: Three',
|
||
'## Phase 4: Four',
|
||
'## Phase 5: Five',
|
||
'## Phase 6: Six',
|
||
'',
|
||
].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'STATE.md'), buildStateMd({ totalPhases: 6 }));
|
||
seedPhaseDirs(tmpDir, [1, 2, 3, 4, 5, 6]);
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(Number(out.progress.total_phases), 6, `expected 6, got ${out.progress && out.progress.total_phases}`);
|
||
});
|
||
|
||
test('extra directories win via max()', () => {
|
||
// Row 9 — boundary limit+1. 6 heading-declared phases + a 7th phase
|
||
// declared only via the bullet-entry syntax ('- [ ] **Phase 7 — Extra**',
|
||
// #2199 bullet house style), which the directory-membership filter
|
||
// counts but the heading-only roadmapPhaseCount scan does not — so disk
|
||
// (7, all pass the membership filter) legitimately exceeds the
|
||
// heading-only roadmap count (6), and max() must pick 7.
|
||
//
|
||
// NOTE: a naive "N heading-declared phases + N+1 plain directories" does
|
||
// NOT exercise this path — the directory-membership filter
|
||
// (getMilestonePhaseFilter, roadmap-parser.cts) excludes any directory
|
||
// whose phase number has no matching roadmap entry at all, so an
|
||
// out-of-roadmap directory number is silently dropped from the disk
|
||
// count rather than inflating it. Verified against the running CLI
|
||
// before authoring this fixture.
|
||
const roadmap = [
|
||
'# Roadmap',
|
||
'',
|
||
'## Phase 1: One',
|
||
'## Phase 2: Two',
|
||
'## Phase 3: Three',
|
||
'## Phase 4: Four',
|
||
'## Phase 5: Five',
|
||
'## Phase 6: Six',
|
||
'',
|
||
'- [ ] **Phase 7 — Extra**',
|
||
'',
|
||
].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'STATE.md'), buildStateMd({ totalPhases: 6 }));
|
||
seedPhaseDirs(tmpDir, [1, 2, 3, 4, 5, 6, 7]);
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(
|
||
Number(out.progress.total_phases),
|
||
7,
|
||
`expected max(7 dirs, 6 heading-declared) = 7, got ${out.progress && out.progress.total_phases}`,
|
||
);
|
||
});
|
||
|
||
test('absent roadmap falls back to disk', () => {
|
||
// Row 10 — no ROADMAP.md at all.
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'STATE.md'), buildStateMd({ totalPhases: 4 }));
|
||
seedPhaseDirs(tmpDir, [1, 2, 3, 4]);
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(Number(out.progress.total_phases), 4, `expected disk count 4, got ${out.progress && out.progress.total_phases}`);
|
||
});
|
||
|
||
test('roadmap with no phase headings falls back to disk', () => {
|
||
// Row 11 — ROADMAP.md present but zero Phase headings anywhere.
|
||
const roadmap = ['# Roadmap', '', '## Notes', '', 'No phases declared yet.', ''].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'STATE.md'), buildStateMd({ totalPhases: 4 }));
|
||
seedPhaseDirs(tmpDir, [1, 2, 3, 4]);
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(Number(out.progress.total_phases), 4, `expected disk count 4, got ${out.progress && out.progress.total_phases}`);
|
||
});
|
||
|
||
test('a phase heading carrying a version token is not a milestone heading', () => {
|
||
// Row 12 (hostile, negative space) — '### Phase 3: Ship v2.0 gaps' carries
|
||
// a version token in its own text, but hasMilestoneSectioning's
|
||
// isPhaseHeading check excludes any heading matching '^Phase\s+\S' before
|
||
// the vocabulary signal is ever tested, so this must NOT count as a
|
||
// milestone heading. Otherwise-flat roadmap, so the roadmap-declared
|
||
// count must be used, not the disk count.
|
||
const roadmap = [
|
||
'# Roadmap',
|
||
'',
|
||
'## Phase 1: One',
|
||
'## Phase 2: Two',
|
||
'### Phase 3: Ship v2.0 gaps',
|
||
'## Phase 4: Four',
|
||
'',
|
||
].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'STATE.md'), buildStateMd({ totalPhases: 4 }));
|
||
seedPhaseDirs(tmpDir, [1, 2]);
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(
|
||
Number(out.progress.total_phases),
|
||
4,
|
||
`a version token borne by a Phase heading must not trigger milestone sectioning; expected roadmap count 4, got ${out.progress && out.progress.total_phases}`,
|
||
);
|
||
});
|
||
|
||
test('a version heading inside a fence is not sectioning', () => {
|
||
// Row 13 (hostile, negative space) — '## v2.0' appears only inside a
|
||
// fenced code block (a documentation example of the heading syntax) on an
|
||
// otherwise flat roadmap. hasMilestoneSectioning is routed through
|
||
// tokenizeHeadings (fence-aware), so a fenced heading is never tokenised
|
||
// and must NOT count as sectioning. The roadmap-declared count must be
|
||
// used, not the disk count.
|
||
const roadmap = [
|
||
'# Roadmap',
|
||
'',
|
||
'## Phase 1: One',
|
||
'## Phase 2: Two',
|
||
'## Phase 3: Three',
|
||
'## Phase 4: Four',
|
||
'',
|
||
'Example heading syntax:',
|
||
'',
|
||
'```',
|
||
'## v2.0',
|
||
'```',
|
||
'',
|
||
].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'STATE.md'), buildStateMd({ totalPhases: 4 }));
|
||
seedPhaseDirs(tmpDir, [1, 2]);
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(
|
||
Number(out.progress.total_phases),
|
||
4,
|
||
`a version heading inside a fence must not trigger milestone sectioning; expected roadmap count 4, got ${out.progress && out.progress.total_phases}`,
|
||
);
|
||
});
|
||
});
|
||
|
||
// ─────────────────────────────────────────────────────────────────────────────
|
||
// #3185 adversarial review — hasMilestoneSectioning ownership-model shapes
|
||
// missed by the original suite (BLOCKER + MAJOR findings against the #3184
|
||
// "strictly-deeper nesting" rewrite).
|
||
// ─────────────────────────────────────────────────────────────────────────────
|
||
|
||
describe('#3185 review — hasMilestoneSectioning shapes the original suite missed', () => {
|
||
let tmpDir;
|
||
|
||
beforeEach(() => {
|
||
tmpDir = createTempProject();
|
||
});
|
||
|
||
afterEach(() => {
|
||
cleanup(tmpDir);
|
||
});
|
||
|
||
test('BLOCKER: same-level sibling milestones preserve the stored total', () => {
|
||
// Adversarial review BLOCKER (#1761 regression): the #3184 rewrite
|
||
// required a candidate milestone heading's owned Phase heading to be
|
||
// STRICTLY DEEPER (next.level > candidate.level). Real sibling
|
||
// milestones are frequently at the SAME level as their own Phase
|
||
// headings ('## v1.0' / '## Phase 1:' / '## v2.0' / '## Phase 3:'), so
|
||
// that predicate answered false and the whole-document count conflated
|
||
// both milestones. The asserted milestone ('v3.0') is unbound (matches
|
||
// neither v1.0 nor v2.0), so this is genuinely sectioned and neither
|
||
// the whole-doc count NOR the disk count may be written (#3354): the
|
||
// stored value (4) must be preserved. Pre-#3354 this row asserted the
|
||
// disk count (2).
|
||
const roadmap = [
|
||
'# Roadmap',
|
||
'',
|
||
'## v1.0',
|
||
'## Phase 1: One',
|
||
'## Phase 2: Two',
|
||
'',
|
||
'## v2.0',
|
||
'## Phase 3: Three',
|
||
'## Phase 4: Four',
|
||
'',
|
||
].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
fs.writeFileSync(
|
||
path.join(tmpDir, '.planning', 'STATE.md'),
|
||
buildStateMd({ milestone: 'v3.0', milestoneName: 'Third', totalPhases: 4 }),
|
||
);
|
||
seedPhaseDirs(tmpDir, [1, 2]);
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(
|
||
Number(out.progress.total_phases),
|
||
4,
|
||
`same-level sibling milestones must preserve the stored total (4), not clobber to the disk count (2). Got ${out.progress && out.progress.total_phases}`,
|
||
);
|
||
});
|
||
|
||
test('#3185 repro: structural headings interleaved among flat phases keep the roadmap count', () => {
|
||
// #3185's own reproduction of the adjacency model this suite's
|
||
// predecessor shipped: '## Overview' sits immediately before
|
||
// '## Phase 1:' and '## Notes' sits immediately before '## Phase 4:',
|
||
// giving an adjacency-based predicate 2 "owning" candidates even though
|
||
// neither heading carries any milestone vocabulary (no version token, no
|
||
// status marker, no "Milestone" word) and the roadmap is genuinely flat.
|
||
const roadmap = [
|
||
'# Roadmap',
|
||
'',
|
||
'## Overview',
|
||
'## Phase 1: One',
|
||
'## Phase 2: Two',
|
||
'## Phase 3: Three',
|
||
'## Notes',
|
||
'## Phase 4: Four',
|
||
'## Phase 5: Five',
|
||
'## Phase 6: Six',
|
||
'',
|
||
].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
fs.writeFileSync(
|
||
path.join(tmpDir, '.planning', 'STATE.md'),
|
||
buildStateMd({ milestone: 'v9.9', milestoneName: 'Test', totalPhases: 6 }),
|
||
);
|
||
seedPhaseDirs(tmpDir, [1, 2]);
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(
|
||
Number(out.progress.total_phases),
|
||
6,
|
||
`#3185: structural headings adjacent to phase headings must not be treated as milestone sectioning; expected roadmap count 6, got ${out.progress && out.progress.total_phases}`,
|
||
);
|
||
});
|
||
|
||
test('MAJOR: wrapper + single nested milestone keeps the roadmap count', () => {
|
||
// Adversarial review MAJOR (#3204 reintroduction): every ancestor in a
|
||
// nesting chain was counted as its own candidate section under the
|
||
// #3184 rewrite, so a generic wrapper heading with only ONE real
|
||
// milestone nested under it was misclassified as sectioned. Mirrors
|
||
// this repo's own bundled template shape (gsd-core/templates/roadmap.md:
|
||
// '## Phases' -> '### 🚧 v1.1 [Name] (In Progress)' -> '#### Phase N:').
|
||
// The asserted milestone ('v9.9') is deliberately unbound so the
|
||
// assertion exercises hasMilestoneSectioning itself, not
|
||
// isMilestoneBoundedInRoadmap.
|
||
const roadmap = [
|
||
'# Roadmap',
|
||
'',
|
||
'## Phases',
|
||
'',
|
||
'### 🚧 v1.1 [Name] (In Progress)',
|
||
'',
|
||
'#### Phase 1: One',
|
||
'#### Phase 2: Two',
|
||
'#### Phase 3: Three',
|
||
'#### Phase 4: Four',
|
||
'',
|
||
].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
fs.writeFileSync(
|
||
path.join(tmpDir, '.planning', 'STATE.md'),
|
||
buildStateMd({ milestone: 'v9.9', milestoneName: 'Unbound', totalPhases: 2 }),
|
||
);
|
||
seedPhaseDirs(tmpDir, [1, 2]);
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(
|
||
Number(out.progress.total_phases),
|
||
4,
|
||
`wrapper + single nested milestone must keep the roadmap-declared count (4), not clobber to the disk count of 2. Got ${out.progress && out.progress.total_phases}`,
|
||
);
|
||
});
|
||
});
|
||
|
||
// ─────────────────────────────────────────────────────────────────────────────
|
||
// Rows 15-18 — #3185 consolidation independence checks
|
||
//
|
||
// These exercise the directory-enumeration owner (listMilestonePhaseDirs /
|
||
// getMilestonePhaseFilter), not hasMilestoneSectioning. Verified PASSING
|
||
// against the current build (manual CLI probe) before being added here —
|
||
// included per the dispatch brief's "include only if they pass today"
|
||
// condition. If a future change to the #3204 fix regresses one of these,
|
||
// that is a SEPARATE finding from the #3204 repro above, not folded into it.
|
||
// ─────────────────────────────────────────────────────────────────────────────
|
||
|
||
describe('#3185 buildStateFrontmatter total_phases — directory-enumeration independence (currently passing)', () => {
|
||
let tmpDir;
|
||
|
||
beforeEach(() => {
|
||
tmpDir = createTempProject();
|
||
});
|
||
|
||
afterEach(() => {
|
||
cleanup(tmpDir);
|
||
});
|
||
|
||
test('sentinel directories are excluded by the canonical enumeration', () => {
|
||
// Row 15 — a 999.x backlog directory alongside 3 real phase directories
|
||
// must not inflate total_phases.
|
||
const roadmap = ['# Roadmap', '', '## Phase 1: One', '## Phase 2: Two', '## Phase 3: Three', ''].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'STATE.md'), buildStateMd({ totalPhases: 3 }));
|
||
seedPhaseDirs(tmpDir, [1, 2, 3]);
|
||
seedNamedPhaseDir(tmpDir, '999.1-backlog-idea', '999.1');
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(
|
||
Number(out.progress.total_phases),
|
||
3,
|
||
`sentinel 999.x directory must be excluded, expected 3, got ${out.progress && out.progress.total_phases}`,
|
||
);
|
||
});
|
||
|
||
test('pre-milestone directories are excluded', () => {
|
||
// Row 16 — a '0-*' pre-milestone directory must not be counted.
|
||
const roadmap = ['# Roadmap', '', '## Phase 1: One', '## Phase 2: Two', '## Phase 3: Three', ''].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'STATE.md'), buildStateMd({ totalPhases: 3 }));
|
||
seedPhaseDirs(tmpDir, [1, 2, 3]);
|
||
seedNamedPhaseDir(tmpDir, '0-premilestone', '0');
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(
|
||
Number(out.progress.total_phases),
|
||
3,
|
||
`pre-milestone '0-*' directory must be excluded, expected 3, got ${out.progress && out.progress.total_phases}`,
|
||
);
|
||
});
|
||
|
||
test('duplicate phase-number directories count once', () => {
|
||
// Row 17 — two directories both keyed to phase number 2 must dedup to a
|
||
// single count.
|
||
const roadmap = ['# Roadmap', '', '## Phase 1: One', '## Phase 2: Two', '## Phase 3: Three', ''].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'STATE.md'), buildStateMd({ totalPhases: 3 }));
|
||
seedPhaseDirs(tmpDir, [1, 2, 3]);
|
||
seedNamedPhaseDir(tmpDir, '02-phase-2-dup', '02');
|
||
|
||
const out = recordSessionAndReadTotalPhases(tmpDir);
|
||
assert.strictEqual(
|
||
Number(out.progress.total_phases),
|
||
3,
|
||
`duplicate phase-2 directories must dedup to a single count (3), got ${out.progress && out.progress.total_phases}`,
|
||
);
|
||
});
|
||
|
||
test('re-running record-session does not move total_phases', () => {
|
||
// Row 18 — idempotence: a second record-session call over an unchanged
|
||
// tree, with the clock pinned so 'Last session' does not itself vary,
|
||
// must produce a byte-identical STATE.md.
|
||
const roadmap = ['# Roadmap', '', '## Phase 1: One', '## Phase 2: Two', '## Phase 3: Three', ''].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), roadmap);
|
||
const sessionState = [
|
||
'# GSD State',
|
||
'',
|
||
'## Session',
|
||
'',
|
||
'**Last session:** 2024-01-01T00:00:00.000Z',
|
||
'**Stopped at:** None',
|
||
'**Resume file:** None',
|
||
'',
|
||
'## Current Position',
|
||
'',
|
||
'**Current Phase:** 01',
|
||
'**Status:** Executing',
|
||
'',
|
||
].join('\n');
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'STATE.md'), sessionState);
|
||
seedPhaseDirs(tmpDir, [1, 2, 3]);
|
||
|
||
const statePath = path.join(tmpDir, '.planning', 'STATE.md');
|
||
const pinnedEnv = { GSD_TEST_MODE: '1', GSD_NOW_MS: '1600000000000' };
|
||
const args = ['state', 'record-session', '--stopped-at', 'Phase 1, Plan 1', '--resume-file', 'none'];
|
||
|
||
const first = runGsdTools(args, tmpDir, pinnedEnv);
|
||
assert.ok(first.success, `first record-session failed: ${first.error}`);
|
||
const afterFirst = fs.readFileSync(statePath, 'utf8');
|
||
|
||
const second = runGsdTools(args, tmpDir, pinnedEnv);
|
||
assert.ok(second.success, `second record-session failed: ${second.error}`);
|
||
const afterSecond = fs.readFileSync(statePath, 'utf8');
|
||
|
||
assert.strictEqual(
|
||
afterSecond,
|
||
afterFirst,
|
||
're-running record-session on an unchanged tree with a pinned clock must produce a byte-identical STATE.md',
|
||
);
|
||
});
|
||
});
|
||
|
||
// ─────────────────────────────────────────────────────────────────────────────
|
||
// #3354 — milestoned-but-unbounded: a genuinely milestone-sectioned ROADMAP
|
||
// whose asserted milestone token matches no H1–H3 heading must not have its
|
||
// progress.total_phases clobbered to the on-disk phase-directory count.
|
||
// Surviving branch of #2828/#3204: #3204 closed only the flat-unmilestoned
|
||
// case; the sectioned-but-unbounded arm of `safeToUseRoadmapCount` still
|
||
// wrote phaseDirs.length (25 → 4 in the issue's report).
|
||
// ─────────────────────────────────────────────────────────────────────────────
|
||
|
||
describe('#3354 buildStateFrontmatter total_phases — milestoned-but-unbounded roadmap', () => {
|
||
const { runNode } = require('./helpers/process-seam.cjs');
|
||
const { TOOLS_PATH, TEST_ENV_BASE } = require('./helpers.cjs');
|
||
|
||
let tmpDir;
|
||
|
||
beforeEach(() => {
|
||
tmpDir = createTempProject();
|
||
});
|
||
|
||
afterEach(() => {
|
||
cleanup(tmpDir);
|
||
});
|
||
|
||
/** The #3354 crux fixture: 2 milestone-vocabulary sections, 25 phase headings across siblings. */
|
||
function buildSectionedRoadmap() {
|
||
const lines = ['# Roadmap', ''];
|
||
lines.push('## Milestone v2.0 — Alpha', '');
|
||
for (let i = 1; i <= 12; i++) lines.push(`### Phase ${i}: alpha-${i}`);
|
||
lines.push('');
|
||
lines.push('## Milestone v3.0 — Beta', '');
|
||
for (let i = 13; i <= 25; i++) lines.push(`### Phase ${i}: beta-${i}`);
|
||
lines.push('');
|
||
return lines.join('\n');
|
||
}
|
||
|
||
test('#3354 stored total is preserved (not clobbered to the dir count), a stderr warning names the token, percent stays withheld', () => {
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), buildSectionedRoadmap());
|
||
// milestone: v1.0 appears in NO heading of that roadmap — unbounded.
|
||
fs.writeFileSync(
|
||
path.join(tmpDir, '.planning', 'STATE.md'),
|
||
buildStateMd({ milestone: 'v1.0', milestoneName: 'Unbounded', totalPhases: 25 }),
|
||
);
|
||
seedPhaseDirs(tmpDir, [1, 2, 3, 4]);
|
||
|
||
// Drive the mutating command with stderr captured (runGsdTools discards
|
||
// stderr on success). The warning is asserted on THIS invocation.
|
||
const rec = runNode(
|
||
[TOOLS_PATH, 'state', 'record-session', '--stopped-at', 'Phase 1, Plan 1', '--resume-file', 'none'],
|
||
{ cwd: tmpDir, env: { ...process.env, ...TEST_ENV_BASE }, timeoutMs: 60000 },
|
||
);
|
||
assert.ok(rec.exitCode === 0, `state record-session failed: ${rec.stderr}`);
|
||
|
||
assert.ok(
|
||
/v1\.0/.test(rec.stderr || ''),
|
||
`#3354: expected a stderr warning naming the unbounded milestone token 'v1.0', got stderr=${JSON.stringify(rec.stderr)}`,
|
||
);
|
||
|
||
const jsonResult = runGsdTools(['state', 'json', '--raw'], tmpDir);
|
||
assert.ok(jsonResult.success, `state json --raw failed: ${jsonResult.error}`);
|
||
const out = JSON.parse(jsonResult.output);
|
||
|
||
assert.strictEqual(
|
||
Number(out.progress.total_phases),
|
||
25,
|
||
`#3354: total_phases must preserve the stored 25, not clobber to the on-disk dir count of 4. Got ${out.progress && out.progress.total_phases}`,
|
||
);
|
||
assert.ok(
|
||
!(out.progress && ('percent' in out.progress)),
|
||
`#3354: percent must stay withheld for an unbounded milestone (existing #1761 guard); got progress=${JSON.stringify(out.progress)}`,
|
||
);
|
||
});
|
||
|
||
test('#3354 with nothing stored, the key is omitted rather than written from the dir count', () => {
|
||
fs.writeFileSync(path.join(tmpDir, '.planning', 'ROADMAP.md'), buildSectionedRoadmap());
|
||
// No progress block in frontmatter, no "Total Phases" body annotation —
|
||
// nothing stored to preserve, so the key must be OMITTED (never 4).
|
||
fs.writeFileSync(
|
||
path.join(tmpDir, '.planning', 'STATE.md'),
|
||
[
|
||
'---',
|
||
'gsd_state_version: 1.0',
|
||
'milestone: v1.0',
|
||
'milestone_name: Unbounded',
|
||
'current_phase: "01"',
|
||
'status: executing',
|
||
'---',
|
||
'',
|
||
'# GSD State',
|
||
'',
|
||
'## Current Position',
|
||
'',
|
||
'**Current Phase:** 01',
|
||
'**Status:** Executing',
|
||
'',
|
||
].join('\n'),
|
||
);
|
||
seedPhaseDirs(tmpDir, [1, 2, 3, 4]);
|
||
|
||
const recordResult = runGsdTools(
|
||
['state', 'record-session', '--stopped-at', 'Phase 1, Plan 1', '--resume-file', 'none'],
|
||
tmpDir,
|
||
);
|
||
assert.ok(recordResult.success, `state record-session failed: ${recordResult.error}`);
|
||
|
||
const jsonResult = runGsdTools(['state', 'json', '--raw'], tmpDir);
|
||
assert.ok(jsonResult.success, `state json --raw failed: ${jsonResult.error}`);
|
||
const out = JSON.parse(jsonResult.output);
|
||
|
||
assert.ok(
|
||
!(out.progress && ('total_phases' in out.progress)),
|
||
`#3354: with no stored total, the key must be omitted — never written from the dir count. Got progress=${JSON.stringify(out.progress)}`,
|
||
);
|
||
});
|
||
});
|
||
});
|
||
}
|