Skip to content
TypeScript

fix(opencode): text generation errors explain known provider failures without raw provider text (#29877)

Alex Southwell68c38b959ae8
diff --git a/packages/provider-opencode/src/server/textGeneration.test.ts b/packages/provider-opencode/src/server/textGeneration.test.ts
index 10694ef45ef..a5a74402578 100644
--- a/packages/provider-opencode/src/server/textGeneration.test.ts
+++ b/packages/provider-opencode/src/server/textGeneration.test.ts
@@ -456,6 +456,67 @@ it.layer(layerOpenCodeTextGenerationTest)("OpenCodeTextGeneration", (it) => {
),
);
+ it.effect(
+ "maps OpenCode prompt errors to fixed details and keeps provider text in the cause",
+ () =>
+ Effect.forEach(
+ [
+ {
+ error: {
+ name: "APIError",
+ data: {
+ message: "Org quota secret-org exceeded",
+ statusCode: 429,
+ isRetryable: true,
+ },
+ },
+ rawText: "secret-org",
+ detail: "The model provider's usage or rate limit was reached. Try again later.",
+ },
+ {
+ error: {
+ name: "APIError",
+ data: {
+ message: "<none>",
+ statusCode: 503,
+ isRetryable: true,
+ responseBody: "<title>Upstream gateway secret-host</title>",
+ },
+ },
+ rawText: "secret-host",
+ detail: "The model provider failed the request (HTTP 503).",
+ },
+ {
+ error: { name: "UnknownError", data: { message: "Provider stack trace secret-token" } },
+ rawText: "secret-token",
+ detail: "OpenCode could not generate the text.",
+ },
+ ],
+ (testCase) =>
+ withOpenCodeTextGeneration(DEFAULT_OPENCODE_SETTINGS, (textGeneration) =>
+ Effect.gen(function* () {
+ runtimeMock.state.promptResult = {
+ data: { info: { error: testCase.error }, parts: [] },
+ };
+
+ const error = yield* textGeneration
+ .generateCommitMessage(DEFAULT_COMMIT_MESSAGE_INPUT)
+ .pipe(Effect.flip);
+
+ expect(error.detail).toBe(testCase.detail);
+ expect(error.message).not.toContain(testCase.rawText);
+ expect(error.cause).toMatchObject({
+ _tag: "OpenCodeTextGenerationPromptResponseError",
+ providerErrorName: testCase.error.name,
+ cause: testCase.error,
+ });
+ expect((error.cause as Error).message).not.toContain(testCase.rawText);
+ }),
+ ),
+ { discard: true },
+ ),
+ );
+
it.effect("deletes the session when the prompt request rejects", () =>
withOpenCodeTextGeneration(DEFAULT_OPENCODE_SETTINGS, (textGeneration) =>
Effect.gen(function* () {
diff --git a/packages/provider-opencode/src/server/textGeneration.ts b/packages/provider-opencode/src/server/textGeneration.ts
index ab8d41f1568..570d2ebf6e2 100644
--- a/packages/provider-opencode/src/server/textGeneration.ts
+++ b/packages/provider-opencode/src/server/textGeneration.ts
@@ -70,15 +70,40 @@ export class OpenCodeTextGenerationPromptResponseError extends Schema.TaggedErro
{
...openCodePromptErrorContext,
providerErrorName: Schema.optional(Schema.String),
- providerMessage: Schema.String,
+ statusCode: Schema.optional(Schema.Int),
+ cause: Schema.Defect(),
},
) {
override get message(): string {
const providerError = this.providerErrorName ? ` ${this.providerErrorName}` : "";
- return `OpenCode prompt${providerError} failed for ${this.operation} in ${this.cwd} using ${this.providerId}/${this.modelId} (session ${this.sessionId}): ${this.providerMessage}`;
+ const status = this.statusCode === undefined ? "" : `, HTTP ${this.statusCode}`;
+ return `OpenCode prompt${providerError} failed for ${this.operation} in ${this.cwd} using ${this.providerId}/${this.modelId} (session ${this.sessionId}${status}).`;
}
}
+function openCodePromptResponseErrorDetail(error: OpenCodeTextGenerationPromptResponseError) {
+ if (
+ error.providerErrorName === "ProviderAuthError" ||
+ error.statusCode === 401 ||
+ error.statusCode === 403
+ ) {
+ return "The model provider rejected the credentials. Check the provider's sign-in or API key in OpenCode.";
+ }
+ if (error.statusCode === 429) {
+ return "The model provider's usage or rate limit was reached. Try again later.";
+ }
+ if (error.providerErrorName === "ContextOverflowError") {
+ return "The prompt is too long for the selected model's context window.";
+ }
+ if (error.providerErrorName === "MessageAbortedError") {
+ return "OpenCode stopped the generation.";
+ }
+ if (error.statusCode !== undefined) {
+ return `The model provider failed the request (HTTP ${error.statusCode}).`;
+ }
+ return "OpenCode could not generate the text.";
+}
+
export class OpenCodeTextGenerationEmptyOutputError extends Schema.TaggedError<OpenCodeTextGenerationEmptyOutputError>()(
"OpenCodeTextGenerationEmptyOutputError",
{
@@ -94,7 +119,7 @@ export class OpenCodeTextGenerationEmptyOutputError extends Schema.TaggedError<O
interface OpenCodePromptFailure {
readonly name?: string;
- readonly message: string;
+ readonly statusCode?: number;
}
interface OpenCodeTextPart {
@@ -111,26 +136,21 @@ function getOpenCodePromptFailure(error: unknown): OpenCodePromptFailure | null
"name" in error && typeof error.name === "string" && error.name.trim().length > 0
? error.name.trim()
: undefined;
- const message =
- "data" in error &&
- error.data &&
- typeof error.data === "object" &&
- "message" in error.data &&
- typeof error.data.message === "string"
- ? error.data.message.trim()
- : "";
- if (message.length > 0) {
- return {
- ...(name ? { name } : {}),
- message,
- };
- }
-
- if (name) {
- return { name, message: name };
+ const data = "data" in error && error.data && typeof error.data === "object" ? error.data : {};
+ const statusCode =
+ "statusCode" in data && typeof data.statusCode === "number" && Number.isInteger(data.statusCode)
+ ? data.statusCode
+ : undefined;
+ const hasMessage =
+ "message" in data && typeof data.message === "string" && data.message.trim().length > 0;
+ if (!name && statusCode === undefined && !hasMessage) {
+ return null;
}
- return null;
+ return {
+ ...(name ? { name } : {}),
+ ...(statusCode !== undefined ? { statusCode } : {}),
+ };
}
function isOpenCodeTextPart(part: unknown): part is OpenCodeTextPart {
@@ -263,12 +283,16 @@ export const makeOpenCodeTextGeneration = Effect.fn("makeOpenCodeTextGeneration"
),
),
);
- const promptFailure = getOpenCodePromptFailure(result.data?.info?.error);
+ const promptError = result.data?.info?.error;
+ const promptFailure = getOpenCodePromptFailure(promptError);
if (promptFailure) {
return yield* new OpenCodeTextGenerationPromptResponseError({
...promptContext,
...(promptFailure.name ? { providerErrorName: promptFailure.name } : {}),
- providerMessage: promptFailure.message,
+ ...(promptFailure.statusCode !== undefined
+ ? { statusCode: promptFailure.statusCode }
+ : {}),
+ cause: promptError,
});
}
const responseParts = result.data?.parts ?? [];
@@ -312,7 +336,7 @@ export const makeOpenCodeTextGeneration = Effect.fn("makeOpenCodeTextGeneration"
Effect.fail(
new TextGenerationError({
operation: cause.operation,
- detail: cause.providerMessage,
+ detail: openCodePromptResponseErrorDetail(cause),
cause,
}),
),