serverless-plugin-warmup 8.3.0 → 8.4.0

package/src/schema.js

@@ -2,176 +2,191 @@
  * @description Define the additions to the serverless schema by this plugin.
  * */
 function extendServerlessSchema(serverless) {
-  // Most of these are taken from
-  // https://github.com/serverless/serverless/blob/master/lib/configSchema.js
-  // https://github.com/serverless/serverless/blob/master/lib/plugins/aws/provider.js
-  // https://github.com/serverless/serverless/blob/master/lib/plugins/aws/package/compile/events/schedule.js
+	// Most of these are taken from
+	// https://github.com/serverless/serverless/blob/master/lib/configSchema.js
+	// https://github.com/serverless/serverless/blob/master/lib/plugins/aws/provider.js
+	// https://github.com/serverless/serverless/blob/master/lib/plugins/aws/package/compile/events/schedule.js
 
-  const rateSyntax = '^rate\\((?:1 (?:minute|hour|day)|(?:1\\d+|[2-9]\\d*) (?:minute|hour|day)s)\\)$';
-  const cronSyntax = '^cron\\(\\S+ \\S+ \\S+ \\S+ \\S+ \\S+\\)$';
-  const scheduleSyntax = `${rateSyntax}|${cronSyntax}`;
+	const rateSyntax =
+		'^rate\\((?:1 (?:minute|hour|day)|(?:1\\d+|[2-9]\\d*) (?:minute|hour|day)s)\\)$';
+	const cronSyntax = '^cron\\(\\S+ \\S+ \\S+ \\S+ \\S+ \\S+\\)$';
+	const scheduleSyntax = `${rateSyntax}|${cronSyntax}`;
 
-  const globalConfigSchemaProperties = {
-    folderName: { type: 'string' },
-    cleanFolder: { type: 'boolean' },
-    name: { type: 'string' },
-    roleName: { type: 'string' },
-    role: { $ref: '#/definitions/awsLambdaRole' },
-    tags: { $ref: '#/definitions/awsResourceTags' },
-    vpc: {
-      anyOf: [
-        { const: false }, // to deploy outside of the VPC
-        { $ref: '#/definitions/awsLambdaVpcConfig' },
-      ],
-    },
-    events: {
-      type: 'array',
-      items: {
-        type: 'object',
-        properties: {
-          schedule: {
-            anyOf: [
-              { type: 'string', pattern: scheduleSyntax },
-              {
-                type: 'object',
-                properties: {
-                  rate: {
-                    type: 'array',
-                    minItems: 1,
-                    items: {
-                      type: 'string',
-                      pattern: scheduleSyntax,
-                    },
-                  },
-                  enabled: { type: 'boolean' },
-                  name: {
-                    type: 'string', minLength: 1, maxLength: 64, pattern: '[\\.\\-_A-Za-z0-9]+',
-                  },
-                  description: { type: 'string', maxLength: 512 },
-                  input: {
-                    anyOf: [
-                      { type: 'string', maxLength: 8192 },
-                      {
-                        type: 'object',
-                        oneOf: [
-                          {
-                            properties: {
-                              body: { type: 'string', maxLength: 8192 },
-                            },
-                            required: ['body'],
-                            additionalProperties: false,
-                          },
-                          {
-                            not: {
-                              required: ['body'],
-                            },
-                          },
-                        ],
-                      },
-                    ],
-                  },
-                  inputPath: { type: 'string', maxLength: 256 },
-                  inputTransformer: {
-                    type: 'object',
-                    properties: {
-                      inputTemplate: {
-                        type: 'string',
-                        minLength: 1,
-                        maxLength: 8192,
-                      },
-                      inputPathsMap: { type: 'object' },
-                    },
-                    required: ['inputTemplate'],
-                    additionalProperties: false,
-                  },
-                },
-                required: ['rate'],
-                additionalProperties: false,
-              },
-            ],
-          },
-        },
-        required: ['schedule'],
-        additionalProperties: false,
-      },
-    },
-    architecture: { enum: ['arm64', 'x86_64'] },
-    package: {
-      type: 'object',
-      properties: {
-        artifact: { type: 'string' },
-        patterns: { type: 'array', items: { type: 'string' } },
-        individually: { type: 'boolean' },
-      },
-      additionalProperties: false,
-    },
-    memorySize: { $ref: '#/definitions/awsLambdaMemorySize' },
-    timeout: { $ref: '#/definitions/awsLambdaTimeout' },
-    environment: { $ref: '#/definitions/awsLambdaEnvironment' },
-    tracing: { $ref: '#/definitions/awsLambdaTracing' },
-    verbose: { type: 'boolean' },
-    logRetentionInDays: { $ref: '#/definitions/awsLogRetentionInDays' },
-    prewarm: { type: 'boolean' },
-  };
+	const METHOD_SCHEDULER = 'scheduler';
+	const METHOD_EVENT_BUS = 'eventBus';
 
-  const functionConfigSchemaProperties = {
-    enabled: {
-      anyOf: [
-        { type: 'boolean' },
-        { type: 'string' },
-        { type: 'array', items: { type: 'string' } },
-      ],
-    },
-    alias: { type: 'string' },
-    clientContext: {
-      anyOf: [
-        { const: false }, // to skip it
-        { type: 'object' }, // any
-      ],
-    },
-    payload: { type: 'object' }, // any
-    payloadRaw: { type: 'boolean' },
-    concurrency: { type: 'integer' },
-  };
+	const globalConfigSchemaProperties = {
+		folderName: { type: 'string' },
+		cleanFolder: { type: 'boolean' },
+		name: { type: 'string' },
+		roleName: { type: 'string' },
+		role: { $ref: '#/definitions/awsLambdaRole' },
+		tags: { $ref: '#/definitions/awsResourceTags' },
+		vpc: {
+			anyOf: [
+				{ const: false }, // to deploy outside of the VPC
+				{ $ref: '#/definitions/awsLambdaVpcConfig' },
+			],
+		},
+		events: {
+			type: 'array',
+			items: {
+				type: 'object',
+				properties: {
+					schedule: {
+						anyOf: [
+							{ type: 'string', pattern: scheduleSyntax },
+							{
+								type: 'object',
+								properties: {
+									rate: {
+										type: 'array',
+										minItems: 1,
+										items: {
+											type: 'string',
+											pattern: scheduleSyntax,
+										},
+									},
+									enabled: { type: 'boolean' },
+									name: {
+										type: 'string',
+										minLength: 1,
+										maxLength: 64,
+										pattern: '[\\.\\-_A-Za-z0-9]+',
+									},
+									description: { type: 'string', maxLength: 512 },
+									input: {
+										anyOf: [
+											{ type: 'string', maxLength: 8192 },
+											{
+												type: 'object',
+												oneOf: [
+													{
+														properties: {
+															body: { type: 'string', maxLength: 8192 },
+														},
+														required: ['body'],
+														additionalProperties: false,
+													},
+													{
+														not: {
+															required: ['body'],
+														},
+													},
+												],
+											},
+										],
+									},
+									inputPath: { type: 'string', maxLength: 256 },
+									inputTransformer: {
+										type: 'object',
+										properties: {
+											inputTemplate: {
+												type: 'string',
+												minLength: 1,
+												maxLength: 8192,
+											},
+											inputPathsMap: { type: 'object' },
+										},
+										required: ['inputTemplate'],
+										additionalProperties: false,
+									},
+									method: {
+										type: 'string',
+										enum: [METHOD_EVENT_BUS, METHOD_SCHEDULER],
+									},
+									timezone: {
+										type: 'string',
+										pattern: '[\\w\\-\\/]+',
+									},
+								},
+								required: ['rate'],
+								additionalProperties: false,
+							},
+						],
+					},
+				},
+				required: ['schedule'],
+				additionalProperties: false,
+			},
+		},
+		architecture: { enum: ['arm64', 'x86_64'] },
+		package: {
+			type: 'object',
+			properties: {
+				artifact: { type: 'string' },
+				patterns: { type: 'array', items: { type: 'string' } },
+				individually: { type: 'boolean' },
+			},
+			additionalProperties: false,
+		},
+		memorySize: { $ref: '#/definitions/awsLambdaMemorySize' },
+		timeout: { $ref: '#/definitions/awsLambdaTimeout' },
+		environment: { $ref: '#/definitions/awsLambdaEnvironment' },
+		tracing: { $ref: '#/definitions/awsLambdaTracing' },
+		verbose: { type: 'boolean' },
+		logRetentionInDays: { $ref: '#/definitions/awsLogRetentionInDays' },
+		prewarm: { type: 'boolean' },
+	};
 
-  if (!serverless.configSchemaHandler) return;
+	const functionConfigSchemaProperties = {
+		enabled: {
+			anyOf: [
+				{ type: 'boolean' },
+				{ type: 'string' },
+				{ type: 'array', items: { type: 'string' } },
+			],
+		},
+		alias: { type: 'string' },
+		clientContext: {
+			anyOf: [
+				{ const: false }, // to skip it
+				{ type: 'object' }, // any
+			],
+		},
+		payload: { type: 'object' }, // any
+		payloadRaw: { type: 'boolean' },
+		concurrency: { type: 'integer' },
+	};
 
-  if (typeof serverless.configSchemaHandler.defineCustomProperties === 'function') {
-    serverless.configSchemaHandler.defineCustomProperties({
-      properties: {
-        warmup: {
-          type: 'object',
-          patternProperties: {
-            '.*': {
-              type: 'object',
-              properties: { ...globalConfigSchemaProperties, ...functionConfigSchemaProperties },
-              additionalProperties: false,
-            },
-          },
-        },
-      },
-    });
-  }
+	if (!serverless.configSchemaHandler) return;
 
-  if (typeof serverless.configSchemaHandler.defineFunctionProperties === 'function') {
-    serverless.configSchemaHandler.defineFunctionProperties('aws', {
-      type: 'object',
-      properties: {
-        warmup: {
-          type: 'object',
-          patternProperties: {
-            '.*': {
-              type: 'object',
-              properties: functionConfigSchemaProperties,
-              additionalProperties: false,
-            },
-          },
-        },
-      },
-    });
-  }
+	if (typeof serverless.configSchemaHandler.defineCustomProperties === 'function') {
+		serverless.configSchemaHandler.defineCustomProperties({
+			properties: {
+				warmup: {
+					type: 'object',
+					patternProperties: {
+						'.*': {
+							type: 'object',
+							properties: { ...globalConfigSchemaProperties, ...functionConfigSchemaProperties },
+							additionalProperties: false,
+						},
+					},
+				},
+			},
+		});
+	}
+
+	if (typeof serverless.configSchemaHandler.defineFunctionProperties === 'function') {
+		serverless.configSchemaHandler.defineFunctionProperties('aws', {
+			type: 'object',
+			properties: {
+				warmup: {
+					type: 'object',
+					patternProperties: {
+						'.*': {
+							type: 'object',
+							properties: functionConfigSchemaProperties,
+							additionalProperties: false,
+						},
+					},
+				},
+			},
+		});
+	}
 }
 
 module.exports = {
-  extendServerlessSchema,
+	extendServerlessSchema,
 };

