fix(appsync): empty caching config is created when not provided (#17947)

If the `cachingConfig` property is not provided, the library is generating an empty config. Change this to not add any config to the template. Related to #17925. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
aws · Dec 10, 2021 · 3a9f206 · 3a9f206
1 parent f02fcb4
commit 3a9f206
Show file tree

Hide file tree

Showing 9 changed files with 27 additions and 44 deletions.
diff --git a/packages/@aws-cdk/aws-appsync/lib/resolver.ts b/packages/@aws-cdk/aws-appsync/lib/resolver.ts
@@ -114,15 +114,20 @@ export class Resolver extends CoreConstruct {
       pipelineConfig: pipelineConfig,
       requestMappingTemplate: props.requestMappingTemplate ? props.requestMappingTemplate.renderTemplate() : undefined,
       responseMappingTemplate: props.responseMappingTemplate ? props.responseMappingTemplate.renderTemplate() : undefined,
-      cachingConfig: {
-        cachingKeys: props.cachingConfig?.cachingKeys,
-        ttl: props.cachingConfig?.ttl?.toSeconds(),
-      },
+      cachingConfig: this.createCachingConfig(props.cachingConfig),
     });
     props.api.addSchemaDependency(this.resolver);
     if (props.dataSource) {
       this.resolver.addDependsOn(props.dataSource.ds);
     }
     this.arn = this.resolver.attrResolverArn;
   }
+
+  private createCachingConfig(config?: CachingConfig) {
+    return config ? {
+      cachingKeys: config.cachingKeys,
+      ttl: config.ttl?.toSeconds(),
+    } : undefined;
+  }
+
 }
diff --git a/packages/@aws-cdk/aws-appsync/test/appsync-caching-config.test.ts b/packages/@aws-cdk/aws-appsync/test/appsync-caching-config.test.ts
@@ -1,5 +1,5 @@
 import * as path from 'path';
-import { Template } from '@aws-cdk/assertions';
+import { Match, Template } from '@aws-cdk/assertions';
 import * as lambda from '@aws-cdk/aws-lambda';
 import * as cdk from '@aws-cdk/core';
 import { Duration } from '@aws-cdk/core';
@@ -29,6 +29,23 @@ describe('Lambda caching config', () => {
     });
   });
 
+  test('Lambda resolver can be created without caching config', () => {
+    // WHEN
+    const lambdaDS = api.addLambdaDataSource('LambdaDS', func);
+
+    lambdaDS.createResolver({
+      typeName: 'Query',
+      fieldName: 'allPosts',
+    });
+
+    // THEN
+    Template.fromStack(stack).hasResourceProperties('AWS::AppSync::Resolver', {
+      TypeName: 'Query',
+      FieldName: 'allPosts',
+      CachingConfig: Match.absent(),
+    });
+  });
+
   test('Lambda resolver contains caching config with caching key and TTL', () => {
     // WHEN
     const lambdaDS = api.addLambdaDataSource('LambdaDS', func);

diff --git a/packages/@aws-cdk/aws-appsync/test/integ.api-import.expected.json b/packages/@aws-cdk/aws-appsync/test/integ.api-import.expected.json
@@ -143,7 +143,6 @@
           },
           "FieldName": "getTests",
           "TypeName": "Query",
-          "CachingConfig": {},
           "DataSourceName": "ds",
           "Kind": "UNIT",
           "RequestMappingTemplate": "{\"version\" : \"2017-02-28\", \"operation\" : \"Scan\"}",
@@ -161,7 +160,6 @@
           },
           "FieldName": "addTest",
           "TypeName": "Mutation",
-          "CachingConfig": {},
           "DataSourceName": "ds",
           "Kind": "UNIT",
           "RequestMappingTemplate": "\n      #set($input = $ctx.args.test)\n      \n      {\n        \"version\": \"2017-02-28\",\n        \"operation\": \"PutItem\",\n        \"key\" : {\n      \"id\" : $util.dynamodb.toDynamoDBJson($util.autoId())\n    },\n        \"attributeValues\": $util.dynamodb.toMapValuesJson($input)\n      }",
@@ -225,7 +223,6 @@
           },
           "FieldName": "version",
           "TypeName": "test",
-          "CachingConfig": {},
           "Kind": "PIPELINE",
           "PipelineConfig": {
             "Functions": [

diff --git a/packages/@aws-cdk/aws-appsync/test/integ.appsync-lambda.expected.json b/packages/@aws-cdk/aws-appsync/test/integ.appsync-lambda.expected.json
@@ -114,7 +114,6 @@
         },
         "FieldName": "getPost",
         "TypeName": "Query",
-        "CachingConfig": {},
         "DataSourceName": "LambdaDS",
         "Kind": "UNIT",
         "RequestMappingTemplate": "{\"version\": \"2017-02-28\", \"operation\": \"Invoke\", \"payload\": { \"field\": \"getPost\", \"arguments\": $utils.toJson($context.arguments)}}",
@@ -136,7 +135,6 @@
         },
         "FieldName": "allPosts",
         "TypeName": "Query",
-        "CachingConfig": {},
         "DataSourceName": "LambdaDS",
         "Kind": "UNIT",
         "RequestMappingTemplate": "{\"version\": \"2017-02-28\", \"operation\": \"Invoke\", \"payload\": { \"field\": \"allPosts\"}}",
@@ -158,7 +156,6 @@
         },
         "FieldName": "addPost",
         "TypeName": "Mutation",
-        "CachingConfig": {},
         "DataSourceName": "LambdaDS",
         "Kind": "UNIT",
         "RequestMappingTemplate": "{\"version\": \"2017-02-28\", \"operation\": \"Invoke\", \"payload\": { \"field\": \"addPost\", \"arguments\": $utils.toJson($context.arguments)}}",
