fix: don't rely on excluding fromCache from onFirstData triggers

Author: mesqueeb

packages/plugin-firestore/src/actions/stream.ts

@@ -43,19 +43,13 @@ export function streamActionFactory(
       const documentPath = getFirestoreDocPath(collectionPath, docId, pluginModuleConfig, firestorePluginOptions) // prettier-ignore
       closeStream = onSnapshot(
         doc(db, documentPath),
-        { includeMetadataChanges: true },
         (docSnapshot: DocumentSnapshot<{ [key: string]: unknown }>) => {
           // even if `docSnapshot.metadata.hasPendingWrites`
           //       we should always execute `added/modified`
           //       because `core` handles overlapping calls for us
 
           // Call onFirstData on first snapshot (whether doc exists or not)
-          if (
-            !firstDataReceived &&
-            onFirstData &&
-            !docSnapshot.metadata.fromCache &&
-            !docSnapshot.metadata.hasPendingWrites
-          ) {
+          if (!firstDataReceived && onFirstData) {
             firstDataReceived = true
             setTimeout(() => onFirstData({ empty: !docSnapshot.exists() }), 0)
           }
@@ -82,12 +76,7 @@ export function streamActionFactory(
           //       because `core` handles overlapping calls for us
 
           // Call onFirstData on first snapshot (whether collection has docs or not)
-          if (
-            !firstDataReceived &&
-            onFirstData &&
-            !querySnapshot.metadata.fromCache &&
-            !querySnapshot.metadata.hasPendingWrites
-          ) {
+          if (!firstDataReceived && onFirstData) {
             firstDataReceived = true
             setTimeout(() => onFirstData({ empty: querySnapshot.empty }), 0)
           }

packages/plugin-firestore/test/external/stream.test.ts

@@ -22,6 +22,48 @@ import { createMagnetarInstance } from '../helpers/createMagnetarInstance.js'
     assert.deepEqual(pokedexModule.data.size, 151)
   })
 }
+{
+  const testName = 'stream with onFirstData (empty collection), close and stream again'
+  test(testName, async () => {
+    const { magnetar } = await createMagnetarInstance('read')
+
+    const emptyReadable = magnetar.collection('emptyReopen', {
+      configPerStore: {
+        remote: { firestorePath: 'magnetarTests/read/emptyReopen' },
+      },
+    })
+
+    const onFirstDataPayloads: { empty?: boolean }[] = []
+
+    // First stream
+    emptyReadable
+      .stream({ onFirstData: (payload) => onFirstDataPayloads.push(payload) })
+      .catch((e: any) => assert.fail(e.message))
+
+    // Wait for initial snapshot
+    await waitMs(500)
+
+    // Close all streams and wait a tick
+    emptyReadable.closeAllStreams()
+    await waitMs(10)
+
+    // Second stream
+    emptyReadable
+      .stream({ onFirstData: (payload) => onFirstDataPayloads.push(payload) })
+      .catch((e: any) => assert.fail(e.message))
+
+    // Wait for second snapshot
+    await waitMs(500)
+
+    // Expect onFirstData twice, both indicating empty collection
+    assert.deepEqual(onFirstDataPayloads.length, 2)
+    assert.deepEqual(onFirstDataPayloads[0], { empty: true })
+    assert.deepEqual(onFirstDataPayloads[1], { empty: true })
+
+    // Cleanup
+    emptyReadable.closeAllStreams()
+  })
+}
 {
   const testName = 'stream (empty collection with read access)'
   test(testName, async () => {