Skip to content

Commit 0f9fe12

Browse files
fix: clamp negative Retry-After delays before sleeping (#855)
## Summary - clamp parsed `Retry-After` and `Retry-After-Ms` delays to `Duration.ZERO` when they are negative - preserve immediate retries for past HTTP-date values - add sync and async regression coverage for negative numeric delays and past dates Fixes #853 ## Testing - `git diff --check` passed - direct ktfmt 0.61 validation passed for both changed Kotlin files - full Gradle test suite was attempted online and offline; the online run timed out during Kotlin/Gradle execution without diagnostics, while the offline run was blocked by uncached `junit-jupiter-engine:5.9.3` - repository lint tasks were attempted; direct ktfmt passed, while Gradle lint was blocked by the same local dependency/compile environment Co-authored-by: Dan Piet <[email protected]>
1 parent fe00c01 commit 0f9fe12

2 files changed

Lines changed: 114 additions & 1 deletion

File tree

‎openai-java-core/src/main/kotlin/com/openai/core/http/RetryingHttpClient.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ private constructor(
213213
}
214214
?.let { retryAfterNanos ->
215215
// If the API asks us to wait a certain amount of time, do what it says.
216-
return Duration.ofNanos(retryAfterNanos.toLong())
216+
return Duration.ofNanos(retryAfterNanos.toLong().coerceAtLeast(0))
217217
}
218218

219219
// Apply exponential backoff, but not more than the max.

‎openai-java-core/src/test/kotlin/com/openai/core/http/RetryingHttpClientTest.kt‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,119 @@ internal class RetryingHttpClientTest {
301301
assertNoResponseLeaks()
302302
}
303303

304+
@ParameterizedTest
305+
@ValueSource(booleans = [false, true])
306+
fun execute_withNegativeRetryAfterHeader(async: Boolean) {
307+
stubFor(
308+
post(urlPathEqualTo("/something"))
309+
.inScenario("negative-retry-after")
310+
.whenScenarioStateIs(Scenario.STARTED)
311+
.willReturn(serviceUnavailable().withHeader("Retry-After", "-1"))
312+
.willSetStateTo("RETRY")
313+
)
314+
stubFor(
315+
post(urlPathEqualTo("/something"))
316+
.inScenario("negative-retry-after")
317+
.whenScenarioStateIs("RETRY")
318+
.willReturn(ok())
319+
)
320+
val sleeper = RecordingSleeper()
321+
val retryingClient = retryingHttpClientBuilder(sleeper).maxRetries(1).build()
322+
323+
val response =
324+
retryingClient.execute(
325+
HttpRequest.builder()
326+
.method(HttpMethod.POST)
327+
.baseUrl(baseUrl)
328+
.addPathSegment("something")
329+
.build(),
330+
async,
331+
)
332+
333+
assertThat(response.statusCode()).isEqualTo(200)
334+
verify(2, postRequestedFor(urlPathEqualTo("/something")))
335+
assertThat(sleeper.durations).containsExactly(Duration.ZERO)
336+
assertNoResponseLeaks()
337+
}
338+
339+
@ParameterizedTest
340+
@ValueSource(booleans = [false, true])
341+
fun execute_withNegativeRetryAfterMsHeader(async: Boolean) {
342+
stubFor(
343+
post(urlPathEqualTo("/something"))
344+
.inScenario("negative-retry-after-ms")
345+
.whenScenarioStateIs(Scenario.STARTED)
346+
.willReturn(serviceUnavailable().withHeader("Retry-After-Ms", "-1"))
347+
.willSetStateTo("RETRY")
348+
)
349+
stubFor(
350+
post(urlPathEqualTo("/something"))
351+
.inScenario("negative-retry-after-ms")
352+
.whenScenarioStateIs("RETRY")
353+
.willReturn(ok())
354+
)
355+
val sleeper = RecordingSleeper()
356+
val retryingClient = retryingHttpClientBuilder(sleeper).maxRetries(1).build()
357+
358+
val response =
359+
retryingClient.execute(
360+
HttpRequest.builder()
361+
.method(HttpMethod.POST)
362+
.baseUrl(baseUrl)
363+
.addPathSegment("something")
364+
.build(),
365+
async,
366+
)
367+
368+
assertThat(response.statusCode()).isEqualTo(200)
369+
verify(2, postRequestedFor(urlPathEqualTo("/something")))
370+
assertThat(sleeper.durations).containsExactly(Duration.ZERO)
371+
assertNoResponseLeaks()
372+
}
373+
374+
@ParameterizedTest
375+
@ValueSource(booleans = [false, true])
376+
fun execute_withPastRetryAfterDate(async: Boolean) {
377+
val retryAfterDate = "Wed, 21 Oct 2015 07:28:00 GMT"
378+
val clock =
379+
Clock.fixed(
380+
OffsetDateTime.parse(retryAfterDate, DateTimeFormatter.RFC_1123_DATE_TIME)
381+
.plusSeconds(1)
382+
.toInstant(),
383+
ZoneOffset.UTC,
384+
)
385+
stubFor(
386+
post(urlPathEqualTo("/something"))
387+
.inScenario("past-retry-after-date")
388+
.whenScenarioStateIs(Scenario.STARTED)
389+
.willReturn(serviceUnavailable().withHeader("Retry-After", retryAfterDate))
390+
.willSetStateTo("RETRY")
391+
)
392+
stubFor(
393+
post(urlPathEqualTo("/something"))
394+
.inScenario("past-retry-after-date")
395+
.whenScenarioStateIs("RETRY")
396+
.willReturn(ok())
397+
)
398+
val sleeper = RecordingSleeper()
399+
val retryingClient = retryingHttpClientBuilder(sleeper, clock).maxRetries(1).build()
400+
401+
val response =
402+
retryingClient.execute(
403+
HttpRequest.builder()
404+
.method(HttpMethod.POST)
405+
.baseUrl(baseUrl)
406+
.addPathSegment("something")
407+
.build(),
408+
async,
409+
)
410+
411+
assertThat(response.statusCode()).isEqualTo(200)
412+
verify(2, postRequestedFor(urlPathEqualTo("/something")))
413+
assertThat(sleeper.durations).containsExactly(Duration.ZERO)
414+
assertNoResponseLeaks()
415+
}
416+
304417
@ParameterizedTest
305418
@ValueSource(booleans = [false, true])
306419
fun execute_withRetryableException(async: Boolean) {

0 commit comments

Comments
 (0)