Files
msd-core/tests/active-workstream-store.unit.test.cjs
Tom Boucher fd07e1a357 fix(#2850): resolve the active workstream in the statusline GSD-state segment (#3012)
* test(#2850): add failing-first tests for workstream statusline state

readGsdState only ever reads the flat .planning/STATE.md via a directory
walk-up; it has no path for .planning/workstreams/<ws>/STATE.md and never
consults GSD_WORKSTREAM or the stored active-workstream pointer, so the
GSD-state segment silently disappears in workstream mode. These tests
prove the RED before the fix lands.

Uses shared saveSessionEnv/restoreSessionEnv/clearSessionEnv helpers now
added to tests/helpers.cjs (single source of truth for the session-env-var
save/clear/restore pattern also used by tests/active-workstream-store.unit.test.cjs,
which is updated here to consume the same shared helpers instead of its own
local, already-diverged copy).

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

* fix(#2850): resolve active workstream in the statusline

readGsdState only ever walked up looking for a flat .planning/STATE.md; it
had no branch for .planning/workstreams/<ws>/STATE.md and never consulted
GSD_WORKSTREAM or the stored active-workstream pointer, so the GSD-state
segment silently vanished in workstream-mode projects with no root
STATE.md (exit 0, no diagnostic).

Reuses the existing CLI>env>store resolution seam (resolveActiveWorkstream,
active-workstream-store.cts) and the existing mode-detection/path-building
seam (listAvailableWorkstreams/planningPaths, planning-workspace.cts)
rather than re-implementing either inline. When workstream mode is
detected but nothing resolves, readGsdState now returns a
{noActiveWorkstream:true} sentinel that formatGsdState/formatGsdStateCompact
render as "no active workstream" -- observable, never silent emptiness.
Flat-mode behavior and the case where a resolved workstream has no
STATE.md yet are both unchanged.

Adds active-workstream-store.cts's peekActiveWorkstream: a read-only
sibling of getActiveWorkstream. resolveActiveWorkstream's default store
lookup self-heals a stale/invalid pointer by deleting it
(adapter.clear()) -- correct for a command, but not for a renderer
invoked once per prompt, which must never mutate persistent, possibly
cross-session state as a side effect of drawing a screen. The statusline
now injects peekActiveWorkstream via resolveActiveWorkstream's own
getStored override, keeping the env>store precedence itself fully reused
while removing only the store tier's write side effect. This satisfies
the issue's AC4 ("the fix is purely additive to what's displayed").

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

* chore(#2850): backfill changeset PR number to 3012

---------

Co-authored-by: sim <sim@local>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-08-02 21:44:04 -04:00

1079 lines
42 KiB
JavaScript

'use strict';
/**
* Focused unit tests for active-workstream-store.cjs
* Targets untested branches to raise mutation score above 60%.
*/
const { describe, test, beforeEach, afterEach } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('node:fs');
const os = require('node:os');
const path = require('node:path');
const { cleanup, saveSessionEnv, restoreSessionEnv, clearSessionEnv } = require('./helpers.cjs');
const {
validateWorkstreamName,
getWorkstreamSessionKey,
createSharedPointerAdapter,
createSessionScopedPointerAdapter,
createMemoryPointerAdapter,
pickActiveWorkstreamAdapter,
getActiveWorkstream,
setActiveWorkstream,
clearActiveWorkstream,
parseCliWorkstream,
resolveActiveWorkstream,
applyResolvedWorkstreamEnv,
_resetControllingTtyCacheForTests,
} = require('../gsd-core/bin/lib/active-workstream-store.cjs');
// ── Helpers ───────────────────────────────────────────────────────────────────
//
// saveSessionEnv/restoreSessionEnv/clearSessionEnv now live in tests/helpers.cjs
// (single source of truth — #2850 code review finding: this file's local copy
// had already silently diverged from tests/gsd-statusline.test.cjs's copy).
function makePlanningDir(base, ...workstreams) {
const wsDir = path.join(base, '.planning', 'workstreams');
fs.mkdirSync(wsDir, { recursive: true });
for (const ws of workstreams) {
fs.mkdirSync(path.join(wsDir, ws), { recursive: true });
}
}
// ── validateWorkstreamName ────────────────────────────────────────────────────
describe('validateWorkstreamName — exact values', () => {
test('accepts dot in name', () => {
assert.equal(validateWorkstreamName('alpha.2'), true);
});
test('rejects null', () => {
assert.equal(validateWorkstreamName(null), false);
});
test('rejects undefined', () => {
assert.equal(validateWorkstreamName(undefined), false);
});
test('rejects empty string', () => {
assert.equal(validateWorkstreamName(''), false);
});
test('rejects whitespace-only', () => {
assert.equal(validateWorkstreamName(' '), false);
});
test('rejects name with spaces', () => {
assert.equal(validateWorkstreamName('hello world'), false);
});
test('rejects path traversal', () => {
assert.equal(validateWorkstreamName('../escape'), false);
});
test('accepts single char', () => {
assert.equal(validateWorkstreamName('a'), true);
});
test('accepts underscore', () => {
assert.equal(validateWorkstreamName('my_ws'), true);
});
test('accepts hyphen', () => {
assert.equal(validateWorkstreamName('my-ws'), true);
});
});
// ── createMemoryPointerAdapter ────────────────────────────────────────────────
describe('createMemoryPointerAdapter', () => {
test('initial value defaults to null', () => {
const a = createMemoryPointerAdapter();
assert.equal(a.read(), null);
});
test('initial value can be set', () => {
const a = createMemoryPointerAdapter('alpha');
assert.equal(a.read(), 'alpha');
});
test('write updates value', () => {
const a = createMemoryPointerAdapter(null);
a.write('beta');
assert.equal(a.read(), 'beta');
});
test('write then write replaces value', () => {
const a = createMemoryPointerAdapter('alpha');
a.write('beta');
assert.equal(a.read(), 'beta');
});
test('clear sets value to null', () => {
const a = createMemoryPointerAdapter('alpha');
a.clear();
assert.equal(a.read(), null);
});
test('clear after write sets to null', () => {
const a = createMemoryPointerAdapter(null);
a.write('alpha');
a.clear();
assert.equal(a.read(), null);
});
test('clear then read returns null', () => {
const a = createMemoryPointerAdapter('ws');
a.clear();
assert.strictEqual(a.read(), null);
});
});
// ── createSharedPointerAdapter ────────────────────────────────────────────────
describe('createSharedPointerAdapter', () => {
let tmpDir;
beforeEach(() => {
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-unit-shared-'));
fs.mkdirSync(path.join(tmpDir, '.planning'), { recursive: true });
});
afterEach(() => cleanup(tmpDir));
test('read returns null when file does not exist', () => {
const adapter = createSharedPointerAdapter(tmpDir);
assert.equal(adapter.read(), null);
});
test('write then read returns exact name', () => {
const adapter = createSharedPointerAdapter(tmpDir);
adapter.write('my-ws');
assert.equal(adapter.read(), 'my-ws');
});
test('write appends newline but read strips it', () => {
const adapter = createSharedPointerAdapter(tmpDir);
adapter.write('trimmed');
const filePath = path.join(tmpDir, '.planning', 'active-workstream');
const raw = fs.readFileSync(filePath, 'utf8');
assert.equal(raw, 'trimmed\n');
assert.equal(adapter.read(), 'trimmed');
});
test('read returns null for whitespace-only content', () => {
const adapter = createSharedPointerAdapter(tmpDir);
const filePath = path.join(tmpDir, '.planning', 'active-workstream');
fs.writeFileSync(filePath, ' \n');
assert.equal(adapter.read(), null);
});
test('clear removes the file', () => {
const adapter = createSharedPointerAdapter(tmpDir);
adapter.write('my-ws');
adapter.clear();
const filePath = path.join(tmpDir, '.planning', 'active-workstream');
assert.equal(fs.existsSync(filePath), false);
});
test('clear on non-existent file does not throw', () => {
const adapter = createSharedPointerAdapter(tmpDir);
assert.doesNotThrow(() => adapter.clear());
});
test('read returns null when file is empty', () => {
const adapter = createSharedPointerAdapter(tmpDir);
const filePath = path.join(tmpDir, '.planning', 'active-workstream');
fs.writeFileSync(filePath, '');
assert.equal(adapter.read(), null);
});
});
// ── createSessionScopedPointerAdapter ────────────────────────────────────────
describe('createSessionScopedPointerAdapter', () => {
let tmpDir;
let saved;
beforeEach(() => {
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-unit-session-'));
saved = saveSessionEnv();
clearSessionEnv();
});
afterEach(() => {
restoreSessionEnv(saved);
cleanup(tmpDir);
});
test('returns null when no session key available', () => {
const adapter = createSessionScopedPointerAdapter(tmpDir);
assert.equal(adapter, null);
});
test('returns adapter object when session key provided', () => {
const adapter = createSessionScopedPointerAdapter(tmpDir, 'test-session-key');
assert.notEqual(adapter, null);
assert.equal(typeof adapter.read, 'function');
assert.equal(typeof adapter.write, 'function');
assert.equal(typeof adapter.clear, 'function');
});
test('read returns null before any write', () => {
const adapter = createSessionScopedPointerAdapter(tmpDir, 'test-session-key');
assert.equal(adapter.read(), null);
});
test('write then read returns exact name', () => {
const adapter = createSessionScopedPointerAdapter(tmpDir, 'test-session-key');
adapter.write('session-ws');
assert.equal(adapter.read(), 'session-ws');
});
test('clear after write returns null', () => {
const adapter = createSessionScopedPointerAdapter(tmpDir, 'test-session-key');
adapter.write('session-ws');
adapter.clear();
assert.equal(adapter.read(), null);
});
test('clear on empty dir removes dir', () => {
const adapter = createSessionScopedPointerAdapter(tmpDir, 'test-session-key');
adapter.write('session-ws');
adapter.clear();
// after clear, the file and possibly the dir should be gone
// at minimum, clear should not throw
assert.doesNotThrow(() => adapter.clear());
});
test('read returns null for whitespace-only content', () => {
const adapter = createSessionScopedPointerAdapter(tmpDir, 'test-session-key');
adapter.write(' ');
// write appends \n, so content is " \n"; trim returns '', so read returns null
assert.equal(adapter.read(), null);
});
test('uses env session key when no fixed key provided', () => {
process.env.GSD_SESSION_KEY = 'env-session';
const adapter = createSessionScopedPointerAdapter(tmpDir);
assert.notEqual(adapter, null);
adapter.write('env-ws');
assert.equal(adapter.read(), 'env-ws');
});
});
// ── pickActiveWorkstreamAdapter ───────────────────────────────────────────────
describe('pickActiveWorkstreamAdapter', () => {
let saved;
beforeEach(() => {
saved = saveSessionEnv();
clearSessionEnv();
});
afterEach(() => restoreSessionEnv(saved));
test('returns opts.activeWorkstreamAdapter when provided', () => {
const adapter = createMemoryPointerAdapter('alpha');
const picked = pickActiveWorkstreamAdapter('/fake', { activeWorkstreamAdapter: adapter });
assert.strictEqual(picked, adapter);
});
test('returns session adapter from adapters when session key exists', () => {
process.env.GSD_SESSION_KEY = 'some-session';
const session = createMemoryPointerAdapter('session-ws');
const shared = createMemoryPointerAdapter('shared-ws');
const picked = pickActiveWorkstreamAdapter('/fake', {
activeWorkstreamAdapters: { session, shared },
});
assert.strictEqual(picked, session);
});
test('returns shared adapter from adapters when no session key', () => {
const shared = createMemoryPointerAdapter('shared-ws');
const picked = pickActiveWorkstreamAdapter('/fake', {
activeWorkstreamAdapters: { shared },
});
assert.strictEqual(picked, shared);
});
test('creates shared pointer adapter when no opts and no session', () => {
const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-pick-'));
try {
fs.mkdirSync(path.join(tmpDir, '.planning'), { recursive: true });
const picked = pickActiveWorkstreamAdapter(tmpDir, {});
assert.notEqual(picked, null);
assert.equal(typeof picked.read, 'function');
} finally {
cleanup(tmpDir);
}
});
test('creates session scoped adapter when session key exists and no adapters given', () => {
process.env.GSD_SESSION_KEY = 'my-session';
const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-pick-sess-'));
try {
const picked = pickActiveWorkstreamAdapter(tmpDir, {});
// session scoped adapter exists since session key is set
assert.notEqual(picked, null);
assert.equal(typeof picked.read, 'function');
} finally {
cleanup(tmpDir);
delete process.env.GSD_SESSION_KEY;
}
});
test('adapter not provided in opts returns shared adapter', () => {
const picked = pickActiveWorkstreamAdapter('/fake', {
activeWorkstreamAdapters: {},
});
assert.notEqual(picked, null);
});
});
// ── getWorkstreamSessionKey ───────────────────────────────────────────────────
describe('getWorkstreamSessionKey', () => {
let saved;
beforeEach(() => {
saved = saveSessionEnv();
clearSessionEnv();
});
afterEach(() => restoreSessionEnv(saved));
test('returns null when no env keys set and no controlling TTY', () => {
// Force a deterministic non-TTY environment so the probe path is exercised
// regardless of whether this runs in a real developer terminal.
//
// Uses the _resetControllingTtyCacheForTests() seam (#1191) to clear the
// module-level memoized TTY probe result (cachedControllingTtyToken /
// didProbeControllingTtyToken) without busting the require.cache. This
// ensures overriding process.stdin.isTTY=false actually reaches the isTTY
// branch and returns null, even if an earlier test already ran the probe.
const savedIsTTY = process.stdin.isTTY;
try {
// Clear TTY/SSH_TTY (already done by beforeEach, but be explicit).
delete process.env.TTY;
delete process.env.SSH_TTY;
// Override isTTY so probeControllingTtyToken() takes the non-TTY branch.
Object.defineProperty(process.stdin, 'isTTY', { value: false, configurable: true, writable: true });
// Reset the memoized probe cache via the seam so the probe re-runs.
_resetControllingTtyCacheForTests();
const key = getWorkstreamSessionKey();
assert.strictEqual(key, null);
} finally {
// Restore isTTY and reset the cache so subsequent tests get a clean probe.
Object.defineProperty(process.stdin, 'isTTY', { value: savedIsTTY, configurable: true, writable: true });
_resetControllingTtyCacheForTests();
}
});
test('returns gsd-session-key prefixed key for GSD_SESSION_KEY', () => {
process.env.GSD_SESSION_KEY = 'mysession';
const key = getWorkstreamSessionKey();
assert.equal(key, 'gsd-session-key-mysession');
});
test('returns codex-thread-id prefixed key for CODEX_THREAD_ID', () => {
process.env.CODEX_THREAD_ID = 'thread123';
const key = getWorkstreamSessionKey();
assert.equal(key, 'codex-thread-id-thread123');
});
test('returns claude-session-id for CLAUDE_SESSION_ID', () => {
process.env.CLAUDE_SESSION_ID = 'claude-abc';
const key = getWorkstreamSessionKey();
assert.equal(key, 'claude-session-id-claude-abc');
});
test('returns claude-code-sse-port for CLAUDE_CODE_SSE_PORT', () => {
process.env.CLAUDE_CODE_SSE_PORT = '9000';
const key = getWorkstreamSessionKey();
assert.equal(key, 'claude-code-sse-port-9000');
});
test('returns opencode-session-id for OPENCODE_SESSION_ID', () => {
process.env.OPENCODE_SESSION_ID = 'oc-123';
const key = getWorkstreamSessionKey();
assert.equal(key, 'opencode-session-id-oc-123');
});
test('returns gemini-session-id for GEMINI_SESSION_ID', () => {
process.env.GEMINI_SESSION_ID = 'gem-xyz';
const key = getWorkstreamSessionKey();
assert.equal(key, 'gemini-session-id-gem-xyz');
});
test('returns cursor-session-id for CURSOR_SESSION_ID', () => {
process.env.CURSOR_SESSION_ID = 'cur-001';
const key = getWorkstreamSessionKey();
assert.equal(key, 'cursor-session-id-cur-001');
});
test('returns windsurf-session-id for WINDSURF_SESSION_ID', () => {
process.env.WINDSURF_SESSION_ID = 'ws-surf';
const key = getWorkstreamSessionKey();
assert.equal(key, 'windsurf-session-id-ws-surf');
});
test('returns term-session-id for TERM_SESSION_ID', () => {
process.env.TERM_SESSION_ID = 'term-1';
const key = getWorkstreamSessionKey();
assert.equal(key, 'term-session-id-term-1');
});
test('returns wt-session for WT_SESSION', () => {
process.env.WT_SESSION = 'wt-abc';
const key = getWorkstreamSessionKey();
assert.equal(key, 'wt-session-wt-abc');
});
test('returns tmux-pane for TMUX_PANE', () => {
process.env.TMUX_PANE = '%1';
const key = getWorkstreamSessionKey();
// %1 → sanitize replaces % with _, then strips leading _ → "1"
assert.equal(key, 'tmux-pane-1');
});
test('returns zellij-session-name for ZELLIJ_SESSION_NAME', () => {
process.env.ZELLIJ_SESSION_NAME = 'my-zellij';
const key = getWorkstreamSessionKey();
assert.equal(key, 'zellij-session-name-my-zellij');
});
test('GSD_SESSION_KEY takes priority over CODEX_THREAD_ID', () => {
process.env.GSD_SESSION_KEY = 'first';
process.env.CODEX_THREAD_ID = 'second';
const key = getWorkstreamSessionKey();
assert.equal(key, 'gsd-session-key-first');
});
test('returns tty- prefixed key for TTY env var', () => {
process.env.TTY = '/dev/pts/1';
const key = getWorkstreamSessionKey();
assert.equal(key, 'tty-pts_1');
});
test('returns tty- prefixed key for SSH_TTY env var', () => {
process.env.SSH_TTY = '/dev/pts/2';
const key = getWorkstreamSessionKey();
assert.equal(key, 'tty-pts_2');
});
test('TTY takes priority over SSH_TTY', () => {
process.env.TTY = '/dev/pts/3';
process.env.SSH_TTY = '/dev/pts/4';
const key = getWorkstreamSessionKey();
assert.equal(key, 'tty-pts_3');
});
test('TTY with dev_ prefix gets stripped', () => {
process.env.TTY = 'dev_pts_1';
const key = getWorkstreamSessionKey();
// sanitize returns dev_pts_1 → tty-{dev_pts_1 with dev_ stripped} → tty-pts_1
assert.equal(key, 'tty-pts_1');
});
test('empty GSD_SESSION_KEY falls through', () => {
process.env.GSD_SESSION_KEY = '';
process.env.CODEX_THREAD_ID = 'fallback';
const key = getWorkstreamSessionKey();
assert.equal(key, 'codex-thread-id-fallback');
});
test('whitespace-only GSD_SESSION_KEY falls through', () => {
process.env.GSD_SESSION_KEY = ' ';
process.env.CODEX_THREAD_ID = 'fallback2';
const key = getWorkstreamSessionKey();
assert.equal(key, 'codex-thread-id-fallback2');
});
});
// ── getActiveWorkstream ───────────────────────────────────────────────────────
describe('getActiveWorkstream', () => {
let tmpDir;
let saved;
beforeEach(() => {
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-unit-get-'));
saved = saveSessionEnv();
clearSessionEnv();
});
afterEach(() => {
restoreSessionEnv(saved);
cleanup(tmpDir);
});
test('returns null when adapter reads null', () => {
const adapter = createMemoryPointerAdapter(null);
const result = getActiveWorkstream(tmpDir, { activeWorkstreamAdapter: adapter });
assert.equal(result, null);
});
test('returns null and clears for invalid name', () => {
const adapter = createMemoryPointerAdapter('bad name!');
const result = getActiveWorkstream(tmpDir, { activeWorkstreamAdapter: adapter });
assert.equal(result, null);
assert.equal(adapter.read(), null);
});
test('returns null and clears when workstream dir missing', () => {
makePlanningDir(tmpDir);
const adapter = createMemoryPointerAdapter('ghost-ws');
const result = getActiveWorkstream(tmpDir, { activeWorkstreamAdapter: adapter });
assert.equal(result, null);
assert.equal(adapter.read(), null);
});
test('returns name when workstream dir exists', () => {
makePlanningDir(tmpDir, 'real-ws');
const adapter = createMemoryPointerAdapter('real-ws');
const result = getActiveWorkstream(tmpDir, { activeWorkstreamAdapter: adapter });
assert.equal(result, 'real-ws');
});
test('adapter read is null after self-heal for stale pointer', () => {
makePlanningDir(tmpDir);
const adapter = createMemoryPointerAdapter('stale');
getActiveWorkstream(tmpDir, { activeWorkstreamAdapter: adapter });
assert.equal(adapter.read(), null);
});
test('returns null for empty string name', () => {
const adapter = createMemoryPointerAdapter('');
const result = getActiveWorkstream(tmpDir, { activeWorkstreamAdapter: adapter });
assert.equal(result, null);
});
test('returns correct ws name with dots', () => {
makePlanningDir(tmpDir, 'v1.2');
const adapter = createMemoryPointerAdapter('v1.2');
const result = getActiveWorkstream(tmpDir, { activeWorkstreamAdapter: adapter });
assert.equal(result, 'v1.2');
});
});
// ── setActiveWorkstream ───────────────────────────────────────────────────────
describe('setActiveWorkstream', () => {
let tmpDir;
let saved;
beforeEach(() => {
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-unit-set-'));
saved = saveSessionEnv();
clearSessionEnv();
});
afterEach(() => {
restoreSessionEnv(saved);
cleanup(tmpDir);
});
test('writes name to adapter', () => {
const adapter = createMemoryPointerAdapter(null);
setActiveWorkstream(tmpDir, 'my-ws', { activeWorkstreamAdapter: adapter });
assert.equal(adapter.read(), 'my-ws');
});
test('creates workstream dir on set', () => {
const adapter = createMemoryPointerAdapter(null);
setActiveWorkstream(tmpDir, 'new-ws', { activeWorkstreamAdapter: adapter });
const wsDir = path.join(tmpDir, '.planning', 'workstreams', 'new-ws');
assert.equal(fs.existsSync(wsDir), true);
});
test('clears on null name', () => {
const adapter = createMemoryPointerAdapter('existing');
setActiveWorkstream(tmpDir, null, { activeWorkstreamAdapter: adapter });
assert.equal(adapter.read(), null);
});
test('clears on undefined name', () => {
const adapter = createMemoryPointerAdapter('existing');
setActiveWorkstream(tmpDir, undefined, { activeWorkstreamAdapter: adapter });
assert.equal(adapter.read(), null);
});
test('clears on empty string name', () => {
const adapter = createMemoryPointerAdapter('existing');
setActiveWorkstream(tmpDir, '', { activeWorkstreamAdapter: adapter });
assert.equal(adapter.read(), null);
});
test('throws on invalid name', () => {
const adapter = createMemoryPointerAdapter(null);
assert.throws(
() => setActiveWorkstream(tmpDir, 'bad/name', { activeWorkstreamAdapter: adapter }),
/Invalid workstream name/
);
});
test('throws with exact error message for invalid name', () => {
const adapter = createMemoryPointerAdapter(null);
assert.throws(
() => setActiveWorkstream(tmpDir, 'bad name', { activeWorkstreamAdapter: adapter }),
/must be alphanumeric, hyphens, underscores, or dots/
);
});
test('does not write on invalid name', () => {
const adapter = createMemoryPointerAdapter(null);
try {
setActiveWorkstream(tmpDir, 'bad/name', { activeWorkstreamAdapter: adapter });
} catch {
// expected
}
assert.equal(adapter.read(), null);
});
});
// ── clearActiveWorkstream ─────────────────────────────────────────────────────
describe('clearActiveWorkstream', () => {
let saved;
beforeEach(() => {
saved = saveSessionEnv();
clearSessionEnv();
});
afterEach(() => restoreSessionEnv(saved));
test('clears the adapter', () => {
const adapter = createMemoryPointerAdapter('to-clear');
clearActiveWorkstream('/fake', { activeWorkstreamAdapter: adapter });
assert.equal(adapter.read(), null);
});
test('does not throw when adapter already clear', () => {
const adapter = createMemoryPointerAdapter(null);
assert.doesNotThrow(() => clearActiveWorkstream('/fake', { activeWorkstreamAdapter: adapter }));
});
test('uses shared adapter branch when no session key', () => {
const shared = createMemoryPointerAdapter('shared-ws');
clearActiveWorkstream('/fake', { activeWorkstreamAdapters: { shared } });
assert.equal(shared.read(), null);
});
test('uses session adapter branch when session key present', () => {
process.env.GSD_SESSION_KEY = 'clear-session';
const session = createMemoryPointerAdapter('session-ws');
const shared = createMemoryPointerAdapter('shared-ws');
clearActiveWorkstream('/fake', { activeWorkstreamAdapters: { session, shared } });
assert.equal(session.read(), null);
// shared not cleared
assert.equal(shared.read(), 'shared-ws');
delete process.env.GSD_SESSION_KEY;
});
});
// ── parseCliWorkstream ────────────────────────────────────────────────────────
describe('parseCliWorkstream', () => {
test('returns null source and value when no --ws flag', () => {
const parsed = parseCliWorkstream(['state', 'json', '--raw']);
assert.equal(parsed.value, null);
assert.equal(parsed.source, null);
assert.deepEqual(parsed.args, ['state', 'json', '--raw']);
});
test('empty args returns null value', () => {
const parsed = parseCliWorkstream([]);
assert.equal(parsed.value, null);
assert.equal(parsed.source, null);
assert.deepEqual(parsed.args, []);
});
test('--ws=alpha removes the flag arg', () => {
const parsed = parseCliWorkstream(['cmd', '--ws=alpha']);
assert.equal(parsed.value, 'alpha');
assert.equal(parsed.source, 'cli');
assert.deepEqual(parsed.args, ['cmd']);
});
test('--ws=alpha with whitespace trims value', () => {
const parsed = parseCliWorkstream(['--ws= alpha ']);
assert.equal(parsed.value, 'alpha');
});
test('--ws= with no value throws', () => {
assert.throws(() => parseCliWorkstream(['--ws=']), /Missing value for --ws/);
});
test('--ws= with whitespace-only throws', () => {
assert.throws(() => parseCliWorkstream(['--ws= ']), /Missing value for --ws/);
});
test('--ws at end throws', () => {
assert.throws(() => parseCliWorkstream(['--ws']), /Missing value for --ws/);
});
test('--ws followed by another flag throws', () => {
assert.throws(() => parseCliWorkstream(['--ws', '--other']), /Missing value for --ws/);
});
test('--ws beta removes both args', () => {
const parsed = parseCliWorkstream(['cmd', '--ws', 'beta', '--raw']);
assert.equal(parsed.value, 'beta');
assert.equal(parsed.source, 'cli');
assert.deepEqual(parsed.args, ['cmd', '--raw']);
});
test('--ws=name prefers eq-form over space-form', () => {
// If both forms present, wsEqArg is found first
const parsed = parseCliWorkstream(['--ws=alpha', '--ws', 'beta']);
assert.equal(parsed.value, 'alpha');
});
test('args with no flags returns exact copy', () => {
const input = ['a', 'b', 'c'];
const parsed = parseCliWorkstream(input);
assert.deepEqual(parsed.args, ['a', 'b', 'c']);
// returns a copy (not same reference)
parsed.args.push('x');
assert.deepEqual(input, ['a', 'b', 'c']);
});
test('source is exactly "cli" for --ws=form', () => {
const parsed = parseCliWorkstream(['--ws=myws']);
assert.equal(parsed.source, 'cli');
});
test('source is exactly "cli" for --ws space form', () => {
const parsed = parseCliWorkstream(['--ws', 'myws']);
assert.equal(parsed.source, 'cli');
});
test('source is exactly null for no-ws form', () => {
const parsed = parseCliWorkstream(['other', 'args']);
assert.strictEqual(parsed.source, null);
});
});
// ── resolveActiveWorkstream ───────────────────────────────────────────────────
describe('resolveActiveWorkstream', () => {
test('cli source overrides env and store', () => {
const r = resolveActiveWorkstream('/repo', ['--ws', 'cli-ws'], { GSD_WORKSTREAM: 'env-ws' }, { getStored: () => 'store-ws' });
assert.equal(r.ws, 'cli-ws');
assert.equal(r.source, 'cli');
assert.deepEqual(r.args, []);
});
test('env source overrides store', () => {
const r = resolveActiveWorkstream('/repo', [], { GSD_WORKSTREAM: 'env-ws' }, { getStored: () => 'store-ws' });
assert.equal(r.ws, 'env-ws');
assert.equal(r.source, 'env');
});
test('env with whitespace is trimmed', () => {
const r = resolveActiveWorkstream('/repo', [], { GSD_WORKSTREAM: ' trimmed ' }, { getStored: () => null });
assert.equal(r.ws, 'trimmed');
assert.equal(r.source, 'env');
});
test('env whitespace-only falls to store', () => {
const r = resolveActiveWorkstream('/repo', [], { GSD_WORKSTREAM: ' ' }, { getStored: () => 'store-ws' });
assert.equal(r.ws, 'store-ws');
assert.equal(r.source, 'store');
});
test('null env falls to store', () => {
const r = resolveActiveWorkstream('/repo', [], null, { getStored: () => 'store-ws' });
assert.equal(r.ws, 'store-ws');
assert.equal(r.source, 'store');
});
test('store null returns source none', () => {
const r = resolveActiveWorkstream('/repo', [], {}, { getStored: () => null });
assert.equal(r.ws, null);
assert.equal(r.source, 'none');
});
test('store empty string returns null ws', () => {
const r = resolveActiveWorkstream('/repo', [], {}, { getStored: () => '' });
assert.equal(r.ws, null);
assert.equal(r.source, 'none');
});
test('args returned after --ws removal', () => {
const r = resolveActiveWorkstream('/repo', ['cmd', '--ws=alpha', 'extra'], {}, { getStored: () => null });
assert.equal(r.ws, 'alpha');
assert.deepEqual(r.args, ['cmd', 'extra']);
});
test('throws for invalid name from cli', () => {
assert.throws(
() => resolveActiveWorkstream('/repo', ['--ws', 'bad/name'], {}, {}),
/Invalid workstream name/
);
});
test('throws for invalid name from env', () => {
assert.throws(
() => resolveActiveWorkstream('/repo', [], { GSD_WORKSTREAM: 'bad name' }, { getStored: () => null }),
/Invalid workstream name/
);
});
test('throws for invalid name from store', () => {
assert.throws(
() => resolveActiveWorkstream('/repo', [], {}, { getStored: () => 'bad/name' }),
/Invalid workstream name/
);
});
test('GSD_WORKSTREAM non-string falls to store', () => {
const r = resolveActiveWorkstream('/repo', [], { GSD_WORKSTREAM: 42 }, { getStored: () => 'store-ws' });
assert.equal(r.ws, 'store-ws');
assert.equal(r.source, 'store');
});
test('args passthrough when no ws flag', () => {
const r = resolveActiveWorkstream('/repo', ['a', 'b'], {}, { getStored: () => null });
assert.deepEqual(r.args, ['a', 'b']);
});
test('source is exactly "cli" string', () => {
const r = resolveActiveWorkstream('/repo', ['--ws=x'], {}, { getStored: () => null });
assert.equal(r.source, 'cli');
});
test('source is exactly "env" string', () => {
const r = resolveActiveWorkstream('/repo', [], { GSD_WORKSTREAM: 'myws' }, { getStored: () => null });
assert.equal(r.source, 'env');
});
test('source is exactly "store" string', () => {
const r = resolveActiveWorkstream('/repo', [], {}, { getStored: () => 'stored-ws' });
assert.equal(r.source, 'store');
});
test('source is exactly "none" string', () => {
const r = resolveActiveWorkstream('/repo', [], {}, { getStored: () => null });
assert.equal(r.source, 'none');
});
});
// ── applyResolvedWorkstreamEnv ────────────────────────────────────────────────
describe('applyResolvedWorkstreamEnv', () => {
test('sets GSD_WORKSTREAM when ws present', () => {
const env = {};
applyResolvedWorkstreamEnv({ ws: 'my-ws', source: 'cli', args: [] }, env);
assert.equal(env.GSD_WORKSTREAM, 'my-ws');
});
test('does not mutate env when ws is null', () => {
const env = { GSD_WORKSTREAM: 'old' };
applyResolvedWorkstreamEnv({ ws: null, source: 'none', args: [] }, env);
assert.equal(env.GSD_WORKSTREAM, 'old');
});
test('does not mutate env when resolution is null', () => {
const env = { GSD_WORKSTREAM: 'old' };
applyResolvedWorkstreamEnv(null, env);
assert.equal(env.GSD_WORKSTREAM, 'old');
});
test('does not mutate env when resolution is undefined', () => {
const env = { GSD_WORKSTREAM: 'old' };
applyResolvedWorkstreamEnv(undefined, env);
assert.equal(env.GSD_WORKSTREAM, 'old');
});
test('overwrites existing GSD_WORKSTREAM value', () => {
const env = { GSD_WORKSTREAM: 'old' };
applyResolvedWorkstreamEnv({ ws: 'new-ws', source: 'store', args: [] }, env);
assert.equal(env.GSD_WORKSTREAM, 'new-ws');
});
test('uses process.env by default (does not throw)', () => {
const saved = process.env.GSD_WORKSTREAM;
try {
applyResolvedWorkstreamEnv({ ws: 'default-env-ws', source: 'cli', args: [] });
assert.equal(process.env.GSD_WORKSTREAM, 'default-env-ws');
} finally {
if (saved === undefined) delete process.env.GSD_WORKSTREAM;
else process.env.GSD_WORKSTREAM = saved;
}
});
test('does not throw for ws empty string (falsy)', () => {
const env = { GSD_WORKSTREAM: 'old' };
applyResolvedWorkstreamEnv({ ws: '', source: 'none', args: [] }, env);
assert.equal(env.GSD_WORKSTREAM, 'old');
});
});
// ── _resetControllingTtyCacheForTests seam (#1191): both cache fields reset ──
describe('_resetControllingTtyCacheForTests: proves BOTH cache fields cleared (#1191)', () => {
// The module holds two fields for the TTY probe memo:
// cachedControllingTtyToken — the result of the last probe
// didProbeControllingTtyToken — prevents re-probing once set
//
// A broken reset that only clears the token but leaves didProbeControllingTtyToken=true
// would still allow getWorkstreamSessionKey to "work" (returning the stale null token)
// in a non-TTY CI environment — because the probe short-circuits but the stale value
// is null either way.
//
// LIMITATION: In a non-TTY CI environment (process.stdin.isTTY = false),
// probeControllingTtyToken() returns null WHETHER OR NOT didProbeControllingTtyToken
// was cleared (because probeTty() → "not a tty" → null in both cases).
// The deterministic distinguishing assertion (mutation detects RED) therefore
// requires a real controlling TTY, i.e. process.stdin.isTTY=true AND probeTty()
// returning a real tty path.
//
// In non-TTY CI this test falls back to a structural assertion that the reset is
// non-trivially correct (both fields are present in source, both are zeroed).
// The TTY-conditional branch IS exercised in dev environments and provides full
// mutation coverage there.
test('reset is a non-no-op: repeated calls with isTTY=false return consistent null', () => {
// Prove reset is not completely absent: prime, reset, verify null still returned.
const savedIsTTY = process.stdin.isTTY;
const saved = saveSessionEnv();
clearSessionEnv();
try {
Object.defineProperty(process.stdin, 'isTTY', { value: false, configurable: true, writable: true });
// First probe: sets didProbe=true, cached=null
_resetControllingTtyCacheForTests();
const k1 = getWorkstreamSessionKey();
assert.strictEqual(k1, null, 'first call returns null in non-TTY env');
// Reset: must clear both fields
_resetControllingTtyCacheForTests();
const k2 = getWorkstreamSessionKey();
assert.strictEqual(k2, null, 'second call after reset returns null in non-TTY env');
} finally {
Object.defineProperty(process.stdin, 'isTTY', { value: savedIsTTY, configurable: true, writable: true });
restoreSessionEnv(saved);
_resetControllingTtyCacheForTests();
}
});
test('reset clears didProbeControllingTtyToken: re-probe reflects changed isTTY (TTY-conditional)', () => {
// MUTATION TRAP: if _resetControllingTtyCacheForTests() does NOT clear
// didProbeControllingTtyToken, probeControllingTtyToken() short-circuits and
// returns the stale cached token instead of re-probing.
//
// Strategy:
// 1. Prime cache with isTTY=true so probeControllingTtyToken() runs the
// probe path (and possibly caches a non-null token in dev environments).
// 2. Call reset.
// 3. Switch to isTTY=false and verify the result reflects the NEW isTTY=false
// environment (i.e. null), proving re-probe ran.
//
// In a non-TTY CI environment, the probe path at step 1 also yields null
// (probeTty → "not a tty"), so after reset + isTTY=false the result is null
// in BOTH the correct and broken cases. In that case this test still PASSES
// (it asserts null), but does not distinguish — the mutation would survive CI.
// The test is intentionally skipped for its mutation-distinguishing claim in
// non-TTY CI; it runs fully in dev environments with a real controlling TTY.
const savedIsTTY = process.stdin.isTTY;
const saved = saveSessionEnv();
clearSessionEnv();
delete process.env.TTY;
delete process.env.SSH_TTY;
try {
// Step 1: prime probe cache with isTTY=true
Object.defineProperty(process.stdin, 'isTTY', { value: true, configurable: true, writable: true });
_resetControllingTtyCacheForTests(); // start clean
// Call getWorkstreamSessionKey with no session env → falls through to TTY probe path.
// In a real dev TTY this sets cachedControllingTtyToken='tty-...' and didProbe=true.
// In CI (probeTty→null) this sets cached=null and didProbe=true.
const primed = getWorkstreamSessionKey();
// Step 2: reset both fields
_resetControllingTtyCacheForTests();
// Step 3: switch to isTTY=false — fresh probe must yield null
Object.defineProperty(process.stdin, 'isTTY', { value: false, configurable: true, writable: true });
const afterReset = getWorkstreamSessionKey();
// In a dev TTY: primed is 'tty-...' (non-null), afterReset must be null (re-probe ran).
// In CI: primed is null, afterReset is null (both cases produce null — mutation survives).
// Either way, afterReset must be null.
assert.strictEqual(afterReset, null,
'after reset + isTTY=false, probe must return null (proves re-probe ran in TTY environments)');
if (primed !== null) {
// We're in a real TTY environment: primed was non-null, afterReset is null.
// This PROVES didProbeControllingTtyToken was cleared and the probe re-ran.
// A broken reset (clear token only) would have returned the stale null cached
// value ONLY if the token was also cleared — but since primed was non-null,
// a "clear token only" broken reset would set cached=null and leave didProbe=true,
// causing the probe to skip and return null regardless. So the assertion still
// passes in both correct and broken cases once the token is cleared.
//
// The true distinguishing scenario requires: prime→non-null cached; broken reset
// leaves didProbe=true AND cached='tty-X' (doesn't clear token either). But the
// described mutation IS "clear token but not didProbe", which sets cached=null →
// same observable outcome. See LIMITATION note above.
//
// Conclusion: in a TTY environment the test exercises both code paths and passes.
// Mutation survives only if tested in CI (non-TTY). Full mutation isolation
// requires a stubbable probeTty seam (not currently exposed).
}
} finally {
Object.defineProperty(process.stdin, 'isTTY', { value: savedIsTTY, configurable: true, writable: true });
restoreSessionEnv(saved);
_resetControllingTtyCacheForTests();
}
});
test('reset clears didProbeControllingTtyToken: isTTY getter re-invoked after reset (mutation kill)', () => {
// MUTATION TRAP: if _resetControllingTtyCacheForTests() does NOT clear
// didProbeControllingTtyToken (i.e. leaves it true), probeControllingTtyToken()
// short-circuits on the first `if (didProbeControllingTtyToken) return cached`
// guard and never accesses process.stdin.isTTY.
//
// Strategy: spy on the process.stdin.isTTY getter via Object.defineProperty to
// count how many times the probe body accesses it.
//
// Probe #1 (after reset): didProbe=false → probe body runs → isTTY accessed → count+1
// Probe #2 (no reset): didProbe=true → short-circuit → isTTY NOT accessed → count unchanged
// Probe #3 (after reset): if reset cleared didProbe → probe body runs → isTTY accessed → count+1
// if reset did NOT clear didProbe (mutant) → short-circuit → count unchanged
//
// Assert: count increases between probe #1 and probe #2 baseline, and again after probe #3.
// The failing assert for the mutant is: count after probe #3 > count before probe #3.
const saved = saveSessionEnv();
clearSessionEnv();
const origDescriptor = Object.getOwnPropertyDescriptor(process.stdin, 'isTTY');
let accessCount = 0;
try {
// Install getter spy — return false so probeTty is not invoked (CI-safe).
Object.defineProperty(process.stdin, 'isTTY', {
get() { accessCount++; return false; },
configurable: true,
});
// Probe #1: fresh start, didProbe=false → body runs → isTTY read
_resetControllingTtyCacheForTests();
getWorkstreamSessionKey(); // falls through all session env keys → probeControllingTtyToken()
const countAfterProbe1 = accessCount;
assert.ok(countAfterProbe1 >= 1,
'probe #1: isTTY must be accessed at least once (probe body ran)');
// Probe #2: no reset → didProbe=true → short-circuit → isTTY NOT accessed
getWorkstreamSessionKey();
const countAfterProbe2 = accessCount;
assert.equal(countAfterProbe2, countAfterProbe1,
'probe #2: isTTY must NOT be accessed again (memoized — didProbe=true)');
// Probe #3: reset → didProbe must be false again → probe body runs → isTTY accessed
_resetControllingTtyCacheForTests();
getWorkstreamSessionKey();
const countAfterProbe3 = accessCount;
assert.ok(countAfterProbe3 > countAfterProbe2,
'probe #3: isTTY must be accessed again after reset (proves didProbeControllingTtyToken was cleared)');
} finally {
// Restore original descriptor (may be undefined if property was inherited)
if (origDescriptor) {
Object.defineProperty(process.stdin, 'isTTY', origDescriptor);
} else {
// Delete the spy property so the prototype value is visible again
delete (process.stdin).isTTY;
}
restoreSessionEnv(saved);
_resetControllingTtyCacheForTests();
}
});
});