Files
fission-ai__openspec/test/core/artifact-graph/workflow.integration.test.ts
Tabish Bidiwale af273b8e0b proposal: add artifact graph core query system (#400)
* proposal: add artifact graph core query system

Add OpenSpec change proposal for Slice 1 of the artifact POC - the core
"What's Ready?" query system. This implements:

- ArtifactGraph class for DAG-based dependency modeling
- Filesystem-based state detection (file existence = completion)
- Topological sort for build order calculation
- Ready/blocked artifact queries

This is a parallel module that will coexist with the current system.

* docs: specify Zod for schema validation in artifact graph proposal

- Add decision section for Zod schema validation in design.md
- Update data structures to show Zod schemas with z.infer<> types
- Update tasks to specify Zod usage for type definitions and parsing

* docs: add 2-level schema resolution and built-in schemas

- Add decision for global → built-in schema resolution pattern
- Add resolver.ts for schema lookup logic
- Add built-in schemas directory (spec-driven.yaml, tdd.yaml)
- Add schema resolution tests
- Follows ESLint/Prettier/Git patterns (defaults baked in package)

* experiment: add vertical slice version of artifact graph change

Creates add-artifact-graph-core-v2 with requirements organized as
vertical slices - each requirement file contains its spec, design
decisions, and tasks bundled together for comparison.

* feat(core): add getGlobalDataDir for XDG-compliant data directory

Add getGlobalDataDir() function following XDG Base Directory Specification
for storing user data like schema overrides:
- XDG_DATA_HOME takes precedence on all platforms
- Unix/macOS fallback: ~/.local/share/openspec/
- Windows fallback: %LOCALAPPDATA%/openspec/

* feat(artifact-graph): add core dependency graph module

Implement Slice 1 ("What's Ready?") of the artifact graph system:

- types.ts: Zod schemas for artifact definitions with derived TypeScript types
- schema.ts: YAML parsing with validation for duplicates, invalid refs, cycles
- graph.ts: ArtifactGraph class with Kahn's algorithm for topological sort
- state.ts: Filesystem-based completion detection with glob pattern support
- resolver.ts: Two-level schema resolution (global override → built-in)
- builtin-schemas.ts: spec-driven and tdd workflow definitions

Key design decisions:
- Filesystem as database (stateless, git-friendly)
- Cycle errors show full path (e.g., "A → B → C → A")
- Deterministic ordering via sorted queues

* test(artifact-graph): add comprehensive test suite

52 tests covering all artifact-graph functionality:

- schema.test.ts: Parsing, validation errors, cycle detection
- graph.test.ts: Build order, ready artifacts, blocked queries
- state.test.ts: File existence, glob patterns, missing directories
- resolver.test.ts: Schema resolution with global overrides

* docs(openspec): archive add-artifact-graph-core change

Archive completed change proposal and create artifact-graph spec with
6 requirements covering schema loading, build order, state detection,
ready queries, completion checks, and blocked queries.

* chore: remove experimental artifact-graph-core-v2 folder

Clean up experimental vertical slice proposal that is no longer needed.

* feat(artifact-graph): validate global schema overrides

Global schema overrides are now validated through the same pipeline as
built-in schemas, catching invalid schemas, cyclic dependencies, and
invalid requires references at load time. Added SchemaLoadError for
better error context with file paths.

* test(artifact-graph): add workflow integration tests

Add end-to-end integration tests that exercise the full artifact-graph
pipeline: resolveSchema → ArtifactGraph → detectCompleted → queries.

Tests cover:
- Complete spec-driven and tdd workflow progressions
- Out-of-order file creation handling
- Glob pattern matching with multiple files
- Build order consistency
- Edge cases (empty/missing directories, non-matching files)

* refactor(artifact-graph): adopt zod v4 error message format

Update custom error messages from string format to zod v4 object format
using `{ error: 'message' }` convention.

* fix(test): prevent hanging vitest threads after test runs

- Add teardownTimeout (3s) to vitest config for forced cleanup
- Add global teardown function to vitest.setup.ts
- Call child.unref() to prevent child processes from blocking event loop
- Explicitly destroy stdio streams on process close/error
2025-12-25 22:09:42 +11:00

223 lines
9.2 KiB
TypeScript

import { describe, it, expect, beforeEach, afterEach } from 'vitest';
import * as fs from 'node:fs';
import * as path from 'node:path';
import * as os from 'node:os';
import { resolveSchema } from '../../../src/core/artifact-graph/resolver.js';
import { ArtifactGraph } from '../../../src/core/artifact-graph/graph.js';
import { detectCompleted } from '../../../src/core/artifact-graph/state.js';
import type { BlockedArtifacts } from '../../../src/core/artifact-graph/types.js';
/**
* Normalize BlockedArtifacts for comparison by sorting dependency arrays.
* The order of unmet dependencies is not guaranteed, so we sort for stable assertions.
*/
function normalizeBlocked(blocked: BlockedArtifacts): BlockedArtifacts {
const normalized: BlockedArtifacts = {};
for (const [key, deps] of Object.entries(blocked)) {
normalized[key] = [...deps].sort();
}
return normalized;
}
describe('artifact-graph workflow integration', () => {
let tempDir: string;
beforeEach(() => {
// Use a unique temp directory for each test
tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'openspec-workflow-test-'));
});
afterEach(() => {
// Clean up temp directory after each test
if (tempDir && fs.existsSync(tempDir)) {
fs.rmSync(tempDir, { recursive: true, force: true });
}
});
describe('spec-driven workflow', () => {
it('should progress through complete workflow', () => {
// 1. Resolve the real built-in schema
const schema = resolveSchema('spec-driven');
const graph = ArtifactGraph.fromSchema(schema);
// Verify schema structure
expect(graph.getName()).toBe('spec-driven');
expect(graph.getAllArtifacts()).toHaveLength(4);
// 2. Initial state - nothing complete, only proposal is ready
let completed = detectCompleted(graph, tempDir);
expect(completed.size).toBe(0);
expect(graph.getNextArtifacts(completed)).toEqual(['proposal']);
expect(graph.isComplete(completed)).toBe(false);
expect(normalizeBlocked(graph.getBlocked(completed))).toEqual({
specs: ['proposal'],
design: ['proposal'],
tasks: ['design', 'specs'],
});
// 3. Create proposal.md - now specs and design become ready
fs.writeFileSync(path.join(tempDir, 'proposal.md'), '# Proposal\n\nInitial proposal content.');
completed = detectCompleted(graph, tempDir);
expect(completed).toEqual(new Set(['proposal']));
expect(graph.getNextArtifacts(completed).sort()).toEqual(['design', 'specs']);
expect(normalizeBlocked(graph.getBlocked(completed))).toEqual({
tasks: ['design', 'specs'],
});
// 4. Create design.md - specs still needed for tasks
fs.writeFileSync(path.join(tempDir, 'design.md'), '# Design\n\nTechnical design content.');
completed = detectCompleted(graph, tempDir);
expect(completed).toEqual(new Set(['proposal', 'design']));
expect(graph.getNextArtifacts(completed)).toEqual(['specs']);
expect(graph.getBlocked(completed)).toEqual({
tasks: ['specs'],
});
// 5. Create specs directory with a spec file - tasks becomes ready
const specsDir = path.join(tempDir, 'specs');
fs.mkdirSync(specsDir, { recursive: true });
fs.writeFileSync(path.join(specsDir, 'feature-auth.md'), '# Auth Spec\n\nAuthentication specification.');
completed = detectCompleted(graph, tempDir);
expect(completed).toEqual(new Set(['proposal', 'design', 'specs']));
expect(graph.getNextArtifacts(completed)).toEqual(['tasks']);
expect(graph.getBlocked(completed)).toEqual({});
// 6. Create tasks.md - workflow complete
fs.writeFileSync(path.join(tempDir, 'tasks.md'), '# Tasks\n\n- [ ] Implement feature');
completed = detectCompleted(graph, tempDir);
expect(completed).toEqual(new Set(['proposal', 'design', 'specs', 'tasks']));
expect(graph.getNextArtifacts(completed)).toEqual([]);
expect(graph.isComplete(completed)).toBe(true);
expect(graph.getBlocked(completed)).toEqual({});
});
it('should handle out-of-order file creation', () => {
const schema = resolveSchema('spec-driven');
const graph = ArtifactGraph.fromSchema(schema);
// Create files in wrong order - design before proposal
fs.writeFileSync(path.join(tempDir, 'design.md'), '# Design');
let completed = detectCompleted(graph, tempDir);
// design file exists but it's still marked complete (filesystem-based)
expect(completed).toEqual(new Set(['design']));
// proposal is still the only "ready" artifact since it has no deps
expect(graph.getNextArtifacts(completed)).toEqual(['proposal']);
// Now create proposal
fs.writeFileSync(path.join(tempDir, 'proposal.md'), '# Proposal');
completed = detectCompleted(graph, tempDir);
expect(completed).toEqual(new Set(['proposal', 'design']));
// specs is the only thing ready now (design already done)
expect(graph.getNextArtifacts(completed)).toEqual(['specs']);
});
it('should handle multiple spec files in glob pattern', () => {
const schema = resolveSchema('spec-driven');
const graph = ArtifactGraph.fromSchema(schema);
// Complete prerequisites
fs.writeFileSync(path.join(tempDir, 'proposal.md'), '# Proposal');
// Create specs directory with multiple files
const specsDir = path.join(tempDir, 'specs');
fs.mkdirSync(specsDir, { recursive: true });
fs.writeFileSync(path.join(specsDir, 'auth.md'), '# Auth');
fs.writeFileSync(path.join(specsDir, 'api.md'), '# API');
fs.writeFileSync(path.join(specsDir, 'database.md'), '# Database');
const completed = detectCompleted(graph, tempDir);
expect(completed.has('specs')).toBe(true);
});
});
describe('tdd workflow', () => {
it('should progress through complete workflow', () => {
const schema = resolveSchema('tdd');
const graph = ArtifactGraph.fromSchema(schema);
expect(graph.getName()).toBe('tdd');
expect(graph.getBuildOrder()).toEqual(['spec', 'tests', 'implementation', 'docs']);
// Initial state
let completed = detectCompleted(graph, tempDir);
expect(graph.getNextArtifacts(completed)).toEqual(['spec']);
// Create spec
fs.writeFileSync(path.join(tempDir, 'spec.md'), '# Feature Spec');
completed = detectCompleted(graph, tempDir);
expect(graph.getNextArtifacts(completed)).toEqual(['tests']);
// Create tests directory with test file
const testsDir = path.join(tempDir, 'tests');
fs.mkdirSync(testsDir, { recursive: true });
fs.writeFileSync(path.join(testsDir, 'feature.test.ts'), 'describe("feature", () => {});');
completed = detectCompleted(graph, tempDir);
expect(graph.getNextArtifacts(completed)).toEqual(['implementation']);
// Create src directory with implementation
const srcDir = path.join(tempDir, 'src');
fs.mkdirSync(srcDir, { recursive: true });
fs.writeFileSync(path.join(srcDir, 'feature.ts'), 'export function feature() {}');
completed = detectCompleted(graph, tempDir);
expect(graph.getNextArtifacts(completed)).toEqual(['docs']);
// Create docs
const docsDir = path.join(tempDir, 'docs');
fs.mkdirSync(docsDir, { recursive: true });
fs.writeFileSync(path.join(docsDir, 'feature.md'), '# Feature Documentation');
completed = detectCompleted(graph, tempDir);
expect(graph.isComplete(completed)).toBe(true);
});
});
describe('build order consistency', () => {
it('should return consistent build order across multiple calls', () => {
const schema = resolveSchema('spec-driven');
const graph = ArtifactGraph.fromSchema(schema);
const order1 = graph.getBuildOrder();
const order2 = graph.getBuildOrder();
const order3 = graph.getBuildOrder();
expect(order1).toEqual(order2);
expect(order2).toEqual(order3);
});
});
describe('empty and edge cases', () => {
it('should handle empty change directory gracefully', () => {
const schema = resolveSchema('spec-driven');
const graph = ArtifactGraph.fromSchema(schema);
// Directory exists but is empty
const completed = detectCompleted(graph, tempDir);
expect(completed.size).toBe(0);
expect(graph.getNextArtifacts(completed)).toEqual(['proposal']);
});
it('should handle non-existent change directory', () => {
const schema = resolveSchema('spec-driven');
const graph = ArtifactGraph.fromSchema(schema);
const nonExistentDir = path.join(tempDir, 'does-not-exist');
const completed = detectCompleted(graph, nonExistentDir);
expect(completed.size).toBe(0);
});
it('should not count non-matching files in glob directories', () => {
const schema = resolveSchema('spec-driven');
const graph = ArtifactGraph.fromSchema(schema);
// Create specs directory with wrong file types
const specsDir = path.join(tempDir, 'specs');
fs.mkdirSync(specsDir, { recursive: true });
fs.writeFileSync(path.join(specsDir, 'notes.txt'), 'not a markdown file');
fs.writeFileSync(path.join(specsDir, 'data.json'), '{}');
const completed = detectCompleted(graph, tempDir);
expect(completed.has('specs')).toBe(false);
});
});
});