workflow: meta rides the seam as data — the engine never evaluates it
P1 review finding: extractMeta timed only the literal's vm evaluation;
materializing the RESULT then read properties ordinarily on the HOST
stack, so a meta literal smuggling a getter (get name() { while(true){} })
could wedge the host outside any timeout — defeating the exact spin
isolation the worker thread exists for.
Rather than harden the evaluator (descriptor walks, AST validation),
delete the mechanism: the workflow's identity now reaches the seam as a
plain JSON field (WorkflowStartRequest.meta), carried by the tool as a
schema-validated `meta` object parameter the model fills directly. The
engine only shape-validates data (validateMeta, every violation named)
and pre-parses the body; the scanner, the vm evaluation, and the
host-side materialization are gone, and with them the hole. A body
still opening with a Claude Code-style `export const meta` statement
gets a pointed SCRIPT_PARSE message (the likeliest authoring slip; a
CC script's body stays drop-in, only its meta header moves into the
parameter). syncTimeoutMs now governs exactly one thing: the initial
synchronous slice inside the worker.
The RFC's decision section is rewritten in place (implemented-RFC
rule); the embedded-meta format moves to alternatives-considered with
the hole as the reason. Tool description, presentation (title now reads
meta.name directly — the textual sniff is gone), seam vocabulary docs,
and catalogs follow.
This commit is contained in:
imccyu
@@ -1,182 +1,88 @@
|
||||
import { describe, expect, it } from 'vitest'
|
||||
import { WorkflowError } from '@deepseek-ai/dsh-workflow'
|
||||
import { extractMeta } from '../src/meta.ts'
|
||||
import { validateMeta } from '../src/meta.ts'
|
||||
|
||||
const TIMEOUT = 1000
|
||||
|
||||
/** Extract and expect success. */
|
||||
function ok(script: string) {
|
||||
return extractMeta(script, TIMEOUT)
|
||||
}
|
||||
|
||||
/** The WorkflowError a bad script produces (throws if it extracts cleanly). */
|
||||
function bad(script: string): WorkflowError {
|
||||
/** Assert a META_INVALID throw whose message matches every given fragment. */
|
||||
function expectInvalid(value: unknown, ...fragments: string[]): void {
|
||||
let thrown: unknown
|
||||
try {
|
||||
extractMeta(script, TIMEOUT)
|
||||
validateMeta(value)
|
||||
} catch (error: unknown) {
|
||||
if (error instanceof WorkflowError) return error
|
||||
throw error
|
||||
thrown = error
|
||||
}
|
||||
expect(thrown).toBeInstanceOf(WorkflowError)
|
||||
expect((thrown as WorkflowError).code).toBe('META_INVALID')
|
||||
for (const fragment of fragments) {
|
||||
expect((thrown as WorkflowError).message).toContain(fragment)
|
||||
}
|
||||
throw new Error('expected extraction to fail')
|
||||
}
|
||||
|
||||
describe('extractMeta', () => {
|
||||
it('extracts a full meta block and blanks the statement line-preservingly', () => {
|
||||
const script = `export const meta = {
|
||||
name: 'audit-routes',
|
||||
description: 'Audit every route',
|
||||
whenToUse: 'when auditing',
|
||||
phases: [{ title: 'Scan', detail: 'find files' }, { title: 'Fix', model: 'deepseek-v4-pro' }],
|
||||
}
|
||||
const x = 1
|
||||
return x`
|
||||
const { meta, body } = ok(script)
|
||||
expect(meta).toEqual({
|
||||
name: 'audit-routes',
|
||||
description: 'Audit every route',
|
||||
whenToUse: 'when auditing',
|
||||
phases: [{ title: 'Scan', detail: 'find files' }, { title: 'Fix', model: 'deepseek-v4-pro' }],
|
||||
describe('validateMeta', () => {
|
||||
it('accepts a minimal meta and returns a normalized copy (no aliasing of the input)', () => {
|
||||
const input = { name: 'audit', description: 'audit the repo' }
|
||||
const meta = validateMeta(input)
|
||||
expect(meta).toEqual({ name: 'audit', description: 'audit the repo' })
|
||||
expect(meta).not.toBe(input)
|
||||
input.name = 'mutated'
|
||||
expect(meta.name).toBe('audit')
|
||||
})
|
||||
|
||||
it('accepts the full shape and rebuilds phases entry by entry', () => {
|
||||
const meta = validateMeta({
|
||||
name: 'migrate',
|
||||
description: 'migrate call sites',
|
||||
whenToUse: 'large mechanical sweeps',
|
||||
phases: [
|
||||
{ title: 'Discover' },
|
||||
{ title: 'Transform', detail: 'one agent per file', model: 'deepseek-v4-pro' },
|
||||
],
|
||||
})
|
||||
expect(meta).toEqual({
|
||||
name: 'migrate',
|
||||
description: 'migrate call sites',
|
||||
whenToUse: 'large mechanical sweeps',
|
||||
phases: [
|
||||
{ title: 'Discover' },
|
||||
{ title: 'Transform', detail: 'one agent per file', model: 'deepseek-v4-pro' },
|
||||
],
|
||||
})
|
||||
// Same line count; the statement's characters blanked; the body intact.
|
||||
expect(body.split('\n').length).toBe(script.split('\n').length)
|
||||
expect(body.split('\n')[6]).toBe('const x = 1')
|
||||
expect(body).not.toContain('export')
|
||||
})
|
||||
|
||||
it('allows leading line and block comments before the meta statement', () => {
|
||||
const script = `// a workflow
|
||||
/* multi
|
||||
line */
|
||||
export const meta = { name: 'x', description: 'y' }
|
||||
return 1`
|
||||
expect(ok(script).meta.name).toBe('x')
|
||||
it('rejects non-object values loud', () => {
|
||||
expectInvalid(undefined, 'meta must be an object')
|
||||
expectInvalid('a string', 'meta must be an object')
|
||||
expectInvalid(null, 'meta must be an object')
|
||||
expectInvalid([{ name: 'x', description: 'd' }], 'meta must be an object')
|
||||
})
|
||||
|
||||
it('handles braces inside strings and comments while scanning', () => {
|
||||
const script = `export const meta = {
|
||||
name: 'tricky', // } not a close {
|
||||
/* } also not } */
|
||||
description: "has { braces } and 'quotes'",
|
||||
}
|
||||
return 2`
|
||||
expect(ok(script).meta.description).toBe("has { braces } and 'quotes'")
|
||||
it('rejects unknown fields by name (accepted-then-ignored is banned)', () => {
|
||||
expectInvalid({ name: 'x', description: 'd', color: 'red' }, 'meta.color is not a recognized field')
|
||||
})
|
||||
|
||||
it('tolerates template-quoted strings WITHOUT interpolation, escapes included', () => {
|
||||
const script = 'export const meta = { name: `plain`, description: `esc \\` tick` }\nreturn 1'
|
||||
expect(ok(script).meta.name).toBe('plain')
|
||||
it('rejects missing or mistyped name/description/whenToUse', () => {
|
||||
expectInvalid({ description: 'd' }, 'meta.name must be a non-empty string')
|
||||
expectInvalid({ name: '', description: 'd' }, 'meta.name must be a non-empty string')
|
||||
expectInvalid({ name: 'x' }, 'meta.description must be a non-empty string')
|
||||
expectInvalid({ name: 'x', description: 42 }, 'meta.description must be a non-empty string')
|
||||
expectInvalid({ name: 'x', description: 'd', whenToUse: 3 }, 'meta.whenToUse must be a string')
|
||||
})
|
||||
|
||||
it('consumes a trailing semicolon after the literal, spaces included', () => {
|
||||
const { body } = ok("export const meta = { name: 'x', description: 'y' };\nreturn 1")
|
||||
expect(body).not.toContain(';')
|
||||
expect(body.split('\n')[1]).toBe('return 1')
|
||||
const spaced = ok("export const meta = { name: 'x', description: 'y' } ;\nreturn 1")
|
||||
expect(spaced.body).not.toContain(';')
|
||||
it('rejects malformed phases, entry by entry', () => {
|
||||
expectInvalid({ name: 'x', description: 'd', phases: 'Scan' }, 'meta.phases must be an array')
|
||||
expectInvalid({ name: 'x', description: 'd', phases: ['Scan'] }, 'meta.phases[0] must be an object')
|
||||
expectInvalid({ name: 'x', description: 'd', phases: [{ title: '' }] }, 'meta.phases[0].title must be a non-empty string')
|
||||
expectInvalid({ name: 'x', description: 'd', phases: [{ title: 'Scan', order: 1 }] }, 'meta.phases[0].order is not a recognized field')
|
||||
expectInvalid({ name: 'x', description: 'd', phases: [{ title: 'Scan', detail: 9 }] }, 'meta.phases[0].detail must be a string')
|
||||
expectInvalid({ name: 'x', description: 'd', phases: [{ title: 'Scan', model: 9 }] }, 'meta.phases[0].model must be a string')
|
||||
})
|
||||
|
||||
it('rejects a script that does not begin with the meta statement (SCRIPT_PARSE)', () => {
|
||||
expect(bad('const a = 1').code).toBe('SCRIPT_PARSE')
|
||||
expect(bad('').code).toBe('SCRIPT_PARSE')
|
||||
expect(bad('export const meta = [1]').code).toBe('SCRIPT_PARSE')
|
||||
})
|
||||
|
||||
it('a near-miss prefix (comment header + whitespace, then no `export`) fails FAST as SCRIPT_PARSE', () => {
|
||||
// Regression: the previous all-alternation prefix regex backtracked
|
||||
// exponentially on exactly this shape (~×2 per extra whitespace char once
|
||||
// the match fails), spinning the host synchronously inside start(). The
|
||||
// linear trivia scan must reject it in effectively zero time.
|
||||
const nearMiss = `// deep-audit workflow: reviews every route handler\n${' \n'.repeat(40)}/* second header block */\n${' '.repeat(200)}\nconst meta = { name: 'x', description: 'y' }\n`
|
||||
const started = Date.now()
|
||||
expect(bad(nearMiss).code).toBe('SCRIPT_PARSE')
|
||||
expect(Date.now() - started).toBeLessThan(1000)
|
||||
})
|
||||
|
||||
it('an unterminated block comment BEFORE the meta statement is SCRIPT_PARSE', () => {
|
||||
const error = bad('/* never closed\nexport const meta = { name: "x", description: "y" }')
|
||||
expect(error.code).toBe('SCRIPT_PARSE')
|
||||
expect(error.message).toContain('unterminated comment')
|
||||
})
|
||||
|
||||
it('a line comment running to EOF leaves no meta statement (SCRIPT_PARSE)', () => {
|
||||
expect(bad('// only a comment, no newline').code).toBe('SCRIPT_PARSE')
|
||||
})
|
||||
|
||||
it('rejects template interpolation in the meta block as impure (SCRIPT_PARSE)', () => {
|
||||
const error = bad('export const meta = { name: `w-${1}`, description: "d" }\nreturn 1')
|
||||
expect(error.code).toBe('SCRIPT_PARSE')
|
||||
expect(error.message).toContain('pure literal')
|
||||
})
|
||||
|
||||
it('rejects unbalanced literals, unterminated strings, and unterminated comments (SCRIPT_PARSE)', () => {
|
||||
expect(bad('export const meta = { name: "x", description: "y"').code).toBe('SCRIPT_PARSE')
|
||||
expect(bad('export const meta = { name: "x').code).toBe('SCRIPT_PARSE')
|
||||
expect(bad('export const meta = { /* open').code).toBe('SCRIPT_PARSE')
|
||||
// A line comment running to EOF (no newline) leaves the literal unbalanced.
|
||||
expect(bad('export const meta = { name: "x" // eof comment').code).toBe('SCRIPT_PARSE')
|
||||
})
|
||||
|
||||
it('rejects a literal referencing variables or calls (META_INVALID via the empty realm)', () => {
|
||||
const error = bad('export const meta = { name: someVariable, description: "d" }\nreturn 1')
|
||||
expect(error.code).toBe('META_INVALID')
|
||||
expect(error.message).toContain('pure literal')
|
||||
expect(bad('export const meta = { name: compute(), description: "d" }').code).toBe('META_INVALID')
|
||||
})
|
||||
|
||||
it('rejects a literal evaluating to non-JSON data (META_INVALID via materialization)', () => {
|
||||
const error = bad('export const meta = { name: "x", description: "d", whenToUse: () => 1 }')
|
||||
expect(error.code).toBe('META_INVALID')
|
||||
expect(error.message).toContain('JSON data')
|
||||
})
|
||||
|
||||
it('a meta expression that THROWS maps to META_INVALID carrying the rendered value', () => {
|
||||
const error = bad('export const meta = { name: (() => { throw "nope" })(), description: "d" }\nreturn 1')
|
||||
expect(error.code).toBe('META_INVALID')
|
||||
expect(error.message).toContain('pure literal')
|
||||
expect(error.message).toContain('nope')
|
||||
})
|
||||
|
||||
it('a spinning meta expression dies by the eval timeout', () => {
|
||||
try {
|
||||
extractMeta('export const meta = { name: (() => { while (true) {} })(), description: "d" }', 50)
|
||||
throw new Error('expected the extraction to time out')
|
||||
} catch (error: unknown) {
|
||||
expect(error).toBeInstanceOf(WorkflowError)
|
||||
expect((error as WorkflowError).code).toBe('META_INVALID')
|
||||
expect((error as WorkflowError).message.toLowerCase()).toContain('timed out')
|
||||
}
|
||||
})
|
||||
|
||||
it('rejects shape violations with EVERY violation listed (META_INVALID)', () => {
|
||||
const error = bad('export const meta = { description: 7, bogus: 1 }\nreturn 1')
|
||||
expect(error.code).toBe('META_INVALID')
|
||||
expect(error.message).toContain('meta.name must be a non-empty string')
|
||||
expect(error.message).toContain('meta.description must be a non-empty string')
|
||||
expect(error.message).toContain('meta.bogus is not a recognized field')
|
||||
})
|
||||
|
||||
it('rejects malformed whenToUse and phases shapes precisely', () => {
|
||||
expect(bad('export const meta = { name: "x", description: "d", whenToUse: 3 }').message)
|
||||
.toContain('meta.whenToUse must be a string')
|
||||
expect(bad('export const meta = { name: "x", description: "d", phases: "no" }').message)
|
||||
.toContain('meta.phases must be an array')
|
||||
expect(bad('export const meta = { name: "x", description: "d", phases: [3] }').message)
|
||||
.toContain('meta.phases[0] must be an object')
|
||||
expect(bad('export const meta = { name: "x", description: "d", phases: [{}] }').message)
|
||||
.toContain('meta.phases[0].title must be a non-empty string')
|
||||
expect(bad('export const meta = { name: "x", description: "d", phases: [{ title: "t", extra: 1 }] }').message)
|
||||
.toContain('meta.phases[0].extra is not a recognized field')
|
||||
expect(bad('export const meta = { name: "x", description: "d", phases: [{ title: "t", detail: 1 }] }').message)
|
||||
.toContain('meta.phases[0].detail must be a string')
|
||||
expect(bad('export const meta = { name: "x", description: "d", phases: [{ title: "t", model: 1 }] }').message)
|
||||
.toContain('meta.phases[0].model must be a string')
|
||||
})
|
||||
|
||||
it('stops scanning at the balanced literal — trailing expression text stays in the body', () => {
|
||||
// The scanner extracts exactly `{ valueOf: null }`; the ` && 3` is body
|
||||
// text (which would fail compilation later, but extraction sees only the
|
||||
// literal and reports its unknown field).
|
||||
expect(bad('export const meta = { valueOf: null } && 3').message)
|
||||
.toContain('meta.valueOf is not a recognized field')
|
||||
it('names EVERY violation in one throw, not just the first', () => {
|
||||
expectInvalid(
|
||||
{ description: 7, extra: true, phases: [{ title: 'Scan' }, 'bad'] },
|
||||
'meta.extra is not a recognized field',
|
||||
'meta.name must be a non-empty string',
|
||||
'meta.description must be a non-empty string',
|
||||
'meta.phases[1] must be an object',
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
Reference in New Issue
Block a user