Rename QueryData|Cache to TargetData|Cache (#4670)

* Rename done by CLion

QueryCache -> TargetCache
QueryData -> TargetData

* Fix cmake list indention

* Fixing ordering.

Author: wu-hui

Firestore/Example/Firestore.xcodeproj/project.pbxproj

@@ -31,8 +31,8 @@
 #include "Firestore/core/src/firebase/firestore/core/database_info.h"
 #include "Firestore/core/src/firebase/firestore/local/local_store.h"
 #include "Firestore/core/src/firebase/firestore/local/memory_persistence.h"
-#include "Firestore/core/src/firebase/firestore/local/query_data.h"
 #include "Firestore/core/src/firebase/firestore/local/simple_query_engine.h"
+#include "Firestore/core/src/firebase/firestore/local/target_data.h"
 #include "Firestore/core/src/firebase/firestore/model/database_id.h"
 #include "Firestore/core/src/firebase/firestore/model/document_key.h"
 #include "Firestore/core/src/firebase/firestore/model/precondition.h"
@@ -57,8 +57,8 @@
 using firebase::firestore::local::LocalStore;
 using firebase::firestore::local::MemoryPersistence;
 using firebase::firestore::local::Persistence;
-using firebase::firestore::local::QueryData;
 using firebase::firestore::local::SimpleQueryEngine;
+using firebase::firestore::local::TargetData;
 using firebase::firestore::model::BatchId;
 using firebase::firestore::model::DatabaseId;
 using firebase::firestore::model::DocumentKey;

Firestore/Example/Tests/Integration/FSTDatastoreTests.mm

@@ -71,7 +71,7 @@ class MockDatastore : public Datastore {
   void FailWatchStream(const util::Status& error);
 
   /** Returns the set of active targets on the watch stream. */
-  const std::unordered_map<model::TargetId, local::QueryData>& ActiveTargets() const;
+  const std::unordered_map<model::TargetId, local::TargetData>& ActiveTargets() const;
   /** Helper method to expose watch stream state to verify in tests. */
   bool IsWatchStreamOpen() const;
 

Firestore/Example/Tests/SpecTests/FSTMockDatastore.h

@@ -24,7 +24,7 @@
 #include "Firestore/core/src/firebase/firestore/auth/credentials_provider.h"
 #include "Firestore/core/src/firebase/firestore/auth/empty_credentials_provider.h"
 #include "Firestore/core/src/firebase/firestore/core/database_info.h"
-#include "Firestore/core/src/firebase/firestore/local/query_data.h"
+#include "Firestore/core/src/firebase/firestore/local/target_data.h"
 #include "Firestore/core/src/firebase/firestore/model/database_id.h"
 #include "Firestore/core/src/firebase/firestore/model/mutation.h"
 #include "Firestore/core/src/firebase/firestore/remote/connectivity_monitor.h"
@@ -44,7 +44,7 @@
 using firebase::firestore::auth::CredentialsProvider;
 using firebase::firestore::auth::EmptyCredentialsProvider;
 using firebase::firestore::core::DatabaseInfo;
-using firebase::firestore::local::QueryData;
+using firebase::firestore::local::TargetData;
 using firebase::firestore::model::DatabaseId;
 using firebase::firestore::model::Mutation;
 using firebase::firestore::model::MutationResult;
@@ -78,7 +78,7 @@
         callback_{callback} {
   }
 
-  const std::unordered_map<TargetId, QueryData>& ActiveTargets() const {
+  const std::unordered_map<TargetId, TargetData>& ActiveTargets() const {
     return active_targets_;
   }
 
@@ -101,14 +101,15 @@ bool IsOpen() const override {
     return open_;
   }
 
-  void WatchQuery(const QueryData& query) override {
+  void WatchQuery(const TargetData& query) override {
     LOG_DEBUG("WatchQuery: %s: %s, %s", query.target_id(), query.target().ToString(),
               query.resume_token().ToString());
 
     // Snapshot version is ignored on the wire
-    QueryData sentQueryData = query.WithResumeToken(query.resume_token(), SnapshotVersion::None());
+    TargetData sentTargetData =
+        query.WithResumeToken(query.resume_token(), SnapshotVersion::None());
     datastore_->IncrementWatchStreamRequests();
-    active_targets_[query.target_id()] = sentQueryData;
+    active_targets_[query.target_id()] = sentTargetData;
   }
 
   void UnwatchTargetId(model::TargetId target_id) override {
@@ -150,7 +151,7 @@ void WriteWatchChange(const WatchChange& change, SnapshotVersion snap) {
 
  private:
   bool open_ = false;
-  std::unordered_map<TargetId, QueryData> active_targets_;
+  std::unordered_map<TargetId, TargetData> active_targets_;
   MockDatastore* datastore_ = nullptr;
   WatchStreamCallback* callback_ = nullptr;
 };
@@ -273,7 +274,7 @@ int sent_mutations_count() const {
   watch_stream_->FailStream(error);
 }
 
-const std::unordered_map<TargetId, QueryData>& MockDatastore::ActiveTargets() const {
+const std::unordered_map<TargetId, TargetData>& MockDatastore::ActiveTargets() const {
   return watch_stream_->ActiveTargets();
 }
 

Firestore/Example/Tests/SpecTests/FSTMockDatastore.mm

@@ -33,7 +33,7 @@
 #include "Firestore/core/include/firebase/firestore/firestore_errors.h"
 #include "Firestore/core/src/firebase/firestore/auth/user.h"
 #include "Firestore/core/src/firebase/firestore/local/persistence.h"
-#include "Firestore/core/src/firebase/firestore/local/query_data.h"
+#include "Firestore/core/src/firebase/firestore/local/target_data.h"
 #include "Firestore/core/src/firebase/firestore/model/document.h"
 #include "Firestore/core/src/firebase/firestore/model/document_key.h"
 #include "Firestore/core/src/firebase/firestore/model/document_key_set.h"
@@ -67,7 +67,7 @@
 using firebase::firestore::core::DocumentViewChange;
 using firebase::firestore::core::Query;
 using firebase::firestore::local::Persistence;
-using firebase::firestore::local::QueryData;
+using firebase::firestore::local::TargetData;
 using firebase::firestore::local::QueryPurpose;
 using firebase::firestore::model::Document;
 using firebase::firestore::model::DocumentKey;
@@ -665,15 +665,15 @@ - (void)validateExpectedState:(nullable NSDictionary *)expectedState {
             TargetId targetID = [targetIDString intValue];
             ByteString resumeToken = MakeResumeToken(queryData[@"resumeToken"]);
             NSArray *queriesJson = queryData[@"queries"];
-            std::vector<QueryData> queries;
+            std::vector<TargetData> queries;
             for (id queryJson in queriesJson) {
               Query query = [self parseQuery:queryJson];
               // TODO(mcg): populate the purpose of the target once it's possible to encode that in
               // the spec tests. For now, hard-code that it's a listen despite the fact that it's
               // not always the right value.
-              queries.push_back(QueryData(query.ToTarget(), targetID, 0, QueryPurpose::Listen,
-                                          SnapshotVersion::None(), SnapshotVersion::None(),
-                                          std::move(resumeToken)));
+              queries.push_back(TargetData(query.ToTarget(), targetID, 0, QueryPurpose::Listen,
+                                           SnapshotVersion::None(), SnapshotVersion::None(),
+                                           std::move(resumeToken)));
             }
             expectedActiveTargets[targetID] = std::make_pair(std::move(queries), resumeToken);
           }];
@@ -736,26 +736,26 @@ - (void)validateActiveTargets {
   }
 
   // Create a copy so we can modify it below
-  std::unordered_map<TargetId, QueryData> actualTargets = [self.driver activeTargets];
+  std::unordered_map<TargetId, TargetData> actualTargets = [self.driver activeTargets];
 
   for (const auto &kv : [self.driver expectedActiveTargets]) {
     TargetId targetID = kv.first;
-    const std::pair<std::vector<QueryData>, ByteString> &queries = kv.second;
-    const QueryData &queryData = queries.first[0];
+    const std::pair<std::vector<TargetData>, ByteString> &queries = kv.second;
+    const TargetData &targetData = queries.first[0];
 
     auto found = actualTargets.find(targetID);
     XCTAssertNotEqual(found, actualTargets.end(), @"Expected active target not found: %s",
-                      queryData.ToString().c_str());
+                      targetData.ToString().c_str());
 
     // TODO(mcg): validate the purpose of the target once it's possible to encode that in the
     // spec tests. For now, only validate properties that can be validated.
-    // XCTAssertEqualObjects(actualTargets[targetID], queryData);
+    // XCTAssertEqualObjects(actualTargets[targetID], TargetData);
 
-    const QueryData &actual = found->second;
-    XCTAssertEqual(actual.target(), queryData.target());
-    XCTAssertEqual(actual.target_id(), queryData.target_id());
-    XCTAssertEqual(actual.snapshot_version(), queryData.snapshot_version());
-    XCTAssertEqual(actual.resume_token(), queryData.resume_token());
+    const TargetData &actual = found->second;
+    XCTAssertEqual(actual.target(), targetData.target());
+    XCTAssertEqual(actual.target_id(), targetData.target_id());
+    XCTAssertEqual(actual.snapshot_version(), targetData.snapshot_version());
+    XCTAssertEqual(actual.resume_token(), targetData.resume_token());
 
     actualTargets.erase(targetID);
   }

Firestore/Example/Tests/SpecTests/FSTSpecTests.mm

@@ -26,7 +26,7 @@
 #include "Firestore/core/src/firebase/firestore/core/event_listener.h"
 #include "Firestore/core/src/firebase/firestore/core/query.h"
 #include "Firestore/core/src/firebase/firestore/core/view_snapshot.h"
-#include "Firestore/core/src/firebase/firestore/local/query_data.h"
+#include "Firestore/core/src/firebase/firestore/local/target_data.h"
 #include "Firestore/core/src/firebase/firestore/model/document_key.h"
 #include "Firestore/core/src/firebase/firestore/model/document_key_set.h"
 #include "Firestore/core/src/firebase/firestore/model/mutation.h"
@@ -54,11 +54,11 @@ namespace model = firebase::firestore::model;
 namespace nanopb = firebase::firestore::nanopb;
 
 // A map holds expected information about currently active targets. The keys are
-// target ID, and the values are a vector of `QueryData`s mapped to the target and
+// target ID, and the values are a vector of `TargetData`s mapped to the target and
 // the target's resume token.
 using ActiveTargetMap =
     std::unordered_map<model::TargetId,
-                       std::pair<std::vector<local::QueryData>, nanopb::ByteString>>;
+                       std::pair<std::vector<local::TargetData>, nanopb::ByteString>>;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -345,7 +345,8 @@ typedef std::unordered_map<firebase::firestore::auth::User,
 - (void)removeSnapshotsInSyncListener;
 
 /** The set of active targets as observed on the watch stream. */
-- (const std::unordered_map<firebase::firestore::model::TargetId, local::QueryData> &)activeTargets;
+- (const std::unordered_map<firebase::firestore::model::TargetId, local::TargetData> &)
+    activeTargets;
 
 /** The expected set of active targets, keyed by target ID. */
 - (const ActiveTargetMap &)expectedActiveTargets;

Firestore/Example/Tests/SpecTests/FSTSyncEngineTestDriver.h

@@ -69,7 +69,7 @@
 using firebase::firestore::local::IndexFreeQueryEngine;
 using firebase::firestore::local::LocalStore;
 using firebase::firestore::local::Persistence;
-using firebase::firestore::local::QueryData;
+using firebase::firestore::local::TargetData;
 using firebase::firestore::model::DatabaseId;
 using firebase::firestore::model::DocumentKey;
 using firebase::firestore::model::DocumentKeySet;
@@ -165,7 +165,7 @@ @implementation FSTSyncEngineTestDriver {
   DelayedConstructor<EventManager> _eventManager;
 
   // Set of active targets, keyed by target Id, mapped to corresponding resume token,
-  // and list of `QueryData`.
+  // and list of `TargetData`.
   ActiveTargetMap _expectedActiveTargets;
 
   // ivar is declared as mutable.
@@ -474,7 +474,7 @@ - (void)receiveWatchStreamError:(int)errorCode userInfo:(NSDictionary<NSString *
   return _syncEngine->GetCurrentLimboDocuments();
 }
 
-- (const std::unordered_map<TargetId, QueryData> &)activeTargets {
+- (const std::unordered_map<TargetId, TargetData> &)activeTargets {
   return _datastore->ActiveTargets();
 }
 

Firestore/Example/Tests/SpecTests/FSTSyncEngineTestDriver.mm

@@ -19,8 +19,8 @@
 #include "Firestore/core/include/firebase/firestore/firestore_errors.h"
 #include "Firestore/core/src/firebase/firestore/core/transaction.h"
 #include "Firestore/core/src/firebase/firestore/core/transaction_runner.h"
-#include "Firestore/core/src/firebase/firestore/local/query_data.h"
 #include "Firestore/core/src/firebase/firestore/local/query_result.h"
+#include "Firestore/core/src/firebase/firestore/local/target_data.h"
 #include "Firestore/core/src/firebase/firestore/model/document_key.h"
 #include "Firestore/core/src/firebase/firestore/model/document_key_set.h"
 #include "Firestore/core/src/firebase/firestore/model/document_map.h"
@@ -41,9 +41,9 @@ using firestore::Error;
 using local::LocalStore;
 using local::LocalViewChanges;
 using local::LocalWriteResult;
-using local::QueryData;
 using local::QueryPurpose;
 using local::QueryResult;
+using local::TargetData;
 using model::BatchId;
 using model::DocumentKey;
 using model::DocumentKeySet;
@@ -94,17 +94,17 @@ TargetId SyncEngine::Listen(Query query) {
   HARD_ASSERT(query_views_by_query_.find(query) == query_views_by_query_.end(),
               "We already listen to query: %s", query.ToString());
 
-  QueryData query_data = local_store_->AllocateTarget(query.ToTarget());
+  TargetData target_data = local_store_->AllocateTarget(query.ToTarget());
   ViewSnapshot view_snapshot =
-      InitializeViewAndComputeSnapshot(query, query_data.target_id());
+      InitializeViewAndComputeSnapshot(query, target_data.target_id());
   std::vector<ViewSnapshot> snapshots;
   // Not using the `std::initializer_list` constructor to avoid extra copies.
   snapshots.push_back(std::move(view_snapshot));
   sync_engine_callback_->OnViewSnapshots(std::move(snapshots));
 
-  // TODO(wuandy): move `query_data` into `Listen`.
-  remote_store_->Listen(query_data);
-  return query_data.target_id();
+  // TODO(wuandy): move `target_data` into `Listen`.
+  remote_store_->Listen(target_data);
+  return target_data.target_id();
 }
 
 ViewSnapshot SyncEngine::InitializeViewAndComputeSnapshot(const Query& query,
@@ -528,12 +528,11 @@ void SyncEngine::TrackLimboChange(const LimboDocumentChange& limbo_change) {
 
     TargetId limbo_target_id = target_id_generator_.NextId();
     Query query(key.path());
-    QueryData query_data(query.ToTarget(), limbo_target_id,
-                         kIrrelevantSequenceNumber,
-                         QueryPurpose::LimboResolution);
+    TargetData target_data(query.ToTarget(), limbo_target_id,
+                           kIrrelevantSequenceNumber,
+                           QueryPurpose::LimboResolution);
     limbo_resolutions_by_target_.emplace(limbo_target_id, LimboResolution{key});
-    // TODO(wuandy): move `query_data` into `Listen`.
-    remote_store_->Listen(query_data);
+    remote_store_->Listen(target_data);
     limbo_targets_by_key_[key] = limbo_target_id;
   }
 }

Firestore/core/src/firebase/firestore/core/sync_engine.cc

@@ -29,8 +29,8 @@
 #include "Firestore/core/src/firebase/firestore/core/view.h"
 #include "Firestore/core/src/firebase/firestore/core/view_snapshot.h"
 #include "Firestore/core/src/firebase/firestore/local/local_store.h"
-#include "Firestore/core/src/firebase/firestore/local/query_data.h"
 #include "Firestore/core/src/firebase/firestore/local/reference_set.h"
+#include "Firestore/core/src/firebase/firestore/local/target_data.h"
 #include "Firestore/core/src/firebase/firestore/model/document_key_set.h"
 #include "Firestore/core/src/firebase/firestore/model/maybe_document.h"
 #include "Firestore/core/src/firebase/firestore/remote/remote_store.h"

Firestore/core/src/firebase/firestore/core/sync_engine.h

@@ -24,7 +24,7 @@ namespace firestore {
 namespace core {
 
 /** The set of all valid generators. */
-enum class TargetIdGeneratorId { QueryCache = 0, SyncEngine = 1 };
+enum class TargetIdGeneratorId { TargetCache = 0, SyncEngine = 1 };
 
 /**
  * Generates monotonically increasing target IDs for sending targets to the
@@ -57,8 +57,8 @@ class TargetIdGenerator {
    * @param after An ID to start at. Every call to NextId returns a larger id.
    * @return An instance of TargetIdGenerator.
    */
-  static TargetIdGenerator QueryCacheTargetIdGenerator(model::TargetId after) {
-    TargetIdGenerator generator(TargetIdGeneratorId::QueryCache, after);
+  static TargetIdGenerator TargetCacheTargetIdGenerator(model::TargetId after) {
+    TargetIdGenerator generator(TargetIdGeneratorId::TargetCache, after);
     // Make sure that the next call to `NextId()` returns the first value after
     // 'after'.
     generator.NextId();

Firestore/core/src/firebase/firestore/core/target_id_generator.h

@@ -24,10 +24,10 @@ cc_library(
     lru_garbage_collector.h
     memory_index_manager.cc
     memory_index_manager.h
-    query_data.cc
-    query_data.h
     reference_set.cc
     reference_set.h
+    target_data.cc
+    target_data.h
   DEPENDS
     absl_strings
     firebase_firestore_core_query
@@ -53,10 +53,10 @@ cc_library(
     leveldb_mutation_queue.h
     leveldb_persistence.cc
     leveldb_persistence.h
-    leveldb_query_cache.cc
-    leveldb_query_cache.h
     leveldb_remote_document_cache.cc
     leveldb_remote_document_cache.h
+    leveldb_target_cache.cc
+    leveldb_target_cache.h
     leveldb_transaction.cc
     leveldb_transaction.h
     leveldb_util.cc
@@ -98,22 +98,22 @@ cc_library(
     memory_mutation_queue.h
     memory_persistence.cc
     memory_persistence.h
-    memory_query_cache.cc
-    memory_query_cache.h
     memory_remote_document_cache.cc
     memory_remote_document_cache.h
+    memory_target_cache.cc
+    memory_target_cache.h
     mutation_queue.h
     persistence.h
     proto_sizer.cc
     proto_sizer.h
-    query_cache.h
     query_engine.h
     query_result.h
     reference_delegate.h
     remote_document_cache.h
     simple_query_engine.cc
     simple_query_engine.h
     sizer.h
+    target_cache.h
   DEPENDS
     absl_strings
     firebase_firestore_auth

Firestore/core/src/firebase/firestore/local/CMakeLists.txt

@@ -36,7 +36,7 @@ namespace local {
 
 /**
  * A query engine that takes advantage of the target document mapping in the
- * QueryCache. The IndexFreeQueryEngine optimizes query execution by only
+ * TargetCache. The IndexFreeQueryEngine optimizes query execution by only
  * reading the documents that previously matched a query plus any documents that
  * were edited after the query was last listened to.
  *