orca/src/shared/commit-message-plan.ts

260 lines
8.1 KiB
TypeScript

import {
getCommitMessageAgentSpec,
getCommitMessageModel,
isCustomAgentId
} from './commit-message-agent-spec'
import { planCustomCommand, tokenizeCustomCommandTemplate } from './commit-message-prompt'
import type { TuiAgent } from './types'
// Why: planning is a pure transformation from "user request + prompt text"
// into "spawn-ready binary + argv". Keeping it in shared lets both the local
// generator (main process) and the SSH provider (which delegates to the
// relay over JSON-RPC) reuse the exact same validation and arg-building
// logic without duplicating the spec/model/thinking checks.
export type CommitMessagePlanInput = {
agentId: TuiAgent | 'custom'
model: string
thinkingLevel?: string
customAgentCommand?: string
agentCommandOverride?: string
agentArgs?: string
}
export type CommitMessagePlan = {
binary: string
args: string[]
/** Non-null when the prompt should be piped via stdin. */
stdinPayload: string | null
/** Human-readable label used in error prefixes (e.g. "Claude failed: ..."). */
label: string
}
export type CommitMessagePlanResult =
| { ok: true; plan: CommitMessagePlan }
| { ok: false; error: string }
export function planAgentBinary(
defaultBinary: string,
commandOverride: string | undefined
): { ok: true; binary: string; prefixArgs: string[] } | { ok: false; error: string } {
const command = commandOverride?.trim()
if (!command) {
return { ok: true, binary: defaultBinary, prefixArgs: [] }
}
const tokenized = tokenizeCustomCommandTemplate(command)
if (!tokenized.ok) {
return { ok: false, error: `Agent command override is invalid: ${tokenized.error}` }
}
const [binary, ...prefixArgs] = tokenized.tokens
if (!binary) {
return { ok: false, error: 'Agent command override must start with a binary name.' }
}
return { ok: true, binary, prefixArgs }
}
function planAdditionalAgentArgs(
agentArgs: string | null | undefined
): { ok: true; args: string[] } | { ok: false; error: string } {
const trimmed = agentArgs?.trim()
if (!trimmed) {
return { ok: true, args: [] }
}
const tokenized = tokenizeCustomCommandTemplate(trimmed)
if (!tokenized.ok) {
return { ok: false, error: `CLI arguments are invalid: ${tokenized.error}` }
}
return { ok: true, args: tokenized.tokens }
}
const CODEX_MODEL_OPTION_ALIASES = ['--model', '-m'] as const
function matchesOption(token: string, aliases: readonly string[]): boolean {
return aliases.some(
(alias) =>
token === alias ||
token.startsWith(`${alias}=`) ||
(alias.startsWith('-') &&
!alias.startsWith('--') &&
token.startsWith(alias) &&
token.length > alias.length)
)
}
function findOptionOccurrence(
tokens: string[],
aliases: readonly string[],
stopAtTerminator: boolean
): { index: number; consumed: number } | null {
for (let index = 0; index < tokens.length; index += 1) {
const token = tokens[index]
if (stopAtTerminator && token === '--') {
break
}
if (!matchesOption(token, aliases)) {
continue
}
const nextToken = tokens[index + 1]
const consumesNext =
aliases.includes(token) && nextToken !== undefined && !nextToken.startsWith('-')
return { index, consumed: consumesNext ? 2 : 1 }
}
return null
}
function applyRecipeOptionOverride(args: {
generatedArgs: string[]
recipeArgs: string[]
aliases: readonly string[]
}): { generatedArgs: string[]; recipeArgs: string[] } {
const recipeOption = findOptionOccurrence(args.recipeArgs, args.aliases, true)
const generatedOption = findOptionOccurrence(args.generatedArgs, args.aliases, false)
if (!recipeOption || !generatedOption) {
return { generatedArgs: args.generatedArgs, recipeArgs: args.recipeArgs }
}
const overrideTokens = args.recipeArgs.slice(
recipeOption.index,
recipeOption.index + recipeOption.consumed
)
return {
generatedArgs: [
...args.generatedArgs.slice(0, generatedOption.index),
...overrideTokens,
...args.generatedArgs.slice(generatedOption.index + generatedOption.consumed)
],
recipeArgs: [
...args.recipeArgs.slice(0, recipeOption.index),
...args.recipeArgs.slice(recipeOption.index + recipeOption.consumed)
]
}
}
function insertAdditionalAgentArgs(args: {
baseArgs: string[]
agentArgs: string[]
promptDelivery: 'argv' | 'stdin'
prompt: string
}): string[] {
if (!args.agentArgs.length) {
return args.baseArgs
}
const promptPlaceholderIndex = args.baseArgs.lastIndexOf('{prompt}')
if (promptPlaceholderIndex !== -1) {
const merged = [...args.baseArgs]
merged.splice(promptPlaceholderIndex, 0, ...args.agentArgs)
return merged
}
if (
args.promptDelivery === 'argv' &&
args.prompt.length > 0 &&
args.baseArgs.at(-1) === args.prompt
) {
return [...args.baseArgs.slice(0, -1), ...args.agentArgs, args.prompt]
}
return [...args.baseArgs, ...args.agentArgs]
}
export function planCommitMessageGeneration(
input: CommitMessagePlanInput,
prompt: string
): CommitMessagePlanResult {
if (isCustomAgentId(input.agentId)) {
const command = input.customAgentCommand?.trim() ?? ''
if (!command) {
return {
ok: false,
error: 'Custom command is empty. Add one in Settings → Git → AI Commit Messages.'
}
}
const planned = planCustomCommand(command, prompt)
if (!planned.ok) {
return { ok: false, error: planned.error }
}
const agentArgs = planAdditionalAgentArgs(input.agentArgs)
if (!agentArgs.ok) {
return agentArgs
}
return {
ok: true,
plan: {
binary: planned.binary,
args: insertAdditionalAgentArgs({
baseArgs: planned.args,
agentArgs: agentArgs.args,
promptDelivery: planned.stdinPayload === null ? 'argv' : 'stdin',
prompt
}),
stdinPayload: planned.stdinPayload,
// Why: a custom command has no friendly name, so the binary doubles
// as the label in error prefixes ("ollama failed: ...").
label: planned.binary
}
}
}
const spec = getCommitMessageAgentSpec(input.agentId)
if (!spec) {
return { ok: false, error: `Agent "${input.agentId}" does not support AI commit messages.` }
}
const model = getCommitMessageModel(input.agentId, input.model)
if (!model) {
return { ok: false, error: `Model "${input.model}" is not available for ${spec.label}.` }
}
if (input.thinkingLevel) {
if (!model.thinkingLevels && spec.modelSource !== 'dynamic') {
return {
ok: false,
error: `Model "${model.label}" does not support a thinking effort level.`
}
}
if (model.thinkingLevels && !model.thinkingLevels.some((l) => l.id === input.thinkingLevel)) {
return {
ok: false,
error: `Thinking level "${input.thinkingLevel}" is not valid for ${model.label}.`
}
}
}
const argvPrompt = spec.promptDelivery === 'argv' ? prompt : ''
const baseArgs = spec.buildArgs({
prompt: argvPrompt,
model: input.model,
thinkingLevel: input.thinkingLevel
})
const agentArgs = planAdditionalAgentArgs(input.agentArgs)
if (!agentArgs.ok) {
return agentArgs
}
// Why: Codex rejects repeated singleton model flags. Recipe CLI arguments
// are the more specific setting, so they replace Orca's generated model.
const overriddenArgs =
input.agentId === 'codex'
? applyRecipeOptionOverride({
generatedArgs: baseArgs,
recipeArgs: agentArgs.args,
aliases: CODEX_MODEL_OPTION_ALIASES
})
: { generatedArgs: baseArgs, recipeArgs: agentArgs.args }
const args = insertAdditionalAgentArgs({
baseArgs: overriddenArgs.generatedArgs,
agentArgs: overriddenArgs.recipeArgs,
promptDelivery: spec.promptDelivery,
prompt: argvPrompt
})
const command = planAgentBinary(spec.binary, input.agentCommandOverride)
if (!command.ok) {
return { ok: false, error: command.error }
}
return {
ok: true,
plan: {
binary: command.binary,
args: [...command.prefixArgs, ...args],
stdinPayload: spec.promptDelivery === 'stdin' ? prompt : null,
label: spec.label
}
}
}