Skip to content

Update CHANGELOG.md #1198

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 6 commits into from
Sep 6, 2018
Merged

Update CHANGELOG.md #1198

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2df3a38
Update CHANGELOG.md
schmidt-sebastian Sep 5, 2018
429c5ef
Update CHANGELOG.md
schmidt-sebastian Sep 5, 2018
7fc8337
Update CHANGELOG.md
schmidt-sebastian Sep 5, 2018
ff513fe
Review feedback
schmidt-sebastian Sep 5, 2018
a5163c1
Remove spaces
schmidt-sebastian Sep 5, 2018
93a47b3
Merge branch 'master' into schmidt-sebastian-changelog
schmidt-sebastian Sep 5, 2018
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
7 changes: 6 additions & 1 deletion packages/firestore/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# Unreleased
# Unreleased (0.8.1)
- [changed] The internal handling for locally updated documents that haven't yet
Copy link
Contributor

Choose a reason for hiding this comment

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

Most of these notes start with the verb (i.e. "Changed" in this case).

If possible it would be worthwhile to vaguely describe what the differences might be. Something like: SnapshotMetadata.hasPendingWrites may now be cleared earlier than it used to (or whatever the actual change is).

One key difference here is that after restart an acknowledged but unobserved document will have hasPendingWrites: false but fromCache: true. Should we make note that users wanting to make sure documents are non-dirty should check for either condition?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated Changelog per our discussion:

  • Changed the wording slightly to start with "Changed", but didn't mention the restart case since that hasn't actually changed in behavior. I also shied away from adding more detail since it is really hard to describe to external users.
  • Added a section on how we no longer rebase mutations as we get outdated document updates.

been read back from Firestore has changed. This can lead to slight behavior
changes and may affect the `SnapshotMetadata.hasPendingWrites` metadata flag.

# 0.7.1
- [fixed] Fixed a regression that prevented use of Firestore on ReactNative's
Expo platform (#1138).

Expand Down