add consistent read for dynamoDbGetItem, dynamoDbScanTable and dynamo…

…DbQuery
aws · mergify · Jul 21, 2022 · Jun 22, 2022 · Jun 23, 2022 · Jul 1, 2022
commit fd9454243941f40d23eef4ea16a26d1d5553d31f
diff --git a/packages/@aws-cdk/aws-appsync/README.md b/packages/@aws-cdk/aws-appsync/README.md
@@ -80,7 +80,7 @@ const demoDS = api.addDynamoDbDataSource('demoDataSource', demoTable);
 demoDS.createResolver({
   typeName: 'Query',
   fieldName: 'getDemos',
-  requestMappingTemplate: appsync.MappingTemplate.dynamoDbScanTable(),
+  requestMappingTemplate: appsync.MappingTemplate.dynamoDbScanTable(true),
   responseMappingTemplate: appsync.MappingTemplate.dynamoDbResultList(),
 });
 

diff --git a/packages/@aws-cdk/aws-appsync/lib/mapping-template.ts b/packages/@aws-cdk/aws-appsync/lib/mapping-template.ts
@@ -36,17 +36,17 @@ export abstract class MappingTemplate {
   /**
    * Mapping template to scan a DynamoDB table to fetch all entries
    */
-  public static dynamoDbScanTable(): MappingTemplate {
-    return this.fromString('{"version" : "2017-02-28", "operation" : "Scan"}');
+  public static dynamoDbScanTable(consistentRead: boolean = false): MappingTemplate {
+    return this.fromString(`{"version" : "2017-02-28", "operation" : "Scan", "consistentRead": "${consistentRead}"}`);
   }
 
   /**
    * Mapping template to query a set of items from a DynamoDB table
    *
    * @param cond the key condition for the query
    */
-  public static dynamoDbQuery(cond: KeyCondition, indexName?: string): MappingTemplate {
-    return this.fromString(`{"version" : "2017-02-28", "operation" : "Query", ${indexName ? `"index" : "${indexName}", ` : ''}${cond.renderTemplate()}}`);
+   public static dynamoDbQuery(cond: KeyCondition, consistentRead: boolean = false, indexName?: string): MappingTemplate {
+    return this.fromString(`{"version" : "2017-02-28", "operation" : "Query",  "consistentRead": "${consistentRead}", ${indexName ? `"index" : "${indexName}", ` : ''}${cond.renderTemplate()}}`);
   }
 
   /**
@@ -55,8 +55,8 @@ export abstract class MappingTemplate {
    * @param keyName the name of the hash key field
    * @param idArg the name of the Query argument
    */
-  public static dynamoDbGetItem(keyName: string, idArg: string): MappingTemplate {
-    return this.fromString(`{"version": "2017-02-28", "operation": "GetItem", "key": {"${keyName}": $util.dynamodb.toDynamoDBJson($ctx.args.${idArg})}}`);
+  public static dynamoDbGetItem(keyName: string, idArg: string, consistentRead: boolean = false): MappingTemplate {
+    return this.fromString(`{"version": "2017-02-28", "operation": "GetItem", "consistentRead": "${consistentRead}", "key": {"${keyName}": $util.dynamodb.toDynamoDBJson($ctx.args.${idArg})}}`);
   }
 
   /**

diff --git a/packages/@aws-cdk/aws-appsync/test/integ.api-import.ts b/packages/@aws-cdk/aws-appsync/test/integ.api-import.ts
@@ -46,7 +46,7 @@ const testDS = api.addDynamoDbDataSource('ds', testTable);
 testDS.createResolver({
   typeName: 'Query',
   fieldName: 'getTests',
-  requestMappingTemplate: appsync.MappingTemplate.dynamoDbScanTable(),
+  requestMappingTemplate: appsync.MappingTemplate.dynamoDbScanTable(true),
   responseMappingTemplate: appsync.MappingTemplate.dynamoDbResultList(),
 });
 

diff --git a/packages/@aws-cdk/aws-appsync/test/integ.auth-apikey.ts b/packages/@aws-cdk/aws-appsync/test/integ.auth-apikey.ts
@@ -49,7 +49,7 @@ const testDS = api.addDynamoDbDataSource('testDataSource', testTable);
 testDS.createResolver({
   typeName: 'Query',
   fieldName: 'getTests',
-  requestMappingTemplate: MappingTemplate.dynamoDbScanTable(),
+  requestMappingTemplate: MappingTemplate.dynamoDbScanTable(true),
   responseMappingTemplate: MappingTemplate.dynamoDbResultList(),
 });
 

diff --git a/packages/@aws-cdk/aws-appsync/test/integ.graphql-iam.ts b/packages/@aws-cdk/aws-appsync/test/integ.graphql-iam.ts
@@ -69,14 +69,14 @@ const testDS = api.addDynamoDbDataSource('ds', testTable, { name: 'testDataSourc
 testDS.createResolver({
   typeName: 'Query',
   fieldName: 'getTest',
-  requestMappingTemplate: MappingTemplate.dynamoDbGetItem('id', 'id'),
+  requestMappingTemplate: MappingTemplate.dynamoDbGetItem('id', 'id', true),
   responseMappingTemplate: MappingTemplate.dynamoDbResultItem(),
 });
 
 testDS.createResolver({
   typeName: 'Query',
   fieldName: 'getTests',
-  requestMappingTemplate: MappingTemplate.dynamoDbScanTable(),
+  requestMappingTemplate: MappingTemplate.dynamoDbScanTable(true),
   responseMappingTemplate: MappingTemplate.dynamoDbResultList(),
 });
 

diff --git a/packages/@aws-cdk/aws-appsync/test/integ.graphql-schema.ts b/packages/@aws-cdk/aws-appsync/test/integ.graphql-schema.ts
@@ -67,7 +67,7 @@ const species = api.addType(new appsync.ObjectType('Species', {
 api.addQuery('getPlanets', new appsync.ResolvableField({
   returnType: planet.attribute({ isList: true }),
   dataSource: tableDS,
-  requestMappingTemplate: appsync.MappingTemplate.dynamoDbScanTable(),
+  requestMappingTemplate: appsync.MappingTemplate.dynamoDbScanTable(true),
   responseMappingTemplate: appsync.MappingTemplate.dynamoDbResultList(),
 }));
 

diff --git a/packages/@aws-cdk/aws-appsync/test/integ.graphql.ts b/packages/@aws-cdk/aws-appsync/test/integ.graphql.ts
@@ -114,13 +114,13 @@ const paymentDS = api.addDynamoDbDataSource('paymentDs', paymentTable, { name: '
 customerDS.createResolver({
   typeName: 'Query',
   fieldName: 'getCustomers',
-  requestMappingTemplate: MappingTemplate.dynamoDbScanTable(),
+  requestMappingTemplate: MappingTemplate.dynamoDbScanTable(true),
   responseMappingTemplate: MappingTemplate.dynamoDbResultList(),
 });
 customerDS.createResolver({
   typeName: 'Query',
   fieldName: 'getCustomer',
-  requestMappingTemplate: MappingTemplate.dynamoDbGetItem('id', 'id'),
+  requestMappingTemplate: MappingTemplate.dynamoDbGetItem('id', 'id', true),
   responseMappingTemplate: MappingTemplate.dynamoDbResultItem(),
 });
 customerDS.createResolver({
@@ -165,49 +165,49 @@ for (const { suffix, op } of ops) {
   orderDS.createResolver({
     typeName: 'Query',
     fieldName: 'getCustomerOrders' + suffix,
-    requestMappingTemplate: MappingTemplate.dynamoDbQuery(op('customer', 'customer')),
+    requestMappingTemplate: MappingTemplate.dynamoDbQuery(op('customer', 'customer'), true),
     responseMappingTemplate: MappingTemplate.dynamoDbResultList(),
   });
   orderDS.createResolver({
     typeName: 'Query',
     fieldName: 'getOrderCustomers' + suffix,
-    requestMappingTemplate: MappingTemplate.dynamoDbQuery(op('order', 'order'), 'orderIndex'),
+    requestMappingTemplate: MappingTemplate.dynamoDbQuery(op('order', 'order'), true, 'orderIndex'),
     responseMappingTemplate: MappingTemplate.dynamoDbResultList(),
   });
 }
 orderDS.createResolver({
   typeName: 'Query',
   fieldName: 'getCustomerOrdersFilter',
   requestMappingTemplate: MappingTemplate.dynamoDbQuery(
-    KeyCondition.eq('customer', 'customer').and(KeyCondition.beginsWith('order', 'order'))),
+    KeyCondition.eq('customer', 'customer').and(KeyCondition.beginsWith('order', 'order')), true),
   responseMappingTemplate: MappingTemplate.dynamoDbResultList(),
 });
 orderDS.createResolver({
   typeName: 'Query',
   fieldName: 'getCustomerOrdersBetween',
   requestMappingTemplate: MappingTemplate.dynamoDbQuery(
-    KeyCondition.eq('customer', 'customer').and(KeyCondition.between('order', 'order1', 'order2'))),
+    KeyCondition.eq('customer', 'customer').and(KeyCondition.between('order', 'order1', 'order2')), true),
   responseMappingTemplate: MappingTemplate.dynamoDbResultList(),
 });
 orderDS.createResolver({
   typeName: 'Query',
   fieldName: 'getOrderCustomersFilter',
   requestMappingTemplate: MappingTemplate.dynamoDbQuery(
-    KeyCondition.eq('order', 'order').and(KeyCondition.beginsWith('customer', 'customer'))),
+    KeyCondition.eq('order', 'order').and(KeyCondition.beginsWith('customer', 'customer')), true),
   responseMappingTemplate: MappingTemplate.dynamoDbResultList(),
 });
 orderDS.createResolver({
   typeName: 'Query',
   fieldName: 'getOrderCustomersBetween',
   requestMappingTemplate: MappingTemplate.dynamoDbQuery(
-    KeyCondition.eq('order', 'order').and(KeyCondition.between('customer', 'customer1', 'customer2')), 'orderIndex'),
+    KeyCondition.eq('order', 'order').and(KeyCondition.between('customer', 'customer1', 'customer2')), true, 'orderIndex'),
   responseMappingTemplate: MappingTemplate.dynamoDbResultList(),
 });
 
 paymentDS.createResolver({
   typeName: 'Query',
   fieldName: 'getPayment',
-  requestMappingTemplate: MappingTemplate.dynamoDbGetItem('id', 'id'),
+  requestMappingTemplate: MappingTemplate.dynamoDbGetItem('id', 'id', true),
   responseMappingTemplate: MappingTemplate.dynamoDbResultItem(),
 });
 paymentDS.createResolver({

diff --git a/....snapshot/asset.5d88959fad6bed204d22b24bf15826b8c7591c586a60a313e54f1948d9cdf80f/index.js b/....snapshot/asset.5d88959fad6bed204d22b24bf15826b8c7591c586a60a313e54f1948d9cdf80f/index.js
diff --git a/....snapshot/asset.5d88959fad6bed204d22b24bf15826b8c7591c586a60a313e54f1948d9cdf80f/index.js b/....snapshot/asset.5d88959fad6bed204d22b24bf15826b8c7591c586a60a313e54f1948d9cdf80f/index.js
diff --git a/....snapshot/asset.1e025324752b3133dc230c4b8b8752f666b63c09cd4aa605ec2b322cc40def2e/index.js b/....snapshot/asset.1e025324752b3133dc230c4b8b8752f666b63c09cd4aa605ec2b322cc40def2e/index.js