Skip to content

Commit c789868

Browse files
authored
fix(opencode): cap session retries with jitter (#41939)
1 parent d470434 commit c789868

2 files changed

Lines changed: 46 additions & 7 deletions

File tree

‎packages/opencode/src/session/retry.ts‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,10 @@ export type Retryable = {
2525

2626
export const RETRY_INITIAL_DELAY = 2000
2727
export const RETRY_BACKOFF_FACTOR = 2
28+
export const RETRY_JITTER_FACTOR = 0.25
2829
export const RETRY_MAX_DELAY_NO_HEADERS = 30_000 // 30 seconds
2930
export const RETRY_MAX_DELAY = 2_147_483_647 // max 32-bit signed integer for setTimeout
31+
export const RETRY_MAX_RETRIES = 5
3032

3133
const RETRYABLE_MESSAGE_PATTERNS = [
3234
/429|500|502|503|504|524/i,
@@ -41,7 +43,7 @@ function cap(ms: number) {
4143
return Math.min(ms, RETRY_MAX_DELAY)
4244
}
4345

44-
export function delay(attempt: number, error?: SessionV1.APIError) {
46+
export function delay(attempt: number, error?: SessionV1.APIError, random = Math.random()) {
4547
if (error) {
4648
const headers = error.data.responseHeaders
4749
if (headers) {
@@ -67,11 +69,16 @@ export function delay(attempt: number, error?: SessionV1.APIError) {
6769
}
6870
}
6971

70-
return cap(RETRY_INITIAL_DELAY * Math.pow(RETRY_BACKOFF_FACTOR, attempt - 1))
72+
return cap(exponential(attempt, random))
7173
}
7274
}
7375

74-
return cap(Math.min(RETRY_INITIAL_DELAY * Math.pow(RETRY_BACKOFF_FACTOR, attempt - 1), RETRY_MAX_DELAY_NO_HEADERS))
76+
return cap(Math.min(exponential(attempt, random), RETRY_MAX_DELAY_NO_HEADERS))
77+
}
78+
79+
function exponential(attempt: number, random: number) {
80+
const base = RETRY_INITIAL_DELAY * Math.pow(RETRY_BACKOFF_FACTOR, attempt - 1)
81+
return Math.ceil(base + base * RETRY_JITTER_FACTOR * random)
7582
}
7683

7784
export function retryable(error: Err, provider: string) {
@@ -182,6 +189,7 @@ export function policy(opts: {
182189
const error = opts.parse(meta.input)
183190
const retry = retryable(error, opts.provider)
184191
if (!retry) return Cause.done(meta.attempt)
192+
if (meta.attempt > RETRY_MAX_RETRIES) return Cause.done(meta.attempt)
185193
return Effect.gen(function* () {
186194
const wait = delay(meta.attempt, SessionV1.APIError.isInstance(error) ? error : undefined)
187195
const now = yield* Clock.currentTimeMillis

‎packages/opencode/test/session/retry.test.ts‎

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,18 @@ function wrap(message: unknown): ReturnType<NamedError["toObject"]> {
3535
describe("session.retry.delay", () => {
3636
test("caps delay at 30 seconds when headers missing", () => {
3737
const error = apiError()
38-
const delays = Array.from({ length: 10 }, (_, index) => SessionRetry.delay(index + 1, error))
38+
const delays = Array.from({ length: 10 }, (_, index) => SessionRetry.delay(index + 1, error, 0))
3939
expect(delays).toStrictEqual([2000, 4000, 8000, 16000, 30000, 30000, 30000, 30000, 30000, 30000])
4040
})
4141

42+
test("adds jitter to exponential delays", () => {
43+
const error = apiError()
44+
expect(SessionRetry.delay(1, error, 0)).toBe(2000)
45+
expect(SessionRetry.delay(1, error, 1)).toBe(2500)
46+
expect(SessionRetry.delay(4, error, 1)).toBe(20000)
47+
expect(SessionRetry.delay(5, error, 1)).toBe(30000)
48+
})
49+
4250
test("prefers retry-after-ms when shorter than exponential", () => {
4351
const error = apiError({ "retry-after-ms": "1500" })
4452
expect(SessionRetry.delay(4, error)).toBe(1500)
@@ -59,18 +67,18 @@ describe("session.retry.delay", () => {
5967

6068
test("ignores invalid retry hints", () => {
6169
const error = apiError({ "retry-after": "not-a-number" })
62-
expect(SessionRetry.delay(1, error)).toBe(2000)
70+
expect(SessionRetry.delay(1, error, 0)).toBe(2000)
6371
})
6472

6573
test("ignores malformed date retry hints", () => {
6674
const error = apiError({ "retry-after": "Invalid Date String" })
67-
expect(SessionRetry.delay(1, error)).toBe(2000)
75+
expect(SessionRetry.delay(1, error, 0)).toBe(2000)
6876
})
6977

7078
test("ignores past date retry hints", () => {
7179
const pastDate = new Date(Date.now() - 5000).toUTCString()
7280
const error = apiError({ "retry-after": pastDate })
73-
expect(SessionRetry.delay(1, error)).toBe(2000)
81+
expect(SessionRetry.delay(1, error, 0)).toBe(2000)
7482
})
7583

7684
test("uses retry-after values even when exceeding 10 minutes with headers", () => {
@@ -115,6 +123,29 @@ describe("session.retry.delay", () => {
115123
})
116124
}),
117125
)
126+
127+
it.instance("policy stops after five retries", () =>
128+
Effect.gen(function* () {
129+
const attempts: number[] = []
130+
const error = apiError({ "retry-after-ms": "0" })
131+
const step = yield* Schedule.toStepWithMetadata(
132+
SessionRetry.policy({
133+
provider: "test",
134+
parse: Schema.decodeUnknownSync(SessionV1.APIError.Schema),
135+
set: (info) =>
136+
Effect.sync(() => {
137+
attempts.push(info.attempt)
138+
}),
139+
}),
140+
)
141+
142+
yield* Effect.forEach(Array.from({ length: SessionRetry.RETRY_MAX_RETRIES + 1 }), () =>
143+
Effect.ignore(step(error)),
144+
)
145+
146+
expect(attempts).toStrictEqual([1, 2, 3, 4, 5])
147+
}),
148+
)
118149
})
119150

120151
describe("session.retry.retryable", () => {

0 commit comments

Comments
 (0)