fix: do not release client before retry #870
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
googlebot
added
the
cla: yes
schmidt-sebastian
changed the title
Codecov Report
@@ Coverage Diff @@
## master #870 +/- ##
=========================================
- Coverage 94.9% 94.9% -0.01%
=========================================
Files 25 25
Lines 15198 15200 +2
Branches 1125 1128 +3
=========================================
+ Hits 14424 14425 +1
Misses 767 767
- Partials 7 8 +1
Continue to review full report at Codecov.
|
dev/src/index.ts
Outdated
| @@ -1181,6 +1183,7 @@ export class Firestore { | |||
| */ | |||
| private _initializeStream( | |||
| backendStream: Duplex, | |||
| liftime: Deferred<void>, | |||
There was a problem hiding this comment.
typo, liftime vs lifetime?
alexander-fenster
approved these changes
Jan 11, 2020
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.
Addresses #829
I think there is a potential problem with stream retry in the existing client. I wasn't able to write a test that hit the scenario, but I can try to put it into words.
In the existing code, requestStream() takes a client object out of the client pool and then calls retry(). There are two Promises that manage all the logic: Result and Lifetime. Since there are separate, it is possible that result.reject() is called (causing a retry) just before lifetime.resolve() is called, which returns the client back to the pool. We then retry with a client that was already returned to the pool, which - if the use is unlucky - is a client that was already garbage collected.
The change in this PR reverses the order: Each retry attempt fetches its own client from the pool, and thus the lifetime is now bound to the length of a single retry attempt.