Aws Lambda Fastify

Insipired by aws-serverless-express to work with Fastify with inject functionality.
Alternatives To Aws Lambda Fastify
Project NameStarsDownloadsRepos Using ThisPackages Using ThisMost Recent CommitTotal ReleasesLatest ReleaseOpen IssuesLicenseLanguage
Examples10,886
9 days ago19April 25, 2021170otherJavaScript
Serverless Examples – A collection of boilerplates and examples of serverless architectures built with the Serverless Framework on AWS Lambda, Microsoft Azure, Google Cloud Functions, and more.
Caprover10,459
a month ago100otherTypeScript
Scalable PaaS (automated Docker+nginx) - aka Heroku on Steroids
Up8,68768133 months ago11March 02, 2018291mitGo
Deploy infinitely scalable serverless apps, apis, and sites in seconds to AWS.
Midway6,6683147a day ago204August 16, 2022134mitTypeScript
🍔 A Node.js Serverless Framework for front-end/full-stack developers. Build the application for next decade. Works on AWS, Alibaba Cloud, Tencent Cloud and traditional VM/Container. Super easy integrate with React and Vue. 🌈
Webiny Js6,592113a day ago251September 07, 2022254otherTypeScript
Open-source serverless enterprise CMS. Includes a headless CMS, page builder, form builder, and file manager. Easy to customize and expand. Deploys to AWS.
Dev Setup5,802
9 months ago34otherPython
macOS development environment setup: Easy-to-understand instructions with automated setup scripts for developer tools like Vim, Sublime Text, Bash, iTerm, Python data analysis, Spark, Hadoop MapReduce, AWS, Heroku, JavaScript web development, Android development, common data stores, and dev-based OS X defaults.
Serverless Express4,83566015920 days ago33December 06, 202076apache-2.0JavaScript
Run Node.js web applications and APIs using existing application frameworks on AWS #serverless technologies such as Lambda, API Gateway, [email protected], and ALB.
Grant3,771210416 months ago98March 09, 202223mitJavaScript
OAuth Proxy
Practicalnode3,765
4 months ago6JavaScript
Practical Node.js, 1st and 2nd Editions [Apress] 📓
Claudia3,70919329a year ago122March 17, 202214mitJavaScript
Deploy Node.js projects to AWS Lambda and API Gateway easily
Alternatives To Aws Lambda Fastify
Select To Compare


Alternative Project Comparisons
Readme

Introduction

CI NPM version js-standard-style

Inspired by the AWSLABS aws-serverless-express library tailor made for the Fastify web framework.

No use of internal sockets, makes use of Fastify's inject function.

Seems faster (as the name implies) than aws-serverless-express and aws-serverless-fastify 😉

👨🏻‍💻Installation

$ npm i @fastify/aws-lambda

Options

@fastify/aws-lambda can take options by passing them with : awsLambdaFastify(app, options)

property description default value
binaryMimeTypes Array of binary MimeTypes to handle []
enforceBase64 Function that receives the response and returns a boolean indicating if the response content is binary or not and should be base64-encoded undefined
serializeLambdaArguments Activate the serialization of lambda Event and Context in http header x-apigateway-event x-apigateway-context false (was true for <v2.0.0)
decorateRequest Decorates the fastify request with the lambda Event and Context request.awsLambda.event request.awsLambda.context true
decorationPropertyName The default property name for request decoration awsLambda
callbackWaitsForEmptyEventLoop See: Official Documentation undefined

📖Example

lambda.js

const awsLambdaFastify = require('@fastify/aws-lambda')
const app = require('./app')

const proxy = awsLambdaFastify(app)
// or
// const proxy = awsLambdaFastify(app, { binaryMimeTypes: ['application/octet-stream'], serializeLambdaArguments: false /* default is true */ })

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)

app.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({ port: 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 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.

📣Hint

Lambda arguments

The original lambda event and context are passed via Fastify request and can be used like this:

app.get('/', (request, reply) => {
  const event = request.awsLambda.event
  const context = request.awsLambda.context
  // ...
})

If you do not like it, you can disable this by setting the decorateRequest option to false.

Alternatively the original lambda event and context are passed via headers and can be used like this, if setting the serializeLambdaArguments option to true:

app.get('/', (request, reply) => {
  const event = JSON.parse(decodeURIComponent(request.headers['x-apigateway-event']))
  const context = JSON.parse(decodeURIComponent(request.headers['x-apigateway-context']))
  // ...
})

Lower cold start latency

Since AWS Lambda now enables the use of ECMAScript (ES) modules in Node.js 14 runtimes, you could lower the cold start latency when used with Provisioned Concurrency thanks to the top-level await functionality.

We can use this by calling the fastify.ready() function outside of the Lambda handler function, like this:

import awsLambdaFastify from '@fastify/aws-lambda'
import app from './app.js'
export const handler = awsLambdaFastify(app)
await app.ready() // needs to be placed after awsLambdaFastify call because of the decoration: https://github.com/fastify/aws-lambda-fastify/blob/master/index.js#L9

Here you can find the approriate issue discussing this feature.

⚡️Some basic performance metrics

@fastify/aws-lambda (decorateRequest : false) x 56,892 ops/sec ±3.73% (79 runs sampled)

@fastify/aws-lambda x 56,571 ops/sec ±3.52% (82 runs sampled)

@fastify/aws-lambda (serializeLambdaArguments : true) x 56,499 ops/sec ±3.56% (76 runs sampled)

serverless-http x 45,867 ops/sec ±4.42% (83 runs sampled)

aws-serverless-fastify x 17,937 ops/sec ±1.83% (86 runs sampled)

aws-serverless-express x 16,647 ops/sec ±2.88% (87 runs sampled)

Fastest is @fastify/aws-lambda (decorateRequest : false), @fastify/aws-lambda

⚠️Considerations

  • For apps that may not see traffic for several minutes at a time, you could see cold starts
  • Stateless only
  • API Gateway has a timeout of 29 seconds, and Lambda has a maximum execution time of 15 minutes. (Using Application Load Balancer has no timeout limit, so the lambda maximum execution time is relevant)
  • If you are using another web framework beside Fastify (i.e. Connect, Express, Koa, Restana, Sails, Hapi, Restify) or want to use a more generic serverless proxy framework, have a look at: serverless-http

🎖Who is using it?

locize is using @fastify/aws-lambda
localistars is using @fastify/aws-lambda

The logos displayed in this page are property of the respective organisations and they are not distributed under the same license as @fastify/aws-lambda (MIT).

Popular Nodejs Projects
Popular Amazon Web Services Projects
Popular Runtime Environments Categories
Related Searches

Get A Weekly Email With Trending Projects For These Categories
No Spam. Unsubscribe easily at any time.
Javascript
Node
Aws
Express
Cloud
Proxy
Lambda
Amazon
Serverless
Api Gateway