fix: bulkWriter: ensure buffered batches are sent after flush #1535
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
product-auto-label
bot
added
the
api: firestore
thebrianchen
changed the title
google-cla
bot
added
the
cla: yes
| * | ||
| * @private | ||
| */ | ||
| class BufferedOperation { |
There was a problem hiding this comment.
Can you just enqueue BulkWriterOperation and make send() public?
There was a problem hiding this comment.
I tried that approach, but that requires storing enqueueOnBatchCallback onto BulkWriterOperation, which doesn't make sense conceptually.
schmidt-sebastian
approved these changes
Jun 16, 2021
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 #1531.
flush()currently does not schedule batches that are buffered, which caused the issue above. If the last batch did not meet the maximum batch size, it would not be sent, causingflush()to never resolve.This PR allows BulkWriter to track when
flush()is called while there are buffered operations and ensures that the batch is flushed even if it is not at the maximum batch size. I'm not a huge fan of adding theBufferedOperation, class but I can't seem to find a clean way to do it. Added a unit test that fails without this logic.