add esc and ctrl-c to cancel

Author: charleslien

cli/src/hooks/use-keyboard-handlers.ts

@@ -49,6 +49,8 @@ export const useKeyboardHandlers = ({
           if (abortControllerRef.current) {
             abortControllerRef.current.abort()
           }
+
+          return
         }
 
         if (isCtrlC) {

cli/src/hooks/use-send-message.ts

@@ -616,6 +616,46 @@ export const useSendMessage = ({
 
       const abortController = new AbortController()
       abortControllerRef.current = abortController
+      abortController.signal.addEventListener('abort', () => {
+        setIsStreaming(false)
+        setCanProcessQueue(true)
+        updateChainInProgress(false)
+        setIsWaitingForResponse(false)
+        timerController.stop('aborted')
+
+        applyMessageUpdate((prev) =>
+          prev.map((msg) => {
+            if (msg.id !== aiMessageId) {
+              return msg
+            }
+
+            const blocks: ContentBlock[] = msg.blocks ? [...msg.blocks] : []
+            const lastBlock = blocks[blocks.length - 1]
+
+            if (lastBlock && lastBlock.type === 'text') {
+              const interruptedBlock: ContentBlock = {
+                type: 'text',
+                content: `${lastBlock.content}\n\n[response interrupted]`,
+              }
+              return {
+                ...msg,
+                blocks: [...blocks.slice(0, -1), interruptedBlock],
+                isComplete: true,
+              }
+            }
+
+            const interruptionNotice: ContentBlock = {
+              type: 'text',
+              content: '[response interrupted]',
+            }
+            return {
+              ...msg,
+              blocks: [...blocks, interruptionNotice],
+              isComplete: true,
+            }
+          }),
+        )
+      })
 
       try {
         // Load local agent definitions from .agents directory
@@ -1306,6 +1346,11 @@ export const useSendMessage = ({
           },
         })
 
+        if (!result.success) {
+          logger.warn({ error: result.error }, 'Agent run failed')
+          return
+        }
+
         setIsStreaming(false)
         setCanProcessQueue(true)
         updateChainInProgress(false)
@@ -1342,8 +1387,6 @@ export const useSendMessage = ({
 
         previousRunStateRef.current = result
       } catch (error) {
-        const isAborted = error instanceof Error && error.name === 'AbortError'
-
         logger.error(
           { error: getErrorObject(error) },
           'SDK client.run() failed',
@@ -1352,61 +1395,26 @@ export const useSendMessage = ({
         setCanProcessQueue(true)
         updateChainInProgress(false)
         setIsWaitingForResponse(false)
-        timerController.stop(isAborted ? 'aborted' : 'error')
-
-        if (isAborted) {
-          applyMessageUpdate((prev) =>
-            prev.map((msg) => {
-              if (msg.id !== aiMessageId) {
-                return msg
-              }
-
-              const blocks: ContentBlock[] = msg.blocks ? [...msg.blocks] : []
-              const lastBlock = blocks[blocks.length - 1]
+        timerController.stop('error')
 
-              if (lastBlock && lastBlock.type === 'text') {
-                const interruptedBlock: ContentBlock = {
-                  type: 'text',
-                  content: `${lastBlock.content}\n\n[response interrupted]`,
-                }
-                return {
+        const errorMessage =
+          error instanceof Error ? error.message : 'Unknown error occurred'
+        applyMessageUpdate((prev) =>
+          prev.map((msg) =>
+            msg.id === aiMessageId
+              ? {
                   ...msg,
-                  blocks: [...blocks.slice(0, -1), interruptedBlock],
-                  isComplete: true,
+                  content: msg.content + `\n\n**Error:** ${errorMessage}`,
                 }
-              }
+              : msg,
+          ),
+        )
 
-              const interruptionNotice: ContentBlock = {
-                type: 'text',
-                content: '[response interrupted]',
-              }
-              return {
-                ...msg,
-                blocks: [...blocks, interruptionNotice],
-                isComplete: true,
-              }
-            }),
-          )
-        } else {
-          const errorMessage =
-            error instanceof Error ? error.message : 'Unknown error occurred'
-          applyMessageUpdate((prev) =>
-            prev.map((msg) =>
-              msg.id === aiMessageId
-                ? {
-                    ...msg,
-                    content: msg.content + `\n\n**Error:** ${errorMessage}`,
-                  }
-                : msg,
-            ),
-          )
-
-          applyMessageUpdate((prev) =>
-            prev.map((msg) =>
-              msg.id === aiMessageId ? { ...msg, isComplete: true } : msg,
-            ),
-          )
-        }
+        applyMessageUpdate((prev) =>
+          prev.map((msg) =>
+            msg.id === aiMessageId ? { ...msg, isComplete: true } : msg,
+          ),
+        )
       }
     },
     [

sdk/src/client.ts

@@ -1,9 +1,10 @@
-import { BACKEND_URL, WEBSITE_URL } from './constants'
+import { WEBSITE_URL } from './constants'
 import { run } from './run'
 import { API_KEY_ENV_VAR } from '../../common/src/old-constants'
 
 import type { RunOptions, CodebuffClientOptions } from './run'
 import type { RunState } from './run-state'
+import type { ErrorOr } from '@codebuff/common/util/error'
 
 export class CodebuffClient {
   public options: CodebuffClientOptions & {
@@ -48,11 +49,13 @@ export class CodebuffClient {
    * @param maxAgentSteps - (Optional) Maximum number of steps the agent can take before stopping. Use this as a safety measure in case your agent starts going off the rails. A reasonable number is around 20.
    * @param env - (Optional) Environment variables to pass to terminal commands executed by the agent. These will be merged with process.env, with the custom values taking precedence. Can also be provided in individual run() calls to override.
    *
-   * @returns A Promise that resolves to a RunState JSON object which you can pass to a subsequent run() call to continue the run. Use result.output to get the agent's output.
+   * @returns A Promise that resolves to one of:
+   * - { "success": true, value: runState } (a RunState JSON object which you can pass to a subsequent run() call to continue the run. Use result.output to get the agent's output.)
+   * - { "success": false, error: error } (a JSON object containing `name`, `message`, and `stack` properties)
    */
   public async run(
     options: RunOptions & CodebuffClientOptions,
-  ): Promise<RunState> {
+  ): Promise<ErrorOr<RunState>> {
     return run({ ...this.options, ...options })
   }
 

sdk/src/index.ts

@@ -2,6 +2,7 @@ export type * from '../../common/src/types/json'
 export type * from '../../common/src/types/messages/codebuff-message'
 export type * from '../../common/src/types/messages/data-content'
 export type * from '../../common/src/types/print-mode'
+export type * from '../../common/src/util/error'
 export type * from './run'
 // Agent type exports
 export type { AgentDefinition } from '../../common/src/templates/initial-agents-dir/types/agent-definition'

sdk/src/run.ts

@@ -7,6 +7,7 @@ import { toOptionalFile } from '@codebuff/common/old-constants'
 import { toolNames } from '@codebuff/common/tools/constants'
 import { clientToolCallSchema } from '@codebuff/common/tools/list'
 import { AgentOutputSchema } from '@codebuff/common/types/session-state'
+import { failure, success } from '@codebuff/common/util/error'
 import { cloneDeep } from 'lodash'
 
 import { getAgentRuntimeImpl } from './impl/agent-runtime'
@@ -44,6 +45,7 @@ import type {
 import type { PrintModeEvent } from '@codebuff/common/types/print-mode'
 import type { SessionState } from '@codebuff/common/types/session-state'
 import type { Source } from '@codebuff/common/types/source'
+import type { ErrorOr, Failure } from '@codebuff/common/util/error'
 
 export type CodebuffClientOptions = {
   apiKey?: string
@@ -98,12 +100,13 @@ export type RunOptions = {
   signal?: AbortSignal
 }
 
-function checkAborted(signal?: AbortSignal) {
-  if (signal?.aborted) {
-    const error = new Error('Run cancelled by user')
-    error.name = 'AbortError'
-    throw error
+function checkAborted(signal?: AbortSignal): Failure | null {
+  if (!signal?.aborted) {
+    return null
   }
+  const error = new Error('Run cancelled by user')
+  error.name = 'AbortError'
+  return failure(error)
 }
 
 type RunReturnType = Awaited<ReturnType<typeof run>>
@@ -137,8 +140,11 @@ export async function run({
   CodebuffClientOptions & {
     apiKey: string
     fingerprintId: string
-  }): Promise<RunState> {
-  checkAborted(signal)
+  }): Promise<ErrorOr<RunState>> {
+  const aborted = checkAborted(signal)
+  if (aborted) {
+    return aborted
+  }
 
   const fs = await (typeof fsSource === 'function' ? fsSource() : fsSource)
 
@@ -168,7 +174,11 @@ export async function run({
   const onResponseChunk = async (
     action: ServerAction<'response-chunk'>,
   ): Promise<void> => {
-    checkAborted(signal)
+    const aborted = checkAborted(signal)
+    if (aborted) {
+      resolve(aborted)
+      return
+    }
     const { chunk } = action
     if (typeof chunk !== 'string') {
       if (chunk.type === 'reasoning') {
@@ -205,7 +215,11 @@ export async function run({
   const onSubagentResponseChunk = async (
     action: ServerAction<'subagent-response-chunk'>,
   ) => {
-    checkAborted(signal)
+    const aborted = checkAborted(signal)
+    if (aborted) {
+      resolve(aborted)
+      return
+    }
     const { agentId, agentType, chunk } = action
 
     if (handleStreamChunk) {
@@ -381,7 +395,10 @@ export async function run({
   const promptId = Math.random().toString(36).substring(2, 15)
 
   // Send input
-  checkAborted(signal)
+  const isAborted = checkAborted(signal)
+  if (isAborted) {
+    return isAborted
+  }
 
   const userInfo = await getUserInfoFromApiKey({
     ...agentRuntimeImpl,
@@ -570,13 +587,15 @@ async function handlePromptResponse({
 }) {
   if (action.type === 'prompt-error') {
     onError({ message: action.message })
-    resolve({
-      sessionState: initialSessionState,
-      output: {
-        type: 'error',
-        message: action.message,
-      },
-    })
+    resolve(
+      failure({
+        sessionState: initialSessionState,
+        output: {
+          type: 'error',
+          message: action.message,
+        },
+      }),
+    )
   } else if (action.type === 'prompt-response') {
     // Stop enforcing session state schema! It's a black box we will pass back to the server.
     // Only check the output schema.
@@ -588,10 +607,7 @@ async function handlePromptResponse({
         'If this issues persists, please contact [email protected]',
       ].join('\n')
       onError({ message })
-      resolve({
-        sessionState: initialSessionState,
-        output: { type: 'error', message },
-      })
+      resolve(failure(new Error(message)))
       return
     }
     const { sessionState, output } = action
@@ -603,18 +619,14 @@ async function handlePromptResponse({
         message: 'No output from agent',
       },
     }
-    resolve(state)
+    resolve(success(state))
   } else {
     action satisfies never
     onError({
       message: 'Internal error: prompt response type not handled',
     })
-    resolve({
-      sessionState: initialSessionState,
-      output: {
-        type: 'error',
-        message: 'Internal error: prompt response type not handled',
-      },
-    })
+    resolve(
+      failure(new Error('Internal error: prompt response type not handled')),
+    )
   }
 }