├── .circleci
    └── config.yml
├── .eslintrc.js
├── .gitignore
├── .npmrc
├── .nvmrc
├── .prettierrc
├── CHANGELOG.md
├── LICENSE
├── README.md
├── artillery-test.yml
├── docs
    └── performance
    │   ├── aws-serverless-express-results.html
    │   └── aws-serverless-fastify-results.html
├── package-lock.json
├── package.json
├── src
    ├── index.spec.ts
    ├── index.ts
    ├── request-forwarder.ts
    ├── request-mapper.ts
    ├── response-builder.spec.ts
    ├── response-builder.ts
    └── socket-manager.ts
├── tsconfig.build.json
├── tsconfig.json
└── tslint.json


/.circleci/config.yml:
--------------------------------------------------------------------------------
 1 | version: 2
 2 | jobs:
 3 |   build:
 4 |     docker:
 5 |       - image: cimg/node:20.11.0
 6 |     working_directory: ~/repo
 7 |     steps:
 8 |       - checkout
 9 |       - restore_cache:
10 |           keys:
11 |           - v1-dependencies-{{ checksum "package.json" }}
12 |           # fallback to using the latest cache if no exact match is found
13 |           - v1-dependencies-
14 |       - run:
15 |           name: Install Dependencies
16 |           command: |
17 |             npm install
18 |       - save_cache:
19 |           paths:
20 |             - ./node_modules
21 |           key: v1-dependencies-{{ checksum "package.json" }}
22 |       - run:
23 |           name: Build
24 |           command: |
25 |             npm run build
26 |       - run:
27 |           name: Test
28 |           command: |
29 |             npm run test:cov
30 |       - run:
31 |           name: Lint
32 |           command: |
33 |             npm run lint
34 | 
35 |   release:
36 |     docker:
37 |       - image: cimg/node:20.11.0
38 |     working_directory: ~/repo
39 |     steps:
40 |       - checkout
41 |       - restore_cache:
42 |           keys:
43 |           - v1-dependencies-{{ checksum "package.json" }}
44 |           # fallback to using the latest cache if no exact match is found
45 |           - v1-dependencies-
46 |       - run:
47 |           name: Install Dependencies
48 |           command: |
49 |             npm install
50 |       - run:
51 |           name: Build
52 |           command: |
53 |             npm run build
54 |       - run:
55 |           name: Release
56 |           command: |
57 |             npx semantic-release
58 | 
59 | workflows:
60 |   version: 2
61 |   test_and_release:
62 |     jobs:
63 |       - build
64 |       - release:
65 |           requires:
66 |             - build
67 |           filters:
68 |             branches:
69 |               only: master


--------------------------------------------------------------------------------
/.eslintrc.js:
--------------------------------------------------------------------------------
 1 | module.exports = {
 2 |   parser: '@typescript-eslint/parser',
 3 |   parserOptions: {
 4 |     project: 'tsconfig.json',
 5 |     tsconfigRootDir : __dirname, 
 6 |     sourceType: 'module',
 7 |   },
 8 |   plugins: ['@typescript-eslint/eslint-plugin'],
 9 |   extends: [
10 |     'plugin:@typescript-eslint/recommended',
11 |     'plugin:prettier/recommended',
12 |   ],
13 |   root: true,
14 |   env: {
15 |     node: true,
16 |     jest: true,
17 |   },
18 |   ignorePatterns: ['.eslintrc.js'],
19 |   rules: {
20 |     '@typescript-eslint/interface-name-prefix': 'off',
21 |     '@typescript-eslint/explicit-function-return-type': 'off',
22 |     '@typescript-eslint/explicit-module-boundary-types': 'off',
23 |     '@typescript-eslint/no-explicit-any': 'off',
24 |   },
25 | };
26 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # compiled output
 2 | /dist
 3 | /node_modules
 4 | 
 5 | # Logs
 6 | logs
 7 | *.log
 8 | npm-debug.log*
 9 | yarn-debug.log*
