refactor: codebase cleanup (#90)

* chore: update node runtime version

* refactor: leave typescript function only

* chore: update circleci node version

* refactor: remove unnecessary packages

* docs: update readme

* fix: change function type and return type under run-warm

* fix: add context and event under test

* fix: add line at hello handler

Co-authored-by: peter bardawil <[email protected]>

Author: WajeehZantout

.babelrc

@@ -2,14 +2,14 @@ version: 2
 jobs:
   build:
     docker:
-      - image: circleci/node:10.16
+      - image: circleci/node:12.13.1
     steps:
       - checkout
       - run: yarn install
       - run: yarn build
   test:
     docker:
-      - image: circleci/node:10.16
+      - image: circleci/node:12.13.1
     steps:
       - checkout
       - run: yarn install

.circleci/config.yml

@@ -1,29 +1,10 @@
 module.exports = {
   parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint'],
-  extends: ['prettier', 'airbnb'],
+  extends: ['prettier', 'plugin:@typescript-eslint/recommended'],
   parserOptions: {
     ecmaVersion: 6,
     sourceType: 'module',
   },
   env: { jest: true, browser: true, node: true },
-  rules: { 
-    'no-console': 'warn',
-    "import/extensions": [
-      "error",
-      "ignorePackages",
-      {
-        "js": "never",
-        "ts": "never",
-      }
-   ]
-  },
-  settings: {
-    'import/resolver': {
-      node: {
-        paths: ['src'],
-        extensions: ['.js', '.ts'],
-      },
-    },
-  },
+  rules: { 'no-console': 'warn' },
 };

.eslintrc.js

@@ -1 +1 @@
-v10.16.3
+v12.13.1

.nvmrc

@@ -44,11 +44,11 @@ functions:
           method: get
 ```
 
-Ignoring the scheduling event, you can see here that we're setting up a function named `hello` with a handler at `src/hello.js` (the `.default` piece is just indicating that the function to run will be the default export from that file). The `http` event says that this function will run when an http event is triggered (on AWS, this happens via API Gateway).
+Ignoring the scheduling event, you can see here that we're setting up a function named `hello` with a handler at `src/hello.ts` (the `.default` piece is just indicating that the function to run will be the default export from that file). The `http` event says that this function will run when an http event is triggered (on AWS, this happens via API Gateway).
 
 #### 2. Create your function
 
-This starter kit's Hello World function (which you will of course get rid of) can be found at [`./src/hello.js`](./src/hello.js). There you can see a basic function that's intended to work in conjunction with API Gateway (i.e., it is web-accessible). Like most Serverless functions, the `hello` function is asynchronous and accepts an event & context. (This is all basic Serverless; if you've never used it, be sure to read through [their docs](https://serverless.com/framework/docs/).
+This starter kit's Hello World function (which you will of course get rid of) can be found at [`./src/hello.ts`](./src/hello.ts). There you can see a basic function that's intended to work in conjunction with API Gateway (i.e., it is web-accessible). Like most Serverless functions, the `hello` function is asynchronous and accepts an event & context. (This is all basic Serverless; if you've never used it, be sure to read through [their docs](https://serverless.com/framework/docs/).
 
 ---
 
@@ -73,7 +73,7 @@ yarn serve
 ### Test your functions with Jest
 
 Jest is installed as the testrunner. To create a test, co-locate your test with the file it's testing
-as `<filename>.test.js` and then run/watch tests with:
+as `<filename>.test.ts` and then run/watch tests with:
 
 ```bash
 yarn test

README.md

@@ -1,9 +1,10 @@
 module.exports = {
   roots: ['<rootDir>/src'],
-  testRegex: '(.*\\.test\\.(tsx?|jsx?))$',
+  testMatch: [
+    '**/__tests__/**/*.+(ts|tsx|js)',
+    '**/?(*.)+(spec|test).+(ts|tsx|js)',
+  ],
   transform: {
-    '^.+\\.tsx?$': 'ts-jest',
-    '^.+\\.jsx?$': 'babel-jest',
+    '^.+\\.(ts|tsx)$': 'ts-jest',
   },
-  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
 };

fixtures/scheduled.json

@@ -18,24 +18,12 @@
     "watch:hello": "sls invoke local --watch --function hello --path fixtures/event.json"
   },
   "devDependencies": {
-    "@babel/core": "7.6.2",
-    "@babel/preset-env": "7.6.2",
-    "@babel/preset-typescript": "^7.6.0",
+    "@types/aws-lambda": "^8.10.39",
     "@types/jest": "^25.1.0",
     "@typescript-eslint/eslint-plugin": "^3.0.0",
     "@typescript-eslint/parser": "^3.0.0",
-    "aws-sdk": "^2.529.0",
-    "babel-core": "^7.0.0-bridge.0",
-    "babel-jest": "^24.9.0",
-    "babel-loader": "^8.0.6",
     "eslint": "^6.3.0",
-    "eslint-config-airbnb": "^18.0.1",
     "eslint-config-prettier": "^6.3.0",
-    "eslint-import-resolver-typescript": "^2.0.0",
-    "eslint-plugin-import": "^2.18.2",
-    "eslint-plugin-jsx-a11y": "^6.2.3",
-    "eslint-plugin-react": "^7.14.3",
-    "eslint-plugin-react-hooks": "2.1.0",
     "husky": "^4.0.2",
     "jest": "^24.9.0",
     "lint-staged": "^10.0.3",
@@ -53,11 +41,6 @@
     "webpack": "^4.39.3",
     "webpack-node-externals": "^1.7.2"
   },
