fix: update grpc based ReadObject rpcs to remove race condition between cancellation and message handling #2708
Conversation
This file contains hidden or 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
product-auto-label bot added size: l 
BenWhitehead commented Sep 13, 2024
| private final class LazyServerStreamIterator implements Iterator<ReadObjectResponse>, Closeable { | ||
| private ServerStream<ReadObjectResponse> serverStream; | ||
| private Iterator<ReadObjectResponse> responseIterator; | ||
| private final class ReadObjectObserver extends StateCheckingResponseObserver<ReadObjectResponse> { |
Collaborator Author
There was a problem hiding this comment.
Unfortunately, git thinks this class is a modification of the previous LazyServerStreamIterator except it's a whole new class.
Rather than comparing this class to what was there before, evaluate this class as brand new.
Collaborator Author
There was a problem hiding this comment.
This is loosely modeled on the https://github.com/googleapis/sdk-platform-java/blob/2447513ce8a93632d2ff1878e717f4c914717bb3/gax-java/gax/src/main/java/com/google/api/gax/rpc/QueuingResponseObserver.java that was used previously
BenWhitehead force-pushed the zc/gapic-removal branch from c8cf09f to 6aa1ac1 Compare 
…en cancellation and message handling Update GapicUnbufferedReadableByteChannel to manage the grpc stream itself rather than using the stream iterator provided by gax. This allows us to ensure the cancellation is observed and our draining performs before returning from close(). As a side effect of not using the gax stream iterator, we now must handle stream restarts ourselves. GrpcStorageOptions.ReadObjectResumptionStrategy has been removed entirely, while RetryingDependencies and ResultRetryAlgorithm are now plumbed all the way down to the GapicUnbufferedReadableByteChannel.
BenWhitehead force-pushed the zc/gapic-removal branch from 6aa1ac1 to 4f3fd43 Compare 
sydney-munro added the kokoro:force-run 
yoshi-kokoro removed the kokoro:force-run 
sydney-munro approved these changes Sep 19, 2024
lqiu96 pushed a commit that referenced this pull request Sep 23, 2024
…en cancellation and message handling (#2708) Update GapicUnbufferedReadableByteChannel to manage the grpc stream itself rather than using the stream iterator provided by gax. This allows us to ensure the cancellation is observed and our draining performs before returning from close(). As a side effect of not using the gax stream iterator, we now must handle stream restarts ourselves. GrpcStorageOptions.ReadObjectResumptionStrategy has been removed entirely, while RetryingDependencies and ResultRetryAlgorithm are now plumbed all the way down to the GapicUnbufferedReadableByteChannel.
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.
Update GapicUnbufferedReadableByteChannel to manage the grpc stream itself rather than using the stream iterator provided by gax. This allows us to ensure the cancellation is observed and our draining performs before returning from close().
As a side effect of not using the gax stream iterator, we now must handle stream restarts ourselves. GrpcStorageOptions.ReadObjectResumptionStrategy has been removed entirely, while RetryingDependencies and ResultRetryAlgorithm are now plumbed all the way down to the GapicUnbufferedReadableByteChannel.