Use forward declarations instead of IWYU (#4868)

* Remove rarely used template argumnets from SortedMap/SortedSet

* Remove unused STATUS_CHECK_OK

* Rename QuerySnapshot::Listener to QuerySnapshotListener

This makes the type something that can be forward declared.

* Rename DocumentSnapshot::Listener to DocumentSnapshotListener

This makes the type something that can be forward declared.

* Rename ViewSnapshot::Listener to ViewSnapshotListener

This makes the type something that can be forward declared.

* Put most QueryListener implementation in .cc

* Actually use sync_engine_callback.h

* Add forward declaration headers for api, core, and model

These centralize forward declarations, including declarations for some
hard-to-forward-declare types.

* Move includes of hard_assert.h out of other headers

* Make testutil definitions out of line

* Move definitions out-of-line

* Move DocumentKey definitions out-of-line

* Move definitions out-of-line

* Shorten unnecessarily long namespace usages

* Use default destructors where possible

* Delete unused MutationBatch::kUnknown constant

* Use forward declarations instead of IWYU

* Misc fixups from Linux/GCC 9.2.1

* Fix testutil under VS 2017

Forward declarations of functions local to a function body end up
generating unresolved externals. Reduce most of these back to just
calling FieldValue::FromX methods.

Author: wilhuff

Firestore/Example/Tests/API/FIRFieldPathTests.mm

@@ -22,6 +22,7 @@
 
 #import "Firestore/Example/Tests/Util/FSTHelpers.h"
 
+#include "Firestore/core/src/firebase/firestore/model/field_path.h"
 #include "Firestore/core/test/firebase/firestore/testutil/testutil.h"
 
 namespace testutil = firebase::firestore::testutil;

Firestore/Example/Tests/API/FIRQueryUnitTests.mm

@@ -24,6 +24,7 @@
 #import "Firestore/Example/Tests/API/FSTAPIHelpers.h"
 #import "Firestore/Example/Tests/Util/FSTHelpers.h"
 
+#include "Firestore/core/src/firebase/firestore/core/query.h"
 #include "Firestore/core/test/firebase/firestore/testutil/testutil.h"
 
 namespace api = firebase::firestore::api;

Firestore/Example/Tests/Integration/API/FIRDatabaseTests.mm

@@ -23,6 +23,7 @@
 #import "Firestore/Example/Tests/Util/FSTIntegrationTestCase.h"
 #import "Firestore/Source/API/FIRFirestore+Internal.h"
 
+#include "Firestore/core/src/firebase/firestore/api/query_snapshot.h"
 #include "Firestore/core/src/firebase/firestore/core/firestore_client.h"
 #include "Firestore/core/test/firebase/firestore/testutil/app_testing.h"
 

Firestore/Example/Tests/Integration/FSTDatastoreTests.mm

@@ -29,13 +29,16 @@
 
 #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/local_documents_view.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/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/mutation_batch_result.h"
 #include "Firestore/core/src/firebase/firestore/model/precondition.h"
+#include "Firestore/core/src/firebase/firestore/model/set_mutation.h"
 #include "Firestore/core/src/firebase/firestore/remote/datastore.h"
 #include "Firestore/core/src/firebase/firestore/remote/remote_event.h"
 #include "Firestore/core/src/firebase/firestore/remote/remote_store.h"

Firestore/Example/Tests/SpecTests/FSTMockDatastore.h

@@ -20,8 +20,7 @@
 #include <unordered_map>
 #include <vector>
 
-#include "Firestore/core/src/firebase/firestore/model/snapshot_version.h"
-#include "Firestore/core/src/firebase/firestore/model/types.h"
+#include "Firestore/core/src/firebase/firestore/model/model_fwd.h"
 #include "Firestore/core/src/firebase/firestore/remote/datastore.h"
 #include "Firestore/core/src/firebase/firestore/util/status_fwd.h"
 

Firestore/Example/Tests/SpecTests/FSTSpecTests.mm

@@ -32,15 +32,19 @@
 
 #include "Firestore/core/include/firebase/firestore/firestore_errors.h"
 #include "Firestore/core/src/firebase/firestore/auth/user.h"
+#include "Firestore/core/src/firebase/firestore/core/field_filter.h"
 #include "Firestore/core/src/firebase/firestore/local/persistence.h"
 #include "Firestore/core/src/firebase/firestore/local/target_data.h"
+#include "Firestore/core/src/firebase/firestore/model/delete_mutation.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"
 #include "Firestore/core/src/firebase/firestore/model/field_value.h"
 #include "Firestore/core/src/firebase/firestore/model/maybe_document.h"
 #include "Firestore/core/src/firebase/firestore/model/no_document.h"
+#include "Firestore/core/src/firebase/firestore/model/patch_mutation.h"
 #include "Firestore/core/src/firebase/firestore/model/resource_path.h"
+#include "Firestore/core/src/firebase/firestore/model/set_mutation.h"
 #include "Firestore/core/src/firebase/firestore/model/snapshot_version.h"
 #include "Firestore/core/src/firebase/firestore/model/types.h"
 #include "Firestore/core/src/firebase/firestore/nanopb/nanopb_util.h"

Firestore/Example/Tests/SpecTests/FSTSyncEngineTestDriver.h

@@ -23,15 +23,9 @@
 #include <vector>
 
 #include "Firestore/core/src/firebase/firestore/auth/user.h"
-#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/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"
-#include "Firestore/core/src/firebase/firestore/model/snapshot_version.h"
-#include "Firestore/core/src/firebase/firestore/model/types.h"
+#include "Firestore/core/src/firebase/firestore/model/model_fwd.h"
 #include "Firestore/core/src/firebase/firestore/nanopb/byte_string.h"
 #include "Firestore/core/src/firebase/firestore/nanopb/nanopb_util.h"
 #include "Firestore/core/src/firebase/firestore/remote/watch_change.h"
@@ -43,15 +37,19 @@ namespace firestore {
 namespace local {
 
 class Persistence;
+class TargetData;
 
 }  // namespace local
 }  // namespace firestore
 }  // namespace firebase
 
