* refactor(prompts): move loader to lib/prompts/ Move file-based prompt loader from lib/generation/prompts/ to project-level lib/prompts/ so it can be shared by orchestration and PBL prompts in subsequent commits. - Templates and snippets moved alongside the loader - getPromptsDir() now points at lib/prompts/ - Generation pipeline imports updated to @/lib/prompts (outline-generator, scene-generator, search-query-builder, scene-outlines-stream route) - Add tests/prompts/loader.test.ts as sanity gate Pure file move — no behavior change. * test(orchestration): add baseline snapshots for prompt builders Snapshot tests cover variant matrix: - buildStructuredPrompt: role × scene-type × peer/ledger/discussion/profile - convertMessagesToOpenAI: mixed message kinds - summarizeConversation: truncation - buildDirectorPrompt: Q&A vs discussion, ledger, profile - buildPBLSystemPrompt: default config These lock current output so the body refactor in subsequent commits can be verified byte-equal. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * test(orchestration): plug snapshot coverage gaps from review - Split convertMessagesToOpenAI test: same-agent (existing) + cross-agent (new). The original test passed currentAgentId matching the message's agentId, so the cross-agent role-conversion branch was never exercised. - Add 'teacher / quiz scene' snapshot to lock the spotlight/laser strip path in getEffectiveActions. The previous variant-7 test (whiteboard-open) only triggered the mutual-exclusion warning, not the strip — renamed it to reflect what it actually tests. - Add assistant-role variant (was uncovered: ROLE_GUIDELINES, buildLengthGuidelines, buildWhiteboardGuidelines all branch on role). * refactor(orchestration): extract summarizers from prompt-builder.ts Move state-context, virtual whiteboard ledger replay, peer context, message converter, and conversation summary out of the 890-line prompt-builder.ts into focused modules under lib/orchestration/summarizers/. prompt-builder.ts now only owns prompt assembly. director-graph imports updated to the new locations. Snapshot tests pass byte-equal — no behavior change. * refactor(orchestration): move agent-system prompt to template file The buildStructuredPrompt template literal is now lib/prompts/templates/agent-system/system.md, assembled by a thin variable-pass through the shared prompt loader. Per-variant ternaries (format example, ordering, spotlight examples, mutual-exclusion note) are kept as module-level constants in prompt-builder.ts. ROLE_GUIDELINES, buildLengthGuidelines, and buildWhiteboardGuidelines stay too (they may further migrate to template partials in Phase 2). Also: PROMPT_IDS gains a 'satisfies Record<string, PromptId>' clause to prevent constant/union drift as more IDs are added. Snapshot tests (12 prompt-builder + 4 director + 1 pbl) pass byte-equal. * refactor(prompts): align agent-system template with project conventions - Rename agent-system placeholders snake_case → camelCase to match the convention already used by slide-actions/user.md and other generation templates. Settles convention before Task 5 lands two more templates that would otherwise inherit drift. - Extract '## Speech Guidelines (CRITICAL)' into lib/prompts/snippets/speech-guidelines.md for reuse by director and PBL prompts in Task 5. Snapshot tests pass byte-equal — placeholder name changes are invisible in rendered output, and snippet inclusion happens at load time. * refactor(orchestration,pbl): move director + PBL prompts to templates director-prompt.ts and pbl-system-prompt.ts now use the shared template loader. Bodies collapse to thin variable assembly. Three orchestration-tier prompts now share one infrastructure: agent-system, director, pbl-design. Snapshot tests pass byte-equal. * refactor(orchestration): extract WhiteboardActionRecord + AgentTurnSummary to types module These two interfaces are imported by 6+ modules including summarizers/ — having them live in director-prompt.ts created an awkward upward import direction (summarizers reaching back to a sibling prompt builder for types). Move them to lib/orchestration/types.ts and update all callers. director-prompt.ts now imports them too. Pure type-location refactor — snapshots pass byte-equal. * test: remove snapshot tests in favor of eval-as-integration-test Per review feedback: byte-equal snapshots were the wrong invariant for this refactor. The goal was a stable substrate for editing prompts, not a frozen contract. Snapshots would have generated maintenance churn (~100-200 line diffs per intentional Phase 2 prompt tweak) without providing value the eval doesn't already. Test posture going forward: - tests/prompts/loader.test.ts (3 tests) — bounds the loader infrastructure (template load, snippet inclusion, variable interpolation, missing-id behavior) - pnpm eval:whiteboard — bounds end-to-end agent loop, template composition, and integration with chat/director/state-manager Removed: 1879 lines of .snap + 320 lines of test scaffolding + fixtures. Net PR diff drops by ~2200 lines. * docs(prompts): add README + structural assertion tests (review feedback) Addresses two items flagged by PR #459 final review: 1. lib/prompts/README.md — conventions, syntax, gotchas, and local-testing recipe for template authors. Previously there was no doc for the stated goal of "non-engineers can edit prompts." 2. tests/prompts/templates.test.ts — 8 structural assertions covering: - no surviving {{...}} placeholders in any rendered template - role dispatch (teacher → LEAD TEACHER, student → not) - scene-type action stripping (quiz scene has no spotlight/laser) - director prompt output spec mentions next_agent These replace the removed byte-equal snapshot suite at much lower maintenance cost — they assert behaviors the refactor must preserve, not exact bytes. * chore(prompts): relocate templates added on main during rebase PR #461 (interactive mode clean) added 7 new templates under lib/generation/prompts/templates/ (the pre-refactor location). Rebase onto origin/main landed them at the old path; git's rename detection didn't forward them through the directory move in db56c40. Manually move them to lib/prompts/templates/ to match the new convention, and fix scene-generator.ts's relative import ('./prompts/types' → '@/lib/prompts/types') since the dir no longer exists as a sibling. No behavior change — templates read from PROMPT_IDS values via getPromptsDir() which already points at lib/prompts/. * refactor(prompts): address review feedback from @cosarah - loadSnippet now throws on missing file instead of silently returning a literal {{snippet:id}} string. A typo like {{snippet:speach-guidelines}} now fails at load time instead of reaching the LLM. - README gains a "Still in TypeScript" section listing the role-conditional content that still lives in prompt-builder.ts (ROLE_GUIDELINES, buildLengthGuidelines, buildWhiteboardGuidelines) so contributors expecting a pure-markdown workflow know where to look. - Expand tests/prompts/templates.test.ts to cover the conditional branches Phase 2 is most likely to touch (9 new assertions): - assistant role dispatch - peer-context section toggles on agentResponses presence - language constraint toggles on stage.languageDirective presence - director Q&A vs discussion mode branching - pbl-design {{issueCount}} substituted at all 3 occurrences - placeholder-naming-convention lint scans every template for non-camelCase placeholders (slide-content grandfathered) - Comment above interpolateVariables regex documents why kebab-case placeholders pass through silently (the lint test now catches them). - New test in loader.test.ts locks the throw-on-missing-snippet behavior. --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
100 lines
2.9 KiB
TypeScript
100 lines
2.9 KiB
TypeScript
import { parseJsonResponse } from '@/lib/generation/json-repair';
|
|
import { PROMPT_IDS, buildPrompt } from '@/lib/prompts';
|
|
import type { AICallFn } from '@/lib/generation/pipeline-types';
|
|
import { createLogger } from '@/lib/logger';
|
|
|
|
const log = createLogger('SearchQueryBuilder');
|
|
const TAVILY_SOFT_MAX_QUERY_LENGTH = 350;
|
|
export const SEARCH_QUERY_REWRITE_EXCERPT_LENGTH = 7000;
|
|
|
|
interface SearchQueryRewriteResponse {
|
|
query: string;
|
|
}
|
|
|
|
export interface SearchQueryBuildResult {
|
|
query: string;
|
|
rewriteAttempted: boolean;
|
|
rawRequirementLength: number;
|
|
finalQueryLength: number;
|
|
hasPdfContext: boolean;
|
|
}
|
|
|
|
function normalizeSearchRequirement(requirement: string): string {
|
|
return requirement.replace(/\s+/g, ' ').trim();
|
|
}
|
|
|
|
function normalizePdfExcerpt(pdfText?: string): string {
|
|
if (!pdfText) {
|
|
return '';
|
|
}
|
|
|
|
return pdfText.replace(/\s+/g, ' ').trim().slice(0, SEARCH_QUERY_REWRITE_EXCERPT_LENGTH);
|
|
}
|
|
|
|
function shouldRewriteSearchQuery(
|
|
normalizedRequirement: string,
|
|
normalizedPdfExcerpt: string,
|
|
): boolean {
|
|
return normalizedRequirement.length > 400 || Boolean(normalizedPdfExcerpt);
|
|
}
|
|
|
|
export async function buildSearchQuery(
|
|
requirement: string,
|
|
pdfText: string | undefined,
|
|
aiCall?: AICallFn,
|
|
): Promise<SearchQueryBuildResult> {
|
|
const normalizedRequirement = normalizeSearchRequirement(requirement);
|
|
const pdfExcerpt = normalizePdfExcerpt(pdfText);
|
|
const hasPdfContext = Boolean(pdfExcerpt);
|
|
const rewriteAttempted = shouldRewriteSearchQuery(normalizedRequirement, pdfExcerpt);
|
|
|
|
const fallback = {
|
|
query: normalizedRequirement,
|
|
rewriteAttempted,
|
|
rawRequirementLength: normalizedRequirement.length,
|
|
finalQueryLength: normalizedRequirement.length,
|
|
hasPdfContext,
|
|
} satisfies SearchQueryBuildResult;
|
|
|
|
if (!normalizedRequirement || !rewriteAttempted) {
|
|
return fallback;
|
|
}
|
|
|
|
if (!aiCall) {
|
|
log.warn('Query rewrite AI call unavailable, falling back to raw requirement');
|
|
return fallback;
|
|
}
|
|
|
|
const prompts = buildPrompt(PROMPT_IDS.WEB_SEARCH_QUERY_REWRITE, {
|
|
requirement: normalizedRequirement,
|
|
pdfExcerpt: pdfExcerpt || 'None',
|
|
});
|
|
|
|
if (!prompts) {
|
|
log.warn('Query rewrite prompt not found, falling back to raw requirement');
|
|
return fallback;
|
|
}
|
|
|
|
try {
|
|
const response = await aiCall(prompts.system, prompts.user);
|
|
const parsed = parseJsonResponse<SearchQueryRewriteResponse>(response);
|
|
const rewrittenQuery = normalizeSearchRequirement(parsed?.query || '').slice(
|
|
0,
|
|
TAVILY_SOFT_MAX_QUERY_LENGTH,
|
|
);
|
|
if (!rewrittenQuery) {
|
|
log.warn('Query rewrite returned empty output, falling back to raw requirement');
|
|
return fallback;
|
|
}
|
|
|
|
return {
|
|
...fallback,
|
|
query: rewrittenQuery,
|
|
finalQueryLength: rewrittenQuery.length,
|
|
};
|
|
} catch (error) {
|
|
log.warn('Query rewrite failed, falling back to raw requirement:', error);
|
|
return fallback;
|
|
}
|
|
}
|