Port FSTUsageValidation to C++ (#2670)

* Port FSTUsageValidation to C++

* Add an error log level

Author: wilhuff

FirebaseFirestore.podspec

@@ -41,6 +41,7 @@ Google Cloud Firestore is a NoSQL document database built for automatic scaling,
     'Firestore/third_party/Immutable/Tests/**',
 
     # Exclude alternate implementations for other platforms
+    'Firestore/core/src/firebase/firestore/api/input_validation_std.cc',
     'Firestore/core/src/firebase/firestore/remote/connectivity_monitor_noop.cc',
     'Firestore/core/src/firebase/firestore/remote/grpc_root_certificate_finder_generated.cc',
     'Firestore/core/src/firebase/firestore/util/filesystem_win.cc',

Firestore/Source/API/FIRCollectionReference.mm

@@ -25,13 +25,14 @@
 #import "Firestore/Source/API/FIRQuery+Internal.h"
 #import "Firestore/Source/API/FIRQuery_Init.h"
 #import "Firestore/Source/Core/FSTQuery.h"
-#import "Firestore/Source/Util/FSTUsageValidation.h"
 
+#include "Firestore/core/src/firebase/firestore/api/input_validation.h"
 #include "Firestore/core/src/firebase/firestore/model/document_key.h"
 #include "Firestore/core/src/firebase/firestore/model/resource_path.h"
 #include "Firestore/core/src/firebase/firestore/util/string_apple.h"
 
 namespace util = firebase::firestore::util;
+using firebase::firestore::api::ThrowInvalidArgument;
 using firebase::firestore::model::DocumentKey;
 using firebase::firestore::model::ResourcePath;
 using firebase::firestore::util::CreateAutoId;
@@ -58,9 +59,9 @@ @implementation FIRCollectionReference
 
 - (instancetype)initWithPath:(const ResourcePath &)path firestore:(FIRFirestore *)firestore {
   if (path.size() % 2 != 1) {
-    FSTThrowInvalidArgument(@"Invalid collection reference. Collection references must have an odd "
-                             "number of segments, but %s has %zu",
-                            path.CanonicalString().c_str(), path.size());
+    ThrowInvalidArgument("Invalid collection reference. Collection references must have an odd "
+                         "number of segments, but %s has %s",
+                         path.CanonicalString(), path.size());
   }
   self = [super initWithQuery:[FSTQuery queryWithPath:path] firestore:firestore];
   return self;
@@ -112,7 +113,7 @@ - (NSString *)path {
 
 - (FIRDocumentReference *)documentWithPath:(NSString *)documentPath {
   if (!documentPath) {
-    FSTThrowInvalidArgument(@"Document path cannot be nil.");
+    ThrowInvalidArgument("Document path cannot be nil.");
   }
   const ResourcePath subPath = ResourcePath::FromString(util::MakeString(documentPath));
   ResourcePath path = self.query.path.Append(subPath);

Firestore/Source/API/FIRDocumentReference.mm

@@ -30,10 +30,10 @@
 #import "Firestore/Source/Core/FSTEventManager.h"
 #import "Firestore/Source/Core/FSTQuery.h"
 #import "Firestore/Source/Model/FSTFieldValue.h"
-#import "Firestore/Source/Util/FSTUsageValidation.h"
 
 #include "Firestore/core/src/firebase/firestore/api/document_reference.h"
 #include "Firestore/core/src/firebase/firestore/api/document_snapshot.h"
+#include "Firestore/core/src/firebase/firestore/api/input_validation.h"
 #include "Firestore/core/src/firebase/firestore/core/event_listener.h"
 #include "Firestore/core/src/firebase/firestore/model/document_key.h"
 #include "Firestore/core/src/firebase/firestore/model/document_set.h"
@@ -49,6 +49,7 @@
 using firebase::firestore::api::DocumentReference;
 using firebase::firestore::api::DocumentSnapshot;
 using firebase::firestore::api::Firestore;
+using firebase::firestore::api::ThrowInvalidArgument;
 using firebase::firestore::core::EventListener;
 using firebase::firestore::core::ListenOptions;
 using firebase::firestore::core::ParsedSetData;
@@ -77,9 +78,9 @@ - (instancetype)initWithReference:(DocumentReference &&)reference {
 
 - (instancetype)initWithPath:(ResourcePath)path firestore:(Firestore *)firestore {
   if (path.size() % 2 != 0) {
-    FSTThrowInvalidArgument(@"Invalid document reference. Document references must have an even "
-                             "number of segments, but %s has %zu",
-                            path.CanonicalString().c_str(), path.size());
+    ThrowInvalidArgument("Invalid document reference. Document references must have an even "
+                         "number of segments, but %s has %s",
+                         path.CanonicalString(), path.size());
   }
   return [self initWithKey:DocumentKey{std::move(path)} firestore:firestore];
 }
@@ -125,7 +126,7 @@ - (NSString *)path {
 
 - (FIRCollectionReference *)collectionWithPath:(NSString *)collectionPath {
   if (!collectionPath) {
-    FSTThrowInvalidArgument(@"Collection path cannot be nil.");
+    ThrowInvalidArgument("Collection path cannot be nil.");
   }
 
   ResourcePath subPath = ResourcePath::FromString(util::MakeString(collectionPath));

Firestore/Source/API/FIRDocumentSnapshot.mm

@@ -28,10 +28,10 @@
 #import "Firestore/Source/API/FIRSnapshotMetadata+Internal.h"
 #import "Firestore/Source/Model/FSTDocument.h"
 #import "Firestore/Source/Model/FSTFieldValue.h"
-#import "Firestore/Source/Util/FSTUsageValidation.h"
 
 #include "Firestore/core/src/firebase/firestore/api/document_snapshot.h"
 #include "Firestore/core/src/firebase/firestore/api/firestore.h"
+#include "Firestore/core/src/firebase/firestore/api/input_validation.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/field_value.h"
@@ -41,6 +41,7 @@
 namespace util = firebase::firestore::util;
 using firebase::firestore::api::DocumentSnapshot;
 using firebase::firestore::api::Firestore;
+using firebase::firestore::api::ThrowInvalidArgument;
 using firebase::firestore::model::DatabaseId;
 using firebase::firestore::model::DocumentKey;
 using firebase::firestore::model::FieldValue;
@@ -163,7 +164,7 @@ - (nullable id)valueForField:(id)field
   } else if ([field isKindOfClass:[FIRFieldPath class]]) {
     fieldPath = field;
   } else {
-    FSTThrowInvalidArgument(@"Subscript key must be an NSString or FIRFieldPath.");
+    ThrowInvalidArgument("Subscript key must be an NSString or FIRFieldPath.");
   }
 
   FSTFieldValue *fieldValue = _snapshot.GetValue(fieldPath.internalValue);

Firestore/Source/API/FIRFieldPath.mm

@@ -22,13 +22,14 @@
 #include <vector>
 
 #import "Firestore/Source/API/FIRFieldPath+Internal.h"
-#import "Firestore/Source/Util/FSTUsageValidation.h"
 
+#include "Firestore/core/src/firebase/firestore/api/input_validation.h"
 #include "Firestore/core/src/firebase/firestore/model/field_path.h"
 #include "Firestore/core/src/firebase/firestore/util/hashing.h"
 #include "Firestore/core/src/firebase/firestore/util/string_apple.h"
 
 namespace util = firebase::firestore::util;
+using firebase::firestore::api::ThrowInvalidArgument;
 using firebase::firestore::model::FieldPath;
 
 NS_ASSUME_NONNULL_BEGIN
@@ -44,14 +45,14 @@ @implementation FIRFieldPath
 
 - (instancetype)initWithFields:(NSArray<NSString *> *)fieldNames {
   if (fieldNames.count == 0) {
-    FSTThrowInvalidArgument(@"Invalid field path. Provided names must not be empty.");
+    ThrowInvalidArgument("Invalid field path. Provided names must not be empty.");
   }
 
   std::vector<std::string> field_names;
   field_names.reserve(fieldNames.count);
   for (int i = 0; i < fieldNames.count; ++i) {
     if (fieldNames[i].length == 0) {
-      FSTThrowInvalidArgument(@"Invalid field name at index %d. Field names must not be empty.", i);
+      ThrowInvalidArgument("Invalid field name at index %s. Field names must not be empty.", i);
     }
     field_names.emplace_back(util::MakeString(fieldNames[i]));
   }
@@ -75,15 +76,15 @@ + (instancetype)pathWithDotSeparatedString:(NSString *)path {
           numberOfMatchesInString:path
                           options:0
                             range:NSMakeRange(0, path.length)] > 0) {
-    FSTThrowInvalidArgument(
-        @"Invalid field path (%@). Paths must not contain '~', '*', '/', '[', or ']'", path);
+    ThrowInvalidArgument(
+        "Invalid field path (%s). Paths must not contain '~', '*', '/', '[', or ']'", path);
   }
   @try {
     return [[FIRFieldPath alloc] initWithFields:[path componentsSeparatedByString:@"."]];
   } @catch (NSException *exception) {
-    FSTThrowInvalidArgument(
-        @"Invalid field path (%@). Paths must not be empty, begin with '.', end with '.', or "
-        @"contain '..'",
+    ThrowInvalidArgument(
+        "Invalid field path (%s). Paths must not be empty, begin with '.', end with '.', or "
+        "contain '..'",
         path);
   }
 }

Firestore/Source/API/FIRFirestore.mm

@@ -32,9 +32,9 @@
 #import "Firestore/Source/API/FIRFirestore+Internal.h"
 #import "Firestore/Source/API/FSTFirestoreComponent.h"
 #import "Firestore/Source/API/FSTUserDataConverter.h"
-#import "Firestore/Source/Util/FSTUsageValidation.h"
 
 #include "Firestore/core/src/firebase/firestore/api/firestore.h"
+#include "Firestore/core/src/firebase/firestore/api/input_validation.h"
 #include "Firestore/core/src/firebase/firestore/auth/credentials_provider.h"
 #include "Firestore/core/src/firebase/firestore/core/database_info.h"
 #include "Firestore/core/src/firebase/firestore/model/database_id.h"
@@ -46,6 +46,8 @@
 namespace util = firebase::firestore::util;
 using firebase::firestore::api::DocumentReference;
 using firebase::firestore::api::Firestore;
+using firebase::firestore::api::ThrowIllegalState;
+using firebase::firestore::api::ThrowInvalidArgument;
 using firebase::firestore::auth::CredentialsProvider;
 using firebase::firestore::model::DatabaseId;
 using firebase::firestore::util::AsyncQueue;
@@ -109,9 +111,8 @@ + (void)initialize {
 + (instancetype)firestore {
   FIRApp *app = [FIRApp defaultApp];
   if (!app) {
-    FSTThrowInvalidUsage(@"FIRAppNotConfiguredException",
-                         @"Failed to get FirebaseApp instance. Please call FirebaseApp.configure() "
-                         @"before using Firestore");
+    ThrowIllegalState("Failed to get FirebaseApp instance. Please call FirebaseApp.configure() "
+                      "before using Firestore");
   }
   return [self firestoreForApp:app database:util::WrapNSString(DatabaseId::kDefault)];
 }
@@ -123,13 +124,13 @@ + (instancetype)firestoreForApp:(FIRApp *)app {
 // TODO(b/62410906): make this public
 + (instancetype)firestoreForApp:(FIRApp *)app database:(NSString *)database {
   if (!app) {
-    FSTThrowInvalidArgument(@"FirebaseApp instance may not be nil. Use FirebaseApp.app() if you'd "
-                             "like to use the default FirebaseApp instance.");
+    ThrowInvalidArgument("FirebaseApp instance may not be nil. Use FirebaseApp.app() if you'd like "
+                         "to use the default FirebaseApp instance.");
   }
   if (!database) {
-    FSTThrowInvalidArgument(@"database identifier may not be nil. Use '%s' if you want the default "
-                             "database",
-                            DatabaseId::kDefault);
+    ThrowInvalidArgument("Database identifier may not be nil. Use '%s' if you want the default "
+                         "database",
+                         DatabaseId::kDefault);
   }
 
   id<FSTFirestoreMultiDBProvider> provider =
@@ -182,22 +183,21 @@ - (FSTFirestoreClient *)client {
 
 - (FIRCollectionReference *)collectionWithPath:(NSString *)collectionPath {
   if (!collectionPath) {
-    FSTThrowInvalidArgument(@"Collection path cannot be nil.");
+    ThrowInvalidArgument("Collection path cannot be nil.");
   }
   if ([collectionPath containsString:@"//"]) {
-    FSTThrowInvalidArgument(@"Invalid path (%@). Paths must not contain // in them.",
-                            collectionPath);
+    ThrowInvalidArgument("Invalid path (%s). Paths must not contain // in them.", collectionPath);
   }
 
   return _firestore->GetCollection(util::MakeString(collectionPath));
 }
 
 - (FIRDocumentReference *)documentWithPath:(NSString *)documentPath {
   if (!documentPath) {
-    FSTThrowInvalidArgument(@"Document path cannot be nil.");
+    ThrowInvalidArgument("Document path cannot be nil.");
   }
   if ([documentPath containsString:@"//"]) {
-    FSTThrowInvalidArgument(@"Invalid path (%@). Paths must not contain // in them.", documentPath);
+    ThrowInvalidArgument("Invalid path (%s). Paths must not contain // in them.", documentPath);
   }
 
   DocumentReference documentReference = _firestore->GetDocument(util::MakeString(documentPath));
@@ -215,9 +215,9 @@ - (void)runTransactionWithBlock:(id _Nullable (^)(FIRTransaction *, NSError **))
   // We wrap the function they provide in order to use internal implementation classes for
   // transaction, and to run the user callback block on the proper queue.
   if (!updateBlock) {
-    FSTThrowInvalidArgument(@"Transaction block cannot be nil.");
+    ThrowInvalidArgument("Transaction block cannot be nil.");
   } else if (!completion) {
-    FSTThrowInvalidArgument(@"Transaction completion block cannot be nil.");
+    ThrowInvalidArgument("Transaction completion block cannot be nil.");
   }
 
   _firestore->RunTransaction(updateBlock, queue, completion);
@@ -275,11 +275,11 @@ + (FIRFirestore *)recoverFromFirestore:(Firestore *)firestore {
 
 - (FIRQuery *)collectionGroupWithID:(NSString *)collectionID {
   if (!collectionID) {
-    FSTThrowInvalidArgument(@"Collection ID cannot be nil.");
+    ThrowInvalidArgument("Collection ID cannot be nil.");
   }
   if ([collectionID containsString:@"/"]) {
-    FSTThrowInvalidArgument(
-        @"Invalid collection ID (%@). Collection IDs must not contain / in them.", collectionID);
+    ThrowInvalidArgument("Invalid collection ID (%s). Collection IDs must not contain / in them.",
+                         collectionID);
   }
 
   return _firestore->GetCollectionGroup(collectionID);

Firestore/Source/API/FIRFirestoreSettings.mm

@@ -14,14 +14,15 @@
  * limitations under the License.
  */
 
-#include "Firestore/core/src/firebase/firestore/util/warnings.h"
-
 #import "FIRFirestoreSettings.h"
 
-#import "Firestore/Source/Util/FSTUsageValidation.h"
+#include "Firestore/core/src/firebase/firestore/api/input_validation.h"
+#include "Firestore/core/src/firebase/firestore/util/warnings.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
+using firebase::firestore::api::ThrowInvalidArgument;
+
 static NSString *const kDefaultHost = @"firestore.googleapis.com";
 static const BOOL kDefaultSSLEnabled = YES;
 static const BOOL kDefaultPersistenceEnabled = YES;
@@ -88,28 +89,27 @@ - (id)copyWithZone:(nullable NSZone *)zone {
 
 - (void)setHost:(NSString *)host {
   if (!host) {
-    FSTThrowInvalidArgument(
-        @"host setting may not be nil. You should generally just use the default value "
-         "(which is %@)",
-        kDefaultHost);
+    ThrowInvalidArgument("Host setting may not be nil. You should generally just use the default "
+                         "value (which is %s)",
+                         kDefaultHost);
   }
   _host = [host mutableCopy];
 }
 
 - (void)setDispatchQueue:(dispatch_queue_t)dispatchQueue {
   if (!dispatchQueue) {
-    FSTThrowInvalidArgument(
-        @"dispatch queue setting may not be nil. Create a new dispatch queue with "
-         "dispatch_queue_create(\"com.example.MyQueue\", NULL) or just use the default "
-         "(which is the main queue, returned from dispatch_get_main_queue())");
+    ThrowInvalidArgument(
+        "Dispatch queue setting may not be nil. Create a new dispatch queue with "
+        "dispatch_queue_create(\"com.example.MyQueue\", NULL) or just use the default (which is "
+        "the main queue, returned from dispatch_get_main_queue())");
   }
   _dispatchQueue = dispatchQueue;
 }
 
 - (void)setCacheSizeBytes:(int64_t)cacheSizeBytes {
   if (cacheSizeBytes != kFIRFirestoreCacheSizeUnlimited &&
       cacheSizeBytes < kMinimumCacheSizeBytes) {
-    FSTThrowInvalidArgument(@"Cache size must be set to at least %i bytes", kMinimumCacheSizeBytes);
+    ThrowInvalidArgument("Cache size must be set to at least %s bytes", kMinimumCacheSizeBytes);
   }
   _cacheSizeBytes = cacheSizeBytes;
 }

Firestore/Source/API/FIRGeoPoint.mm

@@ -16,10 +16,10 @@
 
 #import "Firestore/Source/API/FIRGeoPoint+Internal.h"
 
-#import "Firestore/core/src/firebase/firestore/util/comparison.h"
-
-#import "Firestore/Source/Util/FSTUsageValidation.h"
+#include "Firestore/core/src/firebase/firestore/api/input_validation.h"
+#include "Firestore/core/src/firebase/firestore/util/comparison.h"
 
+using firebase::firestore::api::ThrowInvalidArgument;
 using firebase::firestore::util::DoubleBitwiseEquals;
 using firebase::firestore::util::DoubleBitwiseHash;
 using firebase::firestore::util::WrapCompare;
@@ -31,14 +31,14 @@ @implementation FIRGeoPoint
 - (instancetype)initWithLatitude:(double)latitude longitude:(double)longitude {
   if (self = [super init]) {
     if (latitude < -90 || latitude > 90 || !isfinite(latitude)) {
-      FSTThrowInvalidArgument(@"GeoPoint requires a latitude value in the range of [-90, 90], "
-                               "but was %f",
-                              latitude);
+      ThrowInvalidArgument("GeoPoint requires a latitude value in the range of [-90, 90], "
+                           "but was %s",
+                           latitude);
     }
     if (longitude < -180 || longitude > 180 || !isfinite(longitude)) {
-      FSTThrowInvalidArgument(@"GeoPoint requires a longitude value in the range of [-180, 180], "
-                               "but was %f",
-                              longitude);
+      ThrowInvalidArgument("GeoPoint requires a longitude value in the range of [-180, 180], "
+                           "but was %s",
+                           longitude);
     }
 
     _latitude = latitude;