fix(appsync): add caching config to AppSync resolvers #17815
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| import { Duration } from '@aws-cdk/core'; | ||
|
|
||
| /** | ||
| * CachingConfig for AppSync resolvers | ||
| */ | ||
| export interface CachingConfig { | ||
| /** | ||
| * The caching keys for a resolver that has caching enabled. | ||
| * Valid values are entries from the $context.arguments, $context.source, and $context.identity maps. | ||
| * | ||
| * @default - No caching keys | ||
| */ | ||
| readonly cachingKeys?: string[]; | ||
|
|
||
| /** | ||
| * The TTL in seconds for a resolver that has caching enabled. | ||
| * Valid values are between 1 and 3600 seconds. | ||
|
There was a problem hiding this comment. Same thing with this one. There was a problem hiding this comment. Added validation + unit tests for ttl! |
||
| * | ||
| * @default - No TTL | ||
| */ | ||
| readonly ttl?: Duration; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| export const CONTEXT_ARGUMENTS_CACHING_KEY = '$context.arguments'; | ||
| export const CONTEXT_SOURCE_CACHING_KEY = '$context.source'; | ||
| export const CONTEXT_IDENTITY_CACHING_KEY = '$context.identity'; | ||
| export const BASE_CACHING_KEYS = [CONTEXT_ARGUMENTS_CACHING_KEY, CONTEXT_SOURCE_CACHING_KEY, CONTEXT_IDENTITY_CACHING_KEY]; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| import * as path from 'path'; | ||
| import { 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'; | ||
| import * as appsync from '../lib'; | ||
|
|
||
| let stack: cdk.Stack; | ||
| let api: appsync.GraphqlApi; | ||
|
|
||
| beforeEach(() => { | ||
| // GIVEN | ||
| stack = new cdk.Stack(); | ||
| api = new appsync.GraphqlApi(stack, 'api', { | ||
| name: 'api', | ||
| schema: appsync.Schema.fromAsset(path.join(__dirname, 'appsync.lambda.graphql')), | ||
| }); | ||
| }); | ||
|
|
||
| describe('Lambda caching config', () => { | ||
| // GIVEN | ||
| let func: lambda.Function; | ||
|
|
||
| beforeEach(() => { | ||
| func = new lambda.Function(stack, 'func', { | ||
| code: lambda.Code.fromAsset(path.join(__dirname, 'verify/lambda-tutorial')), | ||
| handler: 'lambda-tutorial.handler', | ||
| runtime: lambda.Runtime.NODEJS_12_X, | ||
| }); | ||
| }); | ||
|
|
||
| test('Lambda resolver contains caching config with caching key and TTL', () => { | ||
| // WHEN | ||
| const lambdaDS = api.addLambdaDataSource('LambdaDS', func); | ||
|
|
||
| lambdaDS.createResolver({ | ||
| typeName: 'Query', | ||
| fieldName: 'allPosts', | ||
| cachingConfig: { | ||
| cachingKeys: ['$context.arguments', '$context.source', '$context.identity'], | ||
| ttl: Duration.seconds(300), | ||
| }, | ||
| }); | ||
|
|
||
| // THEN | ||
| Template.fromStack(stack).hasResourceProperties('AWS::AppSync::Resolver', { | ||
| TypeName: 'Query', | ||
| FieldName: 'allPosts', | ||
| CachingConfig: { | ||
| CachingKeys: ['$context.arguments', '$context.source', '$context.identity'], | ||
| Ttl: 300, | ||
| }, | ||
| }); | ||
| }); | ||
|
|
||
| test('Lambda resolver throws error when caching config with TTL is less than 1 second', () => { | ||
| // WHEN | ||
| const ttlInSconds = 0; | ||
| const lambdaDS = api.addLambdaDataSource('LambdaDS', func); | ||
|
|
||
| // THEN | ||
| expect(() => { | ||
| lambdaDS.createResolver({ | ||
| typeName: 'Query', | ||
| fieldName: 'allPosts', | ||
| cachingConfig: { | ||
| cachingKeys: ['$context.identity'], | ||
| ttl: Duration.seconds(0), | ||
| }, | ||
| }); | ||
| }).toThrowError(`Caching config TTL must be between 1 and 3600 seconds. Received: ${ttlInSconds}`); | ||
| }); | ||
|
|
||
| test('Lambda resolver throws error when caching config with TTL is greater than 3600 seconds', () => { | ||
| // WHEN | ||
| const ttlInSconds = 4200; | ||
| const lambdaDS = api.addLambdaDataSource('LambdaDS', func); | ||
|
|
||
| // THEN | ||
| expect(() => { | ||
| lambdaDS.createResolver({ | ||
| typeName: 'Query', | ||
| fieldName: 'allPosts', | ||
| cachingConfig: { | ||
| cachingKeys: ['$context.identity'], | ||
| ttl: Duration.seconds(ttlInSconds), | ||
| }, | ||
| }); | ||
| }).toThrowError(`Caching config TTL must be between 1 and 3600 seconds. Received: ${ttlInSconds}`); | ||
| }); | ||
|
|
||
| test('Lambda resolver throws error when caching config has invalid caching keys', () => { | ||
| // WHEN | ||
| const invalidCachingKeys = ['$context.metadata']; | ||
| const lambdaDS = api.addLambdaDataSource('LambdaDS', func); | ||
|
|
||
| // THEN | ||
| expect(() => { | ||
| lambdaDS.createResolver({ | ||
| typeName: 'Query', | ||
| fieldName: 'allPosts', | ||
| cachingConfig: { | ||
| cachingKeys: invalidCachingKeys, | ||
| ttl: Duration.seconds(300), | ||
| }, | ||
| }); | ||
| }).toThrowError(`Caching config keys must begin with $context.arguments, $context.source or $context.identity. Received: ${invalidCachingKeys}`); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please also add validation for this constraint?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will do!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alright - added validation for caching keys + unit test - added some constants for $context.source, $context.arguments and $context.identity to help validate that caching keys are prefixed by these keys. Technically, there's some VTL syntax that should be adhered to but I think that may be a bit much for CDK to take on.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! One last thing: Before validating you should check whether the value is encoded as a token, using the
Token.isUnresolved()static method.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah cool - I'll make this change!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alright sweet - done! Checked to see if the caching key is resolved first before validating.