Skip to content

fix: restore type safety on streaming chunk schema #21831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
peda-cos wants to merge 2 commits into
base: dev
Choose a base branch
from
+36 −37
Open

fix: restore type safety on streaming chunk schema #21831

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8b1390
fix: restore type safety on streaming chunk schema
peda-cos Apr 10, 2026
0c9e4fa
Merge branch 'dev' into dev
peda-cos Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 36 additions & 37 deletions packages/opencode/src/provider/sdk/copilot/chat/openai-compatible-chat-language-model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,7 +383,6 @@ export class OpenAICompatibleChatLanguageModel implements LanguageModelV3 {
controller.enqueue({ type: "stream-start", warnings })
},

// TODO we lost type safety on Chunk, most likely due to the error schema. MUST FIX
transform(chunk, controller) {
// Emit raw chunk if requested (before anything else)
if (options.includeRawChunks) {
Expand All @@ -399,20 +398,21 @@ export class OpenAICompatibleChatLanguageModel implements LanguageModelV3 {
controller.enqueue({ type: "error", error: chunk.error })
return
}
const value = chunk.value

metadataExtractor?.processChunk(chunk.rawValue)

// handle error chunks:
if ("error" in value) {
if ("error" in chunk.value) {
finishReason = {
unified: "error",
raw: undefined,
}
controller.enqueue({ type: "error", error: value.error.message })
controller.enqueue({ type: "error", error: chunk.value.error.message })
return
}

const value = chunk.value as z.infer<typeof chunkBaseSchema>

if (isFirstChunk) {
isFirstChunk = false

Expand Down Expand Up @@ -777,39 +777,38 @@ const OpenAICompatibleChatResponseSchema = z.object({

// limited version of the schema, focussed on what is needed for the implementation
// this approach limits breakages when the API changes and increases efficiency
const createOpenAICompatibleChatChunkSchema = <ERROR_SCHEMA extends z.core.$ZodType>(errorSchema: ERROR_SCHEMA) =>
z.union([
const chunkBaseSchema = z.object({
id: z.string().nullish(),
created: z.number().nullish(),
model: z.string().nullish(),
choices: z.array(
z.object({
id: z.string().nullish(),
created: z.number().nullish(),
model: z.string().nullish(),
choices: z.array(
z.object({
delta: z
.object({
role: z.enum(["assistant"]).nullish(),
content: z.string().nullish(),
// Copilot-specific reasoning fields
reasoning_text: z.string().nullish(),
reasoning_opaque: z.string().nullish(),
tool_calls: z
.array(
z.object({
index: z.number(),
id: z.string().nullish(),
function: z.object({
name: z.string().nullish(),
arguments: z.string().nullish(),
}),
}),
)
.nullish(),
})
delta: z
.object({
role: z.enum(["assistant"]).nullish(),
content: z.string().nullish(),
// Copilot-specific reasoning fields
reasoning_text: z.string().nullish(),
reasoning_opaque: z.string().nullish(),
tool_calls: z
.array(
z.object({
index: z.number(),
id: z.string().nullish(),
function: z.object({
name: z.string().nullish(),
arguments: z.string().nullish(),
}),
}),
)
.nullish(),
finish_reason: z.string().nullish(),
}),
),
usage: openaiCompatibleTokenUsageSchema,
})
.nullish(),
finish_reason: z.string().nullish(),
}),
errorSchema,
])
),
usage: openaiCompatibleTokenUsageSchema,
})

const createOpenAICompatibleChatChunkSchema = <ERROR_SCHEMA extends z.core.$ZodType>(errorSchema: ERROR_SCHEMA) =>
z.union([chunkBaseSchema, errorSchema])
Loading