10 | yarn-error.log*
11 | lerna-debug.log*
12 | 
13 | # OS
14 | .DS_Store
15 | 
16 | # Tests
17 | /coverage
18 | /.nyc_output
19 | 
20 | # IDEs and editors
21 | /.idea
22 | .project
23 | .classpath
24 | .c9/
25 | *.launch
26 | .settings/
27 | *.sublime-workspace
28 | 
29 | # IDE - VSCode
30 | .vscode/*
31 | !.vscode/settings.json
32 | !.vscode/tasks.json
33 | !.vscode/launch.json
34 | !.vscode/extensions.json


--------------------------------------------------------------------------------
/.npmrc:
--------------------------------------------------------------------------------
1 | registry=https://registry.npmjs.org/
2 | 


--------------------------------------------------------------------------------
/.nvmrc:
--------------------------------------------------------------------------------
1 | v20.9.0
2 | 


--------------------------------------------------------------------------------
/.prettierrc:
--------------------------------------------------------------------------------
1 | {
2 |   "singleQuote": true,
3 |   "trailingComma": "all"
4 | }


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # [3.1.0](https://github.com/benMain/aws-serverless-fastify/compare/v3.0.7...v3.1.0) (2024-05-16)
 2 | 
 3 | 
 4 | ### Features
 5 | 
 6 | * **NestJs10Compatibility:** Add compatibility for NestJs10. ([4a7f466](https://github.com/benMain/aws-serverless-fastify/commit/4a7f466dc380f2bc8ae6a5d1da79154fbd909254))
 7 | * **NestJs10Compatibility:** Add compatibility for NestJs10. ([fbb4eb2](https://github.com/benMain/aws-serverless-fastify/commit/fbb4eb2394b1eebf143e92c3171c44239bf5617f))
 8 | 
 9 | ## [3.0.7](https://github.com/benMain/aws-serverless-fastify/compare/v3.0.6...v3.0.7) (2024-05-16)
10 | 
11 | ## [3.0.6](https://github.com/benMain/aws-serverless-fastify/compare/v3.0.5...v3.0.6) (2023-12-14)
12 | 
13 | ## [3.0.5](https://github.com/benMain/aws-serverless-fastify/compare/v3.0.4...v3.0.5) (2023-12-08)
14 | 
15 | 
16 | ### Bug Fixes
17 | 
18 | * use options object on instance.listen ([cc2820a](https://github.com/benMain/aws-serverless-fastify/commit/cc2820a))
19 | 
20 | ## [3.0.4](https://github.com/benMain/aws-serverless-fastify/compare/v3.0.3...v3.0.4) (2023-06-20)
21 | 
22 | ## [3.0.3](https://github.com/benMain/aws-serverless-fastify/compare/v3.0.2...v3.0.3) (2023-06-08)
23 | 
24 | ## [3.0.2](https://github.com/benMain/aws-serverless-fastify/compare/v3.0.1...v3.0.2) (2023-01-11)
25 | 
26 | ## [3.0.1](https://github.com/benMain/aws-serverless-fastify/compare/v3.0.0...v3.0.1) (2023-01-10)
27 | 
28 | # [3.0.0](https://github.com/benMain/aws-serverless-fastify/compare/v2.0.1...v3.0.0) (2022-11-15)
29 | 
30 | ## [2.0.1](https://github.com/benMain/aws-serverless-fastify/compare/v2.0.0...v2.0.1) (2022-11-10)
31 | 
32 | # [2.0.0](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.29...v2.0.0) (2022-11-10)
33 | 
34 | ## [1.0.29](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.28...v1.0.29) (2022-06-07)
35 | 
36 | ## [1.0.28](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.27...v1.0.28) (2021-10-05)
37 | 
38 | ## [1.0.27](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.26...v1.0.27) (2021-07-22)
39 | 
40 | ## [1.0.26](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.25...v1.0.26) (2021-05-04)
41 | 
42 | ## [1.0.25](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.24...v1.0.25) (2021-01-14)
43 | 
44 | ## [1.0.24](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.23...v1.0.24) (2020-11-25)
45 | 
46 | ## [1.0.23](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.22...v1.0.23) (2020-10-15)
47 | 
48 | ## [1.0.22](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.21...v1.0.22) (2020-10-15)
49 | 
50 | ## [1.0.21](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.20...v1.0.21) (2020-08-10)
51 | 
52 | ## [1.0.20](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.19...v1.0.20) (2020-07-28)
53 | 
54 | ## [1.0.19](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.18...v1.0.19) (2020-07-28)
55 | 
56 | ## [1.0.18](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.17...v1.0.18) (2020-07-10)
57 | 
58 | ## [1.0.17](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.16...v1.0.17) (2020-05-14)
59 | 
60 | ## [1.0.16](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.15...v1.0.16) (2020-05-14)
61 | 
62 | ## [1.0.15](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.14...v1.0.15) (2020-05-14)
63 | 
64 | ## [1.0.14](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.13...v1.0.14) (2020-05-14)
65 | 
66 | ## [1.0.13](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.12...v1.0.13) (2019-12-30)
67 | 
68 | ## [1.0.12](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.11...v1.0.12) (2019-12-30)
69 | 
70 | ## [1.0.11](https://github.com/benMain/aws-serverless-fastify/compare/v1.0.10...v1.0.11) (2019-11-20)
71 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Copyright 2019 Benjamin Main
2 | 
3 | 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:
4 | 
5 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6 | 
7 | 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.


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # AWS-SERVERLESS-FASTIFY
  2 | 
  3 | <p align="center">
  4 |   <a href="https://docs.aws.amazon.com/lambda/latest/dg/with-on-demand-https.html" target="blank"><img src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcR_J7FdTrTevEYb1SKKWlcxc3xKVXR6x7oBG7jHh0e8P5Ev_IN-Aw" width="320" alt="Nest Logo" /></a>
  5 | </p>
  6 | 
  7 | ## Description
  8 | 
  9 | A port of the AWSLABS [aws-serverless-express](https://github.com/awslabs/aws-serverless-express) library tailor made for the
 10 | [Fastify](https://www.fastify.io/) web framework. Inspired by wanting to use the Fastify gracefully in [Nest](https://docs.nestjs.com/) projects with Lambda. Plus it's called Fastify, how cool is that!
 11 | 
 12 | ## Nest Compatibility
 13 | 
 14 | Version 1.x compatible with nestjs 7.x and Fastify 2.x 
 15 | Version 2.x compatible with nestjs 8.x and Fastify 3.x
 16 | Version 3.x compatible with nestjs 9.x and Fastify 4.x
 17 | 
 18 | ## Installation
 19 | 
 20 | ```bash
 21 | $ npm install aws-serverless-fastify
 22 | ```
 23 | 
 24 | ## Examples
 25 | 
 26 | ### Nest
 27 | 
 28 | Nest example is provided [here](https://github.com/benMain/aws-serverless-fastify-nest-example). Below is the summary.
 29 | 
 30 | lambda-entrypoint.ts (I think the lambda-entrypoint.ts is much cleaner than what is proposed by [Fastify](https://github.com/fastify/fastify/blob/master/docs/Serverless.md))
 31 | 
 32 | ```typescript
 33 | import {
 34 |   Context,
 35 |   APIGatewayProxyEvent,
 36 |   APIGatewayProxyResult,
 37 | } from 'aws-lambda';
 38 | import { bootstrap } from './app';
 39 | import * as fastify from 'fastify';
 40 | import { proxy } from 'aws-serverless-fastify';
 41 | 
 42 | let fastifyServer: fastify.FastifyInstance;
 43 | 
 44 | export const handler = async (
 45 |   event: APIGatewayProxyEvent,
 46 |   context: Context,
 47 | ): Promise<APIGatewayProxyResult> => {
 48 |   if (!fastifyServer) {
 49 |     fastifyServer = await bootstrap();
 50 |   }
 51 |   return await proxy(fastifyServer, event, context);
 52 | };
 53 | ```
 54 | 
 55 | app.ts (Setup the application once in app.ts)
 56 | 
 57 | ```typescript
 58 | import { NestFactory } from '@nestjs/core';
 59 | import { AppModule } from './app.module';
 60 | import {
 61 |   FastifyAdapter,
 62 |   NestFastifyApplication,
 63 | } from '@nestjs/platform-fastify';
 64 | import * as fastify from 'fastify';
 65 | 
 66 | export async function bootstrap(): Promise<fastify.FastifyInstance> {
 67 |   const serverOptions: fastify.ServerOptionsAsHttp = {
 68 |     logger: true,
 69 |   };
 70 |   const instance: fastify.FastifyInstance = fastify(serverOptions);
 71 |   const nestApp = await NestFactory.create<NestFastifyApplication>(
 72 |     AppModule,
 73 |     new FastifyAdapter(instance),
 74 |   );
 75 |   nestApp.setGlobalPrefix('api');
 76 |   nestApp.enableCors();
 77 |   await nestApp.init();
 78 |   return instance;
 79 | }
 80 | ```
 81 | 
 82 | main.ts (Will still serve to run the Nest App locally)
 83 | 
 84 | ```typescript
 85 | import { bootstrap } from './app';
 86 | 
 87 | async function startLocal() {
 88 |   const fastifyInstance = await bootstrap();
 89 |   fastifyInstance.listen(3000);
 90 | }
 91 | 
 92 | startLocal();
 93 | ```
 94 | 
 95 | ## Performance
 96 | 
 97 | Not meant to be exhaustive by any means but here are some basic load tests comparisons through API Gateway via [Artillery](https://artillery.io/). [aws-serverless-fastify](https://benMain.github.io/aws-serverless-fastify/performance/aws-serverless-fastify-results.html) versus [aws-serverless-express](https://benMain.github.io/aws-serverless-fastify/performance/aws-serverless-express-results.html)
 98 | 
 99 | ## Support
100 | 
101 | Pull Requests are welcome! We just thought this was a cool idea to simplify!
102 | Important: Commits should follow Angluar conventional-changelog format :)
103 | 
104 | ## Stay in touch
105 | 
106 | - Author - [Benjamin Main](mailto:bmain@lumeris.com)
107 | 
108 | ## License
109 | 
110 | aws-serverless-fastify is [MIT licensed](LICENSE).
111 | 


--------------------------------------------------------------------------------
/artillery-test.yml:
--------------------------------------------------------------------------------
 1 | config:
 2 |   target: 'https://dev-customerservice.api.lumeris.io/api/members'
 3 |   phases:
 4 |     - duration: 60
 5 |       arrivalRate: 10
 6 |   defaults:
 7 |     headers:
 8 |       Accept: 'application/json'
 9 |       x-api-key: "{{ $processEnvironment.X_API_KEY }}"
10 |   payload:
11 |     path: "ids.csv"
12 |     fields: 
13 |       - "id"
14 | scenarios:
15 |   - flow:
16 |     - get:
17 |         url: "/{{ id }}"
18 | 


--------------------------------------------------------------------------------
/docs/performance/aws-serverless-express-results.html:
--------------------------------------------------------------------------------
  1 | <!DOCTYPE html>
  2 | <html>
  3 | <head>
  4 |   <title>Artillery report</title>
  5 |   <script src='https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js'></script>
  6 |   <script src='https://cdnjs.cloudflare.com/ajax/libs/d3/3.5.0/d3.min.js' charset='utf-8'></script>
  7 |   <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/metrics-graphics/2.6.0/metricsgraphics.min.css" />
  8 |   <script src="https://cdnjs.cloudflare.com/ajax/libs/metrics-graphics/2.6.0/metricsgraphics.min.js"></script>
  9 | 
 10 |   <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,300,700' rel='stylesheet' type='text/css'>
 11 |   <link href='https://fonts.googleapis.com/css?family=PT+Serif:400,700,400italic' rel='stylesheet' type='text/css'>
 12 |   <link href='https://netdna.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.css' rel='stylesheet' type='text/css'>
 13 |   <link href='https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css' rel='stylesheet' type='text/css'>
 14 | 
 15 |   <script src="https://cdnjs.cloudflare.com/ajax/libs/moment.js/2.10.6/moment.min.js"></script>
 16 |   <script src="https://cdnjs.cloudflare.com/ajax/libs/lodash.js/3.10.1/lodash.min.js"></script>
 17 | 
 18 |   <script src="https://cdnjs.cloudflare.com/ajax/libs/ace/1.2.0/ace.js" charset="utf-8"></script>
 19 | 
 20 |   <style>
 21 |   body, p, li {
 22 |     font-family: sans-serif;
 23 |     font-size: 10pt;
 24 |   }
 25 | 
 26 |   h1 {
 27 |     font-size: 18pt;
 28 |     font-weight: bold;
 29 |   }
 30 | 
 31 |   #errorsContainer > p {
 32 |     color: #009900;
 33 |   }
 34 | 
 35 |   #footer {
 36 |     padding: 1em;
 37 |     font-size: 0.8em;
 38 |     color: #999;
 39 |     text-align: center;
 40 |     margin-top: 1em;
 41 |     background-color: #eee;
 42 |   }
 43 |   #editor {
 44 |     font-size: 8pt;
 45 |     height: 20em;
 46 |   }
 47 |   </style>
 48 | 
 49 |   <script>
 50 |   window.Report = {
 51 |   "aggregate": {
 52 |     "timestamp": "2019-07-04T01:24:51.309Z",
 53 |     "scenariosCreated": 600,
 54 |     "scenariosCompleted": 600,
 55 |     "requestsCompleted": 600,
 56 |     "latency": {
 57 |       "min": 140.4,
 58 |       "max": 618.1,
 59 |       "median": 160.8,
 60 |       "p95": 243.5,
 61 |       "p99": 297
 62 |     },
 63 |     "rps": {
 64 |       "count": 600,
 65 |       "mean": 9.94
 66 |     },
 67 |     "scenarioDuration": {
 68 |       "min": 142.6,
 69 |       "max": 620.5,
 70 |       "median": 163.6,
 71 |       "p95": 247.1,
 72 |       "p99": 298.9
 73 |     },
 74 |     "scenarioCounts": {
 75 |       "0": 600
 76 |     },
 77 |     "errors": {},
 78 |     "codes": {
 79 |       "200": 580,
 80 |       "500": 20
 81 |     },
 82 |     "matches": 0,
 83 |     "customStats": {},
 84 |     "counters": {},
 85 |     "scenariosAvoided": 0,
 86 |     "phases": [
 87 |       {
 88 |         "duration": 60,
 89 |         "arrivalRate": 10
 90 |       }
 91 |     ]
 92 |   },
 93 |   "intermediate": [
 94 |     {
 95 |       "timestamp": "2019-07-04T01:24:00.795Z",
 96 |       "scenariosCreated": 99,
 97 |       "scenariosCompleted": 98,
 98 |       "requestsCompleted": 98,
 99 |       "latency": {
100 |         "min": 144.2,
101 |         "max": 259.3,
102 |         "median": 162.7,
103 |         "p95": 236.7,
104 |         "p99": 258
105 |       },
106 |       "rps": {
107 |         "count": 99,
108 |         "mean": 10.05
109 |       },
110 |       "scenarioDuration": {
111 |         "min": 147.4,
112 |         "max": 261.7,
113 |         "median": 165.5,
114 |         "p95": 244.2,
115 |         "p99": 260.5
116 |       },
117 |       "scenarioCounts": {
118 |         "0": 99
119 |       },
120 |       "errors": {},
121 |       "codes": {
122 |         "200": 98
123 |       },
124 |       "matches": 0,
125 |       "customStats": {},
126 |       "counters": {},
127 |       "concurrency": 1,
128 |       "pendingRequests": 1,
129 |       "scenariosAvoided": 0
130 |     },
131 |     {
132 |       "timestamp": "2019-07-04T01:24:10.792Z",
133 |       "scenariosCreated": 100,
134 |       "scenariosCompleted": 100,
135 |       "requestsCompleted": 100,
136 |       "latency": {
137 |         "min": 145.4,
138 |         "max": 277.2,
139 |         "median": 160.4,
140 |         "p95": 233.3,
141 |         "p99": 275.5
142 |       },
143 |       "rps": {
144 |         "count": 100,
145 |         "mean": 10.01
146 |       },
147 |       "scenarioDuration": {
148 |         "min": 148.1,
149 |         "max": 279.5,
150 |         "median": 162.8,
151 |         "p95": 235.8,
152 |         "p99": 277.7
153 |       },
154 |       "scenarioCounts": {
155 |         "0": 100
156 |       },
157 |       "errors": {},
158 |       "codes": {
159 |         "200": 100
160 |       },
161 |       "matches": 0,
162 |       "customStats": {},
163 |       "counters": {},
164 |       "concurrency": 1,
165 |       "pendingRequests": 1,
166 |       "scenariosAvoided": 0
167 |     },
168 |     {
169 |       "timestamp": "2019-07-04T01:24:20.792Z",
170 |       "scenariosCreated": 100,
171 |       "scenariosCompleted": 100,
172 |       "requestsCompleted": 100,
173 |       "latency": {
174 |         "min": 144.1,
175 |         "max": 272.4,
176 |         "median": 205.7,
177 |         "p95": 251.1,
178 |         "p99": 268.3
179 |       },
180 |       "rps": {
181 |         "count": 100,
182 |         "mean": 10.02
183 |       },
184 |       "scenarioDuration": {
185 |         "min": 146.4,
186 |         "max": 277.8,
187 |         "median": 208.2,
188 |         "p95": 253.3,
189 |         "p99": 272.2
190 |       },
191 |       "scenarioCounts": {
192 |         "0": 100
193 |       },
194 |       "errors": {},
195 |       "codes": {
196 |         "200": 100
197 |       },
198 |       "matches": 0,
199 |       "customStats": {},
200 |       "counters": {},
201 |       "concurrency": 1,
202 |       "pendingRequests": 1,
203 |       "scenariosAvoided": 0
204 |     },
205 |     {
206 |       "timestamp": "2019-07-04T01:24:30.791Z",
207 |       "scenariosCreated": 100,
208 |       "scenariosCompleted": 100,
209 |       "requestsCompleted": 100,
210 |       "latency": {
211 |         "min": 142.8,
212 |         "max": 314,
213 |         "median": 160.8,
214 |         "p95": 253.2,
215 |         "p99": 307.2
216 |       },
217 |       "rps": {
218 |         "count": 100,
219 |         "mean": 10.01
220 |       },
221 |       "scenarioDuration": {
222 |         "min": 145.1,
223 |         "max": 316.6,
224 |         "median": 163.6,
225 |         "p95": 255.4,
226 |         "p99": 309.5
227 |       },
228 |       "scenarioCounts": {
229 |         "0": 100
230 |       },
231 |       "errors": {},
232 |       "codes": {
233 |         "200": 100
234 |       },
235 |       "matches": 0,
236 |       "customStats": {},
237 |       "counters": {},
238 |       "concurrency": 1,
239 |       "pendingRequests": 1,
240 |       "scenariosAvoided": 0
241 |     },
242 |     {
243 |       "timestamp": "2019-07-04T01:24:40.792Z",
244 |       "scenariosCreated": 100,
245 |       "scenariosCompleted": 100,
246 |       "requestsCompleted": 100,
247 |       "latency": {
248 |         "min": 140.9,
249 |         "max": 293.5,
250 |         "median": 159.5,
251 |         "p95": 243.9,
252 |         "p99": 280.8
253 |       },
254 |       "rps": {
255 |         "count": 100,
256 |         "mean": 10.01
257 |       },
258 |       "scenarioDuration": {
259 |         "min": 143.1,
260 |         "max": 295.3,
261 |         "median": 162.1,
262 |         "p95": 246.4,
263 |         "p99": 282.8
264 |       },
265 |       "scenarioCounts": {
266 |         "0": 100
267 |       },
268 |       "errors": {},
269 |       "codes": {
270 |         "200": 100
271 |       },
272 |       "matches": 0,
273 |       "customStats": {},
274 |       "counters": {},
275 |       "concurrency": 1,
276 |       "pendingRequests": 1,
277 |       "scenariosAvoided": 0
278 |     },
279 |     {
280 |       "timestamp": "2019-07-04T01:24:50.792Z",
281 |       "scenariosCreated": 100,
282 |       "scenariosCompleted": 99,
283 |       "requestsCompleted": 99,
284 |       "latency": {
285 |         "min": 140.4,
286 |         "max": 618.1,
287 |         "median": 157.9,
288 |         "p95": 260.6,
289 |         "p99": 590.8
290 |       },
291 |       "rps": {
292 |         "count": 100,
293 |         "mean": 10.01
294 |       },
295 |       "scenarioDuration": {
296 |         "min": 142.6,
297 |         "max": 620.5,
298 |         "median": 160.3,
299 |         "p95": 263.3,
300 |         "p99": 593.6
301 |       },
302 |       "scenarioCounts": {
303 |         "0": 100
304 |       },
305 |       "errors": {},
306 |       "codes": {
307 |         "200": 82,
308 |         "500": 17
309 |       },
310 |       "matches": 0,
311 |       "customStats": {},
312 |       "counters": {},
313 |       "concurrency": 2,
314 |       "pendingRequests": 2,
315 |       "scenariosAvoided": 0
316 |     },
317 |     {
318 |       "timestamp": "2019-07-04T01:24:51.298Z",
319 |       "scenariosCreated": 1,
320 |       "scenariosCompleted": 3,
321 |       "requestsCompleted": 3,
322 |       "latency": {
323 |         "min": 149.7,
324 |         "max": 212,
325 |         "median": 174.2,
326 |         "p95": 212,
327 |         "p99": 212
328 |       },
329 |       "rps": {
330 |         "count": 1,
331 |         "mean": 2
332 |       },
333 |       "scenarioDuration": {
334 |         "min": 156.6,
335 |         "max": 214.3,
336 |         "median": 176.4,
337 |         "p95": 214.3,
338 |         "p99": 214.3
339 |       },
340 |       "scenarioCounts": {
341 |         "0": 1
342 |       },
343 |       "errors": {},
344 |       "codes": {
345 |         "500": 3
346 |       },
347 |       "matches": 0,
348 |       "customStats": {},
349 |       "counters": {},
350 |       "concurrency": 0,
351 |       "pendingRequests": 0,
352 |       "scenariosAvoided": 0
353 |     }
354 |   ]
355 | };
356 |   </script>
357 | 
358 |   <style>
359 |       h1 {
360 |         line-height: 200%;
361 |       }
362 | 
363 |       body {
364 |           background-color: #fcfcfc;
365 |       }
366 | 
367 |       .container {
368 |           width: 100%;
369 |           min-width: 960px;
370 |       }
371 |   </style>
372 | 
373 | 
374 | </head>
375 | <body>
376 | 
377 | <div class="container">
378 | 
379 | <div class="row" id="header">
380 |   <div class="col-lg-4 col-lg-offset-4">
381 |     <pre style="font-size: 5pt; background-color: #fcfcfc; border: none;">
382 |             _   _ _ _                                                _
383 |   __ _ _ __| |_(_) | | ___ _ __ _   _      _ __ ___ _ __   ___  _ __| |_
384 |  / _` | '__| __| | | |/ _ \ '__| | | |    | '__/ _ \ '_ \ / _ \| '__| __|
385 | | (_| | |  | |_| | | |  __/ |  | |_| |    | | |  __/ |_) | (_) | |  | |_
386 |  \__,_|_|   \__|_|_|_|\___|_|   \__, |    |_|  \___| .__/ \___/|_|   \__|
387 |                                 |___/              |_|
388 | 
389 |     </pre>
390 |   </div>
391 | </div>
392 | 
393 | <div class="row">
394 |   <div class="col-lg-12">
395 |     <h1 class="text-center" id="page-title">Test run on <span id="timestamp">date</span></h1>
396 |   </div>
397 | </div>
398 | 
399 | <div class="row">
400 |   <div class="col-lg-3">
401 |     <p><strong>Summary</strong></p>
402 |     <table class="table table-bordered table-hover table-condensed">
403 |       <tbody>
404 |         <tr>
405 |           <td>Test duration</td>
406 |           <td><span id="testDuration">0</span> sec</td>
407 |         </tr>
408 |         <tr>
409 |           <td>Scenarios created</td>
410 |           <td><span id="scenariosCreated">0</span></td>
411 |         </tr>
412 | 
413 |         <tr>
414 |           <td>Scenarios completed</td>
415 |           <td><span id="scenariosCompleted">0</span></td>
416 |         </tr>
417 |       </tbody>
418 |     </table>
419 |   </div>
420 | 
421 |   <div class="col-lg-5" id="scenarioCountsContainer">
422 |     <div>
423 |       <strong>Scenario counts:</strong>
424 | 
425 |       <p></p>
426 | 
427 |       <table class="table table-bordered table-hover table-condensed" id="scenarioCounts">
428 |       </table>
429 |     </div>
430 |   </div>
431 | 
432 |   <div class="col-lg-1">
433 |     <div id="codesContainer">
434 |       <strong>Codes</strong>
435 | 
436 |       <p></p>
437 | 
438 |       <table class="table table-bordered table-hover table-condensed" id="codes">
439 |       </table>
440 |     </div>
441 |   </div>
442 | 
443 |   <div class="col-lg-3">
444 |     <div id="errorsContainer">
445 |       <strong>Errors</strong>
446 | 
447 |       <p></p>
448 | 
449 |       <table class="table table-bordered table-hover table-condensed" id="errors">
450 |       </table>
451 |     </div>
452 |   </div>
453 | </div> <!-- /.row -->
454 | 
455 | <div class="row">
456 |   <div class="text-center col-lg-12">
457 |     <h2>Charts</h2>
458 |   </div>
459 | </div>
460 | 
461 | <div class="row">
462 |   <div class="latency-histogram text-center col-lg-12"></div>
463 | </div>
464 | 
465 | <div class="row">
466 |   <div class="latency text-center col-lg-12"></div>
467 | </div>
468 | 
469 | <div class="latency-legend"></div>
470 | 
471 | <div class="row">
472 | 
473 | </div>
474 | 
475 | <div class="row">
476 |   <div class="concurrency text-center col-lg-12"></div>
477 | </div>
478 | 
479 | <div class="row">
480 |   <div class="rps-mean text-center col-lg-12"></div>
481 | </div>
482 | <div class="row">
483 |   <div class="rps-count text-center col-lg-12"></div>
484 | </div>
485 | 
486 | <div class="row">
487 |   <div class="codes-line text-center col-lg-12"></div>
488 | </div>
489 | <div class="row">
490 |   <div class="errors-line text-center col-lg-12"></div>
491 | </div>
492 | 
493 | 
494 |   
495 | 
496 | 
497 | </div>
498 | 
499 | <div class="row">
500 |   <div class="col-lg-8 col-lg-offset-2">
501 |     <h3 class="text-center">Raw report data</h3>
502 |     <p>This is the raw JSON stats output that the report was generated from.</p>
503 |     <div id="editor">
504 |     </div>
505 |   </div>
506 | </div>
507 | 
508 | <script>
509 | var editor = ace.edit("editor");
510 | editor.getSession().setMode("ace/mode/javascript");
511 | editor.setValue(JSON.stringify(Report, null, 2));
512 | editor.gotoLine(1);editor.setHighlightActiveLine(false);
513 | 
514 | var l = _;
515 | 
516 | $('#timestamp').html(moment(Report.aggregate.timestamp).format('DD MMM YYYY HH:mm:SS'));
517 | $('#testDuration').html(l.size(Report.intermediate) * 10);
518 | $('#scenariosCompleted').html(Report.aggregate.scenariosCompleted);
519 | $('#scenariosCreated').html(Report.aggregate.scenariosCreated);
520 | 
521 | var markers = [];
522 | if(l.size(Report.phases) > 0) {
523 |   markers = l.foldl(Report.phases, function(acc, phase, index) {
524 |     var label = phase.name || 'Phase ' + (index + 1);
525 |     var timestamp = (index === 0) ? 0 : Report.phases[index - 1].duration + acc[index - 1].timestamp;
526 | 
527 |     acc.push({
528 |       timestamp: timestamp,
529 |       label: label
530 |     });
531 | 
532 |     return acc;
533 |   }, []);
534 | }
535 | 
536 | if (l.size(Report.aggregate.scenarioCounts) > 0) {
537 |   l.each(Report.aggregate.scenarioCounts, function(count, name) {
538 |     var $tdName = $('<td>' + name + '</td>');
539 |     var percentage = Math.round(count / Report.aggregate.scenariosCreated * 100 * 1000) / 1000;
540 |     var $tdCount = $('<td>' + count + ' (' + percentage + '%)' + '</td>');
541 |     var $el = $('<tr></tr>')
542 |       .append($tdName)
543 |       .append($tdCount)
544 |       .appendTo($('#scenarioCounts'));
545 |   });
546 | } else {
547 |   $('#scenarioCountsContainer').hide();
548 | }
549 | 
550 | if (l.size(Report.aggregate.codes) > 0) {
551 |   l.each(Report.aggregate.codes, function(count, code) {
552 |     var anchor = '';
553 |     if (code >= 100 && code < 200) {
554 |       anchor = '#1xx_Informational';
555 |     } else if (code >= 200 && code < 300) {
556 |       anchor = '#2xx_Success';
557 |     } else if (code >= 300 && code < 400) {
558 |       anchor = '#3xx_Redirection';
559 |     } else if (code >= 400 && code < 500) {
560 |       anchor = '#4xx_Client_Error';
561 |     } else if (code >= 500 && code < 600) {
562 |       anchor = '#5xx_Server_Error';
563 |     }
564 | 
565 |     var $a = $('<a>' + code + '</a>').attr('href', 'https://en.wikipedia.org/wiki/List_of_HTTP_status_codes' + anchor);
566 |     var $td = $('<td></td>').append($a);
567 |     var $el = $('<tr></tr>')
568 |       .append($td)
569 |       .append($('<td>' + count + '</td>'))
570 |       .appendTo($('#codes'));
571 |   });
572 | } else {
573 |   $('#codesContainer').hide();
574 | }
575 | 
576 | if (l.size(Report.aggregate.errors) > 0) {
577 |   l.each(Report.aggregate.errors, function(count, code) {
578 |     var $el = $('<tr></tr>')
579 |       .append($('<td>' + code + '</td>'))
580 |       .append($('<td>' + count + '</td>'))
581 |       .appendTo($('#errors'));
582 |   });
583 | } else {
584 |   $('#errorsContainer > p').html('&#10004; Test completed without network or OS errors.');
585 | }
586 | 
587 | var histogramData = l.map(Report.aggregate.latency, function(v, k) { return {bin: k, value: v} });
588 | 
589 | MG.data_graphic({
590 |   chart_type: 'bar',
591 |   x_label: 'Percentile',
592 |   y_label: '(ms)',
593 |   animate_on_load: true,
594 |   title: 'Overall Latency Distribution',
595 |   description: 'Distribution of all observed response latencies',
596 |   target: '.latency-histogram',
597 |   data: histogramData,
598 |   x_accessor: 'bin',
599 |   y_accessor: 'value',
600 |   binned: true,
601 |   height: 250,
602 |   interpolate: 'monotone',
603 |   padding_percentage: 0,
604 |   bar_orientation: 'vertical',
605 |   width: 450
606 | });
607 | 
608 | var chartData = l.map(
609 |   window.Report.intermediate,
610 |   function(o,i) {
611 |     return {
612 |       timestamp: i*10+10,
613 | 
614 |       rpsMean: o.rps.mean,
615 |       rpsCount: o.rps.count,
616 |       concurrency: o.concurrency,
617 |       latencyMax: o.latency.max,
618 |       latencyp99: o.latency.p99,
619 |       latencyp95: o.latency.p95,
620 |       latencyMedian: o.latency.median,
621 |       latencyMin: o.latency.min
622 |     }
623 |   });
624 | 
625 | //
626 | // Response codes
627 | //
628 | 
629 | if (l.size(Report.aggregate.codes) > 0) {
630 |   var codesData = l.foldl(Report.intermediate, function(acc, o, i) {
631 |     var res = {};
632 |     res.timestamp = i*10+10;
633 |     l.each(o.codes, function(count, code) {
634 |       res[code] = count;
635 |     });
636 |     acc.push(res);
637 |     return acc;
638 |   }, []);
639 |   var uniqueCodes = l.foldl(Report.intermediate, function(acc, o) {
640 |     l.each(o.codes, function(count, code) {
641 |       if (l.indexOf(acc, code) === -1) {
642 |         acc.push(code);
643 |       }
644 |     });
645 |     return acc;
646 |   }, []);
647 | 
648 |   MG.data_graphic({
649 |     x_label: 'Time',
650 |     y_label: 'Count',
651 |     title: 'HTTP codes',
652 |     description: 'Occurence of HTTP response codes',
653 |     target: '.codes-line',
654 |     data: codesData,
655 |     x_accessor: 'timestamp',
656 |     y_accessor: uniqueCodes,
657 |     legend: uniqueCodes,
658 |     right: 50,
659 |     chart_type: 'line',
660 |     area: false,
661 |     markers: markers,
662 |     width: 900
663 |   });
664 | }
665 | 
666 | //
667 | // Errors
668 | //
669 | 
670 | if (l.size(Report.aggregate.errors) > 0) {
671 |   var errorData = l.foldl(Report.intermediate, function(acc, o, i) {
672 |     var res = {};
673 |     res.timestamp = i*10+10;
674 |     l.each(o.errors, function(count, name) {
675 |       res[name] = count;
676 |     });
677 |     acc.push(res);
678 |     return acc;
679 |   }, []);
680 |   var uniqueErrors = l.foldl(Report.intermediate, function(acc, o) {
681 |     l.each(o.errors, function(count, name) {
682 |       if (l.indexOf(acc, name) === -1) {
683 |         acc.push(name);
684 |       }
685 |     });
686 |     return acc;
687 |   }, []);
688 | 
689 |   MG.data_graphic({
690 |     title: 'Error Codes',
691 |     description: 'Occurence of error codes',
692 |     target: '.errors-line',
693 |     data: errorData,
694 |     x_accessor: 'timestamp',
695 |     y_accessor: uniqueErrors,
696 |     chart_type: 'line',
697 |     area: false,
698 |     markers: markers
699 |   });
700 | 
701 | }
702 | 
703 | //
704 | // Latency
705 | //
706 | MG.data_graphic({
707 |   chart_type: 'line',
708 |   x_label: 'Time',
709 |   y_label: '(ms)',
710 |   animate_on_load: true,
711 |   area: false,
712 |   title: "Latency At Intervals",
713 |   description: "Latency values at different points during the test run",
714 |   data: chartData,
715 |   target: '.latency',
716 |   width: 900,
717 |   x_accessor: 'timestamp',
718 |   y_accessor: ['latencyMin', 'latencyMedian', 'latencyp95', 'latencyMax'],
719 |   legend: ['min', 'p50', 'p95', 'max'],
720 |   //legend_target: '.latency-legend',
721 |   right: 50,
722 |   interpolate: 'monotone',
723 |   mouseover: function(d, i) {
724 |   },
725 |   markers: markers
726 |         });
727 | 
728 |             MG.data_graphic({
729 |             animate_on_load: true,
730 |             area: false,
731 |             y_label: 'Count',
732 |             x_label: 'Time',
733 |             title: 'Concurrent users',
734 |             description: 'Concurrent users',
735 |             data: chartData,
736 |             target: '.concurrency',
737 |             x_accessor: 'timestamp',
738 |             y_accessor: ['concurrency'],
739 |             interpolate: 'monotone',
740 |             markers: markers,
741 |             width: 900
742 |             });
743 | 
744 | MG.data_graphic({
745 |   animate_on_load: true,
746 |   area: false,
747 |   y_label: 'Count',
748 |   x_label: 'Time',
749 |   title: 'Mean RPS',
750 |   description: 'Mean requests per second',
751 |   data: chartData,
752 |   target: '.rps-mean',
753 |   x_accessor: 'timestamp',
754 |   y_accessor: ['rpsMean'],
755 |   interpolate: 'monotone',
756 |   markers: markers,
757 |   width: 900
758 | });
759 | 
760 | MG.data_graphic({
761 |   animate_on_load: true,
762 |   area: false,
763 |   y_label: 'Count',
764 |   x_label: 'Time',
765 |   title: 'RPS Count',
766 |   description: 'Count of requests per second',
767 |   data: chartData,
768 |   target: '.rps-count',
769 |   x_accessor: 'timestamp',
770 |   y_accessor: ['rpsCount'],
771 |   interpolate: 'monotone',
772 |   markers: markers,
773 |   width: 900
774 | });
775 | </script>
776 | <div id="footer">
777 |   <footer>This report was created with <a href="https://artillery.io">Artillery</a> - free open-source load-testing for HTTP and WebSockets</footer>
778 | </div>
779 | </body>
780 | </html>
781 | 


--------------------------------------------------------------------------------
/docs/performance/aws-serverless-fastify-results.html:
--------------------------------------------------------------------------------
  1 | <!DOCTYPE html>
  2 | <html>
  3 | <head>
  4 |   <title>Artillery report</title>
  5 |   <script src='https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js'></script>
  6 |   <script src='https://cdnjs.cloudflare.com/ajax/libs/d3/3.5.0/d3.min.js' charset='utf-8'></script>
  7 |   <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/metrics-graphics/2.6.0/metricsgraphics.min.css" />
  8 |   <script src="https://cdnjs.cloudflare.com/ajax/libs/metrics-graphics/2.6.0/metricsgraphics.min.js"></script>
  9 | 
 10 |   <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,300,700' rel='stylesheet' type='text/css'>
 11 |   <link href='https://fonts.googleapis.com/css?family=PT+Serif:400,700,400italic' rel='stylesheet' type='text/css'>
 12 |   <link href='https://netdna.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.css' rel='stylesheet' type='text/css'>
 13 |   <link href='https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css' rel='stylesheet' type='text/css'>
 14 | 
 15 |   <script src="https://cdnjs.cloudflare.com/ajax/libs/moment.js/2.10.6/moment.min.js"></script>
 16 |   <script src="https://cdnjs.cloudflare.com/ajax/libs/lodash.js/3.10.1/lodash.min.js"></script>
 17 | 
 18 |   <script src="https://cdnjs.cloudflare.com/ajax/libs/ace/1.2.0/ace.js" charset="utf-8"></script>
 19 | 
 20 |   <style>
 21 |   body, p, li {
 22 |     font-family: sans-serif;
 23 |     font-size: 10pt;
 24 |   }
 25 | 
 26 |   h1 {
 27 |     font-size: 18pt;
 28 |     font-weight: bold;
 29 |   }
 30 | 
 31 |   #errorsContainer > p {
 32 |     color: #009900;
 33 |   }
 34 | 
 35 |   #footer {
 36 |     padding: 1em;
 37 |     font-size: 0.8em;
 38 |     color: #999;
 39 |     text-align: center;
 40 |     margin-top: 1em;
 41 |     background-color: #eee;
 42 |   }
 43 |   #editor {
 44 |     font-size: 8pt;
 45 |     height: 20em;
 46 |   }
 47 |   </style>
 48 | 
 49 |   <script>
 50 |   window.Report = {
 51 |   "aggregate": {
 52 |     "timestamp": "2019-07-04T01:05:24.803Z",
 53 |     "scenariosCreated": 600,
 54 |     "scenariosCompleted": 600,
 55 |     "requestsCompleted": 600,
 56 |     "latency": {
 57 |       "min": 91.7,
 58 |       "max": 1250.6,
 59 |       "median": 119.7,
 60 |       "p95": 201.7,
 61 |       "p99": 347.1
 62 |     },
 63 |     "rps": {
 64 |       "count": 600,
 65 |       "mean": 9.94
 66 |     },
 67 |     "scenarioDuration": {
 68 |       "min": 94.2,
 69 |       "max": 1253.1,
 70 |       "median": 122.1,
 71 |       "p95": 204.2,
 72 |       "p99": 349.6
 73 |     },
 74 |     "scenarioCounts": {
 75 |       "0": 600
 76 |     },
 77 |     "errors": {},
 78 |     "codes": {
 79 |       "200": 600
 80 |     },
 81 |     "matches": 0,
 82 |     "customStats": {},
 83 |     "counters": {},
 84 |     "scenariosAvoided": 0,
 85 |     "phases": [
 86 |       {
 87 |         "duration": 60,
 88 |         "arrivalRate": 10
 89 |       }
 90 |     ]
 91 |   },
 92 |   "intermediate": [
 93 |     {
 94 |       "timestamp": "2019-07-04T01:04:34.283Z",
 95 |       "scenariosCreated": 99,
 96 |       "scenariosCompleted": 98,
 97 |       "requestsCompleted": 98,
 98 |       "latency": {
 99 |         "min": 93.9,
100 |         "max": 1250.6,
101 |         "median": 154.2,
102 |         "p95": 309.5,
103 |         "p99": 853.4
104 |       },
105 |       "rps": {
106 |         "count": 99,
107 |         "mean": 10.06
108 |       },
109 |       "scenarioDuration": {
110 |         "min": 95.9,
111 |         "max": 1253.1,
112 |         "median": 156.5,
113 |         "p95": 312.1,
114 |         "p99": 855.8
115 |       },
116 |       "scenarioCounts": {
117 |         "0": 99
118 |       },
119 |       "errors": {},
120 |       "codes": {
121 |         "200": 98
122 |       },
123 |       "matches": 0,
124 |       "customStats": {},
125 |       "counters": {},
126 |       "concurrency": 1,
127 |       "pendingRequests": 1,
128 |       "scenariosAvoided": 0
129 |     },
130 |     {
131 |       "timestamp": "2019-07-04T01:04:44.281Z",
132 |       "scenariosCreated": 100,
133 |       "scenariosCompleted": 100,
134 |       "requestsCompleted": 100,
135 |       "latency": {
136 |         "min": 94.1,
137 |         "max": 263.1,
138 |         "median": 117.5,
139 |         "p95": 188.7,
140 |         "p99": 250.2
141 |       },
142 |       "rps": {
143 |         "count": 100,
144 |         "mean": 10.01
145 |       },
146 |       "scenarioDuration": {
147 |         "min": 96.8,
148 |         "max": 266.1,
149 |         "median": 120.1,
150 |         "p95": 191.3,
151 |         "p99": 252.8
152 |       },
153 |       "scenarioCounts": {
154 |         "0": 100
155 |       },
156 |       "errors": {},
157 |       "codes": {
158 |         "200": 100
159 |       },
160 |       "matches": 0,
161 |       "customStats": {},
162 |       "counters": {},
163 |       "concurrency": 1,
164 |       "pendingRequests": 1,
165 |       "scenariosAvoided": 0
166 |     },
167 |     {
168 |       "timestamp": "2019-07-04T01:04:54.282Z",
169 |       "scenariosCreated": 100,
170 |       "scenariosCompleted": 99,
171 |       "requestsCompleted": 99,
172 |       "latency": {
173 |         "min": 93.9,
174 |         "max": 345.8,
175 |         "median": 146.3,
176 |         "p95": 182.9,
177 |         "p99": 277.4
178 |       },
179 |       "rps": {
180 |         "count": 100,
181 |         "mean": 10.01
182 |       },
183 |       "scenarioDuration": {
184 |         "min": 96.2,
185 |         "max": 348.5,
186 |         "median": 148.4,
187 |         "p95": 185.5,
188 |         "p99": 280.1
189 |       },
190 |       "scenarioCounts": {
191 |         "0": 100
192 |       },
193 |       "errors": {},
194 |       "codes": {
195 |         "200": 99
196 |       },
197 |       "matches": 0,
198 |       "customStats": {},
199 |       "counters": {},
200 |       "concurrency": 2,
201 |       "pendingRequests": 2,
202 |       "scenariosAvoided": 0
203 |     },
204 |     {
205 |       "timestamp": "2019-07-04T01:05:04.280Z",
206 |       "scenariosCreated": 100,
207 |       "scenariosCompleted": 101,
208 |       "requestsCompleted": 101,
209 |       "latency": {
210 |         "min": 94.8,
211 |         "max": 308.6,
212 |         "median": 118.9,
213 |         "p95": 201.7,
214 |         "p99": 277.7
215 |       },
216 |       "rps": {
217 |         "count": 100,
218 |         "mean": 10.01
219 |       },
220 |       "scenarioDuration": {
221 |         "min": 96.9,
222 |         "max": 311.2,
223 |         "median": 121.5,
224 |         "p95": 204.5,
225 |         "p99": 280.7
226 |       },
227 |       "scenarioCounts": {
228 |         "0": 100
229 |       },
230 |       "errors": {},
231 |       "codes": {
232 |         "200": 101
233 |       },
234 |       "matches": 0,
235 |       "customStats": {},
236 |       "counters": {},
237 |       "concurrency": 1,
238 |       "pendingRequests": 1,
239 |       "scenariosAvoided": 0
240 |     },
241 |     {
242 |       "timestamp": "2019-07-04T01:05:14.280Z",
243 |       "scenariosCreated": 100,
244 |       "scenariosCompleted": 100,
245 |       "requestsCompleted": 100,
246 |       "latency": {
247 |         "min": 91.7,
248 |         "max": 277.8,
249 |         "median": 109.7,
250 |         "p95": 182.2,
251 |         "p99": 261.8
252 |       },
253 |       "rps": {
254 |         "count": 100,
255 |         "mean": 10.01
256 |       },
257 |       "scenarioDuration": {
258 |         "min": 94.2,
259 |         "max": 280.6,
260 |         "median": 112.6,
261 |         "p95": 185.4,
262 |         "p99": 264.5
263 |       },
264 |       "scenarioCounts": {
265 |         "0": 100
266 |       },
267 |       "errors": {},
268 |       "codes": {
269 |         "200": 100
270 |       },
271 |       "matches": 0,
272 |       "customStats": {},
273 |       "counters": {},
274 |       "concurrency": 1,
275 |       "pendingRequests": 1,
276 |       "scenariosAvoided": 0
277 |     },
278 |     {
279 |       "timestamp": "2019-07-04T01:05:24.280Z",
280 |       "scenariosCreated": 100,
281 |       "scenariosCompleted": 100,
282 |       "requestsCompleted": 100,
283 |       "latency": {
284 |         "min": 96.2,
285 |         "max": 461,
286 |         "median": 117.5,
287 |         "p95": 232.1,
288 |         "p99": 412.7
289 |       },
290 |       "rps": {
291 |         "count": 100,
292 |         "mean": 10.01
293 |       },
294 |       "scenarioDuration": {
295 |         "min": 98.4,
296 |         "max": 463,
297 |         "median": 119.9,
298 |         "p95": 234.4,
299 |         "p99": 417.2
300 |       },
301 |       "scenarioCounts": {
302 |         "0": 100
303 |       },
304 |       "errors": {},
305 |       "codes": {
306 |         "200": 100
307 |       },
308 |       "matches": 0,
309 |       "customStats": {},
310 |       "counters": {},
311 |       "concurrency": 1,
312 |       "pendingRequests": 1,
313 |       "scenariosAvoided": 0
314 |     },
315 |     {
316 |       "timestamp": "2019-07-04T01:05:24.790Z",
317 |       "scenariosCreated": 1,
318 |       "scenariosCompleted": 2,
319 |       "requestsCompleted": 2,
320 |       "latency": {
321 |         "min": 105.5,
322 |         "max": 115.5,
323 |         "median": 110.5,
324 |         "p95": 115.5,
325 |         "p99": 115.5
326 |       },
327 |       "rps": {
328 |         "count": 1,
329 |         "mean": 2
330 |       },
331 |       "scenarioDuration": {
332 |         "min": 107.2,
333 |         "max": 122.4,
334 |         "median": 114.8,
335 |         "p95": 122.4,
336 |         "p99": 122.4
337 |       },
338 |       "scenarioCounts": {
339 |         "0": 1
340 |       },
341 |       "errors": {},
342 |       "codes": {
343 |         "200": 2
344 |       },
345 |       "matches": 0,
346 |       "customStats": {},
347 |       "counters": {},
348 |       "concurrency": 0,
349 |       "pendingRequests": 0,
350 |       "scenariosAvoided": 0
351 |     }
352 |   ]
353 | };
354 |   </script>
355 | 
356 |   <style>
357 |       h1 {
358 |         line-height: 200%;
359 |       }
360 | 
361 |       body {
362 |           background-color: #fcfcfc;
363 |       }
364 | 
365 |       .container {
366 |           width: 100%;
367 |           min-width: 960px;
368 |       }
369 |   </style>
370 | 
371 | 
372 | </head>
373 | <body>
374 | 
375 | <div class="container">
376 | 
377 | <div class="row" id="header">
378 |   <div class="col-lg-4 col-lg-offset-4">
379 |     <pre style="font-size: 5pt; background-color: #fcfcfc; border: none;">
380 |             _   _ _ _                                                _
381 |   __ _ _ __| |_(_) | | ___ _ __ _   _      _ __ ___ _ __   ___  _ __| |_
382 |  / _` | '__| __| | | |/ _ \ '__| | | |    | '__/ _ \ '_ \ / _ \| '__| __|
383 | | (_| | |  | |_| | | |  __/ |  | |_| |    | | |  __/ |_) | (_) | |  | |_
384 |  \__,_|_|   \__|_|_|_|\___|_|   \__, |    |_|  \___| .__/ \___/|_|   \__|
385 |                                 |___/              |_|
386 | 
387 |     </pre>
388 |   </div>
389 | </div>
390 | 
391 | <div class="row">
392 |   <div class="col-lg-12">
393 |     <h1 class="text-center" id="page-title">Test run on <span id="timestamp">date</span></h1>
394 |   </div>
395 | </div>
396 | 
397 | <div class="row">
398 |   <div class="col-lg-3">
399 |     <p><strong>Summary</strong></p>
400 |     <table class="table table-bordered table-hover table-condensed">
401 |       <tbody>
402 |         <tr>
403 |           <td>Test duration</td>
404 |           <td><span id="testDuration">0</span> sec</td>
405 |         </tr>
406 |         <tr>
407 |           <td>Scenarios created</td>
408 |           <td><span id="scenariosCreated">0</span></td>
409 |         </tr>
410 | 
411 |         <tr>
412 |           <td>Scenarios completed</td>
413 |           <td><span id="scenariosCompleted">0</span></td>
414 |         </tr>
415 |       </tbody>
416 |     </table>
417 |   </div>
418 | 
419 |   <div class="col-lg-5" id="scenarioCountsContainer">
420 |     <div>
421 |       <strong>Scenario counts:</strong>
422 | 
423 |       <p></p>
424 | 
425 |       <table class="table table-bordered table-hover table-condensed" id="scenarioCounts">
426 |       </table>
427 |     </div>
428 |   </div>
429 | 
430 |   <div class="col-lg-1">
431 |     <div id="codesContainer">
432 |       <strong>Codes</strong>
433 | 
434 |       <p></p>
435 | 
436 |       <table class="table table-bordered table-hover table-condensed" id="codes">
437 |       </table>
438 |     </div>
439 |   </div>
440 | 
441 |   <div class="col-lg-3">
442 |     <div id="errorsContainer">
443 |       <strong>Errors</strong>
444 | 
445 |       <p></p>
446 | 
447 |       <table class="table table-bordered table-hover table-condensed" id="errors">
448 |       </table>
449 |     </div>
450 |   </div>
451 | </div> <!-- /.row -->
452 | 
453 | <div class="row">
454 |   <div class="text-center col-lg-12">
455 |     <h2>Charts</h2>
456 |   </div>
457 | </div>
458 | 
459 | <div class="row">
460 |   <div class="latency-histogram text-center col-lg-12"></div>
461 | </div>
462 | 
463 | <div class="row">
464 |   <div class="latency text-center col-lg-12"></div>
465 | </div>
466 | 
467 | <div class="latency-legend"></div>
468 | 
469 | <div class="row">
470 | 
471 | </div>
472 | 
473 | <div class="row">
474 |   <div class="concurrency text-center col-lg-12"></div>
475 | </div>
476 | 
477 | <div class="row">
478 |   <div class="rps-mean text-center col-lg-12"></div>
479 | </div>
480 | <div class="row">
481 |   <div class="rps-count text-center col-lg-12"></div>
482 | </div>
483 | 
484 | <div class="row">
485 |   <div class="codes-line text-center col-lg-12"></div>
486 | </div>
487 | <div class="row">
488 |   <div class="errors-line text-center col-lg-12"></div>
489 | </div>
490 | 
491 | 
492 |   
493 | 
494 | 
495 | </div>
496 | 
497 | <div class="row">
498 |   <div class="col-lg-8 col-lg-offset-2">
499 |     <h3 class="text-center">Raw report data</h3>
500 |     <p>This is the raw JSON stats output that the report was generated from.</p>
501 |     <div id="editor">
502 |     </div>
503 |   </div>
504 | </div>
505 | 
506 | <script>
507 | var editor = ace.edit("editor");
508 | editor.getSession().setMode("ace/mode/javascript");
509 | editor.setValue(JSON.stringify(Report, null, 2));
510 | editor.gotoLine(1);editor.setHighlightActiveLine(false);
511 | 
512 | var l = _;
513 | 
514 | $('#timestamp').html(moment(Report.aggregate.timestamp).format('DD MMM YYYY HH:mm:SS'));
515 | $('#testDuration').html(l.size(Report.intermediate) * 10);
516 | $('#scenariosCompleted').html(Report.aggregate.scenariosCompleted);
517 | $('#scenariosCreated').html(Report.aggregate.scenariosCreated);
518 | 
519 | var markers = [];
520 | if(l.size(Report.phases) > 0) {
521 |   markers = l.foldl(Report.phases, function(acc, phase, index) {
522 |     var label = phase.name || 'Phase ' + (index + 1);
523 |     var timestamp = (index === 0) ? 0 : Report.phases[index - 1].duration + acc[index - 1].timestamp;
524 | 
525 |     acc.push({
526 |       timestamp: timestamp,
527 |       label: label
528 |     });
529 | 
530 |     return acc;
531 |   }, []);
532 | }
533 | 
534 | if (l.size(Report.aggregate.scenarioCounts) > 0) {
535 |   l.each(Report.aggregate.scenarioCounts, function(count, name) {
536 |     var $tdName = $('<td>' + name + '</td>');
537 |     var percentage = Math.round(count / Report.aggregate.scenariosCreated * 100 * 1000) / 1000;
538 |     var $tdCount = $('<td>' + count + ' (' + percentage + '%)' + '</td>');
539 |     var $el = $('<tr></tr>')
540 |       .append($tdName)
541 |       .append($tdCount)
542 |       .appendTo($('#scenarioCounts'));
543 |   });
544 | } else {
545 |   $('#scenarioCountsContainer').hide();
546 | }
547 | 
548 | if (l.size(Report.aggregate.codes) > 0) {
549 |   l.each(Report.aggregate.codes, function(count, code) {
550 |     var anchor = '';
551 |     if (code >= 100 && code < 200) {
552 |       anchor = '#1xx_Informational';
553 |     } else if (code >= 200 && code < 300) {
554 |       anchor = '#2xx_Success';
555 |     } else if (code >= 300 && code < 400) {
556 |       anchor = '#3xx_Redirection';
557 |     } else if (code >= 400 && code < 500) {
558 |       anchor = '#4xx_Client_Error';
559 |     } else if (code >= 500 && code < 600) {
560 |       anchor = '#5xx_Server_Error';
561 |     }
562 | 
563 |     var $a = $('<a>' + code + '</a>').attr('href', 'https://en.wikipedia.org/wiki/List_of_HTTP_status_codes' + anchor);
564 |     var $td = $('<td></td>').append($a);
565 |     var $el = $('<tr></tr>')
566 |       .append($td)
567 |       .append($('<td>' + count + '</td>'))
568 |       .appendTo($('#codes'));
569 |   });
570 | } else {
571 |   $('#codesContainer').hide();
572 | }
573 | 
574 | if (l.size(Report.aggregate.errors) > 0) {
575 |   l.each(Report.aggregate.errors, function(count, code) {
576 |     var $el = $('<tr></tr>')
577 |       .append($('<td>' + code + '</td>'))
578 |       .append($('<td>' + count + '</td>'))
579 |       .appendTo($('#errors'));
580 |   });
581 | } else {
582 |   $('#errorsContainer > p').html('&#10004; Test completed without network or OS errors.');
583 | }
584 | 
585 | var histogramData = l.map(Report.aggregate.latency, function(v, k) { return {bin: k, value: v} });
586 | 
587 | MG.data_graphic({
588 |   chart_type: 'bar',
589 |   x_label: 'Percentile',
590 |   y_label: '(ms)',
591 |   animate_on_load: true,
592 |   title: 'Overall Latency Distribution',
593 |   description: 'Distribution of all observed response latencies',
594 |   target: '.latency-histogram',
595 |   data: histogramData,
596 |   x_accessor: 'bin',
597 |   y_accessor: 'value',
598 |   binned: true,
599 |   height: 250,
600 |   interpolate: 'monotone',
601 |   padding_percentage: 0,
602 |   bar_orientation: 'vertical',
603 |   width: 450
604 | });
605 | 
606 | var chartData = l.map(
607 |   window.Report.intermediate,
608 |   function(o,i) {
609 |     return {
610 |       timestamp: i*10+10,
611 | 
612 |       rpsMean: o.rps.mean,
613 |       rpsCount: o.rps.count,
614 |       concurrency: o.concurrency,
615 |       latencyMax: o.latency.max,
616 |       latencyp99: o.latency.p99,
617 |       latencyp95: o.latency.p95,
618 |       latencyMedian: o.latency.median,
619 |       latencyMin: o.latency.min
620 |     }
621 |   });
622 | 
623 | //
624 | // Response codes
625 | //
626 | 
627 | if (l.size(Report.aggregate.codes) > 0) {
628 |   var codesData = l.foldl(Report.intermediate, function(acc, o, i) {
629 |     var res = {};
630 |     res.timestamp = i*10+10;
631 |     l.each(o.codes, function(count, code) {
632 |       res[code] = count;
633 |     });
634 |     acc.push(res);
635 |     return acc;
636 |   }, []);
637 |   var uniqueCodes = l.foldl(Report.intermediate, function(acc, o) {
638 |     l.each(o.codes, function(count, code) {
639 |       if (l.indexOf(acc, code) === -1) {
640 |         acc.push(code);
641 |       }
642 |     });
643 |     return acc;
644 |   }, []);
645 | 
646 |   MG.data_graphic({
647 |     x_label: 'Time',
648 |     y_label: 'Count',
649 |     title: 'HTTP codes',
650 |     description: 'Occurence of HTTP response codes',
651 |     target: '.codes-line',
652 |     data: codesData,
653 |     x_accessor: 'timestamp',
654 |     y_accessor: uniqueCodes,
655 |     legend: uniqueCodes,
656 |     right: 50,
657 |     chart_type: 'line',
658 |     area: false,
659 |     markers: markers,
660 |     width: 900
661 |   });
662 | }
663 | 
664 | //
665 | // Errors
666 | //
667 | 
668 | if (l.size(Report.aggregate.errors) > 0) {
669 |   var errorData = l.foldl(Report.intermediate, function(acc, o, i) {
670 |     var res = {};
671 |     res.timestamp = i*10+10;
672 |     l.each(o.errors, function(count, name) {
673 |       res[name] = count;
674 |     });
675 |     acc.push(res);
676 |     return acc;
677 |   }, []);
678 |   var uniqueErrors = l.foldl(Report.intermediate, function(acc, o) {
679 |     l.each(o.errors, function(count, name) {
680 |       if (l.indexOf(acc, name) === -1) {
681 |         acc.push(name);
682 |       }
683 |     });
684 |     return acc;
685 |   }, []);
686 | 
687 |   MG.data_graphic({
688 |     title: 'Error Codes',
689 |     description: 'Occurence of error codes',
690 |     target: '.errors-line',
691 |     data: errorData,
692 |     x_accessor: 'timestamp',
693 |     y_accessor: uniqueErrors,
694 |     chart_type: 'line',
695 |     area: false,
696 |     markers: markers
697 |   });
698 | 
699 | }
700 | 
701 | //
702 | // Latency
703 | //
704 | MG.data_graphic({
705 |   chart_type: 'line',
706 |   x_label: 'Time',
707 |   y_label: '(ms)',
708 |   animate_on_load: true,
709 |   area: false,
710 |   title: "Latency At Intervals",
711 |   description: "Latency values at different points during the test run",
712 |   data: chartData,
713 |   target: '.latency',
714 |   width: 900,
715 |   x_accessor: 'timestamp',
716 |   y_accessor: ['latencyMin', 'latencyMedian', 'latencyp95', 'latencyMax'],
717 |   legend: ['min', 'p50', 'p95', 'max'],
718 |   //legend_target: '.latency-legend',
719 |   right: 50,
720 |   interpolate: 'monotone',
721 |   mouseover: function(d, i) {
722 |   },
723 |   markers: markers
724 |         });
725 | 
726 |             MG.data_graphic({
727 |             animate_on_load: true,
728 |             area: false,
729 |             y_label: 'Count',
730 |             x_label: 'Time',
731 |             title: 'Concurrent users',
732 |             description: 'Concurrent users',
733 |             data: chartData,
734 |             target: '.concurrency',
735 |             x_accessor: 'timestamp',
736 |             y_accessor: ['concurrency'],
737 |             interpolate: 'monotone',
738 |             markers: markers,
739 |             width: 900
740 |             });
741 | 
742 | MG.data_graphic({
743 |   animate_on_load: true,
744 |   area: false,
745 |   y_label: 'Count',
746 |   x_label: 'Time',
747 |   title: 'Mean RPS',
748 |   description: 'Mean requests per second',
749 |   data: chartData,
750 |   target: '.rps-mean',
751 |   x_accessor: 'timestamp',
752 |   y_accessor: ['rpsMean'],
753 |   interpolate: 'monotone',
754 |   markers: markers,
755 |   width: 900
756 | });
757 | 
758 | MG.data_graphic({
759 |   animate_on_load: true,
760 |   area: false,
761 |   y_label: 'Count',
762 |   x_label: 'Time',
763 |   title: 'RPS Count',
764 |   description: 'Count of requests per second',
765 |   data: chartData,
766 |   target: '.rps-count',
767 |   x_accessor: 'timestamp',
768 |   y_accessor: ['rpsCount'],
769 |   interpolate: 'monotone',
770 |   markers: markers,
771 |   width: 900
772 | });
773 | </script>
774 | <div id="footer">
775 |   <footer>This report was created with <a href="https://artillery.io">Artillery</a> - free open-source load-testing for HTTP and WebSockets</footer>
776 | </div>
777 | </body>
778 | </html>
779 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
  1 | {
  2 |   "name": "aws-serverless-fastify",
  3 |   "description": "Proxy Library for the Fastify Web Server",
  4 |   "author": "Benjamin Main",
  5 |   "license": "MIT",
  6 |   "main": "dist/index.js",
  7 |   "types": "dist/index.d.ts",
  8 |   "keywords": [
  9 |     "fastify",
 10 |     "serverless",
 11 |     "lambda",
 12 |     "aws",
 13 |     "proxy"
 14 |   ],
 15 |   "homepage": "https://github.com/benMain/aws-serverless-fastify",
 16 |   "bugs": {
 17 |     "url": "https://github.com/benMain/aws-serverless-fastify/issues"
 18 |   },
 19 |   "files": [
 20 |     "dist"
 21 |   ],
 22 |   "repository": {
 23 |     "type": "git",
 24 |     "url": "https://github.com/benMain/aws-serverless-fastify.git"
 25 |   },
 26 |   "publishConfig": {
 27 |     "registry": "https://registry.npmjs.org/",
 28 |     "tag": "latest"
 29 |   },
 30 |   "scripts": {
 31 |     "build": "tsc -p tsconfig.build.json",
 32 |     "format": "prettier --write \"src/**/*.ts\"",
 33 |     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
 34 |     "test": "jest",
 35 |     "test:watch": "jest --watch",
 36 |     "test:cov": "jest --coverage",
 37 |     "release": "semantic-release",
 38 |     "release-local": "node -r dotenv/config node_modules/semantic-release/bin/semantic-release --no-ci --dry-run"
 39 |   },
 40 |   "dependencies": {
 41 |     "binary-case": "^1.1.4",
 42 |     "type-is": "^1.6.18"
 43 |   },
 44 |   "devDependencies": {
 45 |     "@semantic-release/changelog": "^6.0.3",
 46 |     "@semantic-release/git": "^10.0.1",
 47 |     "@types/aws-lambda": "^8.10.137",
 48 |     "@types/jest": "29.5.12",
 49 |     "@types/node": "20.12.12",
 50 |     "@types/supertest": "6.0.2",
 51 |     "@types/type-is": "1.6.6",
 52 |     "@typescript-eslint/eslint-plugin": "^6.0.0",
 53 |     "@typescript-eslint/parser": "^6.0.0",
 54 |     "eslint": "^8.42.0",
 55 |     "eslint-config-prettier": "^9.1.0",
 56 |     "eslint-plugin-prettier": "^5.1.3",
 57 |     "fastify": "4.27.0",
 58 |     "husky": "^9.0.11",
 59 |     "jest": "29.7.0",
 60 |     "lint-staged": "^15.2.2",
 61 |     "prettier": "^3.2.5",
 62 |     "semantic-release": "^23.1.1",
 63 |     "supertest": "^6.3.3",
 64 |     "ts-jest": "29.1.2",
 65 |     "ts-loader": "9.5.1",
 66 |     "ts-node": "^10.9.2",
 67 |     "tsconfig-paths": "4.2.0",
 68 |     "typescript": "5.4.5"
 69 |   },
 70 |   "peerDependencies": {
 71 |     "fastify": "^4.0"
 72 |   },
 73 |   "release": {
 74 |     "branch": "master",
 75 |     "plugins": [
 76 |       [
 77 |         "@semantic-release/commit-analyzer",
 78 |         {
 79 |           "preset": "angular",
 80 |           "releaseRules": [
 81 |             {
 82 |               "type": "docs",
 83 |               "scope": "README",
 84 |               "release": "patch"
 85 |             },
 86 |             {
 87 |               "type": "refactor",
 88 |               "release": "patch"
 89 |             },
 90 |             {
 91 |               "type": "chore",
 92 |               "release": "patch"
 93 |             },
 94 |             {
 95 |               "type": "style",
 96 |               "release": "patch"
 97 |             },
 98 |             {
 99 |               "type": "nestcompat",
100 |               "release": "major"
101 |             }
102 |           ],
103 |           "parserOpts": {
104 |             "noteKeywords": [
105 |               "BREAKING CHANGE",
106 |               "BREAKING CHANGES"
107 |             ]
108 |           }
109 |         }
110 |       ],
111 |       "@semantic-release/release-notes-generator",
112 |       [
113 |         "@semantic-release/changelog",
114 |         {
115 |           "changelogFile": "CHANGELOG.md"
116 |         }
117 |       ],
118 |       [
119 |         "@semantic-release/npm",
120 |         {
121 |           "npmPublish": true,
122 |           "tarballDir": "dist"
123 |         }
124 |       ],
125 |       [
126 |         "@semantic-release/git",
127 |         {
128 |           "assets": [
129 |             "package.json",
130 |             "package-lock.json",
131 |             "CHANGELOG.md"
132 |           ],
133 |           "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
134 |         }
135 |       ],
136 |       [
137 |         "@semantic-release/github",
138 |         {
139 |           "assets": "dist/*.tgz"
140 |         }
141 |       ]
142 |     ]
143 |   },
144 |   "husky": {
145 |     "hooks": {
146 |       "pre-commit": "lint-staged"
147 |     }
148 |   },
149 |   "lint-staged": {
150 |     "*.js": [
151 |       "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
152 |       "jest --findRelatedTests"
153 |     ],
154 |     "./**/*.{js,json,css,md}": [
155 |       "prettier --write \"src/**/*.ts\"",
156 |       "git add"
157 |     ]
158 |   },
159 |   "jest": {
160 |     "moduleFileExtensions": [
161 |       "js",
162 |       "json",
163 |       "ts"
164 |     ],
165 |     "rootDir": "src",
166 |     "testRegex": ".*\\.spec\\.ts$",
167 |     "transform": {
168 |       "^.+\\.(t|j)s$": "ts-jest"
169 |     },
170 |     "collectCoverageFrom": [
171 |       "**/*.(t|j)s"
172 |     ],
173 |     "coverageDirectory": "../coverage",
174 |     "testEnvironment": "node"
175 |   },
176 |   "version": "3.1.0"
177 | }
178 | 


