serverless-plugin-warmup 8.2.1 → 8.4.0

package/README.md

@@ -9,7 +9,7 @@
 Keep your lambdas warm during winter.
 
 **Requirements:**
-* Node *v14.x* or higher
+* Node *v20.x* or higher
 * Serverless *v3.8* or higher
 * AWS provider
 
@@ -64,7 +64,7 @@ The options are the same for all the warmers:
 * **cleanFolder** Whether to automatically delete the generated code folder. You might want to keep it if you are doing some custom packaging (defaults to `true`)
 * **name** Name of the generated warmer lambda (defaults to `${service}-${stage}-warmup-plugin-${warmerName}`)
 * **roleName** Name to be applied to the default warmer lambda role. Ignored if a the role setting is used (defaults to `${service.service}-${stage}-${region}-${warmerName.toLowerCase()}-role`)
-* **role** Role to apply to the warmer lambda (defaults to the role in the provider)
+* **role** Role to apply to the warmer lambda (defaults to a custom role with minimal [permissions](#permissions))
 * **tags** Tag to apply to the generated warmer lambda (defaults to the serverless default tags)
 * **vpc** The VPC and subnets in which to deploy. Can be any [Serverless VPC configuration](https://serverless.com/framework/docs/providers/aws/guide/functions#vpc-configuration) or be set to `false` in order to deploy the warmup function outside of a VPC (defaults to the vpc in the provider)
 * **memorySize** The memory to be assigned to the warmer lambda (defaults to `128`)
@@ -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: nodejs24.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/biome.json

@@ -0,0 +1,47 @@
+{
+	"$schema": "https://biomejs.dev/schemas/2.3.11/schema.json",
+	"vcs": {
+		"enabled": true,
+		"clientKind": "git",
+		"useIgnoreFile": true
+	},
+	"files": {
+		"includes": ["**", "!!**/coverage", "!!**/test_integration", "!!**/node_modules"]
+	},
+	"formatter": {
+		"indentWidth": 2,
+		"lineWidth": 100
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true,
+			"style": {
+				"useNodejsImportProtocol": "off"
+			},
+			"suspicious": {
+				"noEmptyBlockStatements": "off",
+				"noAssignInExpressions": "off"
+			}
+		}
+	},
+	"javascript": {
+		"formatter": {
+			"quoteStyle": "single",
+			"trailingCommas": "all",
+			"semicolons": "always",
+			"arrowParentheses": "always"
+		},
+		"globals": [
+			"jest",
+			"describe",
+			"it",
+			"expect",
+			"beforeEach",
+			"afterEach",
+			"beforeAll",
+			"afterAll",
+			"test"
+		]
+	}
+}

package/package.json

@@ -1,40 +1,38 @@
 {
-  "name": "serverless-plugin-warmup",
-  "version": "8.2.1",
-  "description": "Keep your lambdas warm during winter.",
-  "main": "src/index.js",
-  "scripts": {
-    "prepare": "husky install",
-    "lint": "eslint .",
-    "lint:fix": "eslint --fix .",
-    "test": "jest test",
-    "test-with-coverage": "jest --coverage --collectCoverageFrom=src/**/*.js test"
-  },
-  "author": "Juanjo Diaz <juanjo.diazmo@gmail.com>",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/juanjoDiaz/serverless-plugin-warmup.git"
-  },
-  "keywords": [
-    "serverless plugin warm up lambdas",
-    "serverless warmup",
-    "serverless plugin",
-    "lambda serverless",
-    "warm lambda",
-    "lambda coldstart",
-    "lambda cold"
-  ],
-  "bugs": {
-    "url": "https://github.com/juanjoDiaz/serverless-plugin-warmup/issues"
-  },
-  "homepage": "https://github.com/juanjoDiaz/serverless-plugin-warmup",
-  "dependencies": {},
-  "devDependencies": {
-    "eslint": "^8.5.0",
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-plugin-import": "^2.24.2",
-    "husky": "^8.0.1",
-    "jest": "^29.1.2"
-  }
+	"name": "serverless-plugin-warmup",
+	"version": "8.4.0",
+	"description": "Keep your lambdas warm during winter.",
+	"main": "src/index.js",
+	"scripts": {
+		"prepare": "husky",
+		"lint": "biome check .",
+		"lint:fix": "biome check --write .",
+		"format": "biome format --write .",
+		"test": "jest test",
+		"test-with-coverage": "jest --coverage --collectCoverageFrom=src/**/*.js test"
+	},
+	"author": "Juanjo Diaz <juanjo.diazmo@gmail.com>",
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/juanjoDiaz/serverless-plugin-warmup.git"
+	},
+	"keywords": [
+		"serverless plugin warm up lambdas",
+		"serverless warmup",
+		"serverless plugin",
+		"lambda serverless",
+		"warm lambda",
+		"lambda coldstart",
+		"lambda cold"
+	],
+	"bugs": {
+		"url": "https://github.com/juanjoDiaz/serverless-plugin-warmup/issues"
+	},
+	"homepage": "https://github.com/juanjoDiaz/serverless-plugin-warmup",
+	"devDependencies": {
+		"@biomejs/biome": "2.3.11",
+		"husky": "^9.1.7",
+		"jest": "^30.2.0"
+	}
 }

