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.

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

Jump to bottom

BUG: using multi-tab persistence, the queries in the secondary tabs don't report metadata.fromCache=false #8314

Closed
atsjo opened this issue Jun 13, 2024 · 7 comments · Fixed by #8339, ciscoviit/ciscoviit.github.io#27, sswietoniowski/learning-html-css-javascript#403 or leoo1992/next-tailwind-firebase#22 · May be fixed by surajit03/accounting#182
Closed

BUG: using multi-tab persistence, the queries in the secondary tabs don't report metadata.fromCache=false #8314

atsjo opened this issue Jun 13, 2024 · 7 comments · Fixed by #8339, ciscoviit/ciscoviit.github.io#27, sswietoniowski/learning-html-css-javascript#403 or leoo1992/next-tailwind-firebase#22 · May be fixed by surajit03/accounting#182
Assignees
@milaGGL
Labels
api: firestore needs-attention question

Comments

@atsjo
Copy link

atsjo commented Jun 13, 2024

Operating System

Latest Windows 10/11 (probably all os)

Browser Version

Latest Chrome/Edge (probably all browsers)

Firebase SDK Version

10.12.2

Firebase SDK Product:

Firestore

Describe your project's tooling

Angular 18 app via newest tooling

Describe the problem

When using multi-tab persistence and realtime listeners via onSnapshot and includeMetadataChanges: true, the queries in secondary tabs never report metadata.fromCache=false, so I cannot detect correct online state for queries when having multiple tabs...

