fix(custom-resources): flatten objects with null values in AwsCustomR…

…esource (#5073) Fixes #5061
aws · Nov 18, 2019 · f4ea264 · f4ea264
1 parent 6b764ea
commit f4ea264
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 13 deletions.
diff --git a/packages/@aws-cdk/custom-resources/lib/aws-custom-resource/runtime/index.ts b/packages/@aws-cdk/custom-resources/lib/aws-custom-resource/runtime/index.ts
@@ -8,13 +8,13 @@ import { AwsSdkCall } from '../aws-custom-resource';
  * @param object the object to be flattened
  * @returns a flat object with path as keys
  */
-function flatten(object: object): { [key: string]: string } {
+export function flatten(object: object): { [key: string]: string } {
   return Object.assign(
     {},
     ...function _flatten(child: any, path: string[] = []): any {
       return [].concat(...Object.keys(child)
         .map(key =>
-          typeof child[key] === 'object'
+          typeof child[key] === 'object' && child[key] !== null
             ? _flatten(child[key], path.concat([key]))
             : ({ [path.concat([key]).join('.')]: child[key] })
       ));

diff --git a/...s/@aws-cdk/custom-resources/test/aws-custom-resource/aws-custom-resource-provider.test.ts b/...s/@aws-cdk/custom-resources/test/aws-custom-resource/aws-custom-resource-provider.test.ts
@@ -3,7 +3,7 @@ import AWS = require('aws-sdk-mock');
 import nock = require('nock');
 import sinon = require('sinon');
 import { AwsSdkCall } from '../../lib';
-import { handler } from '../../lib/aws-custom-resource/runtime';
+import { flatten, handler } from '../../lib/aws-custom-resource/runtime';
 
 AWS.setSDK(require.resolve('aws-sdk'));
 
@@ -321,3 +321,20 @@ test('can specify apiVersion and region', async () => {
 
   expect(request.isDone()).toBeTruthy();
 });
+
+test('flatten correctly flattens a nested object', () => {
+  expect(flatten({
+    a: { b: 'c' },
+    d: [
+      { e: 'f' },
+      { g: 'h', i: 1, j: null, k: { l: false } }
+    ],
+  })).toEqual({
+    'a.b': 'c',
+    'd.0.e': 'f',
+    'd.1.g': 'h',
+    'd.1.i': 1,
+    'd.1.j': null,
+    'd.1.k.l': false
+  });
+});
diff --git a/...aws-cdk/custom-resources/test/aws-custom-resource/integ.aws-custom-resource.expected.json b/...aws-cdk/custom-resources/test/aws-custom-resource/integ.aws-custom-resource.expected.json
@@ -109,7 +109,7 @@
       "Properties": {
         "Code": {
           "S3Bucket": {
-            "Ref": "AssetParameters44223b510152d51e381791e0347041da535987f7d6f1703b343f9c06f6075059S3Bucket2360388A"
+            "Ref": "AssetParametersba1b614bb55ac13ae885f2efd32be195ffd984700d9dafcccd3102bdba2f9915S3Bucket7871AF0F"
           },
           "S3Key": {
             "Fn::Join": [
@@ -122,7 +122,7 @@
                       "Fn::Split": [
                         "||",
                         {
-                          "Ref": "AssetParameters44223b510152d51e381791e0347041da535987f7d6f1703b343f9c06f6075059S3VersionKey012A5944"
+                          "Ref": "AssetParametersba1b614bb55ac13ae885f2efd32be195ffd984700d9dafcccd3102bdba2f9915S3VersionKey106B28FA"
                         }
                       ]
                     }
@@ -135,7 +135,7 @@
                       "Fn::Split": [
                         "||",
                         {
-                          "Ref": "AssetParameters44223b510152d51e381791e0347041da535987f7d6f1703b343f9c06f6075059S3VersionKey012A5944"
+                          "Ref": "AssetParametersba1b614bb55ac13ae885f2efd32be195ffd984700d9dafcccd3102bdba2f9915S3VersionKey106B28FA"
                         }
                       ]
                     }
@@ -230,17 +230,17 @@
     }
   },
   "Parameters": {
-    "AssetParameters44223b510152d51e381791e0347041da535987f7d6f1703b343f9c06f6075059S3Bucket2360388A": {
+    "AssetParametersba1b614bb55ac13ae885f2efd32be195ffd984700d9dafcccd3102bdba2f9915S3Bucket7871AF0F": {
       "Type": "String",
-      "Description": "S3 bucket for asset \"44223b510152d51e381791e0347041da535987f7d6f1703b343f9c06f6075059\""
+      "Description": "S3 bucket for asset \"ba1b614bb55ac13ae885f2efd32be195ffd984700d9dafcccd3102bdba2f9915\""
     },
-    "AssetParameters44223b510152d51e381791e0347041da535987f7d6f1703b343f9c06f6075059S3VersionKey012A5944": {
+    "AssetParametersba1b614bb55ac13ae885f2efd32be195ffd984700d9dafcccd3102bdba2f9915S3VersionKey106B28FA": {
       "Type": "String",
-      "Description": "S3 key for asset version \"44223b510152d51e381791e0347041da535987f7d6f1703b343f9c06f6075059\""
+      "Description": "S3 key for asset version \"ba1b614bb55ac13ae885f2efd32be195ffd984700d9dafcccd3102bdba2f9915\""
     },
-    "AssetParameters44223b510152d51e381791e0347041da535987f7d6f1703b343f9c06f6075059ArtifactHashE1243C2C": {
+    "AssetParametersba1b614bb55ac13ae885f2efd32be195ffd984700d9dafcccd3102bdba2f9915ArtifactHashADA31147": {
       "Type": "String",
-      "Description": "Artifact hash for asset \"44223b510152d51e381791e0347041da535987f7d6f1703b343f9c06f6075059\""
+      "Description": "Artifact hash for asset \"ba1b614bb55ac13ae885f2efd32be195ffd984700d9dafcccd3102bdba2f9915\""
     }
   },
   "Outputs": {
@@ -269,4 +269,4 @@
       }
     }
   }
-}
+}