@middy/warmup

Middy warmup middleware

Warmup middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda

You can read the documentation at: https://middy.js.org/docs/middlewares/warmup

Warmup middleware that helps to reduce the cold-start issue. Compatible by default with serverless-plugin-warmup, but it can be configured to suit your implementation.

This middleware allows you to specify a schedule to keep Lambdas that always need to be very responsive warmed-up. It does this by regularly invoking the Lambda, but will terminate early to avoid the actual handler logic from being run.

If you use serverless-plugin-warmup the scheduling part is done by the plugin and you just have to attach the middleware to your "middyfied" handler. If you don't want to use the plugin you have to create the schedule yourself and define the isWarmingUp function to define whether the current event is a warmup event or an actual business logic execution.

Important: AWS recently announced Lambda Provisioned Concurrency. If you have this enabled, you do not need this middleware.

To update your code to use Provisioned Concurrency see:

• AWS Console
• Serverless
• Terraform

Install

To install this middleware you can use NPM:

npm install --save @middy/warmup

Options

• isWarmingUp: (function) a function that accepts the event object as a parameter and returns true if the current event is a warmup event and false if it's a regular execution. The default function will check if the event object has a source property set to serverless-plugin-warmup.

Sample usage

import middy from '@middy/core'
import warmup from '@middy/warmup'

const isWarmingUp = (event) => event.isWarmingUp === true

const originalHandler = (event, context, cb) => {
  /* ... */
}

const handler = middy(originalHandler)
  .use(warmup({ isWarmingUp }))

Middy documentation and examples

For more documentation and examples, refers to the main Middy monorepo on GitHub or Middy official website.

Contributing

Everyone is very welcome to contribute to this repository. Feel free to raise issues or to submit Pull Requests.

License

Licensed under MIT License. Copyright (c) 2017-2022 Luciano Mammino, will Farrell, and the Middy team.