* feat: Phase 2 caller migration — gsd-sdk query in workflows (#2122) Cherry-picked orchestration rewrites from feat/sdk-foundation (#2008, 4018fee) onto current main, resolving conflicts to keep upstream worktree guards and post-merge test gate. SDK stub registry omitted (out of Phase 2 scope per #2122). Refs: #2122 #2008 Made-with: Cursor * docs: add gsd-sdk query migration blurb Made-with: Cursor * docs(workflows): extend Phase 2 gsd-sdk query caller migration - Swap node gsd-tools.cjs for gsd-sdk query in review, plan-phase, execute-plan, ship, extract_learnings, ai-integration-phase, eval-review, next, thread - Document graphify CJS-only in gsd-planner; dual-path in CLI-TOOLS and ARCHITECTURE - Update tests: workstreams gsd-sdk path, thread frontmatter.get, workspace init.*, CRLF-safe autonomous frontmatter parse - CHANGELOG: Phase 2 caller migration scope Made-with: Cursor * docs(phase2): USER-GUIDE + remaining gsd-sdk query call sites - USER-GUIDE: dual-path CLI section; state validate/sync use full CJS path - Commands: debug (config-get+tdd), quick (security note), intel Task prompt - Agent: gsd-debug-session-manager resolve-model via jq - Workflows: milestone-summary, forensics, next, complete-milestone/verify-work (audit-open CJS notes), discuss-phase, progress, verify-phase, add/insert/remove phase, transition, manager, quick workflow; remove-phase commit without --files - Test: quick-session-management accepts frontmatter.get - CHANGELOG: Phase 2 follow-up bullet Made-with: Cursor * docs(phase2): align gsd-sdk query examples in commands and agents - init.* query names; frontmatter.get uses positional field name - state.* handlers use positional args; commit uses positional paths - CJS-only notes for from-gsd2 and graphify; learnings.query wording - CHANGELOG: Phase 2 orchestration doc pass Made-with: Cursor * docs(phase2): normalize gsd-sdk query commit to positional file paths - Strip --files from commit examples in workflows, references, commands - Keep commit-to-subrepo ... --files (separate handler) - git-planning-commit.md: document positional args - Tests: new-project commit line, state.record-session, gates CRLF, roadmap.analyze - CHANGELOG [Unreleased] Made-with: Cursor * feat(sdk): gsd-sdk query parity with gsd-tools and PR 2179 registry fixes - Route query via longest-prefix match and dotted single-token expansion; fall back to runGsdToolsQuery (same argv as node gsd-tools.cjs) for full CLI coverage. - Parse gsd-sdk query permissively so gsd-tools flags (--json, --verify, etc.) are not rejected by strict parseArgs. - resolveGsdToolsPath: honor GSD_TOOLS_PATH; prefer bundled get-shit-done copy over project .claude installs; export runGsdToolsQuery from the SDK. - Fix gsd-tools audit-open (core.output; pass object for --json JSON). - Register summary-extract as alias of summary.extract; fix audit-fix workflow to call audit-uat instead of invalid init.audit-uat (PR review). Updates QUERY-HANDLERS.md and CHANGELOG [Unreleased]. Made-with: Cursor * fix(sdk): Phase 2 scope — Trek-e review (#2179, #2122) - Remove gsd-sdk query passthrough to gsd-tools.cjs; drop GSD_TOOLS_PATH - Consolidate argv routing in resolveQueryArgv(); update USAGE and QUERY-HANDLERS - Surface @file: read failures in GSDTools.parseOutput - execute-plan: defer Task Commit Protocol to gsd-executor - stale-colon-refs: skip .planning/ and root CLAUDE.md (gitignored overlays) - CHANGELOG [Unreleased]: maintainer review and routing notes Made-with: Cursor
182 lines
6.5 KiB
TypeScript
182 lines
6.5 KiB
TypeScript
/**
|
|
* Unit tests for QueryRegistry, extractField, and createRegistry factory.
|
|
*/
|
|
|
|
import { describe, it, expect, vi } from 'vitest';
|
|
import { QueryRegistry, extractField, resolveQueryArgv } from './registry.js';
|
|
import { createRegistry, QUERY_MUTATION_COMMANDS } from './index.js';
|
|
import type { QueryResult } from './utils.js';
|
|
|
|
// ─── extractField ──────────────────────────────────────────────────────────
|
|
|
|
describe('extractField', () => {
|
|
it('extracts nested value with dot notation', () => {
|
|
expect(extractField({ a: { b: 1 } }, 'a.b')).toBe(1);
|
|
});
|
|
|
|
it('extracts top-level value', () => {
|
|
expect(extractField({ slug: 'my-phase' }, 'slug')).toBe('my-phase');
|
|
});
|
|
|
|
it('extracts array element with bracket notation', () => {
|
|
expect(extractField({ items: [10, 20, 30] }, 'items[1]')).toBe(20);
|
|
});
|
|
|
|
it('extracts array element with negative index', () => {
|
|
expect(extractField({ items: [10, 20, 30] }, 'items[-1]')).toBe(30);
|
|
});
|
|
|
|
it('returns undefined for null input', () => {
|
|
expect(extractField(null, 'a')).toBeUndefined();
|
|
});
|
|
|
|
it('returns undefined for undefined input', () => {
|
|
expect(extractField(undefined, 'a')).toBeUndefined();
|
|
});
|
|
|
|
it('returns undefined for missing nested path', () => {
|
|
expect(extractField({ a: 1 }, 'b.c')).toBeUndefined();
|
|
});
|
|
|
|
it('returns undefined when bracket access targets non-array', () => {
|
|
expect(extractField({ items: 'not-array' }, 'items[0]')).toBeUndefined();
|
|
});
|
|
|
|
it('handles deeply nested paths', () => {
|
|
expect(extractField({ a: { b: { c: { d: 42 } } } }, 'a.b.c.d')).toBe(42);
|
|
});
|
|
|
|
it('handles mixed dot and bracket notation', () => {
|
|
expect(extractField({ data: { items: [{ name: 'x' }] } }, 'data.items[0].name')).toBe('x');
|
|
});
|
|
});
|
|
|
|
// ─── QueryRegistry ─────────────────────────────────────────────────────────
|
|
|
|
describe('QueryRegistry', () => {
|
|
it('register makes has() return true', () => {
|
|
const registry = new QueryRegistry();
|
|
const handler = async () => ({ data: 'test' });
|
|
registry.register('test-cmd', handler);
|
|
|
|
expect(registry.has('test-cmd')).toBe(true);
|
|
});
|
|
|
|
it('has() returns false for unregistered command', () => {
|
|
const registry = new QueryRegistry();
|
|
|
|
expect(registry.has('nonexistent')).toBe(false);
|
|
});
|
|
|
|
it('dispatch calls registered handler', async () => {
|
|
const registry = new QueryRegistry();
|
|
const handler = vi.fn(async (args: string[], _projectDir: string): Promise<QueryResult> => {
|
|
return { data: { value: args[0] } };
|
|
});
|
|
registry.register('test-cmd', handler);
|
|
|
|
const result = await registry.dispatch('test-cmd', ['arg1'], '/tmp');
|
|
|
|
expect(handler).toHaveBeenCalledWith(['arg1'], '/tmp');
|
|
expect(result).toEqual({ data: { value: 'arg1' } });
|
|
});
|
|
|
|
it('dispatch throws GSDError for unregistered command', async () => {
|
|
const registry = new QueryRegistry();
|
|
// Bridge removed in v3.0 — unknown commands throw, not fallback
|
|
await expect(registry.dispatch('unknown-cmd', ['arg1'], '/tmp/project'))
|
|
.rejects.toThrow('Unknown command: "unknown-cmd"');
|
|
});
|
|
|
|
it('commands() returns all registered command names', () => {
|
|
const registry = new QueryRegistry();
|
|
registry.register('alpha', async () => ({ data: 1 }));
|
|
registry.register('beta', async () => ({ data: 2 }));
|
|
expect(registry.commands().sort()).toEqual(['alpha', 'beta']);
|
|
});
|
|
});
|
|
|
|
// ─── QUERY_MUTATION_COMMANDS vs registry ───────────────────────────────────
|
|
|
|
describe('QUERY_MUTATION_COMMANDS', () => {
|
|
it('has a registered handler for every mutation command name', () => {
|
|
const registry = createRegistry();
|
|
const missing: string[] = [];
|
|
for (const cmd of QUERY_MUTATION_COMMANDS) {
|
|
if (!registry.has(cmd)) missing.push(cmd);
|
|
}
|
|
expect(missing).toEqual([]);
|
|
});
|
|
});
|
|
|
|
// ─── createRegistry ────────────────────────────────────────────────────────
|
|
|
|
describe('createRegistry', () => {
|
|
it('returns a QueryRegistry instance', () => {
|
|
const registry = createRegistry();
|
|
|
|
expect(registry).toBeInstanceOf(QueryRegistry);
|
|
});
|
|
|
|
it('has generate-slug registered', () => {
|
|
const registry = createRegistry();
|
|
|
|
expect(registry.has('generate-slug')).toBe(true);
|
|
});
|
|
|
|
it('has current-timestamp registered', () => {
|
|
const registry = createRegistry();
|
|
|
|
expect(registry.has('current-timestamp')).toBe(true);
|
|
});
|
|
|
|
it('has summary-extract dash alias (PR #2179 / workflows)', () => {
|
|
const registry = createRegistry();
|
|
expect(registry.has('summary-extract')).toBe(true);
|
|
});
|
|
|
|
it('can dispatch generate-slug', async () => {
|
|
const registry = createRegistry();
|
|
const result = await registry.dispatch('generate-slug', ['My Phase'], '/tmp');
|
|
|
|
expect(result).toEqual({ data: { slug: 'my-phase' } });
|
|
});
|
|
});
|
|
|
|
// ─── resolveQueryArgv ───────────────────────────────────────────────────────
|
|
|
|
describe('resolveQueryArgv', () => {
|
|
it('matches longest dotted prefix (state.update + args)', () => {
|
|
const registry = createRegistry();
|
|
const m = resolveQueryArgv(['state', 'update', 'status', 'X'], registry);
|
|
expect(m).toEqual({ cmd: 'state.update', args: ['status', 'X'] });
|
|
});
|
|
|
|
it('matches longest prefix (phase.add wins over phase when both registered)', () => {
|
|
const registry = createRegistry();
|
|
const m = resolveQueryArgv(['phase', 'add', 'desc'], registry);
|
|
expect(m).toEqual({ cmd: 'phase.add', args: ['desc'] });
|
|
});
|
|
|
|
it('prefers longer match over shorter', () => {
|
|
const registry = createRegistry();
|
|
const m = resolveQueryArgv(['state', 'load'], registry);
|
|
expect(m?.cmd).toBe('state.load');
|
|
expect(m?.args).toEqual([]);
|
|
});
|
|
|
|
it('returns null when no prefix matches', () => {
|
|
const registry = createRegistry();
|
|
const m = resolveQueryArgv(['totally-unknown', 'x'], registry);
|
|
expect(m).toBeNull();
|
|
});
|
|
|
|
it('matches a single dotted command token', () => {
|
|
const registry = createRegistry();
|
|
expect(resolveQueryArgv(['init.new-project'], registry)).toEqual({
|
|
cmd: 'init.new-project',
|
|
args: [],
|
|
});
|
|
});
|
|
});
|