fix: not check sub-property existence for null values (#1330)

Co-authored-by: danieljbruce <[email protected]>
googleapis · Nov 20, 2024 · 5c0ddbc · 5c0ddbc
1 parent ea17528
commit 5c0ddbc
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 0 deletions.
diff --git a/src/entity.ts b/src/entity.ts
@@ -819,6 +819,8 @@ export namespace entity {
     return entityProto;
 
     function excludePathFromEntity(entity: EntityProto, path: string) {
+      if (!entity) return;
+
       const arrayIndex = path.indexOf('[]');
       const entityIndex = path.indexOf('.');
       const wildcardIndex = path.indexOf('.*');
@@ -905,6 +907,7 @@ export namespace entity {
         isFirstPathPartDefined
       ) {
         const array = entity.properties![firstPathPart].arrayValue;
+        if (!array) return;
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         array.values.forEach((value: any) => {
           if (value.entityValue) {

diff --git a/test/entity.ts b/test/entity.ts
@@ -1116,6 +1116,48 @@ describe('entity', () => {
         expectedEntityProto
       );
     });
+
+    it('should not throw when `null` value is supplied for a field with an entity/array index exclusion', () => {
+      const entityObject = {
+        excludeFromIndexes: [
+          'entityCompletelyExcluded.*',
+          'entityPropertyExcluded.name',
+          'entityArrayCompletelyExcluded[].*',
+          'entityArrayPropertyExcluded[].name',
+        ],
+
+        data: {
+          entityCompletelyExcluded: null,
+          entityPropertyExcluded: null,
+          entityArrayCompletelyExcluded: null,
+          entityArrayPropertyExcluded: null,
+        },
+      };
+
+      const expectedEntityProto = {
+        key: null,
+        properties: {
+          entityCompletelyExcluded: {
+            nullValue: 0,
+            excludeFromIndexes: true,
+          },
+          entityPropertyExcluded: {
+            nullValue: 0,
+          },
+          entityArrayCompletelyExcluded: {
+            nullValue: 0,
+          },
+          entityArrayPropertyExcluded: {
+            nullValue: 0,
+          },
+        },
+      };
+
+      assert.deepStrictEqual(
+        testEntity.entityToEntityProto(entityObject),
+        expectedEntityProto
+      );
+    });
   });
 
   describe('formatArray', () => {