package/src/config.js

@@ -7,51 +7,60 @@ const path = require('path');
  * @return {Object} - Global configuration options
  * */
 function getWarmerConfig(config, defaultOpts) {
-  const folderName = (typeof config.folderName === 'string') ? config.folderName : defaultOpts.folderName;
+	const folderName =
+		typeof config.folderName === 'string' ? config.folderName : defaultOpts.folderName;
 
-  /* eslint-disable no-nested-ternary */
-  return {
-    folderName,
-    pathHandler: path.join(folderName, 'index.warmUp'),
-    cleanFolder: (typeof config.cleanFolder === 'boolean') ? config.cleanFolder : defaultOpts.cleanFolder,
-    name: (config.name !== undefined) ? config.name : defaultOpts.name,
-    roleName: (config.roleName !== undefined) ? config.roleName : defaultOpts.roleName,
-    role: (config.role !== undefined) ? config.role : defaultOpts.role,
-    tags: (config.tags !== undefined) ? config.tags : defaultOpts.tags,
-    vpc: config.vpc === false ? { securityGroupIds: [], subnetIds: [] }
-      : (config.vpc !== undefined ? config.vpc : defaultOpts.vpc),
-    events: (Array.isArray(config.events)) ? config.events : defaultOpts.events,
-    architecture: (config.architecture !== undefined)
-      ? config.architecture
-      : defaultOpts.architecture,
-    package: typeof config.package === 'object'
-      ? {
-        individually: (config.package.individually !== undefined)
-          ? config.package.individually
-          : defaultOpts.package.individually,
-        patterns: ['!**', ...Array.isArray(config.package.patterns)
-          ? (config.package.patterns.includes(path.join(folderName, '**'))
-            ? config.package.patterns
-            : [...config.package.patterns, path.join(folderName, '**')])
-          : [...defaultOpts.package.patterns, path.join(folderName, '**')]],
-      }
-      : {
-        ...defaultOpts.package,
-        patterns: ['!**', ...defaultOpts.package.patterns, path.join(folderName, '**')],
-      },
-    memorySize: (config.memorySize !== undefined) ? config.memorySize : defaultOpts.memorySize,
-    timeout: (config.timeout !== undefined) ? config.timeout : defaultOpts.timeout,
-    environment: (config.environment !== undefined)
-      ? config.environment
-      : defaultOpts.environment,
-    tracing: (config.tracing !== undefined) ? config.tracing : defaultOpts.tracing,
-    verbose: (config.verbose !== undefined) ? config.verbose : defaultOpts.verbose,
-    logRetentionInDays: (config.logRetentionInDays !== undefined)
-      ? config.logRetentionInDays
-      : defaultOpts.logRetentionInDays,
-    prewarm: (config.prewarm !== undefined) ? config.prewarm : defaultOpts.prewarm,
-  };
-  /* eslint-enable no-nested-ternary */
+	/* eslint-disable no-nested-ternary */
+	return {
+		folderName,
+		pathHandler: path.join(folderName, 'index.warmUp'),
+		cleanFolder:
+			typeof config.cleanFolder === 'boolean' ? config.cleanFolder : defaultOpts.cleanFolder,
+		name: config.name !== undefined ? config.name : defaultOpts.name,
+		roleName: config.roleName !== undefined ? config.roleName : defaultOpts.roleName,
+		role: config.role !== undefined ? config.role : defaultOpts.role,
+		tags: config.tags !== undefined ? config.tags : defaultOpts.tags,
+		vpc:
+			config.vpc === false
+				? { securityGroupIds: [], subnetIds: [] }
+				: config.vpc !== undefined
+					? config.vpc
+					: defaultOpts.vpc,
+		events: Array.isArray(config.events) ? config.events : defaultOpts.events,
+		architecture:
+			config.architecture !== undefined ? config.architecture : defaultOpts.architecture,
+		package:
+			typeof config.package === 'object'
+				? {
+						individually:
+							config.package.individually !== undefined
+								? config.package.individually
+								: defaultOpts.package.individually,
+						patterns: [
+							'!**',
+							...(Array.isArray(config.package.patterns)
+								? config.package.patterns.includes(path.join(folderName, '**'))
+									? config.package.patterns
+									: [...config.package.patterns, path.join(folderName, '**')]
+								: [...defaultOpts.package.patterns, path.join(folderName, '**')]),
+						],
+					}
+				: {
+						...defaultOpts.package,
+						patterns: ['!**', ...defaultOpts.package.patterns, path.join(folderName, '**')],
+					},
+		memorySize: config.memorySize !== undefined ? config.memorySize : defaultOpts.memorySize,
+		timeout: config.timeout !== undefined ? config.timeout : defaultOpts.timeout,
+		environment: config.environment !== undefined ? config.environment : defaultOpts.environment,
+		tracing: config.tracing !== undefined ? config.tracing : defaultOpts.tracing,
+		verbose: config.verbose !== undefined ? config.verbose : defaultOpts.verbose,
+		logRetentionInDays:
+			config.logRetentionInDays !== undefined
+				? config.logRetentionInDays
+				: defaultOpts.logRetentionInDays,
+		prewarm: config.prewarm !== undefined ? config.prewarm : defaultOpts.prewarm,
+	};
+	/* eslint-enable no-nested-ternary */
 }
 
 /**
@@ -61,25 +70,23 @@ function getWarmerConfig(config, defaultOpts) {
  * @return {Object} - Function-specific configuration options
  * */
 function getFunctionConfig(config, defaultOpts) {
-  /* eslint-disable no-nested-ternary */
-  return {
-    enabled: (config.enabled !== undefined)
-      ? config.enabled
-      : defaultOpts.enabled,
-    alias: (config.alias !== undefined)
-      ? config.alias
-      : defaultOpts.alias,
-    clientContext: (config.clientContext !== undefined)
-      ? config.clientContext && JSON.stringify(config.clientContext)
-      : defaultOpts.clientContext,
-    payload: (config.payload !== undefined)
-      ? (config.payloadRaw ? config.payload : JSON.stringify(config.payload))
-      : defaultOpts.payload,
-    concurrency: (config.concurrency !== undefined)
-      ? config.concurrency
-      : defaultOpts.concurrency,
-  };
-  /* eslint-enable no-nested-ternary */
+	/* eslint-disable no-nested-ternary */
+	return {
+		enabled: config.enabled !== undefined ? config.enabled : defaultOpts.enabled,
+		alias: config.alias !== undefined ? config.alias : defaultOpts.alias,
+		clientContext:
+			config.clientContext !== undefined
+				? config.clientContext && JSON.stringify(config.clientContext)
+				: defaultOpts.clientContext,
+		payload:
+			config.payload !== undefined
+				? config.payloadRaw
+					? config.payload
+					: JSON.stringify(config.payload)
+				: defaultOpts.payload,
+		concurrency: config.concurrency !== undefined ? config.concurrency : defaultOpts.concurrency,
+	};
+	/* eslint-enable no-nested-ternary */
 }
 
 /**
@@ -88,53 +95,54 @@ function getFunctionConfig(config, defaultOpts) {
  * @return {Array} - List of functions to be warmed up and their specific configs
  * */
 function getFunctionsByWarmer(service, stage, configsByWarmer, serverlessClasses) {
-  const functions = service.getAllFunctions()
-    .map((name) => service.getFunction(name))
-    .map((config) => {
-      if (config.warmup === undefined) {
-        return {
-          name: config.name,
-          config: Object.entries(configsByWarmer)
-            .reduce((warmers, [warmerName, warmerConfig]) => ({
-              ...warmers,
-              [warmerName]: getFunctionConfig({}, warmerConfig),
-            }), {}),
-        };
-      }
+	const functions = service
+		.getAllFunctions()
+		.map((name) => service.getFunction(name))
+		.map((config) => {
+			if (config.warmup === undefined) {
+				return {
+					name: config.name,
+					config: Object.entries(configsByWarmer).reduce((warmers, [warmerName, warmerConfig]) => {
+						warmers[warmerName] = getFunctionConfig({}, warmerConfig);
+						return warmers;
+					}, {}),
+				};
+			}
+			const unknownWarmers = Object.keys(config.warmup).filter(
+				(warmerName) => configsByWarmer[warmerName] === undefined,
+			);
+			if (unknownWarmers.length > 0) {
+				throw new serverlessClasses.Error(
+					`WarmUp: Invalid function-level warmup configuration (${unknownWarmers.join(', ')}) in function ${config.name}. Every warmer should be declared in the custom section.`,
+				);
+			}
 
-      const unknownWarmers = Object.keys(config.warmup)
-        .filter((warmerName) => configsByWarmer[warmerName] === undefined);
-      if (unknownWarmers.length > 0) {
-        throw new serverlessClasses.Error(`WarmUp: Invalid function-level warmup configuration (${unknownWarmers.join(', ')}) in function ${config.name}. Every warmer should be declared in the custom section.`);
-      }
+			return {
+				name: config.name,
+				config: Object.entries(configsByWarmer).reduce((warmers, [warmerName, warmerConfig]) => {
+					warmers[warmerName] = getFunctionConfig(config.warmup[warmerName] || {}, warmerConfig);
+					return warmers;
+				}, {}),
+			};
+		});
+	function isEnabled(enabled) {
+		return (
+			enabled === true ||
+			enabled === 'true' ||
+			enabled === stage ||
+			(Array.isArray(enabled) && enabled.indexOf(stage) !== -1)
+		);
+	}
 
-      return {
-        name: config.name,
-        config: Object.entries(configsByWarmer)
-          .reduce((warmers, [warmerName, warmerConfig]) => ({
-            ...warmers,
-            [warmerName]: getFunctionConfig(config.warmup[warmerName] || {}, warmerConfig),
-          }), {}),
-      };
-    });
-
-  function isEnabled(enabled) {
-    return enabled === true
-        || enabled === 'true'
-        || enabled === stage
-        || (Array.isArray(enabled) && enabled.indexOf(stage) !== -1);
-  }
-
-  return functions.reduce((warmersAcc, fn) => {
-    Object.entries(fn.config)
-      .forEach(([warmerName, config]) => {
-        if (!isEnabled(config.enabled)) return;
-        // eslint-disable-next-line no-param-reassign
-        if (!warmersAcc[warmerName]) warmersAcc[warmerName] = [];
-        warmersAcc[warmerName].push({ name: fn.name, config });
-      });
-    return warmersAcc;
-  }, {});
+	return functions.reduce((warmersAcc, fn) => {
+		Object.entries(fn.config).forEach(([warmerName, config]) => {
+			if (!isEnabled(config.enabled)) return;
+			// eslint-disable-next-line no-param-reassign
+			if (!warmersAcc[warmerName]) warmersAcc[warmerName] = [];
+			warmersAcc[warmerName].push({ name: fn.name, config });
+		});
+		return warmersAcc;
+	}, {});
 }
 
 /**
@@ -143,50 +151,54 @@ function getFunctionsByWarmer(service, stage, configsByWarmer, serverlessClasses
  * @return {Object} - Configuration options to be used by the plugin
  * */
 function getConfigsByWarmer({ service, classes }, stage) {
-  const getWarmerDefaultOpts = (warmerName) => ({
-    folderName: path.join('.warmup', warmerName),
-    cleanFolder: true,
-    memorySize: 128,
-    name: `${service.service}-${stage}-warmup-plugin-${warmerName}`,
-    events: [{ schedule: 'rate(5 minutes)' }],
-    package: {
-      individually: true,
-      patterns: [],
-    },
-    timeout: 10,
-    environment: Object.keys(service.provider.environment || [])
-      .reduce((obj, k) => ({ ...obj, [k]: undefined }), {}),
-    verbose: true,
-    prewarm: false,
-  });
+	const getWarmerDefaultOpts = (warmerName) => ({
+		folderName: path.join('.warmup', warmerName),
+		cleanFolder: true,
+		memorySize: 128,
+		name: `${service.service}-${stage}-warmup-plugin-${warmerName}`,
+		events: [{ schedule: 'rate(5 minutes)' }],
+		package: {
+			individually: true,
+			patterns: [],
+		},
+		timeout: 10,
+		environment: Object.keys(service.provider.environment || []).reduce((obj, k) => {
+			obj[k] = undefined;
+			return obj;
+		}, {}),
+		verbose: true,
+		prewarm: false,
+	});
 
-  const functionDefaultOpts = {
-    enabled: false,
-    clientContext: undefined,
-    payload: JSON.stringify({ source: 'serverless-plugin-warmup' }),
-    concurrency: 1,
-  };
+	const functionDefaultOpts = {
+		enabled: false,
+		clientContext: undefined,
+		payload: JSON.stringify({ source: 'serverless-plugin-warmup' }),
+		concurrency: 1,
+	};
 
-  const configsByWarmer = Object.entries(service.custom ? service.custom.warmup : {})
-    .reduce((warmers, [warmerName, warmerConfig]) => ({
-      ...warmers,
-      [warmerName]: {
-        ...getWarmerConfig(warmerConfig, getWarmerDefaultOpts(warmerName)),
-        ...getFunctionConfig(warmerConfig, functionDefaultOpts),
-      },
-    }), {});
+	const configsByWarmer = Object.entries(service.custom?.warmup || {}).reduce(
+		(warmers, [warmerName, warmerConfig]) => {
+			warmers[warmerName] = {
+				...getWarmerConfig(warmerConfig, getWarmerDefaultOpts(warmerName)),
+				...getFunctionConfig(warmerConfig, functionDefaultOpts),
+			};
+			return warmers;
+		},
+		{},
+	);
 
-  const functionsByWarmer = getFunctionsByWarmer(service, stage, configsByWarmer, classes);
+	const functionsByWarmer = getFunctionsByWarmer(service, stage, configsByWarmer, classes);
 
-  return Object.entries(configsByWarmer).reduce((warmers, [warmerName, warmerConfig]) => ({
-    ...warmers,
-    [warmerName]: {
-      ...warmerConfig,
-      functions: functionsByWarmer[warmerName] || [],
-    },
-  }), {});
+	return Object.entries(configsByWarmer).reduce((warmers, [warmerName, warmerConfig]) => {
+		warmers[warmerName] = {
+			...warmerConfig,
+			functions: functionsByWarmer[warmerName] || [],
+		};
+		return warmers;
+	}, {});
 }
 
 module.exports = {
-  getConfigsByWarmer,
+	getConfigsByWarmer,
 };