Skip to content
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

fix(firestore, web): use enableMultiTabIndexedDbPersistence() API when the user inputs synchronizeTabs as true #10024

Merged
merged 5 commits into from Dec 8, 2022

Conversation

russellwheatley
Copy link
Member

@russellwheatley russellwheatley commented Nov 30, 2022

Description

Firestore web JS has changed its API from synchronizeTabs to forceOwnership. See documentation: https://firebase.google.com/docs/reference/js/firestore_.persistencesettings.md

Related Issues

fixes #9929

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]).
This will ensure a smooth and quick review process. Updating the pubspec.yaml and changelogs is not required.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
  • All existing and new tests are passing.
  • I updated/added relevant documentation (doc comments with ///).
  • The analyzer (melos run analyze) does not report any problems on my PR.
  • I read and followed the Flutter Style Guide.
  • I signed the CLA.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • Yes, this is a breaking change.
  • No, this is not a breaking change.

@Ehesp
Copy link
Member

Ehesp commented Nov 30, 2022

Can we not just deprecate instead of forcing a breaking change?

@russellwheatley russellwheatley changed the title fix(firestore, web)!: change synchronizeTabs to forceOwnership fix(firestore, web): change synchronizeTabs to forceOwnership Nov 30, 2022
@pldelattre
Copy link

Is forceOwnership truly the same as synchronizeTabs ?

forceOwnership description is :
Whether to force enable persistence for the client. This cannot be used with multi-tab synchronization and is primarily intended for use with Web Workers. Setting this to true will enable persistence, but cause other tabs using persistence to fail.

But the goal of synchronizeTabs was to enable multi-tab persistence, wasn't it ?

@pldelattre
Copy link

it seems the right method to call is enableMultiTabIndexedDbPersistence()
Documentation :
https://firebase.google.com/docs/reference/js/firestore_.md#enablemultitabindexeddbpersistence

@russellwheatley russellwheatley changed the title fix(firestore, web): change synchronizeTabs to forceOwnership fix(firestore, web): use enableMultiTabIndexedDbPersistence() API when the user inputs synchronizeTabs as true Dec 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
5 participants