unify error

Author: schmidt-sebastian

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

@@ -31,7 +31,6 @@ import { ALT_PROJECT_ID, DEFAULT_PROJECT_ID } from '../util/settings';
 const FieldPath = firebaseExport.FieldPath;
 const FieldValue = firebaseExport.FieldValue;
 const newTestFirestore = firebaseExport.newTestFirestore;
-const usesFunctionalApi = firebaseExport.usesFunctionalApi;
 
 // We're using 'as any' to pass invalid values to APIs for testing purposes.
 /* eslint-disable @typescript-eslint/no-explicit-any */
@@ -117,24 +116,14 @@ apiDescribe('Validation:', (persistence: boolean) => {
       persistence,
       'disallows changing settings after use',
       async db => {
-        let errorMsg =
-          'Firestore has already been started and its settings can no ' +
-          'longer be changed. ';
-
-        if (usesFunctionalApi()) {
-          errorMsg +=
-            'initializeFirestore() cannot be called after calling ' +
-            'getFirestore()';
-        } else {
-          errorMsg +=
-            'You can only modify settings before calling any other ' +
-            'methods on a Firestore object.';
-        }
-
         await db.doc('foo/bar').set({});
         expect(() =>
           db.settings({ host: 'something-else.example.com' })
-        ).to.throw(errorMsg);
+        ).to.throw(
+          'Firestore has already been started and its settings can no ' +
+            'longer be changed. You can only modify settings before calling any other ' +
+            'methods on a Firestore object.'
+        );
       }
     );
 
@@ -661,10 +650,9 @@ apiDescribe('Validation:', (persistence: boolean) => {
       expect(() =>
         collection.where('test', '==', { test: FieldValue.increment(1) })
       ).to.throw(
-        `Function ${
-          usesFunctionalApi() ? 'where' : 'Query.where'
-        }() called with invalid data. FieldValue.increment() can only be ` +
-          'used with update() and set() (found in field test)'
+        'Function Query.where() called with invalid data. ' +
+          'FieldValue.increment() can only be used with update() and set() ' +
+          '(found in field test)'
       );
     });
   });
@@ -673,14 +661,10 @@ apiDescribe('Validation:', (persistence: boolean) => {
     validationIt(persistence, 'with non-positive limit fail', db => {
       const collection = db.collection('test');
       expect(() => collection.limit(0)).to.throw(
-        `Function ${
-          usesFunctionalApi() ? 'limit' : 'Query.limit'
-        }() requires a positive number, but it was: 0.`
+        `Function Query.limit() requires a positive number, but it was: 0.`
       );
       expect(() => collection.limitToLast(-1)).to.throw(
-        `Function ${
-          usesFunctionalApi() ? 'limitToLast' : 'Query.limitToLast'
-        }() requires a positive number, but it was: -1.`
+        `Function Query.limitToLast() requires a positive number, but it was: -1.`
       );
     });
 
@@ -771,10 +755,9 @@ apiDescribe('Validation:', (persistence: boolean) => {
         const collection = db.collection('collection');
         const query = collection.orderBy('foo');
         const reason =
-          `Too many arguments provided to ${
-            usesFunctionalApi() ? 'startAt' : 'Query.startAt'
-          }(). The number of arguments must be less than or equal to the ` +
-          `number of orderBy() clauses`;
+          'Too many arguments provided to Query.startAt(). The number of ' +
+          'arguments must be less than or equal to the number of orderBy() ' +
+          'clauses';
         expect(() => query.startAt(1, 2)).to.throw(reason);
         expect(() => query.orderBy('bar').startAt(1, 2, 3)).to.throw(reason);
       }
@@ -792,22 +775,18 @@ apiDescribe('Validation:', (persistence: boolean) => {
           .orderBy(FieldPath.documentId());
         expect(() => query.startAt(1)).to.throw(
           'Invalid query. Expected a string for document ID in ' +
-            `${
-              usesFunctionalApi() ? 'startAt' : 'Query.startAt'
-            }(), but got a number`
+            'Query.startAt(), but got a number'
         );
         expect(() => query.startAt('foo/bar')).to.throw(
-          `Invalid query. When querying a collection and ordering by FieldPath.documentId(), ` +
-            `the value passed to ${
-              usesFunctionalApi() ? 'startAt' : 'Query.startAt'
-            }() must be a plain document ID, but 'foo/bar' contains a slash.`
+          'Invalid query. When querying a collection and ordering by FieldPath.documentId(), ' +
+            'the value passed to Query.startAt() must be a plain document ID, ' +
+            "but 'foo/bar' contains a slash."
         );
         expect(() => cgQuery.startAt('foo')).to.throw(
-          `Invalid query. When querying a collection group and ordering by ` +
-            `FieldPath.documentId(), the value passed to ${
-              usesFunctionalApi() ? 'startAt' : 'Query.startAt'
-            }() must result in a valid document path, but 'foo' is not because ` +
-            `it contains an odd number of segments.`
+          'Invalid query. When querying a collection group and ordering by ' +
+            'FieldPath.documentId(), the value passed to Query.startAt() ' +
+            "must result in a valid document path, but 'foo' is not because " +
+            'it contains an odd number of segments.'
         );
       }
     );
@@ -1287,21 +1266,12 @@ apiDescribe('Validation:', (persistence: boolean) => {
 
     validationIt(persistence, 'cannot pass undefined as a field value', db => {
       const collection = db.collection('test');
-      if (usesFunctionalApi()) {
-        expect(() => collection.where('foo', '==', undefined)).to.throw(
-          'Function where() called with invalid data. Unsupported field value: undefined'
-        );
-        expect(() => collection.orderBy('foo').startAt(undefined)).to.throw(
-          'Function startAt() called with invalid data. Unsupported field value: undefined'
-        );
-      } else {
-        expect(() => collection.where('foo', '==', undefined)).to.throw(
-          'Function Query.where() called with invalid data. Unsupported field value: undefined'
-        );
-        expect(() => collection.orderBy('foo').startAt(undefined)).to.throw(
-          'Function Query.startAt() called with invalid data. Unsupported field value: undefined'
-        );
-      }
+      expect(() => collection.where('foo', '==', undefined)).to.throw(
+        'Function Query.where() called with invalid data. Unsupported field value: undefined'
+      );
+      expect(() => collection.orderBy('foo').startAt(undefined)).to.throw(
+        'Function Query.startAt() called with invalid data. Unsupported field value: undefined'
+      );
     });
   });
 });

packages/firestore/test/integration/util/firebase_export.ts

@@ -46,7 +46,7 @@ import { getFirestore } from '../../../exp/src/api/database';
  * Firestore API. Used to exclude some tests, e.g. those that validate invalid
  * TypeScript input.
  */
-export function usesFunctionalApi(): boolean {
+function usesFunctionalApi(): boolean {
   // Use the firebase namespace to detect if `firebase.firestore` has been
   // registered, which is only registered in the classic version of Firestore.
   return !('firestore' in firebase);