-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Update changelog to mention performance improvements in write batches #1534
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Firestore/CHANGELOG.md
Outdated
@@ -4,6 +4,10 @@ | |||
- [feature] Added `whereField(arrayContains:)` query filter to find | |||
documents where an array field contains a specific element. | |||
- [fixed] Fixed compilation with older Xcode versions (#1517). | |||
- [fixed] Fixed performance issue when trying to commit a write batch with many |
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 is more specific than it needs to be and uses internal terminology. I suggest something like the following phrasing:
Fixed a performance issue where large write batches with hundreds of changes would take a long time to read and write and consume excessive memory. Large write batches should now see no penalty.
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.
Also, please include the issue number/numbers if there are any.
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.
Finally, note that you can include the CHANGELOG update in the change that fixes the issue (#1533, right)?
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.
Thanks, I like the rephrasing much better. I don't think there was a Github issue for this change, though.
you can include the CHANGELOG update in the change that fixes the issue
The changes I was trying to describe are #1505 and #1507, already merged.
I've added an entry accounting for #1533 to this PR to avoid merging, though I can also add the relevant entry to #1533 if you prefer.
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.
Putting these here is fine--that was most FYI for the future.
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.
LGTM
Firestore/CHANGELOG.md
Outdated
@@ -4,6 +4,10 @@ | |||
- [feature] Added `whereField(arrayContains:)` query filter to find | |||
documents where an array field contains a specific element. | |||
- [fixed] Fixed compilation with older Xcode versions (#1517). | |||
- [fixed] Fixed performance issue when trying to commit a write batch with many |
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.
Putting these here is fine--that was most FYI for the future.
Reflects #1505, #1507.