serverless-plugin-warmup 7.3.0 → 8.1.0

package/README.md

@@ -4,13 +4,13 @@
 [![npm monthly downloads][npm-downloads-badge]][npm-version-badge-url]
 [![Node.js CI](https://github.com/juanjoDiaz/serverless-plugin-warmup/actions/workflows/on-push.yaml/badge.svg)](https://github.com/juanjoDiaz/serverless-plugin-warmup/actions/workflows/on-push.yaml)
 [![Coverage Status][coveralls-badge]][coveralls-badge-url]
-[![license](https://img.shields.io/npm/l/serverless-plugin-warmup.svg)](https://raw.githubusercontent.com/juanjoDiaz/serverless-plugin-warmup/master/LICENSE)
+[![license](https://img.shields.io/npm/l/serverless-plugin-warmup.svg)](https://raw.githubusercontent.com/juanjoDiaz/serverless-plugin-warmup/main/LICENSE)
 
 Keep your lambdas warm during winter.
 
 **Requirements:**
 * Node *v14.x* or higher
-* Serverless *v3.x* or higher
+* Serverless *v3.8* or higher
 * AWS provider
 
 ## How it works
@@ -45,7 +45,7 @@ custom:
         - schedule: cron(0/5 8-17 ? * MON-FRI *)
       concurrency: 10
       verbose: true
-      logRetentionInDays: 10
+      logRetentionInDays: 14
     outOfOfficeHoursWarmer:
       enabled: true
       events:
@@ -63,18 +63,19 @@ The options are the same for all the warmers:
 * **folderName** Folder to temporarily store the generated code (defaults to `.warmup`)
 * **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)
 * **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`)
 * **events** The event that triggers the warmer lambda. Can be any [Serverless event](https://serverless.com/framework/docs/providers/aws/events/) (defaults to `- schedule: rate(5 minutes)`)
-* **architecture**  The [instruction set to use for the lambda](https://www.serverless.com/framework/docs/providers/aws/guide/functions#instruction-set-architecture) (defaults to `arm64`)
+* **architecture**  The [instruction set to use for the lambda](https://www.serverless.com/framework/docs/providers/aws/guide/functions#instruction-set-architecture) (defaults to `x86_64`)
 * **package** The package configuration. Can be any [Serverless package configuration](https://serverless.com/framework/docs/providers/aws/guide/packaging#package-configuration) (defaults to `{ individually: true, patterns: ['!**', '.warmup/${warmerName}/**'] }`)
 * **timeout** How many seconds until the warmer lambda times out. (defaults to `10`)
 * **environment** Can be used to set environment variables in the warmer lambda. You can also unset variables configured at the provider by setting them to undefined. However, you should almost never have to change the default. (defaults to unset all package level environment variables. )
 * **tracing** Specify whether to enable/disable tracing at the function level. When tracing is enabled, warmer functions will use NPM to install the X-Ray client and use it to trace requests (It takes any of the values supported by serverless as `boolean`, `Active`or `PassThrough` and defaults to the provider-level setting)
 * **verbose** If set to false, it disables the console.logs placed on this warmer lambda (defaults to `true`)
-* **logRetentionInDays** Set the retention time in days for the log group associated to this warmer lamba
+* **logRetentionInDays** Set the retention time in days for the log group associated to this warmer lamba. Can be any of the values specified in the [AWS documentation](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutRetentionPolicy.html#API_PutRetentionPolicy_RequestSyntax).
 * **prewarm** If set to true, it warms up your lambdas right after deploying (defaults to `false`)
 
 There are also some options which can be set under `custom.warmup.<yourWarmer>` to be applied to all your lambdas or under `yourLambda.warmup.<yourWarmer>` to  overridde the global configuration for that particular lambda. Keep in mind that in order to configure a warmer at the function level, it needed to be previously configured at the `custom` section or the pluging will error.
@@ -95,6 +96,7 @@ custom:
       cleanFolder: false
       memorySize: 256
       name: warmer-default
+      roleName: my-custom-role
       role: WarmupRole
       tags:
         Project: foo
@@ -111,7 +113,7 @@ custom:
       timeout: 20
       tracing: true
       verbose: false # Disable the logs
-      logRetentionInDays: 10
+      logRetentionInDays: 14
       prewarm: true # Run WarmUp immediately after a deploymentlambda
       clientContext:
         source: my-custom-source
@@ -610,8 +612,8 @@ This software is released under the MIT license. See [the license file](LICENSE)
 [npm-version-badge]: https://badge.fury.io/js/serverless-plugin-warmup.svg
 [npm-version-badge-url]: https://www.npmjs.com/package/serverless-plugin-warmup
 [npm-downloads-badge]: https://img.shields.io/npm/dm/serverless-plugin-warmup.svg
-[coveralls-badge]: https://coveralls.io/repos/juanjoDiaz/serverless-plugin-warmup/badge.svg?branch=master
-[coveralls-badge-url]: https://coveralls.io/r/juanjoDiaz/serverless-plugin-warmup?branch=master
+[coveralls-badge]: https://coveralls.io/repos/juanjoDiaz/serverless-plugin-warmup/badge.svg?branch=main
+[coveralls-badge-url]: https://coveralls.io/r/juanjoDiaz/serverless-plugin-warmup?branch=main
 
 ## Acknowledgements
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-plugin-warmup",
-  "version": "7.3.0",
+  "version": "8.1.0",
   "description": "Keep your lambdas warm during winter.",
   "main": "src/index.js",
   "scripts": {
@@ -35,6 +35,6 @@
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.24.2",
     "husky": "^8.0.1",
-    "jest": "^28.1.3"
+    "jest": "^29.1.2"
   }
 }

package/src/config.js

@@ -15,6 +15,7 @@ function getWarmerConfig(config, defaultOpts) {
     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: [] }

package/src/schema.js

@@ -15,6 +15,7 @@ function extendServerlessSchema(serverless) {
     folderName: { type: 'string' },
     cleanFolder: { type: 'boolean' },
     name: { type: 'string' },
+    roleName: { type: 'string' },
     role: { $ref: '#/definitions/awsLambdaRole' },
     tags: { $ref: '#/definitions/awsResourceTags' },
     vpc: {
@@ -109,10 +110,7 @@ function extendServerlessSchema(serverless) {
     environment: { $ref: '#/definitions/awsLambdaEnvironment' },
     tracing: { $ref: '#/definitions/awsLambdaTracing' },
     verbose: { type: 'boolean' },
-    logRetentionInDays: {
-      type: 'number',
-      enum: [1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653],
-    },
+    logRetentionInDays: { $ref: '#/definitions/awsLogRetentionInDays' },
     prewarm: { type: 'boolean' },
   };
 

package/src/warmer.js

@@ -26,7 +26,7 @@ function addWarmUpFunctionRoleToResources(service, stage, warmerName, warmerConf
     Type: 'AWS::IAM::Role',
     Properties: {
       Path: '/',
-      RoleName: {
+      RoleName: warmerConfig.roleName || {
         'Fn::Join': [
           '-',
           [
@@ -233,6 +233,7 @@ function addWarmUpFunctionToService(service, warmerName, warmerConfig) {
     ...(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 } : {}),