@middy/warmup 1.5.2 → 2.5.3

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2021 Luciano Mammino and the [Middy team](https://github.com/middyjs/middy/graphs/contributors)
+Copyright (c) 2017-2021 Luciano Mammino, will Farrell and the [Middy team](https://github.com/middyjs/middy/graphs/contributors)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -54,9 +54,6 @@ npm install --save @middy/warmup
 
  - `isWarmingUp`: 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`.
- - `onWarmup`: a function that gets executed before the handler exits in case of warmup. By default the function just prints: `Exiting early via warmup Middleware`.
- - `waitForEmptyEventLoop`: a boolean value (`null` by default), that if set will change the current value for `context.callbackWaitsForEmptyEventLoop`. In some circumstances it might be useful to force this value to be `false` to make sure that the lambda quits as early as possible in case of warmup (for instance if you have created a database connection in a previous middleware, this might be hanging and keeping you lambda active until timeout).
-
 
 ## Sample usage
 
@@ -65,17 +62,13 @@ const middy = require('@middy/core')
 const warmup = require('@middy/warmup')
 
 const isWarmingUp = (event) => event.isWarmingUp === true
-const onWarmup = (event) => console.log('I am just warming up', event)
 
 const originalHandler = (event, context, cb) => {
   /* ... */
 }
 
 const handler = middy(originalHandler)
-  .use(warmup({
-    isWarmingUp,
-    onWarmup
-  }))
+  .use(warmup({ isWarmingUp }))
 ```
 
 
@@ -91,7 +84,7 @@ Everyone is very welcome to contribute to this repository. Feel free to [raise i
 
 ## License
 
-Licensed under [MIT License](LICENSE). Copyright (c) 2017-2018 Luciano Mammino and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
+Licensed under [MIT License](LICENSE). Copyright (c) 2017-2021 Luciano Mammino, will Farrell, and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
 
 <a href="https://app.fossa.io/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy?ref=badge_large">
   <img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy.svg?type=large" alt="FOSSA Status"  style="max-width:100%;">

package/index.d.ts

@@ -1,11 +1,10 @@
 import middy from '@middy/core'
 
-interface IWarmupOptions {
-  isWarmingUp?: (event: any) => boolean;
-  onWarmup?: (event: any) => void;
-  waitForEmptyEventLoop?: boolean;
+interface Options {
+  isWarmingUp?: (event: any) => boolean
+  onWarmup?: (event: any) => void
 }
 
-declare const warmup : middy.Middleware<IWarmupOptions, any, any>
+declare function warmup (options?: Options): middy.MiddlewareObj
 
 export default warmup

package/index.js

@@ -1,23 +1,23 @@
-module.exports = (config) => {
-  const defaults = {
-    isWarmingUp: (event) => event.source === 'serverless-plugin-warmup',
-    onWarmup: (event) => console.log('Exiting early via warmup Middleware'),
-    waitForEmptyEventLoop: null
-  }
+"use strict";
 
-  const options = Object.assign({}, defaults, config)
+const defaults = {
+  isWarmingUp: event => (event === null || event === void 0 ? void 0 : event.source) === 'serverless-plugin-warmup'
+};
 
-  return ({
-    before: (handler, next) => {
-      if (options.isWarmingUp(handler.event)) {
-        options.onWarmup(handler.event)
-        if (options.waitForEmptyEventLoop !== null) {
-          handler.context.callbackWaitsForEmptyEventLoop = Boolean(options.waitForEmptyEventLoop)
-        }
-        return handler.callback(null, 'warmup')
-      }
+const warmupMiddleware = opt => {
+  const options = { ...defaults,
+    ...opt
+  };
 
-      next()
+  const warmupMiddlewareBefore = request => {
+    if (options.isWarmingUp(request.event)) {
+      return 'warmup';
     }
-  })
-}
+  };
+
+  return {
+    before: warmupMiddlewareBefore
+  };
+};
+
+module.exports = warmupMiddleware;

package/package.json

@@ -1,18 +1,23 @@
 {
   "name": "@middy/warmup",
-  "version": "1.5.2",
+  "version": "2.5.3",
   "description": "Warmup (cold start mitigation) middleware for the middy framework",
+  "type": "commonjs",
   "engines": {
-    "node": ">=10"
+    "node": ">=12"
   },
   "engineStrict": true,
   "publishConfig": {
     "access": "public"
   },
+  "main": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "index.d.ts"
+  ],
   "scripts": {
-    "test": "npm run test:typings && npm run test:unit",
-    "test:unit": "jest",
-    "test:typings": "typings-tester --config tsconfig.json index.d.ts"
+    "test": "npm run test:unit",
+    "test:unit": "ava"
   },
   "license": "MIT",
   "keywords": [
@@ -33,18 +38,15 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/middyjs/middy.git"
+    "url": "github:middyjs/middy",
+    "directory": "packages/warmup"
   },
   "bugs": {
     "url": "https://github.com/middyjs/middy/issues"
   },
   "homepage": "https://github.com/middyjs/middy#readme",
-  "peerDependencies": {
-    "@middy/core": ">=1.0.0-alpha"
-  },
   "devDependencies": {
-    "@middy/core": "^1.5.2",
-    "es6-promisify": "^6.0.2"
+    "@middy/core": "^2.5.3"
   },
-  "gitHead": "f77cb5e1fc2c529f4fe74efa8a9fb105373b0723"
+  "gitHead": "690884d43b9cd632aeca9a5eba1612160b987cd4"
 }

package/.babelrc

@@ -1,9 +0,0 @@
-{
-  "presets": [
-    ["env", {
-      "targets": {
-        "node": "6.10"
-      }
-    }]
-  ]
-}

package/__tests__/index.js

@@ -1,138 +0,0 @@
-const { invoke } = require('../../test-helpers')
-const middy = require('../../core')
-const lambdaIsWarmingUp = require('../')
-
-console.log = jest.fn()
-
-beforeEach(() => {
-  console.log.mockClear()
-})
-
-describe('🥃 Warmup', () => {
-  test('Should exit with \'warmup\' if provided warmup check function is provide and returns true', async () => {
-    const handler = middy((event, context, cb) => {
-      cb()
-    })
-    handler.use(lambdaIsWarmingUp({
-      isWarmingUp: (event) => true,
-      onWarmup: () => {}
-    }))
-
-    const event = {}
-    const context = {}
-
-    const response = await invoke(handler, event, context)
-
-    expect(response).toBe('warmup')
-  })
-
-  test('Should exit with \'warmup\' if event.source === \'serverless-plugin-warmup\' if no warmup check function provided', async () => {
-    const handler = middy((event, context, cb) => {
-      cb()
-    })
-    handler.use(lambdaIsWarmingUp({
-      onWarmup: () => {}
-    }))
-
-    const event = {
-      source: 'serverless-plugin-warmup'
-    }
-    const context = {}
-
-    const response = await invoke(handler, event, context)
-
-    expect(response).toBe('warmup')
-  })
-
-  test('It should print in the console when exiting because of warmup and the onWarmup function is not redefined', async () => {
-    const logSpy = jest.spyOn(console, 'log')
-
-    const handler = middy((event, context, cb) => {
-      cb()
-    })
-    handler.use(lambdaIsWarmingUp({}))
-
-    const event = {
-      source: 'serverless-plugin-warmup'
-    }
-    const context = {}
-
-    const response = await invoke(handler, event, context)
-
-    expect(response).toBe('warmup')
-    expect(logSpy).toHaveBeenCalled()
-  })
-
-  test('Should execute handler if provided warmup check function returns false', async () => {
-    const handler = middy((event, context, cb) => {
-      cb(null, 'handler executed')
-    })
-    handler.use(lambdaIsWarmingUp({ isWarmingUp: () => false }))
-
-    const event = {}
-    const context = {}
-
-    const response = await invoke(handler, event, context)
-
-    expect(response).toBe('handler executed')
-  })
-
-  test('Should execute handler with callbackWaitsForEmptyEventLoop if waitForEmptyEventLoop true', async () => {
-    const handler = middy((event, context, cb) => {
-      cb()
-    })
-    handler.use(lambdaIsWarmingUp({
-      waitForEmptyEventLoop: true
-    }))
-
-    const event = {
-      source: 'serverless-plugin-warmup'
-    }
-    const context = {}
-
-    const response = await invoke(handler, event, context)
-
-    expect(context.callbackWaitsForEmptyEventLoop).toBe(true)
-    expect(response).toBe('warmup')
-  })
-
-  test('Should execute handler with callbackWaitsForEmptyEventLoop if waitForEmptyEventLoop false', async () => {
-    const handler = middy((event, context, cb) => {
-      cb()
-    })
-    handler.use(lambdaIsWarmingUp({
-      waitForEmptyEventLoop: false
-    }))
-
-    const event = {
-      source: 'serverless-plugin-warmup'
-    }
-    const context = {
-      callbackWaitsForEmptyEventLoop: true
-    }
-
-    const response = await invoke(handler, event, context)
-
-    expect(context.callbackWaitsForEmptyEventLoop).toBe(false)
-    expect(response).toBe('warmup')
-  })
-
-  test('Should execute handler with callbackWaitsForEmptyEventLoop unchanged if waitForEmptyEventLoop is not set', async () => {
-    const handler = middy((event, context, cb) => {
-      cb()
-    })
-    handler.use(lambdaIsWarmingUp({}))
-
-    const event = {
-      source: 'serverless-plugin-warmup'
-    }
-    const context = {
-      callbackWaitsForEmptyEventLoop: true
-    }
-
-    const response = await invoke(handler, event, context)
-
-    expect(context.callbackWaitsForEmptyEventLoop).toBe(true)
-    expect(response).toBe('warmup')
-  })
-})

package/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "commonjs",
-    "lib": ["es2015"],
-    "target": "es2015",
-    "esModuleInterop": true
-  },
-  "files": [
-    "index.d.ts"
-  ]
-}