+namespace auth = firebase::firestore::auth;
 namespace core = firebase::firestore::core;
 namespace local = firebase::firestore::local;
 namespace model = firebase::firestore::model;
 namespace nanopb = firebase::firestore::nanopb;
+namespace remote = firebase::firestore::remote;
+namespace util = firebase::firestore::util;
 
 // A map holds expected information about currently active targets. The keys are
 // target ID, and the values are a vector of `TargetData`s mapped to the target and
@@ -70,8 +68,8 @@ NS_ASSUME_NONNULL_BEGIN
 @property(nonatomic, assign) core::Query query;
 @property(nonatomic, strong, nullable) NSError *error;
 
-- (const absl::optional<firebase::firestore::core::ViewSnapshot> &)viewSnapshot;
-- (void)setViewSnapshot:(absl::optional<firebase::firestore::core::ViewSnapshot>)snapshot;
+- (const absl::optional<core::ViewSnapshot> &)viewSnapshot;
+- (void)setViewSnapshot:(absl::optional<core::ViewSnapshot>)snapshot;
 
 @end
 
@@ -91,9 +89,7 @@ NS_ASSUME_NONNULL_BEGIN
 @end
 
 /** Mapping of user => array of FSTMutations for that user. */
-typedef std::unordered_map<firebase::firestore::auth::User,
-                           NSMutableArray<FSTOutstandingWrite *> *,
-                           firebase::firestore::auth::HashUser>
+typedef std::unordered_map<auth::User, NSMutableArray<FSTOutstandingWrite *> *, auth::HashUser>
     FSTOutstandingWriteQueues;
 
 /**
@@ -131,7 +127,7 @@ typedef std::unordered_map<firebase::firestore::auth::User,
  * mutation queues).
  */
 - (instancetype)initWithPersistence:(std::unique_ptr<local::Persistence>)persistence
-                        initialUser:(const firebase::firestore::auth::User &)initialUser
+                        initialUser:(const auth::User &)initialUser
                   outstandingWrites:(const FSTOutstandingWriteQueues &)outstandingWrites
     NS_DESIGNATED_INITIALIZER;
 
@@ -155,7 +151,7 @@ typedef std::unordered_map<firebase::firestore::auth::User,
  * @param query A valid query to execute against the backend.
  * @return The target ID assigned by the system to track the query.
  */
-- (firebase::firestore::model::TargetId)addUserListenerWithQuery:(core::Query)query;
+- (model::TargetId)addUserListenerWithQuery:(core::Query)query;
 
 /**
  * Removes a listener from the FSTSyncEngine as if the user had removed a listener corresponding
@@ -178,8 +174,8 @@ typedef std::unordered_map<firebase::firestore::auth::User,
  * @param snapshot A snapshot version to attach, if applicable. This should be sent when
  *      simulating the server having sent a complete snapshot.
  */
-- (void)receiveWatchChange:(const firebase::firestore::remote::WatchChange &)change
-           snapshotVersion:(const firebase::firestore::model::SnapshotVersion &)snapshot;
+- (void)receiveWatchChange:(const remote::WatchChange &)change
+           snapshotVersion:(const model::SnapshotVersion &)snapshot;
 
 /**
  * Delivers a watch stream error as if the Streaming Watch backend has generated some kind of error.
@@ -226,9 +222,9 @@ typedef std::unordered_map<firebase::firestore::auth::User,
  *     the mutation. Snapshot versions must be monotonically increasing.
  * @param mutationResults The mutation results for the write that is being acked.
  */
-- (FSTOutstandingWrite *)
-    receiveWriteAckWithVersion:(const firebase::firestore::model::SnapshotVersion &)commitVersion
-               mutationResults:(std::vector<model::MutationResult>)mutationResults;
+- (FSTOutstandingWrite *)receiveWriteAckWithVersion:(const model::SnapshotVersion &)commitVersion
+                                    mutationResults:
+                                        (std::vector<model::MutationResult>)mutationResults;
 
 /**
  * A count of the mutations written to the write stream by the FSTSyncEngine, but not yet
@@ -261,14 +257,14 @@ typedef std::unordered_map<firebase::firestore::auth::User,
 /**
  * Runs a pending timer callback on the worker queue.
  */