package/src/utils.js

@@ -1,5 +1,5 @@
 const capitalize = (name) => name.charAt(0).toUpperCase() + name.slice(1);
 
 module.exports = {
-  capitalize,
+	capitalize,
 };

package/src/warmer.js

@@ -10,109 +10,92 @@ const execAsync = util.promisify(exec);
  * @description Add warmer role to service
  * */
 function addWarmUpFunctionRoleToResources(service, stage, warmerName, warmerConfig) {
-  // eslint-disable-next-line no-param-reassign
-  warmerConfig.role = `WarmUpPlugin${capitalize(warmerName)}Role`;
-  if (typeof service.resources !== 'object') {
-    // eslint-disable-next-line no-param-reassign
-    service.resources = {};
-  }
-  if (typeof service.resources.Resources !== 'object') {
-    // eslint-disable-next-line no-param-reassign
-    service.resources.Resources = {};
-  }
-
-  // eslint-disable-next-line no-param-reassign
-  service.resources.Resources[warmerConfig.role] = {
-    Type: 'AWS::IAM::Role',
-    Properties: {
-      Path: '/',
-      RoleName: warmerConfig.roleName || {
-        'Fn::Join': [
-          '-',
-          [
-            service.service,
-            stage,
-            { Ref: 'AWS::Region' },
-            warmerName.toLowerCase(),
-            'role',
-          ],
-        ],
-      },
-      AssumeRolePolicyDocument: {
-        Version: '2012-10-17',
-        Statement: [
-          {
-            Effect: 'Allow',
-            Principal: {
-              Service: [
-                'lambda.amazonaws.com',
-              ],
-            },
-            Action: 'sts:AssumeRole',
-          },
-        ],
-      },
-      Policies: [
-        {
-          PolicyName: {
-            'Fn::Join': [
-              '-',
-              [
-                service.service,
-                stage,
-                'warmer',
-                warmerName.toLowerCase(),
-                'policy',
-              ],
-            ],
-          },
-          PolicyDocument: {
-            Version: '2012-10-17',
-            Statement: [
-              {
-                Effect: 'Allow',
-                Action: [
-                  'logs:CreateLogGroup',
-                  'logs:CreateLogStream',
-                ],
-                Resource: [{
-                  'Fn::Sub': `arn:\${AWS::Partition}:logs:\${AWS::Region}:\${AWS::AccountId}:log-group:/aws/lambda/${warmerConfig.name}:*`,
-                }],
-              },
-              {
-                Effect: 'Allow',
-                Action: [
-                  'logs:PutLogEvents',
-                ],
-                Resource: [{
-                  'Fn::Sub': `arn:\${AWS::Partition}:logs:\${AWS::Region}:\${AWS::AccountId}:log-group:/aws/lambda/${warmerConfig.name}:*:*`,
-                }],
-              },
-              {
-                Effect: 'Allow',
-                Action: [
-                  'lambda:InvokeFunction',
-                ],
-                Resource: warmerConfig.functions.map((fn) => ({
-                  'Fn::Sub': `arn:\${AWS::Partition}:lambda:\${AWS::Region}:\${AWS::AccountId}:function:${fn.name}*`,
-                })),
-              },
-              {
-                Effect: 'Allow',
-                Action: [
-                  'ec2:CreateNetworkInterface',
-                  'ec2:DescribeNetworkInterfaces',
-                  'ec2:DetachNetworkInterface',
-                  'ec2:DeleteNetworkInterface',
-                ],
-                Resource: '*',
-              },
-            ],
-          },
-        },
-      ],
-    },
-  };
+	// eslint-disable-next-line no-param-reassign
+	warmerConfig.role = `WarmUpPlugin${capitalize(warmerName)}Role`;
+	if (typeof service.resources !== 'object') {
+		// eslint-disable-next-line no-param-reassign
+		service.resources = {};
+	}
+	if (typeof service.resources.Resources !== 'object') {
+		// eslint-disable-next-line no-param-reassign
+		service.resources.Resources = {};
+	}
+
+	// eslint-disable-next-line no-param-reassign
+	service.resources.Resources[warmerConfig.role] = {
+		Type: 'AWS::IAM::Role',
+		Properties: {
+			Path: '/',
+			RoleName: warmerConfig.roleName || {
+				'Fn::Join': [
+					'-',
+					[service.service, stage, { Ref: 'AWS::Region' }, warmerName.toLowerCase(), 'role'],
+				],
+			},
+			AssumeRolePolicyDocument: {
+				Version: '2012-10-17',
+				Statement: [
+					{
+						Effect: 'Allow',
+						Principal: {
+							Service: ['lambda.amazonaws.com'],
+						},
+						Action: 'sts:AssumeRole',
+					},
+				],
+			},
+			Policies: [
+				{
+					PolicyName: {
+						'Fn::Join': [
+							'-',
+							[service.service, stage, 'warmer', warmerName.toLowerCase(), 'policy'],
+						],
+					},
+					PolicyDocument: {
+						Version: '2012-10-17',
+						Statement: [
+							{
+								Effect: 'Allow',
+								Action: ['logs:CreateLogGroup', 'logs:CreateLogStream'],
+								Resource: [
+									{
+										'Fn::Sub': `arn:\${AWS::Partition}:logs:\${AWS::Region}:\${AWS::AccountId}:log-group:/aws/lambda/${warmerConfig.name}:*`,
+									},
+								],
+							},
+							{
+								Effect: 'Allow',
+								Action: ['logs:PutLogEvents'],
+								Resource: [
+									{
+										'Fn::Sub': `arn:\${AWS::Partition}:logs:\${AWS::Region}:\${AWS::AccountId}:log-group:/aws/lambda/${warmerConfig.name}:*:*`,
+									},
+								],
+							},
+							{
+								Effect: 'Allow',
+								Action: ['lambda:InvokeFunction'],
+								Resource: warmerConfig.functions.map((fn) => ({
+									'Fn::Sub': `arn:\${AWS::Partition}:lambda:\${AWS::Region}:\${AWS::AccountId}:function:${fn.name}*`,
+								})),
+							},
+							{
+								Effect: 'Allow',
+								Action: [
+									'ec2:CreateNetworkInterface',
+									'ec2:DescribeNetworkInterfaces',
+									'ec2:DetachNetworkInterface',
+									'ec2:DeleteNetworkInterface',
+								],
+								Resource: '*',
+							},
+						],
+					},
+				},
+			],
+		},
+	};
 }
 
 /**
@@ -126,19 +109,24 @@ function addWarmUpFunctionRoleToResources(service, stage, warmerName, warmerConf
  * @return {Promise}
  * */
 async function createWarmUpFunctionArtifact(functions, tracing, verbose, region, handlerFolder) {
-  const warmUpFunction = `
+	const warmUpFunction = `
 /** Generated by Serverless WarmUp Plugin **/
 
 import { LambdaClient, InvokeCommand } from '@aws-sdk/client-lambda';
+import { NodeHttpHandler } from '@smithy/node-http-handler';
 
 const uninstrumentedLambdaClient = new LambdaClient({
   apiVersion: '2015-03-31',
-  region: '${region}'
+  region: '${region}',
+  requestHandler: new NodeHttpHandler({ connectionTimeout: 1000 }),
 });
 
-${tracing
-    ? 'const lambdaClient = AWSXRay.captureAWSv3Client(uninstrumentedLambdaClient);'
-    : 'const lambdaClient = uninstrumentedLambdaClient;'}
+${
+	tracing
+		? `import * as AWSXRay from 'aws-xray-sdk';
+const lambdaClient = AWSXRay.captureAWSv3Client(uninstrumentedLambdaClient);`
+		: 'const lambdaClient = uninstrumentedLambdaClient;'
+}
 
 const functions = ${JSON.stringify(functions, null, '  ')};
 
@@ -200,48 +188,48 @@ export const warmUp = async (event, context) => {
   logVerbose(\`Warm Up Finished with \${invokes.filter(r => !r).length} invoke errors\`);
 }`;
 
-  /** Write warm up file */
-  await fs.mkdir(handlerFolder, { recursive: true });
-  await fs.writeFile(path.join(handlerFolder, 'index.mjs'), warmUpFunction);
+	/** Write warm up file */
+	await fs.mkdir(handlerFolder, { recursive: true });
+	await fs.writeFile(path.join(handlerFolder, 'index.mjs'), warmUpFunction);
 
-  if (tracing) {
-    await execAsync('npm init -y', { cwd: handlerFolder });
-    await execAsync('npm install --save aws-xray-sdk-core', { cwd: handlerFolder });
-  }
+	if (tracing) {
+		await execAsync('npm init -y', { cwd: handlerFolder });
+		await execAsync('npm install --save aws-xray-sdk-core', { cwd: handlerFolder });
+	}
 }
 
 /**
  * @description Add warmer function to service
  * */
 function addWarmUpFunctionToService(service, warmerName, warmerConfig) {
-  // eslint-disable-next-line no-param-reassign
-  service.functions[`warmUpPlugin${capitalize(warmerName)}`] = {
-    description: `Serverless WarmUp Plugin (warmer "${warmerName}")`,
-    events: warmerConfig.events,
-    handler: warmerConfig.pathHandler.split(path.sep).join(path.posix.sep),
-    memorySize: warmerConfig.memorySize,
-    name: warmerConfig.name,
-    ...(warmerConfig.architecture ? { architecture: warmerConfig.architecture } : {}),
-    runtime: 'nodejs20.x',
-    package: warmerConfig.package,
-    timeout: warmerConfig.timeout,
-    ...(Object.keys(warmerConfig.environment).length
-      ? { environment: warmerConfig.environment }
-      : {}),
-    ...(warmerConfig.tracing !== undefined ? { tracing: warmerConfig.tracing } : {}),
-    ...(warmerConfig.logRetentionInDays !== undefined
-      ? { logRetentionInDays: warmerConfig.logRetentionInDays }
-      : {}),
-    ...(warmerConfig.roleName ? { roleName: warmerConfig.roleName } : {}),
-    ...(warmerConfig.role ? { role: warmerConfig.role } : {}),
-    ...(warmerConfig.tags ? { tags: warmerConfig.tags } : {}),
-    ...(warmerConfig.vpc ? { vpc: warmerConfig.vpc } : {}),
-    layers: [],
-  };
+	// eslint-disable-next-line no-param-reassign
+	service.functions[`warmUpPlugin${capitalize(warmerName)}`] = {
+		description: `Serverless WarmUp Plugin (warmer "${warmerName}")`,
+		events: warmerConfig.events,
+		handler: warmerConfig.pathHandler.split(path.sep).join(path.posix.sep),
+		memorySize: warmerConfig.memorySize,
+		name: warmerConfig.name,
+		...(warmerConfig.architecture ? { architecture: warmerConfig.architecture } : {}),
+		runtime: 'nodejs24.x',
+		package: warmerConfig.package,
+		timeout: warmerConfig.timeout,
+		...(Object.keys(warmerConfig.environment).length
+			? { environment: warmerConfig.environment }
+			: {}),
+		...(warmerConfig.tracing !== undefined ? { tracing: warmerConfig.tracing } : {}),
+		...(warmerConfig.logRetentionInDays !== undefined
+			? { logRetentionInDays: warmerConfig.logRetentionInDays }
+			: {}),
+		...(warmerConfig.roleName ? { roleName: warmerConfig.roleName } : {}),
+		...(warmerConfig.role ? { role: warmerConfig.role } : {}),
+		...(warmerConfig.tags ? { tags: warmerConfig.tags } : {}),
+		...(warmerConfig.vpc ? { vpc: warmerConfig.vpc } : {}),
+		layers: [],
+	};
 }
 
 module.exports = {
-  addWarmUpFunctionRoleToResources,
-  createWarmUpFunctionArtifact,
-  addWarmUpFunctionToService,
+	addWarmUpFunctionRoleToResources,
+	createWarmUpFunctionArtifact,
+	addWarmUpFunctionToService,
 };

package/.eslintignore

@@ -1,2 +0,0 @@
-coverage
-test_integration