--------------------------------------------------------------------------------
/src/index.spec.ts:
--------------------------------------------------------------------------------
  1 | import { fastify, FastifyInstance } from 'fastify';
  2 | import { proxy } from './index';
  3 | import { APIGatewayProxyEvent, Context } from 'aws-lambda';
  4 | import { tmpdir } from 'os';
  5 | import { join } from 'path';
  6 | import { SocketManager } from './socket-manager';
  7 | 
  8 | describe('proxy()', () => {
  9 |   let instance: FastifyInstance;
 10 |   let event: APIGatewayProxyEvent;
 11 |   let context: Context;
 12 |   beforeEach(async () => {
 13 |     instance = fastify({ logger: true });
 14 |     event = buildGetEvent();
 15 |     context = buildContext();
 16 |   });
 17 |   it('forwardRequestToNodeServer(): should forward get request with listening server', async () => {
 18 |     const exampleResponse = { hello: 'world' };
 19 |     const random = SocketManager.getSocketSuffix();
 20 |     const sockFile = join(tmpdir(), `${random}server.sock`);
 21 |     instance.get('/hello', async () => {
 22 |       return exampleResponse;
 23 |     });
 24 |     await instance.listen({ path: sockFile });
 25 |     const response = await proxy(instance, event, context);
 26 |     expect(response.statusCode).toEqual(200);
 27 |     expect(JSON.parse(response.body)).toEqual(exampleResponse);
 28 |     expect(response.isBase64Encoded).toEqual(false);
 29 |     await instance.close();
 30 |   });
 31 |   it('forwardRequestToNodeServer(): should forward get request and start not listening server', async () => {
 32 |     const exampleResponse = { hello: 'world' };
 33 |     instance.get('/hello', async () => {
 34 |       return exampleResponse;
 35 |     });
 36 |     const response = await proxy(instance, event, context);
 37 |     expect(response.statusCode).toEqual(200);
 38 |     expect(JSON.parse(response.body)).toEqual(exampleResponse);
 39 |     expect(response.isBase64Encoded).toEqual(false);
 40 |     await instance.close();
 41 |   });
 42 |   it('forwardRequestToNodeServer(): should forward post request', async () => {
 43 |     const postEvent: APIGatewayProxyEvent = buildPostEvent();
 44 |     instance.post('/post-test', async (request) => {
 45 |       return { hello: (request.body as any).name };
 46 |     });
 47 |     const response = await proxy(instance, postEvent, context);
 48 |     expect(response.statusCode).toEqual(200);
 49 |     expect(JSON.parse(response.body).hello).toEqual(
 50 |       JSON.parse(postEvent.body).name,
 51 |     );
 52 |     expect(response.isBase64Encoded).toEqual(false);
 53 |     await instance.close();
 54 |   });
 55 | 
 56 |   it('forwardRequestToNodeServer(): should respond with 404 when endpoint not found', async () => {
 57 |     const exampleResponse = { hello: 'world' };
 58 |     instance.get('/incorrect', async () => {
 59 |       return exampleResponse;
 60 |     });
 61 |     const response = await proxy(instance, event, context);
 62 |     expect(response.statusCode).toEqual(404);
 63 |     await instance.close();
 64 |   });
 65 | });
 66 | 
 67 | function buildGetEvent(): APIGatewayProxyEvent {
 68 |   return {
 69 |     body: null,
 70 |     headers: {
 71 |       'Accept-Encoding': 'gzip, deflate, sdch',
 72 |       'Accept-Language': 'en-US,en;q=0.8',
 73 |       'Cache-Control': 'max-age=0',
 74 |       'CloudFront-Forwarded-Proto': 'https',
 75 |       'CloudFront-Is-Desktop-Viewer': 'true',
 76 |       'CloudFront-Is-Mobile-Viewer': 'false',
 77 |       'CloudFront-Is-SmartTV-Viewer': 'false',
 78 |       'CloudFront-Is-Tablet-Viewer': 'false',
 79 |       'CloudFront-Viewer-Country': 'US',
 80 |       'Upgrade-Insecure-Requests': '1',
 81 |       'User-Agent': 'Custom User Agent String',
 82 |       'X-Amz-Cf-Id': 'cDehVQoZnx43VYQb9j2-nvCh-9z396Uhbp027Y2JvkCPNLmGJHqlaA==',
 83 |       'X-Forwarded-For': '127.0.0.1, 127.0.0.2',
 84 |       'X-Forwarded-Port': '443',
 85 |       'X-Forwarded-Proto': 'http',
 86 |     },
 87 |     multiValueHeaders: {},
 88 |     httpMethod: 'GET',
 89 |     isBase64Encoded: false,
 90 |     path: '/hello',
 91 |     pathParameters: null,
 92 |     queryStringParameters: null,
 93 |     multiValueQueryStringParameters: null,
 94 |     stageVariables: null,
 95 |     requestContext: null,
 96 |     resource: null,
 97 |   };
 98 | }
 99 | 
