@haoyiyin/workflow 0.2.11 → 0.3.1

package/src/agents/contracts/verifier.ts

@@ -0,0 +1,137 @@
+/**
+ * Verifier Subagent Contract
+ *
+ * The verifier agent checks that implemented changes satisfy requirements.
+ * It operates with read-only permissions to analyze code and test results.
+ */
+
+import type { SubagentContract, PermissionSet } from '../types.js';
+
+const READ_ONLY: PermissionSet = {
+  readFiles: true,
+  searchCode: true,
+  runCommands: false,
+  writeFiles: false,
+  gitOperations: false,
+};
+
+export interface VerifierParams {
+  /** The original goal / requirement */
+  goal: string;
+  /** The plan that was executed */
+  plan: string;
+  /** Files that were changed */
+  changedFiles: string[];
+  /** Acceptance criteria */
+  acceptanceCriteria: string[];
+  /** Test results to verify (if available) */
+  testResults?: string;
+  /** Additional files to read for context */
+  contextFiles?: string[];
+}
+
+/**
+ * Verifier contract: read-only goal-backward verification.
+ * Checks that implemented changes satisfy the original requirements.
+ */
+export function verifierContract(params: VerifierParams): SubagentContract {
+  const criteriaList = params.acceptanceCriteria
+    .map((c, i) => `${i + 1}. ${c}`)
+    .join('\n');
+
+  const testResultsBlock = params.testResults
+    ? `\n\n## Test Results\n\n\`\`\`\n${params.testResults}\n\`\`\``
+    : '';
+
+  const prompt = [
+    `Verify that the implemented changes satisfy the original goal.`,
+    '',
+    '## Original Goal',
+    '',
+    params.goal,
+    '',
+    '## Execution Plan',
+    '',
+    params.plan,
+    '',
+    '## Changed Files',
+    '',
+    params.changedFiles.map((f) => `- \`${f}\``).join('\n'),
+    testResultsBlock,
+    '',
+    '## Acceptance Criteria',
+    '',
+    criteriaList,
+    '',
+    '## Verification Process',
+    '',
+    'Work backward from each acceptance criterion:',
+    '',
+    '1. **For Each Criterion**',
+    '   - Identify what evidence would prove it is met',
+    '   - Check the changed files for that evidence',
+    '   - Verify the implementation matches the intent',
+    '',
+    '2. **Evidence Types**',
+    '   - Code changes directly addressing the requirement',
+    '   - Test coverage for the new functionality',
+    '   - Type safety and compilation success',
+    '   - Error handling for edge cases',
+    '',
+    '3. **Mark Each Criterion**',
+    '   - **PASS**: Criterion is fully satisfied',
+    '   - **FAIL**: Criterion is not satisfied',
+    '   - **UNCERTAIN**: Cannot determine from available information',
+    '',
+    '4. **Identify Gaps**',
+    '   - Missing functionality',
+    '   - Incomplete error handling',
+    '   - Missing tests',
+    '   - Documentation gaps',
+    '',
+    '## Output Format',
+    '',
+    'Respond with a JSON block containing:',
+    '```json',
+    '{',
+    '  "verdict": "pass|fail|partial",',
+    '  "summary": "Brief summary of verification findings",',
+    '  "criteriaResults": [',
+    '    {',
+    '      "criterion": "The acceptance criterion text",',
+    '      "status": "pass|fail|uncertain",',
+    '      "evidence": "Specific evidence from code or tests",',
+    '      "files": ["relevant files"]',
+    '    }',
+    '  ],',
+    '  "gaps": [',
+    '    {',
+    '      "description": "What is missing",',
+    '      "severity": "low|medium|high",',
+    '      "recommendation": "How to address the gap"',
+    '    }',
+    '  ],',
+    '  "recommendation": "Next steps or actions needed"',
+    '}',
+    '```',
+  ].join('\n');
+
+  const reads = [
+    ...params.changedFiles,
+    ...(params.contextFiles ?? []),
+  ];
+
+  return {
+    permissions: READ_ONLY,
+    outputSchema: {
+      verdict: 'string',
+      summary: 'string',
+      criteriaResults: 'object',
+      gaps: 'object',
+      recommendation: 'string',
+    },
+    prompt,
+    owns: [],
+    reads,
+  };
+}