Skip to content

Commit 6e8e772

Browse files
authored
fix(acp): surface prompt errors (#34061)
1 parent 971518c commit 6e8e772

3 files changed

Lines changed: 136 additions & 26 deletions

File tree

‎packages/opencode/src/acp/error.ts‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ export class UnsupportedOperationError extends Schema.TaggedErrorClass<Unsupport
4646
export class ServiceFailureError extends Schema.TaggedErrorClass<ServiceFailureError>()("ACPServiceFailureError", {
4747
safeMessage: Schema.String,
4848
service: Schema.optional(Schema.String),
49+
errorName: Schema.optional(Schema.String),
4950
}) {}
5051

5152
export type Error =
@@ -81,7 +82,13 @@ export function toRequestError(error: Error) {
8182
case "ACPUnsupportedOperationError":
8283
return RequestError.methodNotFound(error.method)
8384
case "ACPServiceFailureError":
84-
return RequestError.internalError({ service: error.service }, error.safeMessage)
85+
return RequestError.internalError(
86+
{
87+
...(error.service ? { service: error.service } : {}),
88+
...(error.errorName ? { errorName: error.errorName } : {}),
89+
},
90+
error.safeMessage,
91+
)
8592
}
8693
}
8794

‎packages/opencode/src/acp/service.ts‎

Lines changed: 57 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import {
3030
type SetSessionModeResponse,
3131
} from "@agentclientprotocol/sdk"
3232
import { InstallationVersion } from "@opencode-ai/core/installation/version"
33-
import type { Message, OpencodeClient, SessionMessageResponse } from "@opencode-ai/sdk/v2"
33+
import type { AssistantMessage, Message, OpencodeClient, SessionMessageResponse } from "@opencode-ai/sdk/v2"
3434
import { Context, Effect, Layer, ManagedRuntime } from "effect"
3535
import * as ACPError from "./error"
3636
import { buildConfigOptions, parseModelSelection } from "./config-option"
@@ -521,7 +521,7 @@ export function make(input: {
521521
"session",
522522
)
523523
yield* sendUsageUpdate(input.usage, input.sdk, input.connection, current.id, current.cwd)
524-
return promptResponse(response.info, params.messageId)
524+
return yield* promptResponse(response.info, params.messageId)
525525
}
526526

527527
const known = snapshot.availableCommands.find((item) => item.name === command.name)
@@ -543,7 +543,7 @@ export function make(input: {
543543
"session",
544544
)
545545
yield* sendUsageUpdate(input.usage, input.sdk, input.connection, current.id, current.cwd)
546-
return promptResponse(response.info, params.messageId)
546+
return yield* promptResponse(response.info, params.messageId)
547547
}
548548

549549
if (command.name === "compact") {
@@ -563,7 +563,7 @@ export function make(input: {
563563
}
564564

565565
yield* sendUsageUpdate(input.usage, input.sdk, input.connection, current.id, current.cwd)
566-
return promptResponse(undefined, params.messageId)
566+
return yield* promptResponse(undefined, params.messageId)
567567
}),
568568
cancel,
569569
}
@@ -695,7 +695,8 @@ type MessageInfo = {
695695
readonly agent?: Message["agent"]
696696
}
697697

698-
type AssistantInfo = UsageService.AssistantTokenCost | undefined
698+
type AssistantError = NonNullable<AssistantMessage["error"]>
699+
type AssistantInfo = (UsageService.AssistantTokenCost & Pick<AssistantMessage, "error">) | undefined
699700

