serverless-plugin-warmup 8.2.1 → 8.3.0

package/README.md

@@ -9,7 +9,7 @@
 Keep your lambdas warm during winter.
 
 **Requirements:**
-* Node *v14.x* or higher
+* Node *v18.x* or higher
 * Serverless *v3.8* or higher
 * AWS provider
 
@@ -258,7 +258,7 @@ The permissions can also be added to all lambdas using setting the role to `IamR
 ```yaml
 provider:
   name: aws
-  runtime: nodejs18.x
+  runtime: nodejs20.x
   iamRoleStatements:
     - Effect: 'Allow'
       Action:
@@ -585,13 +585,13 @@ You can check the Lambda [pricing](https://aws.amazon.com/lambda/pricing/) and C
 
 #### Example
 
-If you have a single warmer and want to warm 10 functions, each with `memorySize = 1024` and `duration = 10`, using the default settings (and we ignore the free tier):
+If you have a single warmer and want to warm 10 functions, each with `memorySize = 1024` and `duration = 10`, using the default settings ($0.0000166667 for every GB-second) and ignoring the free tier:
 
-* WarmUp: runs 8640 times per month = $0.18
-* 10 warm lambdas: each invoked 8640 times per month = $14.4
-* Total = $14.58
+* WarmUp: runs 8640 times per month = $0.0
+* 10 warm lambdas: each invoked 8640 times per month = $0.3
+* Total = $0.3
 
-CloudWatch costs are not in this example because they are very low.
+CloudWatch costs are not consdiered in this example.
 
 ## Contribute
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-plugin-warmup",
-  "version": "8.2.1",
+  "version": "8.3.0",
   "description": "Keep your lambdas warm during winter.",
   "main": "src/index.js",
   "scripts": {

package/src/config.js

@@ -167,7 +167,7 @@ function getConfigsByWarmer({ service, classes }, stage) {
     concurrency: 1,
   };
 
-  const configsByWarmer = Object.entries(service.custom ? service.custom.warmup : {})
+  const configsByWarmer = Object.entries((service.custom && service.custom.warmup) || {})
     .reduce((warmers, [warmerName, warmerConfig]) => ({
       ...warmers,
       [warmerName]: {

package/src/schema.js

@@ -122,6 +122,7 @@ function extendServerlessSchema(serverless) {
         { type: 'array', items: { type: 'string' } },
       ],
     },
+    alias: { type: 'string' },
     clientContext: {
       anyOf: [
         { const: false }, // to skip it

package/src/warmer.js

@@ -126,18 +126,20 @@ function addWarmUpFunctionRoleToResources(service, stage, warmerName, warmerConf
  * @return {Promise}
  * */
 async function createWarmUpFunctionArtifact(functions, tracing, verbose, region, handlerFolder) {
-  const warmUpFunction = `'use strict';
-
+  const warmUpFunction = `
 /** Generated by Serverless WarmUp Plugin **/
 
-${tracing
-    ? `const AWSXRay = require('aws-xray-sdk-core');
-const AWS = AWSXRay.captureAWS(require('@aws-sdk/client-lambda'));`
-    : 'const AWS = require(\'@aws-sdk/client-lambda\')'};
-const lambda = new AWS.Lambda({
+import { LambdaClient, InvokeCommand } from '@aws-sdk/client-lambda';
+
+const uninstrumentedLambdaClient = new LambdaClient({
   apiVersion: '2015-03-31',
   region: '${region}'
 });
+
+${tracing
+    ? 'const lambdaClient = AWSXRay.captureAWSv3Client(uninstrumentedLambdaClient);'
+    : 'const lambdaClient = uninstrumentedLambdaClient;'}
+
 const functions = ${JSON.stringify(functions, null, '  ')};
 
 function logVerbose(str) {
@@ -164,7 +166,7 @@ function getConcurrency(func, envVars) {
   return concurrency;
 }
 
-module.exports.warmUp = async (event, context) => {
+export const warmUp = async (event, context) => {
   logVerbose('Warm Up Start');
 
   const invokes = await Promise.all(functions.map(async (func) => {
@@ -174,7 +176,7 @@ module.exports.warmUp = async (event, context) => {
       ? func.config.clientContext
       : func.config.payload;
 
-    const params = {
+    const invokeCommand = new InvokeCommand({
       ClientContext: clientContext
         ? Buffer.from(\`{"custom":\${clientContext}}\`).toString('base64')
         : undefined,
@@ -183,10 +185,10 @@ module.exports.warmUp = async (event, context) => {
       LogType: 'None',
       Qualifier: func.config.alias || process.env.SERVERLESS_ALIAS,
       Payload: func.config.payload
-    };
+    });
 
     try {
-      await Promise.all(Array(concurrency).fill(0).map(async () => await lambda.invoke(params)));
+      await Promise.all(Array(concurrency).fill(0).map(async () => await lambdaClient.send(invokeCommand)));
       logVerbose(\`Warm Up Invoke Success: \${func.name}\`);
       return true;
     } catch (e) {
@@ -200,7 +202,7 @@ module.exports.warmUp = async (event, context) => {
 
   /** Write warm up file */
   await fs.mkdir(handlerFolder, { recursive: true });
-  await fs.writeFile(path.join(handlerFolder, 'index.js'), warmUpFunction);
+  await fs.writeFile(path.join(handlerFolder, 'index.mjs'), warmUpFunction);
 
   if (tracing) {
     await execAsync('npm init -y', { cwd: handlerFolder });
@@ -220,7 +222,7 @@ function addWarmUpFunctionToService(service, warmerName, warmerConfig) {
     memorySize: warmerConfig.memorySize,
     name: warmerConfig.name,
     ...(warmerConfig.architecture ? { architecture: warmerConfig.architecture } : {}),
-    runtime: 'nodejs18.x',
+    runtime: 'nodejs20.x',
     package: warmerConfig.package,
     timeout: warmerConfig.timeout,
     ...(Object.keys(warmerConfig.environment).length