Files
orca/src/shared/structured-agent-session-composer.ts
T
Brennan Benson bb44f74d00 Keep native chat /clear in the same conversation (#26579)
* Keep clear in the same chat and reset its provider context

* Derive clear pauses only from journal membership and cover older rewind clients

* Point queued command rewind test at the structured hook

* Group queue consume errors and rewind replay assertions
2026-10-08 16:00:29 -07:00

237 lines
8.8 KiB
TypeScript

import {
getHostClaimedNativeChatCommands,
getTextDrivenNativeChatCommands
} from './native-chat-agent-profiles'
import type { AgentType } from './agent-status-types'
import type { SessionOptionDescriptor, SessionOptionValue } from './native-chat-session-options'
import type { SlashCommandSuggestion } from './native-chat-slash-commands'
import type { AgentSessionConversationCommand } from './agent-session-conversation-command'
const MODEL_COMMAND: SlashCommandSuggestion = {
name: 'model',
description: 'Choose the model'
}
const EFFORT_COMMAND: SlashCommandSuggestion = {
name: 'effort',
description: 'Choose reasoning effort'
}
const CONVERSATION_COMMANDS: readonly SlashCommandSuggestion[] = [
{ name: 'clear', description: 'Clear conversation context' },
{ name: 'compact', description: 'Compact conversation context' }
]
/** Session options remain available on hosts predating conversation commands. */
export const STRUCTURED_AGENT_SESSION_SLASH_COMMANDS: readonly SlashCommandSuggestion[] = [
MODEL_COMMAND,
EFFORT_COMMAND
]
export type StructuredAgentSessionComposerOptions = {
agent?: AgentType
snapshot: readonly SessionOptionDescriptor[]
invokeAction: (id: string) => Promise<boolean>
setOption: (id: string, value: SessionOptionValue) => Promise<boolean>
conversationCommands?: readonly AgentSessionConversationCommand[]
runConversationCommand?: (
command: AgentSessionConversationCommand
) => Promise<Omit<StructuredAgentSessionCommandOutcome, 'handled'>>
/** Present only where the host can set this session's goal; otherwise `/goal`
* stays message text the agent acts on itself. */
setThreadGoalObjective?: (objective: string) => Promise<boolean>
}
/** What the chat shows a refused command waiting on: the agent working, a pending prompt, its
* background tasks, a message of this window's still being sent, or one showing its Retry. */
export type StructuredAgentSessionCommandRefusalCause =
| 'working'
| 'prompt'
| 'background'
| 'sending'
| 'retry'
export type StructuredAgentSessionCommandOutcome = {
handled: boolean
accepted: boolean
error: string | null
/** The refusal is said only while this still holds. */
refusedWhile?: StructuredAgentSessionCommandRefusalCause
}
function commandParts(text: string): { name: string; argument: string } | null {
if (!text.startsWith('/')) {
return null
}
const match = /^\/([^\s]+)(?:\s+(.*))?$/.exec(text.trimEnd())
return match ? { name: match[1]!.toLowerCase(), argument: match[2]?.trim() ?? '' } : null
}
/** The commands the composer menu offers when the host reports no catalog of its
* own: the host's own commands, plus the ones this agent acts on from message
* text. Both are honored — the first here, the second by the agent — so a menu
* pick is never answered with "not available". */
export function structuredSlashCommands(
commands: readonly AgentSessionConversationCommand[] = [],
agent?: AgentType | null
): readonly SlashCommandSuggestion[] {
const hostOwned = [
...STRUCTURED_AGENT_SESSION_SLASH_COMMANDS,
...CONVERSATION_COMMANDS.filter((entry) =>
commands.includes(entry.name as AgentSessionConversationCommand)
)
]
// Why: a host with no catalog to report would otherwise hide the commands the
// agent itself implements, e.g. Codex's `/goal`.
return [
...hostOwned,
...getTextDrivenNativeChatCommands(agent).filter(
(entry) => !hostOwned.some((offered) => offered.name === entry.name)
)
]
}
/** Wider than the offered menu on purpose: a TUI-only command still has to be
* claimed here and answered, or a hand-typed `/clear` reaches the model as
* literal prompt text. Commands the agent itself implements are deliberately
* absent — the profile unclaims those so they pass through as text. */
function structuredRecognizedCommands(agent: AgentType): readonly SlashCommandSuggestion[] {
return [
...STRUCTURED_AGENT_SESSION_SLASH_COMMANDS,
...CONVERSATION_COMMANDS,
...getHostClaimedNativeChatCommands(agent)
]
}
/** Whether the chat host, rather than the agent, owns this command. Callers also
* use it to refuse attachments: a host command sends no message, so attachments
* would be silently dropped, whereas a pass-through command is a real send. */
export function isStructuredAgentSessionComposerCommand(
text: string,
agent: AgentType = 'codex'
): boolean {
const command = commandParts(text)
return Boolean(
command && structuredRecognizedCommands(agent).some((entry) => entry.name === command.name)
)
}
/** `/clear` or `/compact` alone: a conversation command with nothing after it. */
export function isLoneStructuredAgentSessionConversationCommand(text: string): boolean {
const command = commandParts(text.trim())
return Boolean(
command &&
command.argument === '' &&
CONVERSATION_COMMANDS.some((entry) => entry.name === command.name)
)
}
/** `/goal …`, which the host answers only where it can set this session's goal. */
export function isStructuredAgentSessionGoalCommand(text: string): boolean {
return commandParts(text)?.name === 'goal'
}
/** `/clear`, `/compact` and `/goal …` change the conversation; option and picker commands do not. */
export function structuredAgentSessionCommandChangesConversation(text: string): boolean {
const command = commandParts(text)
return (
command?.name === 'clear' ||
command?.name === 'compact' ||
(command?.name === 'goal' && command.argument !== '')
)
}
/** `/goal` with nothing after it: an entrance to goal mode, not an objective. */
export function isBareStructuredAgentSessionGoalCommand(text: string): boolean {
const command = commandParts(text)
return command?.name === 'goal' && command.argument === ''
}
/** The objective a goal-mode draft names. A `/goal …` typed there out of habit
* names the same objective it would outside goal mode, never the literal command. */
export function structuredAgentSessionGoalObjective(text: string): string {
const command = commandParts(text)
return command?.name === 'goal' ? command.argument : text.trim()
}
function unavailable(name: string): StructuredAgentSessionCommandOutcome {
return {
handled: true,
accepted: true,
error: `/${name} is not available in chat sessions. Use the slash menu to see available commands.`
}
}
export async function dispatchStructuredAgentSessionComposerCommand(
text: string,
controller: StructuredAgentSessionComposerOptions
): Promise<StructuredAgentSessionCommandOutcome> {
const command = commandParts(text)
if (command?.name === 'goal' && controller.setThreadGoalObjective) {
if (!command.argument) {
return { handled: true, accepted: false, error: 'Describe the goal after /goal.' }
}
// A refusal reaches the user through the session's own error surface.
return {
handled: true,
accepted: await controller.setThreadGoalObjective(command.argument),
error: null
}
}
if (!command || !isStructuredAgentSessionComposerCommand(text, controller.agent)) {
return { handled: false, accepted: false, error: null }
}
if (command.name === 'clear' || command.name === 'compact') {
if (command.argument) {
return { handled: true, accepted: false, error: `Use /${command.name} without arguments.` }
}
if (
!controller.conversationCommands?.includes(command.name) ||
!controller.runConversationCommand
) {
return {
handled: true,
accepted: false,
error: `/${command.name} is not supported by this chat host.`
}
}
return { handled: true, ...(await controller.runConversationCommand(command.name)) }
}
if (command.name !== 'model' && command.name !== 'effort') {
return unavailable(command.name)
}
const descriptor = controller.snapshot.find((entry) => entry.id === command.name)
if (!descriptor || descriptor.kind.type !== 'select') {
return {
handled: true,
accepted: true,
error: `${command.name === 'model' ? 'Models' : 'Reasoning effort'} are unavailable for this chat session.`
}
}
if (!command.argument) {
const opened = await controller.invokeAction(command.name)
return {
handled: true,
accepted: opened,
error: opened ? null : `Could not open the ${command.name} picker.`
}
}
const normalized = command.argument.toLowerCase()
const choice = descriptor.kind.choices.find(
(entry) => entry.value.toLowerCase() === normalized || entry.label.toLowerCase() === normalized
)
if (!choice) {
return {
handled: true,
accepted: false,
error: `${command.argument} is not an available ${command.name} for this chat session.`
}
}
const applied = await controller.setOption(command.name, choice.value)
return {
handled: true,
accepted: applied,
error: applied ? null : `Could not apply ${command.name} ${choice.label}.`
}
}