100 | function buildContext(): Context {
101 |   return {
102 |     functionName: null,
103 |     callbackWaitsForEmptyEventLoop: null,
104 |     functionVersion: null,
105 |     invokedFunctionArn: null,
106 |     awsRequestId: null,
107 |     logGroupName: null,
108 |     logStreamName: null,
109 |     memoryLimitInMB: '1024',
110 |     getRemainingTimeInMillis: () => 1000,
111 |     done: () => null,
112 |     fail: () => null,
113 |     /* tslint:disable:no-empty */
114 | 
115 |     succeed: () => {
116 |       'blah';
117 |     },
118 |   };
119 | }
120 | 
121 | function buildPostEvent(): APIGatewayProxyEvent {
122 |   return {
123 |     body: '{ "name": "Ben" }',
124 |     headers: {
125 |       'Accept-Encoding': 'gzip, deflate, sdch',
126 |       'Accept-Language': 'en-US,en;q=0.8',
127 |       'Cache-Control': 'max-age=0',
128 |       'CloudFront-Forwarded-Proto': 'https',
129 |       'CloudFront-Is-Desktop-Viewer': 'true',
130 |       'CloudFront-Is-Mobile-Viewer': 'false',
131 |       'CloudFront-Is-SmartTV-Viewer': 'false',
132 |       'CloudFront-Is-Tablet-Viewer': 'false',
133 |       'CloudFront-Viewer-Country': 'US',
134 |       'Upgrade-Insecure-Requests': '1',
135 |       'User-Agent': 'Custom User Agent String',
136 |       'X-Amz-Cf-Id': 'cDehVQoZnx43VYQb9j2-nvCh-9z396Uhbp027Y2JvkCPNLmGJHqlaA==',
137 |       'X-Forwarded-For': '127.0.0.1, 127.0.0.2',
138 |       'X-Forwarded-Port': '443',
139 |       'X-Forwarded-Proto': 'http',
140 |       'Content-Type': 'application/json',
141 |     },
142 |     multiValueHeaders: {},
143 |     httpMethod: 'POST',
144 |     isBase64Encoded: false,
145 |     path: '/post-test',
146 |     pathParameters: null,
147 |     queryStringParameters: null,
148 |     multiValueQueryStringParameters: null,
149 |     stageVariables: null,
150 |     requestContext: null,
151 |     resource: null,
152 |   };
153 | }
154 | 