This works fine with 10.12.0, and I tracked down a PR included in 10.12.1 related to a multi-tab issue (#8247) which probably causes this issue. This PR says it fixes that queries in secondary tabs include empty snapshots, but it SHOULD report empty snapshots with changed metadata when includeMetadataChanges=true, or else we cannot determine online state of queries...

Steps and code to reproduce issue

  1. create app with multi-tab persistence that opens a realtime listener via onSnapshot and with includeMetadataChanges: true (initializeFirestore(getApp(), { localCache: persistentLocalCache({ tabManager: persistentMultipleTabManager() }) });)
  2. Open app in multiple tabs in browser, and observe the the queries in the secondary tabs never report metadata.fromCache=false
@atsjo atsjo added new A new issue that hasn't be categoirzed as question, bug or feature request question labels Jun 13, 2024
@atsjo
Copy link
Author

atsjo commented Jun 13, 2024

This is NOT a question, but a serious regression introduced in 10.12.1 related to multi-tab persistence...

@atsjo atsjo changed the title using multi-tab persistence, the queries in the secondary tabs don't report metadata.fromCache=false BUG: using multi-tab persistence, the queries in the secondary tabs don't report metadata.fromCache=false Jun 13, 2024
@milaGGL milaGGL self-assigned this Jun 13, 2024
@jbalidiong jbalidiong added needs-attention and removed new A new issue that hasn't be categoirzed as question, bug or feature request labels Jun 13, 2024
@milaGGL
Copy link
Contributor

milaGGL commented Jun 13, 2024

Hi @atsjo, thank you for reporting this issue.

I cannot detect correct online state for queries when having multiple tabs

Are you trying to switch network condition between online and offline, and expecting to see snapshots with "fromCache: true/false"? I have tried in local test app, and it is working as expected.

@atsjo
Copy link
Author

atsjo commented Jun 13, 2024 •
edited
Loading

No, but my queries always fetch newer than what's in my local cache, so they usually return 0 elements, with fromCache true, but then return 0 again with fromCache false, to signal data is up to date with backend

@milaGGL
Copy link
Contributor

milaGGL commented Jun 13, 2024

Could you please provide reproduction steps, and what was expected vs what is the current behaviour?

@atsjo
Copy link
Author

atsjo commented Jun 14, 2024

I'll try to make a repro... I expect to always receive fromCache=false so I know I'm up to date with the server, and I use this to detect if I'm offline or online. This doesn't work in 10.12.2, but DOES work in 10.12.0.

@atsjo
Copy link
Author

atsjo commented Jun 17, 2024 •
edited
Loading

Hi @milaGGL , I've made a repro and deployed it with different versions of the sdk to different sites:
v10.12.2 -> https://test-57faf.web.app/ (NOT working with multiple tabs)
v10.12.0 -> https://test1-57faf.web.app/ (working with multiple tabs)

You can just use view source to see the source for these projects, as no bundling is used, and all logic is contained within a couple of lines in index.html. Open the first link in 2 tabs (preferably in separate windows so you see both), and refresh the tabs in turns, and you should see one or both turning red. It takes some tries the first time to trigger this, but I have verified in Chrome/Edge and Firefox on windows, AND on my pixel phone with chrome... This does NOT happen with link nr 2.... I use the fromCache metadata to determine when I'm up to date and connected to the firestore backend, as this is the preferred way of doing that according to the docs.... In my app I open 3 snapshot listeners on startup, and if people have multiple tabs or choose to install it as a pwa, this error is triggered...

The firestore db used here allows only reads, and contain no data.... Code used in repro listed below:

<body>
  <div id="info">fromCache</div>
  <script type="module">
    import { initializeApp } from "https://www.gstatic.com/firebasejs/10.12.x/firebase-app.js";
    import { initializeFirestore, persistentLocalCache, persistentMultipleTabManager, onSnapshot, collection } from "https://www.gstatic.com/firebasejs/10.12.x/firebase-firestore.js";
  
    const firebaseConfig = ...
  
    const app = initializeApp(firebaseConfig);
    const fs = initializeFirestore(app, { localCache: persistentLocalCache({ tabManager: persistentMultipleTabManager() }) });

    onSnapshot(collection(fs, 'test'), { includeMetadataChanges: true }, { next: snap => {
      document.getElementById('info').style.backgroundColor = snap.metadata.fromCache ? 'red' : 'green';
      console.log(snap.metadata.fromCache);
    }});
  </script>
</body>

@milaGGL
Copy link
Contributor

milaGGL commented Jun 18, 2024

@atsjo, thank you for the repro, i am looking into the cause.

@milaGGL milaGGL mentioned this issue Jun 26, 2024
Merged
@google-oss-bot google-oss-bot mentioned this issue Jul 2, 2024
Merged
@surajit03 surajit03 mentioned this issue Jul 25, 2024
Open
@Abellache-Rabah Abellache-Rabah mentioned this issue Jul 25, 2024
Open
@admin-token-bot admin-token-bot mentioned this issue Jul 25, 2024
Closed
@therealbenpai therealbenpai mentioned this issue Jul 25, 2024
Closed
@kushalsdesk kushalsdesk mentioned this issue Jul 25, 2024
Open
@Beve-hub Beve-hub mentioned this issue Jul 25, 2024
Open
@kenn7575 kenn7575 mentioned this issue Jul 25, 2024
Closed
@ciscoviit ciscoviit mentioned this issue Jul 25, 2024
Merged
@lydmoon lydmoon mentioned this issue Jul 25, 2024
Open
@sswietoniowski sswietoniowski mentioned this issue Jul 25, 2024
Merged
@DevJPCosta DevJPCosta mentioned this issue Jul 25, 2024
Open
@leoo1992 leoo1992 mentioned this issue Jul 25, 2024
Merged
@22-sharmi 22-sharmi mentioned this issue Jul 25, 2024
Open
@iky95 iky95 mentioned this issue Jul 25, 2024
Closed
@arnonrdp arnonrdp mentioned this issue Jul 25, 2024
Closed
@snyk-io snyk-io bot mentioned this issue Jul 25, 2024
Open
@WontonSam WontonSam mentioned this issue Jul 25, 2024
Open
@sachin2967 sachin2967 mentioned this issue Jul 26, 2024
Open
@Samsonroyal Samsonroyal mentioned this issue Jul 26, 2024
Open
This was referenced Jul 26, 2024
Open
Open
@sonlast sonlast mentioned this issue Jul 27, 2024
Open
@NEONKID NEONKID mentioned this issue Jul 28, 2024
Open
@firebase firebase locked and limited conversation to collaborators Jul 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@milaGGL milaGGL

Labels
api: firestore needs-attention question
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix multi-tab snapshot listener metadata sync issue firebase/firebase-js-sdk
[Snyk] Upgrade firebase from 10.12.2 to 10.12.3 ciscoviit/ciscoviit.github.io
[Snyk] Upgrade firebase from 10.12.2 to 10.12.3 sswietoniowski/learning-html-css-javascript
[Snyk] Upgrade firebase from 10.12.2 to 10.12.3 leoo1992/next-tailwind-firebase
[Snyk] Upgrade firebase from 10.1.0 to 10.12.3 surajit03/accounting
[Snyk] Upgrade firebase from 10.0.0 to 10.12.3 Abellache-Rabah/backend-hawasli
[Snyk] Upgrade firebase from 10.4.0 to 10.12.3 kushalsdesk/Operax-front
[Snyk] Upgrade firebase from 10.12.2 to 10.12.3 Beve-hub/investment
[Snyk] Upgrade firebase from 10.5.2 to 10.12.3 lydmoon/Lydia-MoonFullStackBankingApplication
[Snyk] Upgrade firebase from 10.12.2 to 10.12.3 22-sharmi/Resume-Bulider
5 participants
@DellaBitta @atsjo @google-oss-bot @jbalidiong @milaGGL