Skip to content

Commit b046973

Browse files
authored
fix(opencode): default header timeout to five minutes (anomalyco#46903)
1 parent 4eb29a6 commit b046973

6 files changed

Lines changed: 47 additions & 40 deletions

File tree

‎packages/core/src/v1/config/provider.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,11 @@ export const Info = Schema.Struct({
108108
headerTimeout: Schema.optional(
109109
Schema.Union([PositiveInt, Schema.Literal(false)]).annotate({
110110
description:
111-
"Timeout in milliseconds to wait for response headers. Provider integrations may set defaults. Set to false to disable timeout.",
111+
"Timeout in milliseconds to wait for response headers (default: 300000). Set to false to disable timeout.",
112112
}),
113113
).annotate({
114114
description:
115-
"Timeout in milliseconds to wait for response headers. Provider integrations may set defaults. Set to false to disable timeout.",
115+
"Timeout in milliseconds to wait for response headers (default: 300000). Set to false to disable timeout.",
116116
}),
117117
chunkTimeout: Schema.optional(
118118
Schema.Union([PositiveInt, Schema.Literal(false)]).annotate({

‎packages/opencode/src/provider/provider.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1793,7 +1793,7 @@ const layer = Layer.effect(
17931793

17941794
const customFetch = options["fetch"]
17951795
const chunkTimeout = options["chunkTimeout"] ?? 300_000
1796-
const headerTimeout = options["headerTimeout"]
1796+
const headerTimeout = options["headerTimeout"] ?? 300_000
17971797
delete options["chunkTimeout"]
17981798
delete options["headerTimeout"]
17991799

‎packages/opencode/test/provider/header-timeout.test.ts‎

Lines changed: 40 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -48,40 +48,46 @@ it.live("headerTimeout does not abort delayed SSE body after headers arrive", ()
4848
}),
4949
)
5050

51-
it.live("default chunkTimeout is applied at fetch without changing provider options", () =>
52-
Effect.gen(function* () {
53-
const server = yield* Effect.acquireRelease(
54-
Effect.promise(() => delayedBodyServer(250)),
55-
(server) => Effect.sync(() => server.server.close()),
56-
)
51+
for (const timeout of ["chunkTimeout", "headerTimeout"] as const) {
52+
it.live(`default ${timeout} is applied at fetch without changing provider options`, () =>
53+
Effect.gen(function* () {
54+
const server = yield* Effect.acquireRelease(
55+
Effect.promise(() => delayedBodyServer(250)),
56+
(server) => Effect.sync(() => server.server.close()),
57+
)
5758

58-
yield* provideTmpdirInstance(
59-
() =>
60-
Effect.gen(function* () {
61-
const provider = yield* Provider.Service
62-
const configured = yield* provider.getProvider(ProviderV2.ID.make("test"))
63-
const signals: (AbortSignal | null | undefined)[] = []
64-
configured.options.fetch = (input: RequestInfo | URL, init?: RequestInit) => {
65-
signals.push(init?.signal)
66-
return fetch(input, init)
67-
}
68-
const model = yield* provider.getModel(ProviderV2.ID.make("test"), ModelV2.ID.make("test-model"))
69-
const language = yield* provider.getLanguage(model)
70-
yield* Effect.acquireRelease(
71-
Effect.promise(() =>
72-
language.doStream({ prompt: [{ role: "user", content: [{ type: "text", text: "hello" }] }] }),
73-
),
74-
(result) => Effect.promise(() => result.stream.cancel()),
75-
)
59+
yield* provideTmpdirInstance(
60+
() =>
61+
Effect.gen(function* () {
62+
const provider = yield* Provider.Service
63+
const configured = yield* provider.getProvider(ProviderV2.ID.make("test"))
64+
const signals: (AbortSignal | null | undefined)[] = []
65+
configured.options.fetch = (input: RequestInfo | URL, init?: RequestInit) => {
66+
signals.push(init?.signal)
67+
return fetch(input, init)
68+
}
69+
const model = yield* provider.getModel(ProviderV2.ID.make("test"), ModelV2.ID.make("test-model"))
70+
const language = yield* provider.getLanguage(model)
71+
yield* Effect.acquireRelease(
72+
Effect.promise(() =>
73+
language.doStream({ prompt: [{ role: "user", content: [{ type: "text", text: "hello" }] }] }),
74+
),
75+
(result) => Effect.promise(() => result.stream.cancel()),
76+
)
7677

77-
expect(signals).toHaveLength(1)
78-
expect(signals[0]).toBeInstanceOf(AbortSignal)
79-
expect(configured.options.chunkTimeout).toBeUndefined()
80-
}),
81-
{ config: providerConfig(server.url) },
82-
)
83-
}),
84-
)
78+
expect(signals).toHaveLength(1)
79+
expect(signals[0]).toBeInstanceOf(AbortSignal)
80+
expect(configured.options[timeout]).toBeUndefined()
81+
}),
82+
{
83+
config: providerConfig(server.url, {
84+
[timeout === "chunkTimeout" ? "headerTimeout" : "chunkTimeout"]: false,
85+
}),
86+
},
87+
)
88+
}),
89+
)
90+
}
8591

8692
it.live("configured chunkTimeout raises a retryable response stream error when SSE body stalls", () =>
8793
Effect.gen(function* () {
@@ -178,7 +184,7 @@ it.live("headerTimeout aborts when response headers do not arrive", () =>
178184
}),
179185
)
180186

181-
it.live("headerTimeout is opt-in for non-OpenAI providers", () =>
187+
it.live("headerTimeout can be disabled with false for non-OpenAI providers", () =>
182188
Effect.gen(function* () {
183189
const server = yield* Effect.acquireRelease(
184190
Effect.promise(() => delayedHeaderServer(100)),
@@ -197,7 +203,7 @@ it.live("headerTimeout is opt-in for non-OpenAI providers", () =>
197203

198204
expect(yield* Effect.promise(() => result.text)).toBe("ok")
199205
}),
200-
{ config: providerConfig(server.url) },
206+
{ config: providerConfig(server.url, { headerTimeout: false }) },
201207
)
202208
}),
203209
)

‎packages/sdk/js/src/v2/gen/types.gen.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1751,7 +1751,7 @@ export type ProviderConfig = {
17511751
*/
17521752
timeout?: number | false
17531753
/**
1754-
* Timeout in milliseconds to wait for response headers. Provider integrations may set defaults. Set to false to disable timeout.
1754+
* Timeout in milliseconds to wait for response headers (default: 300000). Set to false to disable timeout.
17551755
*/
17561756
headerTimeout?: number | false
17571757
/**

‎packages/sdk/openapi.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20780,7 +20780,7 @@
2078020780
"enum": [false]
2078120781
}
2078220782
],
20783-
"description": "Timeout in milliseconds to wait for response headers. Provider integrations may set defaults. Set to false to disable timeout."
20783+
"description": "Timeout in milliseconds to wait for response headers (default: 300000). Set to false to disable timeout."
2078420784
},
2078520785
"chunkTimeout": {
2078620786
"anyOf": [

‎packages/web/src/content/docs/config.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,7 @@ You can configure the providers and models you want to use in your OpenCode conf
374374

375375
The `small_model` option configures a separate model for lightweight tasks like title generation. By default, OpenCode tries to use a cheaper model if one is available from your provider, otherwise it falls back to your main model.
376376

377-
Provider options can include `timeout`, `chunkTimeout`, and `setCacheKey`:
377+
Provider options can include `timeout`, `headerTimeout`, `chunkTimeout`, and `setCacheKey`:
378378

379379
```json title="opencode.json"
380380
{
@@ -392,6 +392,7 @@ Provider options can include `timeout`, `chunkTimeout`, and `setCacheKey`:
392392
```
393393

394394
- `timeout` - Request timeout in milliseconds (default: 300000). Set to `false` to disable.
395+
- `headerTimeout` - Timeout in milliseconds to wait for response headers (default: 300000, or 5 minutes). This timer stops once headers arrive and does not limit the streamed response body. Set to `false` to disable.
395396
- `chunkTimeout` - Timeout in milliseconds between streamed response chunks (default: 300000, or 5 minutes). If no chunk arrives in time, the request is aborted. Set to `false` to disable.
396397
- `setCacheKey` - Ensure a cache key is always set for designated provider.
397398

0 commit comments

Comments
 (0)