Throw for sparse arrays

Author: lahirumaramba

src/data-connect/data-connect-api-client-internal.ts

@@ -215,6 +215,11 @@ export class DataConnectApiClient {
       return String(data);
     }
     if (validator.isArray(data)) {
+      if (this.hasNullOrUndefinedElements(data)) {
+        throw new FirebaseDataConnectError(
+          DATA_CONNECT_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
+          'Array elements cannot contain `null` or `undefined` values.'); 
+      }
       const elements = data.map(item => this.objectToString(item)).join(', ');
       return `[${elements}]`;
     }
@@ -263,6 +268,10 @@ export class DataConnectApiClient {
     throw err;
   }
 
+  private hasNullOrUndefinedElements(arr: Array<unknown>): boolean {
+    return arr.includes(null) || arr.includes(undefined);
+  }
+
   /**
    * Insert a single row into the specified table.
    */

test/unit/data-connect/data-connect-api-client-internal.spec.ts

@@ -261,9 +261,14 @@ describe('DataConnectApiClient CRUD helpers', () => {
     },
     notes: undefined,
     releaseYear: undefined,
-    extras: [1, undefined, 'hello', undefined, { a: 1, b: undefined }]
+    extras: [1, 'hello', { a: 1, b: undefined }]
   };
 
+  const dataWithSparseArray = {
+    genre: 'Action',
+    extras: [1, undefined, 'hello', undefined, { a: 1, b: undefined }]
+  }
+
   const tableNames = ['movie', 'Movie', 'MOVIE', 'mOvIE', 'toybox', 'toyBox', 'toyBOX', 'ToyBox', 'TOYBOX'];
   const formatedTableNames = ['movie', 'movie', 'mOVIE', 'mOvIE', 'toybox', 'toyBox', 'toyBOX', 'toyBox', 'tOYBOX'];
 
@@ -343,7 +348,7 @@ describe('DataConnectApiClient CRUD helpers', () => {
        title: "Die Hard",
        ratings: null,
        director: {},
-       extras: [1, null, "hello", null, { a: 1 }]
+       extras: [1, "hello", { a: 1 }]
        })
       }`;
       await apiClient.insert(tableName, dataWithUndefined);
@@ -369,6 +374,16 @@ describe('DataConnectApiClient CRUD helpers', () => {
       await expect(apiClientQueryError.insert(tableName, { data: 1 }))
         .to.be.rejectedWith(FirebaseDataConnectError, `${serverErrorString}. ${additionalErrorMessageForBulkImport}`);
     });
+
+    [
+      { a: [null] }, { a: [undefined] }, { a: [1, null, 2] }, { a: [1, undefined, 2] },
+      { a: ['a', null, 'b', undefined, 'd'] }, dataWithSparseArray
+    ].forEach((data) => {
+      it('should throw FirebaseDataConnectError for arrays with null or undefined elements', async () => {
+        await expect(apiClient.insert(tableName, data))
+          .to.be.rejectedWith(FirebaseDataConnectError, /Array elements cannot contain `null` or `undefined` values./);
+      });
+    });
   });
 
   // --- INSERT MANY TESTS ---
@@ -417,14 +432,14 @@ describe('DataConnectApiClient CRUD helpers', () => {
        title: "Die Hard",
        ratings: null,
        director: {},
-       extras: [1, null, "hello", null, { a: 1 }]
+       extras: [1, "hello", { a: 1 }]
       },
       {
        genre: "Action",
        title: "Die Hard",
        ratings: null,
        director: {},
-       extras: [1, null, "hello", null, { a: 1 }]
+       extras: [1, "hello", { a: 1 }]
       }])
       }`;
       await apiClient.insertMany(tableName, dataArray);
@@ -455,6 +470,16 @@ describe('DataConnectApiClient CRUD helpers', () => {
       await expect(apiClientQueryError.insertMany(tableName, [{ data: 1 }]))
         .to.be.rejectedWith(FirebaseDataConnectError, `${serverErrorString}. ${additionalErrorMessageForBulkImport}`);
     });
+
+    [
+      [null], [undefined], [1, null, 2], [1, undefined, 2],
+      ['a', null, 'b', undefined, 'd'], [dataWithSparseArray]
+    ].forEach((data) => {
+      it('should throw FirebaseDataConnectError for arrays with null or undefined elements', async () => {
+        await expect(apiClient.insertMany(tableName, data))
+          .to.be.rejectedWith(FirebaseDataConnectError, /Array elements cannot contain `null` or `undefined` values./);
+      });
+    });
   });
 
   // --- UPSERT TESTS ---