-  "dependencies": {
-    "@types/aws-lambda": "^8.10.31",
-    "@types/node": "^13.1.0",
-    "debug": "^4.1.1"
-  },
   "husky": {
     "hooks": {
       "pre-commit": "lint-staged && yarn test"

jest.config.js

@@ -24,7 +24,7 @@ package:
 
 provider:
   name: aws
-  runtime: nodejs10.x
+  runtime: nodejs12.x
   # you can overwrite defaults here
   #  stage: dev
   #  region: us-east-1
@@ -39,6 +39,7 @@ custom:
     webpackConfig: ./webpack.config.js
     includeModules: true
     packager: 'yarn' # Packager that will be used to package your external modules
+    excludeFiles: src/**/*.test.[t|j]s # Exclude test files
   warmup:
     enabled: true
     events:
@@ -78,12 +79,6 @@ custom:
 #    - exclude-me-dir/**
 
 functions:
-  hello-typescript:
-    handler: src/hello-ts.default
-    events:
-      - http:
-          path: hello-typescript
-          method: get
   hello:
     handler: src/hello.default
     events:

package.json

@@ -2,7 +2,7 @@
 
 exports[`hello executes as expected 1`] = `
 Object {
-  "body": "{\\"message\\":\\"Go Serverless! Your function executed successfully!\\",\\"input\\":{}}",
+  "body": "{\\"message\\":\\"Go Serverless! Your function executed successfully!\\",\\"input\\":{\\"key3\\":\\"value3\\",\\"key2\\":\\"value2\\",\\"key1\\":\\"value1\\"}}",
   "statusCode": 200,
 }
 `;

serverless.yml

@@ -0,0 +1,12 @@
+import hello from './hello';
+import context from './test/utils/handler-helper';
+import event from './test/fixtures/event.json';
+
+const callback = jest.fn();
+
+describe('hello', () => {
+  it('executes as expected', async () => {
+    const response = await hello(event, context, callback);
+    expect(response).toMatchSnapshot();
+  });
+});

src/__snapshots__/hello.test.js.snap renamed to src/__snapshots__/hello.test.ts.snap

@@ -1,8 +1,9 @@
 import { successResponse, runWarm } from './utils';
+import { Response } from './utils/lambda-response';
 
-const hello = async (event) => {
+const hello = async (event: AWSLambda.APIGatewayEvent): Promise<Response> => {
   // successResponse handles wrapping the response in an API Gateway friendly
-  // format (see other responses, including CORS, in `./utils/lambda-response.js)
+  // format (see other responses, including CORS, in `./utils/lambda-response.ts)
   const response = successResponse({
     message: 'Go Serverless! Your function executed successfully!',
     input: event,

src/hello-ts.ts

@@ -0,0 +1,18 @@
+const context = {
+  awsRequestId: '',
+  invokeid: '',
+  logGroupName: '',
+  logStreamName: '',
+  functionVersion: '',
+  isDefaultFunctionVersion: true,
+  functionName: '',
+  memoryLimitInMB: '0',
+  succeed: jest.fn(),
+  fail: jest.fn(),
+  done: jest.fn(),
+  getRemainingTimeInMillis: jest.fn(),
+  callbackWaitsForEmptyEventLoop: true,
+  invokedFunctionArn: '',
+};
+
+export default context;

src/hello.test.js

@@ -1,27 +1,28 @@
-interface IJSON {
+interface JSON {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   [key: string]: any;
 }
 
-interface IResponseOptions {
-  json: IJSON;
+interface ResponseOptions {
+  json: JSON;
   statusCode: number;
   allowCORS?: boolean;
 }
 
-interface IResponse {
+export interface Response {
   statusCode: number;
   body: string;
   headers?: {
-    [key: string]: any;
+    [key: string]: string;
   };
 }
 
 function lambdaResponse({
   json,
   statusCode,
   allowCORS = false,
-}: IResponseOptions) {
-  const response: IResponse = {
+}: ResponseOptions): Response {
+  const response: Response = {
     statusCode,
     body: JSON.stringify(json),
   };
@@ -35,29 +36,29 @@ function lambdaResponse({
   return response;
 }
 
-export function errorResponse(json: IJSON) {
+export function errorResponse(json: JSON): Response {
   return lambdaResponse({
     json,
     statusCode: 500,
   });
 }
 
-export function corsErrorResponse(json: IJSON) {
+export function corsErrorResponse(json: JSON): Response {
   return lambdaResponse({
     json,
     statusCode: 500,
     allowCORS: true,
   });
 }
 
-export function successResponse(json: IJSON) {
+export function successResponse(json: JSON): Response {
   return lambdaResponse({
     json,
     statusCode: 200,
   });
 }
 
-export function corsSuccessResponse(json: IJSON) {
+export function corsSuccessResponse(json: JSON): Response {
   return lambdaResponse({
     json,
     statusCode: 200,

src/hello.test.ts

@@ -1,14 +1,15 @@
-const runWarm = (lambdaFunc: Function): AWSLambda.Handler => async (
+const runWarm = (lambdaFunc: AWSLambda.Handler): AWSLambda.Handler => (
   event,
   context,
+  callback
 ) => {
   // Detect the keep-alive ping from CloudWatch and exit early. This keeps our
   // lambda function running hot.
   if (event.source === 'serverless-plugin-warmup') {
-    return 'pinged';
+    return callback(null, 'pinged');
   }
 
-  return lambdaFunc(event, context);
+  return lambdaFunc(event, context, callback);
 };
 
 export default runWarm;

src/hello.js renamed to src/hello.ts

@@ -13,14 +13,6 @@ module.exports = {
         use: 'ts-loader',
         exclude: /node_modules/,
       },
-      {
-        test: /\.jsx?$/,
-        include: __dirname,
-        exclude: /node_modules/,
-        use: {
-          loader: 'babel-loader',
-        },
-      },
     ],
   },
   resolve: {