Add ability to run locally with Docker. Update packages. Add ping endpoint.

Author: jch254

.dockerignore

@@ -0,0 +1,4 @@
+node_modules/
+.dynamodb/
+.history/
+.webpack/

.gitignore

@@ -6,4 +6,5 @@ yarn-error.log
 .history/
 .terraform/
 *.tfplan*
-*.tfstate*
+*.tfstate*
+.dynamodb/

Dockerfile

@@ -0,0 +1,12 @@
+FROM node:10-alpine
+WORKDIR /app
+
+COPY package.json yarn.lock serverless.yml ./
+RUN yarn install --ignore-scripts
+
+COPY tsconfig.json tsconfig.json tslint.json webpack.config.ts  ./
+COPY src src
+
+EXPOSE 3000/tcp
+
+ENTRYPOINT ["yarn", "run", "docker-dev"]

README.md

@@ -22,19 +22,37 @@ See [Apiary](http://docs.serverlessapi.apiary.io) for API structure - defined in
 
 To run locally you must run two servers - DB and API.
 
-Serverless-webpack, serverless-dynamodb-local and serverless-offline offer great tooling for local Serverless development. To start a local server that will mimic AWS API Gateway, run the commands below. Both servers will fire up and code will be reloaded upon change so that every request to your local server will serve the latest code.
+Serverless-webpack, serverless-dynamodb-local and serverless-offline offer great tooling for local Serverless development. To start local servers that mimic AWS API Gateway and DyanamoDB, run the commands below. Both servers will fire up and code will be reloaded upon change so that every request to your API will serve the latest code.
 
 Serverless-dynamodb-local requires Java Runtime Engine (JRE) version 6.x or newer.
 
-**DYNAMODB_PORT and AUTH0_CLIENT_SECRET environment variables must be set before `yarn run dev` command below.**
+**AUTH0_CLIENT_SECRET environment variable must be set before `yarn run dev` command below. Optional DYNAMODB_PORT and DYNAMODB_HOST environment variables may be set to override the defaults (localhost:8000).**
 
-E.g. `DYNAMODB_PORT=8001 AUTH0_CLIENT_SECRET=YOUR_SECRET yarn run dev`
+E.g. `AUTH0_CLIENT_SECRET=YOUR_SECRET yarn run dev`
 
 ```
 yarn install (serverless dynamodb install included as postinstall script)
 yarn run dev
 ```
 
+Submit requests to http://localhost:3000. The DynamoDB shell console is available at http://localhost:8000/shell.
+
+## Running locally with Docker
+
+Maintaining a Java installation for the sake of running DynamoDB locally is a pain, running in a Docker container is far easier. As above, to run locally you must run two servers - DB and API.
+
+To start the local servers that mimic AWS API Gateway and DyanamoDB using docker, run the commands below.
+
+**AUTH0_CLIENT_SECRET environment variable must be set before `docker-compose up --build` command below.**
+
+E.g. `AUTH0_CLIENT_SECRET=YOUR_SECRET docker-compose up --build`
+
+```
+docker-compose up --build
+```
+
+Submit requests to http://localhost:3000. The DynamoDB shell console is available at http://localhost:8000/shell.
+
 ## Testing
 
 TBC

docker-compose.yml

@@ -0,0 +1,35 @@
+version: '3.7'
+services:
+  dynamodb:
+    image: amazon/dynamodb-local
+    restart: always
+    healthcheck:
+      test: ["CMD-SHELL", "curl -f http://localhost:8000/shell/ || exit 1"]
+      interval: 1s
+      timeout: 10s
+      retries: 3
+    ports:
+      - "8000:8000"
+    expose:
+      - "8000"
+
+  api:
+    build:
+      context: .
+    depends_on:
+      - dynamodb
+    links:
+      - dynamodb
+    ports:
+      - "3000:3000"
+    restart: always
+    healthcheck:
+      test: "curl -f http://api/ping"
+      interval: 5s
+      timeout: 3s
+      retries: 5
+    environment:
+      AUTH0_CLIENT_SECRET: ${AUTH0_CLIENT_SECRET}
+      DYNAMODB_HOST: dynamodb
+      DYNAMODB_PORT: 8000
+      DYNAMODB_NO_START: 'true'

package.json

@@ -5,39 +5,41 @@
   "main": "src/index.ts",
   "scripts": {
     "postinstall": "serverless dynamodb install",
-    "dev": "serverless offline start",
+    "dev": "cross-env NODE_ENV=development serverless offline start",
+    "docker-dev": "cross-env NODE_ENV=development serverless offline start --host 0.0.0.0",
     "lint": "tslint --type-check --project tsconfig.json || exit 0",
     "deploy": "cross-env NODE_ENV=production serverless deploy"
   },
   "author": "Jordan Hornblow <[email protected]>",
   "license": "MIT",
   "dependencies": {
-    "aws-sdk": "^2.117.0",
-    "jsonwebtoken": "^8.0.1",
-    "moment": "^2.18.1",
-    "uuid": "^3.1.0"
+    "aws-sdk": "^2.531.0",
+    "jsonwebtoken": "^8.5.1",
+    "moment": "^2.24.0",
+    "uuid": "^3.3.3"
   },
   "devDependencies": {
-    "@types/aws-lambda": "^0.0.16",
-    "@types/jsonwebtoken": "^7.2.3",
-    "@types/node": "^8.0.28",
-    "@types/uuid": "^3.4.2",
-    "@types/webpack": "^3.0.10",
-    "awesome-typescript-loader": "^3.2.3",
-    "cross-env": "^5.0.5",
-    "serverless": "^1.22.0",
-    "serverless-dynamodb-autoscaling": "^0.6.1",
-    "serverless-dynamodb-local": "^0.2.25",
-    "serverless-offline": "^3.16.0",
-    "serverless-plugin-custom-domain": "^2.0.0",
-    "serverless-webpack": "^3.0.0",
-    "source-map-loader": "^0.2.1",
-    "tslint": "^5.7.0",
-    "tslint-config-airbnb": "^5.3.0",
-    "tslint-loader": "^3.5.3",
-    "tsutils": "^2.8.2",
-    "typescript": "^2.5.2",
-    "webpack": "^3.6.0",
-    "webpack-node-externals": "^1.6.0"
+    "@types/aws-lambda": "^8.10.31",
+    "@types/jsonwebtoken": "^8.3.4",
+    "@types/node": "^12.7.5",
+    "@types/uuid": "^3.4.5",
+    "@types/webpack": "^4.39.1",
+    "cross-env": "^6.0.0",
+    "fork-ts-checker-webpack-plugin": "^1.5.0",
+    "serverless": "^1.52.0",
+    "serverless-dynamodb-autoscaling": "^0.6.2",
+    "serverless-dynamodb-local": "^0.2.38",
+    "serverless-offline": "^5.11.0",
+    "serverless-plugin-custom-domain": "^2.0.2",
+    "serverless-webpack": "^5.3.1",
+    "source-map-loader": "^0.2.4",
+    "ts-loader": "^6.1.0",
+    "tslint": "^5.20.0",
+    "tslint-config-airbnb": "^5.11.1",
+    "tslint-loader": "^3.5.4",
+    "tsutils": "^3.17.1",
+    "typescript": "^3.6.3",
+    "webpack": "^4.40.2",
+    "webpack-node-externals": "^1.7.2"
   }
-}
+}

