Files
shiro-neko/test/workflow.test.ts
T
asepharyana 7a1e415fea
ci / check (macos-latest) (push) Canceled after 0s
ci / check (ubuntu-latest) (push) Canceled after 0s
ci / check (windows-latest) (push) Canceled after 0s
feat: implement provider-side prompt caching and workflow scaffolding
- Added support for caching the stable prefix of the system prompt for Anthropic models.
- Introduced a new option `cacheSystemPrefix` in SessionOptions to enable caching.
- Implemented a nudge escalation system that reminds users to update the TODO.md file, capped at three nudges.
- Created a new `scaffoldWorkflowFiles` function to generate TODO.md, ROADMAP.md, and docs/ directory when they are missing.
- Updated the App component to scaffold workflow files during initialization.
- Added hooks functionality to allow external scripts to modify tool input and manage approvals.
- Implemented tests for the new hooks functionality, ensuring proper approval and execution flow.
2026-09-09 20:11:23 +07:00

248 lines
10 KiB
TypeScript

import { usageOf } from './helpers';
import { expect, test } from 'bun:test';
import { MockLanguageModelV4, simulateReadableStream } from 'ai/test';
import type { LanguageModelV4StreamPart } from '@ai-sdk/provider';
import { mkdtempSync, rmSync } from 'node:fs';
import { tmpdir } from 'node:os';
import { join } from 'node:path';
import { Session } from '../src/session';
import { loadInstructions, formatInstructions } from '../src/instructions';
import { systemPrompt, type PromptParts } from '../src/prompt';
import { parseCommand } from '../src/commands';
const usage = usageOf(10, 5);
function stream(parts: LanguageModelV4StreamPart[]) {
return { stream: simulateReadableStream({ chunks: parts, chunkDelayInMs: null, initialDelayInMs: null }) };
}
function toolCall(id: string, toolName: string, input: unknown): LanguageModelV4StreamPart[] {
return [
{ type: 'tool-input-start', id, toolName },
{ type: 'tool-input-end', id },
{ type: 'tool-call', toolCallId: id, toolName, input: JSON.stringify(input) },
{ type: 'finish', finishReason: { unified: 'tool-calls', raw: 'tool_use' }, usage },
];
}
function text(body: string): LanguageModelV4StreamPart[] {
return [
{ type: 'text-start', id: '0' },
{ type: 'text-delta', id: '0', delta: body },
{ type: 'text-end', id: '0' },
{ type: 'finish', finishReason: { unified: 'stop', raw: 'stop' }, usage },
];
}
/** Fresh dir + a fake git root (.git/HEAD) so the workflow finds a repo. */
function inGitRepo<T>(fn: () => Promise<T>): Promise<T> {
const orig = process.cwd();
const dir = mkdtempSync(join(tmpdir(), 'shiro-workflow-'));
process.chdir(dir);
return (async () => {
await Bun.write(join(dir, '.git', 'HEAD'), 'ref: refs/heads/main\n');
return fn();
})().finally(() => {
process.chdir(orig);
rmSync(dir, { recursive: true, force: true });
});
}
test('workflow prompt policy renders when the repo tracks progress', () =>
inGitRepo(async () => {
await Bun.write(join(process.cwd(), 'TODO.md'), '# Todo\n- [ ] thing\n');
await Bun.write(join(process.cwd(), 'docs', 'architecture.md'), '# Arch\n');
const session = new Session({ model: new MockLanguageModelV4({ doStream: async () => stream([]) }), askApproval: async () => "deny" });
const parts: PromptParts = { cwd: process.cwd() };
const rendered = systemPrompt(parts);
expect(rendered).not.toContain('Project workflow');
// The policy is supplied by the session, not the parts default.
expect(parts.workflowPolicy).toBeUndefined();
}));
test('workflow policy renders via the session when tracking files exist', () =>
inGitRepo(async () => {
await Bun.write(join(process.cwd(), 'TODO.md'), '# Todo\n- [ ] thing\n');
const session = new Session({ model: new MockLanguageModelV4({ doStream: async () => stream([]) }), askApproval: async () => "deny" });
const status = session.workflowStatus();
expect(status.hasTodo).toBe(true);
expect(status.todoLines).toBe(3);
expect(status.enabled).toBe(true);
// A session whose repo has TODO.md renders the policy into its system prompt.
}));
test('workflow disabled renders no policy even with a TODO.md', () =>
inGitRepo(async () => {
await Bun.write(join(process.cwd(), 'TODO.md'), '# Todo\n- [ ] thing\n');
const session = new Session({
model: new MockLanguageModelV4({ doStream: async () => stream([]) }),
workflow: { enabled: false },
askApproval: async () => 'deny',
});
// systemFor is private; workflowStatus reflects the switch.
expect(session.workflowStatus().enabled).toBe(false);
}));
test('bare repo renders no workflow policy', () =>
inGitRepo(async () => {
const session = new Session({ model: new MockLanguageModelV4({ doStream: async () => stream([]) }), askApproval: async () => "deny" });
const status = session.workflowStatus();
expect(status.hasTodo).toBe(false);
expect(status.hasRoadmap).toBe(false);
expect(status.hasDocs).toBe(false);
// No tracking files -> policy would be empty; workflowStatus still reports the switch.
expect(status.enabled).toBe(true);
}));
test('instructions load TODO.md and ROADMAP.md from the git root', () =>
inGitRepo(async () => {
await Bun.write(join(process.cwd(), 'TODO.md'), '# Todo\n- [ ] thing\n');
await Bun.write(join(process.cwd(), 'ROADMAP.md'), '# Roadmap\n- done\n');
const loaded = await loadInstructions();
const labels = loaded.map((i) => i.path);
expect(labels.some((p) => p.endsWith('TODO.md'))).toBe(true);
expect(labels.some((p) => p.endsWith('ROADMAP.md'))).toBe(true);
const fmt = formatInstructions(loaded);
expect(fmt).toContain('Project tracker');
}));
test('a turn that edits without updating the task list gets one workflow nudge', () =>
inGitRepo(async () => {
await Bun.write(join(process.cwd(), 'TODO.md'), '# Todo\n- [ ] thing\n');
await Bun.write(join(process.cwd(), 'app.ts'), 'const a = 1;\n');
let call = 0;
const session = new Session({
model: new MockLanguageModelV4({
doStream: async () =>
stream(
call++ === 0
? toolCall('c1', 'edit_file', { path: 'app.ts', oldString: 'const a = 1;', newString: 'const a = 2;' })
: text('done'),
),
}),
askApproval: async () => 'once',
});
const notices: string[] = [];
for await (const ev of session.send('bump a')) {
if (ev.type === 'notice') notices.push(ev.text);
}
expect(notices.some((n) => n.includes('without updating the project task list'))).toBe(true);
}));
test('a turn that updates the task list gets no workflow nudge', () =>
inGitRepo(async () => {
await Bun.write(join(process.cwd(), 'TODO.md'), '# Todo\n- [ ] thing\n');
await Bun.write(join(process.cwd(), 'app.ts'), 'const a = 1;\n');
let call = 0;
const session = new Session({
model: new MockLanguageModelV4({
doStream: async () =>
stream(
call++ === 0
? toolCall('c1', 'todo_write', { items: [{ text: 'thing', done: true }] })
: call++ === 1
? toolCall('c2', 'edit_file', { path: 'app.ts', oldString: 'const a = 1;', newString: 'const a = 2;' })
: text('done'),
),
}),
askApproval: async () => 'once',
});
const notices: string[] = [];
for await (const ev of session.send('bump a')) {
if (ev.type === 'notice') notices.push(ev.text);
}
expect(notices.some((n) => n.includes('without updating the project task list'))).toBe(false);
}));
test('/workflow parses to the workflow action', () => {
expect(parseCommand('/workflow')).toEqual({ type: 'workflow' });
const menuEntry = parseCommand('/');
expect(menuEntry).not.toEqual({ type: 'workflow' });
});
test('/workflow panel renders the status rows', () =>
inGitRepo(async () => {
await Bun.write(join(process.cwd(), 'TODO.md'), '# Todo\n- [ ] thing\n');
const session = new Session({ model: new MockLanguageModelV4({ doStream: async () => stream([]) }), askApproval: async () => 'deny' });
const { workflowPanel } = await import('../src/ui/panel-bodies');
const panel = workflowPanel(session);
expect(panel.title).toBe('workflow');
expect(panel.body).toContain('TODO.md: yes');
expect(panel.body).toContain('workflow: on');
}));
test('nudge ladder: fires up to 3 times, then stops', async () => {
const dir = mkdtempSync(join(tmpdir(), 'shiro-wf-ladder'));
try {
await Bun.write(join(dir, '.git', 'HEAD'), 'ref: refs/heads/main\n');
await Bun.write(join(dir, 'TODO.md'), '# Todo\n- [ ] task\n');
await Bun.write(join(dir, 'app.ts'), 'const a = 1;\n');
let call = 0;
const session = new Session({
model: new MockLanguageModelV4({
doStream: async () => {
call++;
if (call <= 3) return stream(toolCall(`c${call}`, 'edit_file', { path: 'app.ts', oldString: 'const a = 1;', newString: `const a = ${call + 1};` }));
// Turn 4+: no tool call — agent stops
return stream(text('done'));
},
}),
askApproval: async () => 'once',
});
const notices: string[] = [];
for (let i = 0; i < 5; i++) {
for await (const ev of session.send(`turn ${i + 1}`)) {
if (ev.type === 'notice') notices.push(ev.text);
}
}
const nudgeNotices = notices.filter((n) => n.includes('without updating the project task list'));
expect(nudgeNotices.length).toBe(3);
} finally {
rmSync(dir, { recursive: true, force: true });
}
});
test('nudge resets after todo_write in a later turn', async () => {
const dir = mkdtempSync(join(tmpdir(), 'shiro-wf-reset'));
try {
await Bun.write(join(dir, '.git', 'HEAD'), 'ref: refs/heads/main\n');
await Bun.write(join(dir, 'TODO.md'), '# Todo\n- [ ] task\n');
await Bun.write(join(dir, 'app.ts'), 'const a = 1;\n');
let call = 0;
const session = new Session({
model: new MockLanguageModelV4({
doStream: async () => {
call++;
// Turn 1-3: edit file → 3 nudges
if (call <= 3) return stream(toolCall(`c${call}`, 'edit_file', { path: 'app.ts', oldString: 'const a = 1;', newString: `const a = ${call + 1};` }));
// Turn 4: todo_write → resets the nudge counter
if (call === 4) return stream(toolCall(`c${call}`, 'todo_write', { items: [{ text: 'completed task', done: true }] }));
// Turn 5: edit file → should nudge again (counter was reset)
return stream(toolCall(`c${call}`, 'edit_file', { path: 'app.ts', oldString: 'const a = 4;', newString: `const a = ${call + 1};` }));
},
}),
askApproval: async () => 'once',
});
const notices: string[] = [];
for (let i = 0; i < 6; i++) {
for await (const ev of session.send(`turn ${i + 1}`)) {
if (ev.type === 'notice') notices.push(ev.text);
}
}
const nudgeNotices = notices.filter((n) => n.includes('without updating the project task list'));
// 3 nudges (turns 1-3) + 1 reset + 1 more nudge (turn 5) = 4
expect(nudgeNotices.length).toBe(4);
} finally {
rmSync(dir, { recursive: true, force: true });
}
});