Files
orca/src/shared/commit-message-prompt.ts
T
OrcaWinandOrcaWin 7d6603aa17 [comment audit] Complete repository-wide comment cleanup (#33249)
* [comment audit] Align legacy failure-read counts with cached display

* [comment audit] Condense shared provider lifecycle and browser recovery comments [skip ci]

* [comment audit] Condense shared generation, path and preview comments [skip ci]

* [comment audit] Condense host, file and Git contract rationale [skip ci]

* [comment audit] Tighten Git lifecycle and provider contract comments [skip ci]

* [comment audit] Clarify shared host authority and launch isolation [skip ci]

* [comment audit] simplify local access mobile and native chat contracts [skip ci]

* [comment audit] simplify native chat presentation and state contracts [skip ci]

* [comment audit] simplify native runtime and provider contracts [skip ci]

* [comment audit] simplify migration and orchestration contracts [skip ci]

* [comment audit] simplify plugin trust and process capture rationale [skip ci]

* [comment audit] simplify terminal delivery and remote compatibility rationale [skip ci]

* [comment audit] clarify remote recovery and launch wire rationale [skip ci]

* [comment audit] shorten shared RPC compatibility and runtime evidence comments [skip ci]

* [comment audit] simplify secure storage shell startup and sidebar rationale [skip ci]

* [comment audit] clarify sidebar, skill and SSH invariants [skip ci]

* [comment audit] condense structured chat delivery and timing rationale [skip ci]

* [comment audit] condense terminal replay and telemetry invariants [skip ci]

* [comment audit] clarify launch permission and terminal delivery rationale [skip ci]

* [comment audit] clarify workspace ownership and layout contracts [skip ci]

* [comment audit] wait for fitted and painted SSH terminal links

* [comment audit] clarify layout persistence and session ownership [skip ci]

* [comment audit] clarify host routing and workspace lifecycle contracts [skip ci]

* [comment audit] clarify startup persistence and app lifetime comments [skip ci]

* [comment audit] clarify recovery and activity boundaries [skip ci]

* [comment audit] condense activity and artifact invariants [skip ci]

* [comment audit] condense automation authority contracts [skip ci]

* [comment audit] simplify automation scheduling and history contracts [skip ci]

* [comment audit] clarify browser chrome and annotation lifecycles [skip ci]

* [comment audit] clarify browser routing and retained guest ownership [skip ci]

* [comment audit] clarify browser recovery and document ownership comments [skip ci]

* [comment audit] restore hosted runners required by native IME fixtures

* [comment audit] shorten preview, palette and dashboard invariants [skip ci]

* [comment audit] clarify terminal preview, dashboard and retention comments [skip ci]

* [comment audit] clarify diff-note recovery and editor lifecycle comments [skip ci]

* [comment audit] shorten rich-text and combined-diff ownership comments [skip ci]

* [comment audit] shorten autosave, draft recovery and model ownership comments [skip ci]

* [comment audit] shorten save-queue, notebook and Markdown constraints [skip ci]

* [comment audit] shorten Monaco, PDF and rich Markdown safeguards [skip ci]

* [comment audit] clarify rich Markdown source and selection safeguards [skip ci]

* [comment audit] clarify editor loading and emulator stream lifetimes [skip ci]

* [comment audit] trim emulator and feature tour narration [skip ci]

* [comment audit] clarify floating workspace and GitHub cache ownership [skip ci]

* [comment audit] trim provider controls and Linear filter explanations [skip ci]

* [comment audit] clarify pairing and chat resume lifetimes [skip ci]

* [comment audit] clarify chat delivery and transcript lifetimes [skip ci]

* [comment audit] clarify session options and host-owned status [skip ci]

* [comment audit] clarify draft durability and live-status precedence [skip ci]

* [comment audit] Trim chat send and model ownership explanations [skip ci]

* [comment audit] Shorten transcript ownership and send recovery comments [skip ci]

* [comment audit] Simplify native chat composer and transcript hook comments [skip ci]

* [comment audit] Shorten native chat scroll and structured session explanations [skip ci]

* [comment audit] Trim workspace picker and onboarding commentary [skip ci]

* [comment audit] Simplify pet rendering, review cache and quick open comments [skip ci]

* [comment audit] Trim sidebar and session history explanations [skip ci]

* [comment audit] Condense session resume and review checks comments [skip ci]

* [comment audit] Shorten checks state and file explorer refresh comments [skip ci]

* [comment audit] Trim plugin bridge and source-control action rationale [skip ci]

* [comment audit] Trim source-control listing and review rationale [skip ci]

* [comment audit] Shorten sidebar lifecycle and explorer safeguards [skip ci]

* [comment audit] Condense Settings account and appearance rationale [skip ci]

* [comment audit] Trim pairing and repository Settings explanations [skip ci]

* [comment audit] Condense Settings search SSH and terminal safeguards [skip ci]

* [comment audit] Shorten Settings voice and provider ownership comments [skip ci]

* [comment audit] Condense Settings draft persistence and host-state rationale [skip ci]

* [comment audit] Trim Settings hooks and sidebar setup rationale [skip ci]

* [comment audit] Condense sidebar deletion and board-filter safeguards [skip ci]

* [comment audit] Condense worktree cards, host ownership and Markdown contracts [skip ci]

* [comment audit] Condense sidebar drag, folder and filtering contracts [skip ci]

* [comment audit] Condense sidebar parity, sleep and host ownership contracts [skip ci]

* [comment audit] Prune focus-read baseline after comment cleanup

* [comment audit] Clarify sidebar visibility, board drops and agent evidence [skip ci]

* [comment audit] Tighten sidebar listing, drag and reveal contracts [skip ci]

* [comment audit] Clarify viewport geometry and skill update safeguards [skip ci]

* [comment audit] Tighten skill inventory, usage and host status comments [skip ci]

* [comment audit] Clarify usage ownership and resource kill safeguards [skip ci]

* [comment audit] Tighten tab selection, rename and search contracts [skip ci]

* [comment audit] Tighten tab-strip geometry and drag ownership comments [skip ci]

* [comment audit] Tighten Tasks recovery, pagination and mutation comments [skip ci]

* [comment audit] Tighten provider loading and terminal recovery comments [skip ci]

* [comment audit] Tighten completion, cadence and PTY ownership comments [skip ci]

* [comment audit] Clarify terminal restore and parked-pane boundaries [skip ci]

* [comment audit] Tighten PTY startup and replay explanations [skip ci]

* [comment audit] Clarify PTY identity and delivery ownership [skip ci]

* [comment audit] Shorten remote reconnect and input replay rationale [skip ci]

* [comment audit] Condense terminal parking clipboard and file link comments [skip ci]

* [comment audit] Clarify IME ownership and trim trace history [skip ci]

* [comment audit] Shorten pane recovery and parked watcher explanations [skip ci]

* [comment audit] Condense snapshot replay and visibility recovery rationale [skip ci]

* [comment audit] Shorten terminal parking and keyboard ownership rationale [skip ci]

* [comment audit] Trim renderer lifecycle and menu rationale [skip ci]

* [comment audit] Condense workspace cleanup ownership and settlement notes [skip ci]

* [comment audit] Clarify renderer hook evidence and source ownership [skip ci]

* [comment audit] Tighten IPC ownership and reconnect explanations [skip ci]

* [comment audit] Trim renderer focus, paste and attention comments [skip ci]

* [comment audit] Shorten scroll, locale and agent lifecycle comments [skip ci]

* [comment audit] Trim agent launch, resume and ownership commentary [skip ci]

* [comment audit] Shorten account, browser and editor comments [skip ci]

* [comment audit] Clarify host-mirror waits, previews and input ownership [skip ci]

* [comment audit] Condense launch recovery and editor tokenization comments [skip ci]

* [comment audit] Condense workspace selection and terminal pane rationale [skip ci]

* [comment audit] Condense terminal fitting and rendering recovery comments [skip ci]

* [comment audit] Condense terminal input and host routing explanations [skip ci]

* [comment audit] Condense ownership and sleeping-session recovery rationale [skip ci]

* [comment audit] Condense structured launch and terminal link explanations [skip ci]

* [comment audit] Condense terminal ownership and workspace file routing rationale [skip ci]

* [comment audit] Condense session persistence and workspace activation rationale [skip ci]

* [comment audit] Condense workspace routing and browser ownership rationale [skip ci]

* [comment audit] Condense mirror recovery and layout authority rationale [skip ci]

* [comment audit] Condense runtime transport and file safety rationale [skip ci]

* [comment audit] Condense runtime graph and structured session rationale [skip ci]

* [comment audit] Condense browser creation and remote tab recovery rationale [skip ci]

* [comment audit] Condense snapshot authority and publisher recovery rationale [skip ci]

* [comment audit] Condense frame, startup and provider cache rationale [skip ci]

* [comment audit] Condense host twin and agent lifecycle rationale [skip ci]

* [comment audit] Condense browser authority and editor cleanup rationale [skip ci]

* [comment audit] Condense editor buffer identity and review cache rationale [skip ci]

* [comment audit] Condense provider lifetime and repository ownership rationale [skip ci]

* [comment audit] Condense reconnect, hydration and terminal retirement rationale [skip ci]

* [comment audit] Condense recovery, reconciliation and persistence rationale [skip ci]

* [comment audit] Condense cleanup ownership and listing admission rationale [skip ci]

* [comment audit] Condense teardown ordering and terminal ownership rationale [skip ci]

* [comment audit] Condense recovery ledger and web host-boundary rationale [skip ci]

* [comment audit] Condense web reconnect and credential lifecycle rationale [skip ci]

* [comment audit] Condense cloud rollout and assignment safety rationale [skip ci]

* [comment audit] Condense relay session and database recovery rationale [skip ci]

* [comment audit] Condense relay placement and protocol compatibility rationale [skip ci]

* [comment audit] Condense build and packaging constraints [skip ci]

* [comment audit] Condense CI gates and validation isolation rationale [skip ci]

* [comment audit] Condense catalog identity and browser validation rationale [skip ci]

* [comment audit] Condense mobile browser and frame-budget rationale [skip ci]

* [comment audit] Shorten mobile route and browser test explanations [skip ci]

* [comment audit] Condense editor and session seam test rationale [skip ci]

* [comment audit] Trim session and terminal closure history [skip ci]

* [comment audit] Shorten terminal browser and census explanations [skip ci]

* [comment audit] Preserve root-only E2E diagnostic baseline

* [comment audit] Condense mobile seam and HTML preview test rationale [skip ci]

* [comment audit] Condense preview instrumentation and render harness rationale [skip ci]

* [comment audit] Condense bundle contracts and native-build constraints [skip ci]

* [comment audit] Shorten native packaging and CI routing rationale [skip ci]

* [comment audit] Condense release tooling and benchmark constraints [skip ci]

* [comment audit] Condense packaging and platform gate rationale [skip ci]

* [comment audit] Shorten mobile route and history rationale [skip ci]

* [comment audit] Condense mobile browser and component rationale [skip ci]

* [comment audit] Shorten drawer and workspace-form rationale [skip ci]

* [comment audit] Trim mobile review and editor-document explanations [skip ci]

* [comment audit] Condense editor lifecycle and Markdown explanations [skip ci]

* [comment audit] Trim mobile file, diagnostics and dictation commentary [skip ci]

* [comment audit] Simplify mobile host-list and workspace-view explanations [skip ci]

* [comment audit] Clarify mobile shell lifetime and bridge delivery constraints [skip ci]

* [comment audit] Condense bridge stream, native request and audio rationale [skip ci]

* [comment audit] Reduce bridge schema and page-client commentary [skip ci]

* [comment audit] Tighten mobile page bridge contracts [skip ci]

* [comment audit] Clarify mobile cache and session constraints [skip ci]

* [comment audit] Condense mobile route and lifecycle rationale [skip ci]

* [comment audit] Tighten mobile shell hook timing rationale [skip ci]

* [comment audit] Clarify route handoff and notification compatibility [skip ci]

* [comment audit] Clarify push registration and dictation cleanup constraints [skip ci]

* [comment audit] Condense keyboard geometry and native media ownership rationale [skip ci]

* [comment audit] Tighten mobile chat scroll and composer concurrency rationale [skip ci]

* [comment audit] Condense mobile reply compatibility and upload ownership rationale [skip ci]

* [comment audit] Condense optimistic echo and scroll ownership rationale [skip ci]

* [comment audit] Tighten stream replay and queued session ownership rationale [skip ci]

* [comment audit] Condense mobile composer and reply-schema constraints [skip ci]

* [comment audit] Clarify mobile transcript recovery and session ownership [skip ci]

* [comment audit] Clarify mobile queue and source-control compatibility [skip ci]

* [comment audit] Condense storage and task launch constraints [skip ci]

* [comment audit] Clarify task schemas and terminal document ownership [skip ci]

* [comment audit] Tighten terminal input and viewport rationale [skip ci]

* [comment audit] Shorten terminal and RPC recorder contracts [skip ci]

* [comment audit] Condense recorder engine and connection contracts [skip ci]

* [comment audit] Shorten host credential and relay recovery comments [skip ci]

* [comment audit] Tighten pairing recovery and bundle transport rationale [skip ci]

* [comment audit] Clarify RPC delivery and workspace catalog boundaries [skip ci]

* [comment audit] Condense catalog and relay entry contracts [skip ci]

* [comment audit] Shorten shutdown and SSH relay delivery contracts [skip ci]

* [comment audit] Condense WSL relay and E2E regression rationale [skip ci]

* [comment audit] Shorten cross-version harness and renderer fixture explanations [skip ci]

* [comment audit] Condense paired-host and E2E lifecycle rationale [skip ci]

* [comment audit] Shorten layout oracle and regression explanations [skip ci]

* [comment audit] Condense paired recovery and ownership regression contracts [skip ci]

* [comment audit] Shorten restart, sidebar and SSH lifecycle contracts [skip ci]

* [comment audit] Condense terminal rendering and IME regression rationale [skip ci]

* [comment audit] Shorten terminal recovery and benchmark contracts [skip ci]

* [comment audit] Condense tooling and Windows lifecycle proof rationale [skip ci]

* [comment audit] Condense workflow routing and release rationale [skip ci]

* [comment audit] Condense mobile security and installer contracts [skip ci]

* [comment audit] Shorten native rationale and stylesheet workarounds [skip ci]

* [comment audit] Shorten Windows visibility probe rationale [skip ci]

* [comment audit] Condense embedded release and signing rationale [skip ci]

* [comment audit] Retain current main test behavior in final reconciliation [skip ci]

* [comment audit] Complete final comment review across current source inventory

* [comment audit] Handle consolidated audit reports before final CI

* [comment audit] Preserve credential storage census detail [skip ci]

* [comment audit] Scale broad changed E2E selections with verified timing shards

* [comment audit] Align E2E assertions with browser close and settled session metadata

* [comment audit] Match existing E2Es to current resource and windowing contracts

* [comment audit] Observe the shared server outage notice in reconnect coverage

* [comment audit] Make existing renderer probes measure settled tab and PTY work

* [comment audit] Align palette E2E selector with task search

* [comment audit] Refresh remaining palette search selectors

* [comment audit] Keep selector correction within selected audit specs

* [comment audit] Await emoji fixture settings inside renderer evaluation

* [comment audit] Cancel fixture fit retries between terminal tests

---------

Co-authored-by: OrcaWin <293788423+OrcaWin@users.noreply.github.com>
2026-10-25 04:05:46 -07:00

278 lines
9.2 KiB
TypeScript

import { extractLeadingEnvAssignments } from './command-environment'
// Share prompt wording between renderer preview/tests and main generation.
const COMMIT_MESSAGE_BASE_PROMPT = `You are generating a single git commit message.
Read the staged diff below and produce the message.
Rules:
- First line: imperative mood, <= 72 chars, no trailing period.
- Optional body: blank line, then wrapped at 72 chars explaining WHY.
- Output ONLY the commit message - no preamble, no code fences, no quotes.
- Do not include "Co-authored-by" or other git trailers.
Staged diff:
\`\`\`diff
{{DIFF}}
\`\`\`
`
export {
cleanGeneratedCommitMessage,
excerptAgentFailureOutput,
sanitizeAgentFailureDetail,
stripPrefilledReasoningPreamble
} from './commit-message-agent-output'
/** Append custom suffix verbatim so user style instructions can override defaults. */
export function buildCommitPrompt(diff: string, customSuffix: string): string {
const base = COMMIT_MESSAGE_BASE_PROMPT.replace('{{DIFF}}', diff)
const trimmedSuffix = customSuffix.trim()
if (!trimmedSuffix) {
return base
}
return `${base}\n\nAdditional user prompt:\n${trimmedSuffix}`
}
export const STAGED_DIFF_BYTE_BUDGET = 200_000
/** Split at diff --git headers while retaining boundary newlines so concatenation exactly reproduces input. */
function splitDiffIntoFileSections(diff: string): string[] {
const boundary = '\ndiff --git '
const sections: string[] = []
let start = 0
let next = diff.indexOf(boundary)
while (next !== -1) {
// Assign the boundary newline to the preceding section; the next begins with its header.
sections.push(diff.slice(start, next + 1))
start = next + 1
next = diff.indexOf(boundary, start)
}
sections.push(diff.slice(start))
return sections
}
/** Clip to a UTF-16 budget, preferring whole lines unless one would consume most of the allowance; include an omission marker. */
function clipSectionOnLineBoundary(section: string, limit: number): string {
if (section.length <= limit) {
return section
}
if (limit <= 0) {
return ''
}
const markerFor = (omitted: number): string => `\n...(diff truncated, ${omitted} bytes omitted)\n`
let marker = markerFor(section.length)
if (marker.length >= limit) {
return marker.slice(0, limit)
}
// Reserve headroom for the marker, then back up to the previous newline unless
// that would discard most of the budget (one very long line).
const target = limit - marker.length
const lineBreak = section.lastIndexOf('\n', target)
const cut = lineBreak > target / 2 ? lineBreak : target
const omitted = section.length - cut
marker = markerFor(omitted)
return `${section.slice(0, Math.min(cut, Math.max(0, limit - marker.length)))}${marker}`
}
/** Redistribute unused per-file shares so one huge generated file cannot starve smaller human-authored changes. */
function allocateBudgetFairly(sizes: number[], budget: number): number[] {
const alloc: number[] = Array.from({ length: sizes.length }, () => 0)
let active = sizes.map((_, i) => i)
let remaining = budget
while (active.length > 0 && remaining > 0) {
const share = Math.floor(remaining / active.length)
if (share === 0) {
break
}
const stillActive: number[] = []
for (const i of active) {
const need = sizes[i] - alloc[i]
const grant = Math.min(need, share)
alloc[i] += grant
remaining -= grant
if (grant < need) {
stillActive.push(i)
}
}
active = stillActive
}
return alloc
}
/** Share the UTF-16 budget across files and prefer line boundaries; an oversized file cannot crowd out the others. */
export function truncateDiffForPrompt(
diff: string,
budget: number = STAGED_DIFF_BYTE_BUDGET
): string {
if (diff.length <= budget) {
return diff
}
const sections = splitDiffIntoFileSections(diff)
if (sections.length <= 1) {
return clipSectionOnLineBoundary(diff, budget)
}
const allocations = allocateBudgetFairly(
sections.map((section) => section.length),
budget
)
return sections.map((section, i) => clipSectionOnLineBoundary(section, allocations[i])).join('')
}
export const CUSTOM_PROMPT_PLACEHOLDER = '{prompt}'
/** Original [start,end) offsets. divergesFromShell marks operators, leading #, expansion openers spanning tokens, or cmd single quotes; token values alone cannot recover these hazards. */
export type CommandTokenSpan = { start: number; end: number; divergesFromShell: boolean }
export type TokenizeCustomCommandResult =
| { ok: true; tokens: string[]; spans: CommandTokenSpan[] }
| { ok: false; error: string }
// Group POSIX-style quotes/escapes only; never expand variables, substitutions, globs or home paths. Spawn exact argv without cross-platform shell semantics.
/** Default escape consumes the next character; literal preserves native-Windows path separators (#11375). Select by execution target, not process.platform, because parsing and execution may happen on different hosts. */
export type CommandTemplateBackslash = 'escape' | 'literal'
export function tokenizeCustomCommandTemplate(
template: string,
backslash: CommandTemplateBackslash = 'escape'
): TokenizeCustomCommandResult {
const backslashEscapes = backslash === 'escape'
const tokens: string[] = []
const spans: CommandTokenSpan[] = []
let current = ''
let inToken = false
let tokenStart = 0
let divergesFromShell = false
let quote: '"' | "'" | null = null
let i = 0
while (i < template.length) {
const ch = template[i]
if (quote) {
if (backslashEscapes && ch === '\\' && quote === '"' && i + 1 < template.length) {
// Shell double quotes consume escapes only before these characters; other escapes diverge from this tokenizer.
divergesFromShell ||= !'$`"\\'.includes(template[i + 1])
current += template[i + 1]
i += 2
continue
}
// Expansion bodies can reopen nested shell quotes, invalidating tokenizer word boundaries.
divergesFromShell ||=
quote === '"' && (ch === '`' || (ch === '$' && '({'.includes(template[i + 1] ?? '\0')))
if (ch === quote) {
quote = null
i++
// Adjacent quoted/unquoted pieces form one token (a"b"c becomes abc).
inToken = true
continue
}
current += ch
i++
continue
}
if (ch === '"' || ch === "'") {
quote = ch
if (!inToken) {
tokenStart = i
}
inToken = true
i++
continue
}
if (backslashEscapes && ch === '\\' && i + 1 < template.length) {
// Unquoted continuation joins words the shell splits, potentially hiding a selector from gap checks.
divergesFromShell ||= template[i + 1] === '\n'
current += template[i + 1]
if (!inToken) {
tokenStart = i
}
inToken = true
i += 2
continue
}
if (/\s/.test(ch)) {
if (inToken) {
tokens.push(current)
spans.push({ start: tokenStart, end: i, divergesFromShell })
current = ''
inToken = false
divergesFromShell = false
}
i++
continue
}
if (!inToken) {
tokenStart = i
}
// An unpaired trailing escape would swallow appended content; reject the base as unsafe to extend.
divergesFromShell ||= backslashEscapes && ch === '\\' && i + 1 >= template.length
divergesFromShell ||=
';&|<>`'.includes(ch) ||
(ch === '#' && !inToken) ||
(ch === '$' && '({\'"'.includes(template[i + 1] ?? '\0'))
current += ch
inToken = true
i++
}
if (quote) {
return { ok: false, error: 'Unclosed quote in command template.' }
}
if (inToken) {
tokens.push(current)
spans.push({ start: tokenStart, end: template.length, divergesFromShell })
}
return { ok: true, tokens, spans }
}
export type CustomCommandPlan =
| {
ok: true
binary: string
args: string[]
stdinPayload: string | null
env?: Record<string, string>
}
| { ok: false; error: string }
/** Substitute prompt as one argv value regardless of placeholder quoting; without a placeholder send it on stdin. Tokenization groups only, with no shell. */
export function planCustomCommand(
template: string,
prompt: string,
backslash: CommandTemplateBackslash = 'escape'
): CustomCommandPlan {
const tokenized = tokenizeCustomCommandTemplate(template, backslash)
if (!tokenized.ok) {
return { ok: false, error: tokenized.error }
}
if (tokenized.tokens.length === 0) {
return { ok: false, error: 'Custom command is empty.' }
}
const { env, rest: commandTokens } = extractLeadingEnvAssignments(tokenized.tokens)
const [binary, ...rest] = commandTokens
if (!binary) {
return { ok: false, error: 'Custom command must start with a binary name.' }
}
const substitute = (token: string): string =>
token.includes(CUSTOM_PROMPT_PLACEHOLDER)
? token.split(CUSTOM_PROMPT_PLACEHOLDER).join(prompt)
: token
const usesPlaceholder = commandTokens.some((t) => t.includes(CUSTOM_PROMPT_PLACEHOLDER))
if (usesPlaceholder) {
return {
ok: true,
binary: substitute(binary),
args: rest.map(substitute),
stdinPayload: null,
...(env ? { env } : {})
}
}
return { ok: true, binary, args: rest, stdinPayload: prompt, ...(env ? { env } : {}) }
}