Rewrap comment (#2148)

Author: schmidt-sebastian

packages/firestore/src/local/indexeddb_persistence.ts

@@ -1271,9 +1271,7 @@ export class IndexedDbLruDelegate implements ReferenceDelegate, LruDelegate {
     txn: PersistenceTransaction,
     queryData: QueryData
   ): PersistencePromise<void> {
-    const updated = queryData.copy({
-      sequenceNumber: txn.currentSequenceNumber
-    });
+    const updated = queryData.withSequenceNumber(txn.currentSequenceNumber);
     return this.db.getQueryCache().updateQueryData(txn, updated);
   }
 

packages/firestore/src/local/local_store.ts

@@ -481,10 +481,10 @@ export class LocalStore {
             const resumeToken = change.resumeToken;
             // Update the resume token if the change includes one.
             if (resumeToken.length > 0) {
-              const newQueryData = oldQueryData.copy({
+              const newQueryData = oldQueryData.withResumeToken(
                 resumeToken,
                 snapshotVersion
-              });
+              );
               this.queryDataByTarget[targetId] = newQueryData;
 
               // Update the query data if there are target changes (or if

packages/firestore/src/local/memory_persistence.ts

@@ -434,9 +434,7 @@ export class MemoryLruDelegate implements ReferenceDelegate, LruDelegate {
     txn: PersistenceTransaction,
     queryData: QueryData
   ): PersistencePromise<void> {
-    const updated = queryData.copy({
-      sequenceNumber: txn.currentSequenceNumber
-    });
+    const updated = queryData.withSequenceNumber(txn.currentSequenceNumber);
     return this.persistence.getQueryCache().updateQueryData(txn, updated);
   }
 

packages/firestore/src/local/query_data.ts

@@ -61,28 +61,33 @@ export class QueryData {
     readonly resumeToken: ProtoByteString = emptyByteString()
   ) {}
 
+  /** Creates a new query data instance with an updated sequence number. */
+  withSequenceNumber(sequenceNumber: number): QueryData {
+    return new QueryData(
+      this.query,
+      this.targetId,
+      this.purpose,
+      sequenceNumber,
+      this.snapshotVersion,
+      this.resumeToken
+    );
+  }
+
   /**
-   * Creates a new query data instance with an updated snapshot version and
-   * resume token.
+   * Creates a new query data instance with an updated resume token and
+   * snapshot version.
    */
-  copy(overwrite: {
-    resumeToken?: ProtoByteString;
-    snapshotVersion?: SnapshotVersion;
-    sequenceNumber?: ListenSequenceNumber;
-  }): QueryData {
+  withResumeToken(
+    resumeToken: ProtoByteString,
+    snapshotVersion: SnapshotVersion
+  ): QueryData {
     return new QueryData(
       this.query,
       this.targetId,
       this.purpose,
-      overwrite.sequenceNumber === undefined
-        ? this.sequenceNumber
-        : overwrite.sequenceNumber,
-      overwrite.snapshotVersion === undefined
-        ? this.snapshotVersion
-        : overwrite.snapshotVersion,
-      overwrite.resumeToken === undefined
-        ? this.resumeToken
-        : overwrite.resumeToken
+      this.sequenceNumber,
+      snapshotVersion,
+      resumeToken
     );
   }
 

packages/firestore/src/remote/remote_store.ts

@@ -429,10 +429,10 @@ export class RemoteStore implements TargetMetadataProvider {
         const queryData = this.listenTargets[targetId];
         // A watched target might have been removed already.
         if (queryData) {
-          this.listenTargets[targetId] = queryData.copy({
-            resumeToken: change.resumeToken,
+          this.listenTargets[targetId] = queryData.withResumeToken(
+            change.resumeToken,
             snapshotVersion
-          });
+          );
         }
       }
     });
@@ -448,9 +448,10 @@ export class RemoteStore implements TargetMetadataProvider {
 
       // Clear the resume token for the query, since we're in a known mismatch
       // state.
-      this.listenTargets[targetId] = queryData.copy({
-        resumeToken: emptyByteString()
-      });
+      this.listenTargets[targetId] = queryData.withResumeToken(
+        emptyByteString(),
+        queryData.snapshotVersion
+      );
 
       // Cause a hard reset by unwatching and rewatching immediately, but
       // deliberately don't send a resume token so that we get a full update.

packages/firestore/test/integration/api/batch_writes.test.ts

@@ -125,6 +125,7 @@ apiDescribe('Database batch writes', (persistence: boolean) => {
   });
 
   it('can delete documents', () => {
+    // TODO(#1865): This test fails with node:persistence against Prod
     return integrationHelpers.withTestDoc(persistence, doc => {
       return doc
         .set({ foo: 'bar' })

packages/firestore/test/integration/api/database.test.ts

@@ -70,6 +70,7 @@ apiDescribe('Database', (persistence: boolean) => {
   });
 
   it('can delete a document', () => {
+    // TODO(#1865): This test fails with node:persistence against Prod
     return withTestDoc(persistence, docRef => {
       return docRef
         .set({ foo: 'bar' })

packages/firestore/test/unit/local/lru_garbage_collector.test.ts

@@ -158,9 +158,7 @@ function genericLruGarbageCollectorTests(
     txn: PersistenceTransaction,
     queryData: QueryData
   ): PersistencePromise<void> {
-    const updated = queryData.copy({
-      sequenceNumber: txn.currentSequenceNumber
-    });
+    const updated = queryData.withSequenceNumber(txn.currentSequenceNumber);
     return queryCache
       .updateQueryData(txn, updated)
       .next(() =>