serverless.yml

@@ -30,13 +30,17 @@ package:
 
 custom:
   domain: sls-api.603.nz
-  webpack: ./webpack.config.ts
-  webpackIncludeModules: true
+  webpack:
+    webpackConfig: ./webpack.config.ts
+    includeModules: true
   dynamodb:
     start:
-      port: ${env:DYNAMODB_PORT}
-      inMemory: true
+      port: ${env:DYNAMODB_PORT, 8000}
+      host: ${env:DYNAMODB_HOST, localhost}
       migrate: true
+      noStart: ${env:DYNAMODB_NO_START, false}
+    stages:
+      - ${self:provider.stage}
   capacities:
     - table: ItemsTable
       index:
@@ -51,6 +55,17 @@ custom:
         usage: 0.1
 
 functions:
+  ping:
+    handler: src/index.pingHandler
+    memory: 512
+    timeout: 60
+    events:
+      - http:
+          method: get
+          path: ping
+          cors: true
+          integration: lambda-proxy
+
   authorizer:
     handler: src/index.authorizer
     environment:

src/Event.ts

@@ -11,7 +11,7 @@ export default class Response {
   statusCode: number;
   body?: string;
   headers: {
-    [name: string] : string,
+    [name: string]: string,
   };
 
   constructor(args: ResponseArgs = defaultResponseArgs) {
@@ -25,4 +25,3 @@ export default class Response {
     }
   }
 }
-

src/Response.ts

@@ -8,7 +8,9 @@ import ResponseError from './ResponseError';
 const db = process.env.IS_OFFLINE ?
   new DynamoDB.DocumentClient({
     region: 'localhost',
-    endpoint: `http://localhost:${process.env.DYNAMODB_PORT}`,
+    accessKeyId: 'MOCK_ACCESS_KEY_ID',
+    secretAccessKey: 'MOCK_SECRET_ACCESS_KEY',
+    endpoint: `http://${process.env.DYNAMODB_HOST || 'localhost'}:${process.env.DYNAMODB_PORT || 8000}`,
   }) :
   new DynamoDB.DocumentClient();
 
@@ -40,7 +42,7 @@ export async function getItemById(userId: string, itemId: string): Promise<Item>
 
   if (data.Item === undefined) {
     const notFoundError = new Error(`An item could not be found with id: ${itemId}`) as ResponseError;
-    
+
     notFoundError.responseStatusCode = 404;
 
     throw notFoundError;