Test for specific exception text.

Author: DellaBitta

packages/firestore/src/util/json_validation.ts

@@ -112,7 +112,7 @@ export function validateJSON<S extends JsonSchema>(
   schema: S
 ): json is Json<S> {
   if (!isPlainObject(json)) {
-    throw new FirestoreError(Code.INVALID_ARGUMENT, 'json must be an object');
+    throw new FirestoreError(Code.INVALID_ARGUMENT, 'JSON must be an object');
   }
   let error: string | undefined = undefined;
   for (const key in schema) {
@@ -121,12 +121,13 @@ export function validateJSON<S extends JsonSchema>(
       const value: { value: unknown } | undefined =
         'value' in schema[key] ? { value: schema[key].value } : undefined;
       if (!(key in json)) {
-        error = `json missing required field: ${key}`;
+        error = `JSON missing required field: '${key}'`;
+        break;
       }
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       const fieldValue = (json as any)[key];
       if (typeString && typeof fieldValue !== typeString) {
-        error = `json field '${key}' must be a ${typeString}.`;
+        error = `JSON field '${key}' must be a ${typeString}.`;
         break;
       } else if (value !== undefined && fieldValue !== value.value) {
         error = `Expected '${key}' field to equal '${value.value}'`;

packages/firestore/test/unit/api/database.test.ts

@@ -97,7 +97,7 @@ describe('DocumentReference', () => {
     const db = newTestFirestore();
     expect(() => {
       DocumentReference.fromJSON(db, {});
-    }).to.throw;
+    }).to.throw("JSON missing required field: 'type'");
   });
 
   it('fromJSON() throws with missing type data', () => {
@@ -108,7 +108,7 @@ describe('DocumentReference', () => {
         bundleName: 'test name',
         bundle: 'test bundle'
       });
-    }).to.throw;
+    }).to.throw("JSON missing required field: 'type'");
   });
 
   it('fromJSON() throws with invalid type data', () => {
@@ -120,7 +120,7 @@ describe('DocumentReference', () => {
         bundleName: 'test name',
         bundle: 'test bundle'
       });
-    }).to.throw;
+    }).to.throw("JSON field 'type' must be a string");
   });
 
   it('fromJSON() throws with missing bundleSource', () => {
@@ -131,7 +131,7 @@ describe('DocumentReference', () => {
         bundleName: 'test name',
         bundle: 'test bundle'
       });
-    }).to.throw;
+    }).to.throw("JSON missing required field: 'bundleSource'");
   });
 
   it('fromJSON() throws with invalid bundleSource type', () => {
@@ -143,7 +143,7 @@ describe('DocumentReference', () => {
         bundleName: 'test name',
         bundle: 'test bundle'
       });
-    }).to.throw;
+    }).to.throw("JSON field 'bundleSource' must be a string");
   });
 
   it('fromJSON() throws with invalid bundleSource value', () => {
@@ -155,7 +155,7 @@ describe('DocumentReference', () => {
         bundleName: 'test name',
         bundle: 'test bundle'
       });
-    }).to.throw;
+    }).to.throw("Expected 'bundleSource' field to equal 'DocumentSnapshot'");
   });
 
   it('fromJSON() throws with missing bundleName', () => {
@@ -166,7 +166,7 @@ describe('DocumentReference', () => {
         bundleSource: 'DocumentSnapshot',
         bundle: 'test bundle'
       });
-    }).to.throw;
+    }).to.throw("JSON missing required field: 'bundleName'");
   });
 
   it('fromJSON() throws with invalid bundleName', () => {
@@ -178,7 +178,7 @@ describe('DocumentReference', () => {
         bundleName: 1,
         bundle: 'test bundle'
       });
-    }).to.throw;
+    }).to.throw("JSON field 'bundleName' must be a string");
   });
 
   it('fromJSON() throws with missing bundle', () => {
@@ -189,7 +189,7 @@ describe('DocumentReference', () => {
         bundleSource: 'DocumentSnapshot',
         bundleName: 'test name'
       });
-    }).to.throw;
+    }).to.throw("JSON missing required field: 'bundle'");
   });
 
   it('fromJSON() throws with invalid bundle', () => {
@@ -201,7 +201,7 @@ describe('DocumentReference', () => {
         bundleName: 'test name',
         bundle: 1
       });
-    }).to.throw;
+    }).to.throw("JSON field 'bundle' must be a string");
   });
 
   it('fromJSON() does not throw', () => {
@@ -500,7 +500,7 @@ describe('QuerySnapshot', () => {
     const db = newTestFirestore();
     expect(() => {
       querySnapshotFromJSON(db, {});
-    }).to.throw;
+    }).to.throw("JSON missing required field: 'type'");
   });
 
   it('fromJSON() throws with missing type data', () => {
@@ -511,7 +511,7 @@ describe('QuerySnapshot', () => {
         bundleName: 'test name',
         bundle: 'test bundle'
       });
-    }).to.throw;
+    }).to.throw("JSON missing required field: 'type'");
   });
 
   it('fromJSON() throws with invalid type data', () => {
@@ -523,18 +523,18 @@ describe('QuerySnapshot', () => {
         bundleName: 'test name',
         bundle: 'test bundle'
       });
-    }).to.throw;
+    }).to.throw("JSON field 'type' must be a string");
   });
 
