Skip to content

fix: clamp negative Retry-After delays before sleeping #855

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
abhinavkr26104 wants to merge 1 commit into
base: main
Choose a base branch
from
+114 −1
Open

fix: clamp negative Retry-After delays before sleeping #855

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion openai-java-core/src/main/kotlin/com/openai/core/http/RetryingHttpClient.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ private constructor(
}
?.let { retryAfterNanos ->
// If the API asks us to wait a certain amount of time, do what it says.
return Duration.ofNanos(retryAfterNanos.toLong())
return Duration.ofNanos(retryAfterNanos.toLong().coerceAtLeast(0))
}

// Apply exponential backoff, but not more than the max.
Expand Down
113 changes: 113 additions & 0 deletions openai-java-core/src/test/kotlin/com/openai/core/http/RetryingHttpClientTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,119 @@ internal class RetryingHttpClientTest {
assertNoResponseLeaks()
}

@ParameterizedTest
@ValueSource(booleans = [false, true])
fun execute_withNegativeRetryAfterHeader(async: Boolean) {
stubFor(
post(urlPathEqualTo("/something"))
.inScenario("negative-retry-after")
.whenScenarioStateIs(Scenario.STARTED)
.willReturn(serviceUnavailable().withHeader("Retry-After", "-1"))
.willSetStateTo("RETRY")
)
stubFor(
post(urlPathEqualTo("/something"))
.inScenario("negative-retry-after")
.whenScenarioStateIs("RETRY")
.willReturn(ok())
)
val sleeper = RecordingSleeper()
val retryingClient = retryingHttpClientBuilder(sleeper).maxRetries(1).build()

val response =
retryingClient.execute(
HttpRequest.builder()
.method(HttpMethod.POST)
.baseUrl(baseUrl)
.addPathSegment("something")
.build(),
async,
)

assertThat(response.statusCode()).isEqualTo(200)
verify(2, postRequestedFor(urlPathEqualTo("/something")))
assertThat(sleeper.durations).containsExactly(Duration.ZERO)
assertNoResponseLeaks()
}

@ParameterizedTest
@ValueSource(booleans = [false, true])
fun execute_withNegativeRetryAfterMsHeader(async: Boolean) {
stubFor(
post(urlPathEqualTo("/something"))
.inScenario("negative-retry-after-ms")
.whenScenarioStateIs(Scenario.STARTED)
.willReturn(serviceUnavailable().withHeader("Retry-After-Ms", "-1"))
.willSetStateTo("RETRY")
)
stubFor(
post(urlPathEqualTo("/something"))
.inScenario("negative-retry-after-ms")
.whenScenarioStateIs("RETRY")
.willReturn(ok())
)
val sleeper = RecordingSleeper()
val retryingClient = retryingHttpClientBuilder(sleeper).maxRetries(1).build()

val response =
retryingClient.execute(
HttpRequest.builder()
.method(HttpMethod.POST)
.baseUrl(baseUrl)
.addPathSegment("something")
.build(),
async,
)

assertThat(response.statusCode()).isEqualTo(200)
verify(2, postRequestedFor(urlPathEqualTo("/something")))
assertThat(sleeper.durations).containsExactly(Duration.ZERO)
assertNoResponseLeaks()
}

@ParameterizedTest
@ValueSource(booleans = [false, true])
fun execute_withPastRetryAfterDate(async: Boolean) {
val retryAfterDate = "Wed, 21 Oct 2015 07:28:00 GMT"
val clock =
Clock.fixed(
OffsetDateTime.parse(retryAfterDate, DateTimeFormatter.RFC_1123_DATE_TIME)
.plusSeconds(1)
.toInstant(),
ZoneOffset.UTC,
)
stubFor(
post(urlPathEqualTo("/something"))
.inScenario("past-retry-after-date")
.whenScenarioStateIs(Scenario.STARTED)
.willReturn(serviceUnavailable().withHeader("Retry-After", retryAfterDate))
.willSetStateTo("RETRY")
)
stubFor(
post(urlPathEqualTo("/something"))
.inScenario("past-retry-after-date")
.whenScenarioStateIs("RETRY")
.willReturn(ok())
)
val sleeper = RecordingSleeper()
val retryingClient = retryingHttpClientBuilder(sleeper, clock).maxRetries(1).build()

val response =
retryingClient.execute(
HttpRequest.builder()
.method(HttpMethod.POST)
.baseUrl(baseUrl)
.addPathSegment("something")
.build(),
async,
)

assertThat(response.statusCode()).isEqualTo(200)
verify(2, postRequestedFor(urlPathEqualTo("/something")))
assertThat(sleeper.durations).containsExactly(Duration.ZERO)
assertNoResponseLeaks()
}

@ParameterizedTest
@ValueSource(booleans = [false, true])
fun execute_withRetryableException(async: Boolean) {
Expand Down