-- (void)runTimer:(firebase::firestore::util::TimerId)timerID;
+- (void)runTimer:(util::TimerId)timerID;
 
 /**
  * Switches the FSTSyncEngine to a new user. The test driver tracks the outstanding mutations for
  * each user, so future receiveWriteAck/Error operations will validate the write sent to the mock
  * datastore matches the next outstanding write for that user.
  */
-- (void)changeUser:(const firebase::firestore::auth::User &)user;
+- (void)changeUser:(const auth::User &)user;
 
 /**
  * Drains the client's dispatch queue.
@@ -294,14 +290,13 @@ typedef std::unordered_map<firebase::firestore::auth::User,
 - (NSArray<NSString *> *)capturedRejectedWritesSinceLastCall;
 
 /** The current set of documents in limbo. */
-- (std::map<firebase::firestore::model::DocumentKey, firebase::firestore::model::TargetId>)
-    currentLimboDocuments;
+- (std::map<model::DocumentKey, model::TargetId>)currentLimboDocuments;
 
 /** The expected set of documents in limbo. */
-- (const firebase::firestore::model::DocumentKeySet &)expectedLimboDocuments;
+- (const model::DocumentKeySet &)expectedLimboDocuments;
 
 /** Sets the expected set of documents in limbo. */
-- (void)setExpectedLimboDocuments:(firebase::firestore::model::DocumentKeySet)docs;
+- (void)setExpectedLimboDocuments:(model::DocumentKeySet)docs;
 
 /**
  * The writes that have been sent to the FSTSyncEngine via writeUserMutation: but not yet
@@ -322,7 +317,7 @@ typedef std::unordered_map<firebase::firestore::auth::User,
 @property(nonatomic, assign, readonly) const FSTOutstandingWriteQueues &outstandingWrites;
 
 /** The current user for the FSTSyncEngine; determines which mutation queue is active. */
-@property(nonatomic, assign, readonly) const firebase::firestore::auth::User &currentUser;
+@property(nonatomic, assign, readonly) const auth::User &currentUser;
 
 /**
  * The number of snapshots-in-sync events that have been received.
@@ -345,8 +340,7 @@ 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::TargetData> &)
-    activeTargets;
+- (const std::unordered_map<model::TargetId, local::TargetData> &)activeTargets;
 
 /** The expected set of active targets, keyed by target ID. */
 - (const ActiveTargetMap &)expectedActiveTargets;

Firestore/Example/Tests/SpecTests/FSTSyncEngineTestDriver.mm

@@ -32,6 +32,8 @@
 #include "Firestore/core/src/firebase/firestore/auth/user.h"
 #include "Firestore/core/src/firebase/firestore/core/database_info.h"
 #include "Firestore/core/src/firebase/firestore/core/event_manager.h"
+#include "Firestore/core/src/firebase/firestore/core/listen_options.h"
+#include "Firestore/core/src/firebase/firestore/core/query_listener.h"
 #include "Firestore/core/src/firebase/firestore/core/sync_engine.h"
 #include "Firestore/core/src/firebase/firestore/local/index_free_query_engine.h"
 #include "Firestore/core/src/firebase/firestore/local/local_store.h"

Firestore/Example/Tests/Util/FSTHelpers.h

@@ -19,29 +19,13 @@
 #include <string>
 #include <vector>
 
-#include "Firestore/core/src/firebase/firestore/model/field_path.h"
+#include "Firestore/core/src/firebase/firestore/model/model_fwd.h"
 #include "absl/strings/string_view.h"
 
 @class FIRGeoPoint;
 @class FSTDocumentKeyReference;
 @class FSTUserDataConverter;
 
-namespace firebase {
-namespace firestore {
-
-namespace model {
-class DeleteMutation;
-class DocumentKey;
-class FieldValue;
-class ObjectValue;
-class PatchMutation;
-class SetMutation;
-class TransformMutation;
-}  // namespace model
-
-}  // namespace firestore
-}  // namespace firebase
-
 namespace model = firebase::firestore::model;
 
 NS_ASSUME_NONNULL_BEGIN

Firestore/Example/Tests/Util/FSTHelpers.mm

@@ -32,6 +32,7 @@
 #include "Firestore/core/src/firebase/firestore/model/field_value.h"
 #include "Firestore/core/src/firebase/firestore/model/patch_mutation.h"
 #include "Firestore/core/src/firebase/firestore/model/precondition.h"
+#include "Firestore/core/src/firebase/firestore/model/resource_path.h"
 #include "Firestore/core/src/firebase/firestore/model/set_mutation.h"
 #include "Firestore/core/src/firebase/firestore/model/transform_mutation.h"
 #include "Firestore/core/src/firebase/firestore/util/string_apple.h"