Skip to content

Update CHANGELOG.md to mention limbo resolution throttling #2864

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Apr 6, 2020
Merged

Update CHANGELOG.md to mention limbo resolution throttling #2864

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
42ad868
Update CHANGELOG.md to mention limbo resolution throttling
dconeybe Apr 3, 2020
52e8a98
Merge remote-tracking branch 'origin/master' into LimboThrottlingChan…
dconeybe Apr 3, 2020
ae72155
Re-word change log entry as suggested in code review
dconeybe Apr 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/firestore/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# Unreleased
- [changed] Limbo resolution now attempts to resolve a maximum of 100 documents
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changelogs are hard. They end up in our release notes: https://firebase.google.com/support/release-notes/js so they should be comprehensible by our end users.

This note has some problems:

  • "Limbo resolution" is not an end-user concept we've documented.
  • There's too much detail ("resource exhausted", 15,000)
  • It links to the PR and the issue we're fixing, when one is sufficient

So the way to write this is to think about what we're doing on users' behalf when performing limbo resolution. At a high level we're "resolving cache inconsistencies" or "resolving inconsistencies in the local cache".

How about:

Firestore now limits the number of concurrent document lookups it will perform when resolving inconsistencies in the local cache (#2683).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. I like how you said the same thing with 50% fewer words :)

at a time, instead of resolving all at once (#2790). This addresses an issue
where the server can fail with "resource exhausted" errors if a large number
of documents are in limbo (e.g. 15,000), which can lead to the pathological
client behavior seen in #2683.
- [changed] Changed the in-memory representation of Firestore documents to
reduce memory allocations and improve performance. Calls to
`DocumentSnapshot.getData()` and `DocumentSnapshot.toObject()` will see
Expand Down