Add QueryData.with() helpers

Port of firebase/firebase-js-sdk#2148

Author: schmidt-sebastian

Firestore/Example/Firestore.xcodeproj/xcshareddata/xcschemes/Firestore_Benchmarks_iOS.xcscheme

@@ -8,7 +8,7 @@
       <BuildActionEntries>
          <BuildActionEntry
             buildForTesting = "YES"
-            buildForRunning = "NO"
+            buildForRunning = "YES"
             buildForProfiling = "NO"
             buildForArchiving = "NO"
             buildForAnalyzing = "NO">

Firestore/Example/Tests/Local/FSTLRUGarbageCollectorTests.mm

@@ -179,8 +179,7 @@ - (QueryData)addNextQueryInTransaction {
 }
 
 - (void)updateTargetInTransaction:(const QueryData &)queryData {
-  QueryData updated = queryData.Copy(queryData.snapshot_version(), testutil::ResumeToken(7),
-                                     _persistence->current_sequence_number());
+  QueryData updated = queryData.WithSequenceNumber(_persistence->current_sequence_number());
   _queryCache->UpdateTarget(updated);
 }
 

Firestore/Example/Tests/SpecTests/FSTMockDatastore.mm

@@ -106,8 +106,7 @@ void WatchQuery(const QueryData& query) override {
               query.resume_token().ToString());
 
     // Snapshot version is ignored on the wire
-    QueryData sentQueryData =
-        query.Copy(SnapshotVersion::None(), query.resume_token(), query.sequence_number());
+    QueryData sentQueryData = query.WithResumeToken(query.resume_token(), SnapshotVersion::None());
     datastore_->IncrementWatchStreamRequests();
     active_targets_[query.target_id()] = sentQueryData;
   }

Firestore/core/src/firebase/firestore/local/leveldb_lru_reference_delegate.mm

@@ -71,9 +71,7 @@
 }
 
 void LevelDbLruReferenceDelegate::RemoveTarget(const QueryData& query_data) {
-  QueryData updated =
-      query_data.Copy(query_data.snapshot_version(), query_data.resume_token(),
-                      current_sequence_number());
+  QueryData updated = query_data.WithSequenceNumber(current_sequence_number());
   db_->query_cache()->UpdateTarget(std::move(updated));
 }
 

Firestore/core/src/firebase/firestore/local/local_store.mm

@@ -238,10 +238,6 @@
       query_cache_->GetLastRemoteSnapshotVersion();
 
   return persistence_->Run("Apply remote event", [&] {
-    // TODO(gsoltis): move the sequence number into the reference delegate.
-    ListenSequenceNumber sequence_number =
-        persistence_->current_sequence_number();
-
     for (const auto& entry : remote_event.target_changes()) {
       TargetId target_id = entry.first;
       const TargetChange& change = entry.second;
@@ -266,8 +262,8 @@
       const ByteString& resume_token = change.resume_token();
       // Update the resume token if the change includes one.
       if (!resume_token.empty()) {
-        QueryData new_query_data = old_query_data.Copy(
-            remote_event.snapshot_version(), resume_token, sequence_number);
+        QueryData new_query_data = old_query_data.WithResumeToken(
+            resume_token, remote_event.snapshot_version());
         target_ids[target_id] = new_query_data;
 
         // Update the query data if there are target changes (or if sufficient

Firestore/core/src/firebase/firestore/local/memory_lru_reference_delegate.cc

@@ -65,9 +65,7 @@ void MemoryLruReferenceDelegate::AddInMemoryPins(ReferenceSet* set) {
 }
 
 void MemoryLruReferenceDelegate::RemoveTarget(const QueryData& query_data) {
-  QueryData updated =
-      query_data.Copy(query_data.snapshot_version(), query_data.resume_token(),
-                      current_sequence_number_);
+  QueryData updated = query_data.WithSequenceNumber(current_sequence_number_);
   persistence_->query_cache()->UpdateTarget(updated);
 }
 

Firestore/core/src/firebase/firestore/local/query_data.cc

@@ -85,10 +85,16 @@ QueryData QueryData::Invalid() {
                    SnapshotVersion(SnapshotVersion::None()), {});
 }
 
-QueryData QueryData::Copy(SnapshotVersion snapshot_version,
-                          ByteString resume_token,
-                          model::ListenSequenceNumber sequence_number) const {
+QueryData QueryData::WithSequenceNumber(
+    model::ListenSequenceNumber sequence_number) const {
   return QueryData(Query(query_), target_id_, sequence_number, purpose_,
+                   snapshot_version_, resume_token_);
+}
+
+QueryData QueryData::WithResumeToken(
+    nanopb::ByteString resume_token,
+    model::SnapshotVersion snapshot_version) const {
+  return QueryData(Query(query_), target_id_, sequence_number_, purpose_,
                    std::move(snapshot_version), std::move(resume_token));
 }
 

Firestore/core/src/firebase/firestore/local/query_data.h

@@ -129,9 +129,16 @@ class QueryData {
     return resume_token_;
   }
 
-  QueryData Copy(model::SnapshotVersion snapshot_version,
-                 nanopb::ByteString resume_token,
-                 model::ListenSequenceNumber sequence_number) const;
+  /** Creates a new query data instance with an updated sequence number. */
+  QueryData WithSequenceNumber(
+      model::ListenSequenceNumber sequence_number) const;
+
+  /**
+   *  Creates a new query data instance with an updated resume token and
+   * snapshot version.
+   */
+  QueryData WithResumeToken(nanopb::ByteString resume_token,
+                            model::SnapshotVersion snapshot_version) const;
 
   friend bool operator==(const QueryData& lhs, const QueryData& rhs);
 

Firestore/core/src/firebase/firestore/remote/remote_store.mm

@@ -288,8 +288,8 @@
 
       // A watched target might have been removed already.
       if (query_data) {
-        listen_targets_[target_id] = query_data->Copy(
-            snapshot_version, resumeToken, query_data->sequence_number());
+        listen_targets_[target_id] =
+            query_data->WithResumeToken(resumeToken, snapshot_version);
       }
     }
   }