mirror of
https://github.com/Fission-AI/OpenSpec.git
synced 2026-09-14 20:16:53 +08:00
af273b8e0b
* 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
208 lines
5.2 KiB
TypeScript
208 lines
5.2 KiB
TypeScript
import { describe, it, expect } from 'vitest';
|
|
import { parseSchema, SchemaValidationError } from '../../../src/core/artifact-graph/schema.js';
|
|
|
|
describe('artifact-graph/schema', () => {
|
|
describe('parseSchema', () => {
|
|
it('should parse valid schema YAML', () => {
|
|
const yaml = `
|
|
name: test-schema
|
|
version: 1
|
|
description: A test schema
|
|
artifacts:
|
|
- id: proposal
|
|
generates: proposal.md
|
|
description: Initial proposal
|
|
template: templates/proposal.md
|
|
requires: []
|
|
- id: design
|
|
generates: design.md
|
|
description: Design document
|
|
template: templates/design.md
|
|
requires:
|
|
- proposal
|
|
`;
|
|
const schema = parseSchema(yaml);
|
|
|
|
expect(schema.name).toBe('test-schema');
|
|
expect(schema.version).toBe(1);
|
|
expect(schema.description).toBe('A test schema');
|
|
expect(schema.artifacts).toHaveLength(2);
|
|
expect(schema.artifacts[0].id).toBe('proposal');
|
|
expect(schema.artifacts[1].requires).toEqual(['proposal']);
|
|
});
|
|
|
|
it('should throw on missing required fields', () => {
|
|
const yaml = `
|
|
name: test-schema
|
|
version: 1
|
|
artifacts:
|
|
- id: proposal
|
|
description: Missing generates and template
|
|
`;
|
|
expect(() => parseSchema(yaml)).toThrow(SchemaValidationError);
|
|
expect(() => parseSchema(yaml)).toThrow(/generates/);
|
|
});
|
|
|
|
it('should throw on missing schema name', () => {
|
|
const yaml = `
|
|
version: 1
|
|
artifacts:
|
|
- id: proposal
|
|
generates: proposal.md
|
|
description: Test
|
|
template: templates/proposal.md
|
|
`;
|
|
expect(() => parseSchema(yaml)).toThrow(SchemaValidationError);
|
|
expect(() => parseSchema(yaml)).toThrow(/name/);
|
|
});
|
|
|
|
it('should throw on invalid version (non-positive)', () => {
|
|
const yaml = `
|
|
name: test
|
|
version: 0
|
|
artifacts:
|
|
- id: proposal
|
|
generates: proposal.md
|
|
description: Test
|
|
template: templates/proposal.md
|
|
`;
|
|
expect(() => parseSchema(yaml)).toThrow(SchemaValidationError);
|
|
expect(() => parseSchema(yaml)).toThrow(/positive/);
|
|
});
|
|
|
|
it('should throw on empty artifacts array', () => {
|
|
const yaml = `
|
|
name: test
|
|
version: 1
|
|
artifacts: []
|
|
`;
|
|
expect(() => parseSchema(yaml)).toThrow(SchemaValidationError);
|
|
expect(() => parseSchema(yaml)).toThrow(/artifact/i);
|
|
});
|
|
|
|
it('should throw on duplicate artifact IDs', () => {
|
|
const yaml = `
|
|
name: test
|
|
version: 1
|
|
artifacts:
|
|
- id: proposal
|
|
generates: proposal.md
|
|
description: First
|
|
template: templates/proposal.md
|
|
- id: proposal
|
|
generates: other.md
|
|
description: Duplicate
|
|
template: templates/other.md
|
|
`;
|
|
expect(() => parseSchema(yaml)).toThrow(SchemaValidationError);
|
|
expect(() => parseSchema(yaml)).toThrow(/Duplicate artifact ID: proposal/);
|
|
});
|
|
|
|
it('should throw on invalid requires reference', () => {
|
|
const yaml = `
|
|
name: test
|
|
version: 1
|
|
artifacts:
|
|
- id: design
|
|
generates: design.md
|
|
description: Design doc
|
|
template: templates/design.md
|
|
requires:
|
|
- nonexistent
|
|
`;
|
|
expect(() => parseSchema(yaml)).toThrow(SchemaValidationError);
|
|
expect(() => parseSchema(yaml)).toThrow(/Invalid dependency reference.*nonexistent/);
|
|
});
|
|
|
|
it('should detect self-referencing cycle', () => {
|
|
const yaml = `
|
|
name: test
|
|
version: 1
|
|
artifacts:
|
|
- id: A
|
|
generates: a.md
|
|
description: Self reference
|
|
template: templates/a.md
|
|
requires:
|
|
- A
|
|
`;
|
|
expect(() => parseSchema(yaml)).toThrow(SchemaValidationError);
|
|
expect(() => parseSchema(yaml)).toThrow(/Cyclic dependency detected/);
|
|
});
|
|
|
|
it('should detect simple A → B → A cycle', () => {
|
|
const yaml = `
|
|
name: test
|
|
version: 1
|
|
artifacts:
|
|
- id: A
|
|
generates: a.md
|
|
description: A
|
|
template: templates/a.md
|
|
requires:
|
|
- B
|
|
- id: B
|
|
generates: b.md
|
|
description: B
|
|
template: templates/b.md
|
|
requires:
|
|
- A
|
|
`;
|
|
expect(() => parseSchema(yaml)).toThrow(SchemaValidationError);
|
|
expect(() => parseSchema(yaml)).toThrow(/Cyclic dependency detected/);
|
|
expect(() => parseSchema(yaml)).toThrow(/→/);
|
|
});
|
|
|
|
it('should detect longer A → B → C → A cycle and list all IDs', () => {
|
|
const yaml = `
|
|
name: test
|
|
version: 1
|
|
artifacts:
|
|
- id: A
|
|
generates: a.md
|
|
description: A
|
|
template: templates/a.md
|
|
requires:
|
|
- C
|
|
- id: B
|
|
generates: b.md
|
|
description: B
|
|
template: templates/b.md
|
|
requires:
|
|
- A
|
|
- id: C
|
|
generates: c.md
|
|
description: C
|
|
template: templates/c.md
|
|
requires:
|
|
- B
|
|
`;
|
|
expect(() => parseSchema(yaml)).toThrow(SchemaValidationError);
|
|
expect(() => parseSchema(yaml)).toThrow(/Cyclic dependency detected/);
|
|
// Should contain all three in the cycle path
|
|
const error = (() => {
|
|
try {
|
|
parseSchema(yaml);
|
|
} catch (e) {
|
|
return e;
|
|
}
|
|
})() as Error;
|
|
expect(error.message).toMatch(/A.*→.*B|B.*→.*C|C.*→.*A/);
|
|
});
|
|
|
|
it('should allow default empty requires array', () => {
|
|
const yaml = `
|
|
name: test
|
|
version: 1
|
|
artifacts:
|
|
- id: root
|
|
generates: root.md
|
|
description: Root artifact
|
|
template: templates/root.md
|
|
`;
|
|
const schema = parseSchema(yaml);
|
|
expect(schema.artifacts[0].requires).toEqual([]);
|
|
});
|
|
});
|
|
});
|