--------------------------------------------------------------------------------
/src/index.ts:
--------------------------------------------------------------------------------
 1 | import { Server } from 'http';
 2 | import {
 3 |   APIGatewayProxyEvent,
 4 |   Context,
 5 |   APIGatewayProxyResult,
 6 | } from 'aws-lambda';
 7 | import { RequestForwarder } from './request-forwarder';
 8 | import { SocketManager } from './socket-manager';
 9 | import * as fastify from 'fastify';
10 | 
11 | export function proxy(
12 |   fastifyInstance: fastify.FastifyInstance,
13 |   event: APIGatewayProxyEvent,
14 |   context: Context,
15 |   binaryTypes?: string[],
16 | ): Promise<APIGatewayProxyResult> {
17 |   return new Promise<APIGatewayProxyResult>((resolve, reject) => {
18 |     const promise = {
19 |       resolve,
20 |       reject,
21 |     };
22 |     const resolver = {
23 |       succeed: (data: APIGatewayProxyResult) => {
24 |         return promise.resolve(data);
25 |       },
26 |     };
27 |     binaryTypes = binaryTypes ? binaryTypes.slice() : [];
28 |     if (fastifyInstance.server.listening) {
29 |       RequestForwarder.forwardRequestToNodeServer(
30 |         fastifyInstance.server,
31 |         event,
32 |         context,
33 |         resolver,
34 |         binaryTypes,
35 |       );
36 |     } else {
37 |       const socketSuffix = SocketManager.getSocketSuffix();
38 |       startFastify(fastifyInstance, socketSuffix).on('listening', () =>
39 |         RequestForwarder.forwardRequestToNodeServer(
40 |           fastifyInstance.server,
41 |           event,
42 |           context,
43 |           resolver,
44 |           binaryTypes,
45 |         ),
46 |       );
47 |     }
48 |   });
49 | }
50 | 
51 | function startFastify(
52 |   instance: fastify.FastifyInstance,
53 |   socketSuffix: string,
54 | ): Server {
55 |   instance.listen({ path: SocketManager.getSocketPath(socketSuffix) });
56 |   return instance.server;
57 | }
58 | 


