open-source aws-lambda-fastify

Author: adrai

.editorconfig

@@ -0,0 +1,10 @@
+# EditorConfig is awesome: http://EditorConfig.org
+root = true
+
+[*.{js,jsx,json}]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true

.eslintignore

@@ -0,0 +1 @@
+/node_modules

.eslintrc

@@ -0,0 +1,14 @@
+{
+  "extends": "standard",
+  "globals": {
+    "describe": false,
+    "it": false,
+    "before": false,
+    "after": false,
+    "beforeEach": false,
+    "afterEach": false
+  },
+  "rules": {
+    "array-bracket-spacing": 0
+  }
+}

.gitignore

@@ -0,0 +1,4 @@
+node_modules
+.DS_Store
+npm-debug.log
+package-lock.json

.npmignore

@@ -0,0 +1,10 @@
+.DS_Store
+setup
+test
+.eslintrc
+.gitignore
+.npmignore
+.editorconfig
+.vscode
+README.md
+.eslintignore

README.md

@@ -0,0 +1,80 @@
+# Introduction
+
+[![travis](https://img.shields.io/travis/adrai/aws-lambda-fastify.svg)](https://travis-ci.org/adrai/aws-lambda-fastify) [![npm](https://img.shields.io/npm/v/aws-lambda-fastify.svg)](https://npmjs.org/package/aws-lambda-fastify)
+
+Inspired by the AWSLABS [aws-serverless-express](https://github.com/awslabs/aws-serverless-express) library tailor made for the [Fastify](https://www.fastify.io/) web framework.
+
+No use of internal sockets, makes use of Fastify's [inject](https://www.fastify.io/docs/latest/Testing/#testing-with-http-injection) function.
+
+## Installation
+
+```bash
+$ npm install aws-lambda-fastify
+```
+
+## Example
+
+### app.js
+
+```js
+const fastify = require('fastify');
+
+const app = fastify();
+app.get('/', (request, reply) => reply.send({ hello: 'world' }));
+
+if (require.main !== module) {
+  // called directly i.e. "node app"
+  app.listen(3000, (err) => {
+    if (err) console.error(err);
+    console.log('server listening on 3000');
+  });
+} else {
+  // required as a module => executed on aws lambda
+  module.exports = app;
+}
+```
+
+When executed in your lambda function we don't need to listen to a specific port,
+so we just export the `app` in this case.
+The [`lambda.js`](https://github.com/adrai/aws-lambda-fastify/blob/master/README.md#lambda.js) file will use this export.
+
+When you execute your Fastify application like always,
+i.e. `node app.js` *(the detection for this could be `require.main === module`)*,
+you can normally listen to your port, so you can still run your Fastify function locally.
+
+### lambda.js
+
+```js
+const awsLambdaFastify = require('aws-lambda-fastify')
+const app = require('./app');
+
+const proxy = awsLambdaFastify(app)
+// or
+// const proxy = awsLambdaFastify(app, { binaryMimeTypes: ['application/octet-stream'] })
+
+exports.handler = proxy;
+// or
+// exports.handler = (event, context, callback) => proxy(event, context, callback);
+// or
+// exports.handler = (event, context) => proxy(event, context);
+// or
+// exports.handler = async (event, context) => proxy(event, context);
+```
+
+### Hint
+
+The original lambda event and context are passed via headers and can be used like this:
+
+```js
+app.get('/', (request, reply) => {
+  const event = JSON.parse(decodeURIComponent(request.headers['x-apigateway-event']))
+  const context = JSON.parse(decodeURIComponent(request.headers['x-apigateway-context']))});
+  // ...
+})
+```
+
+#### Considerations
+
+ - For apps that may not see traffic for several minutes at a time, you could see [cold starts](https://aws.amazon.com/blogs/compute/container-reuse-in-lambda/)
+ - Stateless only
+ - API Gateway has a timeout of 29 seconds, and Lambda has a maximum execution time of 15 minutes.

index.js

@@ -0,0 +1,56 @@
+module.exports = (app, options) => (event, context, callback) => {
+  options = options || {}
+  options.binaryMimeTypes = options.binaryMimeTypes || []
+  event.body = event.body || ''
+
+  const method = event.httpMethod
+  const url = event.path
+  const query = event.queryStringParameters
+  const headers = Object.assign({}, event.headers)
+  const payload = Buffer.from(event.body, event.isBase64Encoded ? 'base64' : 'utf8')
+  // NOTE: API Gateway is not setting Content-Length header on requests even when they have a body
+  if (event.body && !headers['Content-Length'] && !headers['content-length']) headers['content-length'] = Buffer.byteLength(payload)
+
+  delete event.body
+  headers['x-apigateway-event'] = encodeURIComponent(JSON.stringify(event))
+  if (context) headers['x-apigateway-context'] = encodeURIComponent(JSON.stringify(context))
+
+  const prom = new Promise((resolve, reject) => {
+    app.inject({ method, url, query, payload, headers }, (err, res) => {
+      if (err) {
+        console.error(err)
+        return resolve({
+          statusCode: 500,
+          body: '',
+          headers: {}
+        })
+      }
+      // chunked transfer not currently supported by API Gateway
+      if (headers['transfer-encoding'] === 'chunked') delete headers['transfer-encoding']
+      if (headers['Transfer-Encoding'] === 'chunked') delete headers['Transfer-Encoding']
+
+      // HACK: modifies header casing to get around API Gateway's limitation of not allowing multiple
+      // headers with the same name, as discussed on the AWS Forum https://forums.aws.amazon.com/message.jspa?messageID=725953#725953
+      Object.keys(res.headers).forEach((h) => {
+        if (Array.isArray(res.headers[h])) {
+          if (h.toLowerCase() === 'set-cookie') {
+            res.headers[h].forEach((value, i) => { res.headers[require('binary-case')(h, i + 1)] = value })
+            delete res.headers[h]
+          } else res.headers[h] = res.headers[h].join(',')
+        }
+      })
+
+      const contentType = (res.headers['content-type'] || res.headers['Content-Type'] || '').split(';')[0]
+      const isBase64Encoded = options.binaryMimeTypes.indexOf(contentType) > -1
+
+      resolve({
+        statusCode: res.statusCode,
+        body: isBase64Encoded ? res.rawPayload.toString('base64') : res.payload,
+        headers: res.headers,
+        isBase64Encoded
+      })
+    })
+  })
+  if (!callback) return prom
+  prom.then((ret) => callback(null, ret)).catch(callback)
+}

package.json

@@ -0,0 +1,23 @@
+{
+  "name": "aws-lambda-fastify",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "lint": "eslint .",
+    "test": "npm run lint && mocha --colors --reporter spec --recursive test"
+  },
+  "dependencies": {
+    "binary-case": "1.1.4"
+  },
+  "devDependencies": {
+    "eslint": "6.0.1",
+    "eslint-config-standard": "13.0.1",
+    "eslint-plugin-import": "2.18.0",
+    "eslint-plugin-node": "9.1.0",
+    "eslint-plugin-promise": "4.2.1",
+    "eslint-plugin-standard": "4.0.0",
+    "fastify": "2.6.0",
+    "mocha": "6.1.4",
+    "should": "13.2.3"
+  }
+}

test/basic.js

@@ -0,0 +1,159 @@
+const should = require('should')
+const fastify = require('fastify')
+const fs = require('fs')
+const awsLambdaFastify = require('../index')
+
+describe('basic', () => {
+  describe('GET', () => {
+    it('should work as expected', async () => {
+      const app = fastify()
+      app.get('/test', async (request, reply) => {
+        should(request.headers).have.property('x-my-header', 'wuuusaaa')
+        should(request.headers).have.property('x-apigateway-event', '%7B%22httpMethod%22%3A%22GET%22%2C%22path%22%3A%22%2Ftest%22%2C%22headers%22%3A%7B%22X-My-Header%22%3A%22wuuusaaa%22%7D%7D')
+        should(request.headers).have.property('user-agent', 'lightMyRequest')
+        should(request.headers).have.property('host', 'localhost:80')
+        should(request.headers).have.property('content-length', '0')
+        reply.header('Set-Cookie', 'qwerty=one')
+        reply.header('Set-Cookie', 'qwerty=two')
+        reply.send({ hello: 'world' })
+      })
+      const proxy = awsLambdaFastify(app)
+      const ret = await proxy({
+        httpMethod: 'GET',
+        path: '/test',
+        headers: {
+          'X-My-Header': 'wuuusaaa'
+        }
+      })
+      should(ret).have.property('statusCode', 200)
+      should(ret).have.property('body', '{"hello":"world"}')
+      should(ret).have.property('isBase64Encoded', false)
+      should(ret).have.property('headers')
+      should(ret.headers).have.property('content-type', 'application/json; charset=utf-8')
+      should(ret.headers).have.property('content-length', '17')
+      should(ret.headers).have.property('date')
+      should(ret.headers).have.property('connection', 'keep-alive')
+      should(ret.headers).have.property('Set-cookie', 'qwerty=one')
+      should(ret.headers).have.property('sEt-cookie', 'qwerty=two')
+    })
+  })
+
+  describe('GET with base64 encoding response', () => {
+    let fileBuffer
+    before((done) => {
+      fs.readFile(__filename, (err, fb) => {
+        fileBuffer = fb
+        done(err)
+      })
+    })
+    it('should work as expected', async () => {
+      const app = fastify()
+      app.get('/test', async (request, reply) => {
+        should(request.headers).have.property('x-my-header', 'wuuusaaa')
+        should(request.headers).have.property('x-apigateway-event', '%7B%22httpMethod%22%3A%22GET%22%2C%22path%22%3A%22%2Ftest%22%2C%22headers%22%3A%7B%22X-My-Header%22%3A%22wuuusaaa%22%2C%22Content-Type%22%3A%22application%2Fjson%22%7D%7D')
+        should(request.headers).have.property('user-agent', 'lightMyRequest')
+        should(request.headers).have.property('host', 'localhost:80')
+        should(request.headers).have.property('content-length', '0')
+        reply.header('Set-Cookie', 'qwerty=one')
+        reply.header('Set-Cookie', 'qwerty=two')
+        reply.send(fileBuffer)
+      })
+      const proxy = awsLambdaFastify(app, { binaryMimeTypes: ['application/octet-stream'] })
+      const ret = await proxy({
+        httpMethod: 'GET',
+        path: '/test',
+        headers: {
+          'X-My-Header': 'wuuusaaa',
+          'Content-Type': 'application/json'
+        }
+      })
+      should(ret).have.property('statusCode', 200)
+      should(ret).have.property('body', fileBuffer.toString('base64'))
+      should(ret).have.property('isBase64Encoded', true)
+      should(ret).have.property('headers')
+      should(ret.headers).have.property('content-type', 'application/octet-stream')
+      should(ret.headers).have.property('content-length')
+      should(ret.headers).have.property('date')
+      should(ret.headers).have.property('connection', 'keep-alive')
+      should(ret.headers).have.property('Set-cookie', 'qwerty=one')
+      should(ret.headers).have.property('sEt-cookie', 'qwerty=two')
+    })
+  })
+
+  describe('POST', () => {
+    it('should work as expected', async () => {
+      const app = fastify()
+      app.post('/test', async (request, reply) => {
+        should(request.headers).have.property('content-type', 'application/json')
+        should(request.headers).have.property('x-my-header', 'wuuusaaa')
+        should(request.headers).have.property('x-apigateway-event', '%7B%22httpMethod%22%3A%22POST%22%2C%22path%22%3A%22%2Ftest%22%2C%22headers%22%3A%7B%22X-My-Header%22%3A%22wuuusaaa%22%2C%22Content-Type%22%3A%22application%2Fjson%22%7D%7D')
+        should(request.headers).have.property('user-agent', 'lightMyRequest')
+        should(request.headers).have.property('host', 'localhost:80')
+        should(request.headers).have.property('content-length', 14)
+        should(request.body).have.property('greet', 'hi')
+        reply.header('Set-Cookie', 'qwerty=one')
+        reply.header('Set-Cookie', 'qwerty=two')
+        reply.send({ hello: 'world2' })
+      })
+      const proxy = awsLambdaFastify(app)
+      const ret = await proxy({
+        httpMethod: 'POST',
+        path: '/test',
+        headers: {
+          'X-My-Header': 'wuuusaaa',
+          'Content-Type': 'application/json'
+        },
+        body: '{"greet":"hi"}'
+      })
+      should(ret).have.property('statusCode', 200)
+      should(ret).have.property('body', '{"hello":"world2"}')
+      should(ret).have.property('isBase64Encoded', false)
+      should(ret).have.property('headers')
+      should(ret.headers).have.property('content-type', 'application/json; charset=utf-8')
+      should(ret.headers).have.property('content-length', '18')
+      should(ret.headers).have.property('date')
+      should(ret.headers).have.property('connection', 'keep-alive')
+      should(ret.headers).have.property('Set-cookie', 'qwerty=one')
+      should(ret.headers).have.property('sEt-cookie', 'qwerty=two')
+    })
+  })
+
+  describe('POST with base64 encoding', () => {
+    it('should work as expected', async () => {
+      const app = fastify()
+      app.post('/test', async (request, reply) => {
+        should(request.headers).have.property('content-type', 'application/json')
+        should(request.headers).have.property('x-my-header', 'wuuusaaa')
+        should(request.headers).have.property('x-apigateway-event', '%7B%22httpMethod%22%3A%22POST%22%2C%22path%22%3A%22%2Ftest%22%2C%22headers%22%3A%7B%22X-My-Header%22%3A%22wuuusaaa%22%2C%22Content-Type%22%3A%22application%2Fjson%22%7D%2C%22isBase64Encoded%22%3Atrue%7D')
+        should(request.headers).have.property('user-agent', 'lightMyRequest')
+        should(request.headers).have.property('host', 'localhost:80')
+        should(request.headers).have.property('content-length', 15)
+        should(request.body).have.property('greet', 'hi')
+        reply.header('Set-Cookie', 'qwerty=one')
+        reply.header('Set-Cookie', 'qwerty=two')
+        reply.send({ hello: 'world2' })
+      })
+      const proxy = awsLambdaFastify(app)
+      const ret = await proxy({
+        httpMethod: 'POST',
+        path: '/test',
+        headers: {
+          'X-My-Header': 'wuuusaaa',
+          'Content-Type': 'application/json'
+        },
+        body: 'eyJncmVldCI6ICJoaSJ9',
+        isBase64Encoded: true
+      })
+      should(ret).have.property('statusCode', 200)
+      should(ret).have.property('body', '{"hello":"world2"}')
+      should(ret).have.property('isBase64Encoded', false)
+      should(ret).have.property('headers')
+      should(ret.headers).have.property('content-type', 'application/json; charset=utf-8')
+      should(ret.headers).have.property('content-length', '18')
+      should(ret.headers).have.property('date')
+      should(ret.headers).have.property('connection', 'keep-alive')
+      should(ret.headers).have.property('Set-cookie', 'qwerty=one')
+      should(ret.headers).have.property('sEt-cookie', 'qwerty=two')
+    })
+  })
+})