Port over original version

baileytincher · baileytincher · commit b83aa97fa009 · 2020-12-18T17:11:50.000-06:00
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,4 @@
+node_modules/**/*
+coverage/**/*
+dist/**/*
+.github/**/*
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,15 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module"
+  },
+  "extends": [
+    "plugin:@typescript-eslint/recommended",
+    "prettier/@typescript-eslint",
+    "plugin:prettier/recommended"
+  ],
+  "rules": {
+    "strict": 2
+  }
+}
diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml
@@ -0,0 +1,63 @@
+name: Package Release
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.release.target_commitish }}
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Run unit tests
+        run: yarn test
+
+  publish:
+    needs: [test]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.release.target_commitish }}
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12
+          always-auth: true
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Set bot git config name
+        run: git config --global user.name "GitHub CD bot"
+
+      - name: Set bot git config email
+        run: git config --global user.email "github-cd-bot@example.com"
+
+      - name: Create a new release version
+        run: yarn version --new-version ${{ github.event.release.tag_name }}
+        env:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build a prod version
+        run: yarn build
+
+      - name: Publish to NPM
+        run: yarn publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/.github/workflows/open-pr.yml b/.github/workflows/open-pr.yml
@@ -0,0 +1,49 @@
+name: PR Validation
+
+on:
+  pull_request:
+    types: [opened, reopened, edited, synchronize]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.release.target_commitish }}
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Run eslint
+        run: yarn eslint
+
+      - name: Run prettier
+        run: yarn prettier -c .
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.release.target_commitish }}
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Run unit tests
+        uses: mattallty/jest-github-action@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,10 @@
+node_modules
+yarn-error.log
+npm-debug.*
+
+dist
+
+coverage
+
+.vscode
+.DS_Store
diff --git a/.huskyrc.json b/.huskyrc.json
@@ -0,0 +1,5 @@
+{
+  "hooks": {
+    "pre-commit": "lint-staged"
+  }
+}
diff --git a/.lintstagedrc.json b/.lintstagedrc.json
@@ -0,0 +1,4 @@
+{
+  "**/*.ts": ["eslint --fix"],
+  "*": ["prettier --write"]
+}
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,18 @@
+tests
+coverage
+jest.config.ts
+
+.github
+
+*.md
+
+.huskyrc.json
+.lintstagedrc.json
+.eslintignore
+.eslintrc.json
+.prettierignore
+.prettierrc.json
+
+yarn-error.log
+
+src
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,6 @@
+node_modules
+coverage
+.*ignore
+yarn*
+dist
+.github
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "printWidth": 90
+}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,9 @@
+This library isn't ready for contributions yet.
+
+## Environment setup
+
+1.) clone this repo
+2.) run `yarn install`
+
+Jest Testing: `yarn test`
+Build+Publish new version: `yarn deploy`
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,7 @@
+Copyright 2020
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1 @@
+# Shallot HTTP Error Handling Middleware
diff --git a/jest.config.ts b/jest.config.ts
@@ -0,0 +1,10 @@
+import type { Config } from '@jest/types';
+
+const config: Config.InitialOptions = {
+  preset: 'ts-jest',
+  verbose: true,
+  collectCoverage: true,
+  collectCoverageFrom: ['src/**/*.{js,ts}'],
+};
+
+export default config;
diff --git a/package.json b/package.json
@@ -0,0 +1,52 @@
+{
+  "name": "@shallot/http-error-handler",
+  "version": "1.0.0",
+  "description": "Error handling middleware for REST APIs",
+  "keywords": [
+    "typescript",
+    "errors",
+    "REST",
+    "shallot",
+    "middleware"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "repository": "https://github.com/ShallotJS/shallot-http-error-handler.git",
+  "author": "Bailey Tincher <bailey.tincher@btin.io>",
+  "license": "MIT",
+  "private": false,
+  "scripts": {
+    "build": "rm -rf dist && webpack",
+    "test": "jest",
+    "postversion": "git push && git push --tags"
+  },
+  "devDependencies": {
+    "@types/aws-lambda": "^8.10.66",
+    "@types/http-errors": "^1.8.0",
+    "@types/jest": "^26.0.15",
+    "@types/node": "^14.14.2",
+    "@types/webpack": "^4.41.25",
+    "@types/webpack-node-externals": "^2.5.0",
+    "@typescript-eslint/eslint-plugin": "^4.5.0",
+    "@typescript-eslint/parser": "^4.5.0",
+    "eslint": "^7.12.0",
+    "eslint-config-prettier": "^6.14.0",
+    "eslint-plugin-prettier": "^3.1.4",
+    "husky": "^4.3.0",
+    "jest": "^26.6.1",
+    "lint-staged": "^10.4.2",
+    "prettier": "^2.1.2",
+    "shallot": "^1.2.1",
+    "ts-jest": "^26.4.3",
+    "ts-loader": "^8.0.11",
+    "ts-node": "^9.0.0",
+    "typescript": "^4.0.3",
+    "webpack": "^5.9.0",
+    "webpack-cli": "^4.2.0",
+    "webpack-node-externals": "^2.5.2",
+    "yarn": "^1.22.10"
+  },
+  "dependencies": {
+    "http-errors": "^1.8.0"
+  }
+}
diff --git a/src/aws/index.ts b/src/aws/index.ts
@@ -0,0 +1,43 @@
+/**
+ * TypeScript + promises port of middy http-error-handler
+ * https://github.com/middyjs/middy/tree/master/packages/http-error-handler
+ */
+
+import type { ShallotMiddlewareWithOptions } from 'shallot/dist/aws/core';
+import type { APIGatewayEvent, APIGatewayProxyResult } from 'aws-lambda';
+
+import HttpError from 'http-errors';
+
+interface TShallotErrorHandlerOptions extends Record<string, unknown> {
+  logger?: (...args: string[]) => void;
+}
+
+/**
+ * Shallot middleware that catches "HTTP Errors" thrown by the
+ * http-errors npm module and returns the corresponding status
+ * code in the response.
+ *
+ * @param config optional object to pass config options
+ */
+const ShallotAWSHttpErrorHandler: ShallotMiddlewareWithOptions<
+  APIGatewayEvent,
+  APIGatewayProxyResult,
+  TShallotErrorHandlerOptions
+> = (config) => ({
+  onError: async (request) => {
+    config = { logger: console.error, ...config };
+
+    if (HttpError.isHttpError(request.error)) {
+      if (config.logger != null) {
+        config.logger(request.error.message);
+      }
+
+      request.response = {
+        statusCode: request.error.statusCode,
+        body: request.error.message,
+      };
+    }
+  },
+});
+
+export default ShallotAWSHttpErrorHandler;
diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1,3 @@
+import ShallotAWSHttpErrorHandler from './aws';
+
+export { ShallotAWSHttpErrorHandler };
diff --git a/tests/aws.test.ts b/tests/aws.test.ts
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/webpack.config.ts b/webpack.config.ts
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +  "hooks": {
 +    "pre-commit": "lint-staged"
 +  }
 +}