@@ -180,7 +177,6 @@
         },
         "FieldName": "relatedPosts",
         "TypeName": "Post",
-        "CachingConfig": {},
         "DataSourceName": "LambdaDS",
         "Kind": "UNIT",
         "RequestMappingTemplate": "{\"version\": \"2017-02-28\", \"operation\": \"BatchInvoke\", \"payload\": { \"field\": \"relatedPosts\", \"source\": $utils.toJson($context.source)}}",

diff --git a/packages/@aws-cdk/aws-appsync/test/integ.auth-apikey.expected.json b/packages/@aws-cdk/aws-appsync/test/integ.auth-apikey.expected.json
@@ -132,7 +132,6 @@
         },
         "FieldName": "getTests",
         "TypeName": "Query",
-        "CachingConfig": {},
         "DataSourceName": "testDataSource",
         "Kind": "UNIT",
         "RequestMappingTemplate": "{\"version\" : \"2017-02-28\", \"operation\" : \"Scan\"}",
@@ -154,7 +153,6 @@
         },
         "FieldName": "addTest",
         "TypeName": "Mutation",
-        "CachingConfig": {},
         "DataSourceName": "testDataSource",
         "Kind": "UNIT",
         "RequestMappingTemplate": "\n      #set($input = $ctx.args.test)\n      \n      {\n        \"version\": \"2017-02-28\",\n        \"operation\": \"PutItem\",\n        \"key\" : {\n      \"id\" : $util.dynamodb.toDynamoDBJson($util.autoId())\n    },\n        \"attributeValues\": $util.dynamodb.toMapValuesJson($input)\n      }",

diff --git a/packages/@aws-cdk/aws-appsync/test/integ.graphql-elasticsearch.expected.json b/packages/@aws-cdk/aws-appsync/test/integ.graphql-elasticsearch.expected.json
@@ -196,7 +196,6 @@
         },
         "FieldName": "getTests",
         "TypeName": "Query",
-        "CachingConfig": {},
         "DataSourceName": "ds",
         "Kind": "UNIT",
         "RequestMappingTemplate": "{\"version\":\"2017-02-28\",\"operation\":\"GET\",\"path\":\"/id/post/_search\",\"params\":{\"headers\":{},\"queryString\":{},\"body\":{\"from\":0,\"size\":50}}}",

diff --git a/packages/@aws-cdk/aws-appsync/test/integ.graphql-iam.expected.json b/packages/@aws-cdk/aws-appsync/test/integ.graphql-iam.expected.json
@@ -163,7 +163,6 @@
         },
         "FieldName": "getTest",
         "TypeName": "Query",
-        "CachingConfig": {},
         "DataSourceName": "testDataSource",
         "Kind": "UNIT",
         "RequestMappingTemplate": "{\"version\": \"2017-02-28\", \"operation\": \"GetItem\", \"key\": {\"id\": $util.dynamodb.toDynamoDBJson($ctx.args.id)}}",
@@ -185,7 +184,6 @@
         },
         "FieldName": "getTests",
         "TypeName": "Query",
-        "CachingConfig": {},
         "DataSourceName": "testDataSource",
         "Kind": "UNIT",
         "RequestMappingTemplate": "{\"version\" : \"2017-02-28\", \"operation\" : \"Scan\"}",
@@ -207,7 +205,6 @@
         },
         "FieldName": "addTest",
         "TypeName": "Mutation",
-        "CachingConfig": {},
         "DataSourceName": "testDataSource",
         "Kind": "UNIT",
         "RequestMappingTemplate": "\n      #set($input = $ctx.args.test)\n      \n      {\n        \"version\": \"2017-02-28\",\n        \"operation\": \"PutItem\",\n        \"key\" : {\n      \"id\" : $util.dynamodb.toDynamoDBJson($util.autoId())\n    },\n        \"attributeValues\": $util.dynamodb.toMapValuesJson($input)\n      }",

diff --git a/packages/@aws-cdk/aws-appsync/test/integ.graphql-schema.expected.json b/packages/@aws-cdk/aws-appsync/test/integ.graphql-schema.expected.json
@@ -131,7 +131,6 @@
         },
         "FieldName": "getPlanets",
         "TypeName": "Query",
-        "CachingConfig": {},
         "DataSourceName": "planets",
         "Kind": "UNIT",
         "RequestMappingTemplate": "{\"version\" : \"2017-02-28\", \"operation\" : \"Scan\"}",
@@ -153,7 +152,6 @@
         },
         "FieldName": "addPlanet",
         "TypeName": "Mutation",
-        "CachingConfig": {},
         "DataSourceName": "planets",
         "Kind": "UNIT",
         "RequestMappingTemplate": "\n      #set($input = $context.arguments)\n      $util.qr($input.put(\"name\", $context.arguments.name))\n$util.qr($input.put(\"diameter\", $context.arguments.diameter))\n$util.qr($input.put(\"rotationPeriod\", $context.arguments.rotationPeriod))\n$util.qr($input.put(\"orbitalPeriod\", $context.arguments.orbitalPeriod))\n$util.qr($input.put(\"gravityPeriod\", $context.arguments.gravity))\n$util.qr($input.put(\"population\", $context.arguments.population))\n$util.qr($input.put(\"climates\", $context.arguments.climates))\n$util.qr($input.put(\"terrains\", $context.arguments.terrains))\n$util.qr($input.put(\"surfaceWater\", $context.arguments.surfaceWater))\n      {\n        \"version\": \"2017-02-28\",\n        \"operation\": \"PutItem\",\n        \"key\" : {\n      \"id\" : $util.dynamodb.toDynamoDBJson($util.autoId())\n    },\n        \"attributeValues\": $util.dynamodb.toMapValuesJson($input)\n      }",