@@ -476,10 +501,10 @@ describe('DataConnectApiClient CRUD helpers', () => {
     });
 
     it('should call executeGraphql with the correct mutation for complex data', async () => {
-      const complexData = { id: 'key2', active: false, items: [1, null], detail: { status: 'done/\\' } };
+      const complexData = { id: 'key2', active: false, items: [1, 2], detail: { status: 'done/\\' } };
       const expectedMutation = `
       mutation { ${formatedTableName}_upsert(data: 
-      { id: "key2", active: false, items: [1, null], detail: { status: "done/\\\\" } }) }`;
+      { id: "key2", active: false, items: [1, 2], detail: { status: "done/\\\\" } }) }`;
       await apiClient.upsert(tableName, complexData);
       expect(executeGraphqlStub).to.have.been.calledOnceWithExactly(normalizeGraphQLString(expectedMutation));
     });
@@ -492,7 +517,7 @@ describe('DataConnectApiClient CRUD helpers', () => {
        title: "Die Hard",
        ratings: null,
        director: {},
-       extras: [1, null, "hello", null, { a: 1 }]
+       extras: [1, "hello", { a: 1 }]
        })
       }`;
       await apiClient.upsert(tableName, dataWithUndefined);
@@ -518,6 +543,16 @@ describe('DataConnectApiClient CRUD helpers', () => {
       await expect(apiClientQueryError.upsert(tableName, { data: 1 }))
         .to.be.rejectedWith(FirebaseDataConnectError, `${serverErrorString}. ${additionalErrorMessageForBulkImport}`);
     });
+
+    [
+      { a: [null] }, { a: [undefined] }, { a: [1, null, 2] }, { a: [1, undefined, 2] },
+      { a: ['a', null, 'b', undefined, 'd'] }, dataWithSparseArray
+    ].forEach((data) => {
+      it('should throw FirebaseDataConnectError for arrays with null or undefined elements', async () => {
+        await expect(apiClient.upsert(tableName, data))
+          .to.be.rejectedWith(FirebaseDataConnectError, /Array elements cannot contain `null` or `undefined` values./);
+      });
+    });
   });
 
   // --- UPSERT MANY TESTS ---
@@ -542,11 +577,11 @@ describe('DataConnectApiClient CRUD helpers', () => {
     it('should call executeGraphql with the correct mutation for complex data array', async () => {
       const complexDataArray = [
         { id: 'x', active: true, info: { nested: 'n1/\\"x' } },
-        { id: 'y', scores: [null, 2] }
+        { id: 'y', scores: [1, 2] }
       ];
       const expectedMutation = `
       mutation { ${formatedTableName}_upsertMany(data: 
-      [{ id: "x", active: true, info: { nested: "n1/\\\\\\"x" } }, { id: "y", scores: [null, 2] }]) }`;
+      [{ id: "x", active: true, info: { nested: "n1/\\\\\\"x" } }, { id: "y", scores: [1, 2] }]) }`;
       await apiClient.upsertMany(tableName, complexDataArray);
       expect(executeGraphqlStub).to.have.been.calledOnceWithExactly(normalizeGraphQLString(expectedMutation));
     });
@@ -563,14 +598,14 @@ describe('DataConnectApiClient CRUD helpers', () => {
        title: "Die Hard",
        ratings: null,
        director: {},
-       extras: [1, null, "hello", null, { a: 1 }]
+       extras: [1, "hello", { a: 1 }]
       },
       {
        genre: "Action",
        title: "Die Hard",
        ratings: null,
        director: {},
-       extras: [1, null, "hello", null, { a: 1 }]
+       extras: [1, "hello", { a: 1 }]
       }])
       }`;
       await apiClient.upsertMany(tableName, dataArray);
@@ -601,5 +636,15 @@ describe('DataConnectApiClient CRUD helpers', () => {
       await expect(apiClientQueryError.upsertMany(tableName, [{ data: 1 }]))
         .to.be.rejectedWith(FirebaseDataConnectError, `${serverErrorString}. ${additionalErrorMessageForBulkImport}`);
     });
+
+    [
+      [null], [undefined], [1, null, 2], [1, undefined, 2],
+      ['a', null, 'b', undefined, 'd'], [dataWithSparseArray]
+    ].forEach((data) => {
+      it('should throw FirebaseDataConnectError for arrays with null or undefined elements', async () => {
+        await expect(apiClient.upsertMany(tableName, data))
+          .to.be.rejectedWith(FirebaseDataConnectError, /Array elements cannot contain `null` or `undefined` values./);
+      });
+    });
   });
 });