Files
msd-core/sdk/src/query/workstream.test.ts
Tom Boucher 26dcdb1ad0 Refactor SDK-first architecture seams (#3316)
* refactor: tighten sdk-first architecture seams

Refs #3312

* refactor: finish state document seam cleanup

Refs #3312

* test: harden minimal install cleanup assertion

* ci: support sdk-scoped package lock

* fix(3316): restore root package-lock.json and align changeset pr ref

Reverts dec57a83 ("ci: support sdk-scoped package lock") and restores
the root package-lock.json that c249d34d deleted. The deletion was the
wrong direction:

- The root package.json declares its own runtime and dev deps
  (@anthropic-ai/claude-agent-sdk, ws, c8). Without a root lockfile,
  `npm install --no-package-lock` resolves whatever satisfies semver at
  install time — CI today and CI in six months can install different
  transitive trees, defeating reproducibility.
- The lockfile has been part of every release on this repo (long
  history on main); removing it loses the npm audit / Dependabot
  target without compensating benefit.
- The CI workaround pattern (cache-dependency-path: sdk/package-lock.json
  + `npm install --no-package-lock`) papered over the symptom rather
  than fix the cause.

Also fix the changeset pr: from 3312 (issue) to 3316 (PR). CONTEXT.md
flags this exact failure mode as a recurring CodeRabbit finding.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* fix: address coderabbit review findings

* fix: close remaining coderabbit threads

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-09 14:21:42 -04:00

154 lines
5.5 KiB
TypeScript

/**
* Tests for workstream query handlers.
*/
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
import { mkdtemp, mkdir, rm, writeFile } from 'node:fs/promises';
import { join } from 'node:path';
import { tmpdir } from 'node:os';
import { readFile } from 'node:fs/promises';
import { workstreamList, workstreamCreate, workstreamSet, workstreamProgress } from './workstream.js';
describe('workstreamList', () => {
let tmpDir: string;
beforeEach(async () => {
tmpDir = await mkdtemp(join(tmpdir(), 'gsd-ws-'));
await mkdir(join(tmpDir, '.planning'), { recursive: true });
await writeFile(join(tmpDir, '.planning', 'config.json'), JSON.stringify({ model_profile: 'balanced' }));
});
afterEach(async () => {
await rm(tmpDir, { recursive: true, force: true });
});
it('returns flat mode when no workstreams directory', async () => {
const r = await workstreamList([], tmpDir);
const data = r.data as Record<string, unknown>;
expect(data.mode).toBe('flat');
expect(Array.isArray(data.workstreams)).toBe(true);
});
});
describe('workstreamProgress', () => {
let tmpDir: string;
beforeEach(async () => {
tmpDir = await mkdtemp(join(tmpdir(), 'gsd-ws-progress-'));
const wsDir = join(tmpDir, '.planning', 'workstreams', 'overflow');
await mkdir(join(wsDir, 'phases', '01-one'), { recursive: true });
await mkdir(join(wsDir, 'phases', '02-two'), { recursive: true });
await writeFile(join(wsDir, 'phases', '01-one', 'PLAN.md'), '# Plan\n');
await writeFile(join(wsDir, 'phases', '01-one', 'SUMMARY.md'), '# Summary\n');
await writeFile(join(wsDir, 'phases', '02-two', 'PLAN.md'), '# Plan\n');
await writeFile(join(wsDir, 'phases', '02-two', 'SUMMARY.md'), '# Summary\n');
await writeFile(join(wsDir, 'STATE.md'), '# State\nStatus: In progress\n');
await writeFile(join(wsDir, 'ROADMAP.md'), '# Roadmap\n### Phase 1: One\n');
await writeFile(join(tmpDir, '.planning', 'active-workstream'), 'overflow\n');
});
afterEach(async () => {
await rm(tmpDir, { recursive: true, force: true });
});
it('clamps progress percent when completed phase dirs exceed roadmap count', async () => {
const result = await workstreamProgress([], tmpDir);
const data = result.data as { workstreams: Array<{ progress_percent: number }> };
expect(data.workstreams[0].progress_percent).toBe(100);
});
});
describe('workstreamCreate', () => {
let tmpDir: string;
beforeEach(async () => {
tmpDir = await mkdtemp(join(tmpdir(), 'gsd-ws2-'));
await mkdir(join(tmpDir, '.planning'), { recursive: true });
await writeFile(join(tmpDir, '.planning', 'config.json'), JSON.stringify({ model_profile: 'balanced' }));
});
afterEach(async () => {
await rm(tmpDir, { recursive: true, force: true });
});
it('creates workstream directory tree', async () => {
const r = await workstreamCreate(['test-ws'], tmpDir);
const data = r.data as Record<string, unknown>;
expect(data.created).toBe(true);
});
});
describe('workstreamSet root STATE.md mirror sync (#2618 gap 2)', () => {
let tmpDir: string;
beforeEach(async () => {
tmpDir = await mkdtemp(join(tmpdir(), 'gsd-ws-set-'));
await mkdir(join(tmpDir, '.planning'), { recursive: true });
await writeFile(
join(tmpDir, '.planning', 'config.json'),
JSON.stringify({ model_profile: 'balanced' }),
);
// Root STATE.md with stale frontmatter (mirror of some prior workstream)
const rootState = [
'---',
'gsd_state_version: 1.0',
'milestone: v0.stale',
'milestone_name: Stale Mirror',
'active_workstream: old-ws',
'current_phase: "99"',
'status: completed',
'last_updated: "2020-01-01T00:00:00.000Z"',
'---',
'',
'# Project State',
'',
].join('\n');
await writeFile(join(tmpDir, '.planning', 'STATE.md'), rootState);
// Target workstream with different frontmatter
const wsDir = join(tmpDir, '.planning', 'workstreams', 'active-ws');
await mkdir(wsDir, { recursive: true });
const wsState = [
'---',
'gsd_state_version: 1.0',
'milestone: v1.0',
'milestone_name: Active Milestone',
'active_workstream: active-ws',
'current_phase: "3"',
'status: executing',
'last_updated: "2026-04-23T00:00:00.000Z"',
'---',
'',
'# Project State',
'',
'Status: executing',
'Current Phase: 3',
'',
].join('\n');
await writeFile(join(wsDir, 'STATE.md'), wsState);
});
afterEach(async () => {
await rm(tmpDir, { recursive: true, force: true });
});
it('rewrites root .planning/STATE.md to mirror the new workstream STATE.md on switch', async () => {
const r = await workstreamSet(['active-ws'], tmpDir);
const data = r.data as Record<string, unknown>;
expect(data.set).toBe(true);
expect(data.active).toBe('active-ws');
const rootStateAfter = await readFile(join(tmpDir, '.planning', 'STATE.md'), 'utf-8');
// The stale mirror fields must be gone; new workstream fields must be present.
expect(rootStateAfter).toContain('milestone: v1.0');
expect(rootStateAfter).toContain('milestone_name: Active Milestone');
expect(rootStateAfter).toContain('active_workstream: active-ws');
expect(rootStateAfter).toContain('current_phase:');
expect(rootStateAfter).toContain('status: executing');
expect(rootStateAfter).not.toContain('milestone: v0.stale');
expect(rootStateAfter).not.toContain('Stale Mirror');
});
});