fix: Prevent watch stream from emitting events after close. #1471
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| /* | ||
| * Copyright 2023 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.google.cloud.firestore; | ||
|
|
||
| import com.google.api.gax.rpc.BidiStreamObserver; | ||
| import com.google.api.gax.rpc.ClientStream; | ||
| import com.google.api.gax.rpc.StreamController; | ||
| import com.google.firestore.v1.ListenRequest; | ||
| import java.util.function.Function; | ||
| import java.util.logging.Logger; | ||
|
|
||
| final class SuppressibleBidiStream<RequestT, ResponseT> | ||
|
There was a problem hiding this comment. Please add a class level comment to explain what this class does and why it is neccessary. |
||
| implements BidiStreamObserver<RequestT, ResponseT> { | ||
|
|
||
| private final ClientStream<ListenRequest> stream; | ||
| private final BidiStreamObserver<RequestT, ResponseT> delegate; | ||
| private boolean silence = false; | ||
|
There was a problem hiding this comment. Since the class is now call |
||
| private static final Logger LOGGER = Logger.getLogger(Watch.class.getName()); | ||
|
|
||
| SuppressibleBidiStream( | ||
| BidiStreamObserver<RequestT, ResponseT> responseObserverT, | ||
| Function<BidiStreamObserver<RequestT, ResponseT>, ClientStream<ListenRequest>> | ||
| streamSupplier) { | ||
| this.delegate = responseObserverT; | ||
| stream = streamSupplier.apply(this); | ||
| } | ||
|
|
||
| public void send(ListenRequest request) { | ||
| LOGGER.info(stream.toString()); | ||
| stream.send(request); | ||
| } | ||
|
|
||
| public void close() { | ||
| LOGGER.info(stream::toString); | ||
| stream.closeSend(); | ||
| } | ||
|
|
||
| public void closeAndSilence() { | ||
|
There was a problem hiding this comment. Same here, use |
||
| LOGGER.info(stream::toString); | ||
| silence = true; | ||
| stream.closeSend(); | ||
| } | ||
|
|
||
| @Override | ||
| public void onReady(ClientStream<RequestT> stream) { | ||
| if (silence) { | ||
| LOGGER.info(() -> String.format("Silenced: %s", stream)); | ||
|
|
||
| } else { | ||
| delegate.onReady(stream); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void onStart(StreamController controller) { | ||
| if (silence) { | ||
| LOGGER.info(() -> String.format("Silenced: %s", stream)); | ||
| } else { | ||
| delegate.onStart(controller); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void onResponse(ResponseT response) { | ||
| if (silence) { | ||
| LOGGER.info(() -> String.format("Silenced: %s", stream)); | ||
| } else { | ||
| delegate.onResponse(response); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void onError(Throwable t) { | ||
| if (silence) { | ||
| LOGGER.info(() -> String.format("Silenced: %s", stream)); | ||
| } else { | ||
| delegate.onError(t); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void onComplete() { | ||
| if (silence) { | ||
| LOGGER.info(() -> String.format("Silenced: %s", stream)); | ||
| } else { | ||
| delegate.onComplete(); | ||
| } | ||
| } | ||
| } | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| /* | ||
| * Copyright 2023 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.google.cloud.firestore; | ||
|
|
||
| import com.google.api.gax.rpc.BidiStreamObserver; | ||
| import com.google.api.gax.rpc.BidiStreamingCallable; | ||
| import com.google.api.gax.rpc.ClientStream; | ||
|
|
||
| public final class FirestoreSpy { | ||
|
|
||
| public final FirestoreImpl spy; | ||
| public BidiStreamObserver streamRequestBidiStreamObserver; | ||
|
|
||
| public FirestoreSpy(FirestoreOptions firestoreOptions) { | ||
| spy = | ||
| new FirestoreImpl(firestoreOptions) { | ||
| @Override | ||
| public <RequestT, ResponseT> ClientStream<RequestT> streamRequest( | ||
| BidiStreamObserver<RequestT, ResponseT> responseObserverT, | ||
| BidiStreamingCallable<RequestT, ResponseT> callable) { | ||
| streamRequestBidiStreamObserver = responseObserverT; | ||
| return super.streamRequest(responseObserverT, callable); | ||
| } | ||
| }; | ||
| } | ||
| } |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This isn't directly related to PR. But since I was adding logging...
I noticed this log was building a string, even if log level is not fine. A lambda allows lazy evaluation, such that production environments don't suffer work when logging is set to a more coarse level.