--------------------------------------------------------------------------------
/src/request-forwarder.ts:
--------------------------------------------------------------------------------
 1 | import { request, Server, RequestOptions } from 'http';
 2 | import {
 3 |   APIGatewayProxyEvent,
 4 |   Context,
 5 |   APIGatewayProxyResult,
 6 | } from 'aws-lambda';
 7 | import { RequestMapper } from './request-mapper';
 8 | import { ResponseBuilder } from './response-builder';
 9 | 
10 | export class RequestForwarder {
11 |   public static forwardRequestToNodeServer(
12 |     server: Server,
13 |     event: APIGatewayProxyEvent,
14 |     context: Context,
15 |     resolver: { succeed: (data: APIGatewayProxyResult) => void },
16 |     binaryTypes: string[],
17 |   ): void {
18 |     try {
19 |       const requestOptions: RequestOptions =
20 |         RequestMapper.mapApiGatewayEventToHttpRequest(
21 |           event,
22 |           context,
23 |           server.address().toString(),
24 |         );
25 |       const req = request(requestOptions, (response) =>
26 |         ResponseBuilder.buildResponseToApiGateway(
27 |           response,
28 |           resolver,
29 |           binaryTypes,
30 |         ),
31 |       );
32 | 
33 |       if (event.body) {
34 |         const body = RequestMapper.getEventBody(event);
35 |         req.write(body);
36 |       }
37 | 
38 |       req
39 |         .on('error', (error) =>
40 |           ResponseBuilder.buildConnectionErrorResponseToApiGateway(
41 |             error,
42 |             resolver,
43 |           ),
44 |         )
45 |         .end();
46 |     } catch (error) {
47 |       ResponseBuilder.buildLibraryErrorResponseToApiGateway(error, resolver);
48 |     }
49 |   }
50 | }
51 | 


