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
175 lines
6.6 KiB
TypeScript
175 lines
6.6 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 { detectCompleted } from '../../../src/core/artifact-graph/state.js';
|
|
import { ArtifactGraph } from '../../../src/core/artifact-graph/graph.js';
|
|
import type { SchemaYaml } from '../../../src/core/artifact-graph/types.js';
|
|
|
|
describe('artifact-graph/state', () => {
|
|
let tempDir: string;
|
|
|
|
const createSchema = (artifacts: SchemaYaml['artifacts']): SchemaYaml => ({
|
|
name: 'test',
|
|
version: 1,
|
|
artifacts,
|
|
});
|
|
|
|
beforeEach(() => {
|
|
tempDir = path.join(os.tmpdir(), `openspec-state-test-${Date.now()}`);
|
|
fs.mkdirSync(tempDir, { recursive: true });
|
|
});
|
|
|
|
afterEach(() => {
|
|
fs.rmSync(tempDir, { recursive: true, force: true });
|
|
});
|
|
|
|
describe('detectCompleted', () => {
|
|
it('should return empty set when changeDir does not exist', () => {
|
|
const schema = createSchema([
|
|
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
|
|
]);
|
|
const graph = ArtifactGraph.fromSchema(schema);
|
|
|
|
const completed = detectCompleted(graph, '/nonexistent/path');
|
|
|
|
expect(completed.size).toBe(0);
|
|
});
|
|
|
|
it('should return empty set when changeDir is empty', () => {
|
|
const schema = createSchema([
|
|
{ id: 'A', generates: 'a.md', description: 'A', template: 't.md', requires: [] },
|
|
]);
|
|
const graph = ArtifactGraph.fromSchema(schema);
|
|
|
|
const completed = detectCompleted(graph, tempDir);
|
|
|
|
expect(completed.size).toBe(0);
|
|
});
|
|
|
|
it('should mark artifact complete when file exists', () => {
|
|
const schema = createSchema([
|
|
{ id: 'proposal', generates: 'proposal.md', description: 'Proposal', template: 't.md', requires: [] },
|
|
]);
|
|
const graph = ArtifactGraph.fromSchema(schema);
|
|
|
|
// Create the file
|
|
fs.writeFileSync(path.join(tempDir, 'proposal.md'), 'content');
|
|
|
|
const completed = detectCompleted(graph, tempDir);
|
|
|
|
expect(completed.has('proposal')).toBe(true);
|
|
});
|
|
|
|
it('should not mark artifact complete when file does not exist', () => {
|
|
const schema = createSchema([
|
|
{ id: 'proposal', generates: 'proposal.md', description: 'Proposal', template: 't.md', requires: [] },
|
|
{ id: 'design', generates: 'design.md', description: 'Design', template: 't.md', requires: [] },
|
|
]);
|
|
const graph = ArtifactGraph.fromSchema(schema);
|
|
|
|
// Only create proposal.md
|
|
fs.writeFileSync(path.join(tempDir, 'proposal.md'), 'content');
|
|
|
|
const completed = detectCompleted(graph, tempDir);
|
|
|
|
expect(completed.has('proposal')).toBe(true);
|
|
expect(completed.has('design')).toBe(false);
|
|
});
|
|
|
|
it('should handle nested paths', () => {
|
|
const schema = createSchema([
|
|
{ id: 'nested', generates: 'docs/design.md', description: 'Nested', template: 't.md', requires: [] },
|
|
]);
|
|
const graph = ArtifactGraph.fromSchema(schema);
|
|
|
|
// Create nested directory and file
|
|
fs.mkdirSync(path.join(tempDir, 'docs'), { recursive: true });
|
|
fs.writeFileSync(path.join(tempDir, 'docs', 'design.md'), 'content');
|
|
|
|
const completed = detectCompleted(graph, tempDir);
|
|
|
|
expect(completed.has('nested')).toBe(true);
|
|
});
|
|
|
|
it('should detect glob pattern as complete when files exist', () => {
|
|
const schema = createSchema([
|
|
{ id: 'specs', generates: 'specs/*.md', description: 'Specs', template: 't.md', requires: [] },
|
|
]);
|
|
const graph = ArtifactGraph.fromSchema(schema);
|
|
|
|
// Create specs directory with files
|
|
fs.mkdirSync(path.join(tempDir, 'specs'), { recursive: true });
|
|
fs.writeFileSync(path.join(tempDir, 'specs', 'feature-a.md'), 'content');
|
|
fs.writeFileSync(path.join(tempDir, 'specs', 'feature-b.md'), 'content');
|
|
|
|
const completed = detectCompleted(graph, tempDir);
|
|
|
|
expect(completed.has('specs')).toBe(true);
|
|
});
|
|
|
|
it('should not mark glob pattern complete when directory is empty', () => {
|
|
const schema = createSchema([
|
|
{ id: 'specs', generates: 'specs/*.md', description: 'Specs', template: 't.md', requires: [] },
|
|
]);
|
|
const graph = ArtifactGraph.fromSchema(schema);
|
|
|
|
// Create empty specs directory
|
|
fs.mkdirSync(path.join(tempDir, 'specs'), { recursive: true });
|
|
|
|
const completed = detectCompleted(graph, tempDir);
|
|
|
|
expect(completed.has('specs')).toBe(false);
|
|
});
|
|
|
|
it('should not mark glob pattern complete when directory does not exist', () => {
|
|
const schema = createSchema([
|
|
{ id: 'specs', generates: 'specs/*.md', description: 'Specs', template: 't.md', requires: [] },
|
|
]);
|
|
const graph = ArtifactGraph.fromSchema(schema);
|
|
|
|
const completed = detectCompleted(graph, tempDir);
|
|
|
|
expect(completed.has('specs')).toBe(false);
|
|
});
|
|
|
|
it('should not mark glob pattern complete when only non-matching files exist', () => {
|
|
const schema = createSchema([
|
|
{ id: 'specs', generates: 'specs/*.md', description: 'Specs', template: 't.md', requires: [] },
|
|
]);
|
|
const graph = ArtifactGraph.fromSchema(schema);
|
|
|
|
// Create specs directory with non-matching files
|
|
fs.mkdirSync(path.join(tempDir, 'specs'), { recursive: true });
|
|
fs.writeFileSync(path.join(tempDir, 'specs', 'readme.txt'), 'content');
|
|
|
|
const completed = detectCompleted(graph, tempDir);
|
|
|
|
expect(completed.has('specs')).toBe(false);
|
|
});
|
|
|
|
it('should handle multiple artifacts with mixed completion', () => {
|
|
const schema = createSchema([
|
|
{ id: 'proposal', generates: 'proposal.md', description: 'Proposal', template: 't.md', requires: [] },
|
|
{ id: 'specs', generates: 'specs/*.md', description: 'Specs', template: 't.md', requires: ['proposal'] },
|
|
{ id: 'design', generates: 'design.md', description: 'Design', template: 't.md', requires: ['proposal'] },
|
|
{ id: 'tasks', generates: 'tasks.md', description: 'Tasks', template: 't.md', requires: ['specs', 'design'] },
|
|
]);
|
|
const graph = ArtifactGraph.fromSchema(schema);
|
|
|
|
// Create some files
|
|
fs.writeFileSync(path.join(tempDir, 'proposal.md'), 'content');
|
|
fs.mkdirSync(path.join(tempDir, 'specs'), { recursive: true });
|
|
fs.writeFileSync(path.join(tempDir, 'specs', 'auth.md'), 'content');
|
|
// design.md and tasks.md do not exist
|
|
|
|
const completed = detectCompleted(graph, tempDir);
|
|
|
|
expect(completed.has('proposal')).toBe(true);
|
|
expect(completed.has('specs')).toBe(true);
|
|
expect(completed.has('design')).toBe(false);
|
|
expect(completed.has('tasks')).toBe(false);
|
|
});
|
|
});
|
|
});
|