Files
msd-core/tests/active-workstream-store.test.cjs
Tom Boucher a28dcec981 chore(#597): replace count-based ratchet guards with AST lint + named-set allowlists (#603)
The windows-test-parity ratchet greps test source for fs.rmSync-without-
maxRetries (and six other Windows-portability anti-patterns), failing when an
integer offender COUNT exceeds a frozen baseline (rmSync: 95). A count ratchet
is a Goodhart metric: fixing one offender and adding another keeps the count
constant, so a new defect slips through green. Replace it — and every other
count ratchet in the repo — with a layered, masking-proof design.

Behavioral seam test
- tests/helpers-cleanup.test.cjs proves helpers.cleanup() carries the Windows
  EBUSY retry budget. cleanup() delegates retries to Node's fs.rmSync via
  maxRetries (it owns no loop), so the test asserts the option contract
  (recursive/force/maxRetries>0/retryDelay>0) + real-FS removal + the cwd-guard,
  rather than a loop that does not exist. The EBUSY risk is now tested ONCE at
  the helper, not approximated textually at every call site.

Write-time ESLint rule (AST-accurate, replaces the grep)
- eslint-rules/no-raw-rmsync-in-tests.cjs (error in tests/**/*.test.cjs) bans
  raw fs.rmSync, steering to cleanup(). Catches member, computed (fs['rmSync']),
  destructured and aliased forms; escape hatch is inline
  `// eslint-disable-next-line local/no-raw-rmsync-in-tests -- <reason>` only.
- Migrated 336 raw fs.rmSync teardown calls across ~116 test files to cleanup().
  ~18 genuinely load-bearing sites (mid-test SUT/fault-injection removals,
  error-swallowing or name-colliding local teardown helpers) keep the raw call
  with an inline eslint-disable + reason.

Shared anti-ratchet primitive
- scripts/lib/allowlist-ratchet.cjs:
  - assertWithinAllowlist: fails on NOVEL ids (new offender introduced) AND on
    STALE ids (a known offender was fixed but not pruned) — identity, not count,
    and a ratchet DOWN toward zero.
  - assertTightCeiling: a size/length budget whose ceiling must stay within a
    grace band of the high-water mark, so budgets may only tighten, never creep.

Ratchets converted onto the primitive
- windows-test-parity-guard.test.cjs: rmSync rule deleted (now ESLint-enforced);
  the remaining six patterns moved from integer baselines to named-set
  allowlists with ratchet-down.
- scripts/lint-test-file-count.{cjs,allowlist.json}: per-module integer counts →
  named filename sets (closes the swap-a-file-keep-the-count blind spot); a
  module dropping under cap now FAILS to force pruning its allowlist entry.
- enh-2790 skill-count `<= 63` → named skill allowlist (ratchets toward ~58).

Size budgets hardened (tighten-only)
- agent-size / workflow-size / feat-3039 help-tiered: ceilings lowered to the
  current high-water mark and an assertTightCeiling anti-creep check added per
  tier. Fixed external-contract limits (description ≤100 chars, agent ≤100 KB)
  are intentionally left as-is — they are not grandfathered creeping budgets.

No user-facing behavior change (tests + tooling only); no USER_FACING_PREFIXES
touched, so no changeset fragment is required.

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-01 22:43:49 -04:00

153 lines
5.4 KiB
JavaScript

const { describe, test } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('fs');
const os = require('os');
const path = require('path');
const { cleanup } = require('./helpers.cjs');
const {
validateWorkstreamName,
parseCliWorkstream,
resolveActiveWorkstream,
applyResolvedWorkstreamEnv,
createMemoryPointerAdapter,
getActiveWorkstream,
setActiveWorkstream,
} = require('../get-shit-done/bin/lib/active-workstream-store.cjs');
describe('active-workstream-store', () => {
test('validateWorkstreamName accepts canonical names', () => {
assert.equal(validateWorkstreamName('alpha'), true);
assert.equal(validateWorkstreamName('alpha_2'), true);
assert.equal(validateWorkstreamName('alpha-2'), true);
});
test('validateWorkstreamName rejects invalid names', () => {
assert.equal(validateWorkstreamName('alpha beta'), false);
assert.equal(validateWorkstreamName('../alpha'), false);
assert.equal(validateWorkstreamName('alpha/beta'), false);
});
test('parseCliWorkstream parses --ws=<name>', () => {
const parsed = parseCliWorkstream(['state', 'json', '--ws=alpha', '--raw']);
assert.equal(parsed.value, 'alpha');
assert.equal(parsed.source, 'cli');
assert.deepEqual(parsed.args, ['state', 'json', '--raw']);
});
test('parseCliWorkstream parses --ws <name>', () => {
const parsed = parseCliWorkstream(['state', 'json', '--ws', 'alpha', '--raw']);
assert.equal(parsed.value, 'alpha');
assert.equal(parsed.source, 'cli');
assert.deepEqual(parsed.args, ['state', 'json', '--raw']);
});
test('parseCliWorkstream throws on missing value', () => {
assert.throws(
() => parseCliWorkstream(['state', 'json', '--ws']),
/Missing value for --ws/
);
});
test('resolveActiveWorkstream precedence: cli > env > store', () => {
const cli = resolveActiveWorkstream('/repo', ['state', 'json', '--ws', 'cli-ws'], {
GSD_WORKSTREAM: 'env-ws',
}, {
getStored: () => 'store-ws',
});
assert.equal(cli.ws, 'cli-ws');
assert.equal(cli.source, 'cli');
const env = resolveActiveWorkstream('/repo', ['state', 'json'], {
GSD_WORKSTREAM: 'env-ws',
}, {
getStored: () => 'store-ws',
});
assert.equal(env.ws, 'env-ws');
assert.equal(env.source, 'env');
const store = resolveActiveWorkstream('/repo', ['state', 'json'], {
GSD_WORKSTREAM: '',
}, {
getStored: () => 'store-ws',
});
assert.equal(store.ws, 'store-ws');
assert.equal(store.source, 'store');
});
test('resolveActiveWorkstream returns none when no source provides a workstream', () => {
const resolved = resolveActiveWorkstream('/repo', ['state', 'json'], {
GSD_WORKSTREAM: '',
}, {
getStored: () => null,
});
assert.equal(resolved.ws, null);
assert.equal(resolved.source, 'none');
});
test('resolveActiveWorkstream rejects invalid selected name', () => {
assert.throws(
() => resolveActiveWorkstream('/repo', ['state', 'json', '--ws', 'bad/name']),
/Invalid workstream name/
);
});
test('applyResolvedWorkstreamEnv sets env only when ws exists', () => {
const env = { GSD_WORKSTREAM: 'old' };
applyResolvedWorkstreamEnv({ ws: null }, env);
assert.equal(env.GSD_WORKSTREAM, 'old');
applyResolvedWorkstreamEnv({ ws: 'new-ws' }, env);
assert.equal(env.GSD_WORKSTREAM, 'new-ws');
});
test('getActiveWorkstream uses session adapter over shared adapter when session key exists', () => {
const savedSession = process.env.GSD_SESSION_KEY;
process.env.GSD_SESSION_KEY = 'session-123';
const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-active-store-precedence-'));
try {
fs.mkdirSync(path.join(tmpDir, '.planning', 'workstreams', 'session-ws'), { recursive: true });
fs.mkdirSync(path.join(tmpDir, '.planning', 'workstreams', 'shared-ws'), { recursive: true });
const session = createMemoryPointerAdapter('session-ws');
const shared = createMemoryPointerAdapter('shared-ws');
const active = getActiveWorkstream(tmpDir, {
activeWorkstreamAdapters: { session, shared },
});
assert.equal(active, 'session-ws');
} finally {
if (savedSession !== undefined) process.env.GSD_SESSION_KEY = savedSession;
else delete process.env.GSD_SESSION_KEY;
cleanup(tmpDir);
}
});
test('getActiveWorkstream self-heals invalid pointer names', () => {
const adapter = createMemoryPointerAdapter('bad/name');
const active = getActiveWorkstream('/fake/repo', { activeWorkstreamAdapter: adapter });
assert.equal(active, null);
assert.equal(adapter.read(), null);
});
test('getActiveWorkstream self-heals stale pointers', () => {
const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-active-store-stale-'));
try {
fs.mkdirSync(path.join(tmpDir, '.planning', 'workstreams'), { recursive: true });
const adapter = createMemoryPointerAdapter('ghost');
const active = getActiveWorkstream(tmpDir, { activeWorkstreamAdapter: adapter });
assert.equal(active, null);
assert.equal(adapter.read(), null);
} finally {
cleanup(tmpDir);
}
});
test('setActiveWorkstream clears pointer on null value', () => {
const adapter = createMemoryPointerAdapter('alpha');
setActiveWorkstream('/fake/repo', null, { activeWorkstreamAdapter: adapter });
assert.equal(adapter.read(), null);
});
});