fix(api-cors-lambda-crud-dynamodb example): Implement use of NodejsFu…

…nction, replaced deprecated API (#468) * fix(package.json,src,index.ts,tsconfig.json): Implement use of NodejsFunction, renamed src -> lambdas, upgraded lambda runtime from node 10 -> 14 ref PR #278 * clean: using direct imports, removed duplicate NodeJsFunctionProps, added newlines * clean: format tsconfig.json spacing from 4 -> 2
aws-samples · Jul 10, 2021 · 16bca6b · 16bca6b
1 parent 9bf9953
commit 16bca6b
Show file tree

Hide file tree

Showing 12 changed files with 168 additions and 133 deletions.
diff --git a/typescript/api-cors-lambda-crud-dynamodb/README.md b/typescript/api-cors-lambda-crud-dynamodb/README.md
@@ -23,7 +23,7 @@ npm install
 npm run build
 ```
 
-This will install the necessary CDK, then this example's dependencies, and then build your TypeScript files and your CloudFormation template.
+This will install the necessary CDK, then this example's dependencies, then the lambda functions' dependencies, and then build your TypeScript files and your CloudFormation template.
 
 ## Deploy
 
@@ -36,11 +36,11 @@ After the deployment you will see the API's URL, which represents the url you ca
 The whole component contains:
 
 - An API, with CORS enabled on all HTTTP Methods. (Use with caution, for production apps you will want to enable only a certain domain origin to be able to query your API.)
-- Lambda pointing to `src/create.ts`, containing code for __storing__ an item  into the DynamoDB table.
-- Lambda pointing to `src/delete-one.ts`, containing code for __deleting__ an item from the DynamoDB table.
-- Lambda pointing to `src/get-all.ts`, containing code for __getting all items__ from the DynamoDB table.
-- Lambda pointing to `src/get-one.ts`, containing code for __getting an item__ from the DynamoDB table.
-- Lambda pointing to `src/update-one.ts`, containing code for __updating an item__ in the DynamoDB table.
+- Lambda pointing to `lambdas/create.ts`, containing code for __storing__ an item  into the DynamoDB table.
+- Lambda pointing to `lambdas/delete-one.ts`, containing code for __deleting__ an item from the DynamoDB table.
+- Lambda pointing to `lambdas/get-all.ts`, containing code for __getting all items__ from the DynamoDB table.
+- Lambda pointing to `lambdas/get-one.ts`, containing code for __getting an item__ from the DynamoDB table.
+- Lambda pointing to `lambdas/update-one.ts`, containing code for __updating an item__ in the DynamoDB table.
 - A DynamoDB table `items` that stores the data.
 - Five `LambdaIntegrations` that connect these Lambdas to the API.
 
@@ -49,8 +49,9 @@ The whole component contains:
 The [`cdk.json`](./cdk.json) file in the root of this repository includes
 instructions for the CDK toolkit on how to execute this program.
 
-After building your TypeScript code, you will be able to run the CDK toolkits commands as usual:
+After building your TypeScript code, you will be able to run the CDK toolkit commands as usual:
 
+```bash
     $ cdk ls
     <list all stacks in this program>
 
@@ -62,3 +63,4 @@ After building your TypeScript code, you will be able to run the CDK toolkits co
 
     $ cdk diff
     <shows diff against deployed stack>
+```
diff --git a/typescript/api-cors-lambda-crud-dynamodb/cdk.json b/typescript/api-cors-lambda-crud-dynamodb/cdk.json
@@ -1,3 +1,3 @@
 {
-    "app": "node index"
+  "app": "index.js"
 }
diff --git a/typescript/api-cors-lambda-crud-dynamodb/index.ts b/typescript/api-cors-lambda-crud-dynamodb/index.ts
@@ -1,108 +1,100 @@
-import apigateway = require('@aws-cdk/aws-apigateway'); 
-import dynamodb = require('@aws-cdk/aws-dynamodb');
-import lambda = require('@aws-cdk/aws-lambda');
-import cdk = require('@aws-cdk/core');
-
-export class ApiLambdaCrudDynamoDBStack extends cdk.Stack {
-  constructor(app: cdk.App, id: string) {
+import { IResource, LambdaIntegration, MockIntegration, PassthroughBehavior, RestApi } from '@aws-cdk/aws-apigateway';
+import { AttributeType, Table } from '@aws-cdk/aws-dynamodb';
+import { Runtime } from '@aws-cdk/aws-lambda';
+import { App, Stack, RemovalPolicy } from '@aws-cdk/core';
+import { NodejsFunction, NodejsFunctionProps } from '@aws-cdk/aws-lambda-nodejs';
+import { join } from 'path'
+
+export class ApiLambdaCrudDynamoDBStack extends Stack {
+  constructor(app: App, id: string) {
     super(app, id);
 
-    const dynamoTable = new dynamodb.Table(this, 'items', {
+    const dynamoTable = new Table(this, 'items', {
       partitionKey: {
         name: 'itemId',
-        type: dynamodb.AttributeType.STRING
+        type: AttributeType.STRING
       },
       tableName: 'items',
 
-      // The default removal policy is RETAIN, which means that cdk destroy will not attempt to delete
-      // the new table, and it will remain in your account until manually deleted. By setting the policy to 
-      // DESTROY, cdk destroy will delete the table (even if it has data in it)
-      removalPolicy: cdk.RemovalPolicy.DESTROY, // NOT recommended for production code
+      /**
+       *  The default removal policy is RETAIN, which means that cdk destroy will not attempt to delete
+       * the new table, and it will remain in your account until manually deleted. By setting the policy to
+       * DESTROY, cdk destroy will delete the table (even if it has data in it)
+       */
+      removalPolicy: RemovalPolicy.DESTROY, // NOT recommended for production code
     });
 
-    const getOneLambda = new lambda.Function(this, 'getOneItemFunction', {
-      code: new lambda.AssetCode('src'),
-      handler: 'get-one.handler',
-      runtime: lambda.Runtime.NODEJS_10_X,
+    const nodeJsFunctionProps: NodejsFunctionProps = {
+      bundling: {
+        externalModules: [
+          'aws-sdk', // Use the 'aws-sdk' available in the Lambda runtime
+        ],
+      },
+      depsLockFilePath: join(__dirname, 'lambdas', 'package-lock.json'),
       environment: {
+        PRIMARY_KEY: 'itemId',
         TABLE_NAME: dynamoTable.tableName,
-        PRIMARY_KEY: 'itemId'
-      }
-    });
+      },
+      runtime: Runtime.NODEJS_14_X,
+    }
 
-    const getAllLambda = new lambda.Function(this, 'getAllItemsFunction', {
-      code: new lambda.AssetCode('src'),
-      handler: 'get-all.handler',
-      runtime: lambda.Runtime.NODEJS_10_X,
-      environment: {
-        TABLE_NAME: dynamoTable.tableName,
-        PRIMARY_KEY: 'itemId'
-      }
+    // Create a Lambda function for each of the CRUD operations
+    const getOneLambda = new NodejsFunction(this, 'getOneItemFunction', {
+      entry: join(__dirname, 'lambdas', 'get-one.ts'),
+      ...nodeJsFunctionProps,
     });
-
-    const createOne = new lambda.Function(this, 'createItemFunction', {
-      code: new lambda.AssetCode('src'),
-      handler: 'create.handler',
-      runtime: lambda.Runtime.NODEJS_10_X,
-      environment: {
-        TABLE_NAME: dynamoTable.tableName,
-        PRIMARY_KEY: 'itemId'
-      }
+    const getAllLambda = new NodejsFunction(this, 'getAllItemsFunction', {
+      entry: join(__dirname, 'lambdas', 'get-all.ts'),
+      ...nodeJsFunctionProps,
     });
-
-    const updateOne = new lambda.Function(this, 'updateItemFunction', {
-      code: new lambda.AssetCode('src'),
-      handler: 'update-one.handler',
-      runtime: lambda.Runtime.NODEJS_10_X,
-      environment: {
-        TABLE_NAME: dynamoTable.tableName,
-        PRIMARY_KEY: 'itemId'
-      }
+    const createOneLambda = new NodejsFunction(this, 'createItemFunction', {
+      entry: join(__dirname, 'lambdas', 'create.ts'),
+      ...nodeJsFunctionProps,
     });
-
-    const deleteOne = new lambda.Function(this, 'deleteItemFunction', {
-      code: new lambda.AssetCode('src'),
-      handler: 'delete-one.handler',
-      runtime: lambda.Runtime.NODEJS_10_X,
-      environment: {
-        TABLE_NAME: dynamoTable.tableName,
-        PRIMARY_KEY: 'itemId'
-      }
+    const updateOneLambda = new NodejsFunction(this, 'updateItemFunction', {
+      entry: join(__dirname, 'lambdas', 'update-one.ts'),
+      ...nodeJsFunctionProps,
     });
-
+    const deleteOneLambda = new NodejsFunction(this, 'deleteItemFunction', {
+      entry: join(__dirname, 'lambdas', 'delete-one.ts'),
+      ...nodeJsFunctionProps,
+    });
+
+    // Grant the Lambda function read access to the DynamoDB table
     dynamoTable.grantReadWriteData(getAllLambda);
     dynamoTable.grantReadWriteData(getOneLambda);
-    dynamoTable.grantReadWriteData(createOne);
-    dynamoTable.grantReadWriteData(updateOne);
-    dynamoTable.grantReadWriteData(deleteOne);
+    dynamoTable.grantReadWriteData(createOneLambda);
+    dynamoTable.grantReadWriteData(updateOneLambda);
+    dynamoTable.grantReadWriteData(deleteOneLambda);
+
+    // Integrate the Lambda functions with the API Gateway resource
+    const getAllIntegration = new LambdaIntegration(getAllLambda);
+    const createOneIntegration = new LambdaIntegration(createOneLambda);
+    const getOneIntegration = new LambdaIntegration(getOneLambda);
+    const updateOneIntegration = new LambdaIntegration(updateOneLambda);
+    const deleteOneIntegration = new LambdaIntegration(deleteOneLambda);
 
-    const api = new apigateway.RestApi(this, 'itemsApi', {
+
+    // Create an API Gateway resource for each of the CRUD operations
+    const api = new RestApi(this, 'itemsApi', {
       restApiName: 'Items Service'
     });
 
     const items = api.root.addResource('items');
-    const getAllIntegration = new apigateway.LambdaIntegration(getAllLambda);
     items.addMethod('GET', getAllIntegration);
-
-    const createOneIntegration = new apigateway.LambdaIntegration(createOne);
     items.addMethod('POST', createOneIntegration);
     addCorsOptions(items);
 
     const singleItem = items.addResource('{id}');
-    const getOneIntegration = new apigateway.LambdaIntegration(getOneLambda);
     singleItem.addMethod('GET', getOneIntegration);
-
-    const updateOneIntegration = new apigateway.LambdaIntegration(updateOne);
     singleItem.addMethod('PATCH', updateOneIntegration);
-
-    const deleteOneIntegration = new apigateway.LambdaIntegration(deleteOne);
     singleItem.addMethod('DELETE', deleteOneIntegration);
     addCorsOptions(singleItem);
   }
 }
 
-export function addCorsOptions(apiResource: apigateway.IResource) {
-  apiResource.addMethod('OPTIONS', new apigateway.MockIntegration({
+export function addCorsOptions(apiResource: IResource) {
+  apiResource.addMethod('OPTIONS', new MockIntegration({
     integrationResponses: [{
       statusCode: '200',
       responseParameters: {
@@ -112,7 +104,7 @@ export function addCorsOptions(apiResource: apigateway.IResource) {
         'method.response.header.Access-Control-Allow-Methods': "'OPTIONS,GET,PUT,POST,DELETE'",
       },
     }],
-    passthroughBehavior: apigateway.PassthroughBehavior.NEVER,
+    passthroughBehavior: PassthroughBehavior.NEVER,
     requestTemplates: {
       "application/json": "{\"statusCode\": 200}"
     },
@@ -124,11 +116,11 @@ export function addCorsOptions(apiResource: apigateway.IResource) {
         'method.response.header.Access-Control-Allow-Methods': true,
         'method.response.header.Access-Control-Allow-Credentials': true,
         'method.response.header.Access-Control-Allow-Origin': true,
-      },  
+      },
     }]
   })
 }
 
-const app = new cdk.App();
+const app = new App();
 new ApiLambdaCrudDynamoDBStack(app, 'ApiLambdaCrudDynamoDBExample');
 app.synth();
diff --git a/...i-cors-lambda-crud-dynamodb/src/create.ts → ...rs-lambda-crud-dynamodb/lambdas/create.ts b/...i-cors-lambda-crud-dynamodb/src/create.ts → ...rs-lambda-crud-dynamodb/lambdas/create.ts
@@ -1,13 +1,15 @@
-const AWS = require('aws-sdk');
-const db = new AWS.DynamoDB.DocumentClient();
-const uuidv4 = require('uuid/v4');
+import * as AWS from 'aws-sdk';
+import { v4 as uuidv4 } from 'uuid';
+
 const TABLE_NAME = process.env.TABLE_NAME || '';
 const PRIMARY_KEY = process.env.PRIMARY_KEY || '';
 
+const db = new AWS.DynamoDB.DocumentClient();
+
 const RESERVED_RESPONSE = `Error: You're using AWS reserved keywords as attributes`,
   DYNAMODB_EXECUTION_ERROR = `Error: Execution update, caused a Dynamodb error, please take a look at your CloudWatch Logs.`;
 
-export const handler = async (event: any = {}) : Promise <any> => {
+export const handler = async (event: any = {}): Promise<any> => {
 
   if (!event.body) {
     return { statusCode: 400, body: 'invalid request, you are missing the parameter body' };
@@ -24,7 +26,7 @@ export const handler = async (event: any = {}) : Promise <any> => {
     return { statusCode: 201, body: '' };
   } catch (dbError) {
     const errorResponse = dbError.code === 'ValidationException' && dbError.message.includes('reserved keyword') ?
-    DYNAMODB_EXECUTION_ERROR : RESERVED_RESPONSE;
+      DYNAMODB_EXECUTION_ERROR : RESERVED_RESPONSE;
     return { statusCode: 500, body: errorResponse };
   }
 };
diff --git a/...rs-lambda-crud-dynamodb/src/delete-one.ts → ...ambda-crud-dynamodb/lambdas/delete-one.ts b/...rs-lambda-crud-dynamodb/src/delete-one.ts → ...ambda-crud-dynamodb/lambdas/delete-one.ts
@@ -1,9 +1,11 @@
-const AWS = require('aws-sdk');
-const db = new AWS.DynamoDB.DocumentClient();
+import * as AWS from 'aws-sdk';
+
 const TABLE_NAME = process.env.TABLE_NAME || '';
 const PRIMARY_KEY = process.env.PRIMARY_KEY || '';
 
-export const handler = async (event: any = {}) : Promise <any> => {
+const db = new AWS.DynamoDB.DocumentClient();
+
+export const handler = async (event: any = {}): Promise<any> => {
 
   const requestedItemId = event.pathParameters.id;
   if (!requestedItemId) {

diff --git a/...-cors-lambda-crud-dynamodb/src/get-all.ts → ...s-lambda-crud-dynamodb/lambdas/get-all.ts b/...-cors-lambda-crud-dynamodb/src/get-all.ts → ...s-lambda-crud-dynamodb/lambdas/get-all.ts
@@ -1,8 +1,10 @@
-const AWS = require('aws-sdk');
-const db = new AWS.DynamoDB.DocumentClient();
+import * as AWS from 'aws-sdk';
+
 const TABLE_NAME = process.env.TABLE_NAME || '';
 
-export const handler = async () : Promise <any> => {
+const db = new AWS.DynamoDB.DocumentClient();
+
+export const handler = async (): Promise<any> => {
 
   const params = {
     TableName: TABLE_NAME
@@ -12,6 +14,6 @@ export const handler = async () : Promise <any> => {
     const response = await db.scan(params).promise();
     return { statusCode: 200, body: JSON.stringify(response.Items) };
   } catch (dbError) {
-    return { statusCode: 500, body: JSON.stringify(dbError)};
+    return { statusCode: 500, body: JSON.stringify(dbError) };
   }
 };
diff --git a/...-cors-lambda-crud-dynamodb/src/get-one.ts → ...s-lambda-crud-dynamodb/lambdas/get-one.ts b/...-cors-lambda-crud-dynamodb/src/get-one.ts → ...s-lambda-crud-dynamodb/lambdas/get-one.ts
@@ -1,9 +1,11 @@
-const AWS = require('aws-sdk');
-const db = new AWS.DynamoDB.DocumentClient();
+import * as AWS from 'aws-sdk';
+
 const TABLE_NAME = process.env.TABLE_NAME || '';
 const PRIMARY_KEY = process.env.PRIMARY_KEY || '';
 
-export const handler = async (event: any = {}) : Promise <any> => {
+const db = new AWS.DynamoDB.DocumentClient();
+
+export const handler = async (event: any = {}): Promise<any> => {
 
   const requestedItemId = event.pathParameters.id;
   if (!requestedItemId) {

diff --git a/typescript/api-cors-lambda-crud-dynamodb/lambdas/package.json b/typescript/api-cors-lambda-crud-dynamodb/lambdas/package.json
@@ -0,0 +1,15 @@
+{
+  "name": "lambda-crud-dynamodb",
+  "version": "1.0.0",
+  "description": "Lambdas to do CRUD operations on DynamoDB",
+  "private": true,
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "*",
+    "@types/uuid": "*"
+  },
+  "dependencies": {
+    "aws-sdk": "*",
+    "uuid": "*"
+  }
+}
diff --git a/typescript/api-cors-lambda-crud-dynamodb/lambdas/tsconfig.json b/typescript/api-cors-lambda-crud-dynamodb/lambdas/tsconfig.json
@@ -0,0 +1,6 @@
+{
+  "extends": "../tsconfig.json",
+  "include": [
+    "*.ts"
+  ]
+}