700701
function request<T>(fn: () => Promise<T | SdkResponse<T>>, service?: string) {
701702
return Effect.tryPromise({
@@ -811,13 +812,60 @@ function detectSlashCommand(parts: ReturnType<typeof promptContentToParts>) {
811812
return { name, args: rest.join(" ").trim() }
812813
}
813814

814-
function promptResponse(info: AssistantInfo, messageId: string | null | undefined): PromptResponse {
815-
return {
816-
stopReason: "end_turn",
817-
...(info ? { usage: UsageService.buildUsage(info) } : {}),
815+
const promptResponse = Effect.fn("ACP.promptResponse")(function* (
816+
info: AssistantInfo,
817+
messageId: string | null | undefined,
818+
) {
819+
if (!info?.error) {
820+
return {
821+
stopReason: "end_turn" as const,
822+
...(info ? { usage: UsageService.buildUsage(info) } : {}),
823+
...(messageId ? { userMessageId: messageId } : {}),
824+
_meta: {},
825+
}
826+
}
827+
828+
const base = {
829+
usage: UsageService.buildUsage(info),
818830
...(messageId ? { userMessageId: messageId } : {}),
819831
_meta: {},
820832
}
833+
834+
if (info.error.name === "MessageAbortedError") {
835+
return {
836+
stopReason: "cancelled" as const,
837+
...base,
838+
}
839+
}
840+
841+
if (info.error.name === "MessageOutputLengthError") {
842+
return {
843+
stopReason: "max_tokens" as const,
844+
...base,
845+
}
846+
}
847+
848+
if (info.error.name === "ContentFilterError") {
849+
return {
850+
stopReason: "refusal" as const,
851+
...base,
852+
}
853+
}
854+
855+
if (info.error.name === "ProviderAuthError") {
856+
return yield* new ACPError.AuthRequiredError({ providerId: info.error.data.providerID })
857+
}
858+
859+
return yield* new ACPError.ServiceFailureError({
860+
service: "session",
861+
safeMessage: promptErrorMessage(info.error),
862+
errorName: info.error.name,
863+
})
864+
})
865+
866+
function promptErrorMessage(error: AssistantError) {
867+
if ("message" in error.data && typeof error.data.message === "string") return error.data.message
868+
return "OpenCode prompt failed"
821869
}
822870

823871
function sendUsageUpdate(

‎packages/opencode/test/acp/service-session.test.ts‎

Lines changed: 71 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import type {
1010
SessionConfigSelectOption,
1111
SetSessionConfigOptionResponse,
1212
} from "@agentclientprotocol/sdk"
13-
import type { OpencodeClient } from "@opencode-ai/sdk/v2"
13+
import type { AssistantMessage, OpencodeClient } from "@opencode-ai/sdk/v2"
1414
import { ProviderV2 } from "@opencode-ai/core/provider"
1515
import { ModelV2 } from "@opencode-ai/core/model"
1616
import { Effect } from "effect"
@@ -144,7 +144,10 @@ const provider: Provider.Info = {
144144
describe("ACP service sessions", () => {
145145
const makeService = (
146146
messages: readonly { info: unknown; parts: readonly unknown[] }[] = [],
147-
options?: { abort?: (input: { sessionID: string }) => Promise<{ data: boolean }> },
147+
options?: {
148+
abort?: (input: { sessionID: string }) => Promise<{ data: boolean }>
149+
prompt?: (input: unknown) => Promise<{ data: { info: ReturnType<typeof assistantInfo> } }>
150+
},
148151
) => {
149152
const updates: SessionNotification[] = []
150153
const mcpAdds: string[] = []
@@ -193,19 +196,21 @@ describe("ACP service sessions", () => {
193196
data: input.directory ? sessions.filter((session) => session.directory === input.directory) : sessions,
194197
}),
195198
messages: () => Promise.resolve({ data: messages }),
196-
prompt: (input: unknown) => {
197-
prompts.push(input)
198-
return Promise.resolve({
199-
data: {
200-
info: assistantInfo({
201-
input: 100,
202-
output: 40,
203-
reasoning: 7,
204-
cache: { read: 11, write: 13 },
205-
}),
206-
},
207-
})
208-
},
199+
prompt:
200+
options?.prompt ??
201+
((input: unknown) => {
202+
prompts.push(input)
203+
return Promise.resolve({
204+
data: {
205+
info: assistantInfo({
206+
input: 100,
207+
output: 40,
208+
reasoning: 7,
209+
cache: { read: 11, write: 13 },
210+
}),
211+
},
212+
})
213+
}),
209214
command: (input: unknown) => {
210215
commands.push(input)
211216
return Promise.resolve({
@@ -994,6 +999,52 @@ describe("ACP service sessions", () => {
994999
expect(usageUpdates).toEqual([session.sessionId])
9951000
})
9961001

1002+
it("maps assistant prompt errors to request errors instead of end turn", async () => {
1003+
const { service } = makeService([], {
1004+
prompt: () =>
1005+
Promise.resolve({
1006+
data: {
1007+
info: assistantInfo(
1008+
{ input: 8, output: 0, reasoning: 0, cache: { read: 0, write: 0 } },
1009+
{ name: "APIError", data: { message: "Provider request failed", isRetryable: false } },
1010+
),
1011+
},
1012+
}),
1013+
})
1014+
const session = await Effect.runPromise(service.newSession({ cwd: "/workspace", mcpServers: [] }))
1015+
1016+
const error = await Effect.runPromise(
1017+
service
1018+
.prompt({ sessionId: session.sessionId, prompt: [{ type: "text", text: "hello" }] })
1019+
.pipe(Effect.mapError(ACPError.toRequestError), Effect.flip),
1020+
)
1021+
1022+
expect(error.code).toBe(-32603)
1023+
expect(error.message).toBe("Internal error: Provider request failed")
1024+
expect(error.data).toEqual({ service: "session", errorName: "APIError" })
1025+
})
1026+
1027+
it("maps aborted assistant prompt errors to cancelled", async () => {
1028+
const { service } = makeService([], {
1029+
prompt: () =>
1030+
Promise.resolve({
1031+
data: {
1032+
info: assistantInfo(
1033+
{ input: 8, output: 1, reasoning: 0, cache: { read: 0, write: 0 } },
1034+
{ name: "MessageAbortedError", data: { message: "Aborted" } },
1035+
),
1036+
},
1037+
}),
1038+
})
1039+
const session = await Effect.runPromise(service.newSession({ cwd: "/workspace", mcpServers: [] }))
1040+
1041+
const result = await Effect.runPromise(
1042+
service.prompt({ sessionId: session.sessionId, prompt: [{ type: "text", text: "hello" }] }),
1043+
)
1044+
1045+
expect(result.stopReason).toBe("cancelled")
1046+
})
1047+
9971048
it("prompt maps assistant and user audience annotations", async () => {
9981049
const { service, prompts } = makeService()
9991050
const session = await Effect.runPromise(service.newSession({ cwd: "/workspace", mcpServers: [] }))
@@ -1145,13 +1196,17 @@ describe("ACP service sessions", () => {
11451196
})
11461197
})
11471198

1148-
function assistantInfo(tokens: UsageService.AssistantTokenCost["tokens"]): UsageService.AssistantMessage {
1199+
function assistantInfo(
1200+
tokens: UsageService.AssistantTokenCost["tokens"],
1201+
error?: AssistantMessage["error"],
1202+
): UsageService.AssistantMessage & Pick<AssistantMessage, "error"> {
11491203
return {
11501204
role: "assistant",
11511205
providerID: "test",
11521206
modelID: "test-model",
11531207
cost: 0,
11541208
tokens,
1209+
...(error ? { error } : {}),
11551210
}
11561211
}
11571212

0 commit comments

Comments
 (0)