Files
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

269 lines
10 KiB
TypeScript

import { describe, it, expect } from 'vitest';
import { ArtifactGraph } from '../../../src/core/artifact-graph/graph.js';
import type { SchemaYaml } from '../../../src/core/artifact-graph/types.js';
describe('artifact-graph/graph', () => {
const createSchema = (artifacts: SchemaYaml['artifacts']): SchemaYaml => ({
name: 'test',
version: 1,
artifacts,
});
describe('fromSchema', () => {
it('should create graph from schema object', () => {
const schema = createSchema([
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
]);
const graph = ArtifactGraph.fromSchema(schema);
expect(graph.getName()).toBe('test');
expect(graph.getVersion()).toBe(1);
});
});
describe('fromYamlContent', () => {
it('should create graph from YAML string', () => {
const yaml = `
name: my-workflow
version: 2
artifacts:
- id: doc
generates: doc.md
description: Documentation
template: templates/doc.md
`;
const graph = ArtifactGraph.fromYamlContent(yaml);
expect(graph.getName()).toBe('my-workflow');
expect(graph.getVersion()).toBe(2);
expect(graph.getArtifact('doc')).toBeDefined();
});
});
describe('getArtifact', () => {
it('should return artifact by ID', () => {
const schema = createSchema([
{ id: 'proposal', generates: 'proposal.md', description: 'Proposal', template: 't.md', requires: [] },
]);
const graph = ArtifactGraph.fromSchema(schema);
const artifact = graph.getArtifact('proposal');
expect(artifact).toBeDefined();
expect(artifact?.id).toBe('proposal');
expect(artifact?.generates).toBe('proposal.md');
});
it('should return undefined for non-existent ID', () => {
const schema = createSchema([
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
]);
const graph = ArtifactGraph.fromSchema(schema);
expect(graph.getArtifact('nonexistent')).toBeUndefined();
});
});
describe('getAllArtifacts', () => {
it('should return all artifacts', () => {
const schema = createSchema([
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
{ id: 'B', generates: 'b.md', description: 'B', template: 't.md', requires: ['A'] },
{ id: 'C', generates: 'c.md', description: 'C', template: 't.md', requires: [] },
]);
const graph = ArtifactGraph.fromSchema(schema);
const artifacts = graph.getAllArtifacts();
expect(artifacts).toHaveLength(3);
expect(artifacts.map(a => a.id).sort()).toEqual(['A', 'B', 'C']);
});
});
describe('getBuildOrder', () => {
it('should return correct order for linear chain A → B → C', () => {
const schema = createSchema([
{ id: 'C', generates: 'c.md', description: 'C', template: 't.md', requires: ['B'] },
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
{ id: 'B', generates: 'b.md', description: 'B', template: 't.md', requires: ['A'] },
]);
const graph = ArtifactGraph.fromSchema(schema);
const order = graph.getBuildOrder();
expect(order).toEqual(['A', 'B', 'C']);
});
it('should handle diamond dependency correctly', () => {
// A → B, A → C, B → D, C → D
const schema = createSchema([
{ id: 'D', generates: 'd.md', description: 'D', template: 't.md', requires: ['B', 'C'] },
{ id: 'B', generates: 'b.md', description: 'B', template: 't.md', requires: ['A'] },
{ id: 'C', generates: 'c.md', description: 'C', template: 't.md', requires: ['A'] },
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
]);
const graph = ArtifactGraph.fromSchema(schema);
const order = graph.getBuildOrder();
// A must come before B and C; D must come last
expect(order.indexOf('A')).toBeLessThan(order.indexOf('B'));
expect(order.indexOf('A')).toBeLessThan(order.indexOf('C'));
expect(order.indexOf('B')).toBeLessThan(order.indexOf('D'));
expect(order.indexOf('C')).toBeLessThan(order.indexOf('D'));
});
it('should return independent artifacts in stable sorted order', () => {
const schema = createSchema([
{ id: 'Z', generates: 'z.md', description: 'Z', template: 't.md', requires: [] },
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
{ id: 'M', generates: 'm.md', description: 'M', template: 't.md', requires: [] },
]);
const graph = ArtifactGraph.fromSchema(schema);
const order = graph.getBuildOrder();
// All independent, should be sorted alphabetically for stability
expect(order).toEqual(['A', 'M', 'Z']);
});
});
describe('getNextArtifacts', () => {
it('should return root artifacts when nothing completed', () => {
const schema = createSchema([
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
{ id: 'B', generates: 'b.md', description: 'B', template: 't.md', requires: ['A'] },
{ id: 'C', generates: 'c.md', description: 'C', template: 't.md', requires: [] },
]);
const graph = ArtifactGraph.fromSchema(schema);
const ready = graph.getNextArtifacts(new Set());
expect(ready.sort()).toEqual(['A', 'C']);
});
it('should include artifact when all deps completed', () => {
const schema = createSchema([
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
{ id: 'B', generates: 'b.md', description: 'B', template: 't.md', requires: ['A'] },
]);
const graph = ArtifactGraph.fromSchema(schema);
const ready = graph.getNextArtifacts(new Set(['A']));
expect(ready).toEqual(['B']);
});
it('should not include completed artifacts', () => {
const schema = createSchema([
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
{ id: 'B', generates: 'b.md', description: 'B', template: 't.md', requires: ['A'] },
]);
const graph = ArtifactGraph.fromSchema(schema);
const ready = graph.getNextArtifacts(new Set(['A', 'B']));
expect(ready).toEqual([]);
});
it('should handle diamond dependency correctly', () => {
// D requires B and C
const schema = createSchema([
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
{ id: 'B', generates: 'b.md', description: 'B', template: 't.md', requires: ['A'] },
{ id: 'C', generates: 'c.md', description: 'C', template: 't.md', requires: ['A'] },
{ id: 'D', generates: 'd.md', description: 'D', template: 't.md', requires: ['B', 'C'] },
]);
const graph = ArtifactGraph.fromSchema(schema);
// Only A completed - B and C ready, D not
expect(graph.getNextArtifacts(new Set(['A'])).sort()).toEqual(['B', 'C']);
// Only B completed (from deps) - C still needed for D
expect(graph.getNextArtifacts(new Set(['A', 'B']))).toEqual(['C']);
// Both B and C completed - D ready
expect(graph.getNextArtifacts(new Set(['A', 'B', 'C']))).toEqual(['D']);
});
});
describe('isComplete', () => {
it('should return true when all artifacts completed', () => {
const schema = createSchema([
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
{ id: 'B', generates: 'b.md', description: 'B', template: 't.md', requires: ['A'] },
]);
const graph = ArtifactGraph.fromSchema(schema);
expect(graph.isComplete(new Set(['A', 'B']))).toBe(true);
});
it('should return false when some artifacts incomplete', () => {
const schema = createSchema([
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
{ id: 'B', generates: 'b.md', description: 'B', template: 't.md', requires: ['A'] },
]);
const graph = ArtifactGraph.fromSchema(schema);
expect(graph.isComplete(new Set(['A']))).toBe(false);
expect(graph.isComplete(new Set())).toBe(false);
});
});
describe('getBlocked', () => {
it('should return empty object when nothing is blocked', () => {
const schema = createSchema([
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
]);
const graph = ArtifactGraph.fromSchema(schema);
expect(graph.getBlocked(new Set())).toEqual({});
});
it('should return artifact blocked by single dependency', () => {
const schema = createSchema([
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
{ id: 'B', generates: 'b.md', description: 'B', template: 't.md', requires: ['A'] },
]);
const graph = ArtifactGraph.fromSchema(schema);
expect(graph.getBlocked(new Set())).toEqual({ B: ['A'] });
});
it('should return artifact blocked by multiple dependencies', () => {
const schema = createSchema([
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
{ id: 'B', generates: 'b.md', description: 'B', template: 't.md', requires: [] },
{ id: 'C', generates: 'c.md', description: 'C', template: 't.md', requires: ['A', 'B'] },
]);
const graph = ArtifactGraph.fromSchema(schema);
// Neither A nor B completed
expect(graph.getBlocked(new Set())).toEqual({ C: ['A', 'B'] });
});
it('should only list unmet dependencies', () => {
const schema = createSchema([
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
{ id: 'B', generates: 'b.md', description: 'B', template: 't.md', requires: [] },
{ id: 'C', generates: 'c.md', description: 'C', template: 't.md', requires: ['A', 'B'] },
]);
const graph = ArtifactGraph.fromSchema(schema);
// A completed, B not
expect(graph.getBlocked(new Set(['A']))).toEqual({ C: ['B'] });
});
it('should not include completed artifacts', () => {
const schema = createSchema([
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
{ id: 'B', generates: 'b.md', description: 'B', template: 't.md', requires: ['A'] },
]);
const graph = ArtifactGraph.fromSchema(schema);
expect(graph.getBlocked(new Set(['A', 'B']))).toEqual({});
});
});
});