Fork off from shallot

baileytincher · baileytincher · commit d69b81755b7c · 2021-04-29T17:15:49.000-05: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,65 @@
+name: Shallot Package Release
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  test:
+    name: Run unit tests
+    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 --frozen-lockfile
+
+      - name: Run unit tests
+        run: yarn test
+
+  publish:
+    name: Publish to NPM
+    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 --frozen-lockfile
+
+      - 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,51 @@
+name: Shallot PR Validation
+
+on:
+  pull_request:
+    types: [opened, reopened, edited, synchronize]
+
+jobs:
+  lint:
+    name: Run linting
+    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 --frozen-lockfile
+
+      - name: Run eslint
+        run: yarn eslint
+
+      - name: Run prettier
+        run: yarn prettier -c .
+
+  test:
+    name: Run tests
+    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 --frozen-lockfile
+
+      - 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,21 @@
+tests
+coverage
+jest.config.ts
+
+.github
+
+*.md
+
+.huskyrc.json
+.lintstagedrc.json
+.eslintignore
+.eslintrc.json
+.prettierignore
+.prettierrc.json
+
+yarn-error.log
+
+src
+
+webpack.config.ts
+tsconfig.json
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 Bailey Tincher
+
+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,169 @@
+# Shallot
+
+[![npm version](https://badge.fury.io/js/shallot.svg)](https://badge.fury.io/js/shallot)
+![Shallot Package Release](https://github.com/ShallotJS/shallot/workflows/Shallot%20Package%20Release/badge.svg)
+[![Known Vulnerabilities](https://snyk.io/test/github/ShallotJS/shallot/badge.svg?targetFile=package.json)](https://snyk.io/test/github/ShallotJS/shallot?targetFile=package.json)
+[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/ShallotJS/shallot.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/ShallotJS/shallot/context:javascript)
+[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
+
+A middleware framework for serverless functions written in TypeScript or JavaScript.
+
+Inspired by [Express.js](http://expressjs.com/) and [Middy.js](https://middy.js.org/)
+
+### Benefits over middy
+
+- First class support for TypeScript
+- Simpler codebase
+- Mildly faster execution
+
+### Drawbacks from middy
+
+- Only supports promise based handlers/middleware with async/await
+
+  \*\*This is an intentional decision to allow for the simplified codebase and faster execution
+
+- Less robust third party middleware options
+
+## Installation
+
+Add shallot to your project
+
+```
+npm install --save shallot
+```
+
+TypeScript support is out of the box so you do not need an additional types module.
+
+## Usage
+
+REST API Wrapper Example:
+
+```javascript
+import { ShallotAWS } from 'shallot';
+
+import { HTTPJSONBodyParser } from '@shallot/http-json-body-parser';
+import { HTTPCors } from '@shallot/http-cors';
+import { HTTPErrorHandler } from '@shallot/http-error-handler';
+
+const _handler = async (event, context) => {
+  // Your handler code here
+};
+
+export const handler = ShallotAWS.ShallotAWS(handler)
+  .use(HTTPJSONBodyParser())
+  .use(HTTPCors())
+  .use(HTTPErrorHandler());
+```
+
+## How it Works
+
+![Middleware onion](https://middy.js.org/img/middy-middleware-engine.png)
+
+\*\*Artwork credit: [Middy.js](https://middy.js.org/)
+
+Middlewares are applied as layers that can execute before and after. This loosely
+can be analogized to an onion (and Serverless starts with an S) hence the name Shallot.
+
+The middlewares can modify the request context, response, or handle exceptions thrown during runtime
+to take care of common tasks. Canonical use cases include establishing database connections, parsing
+request bodies from json, and authenticating users.
+
+## Official Middlewares
+
+### http-json-body-parser
+
+Shallot middleware that parses and replaces the JSON body of HTTP request bodies.
+Requires the Content-Type header to be properly set.
+
+```javascript
+import { HTTPJSONBodyParser } from '@shallot/http-json-body-parser';
+```
+
+### http-cors
+
+Shallot middleware that handles the setting of response CORS headers according
+to the MSDN spec. https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS
+
+```javascript
+import { HTTPCors } from '@shallot/http-cors';
+```
+
+### http-error-handler
+
+Shallot middleware that catches "HTTP Errors" thrown by the
+http-errors npm module and returns the corresponding status
+code in the response.
+
+```javascript
+import { HTTPErrorHandler } from '@shallot/http-error-handler';
+```
+
+## Creating a Custom Middleware
+
+A middleware is an object that defines any of a `before`, `after`, `onError`, or `finally` block.
+
+- before: executes before the handler
+- after: executes after the handler
+- onError: executes in case of exception
+- finally: executes after either the `after` or `onError` stage
+
+\*\*If an error is thrown at any point, execution of all other middlewares/the handler is terminated
+and the onError middlewares + finally middlewares execute instead.
+
+```javascript
+const middleware = {
+  before: async (request) => {
+    console.log(request);
+  },
+};
+
+ShallotAWS(handler).use(middleware);
+```
+
+You may also want to pass config options to the middleware which you can do by exporting your
+middleware as a function instead of an object.
+
+```javascript
+const middlewareWithOptions = (config) => ({
+  before: async (request) => {
+    if (config.shouldLog) {
+      console.log(request);
+    }
+  },
+});
+
+const config = {
+  shouldLog: true,
+};
+
+ShallotAWS(handler).use(middlewareWithOptions(config));
+```
+
+### The request object
+
+The request object passed to each middleware at runtime has the following properties.
+
+```javascript
+{
+  event, // The lambda event object
+  context, // The lambda runtime context object
+  response, // The user-defined response
+  error, // Error object set before calling onError middlewares
+  __handledError, // If true, allows skipping of remaining onError middlewares
+}
+```
+
+## Experimental Azure Functions Support
+
+Accepting PR's from people more experienced with Azure if the current implementation
+does not cover all Azure Functions use cases.
+
+```javascript
+import { ShallotAzure } from 'shallot';
+
+const _handler = async (context, ...args) => {
+  // Your handler code here
+};
+
+export const handler = ShallotAzure(handler).use(MyAzureFunctionMiddleware());
+```
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
diff --git a/src/index.ts b/src/index.ts
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"
 +  }
 +}