-  it('fromJSON() throws with invalid type data', () => {
+  it('fromJSON() throws with missing bundle source data', () => {
     const db = newTestFirestore();
     expect(() => {
       querySnapshotFromJSON(db, {
         type: QuerySnapshot._jsonSchemaVersion,
         bundleName: 'test name',
         bundle: 'test bundle'
       });
-    }).to.throw;
+    }).to.throw("JSON missing required field: 'bundleSource'");
   });
 
   it('fromJSON() throws with invalid bundleSource type', () => {
@@ -546,7 +546,7 @@ describe('QuerySnapshot', () => {
         bundleName: 'test name',
         bundle: 'test bundle'
       });
-    }).to.throw;
+    }).to.throw("JSON field 'bundleSource' must be a string");
   });
 
   it('fromJSON() throws with invalid bundleSource value', () => {
@@ -558,7 +558,7 @@ describe('QuerySnapshot', () => {
         bundleName: 'test name',
         bundle: 'test bundle'
       });
-    }).to.throw;
+    }).to.throw("Expected 'bundleSource' field to equal 'QuerySnapshot'");
   });
 
   it('fromJSON() throws with missing bundleName', () => {
@@ -569,7 +569,7 @@ describe('QuerySnapshot', () => {
         bundleSource: 'QuerySnapshot',
         bundle: 'test bundle'
       });
-    }).to.throw;
+    }).to.throw("JSON missing required field: 'bundleName'");
   });
 
   it('fromJSON() throws with invalid bundleName', () => {
@@ -581,21 +581,21 @@ describe('QuerySnapshot', () => {
         bundleName: 1,
         bundle: 'test bundle'
       });
-    }).to.throw;
+    }).to.throw("JSON field 'bundleName' must be a string");
   });
 
-  it('fromJSON() throws with missing bundle data', () => {
+  it('fromJSON() throws with missing bundle field', () => {
     const db = newTestFirestore();
     expect(() => {
       querySnapshotFromJSON(db, {
         type: QuerySnapshot._jsonSchemaVersion,
         bundleSource: 'QuerySnapshot',
         bundleName: 'test name'
       });
-    }).to.throw;
+    }).to.throw("JSON missing required field: 'bundle'");
   });
 
-  it('fromJSON() throws with invalid bundle data', () => {
+  it('fromJSON() throws with invalid bundle field', () => {
     const db = newTestFirestore();
     expect(() => {
       querySnapshotFromJSON(db, {
@@ -604,7 +604,7 @@ describe('QuerySnapshot', () => {
         bundleName: 'test name',
         bundle: 1
       });
-    }).to.throw;
+    }).to.throw("JSON field 'bundle' must be a string");
   });
 
   it('fromJSON does not throw', () => {