Skip to content

fix: tolerate post-completion stream events in ResponseAccumulator #719

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

fix: tolerate post-completion stream events in ResponseAccumulator #719

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
8 changes: 7 additions & 1 deletion openai-java-core/src/main/kotlin/com/openai/helpers/ResponseAccumulator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,13 @@ class ResponseAccumulator private constructor() {
* accumulated. A [ResponseAccumulator] can only be used to accumulate a single [Response].
*/
fun accumulate(event: ResponseStreamEvent): ResponseStreamEvent {
check(response == null) { "Response has already been completed." }
// The API may send non-terminal events (e.g. `response.rate_limits.updated`) after a
// terminal event (`response.completed`, `response.failed`, `response.incomplete`).
// These events do not carry response data and are safe to ignore. Throwing here would
// break callers that pass every streamed event to the accumulator.
if (response != null) {
return event
}

event.accept(
object : ResponseStreamEvent.Visitor<Unit> {
Expand Down
13 changes: 7 additions & 6 deletions openai-java-core/src/test/kotlin/com/openai/helpers/ResponseAccumulatorTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,16 +62,17 @@ internal class ResponseAccumulatorTest {
}

@Test
fun accumulateAfterCompleted() {
fun accumulateAfterCompletedIgnoresPostCompletionEvents() {
val accumulator = ResponseAccumulator.create()

accumulator.accumulate(ResponseStreamEvent.ofCompleted(responseCompletedEvent()))

assertThatThrownBy {
accumulator.accumulate(ResponseStreamEvent.ofCompleted(responseCompletedEvent()))
}
.isExactlyInstanceOf(IllegalStateException::class.java)
.hasMessage("Response has already been completed.")
// Post-completion events (e.g. `response.rate_limits.updated`) should be silently
// ignored rather than throwing. The original response should remain intact.
assertThatNoException().isThrownBy {
accumulator.accumulate(ResponseStreamEvent.ofCreated(responseCreatedEvent()))
}
assertThat(accumulator.response().id()).isEqualTo("response-id")
}

@Test
Expand Down