fix(2137): skip worktree isolation when .gitmodules detected (#2144)
* feat(sdk): add typed query foundation and gsd-sdk query (Phase 1) Add sdk/src/query registry and handlers with tests, GSDQueryError, CLI query wiring, and supporting type/tool-scoping hooks. Update CHANGELOG. Vitest 4 constructor mock fixes in milestone-runner tests. Made-with: Cursor * fix(2137): skip worktree isolation when .gitmodules detected When a project contains git submodules, worktree isolation cannot correctly handle submodule commits — three separate gaps exist in worktree setup, executor commit protocol, and merge-back. Rather than patch each gap individually, detect .gitmodules at phase start and fall back to sequential execution, which handles submodules transparently (Option B). Affected workflows: execute-phase.md, quick.md --------- Co-authored-by: David Sienkowski <dave@sienkowski.com>
This commit is contained in:
Tom Boucher
308
sdk/src/query/init.test.ts
Normal file
308
sdk/src/query/init.test.ts
Normal file
@@ -0,0 +1,308 @@
|
||||
/**
|
||||
* Unit tests for init composition handlers.
|
||||
*
|
||||
* Tests all 13 init handlers plus the withProjectRoot helper.
|
||||
* Uses mkdtemp temp directories to simulate .planning/ layout.
|
||||
*/
|
||||
|
||||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||
import { mkdtemp, writeFile, mkdir, rm, readdir } from 'node:fs/promises';
|
||||
import { join } from 'node:path';
|
||||
import { tmpdir } from 'node:os';
|
||||
import {
|
||||
withProjectRoot,
|
||||
initExecutePhase,
|
||||
initPlanPhase,
|
||||
initNewMilestone,
|
||||
initQuick,
|
||||
initResume,
|
||||
initVerifyWork,
|
||||
initPhaseOp,
|
||||
initTodos,
|
||||
initMilestoneOp,
|
||||
initMapCodebase,
|
||||
initNewWorkspace,
|
||||
initListWorkspaces,
|
||||
initRemoveWorkspace,
|
||||
} from './init.js';
|
||||
|
||||
let tmpDir: string;
|
||||
|
||||
beforeEach(async () => {
|
||||
tmpDir = await mkdtemp(join(tmpdir(), 'gsd-init-'));
|
||||
// Create minimal .planning structure
|
||||
await mkdir(join(tmpDir, '.planning', 'phases', '09-foundation'), { recursive: true });
|
||||
await mkdir(join(tmpDir, '.planning', 'phases', '10-read-only-queries'), { recursive: true });
|
||||
// Create config.json
|
||||
await writeFile(join(tmpDir, '.planning', 'config.json'), JSON.stringify({
|
||||
model_profile: 'balanced',
|
||||
commit_docs: false,
|
||||
git: {
|
||||
branching_strategy: 'none',
|
||||
phase_branch_template: 'gsd/phase-{phase}-{slug}',
|
||||
milestone_branch_template: 'gsd/{milestone}-{slug}',
|
||||
quick_branch_template: null,
|
||||
},
|
||||
workflow: { research: true, plan_check: true, verifier: true, nyquist_validation: true },
|
||||
}));
|
||||
// Create STATE.md
|
||||
await writeFile(join(tmpDir, '.planning', 'STATE.md'), [
|
||||
'---',
|
||||
'milestone: v3.0',
|
||||
'status: executing',
|
||||
'---',
|
||||
'',
|
||||
'# Project State',
|
||||
'',
|
||||
'## Current Position',
|
||||
'',
|
||||
'Phase: 9 (foundation)',
|
||||
'Plan: 1 of 3',
|
||||
'Status: Executing',
|
||||
'',
|
||||
].join('\n'));
|
||||
// Create ROADMAP.md with phase sections
|
||||
await writeFile(join(tmpDir, '.planning', 'ROADMAP.md'), [
|
||||
'# Roadmap',
|
||||
'',
|
||||
'## v3.0: SDK-First Migration',
|
||||
'',
|
||||
'### Phase 9: Foundation',
|
||||
'',
|
||||
'**Goal:** Build foundation',
|
||||
'',
|
||||
'### Phase 10: Read-Only Queries',
|
||||
'',
|
||||
'**Goal:** Implement queries',
|
||||
'',
|
||||
].join('\n'));
|
||||
// Create plan and summary files in phase 09
|
||||
await writeFile(join(tmpDir, '.planning', 'phases', '09-foundation', '09-01-PLAN.md'), [
|
||||
'---',
|
||||
'phase: 09-foundation',
|
||||
'plan: 01',
|
||||
'wave: 1',
|
||||
'---',
|
||||
'<objective>Test plan</objective>',
|
||||
].join('\n'));
|
||||
await writeFile(join(tmpDir, '.planning', 'phases', '09-foundation', '09-01-SUMMARY.md'), '# Summary');
|
||||
await writeFile(join(tmpDir, '.planning', 'phases', '09-foundation', '09-CONTEXT.md'), '# Context');
|
||||
await writeFile(join(tmpDir, '.planning', 'phases', '09-foundation', '09-RESEARCH.md'), '# Research');
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
await rm(tmpDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
describe('withProjectRoot', () => {
|
||||
it('injects project_root, agents_installed, missing_agents into result', () => {
|
||||
const result: Record<string, unknown> = { foo: 'bar' };
|
||||
const enriched = withProjectRoot(tmpDir, result);
|
||||
expect(enriched.project_root).toBe(tmpDir);
|
||||
expect(typeof enriched.agents_installed).toBe('boolean');
|
||||
expect(Array.isArray(enriched.missing_agents)).toBe(true);
|
||||
// Original field preserved
|
||||
expect(enriched.foo).toBe('bar');
|
||||
});
|
||||
|
||||
it('injects response_language when config has it', () => {
|
||||
const result: Record<string, unknown> = {};
|
||||
const enriched = withProjectRoot(tmpDir, result, { response_language: 'ja' });
|
||||
expect(enriched.response_language).toBe('ja');
|
||||
});
|
||||
|
||||
it('does not inject response_language when not in config', () => {
|
||||
const result: Record<string, unknown> = {};
|
||||
const enriched = withProjectRoot(tmpDir, result, {});
|
||||
expect(enriched.response_language).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('initExecutePhase', () => {
|
||||
it('returns flat JSON with expected keys for existing phase', async () => {
|
||||
const result = await initExecutePhase(['9'], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
expect(data.phase_found).toBe(true);
|
||||
expect(data.phase_number).toBe('09');
|
||||
expect(data.executor_model).toBeDefined();
|
||||
expect(data.commit_docs).toBeDefined();
|
||||
expect(data.project_root).toBe(tmpDir);
|
||||
expect(data.plans).toBeDefined();
|
||||
expect(data.summaries).toBeDefined();
|
||||
expect(data.milestone_version).toBeDefined();
|
||||
});
|
||||
|
||||
it('returns error when phase arg missing', async () => {
|
||||
const result = await initExecutePhase([], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
expect(data.error).toBeDefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('initPlanPhase', () => {
|
||||
it('returns flat JSON with expected keys', async () => {
|
||||
const result = await initPlanPhase(['9'], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
expect(data.phase_found).toBe(true);
|
||||
expect(data.researcher_model).toBeDefined();
|
||||
expect(data.planner_model).toBeDefined();
|
||||
expect(data.checker_model).toBeDefined();
|
||||
expect(data.research_enabled).toBeDefined();
|
||||
expect(data.has_research).toBe(true);
|
||||
expect(data.has_context).toBe(true);
|
||||
expect(data.project_root).toBe(tmpDir);
|
||||
});
|
||||
|
||||
it('returns error when phase arg missing', async () => {
|
||||
const result = await initPlanPhase([], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
expect(data.error).toBeDefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('initNewMilestone', () => {
|
||||
it('returns flat JSON with milestone info', async () => {
|
||||
const result = await initNewMilestone([], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
expect(data.current_milestone).toBeDefined();
|
||||
expect(data.current_milestone_name).toBeDefined();
|
||||
expect(data.phase_dir_count).toBeGreaterThanOrEqual(0);
|
||||
expect(data.project_root).toBe(tmpDir);
|
||||
});
|
||||
});
|
||||
|
||||
describe('initQuick', () => {
|
||||
it('returns flat JSON with task info', async () => {
|
||||
const result = await initQuick(['my-task'], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
expect(data.quick_id).toBeDefined();
|
||||
expect(data.slug).toBe('my-task');
|
||||
expect(data.description).toBe('my-task');
|
||||
expect(data.planner_model).toBeDefined();
|
||||
expect(data.executor_model).toBeDefined();
|
||||
expect(data.quick_dir).toBe('.planning/quick');
|
||||
expect(data.project_root).toBe(tmpDir);
|
||||
});
|
||||
});
|
||||
|
||||
describe('initResume', () => {
|
||||
it('returns flat JSON with state info', async () => {
|
||||
const result = await initResume([], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
expect(data.state_exists).toBe(true);
|
||||
expect(data.roadmap_exists).toBe(true);
|
||||
expect(data.project_root).toBe(tmpDir);
|
||||
expect(data.commit_docs).toBeDefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('initVerifyWork', () => {
|
||||
it('returns flat JSON with expected keys', async () => {
|
||||
const result = await initVerifyWork(['9'], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
expect(data.phase_found).toBe(true);
|
||||
expect(data.phase_number).toBe('09');
|
||||
expect(data.planner_model).toBeDefined();
|
||||
expect(data.checker_model).toBeDefined();
|
||||
expect(data.project_root).toBe(tmpDir);
|
||||
});
|
||||
|
||||
it('returns error when phase arg missing', async () => {
|
||||
const result = await initVerifyWork([], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
expect(data.error).toBeDefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('initPhaseOp', () => {
|
||||
it('returns flat JSON with phase artifacts', async () => {
|
||||
const result = await initPhaseOp(['9'], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
expect(data.phase_found).toBe(true);
|
||||
expect(data.phase_number).toBe('09');
|
||||
expect(data.has_research).toBe(true);
|
||||
expect(data.has_context).toBe(true);
|
||||
expect(data.plan_count).toBeGreaterThanOrEqual(1);
|
||||
expect(data.project_root).toBe(tmpDir);
|
||||
});
|
||||
});
|
||||
|
||||
describe('initTodos', () => {
|
||||
it('returns flat JSON with todo inventory', async () => {
|
||||
const result = await initTodos([], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
expect(data.todo_count).toBe(0);
|
||||
expect(Array.isArray(data.todos)).toBe(true);
|
||||
expect(data.area_filter).toBeNull();
|
||||
expect(data.project_root).toBe(tmpDir);
|
||||
});
|
||||
|
||||
it('filters by area when provided', async () => {
|
||||
const result = await initTodos(['code'], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
expect(data.area_filter).toBe('code');
|
||||
});
|
||||
});
|
||||
|
||||
describe('initMilestoneOp', () => {
|
||||
it('returns flat JSON with milestone info', async () => {
|
||||
const result = await initMilestoneOp([], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
expect(data.milestone_version).toBeDefined();
|
||||
expect(data.milestone_name).toBeDefined();
|
||||
expect(data.phase_count).toBeGreaterThanOrEqual(0);
|
||||
expect(data.completed_phases).toBeGreaterThanOrEqual(0);
|
||||
expect(data.project_root).toBe(tmpDir);
|
||||
});
|
||||
});
|
||||
|
||||
describe('initMapCodebase', () => {
|
||||
it('returns flat JSON with mapper info', async () => {
|
||||
const result = await initMapCodebase([], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
expect(data.mapper_model).toBeDefined();
|
||||
expect(Array.isArray(data.existing_maps)).toBe(true);
|
||||
expect(data.codebase_dir).toBe('.planning/codebase');
|
||||
expect(data.project_root).toBe(tmpDir);
|
||||
});
|
||||
});
|
||||
|
||||
describe('initNewWorkspace', () => {
|
||||
it('returns flat JSON with workspace info', async () => {
|
||||
const result = await initNewWorkspace([], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
expect(data.default_workspace_base).toBeDefined();
|
||||
expect(typeof data.worktree_available).toBe('boolean');
|
||||
expect(data.project_root).toBe(tmpDir);
|
||||
});
|
||||
|
||||
it('detects git availability', async () => {
|
||||
const result = await initNewWorkspace([], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
// worktree_available depends on whether git is installed
|
||||
expect(typeof data.worktree_available).toBe('boolean');
|
||||
});
|
||||
});
|
||||
|
||||
describe('initListWorkspaces', () => {
|
||||
it('returns flat JSON with workspaces array', async () => {
|
||||
const result = await initListWorkspaces([], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
expect(Array.isArray(data.workspaces)).toBe(true);
|
||||
expect(data.workspace_count).toBeGreaterThanOrEqual(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe('initRemoveWorkspace', () => {
|
||||
it('returns error when name arg missing', async () => {
|
||||
const result = await initRemoveWorkspace([], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
expect(data.error).toBeDefined();
|
||||
});
|
||||
|
||||
it('rejects path separator in workspace name (T-14-01)', async () => {
|
||||
const result = await initRemoveWorkspace(['../../bad'], tmpDir);
|
||||
const data = result.data as Record<string, unknown>;
|
||||
expect(data.error).toBeDefined();
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user