--------------------------------------------------------------------------------
/src/request-mapper.ts:
--------------------------------------------------------------------------------
 1 | import { APIGatewayProxyEvent, Context } from 'aws-lambda';
 2 | import { format } from 'url';
 3 | import { RequestOptions } from 'http';
 4 | 
 5 | export class RequestMapper {
 6 |   public static mapApiGatewayEventToHttpRequest(
 7 |     event: APIGatewayProxyEvent,
 8 |     context: Context,
 9 |     socketPath: string,
10 |   ): RequestOptions {
11 |     const headers: { [name: string]: any } = Object.assign({}, event.headers);
12 | 
13 |     if (event.body && !headers['Content-Length']) {
14 |       const body = RequestMapper.getEventBody(event);
15 |       headers['Content-Length'] = Buffer.byteLength(body);
16 |     }
17 | 
18 |     return {
19 |       method: event.httpMethod,
20 |       path: RequestMapper.getPathWithQueryStringParams(event),
21 |       headers,
22 |       socketPath,
23 |     };
24 |   }
25 | 
26 |   private static getPathWithQueryStringParams(
27 |     event: APIGatewayProxyEvent,
28 |   ): string {
29 |     return format({ pathname: event.path, query: event.queryStringParameters });
30 |   }
31 | 
32 |   public static getEventBody(event: APIGatewayProxyEvent): Buffer {
33 |     return Buffer.from(event.body, event.isBase64Encoded ? 'base64' : 'utf8');
34 |   }
35 | }
36 | 


