fix: don't emit error event during stream handoff #1592
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
danieljbruce
reviewed
May 2, 2024
There was a problem hiding this comment.
Thanks @leahecole. I don't know much about the internals of gax, but the outcome in the description is exactly what we need for retries to work upstream.
|
I'll take a look at the system test failure on Monday! |
sofisl
reviewed
May 8, 2024
| // retryStream must be destroyed here for the stream handoff part of retries to function properly | ||
| // but the error event should not be passed - if it emits as part of .destroy() | ||
| // it will bubble up early to the caller | ||
| retryStream.destroy(); |
There was a problem hiding this comment.
Future idea, this will be a great place to add some tracing whenever we add that.
sofisl
approved these changes
May 8, 2024
leahecole
added
the
owlbot:run
gcf-owl-bot
bot
removed
the
owlbot:run
leahecole
added
the
owlbot:run
gcf-owl-bot
bot
removed
the
owlbot:run
Merged
This was referenced Jul 18, 2024
This was referenced Aug 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fixes b/338064353
OLD BEHAVIOR: in
streamingRetryRequest.tsas part ofonResponse, an'error'event would be emitted while the retryStream is being destroyed. This event (usually the first error event in a retry sequence) would be bubbled up to the caller as part of the stream handoff that happens in retries where the old stream is destroyed, a new one is created, and events are forwarded. The call would still resume afterwards and continue successfully, but that error would be raised when it shouldn't have beenNEW BEHAVIOR: The stream is still destroyed, but no error event is emitted. Stream handoff is the same as before, call continues, and the only errors that would be bubbled up to the caller should be ones that are not retry eligible.
This PR makes that one line behavior change and adjusts the test-application to expect that behavior. Our tests beforehand were doing error handling that is atypical of what a client would do (we were either ignoring errors or checking info about them before raising them, which should be handled at the gax level)
Major thanks to @danieljbruce for noticing the resulting behavior and raising it.