--------------------------------------------------------------------------------
/src/response-builder.spec.ts:
--------------------------------------------------------------------------------
 1 | import { ResponseBuilder } from './response-builder';
 2 | import { APIGatewayProxyResult } from 'aws-lambda';
 3 | 
 4 | describe('ResponseBuilder', () => {
 5 |   it('buildConnectionErrorResponseToApiGateway(): should build valid gateway response', () => {
 6 |     const resolver: any = {
 7 |       cache: null,
 8 |       succeed(data: APIGatewayProxyResult) {
 9 |         this.cache = data;
10 |       },
11 |     };
12 |     const error = new Error('Connection error!');
13 |     ResponseBuilder.buildConnectionErrorResponseToApiGateway(error, resolver);
14 |     expect(resolver.cache.statusCode).toEqual(502);
15 |   });
16 | 
17 |   it('buildLibraryErrorResponseToApiGateway(): should build valid gateway response', () => {
18 |     const resolver: any = {
19 |       cache: null,
20 |       succeed(data: APIGatewayProxyResult) {
21 |         this.cache = data;
22 |       },
23 |     };
24 |     const error = new Error('Connection error!');
25 |     ResponseBuilder.buildLibraryErrorResponseToApiGateway(error, resolver);
26 |     expect(resolver.cache.statusCode).toEqual(500);
27 |   });
28 | });
29 | 


--------------------------------------------------------------------------------
/src/response-builder.ts:
--------------------------------------------------------------------------------
  1 | import { IncomingMessage } from 'http';
  2 | import { APIGatewayProxyResult } from 'aws-lambda';
  3 | import { is } from 'type-is';
  4 | import * as binarycase from 'binary-case';
  5 | 
  6 | export class ResponseBuilder {
  7 |   public static buildResponseToApiGateway(
  8 |     response: IncomingMessage,
  9 |     resolver: { succeed: (data: APIGatewayProxyResult) => void },
 10 |     binaryTypes: string[],
 11 |   ) {
 12 |     const buf = [];
 13 | 
 14 |     response
 15 |       .on('data', (chunk: any) => buf.push(chunk))
 16 |       .on('end', () => {
 17 |         const bodyBuffer = Buffer.concat(buf);
 18 |         const statusCode = response.statusCode;
 19 |         const headers = response.headers as {
 20 |           [header: string]: string | number | boolean;
 21 |         };
 22 | 
 23 |         if (headers['transfer-encoding'] === 'chunked') {
 24 |           delete headers['transfer-encoding'];
 25 |         }
 26 | 
 27 |         // HACK: modifies header casing to get around API Gateway's limitation of not allowing multiple
 28 |         // headers with the same name, as discussed on the AWS Forum https://forums.aws.amazon.com/message.jspa?messageID=725953#725953
 29 |         Object.keys(headers).forEach((h) => {
 30 |           if (Array.isArray(h)) {
 31 |             if (h.toLowerCase() === 'set-cookie') {
 32 |               h.forEach((value: any, i: number) => {
 33 |                 headers[binarycase(h, i + 1)] = value;
 34 |               });
 35 |               delete headers[h];
 36 |             } else {
 37 |               headers[h] = h.join(',');
 38 |             }
 39 |           }
 40 |         });
 41 | 
 42 |         const contentType = ResponseBuilder.getContentType({
 43 |           contentTypeHeader: headers['content-type'],
 44 |         });
 45 |         let isBase64Encoded = ResponseBuilder.isContentTypeBinaryMimeType({
 46 |           contentType,
 47 |           binaryMimeTypes: binaryTypes,
 48 |         });
 49 |         if (!isBase64Encoded) {
 50 |           isBase64Encoded = headers['content-encoding'] === 'gzip';
 51 |         }
 52 |         const body = bodyBuffer.toString(isBase64Encoded ? 'base64' : 'utf8');
 53 |         const successResponse: APIGatewayProxyResult = {
 54 |           statusCode,
 55 |           body,
 56 |           headers,
 57 |           isBase64Encoded,
 58 |         };
 59 | 
 60 |         resolver.succeed(successResponse);
 61 |       });
 62 |   }
 63 | 
 64 |   public static buildConnectionErrorResponseToApiGateway(
 65 |     error: Error,
 66 |     resolver: { succeed: (data: APIGatewayProxyResult) => void },
 67 |   ) {
 68 |     // tslint:disable-next-line: no-console
 69 |     console.log('ERROR: aws-serverless-fastify connection error');
 70 |     // tslint:disable-next-line: no-console
 71 |     console.error(error);
 72 |     const errorResponse: APIGatewayProxyResult = {
 73 |       statusCode: 502,
 74 |       body: '',
 75 |       headers: {},
 76 |     };
 77 |     resolver.succeed(errorResponse);
 78 |   }
 79 | 
 80 |   public static buildLibraryErrorResponseToApiGateway(
 81 |     error: Error,
 82 |     resolver: { succeed: (data: APIGatewayProxyResult) => void },
 83 |   ) {
 84 |     // tslint:disable-next-line: no-console
 85 |     console.log('ERROR: aws-serverless-fastify error');
 86 |     // tslint:disable-next-line: no-console
 87 |     console.error(error);
 88 |     const errorResponse: APIGatewayProxyResult = {
 89 |       statusCode: 500,
 90 |       body: '',
 91 |       headers: {},
 92 |     };
 93 |     resolver.succeed(errorResponse);
 94 |   }
 95 | 
 96 |   private static getContentType(params: { contentTypeHeader: any }) {
 97 |     return params.contentTypeHeader
 98 |       ? params.contentTypeHeader.split(';')[0]
 99 |       : '';
100 |   }
101 | 
102 |   private static isContentTypeBinaryMimeType(params: {
103 |     contentType: any;
104 |     binaryMimeTypes: any;
105 |   }) {
106 |     return (
107 |       params.binaryMimeTypes.length > 0 &&
108 |       !!is(params.contentType, params.binaryMimeTypes)
109 |     );
110 |   }
111 | }
112 | 


--------------------------------------------------------------------------------
/src/socket-manager.ts:
--------------------------------------------------------------------------------
 1 | export class SocketManager {
 2 |   public static getSocketPath(socketPathSuffix: string): string {
 3 |     if (/^win/.test(process.platform)) {
 4 |       // eslint-disable-next-line @typescript-eslint/no-var-requires
 5 |       const path = require('path');
 6 |       return path.join(
 7 |         '\\\\?\\pipe',
 8 |         process.cwd(),
 9 |         `server-${socketPathSuffix}`,
10 |       );
11 |     } else {
12 |       return `/tmp/server-${socketPathSuffix}.sock`;
13 |     }
14 |   }
15 | 
16 |   public static getSocketSuffix(): string {
17 |     return Math.random().toString(36).substring(2, 15);
18 |   }
19 | }
20 | 


--------------------------------------------------------------------------------
/tsconfig.build.json:
--------------------------------------------------------------------------------
1 | {
2 |   "extends": "./tsconfig.json",
3 |   "exclude": ["node_modules", "dist", "**/*spec.ts"]
4 | }
5 | 


--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "module": "commonjs",
 4 |     "declaration": true,
 5 |     "removeComments": true,
 6 |     "emitDecoratorMetadata": true,
 7 |     "experimentalDecorators": true,
 8 |     "allowSyntheticDefaultImports": true,
 9 |     "target": "es2017",
10 |     "sourceMap": true,
11 |     "outDir": "./dist",
12 |     "baseUrl": "./",
13 |     "incremental": true,
14 |     "skipLibCheck": true
15 |   },
16 |   "exclude": ["node_modules"]
17 | }
18 | 


--------------------------------------------------------------------------------
/tslint.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "defaultSeverity": "error",
 3 |   "extends": ["tslint:recommended"],
 4 |   "jsRules": {
 5 |     "no-unused-expression": true
 6 |   },
 7 |   "rules": {
 8 |     "quotemark": [true, "single"],
 9 |     "member-access": [false],
10 |     "ordered-imports": [false],
11 |     "max-line-length": [true, 150],
12 |     "member-ordering": [false],
13 |     "interface-name": [false],
14 |     "arrow-parens": false,
15 |     "object-literal-sort-keys": false
16 |   },
17 |   "rulesDirectory": []
18 | }
19 | 


--------------------------------------------------------------------------------