serverless-plugin-warmup 6.0.0 → 6.2.1

package/.eslintignore

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

package/README.md

@@ -9,7 +9,7 @@
 Keep your lambdas warm during winter.
 
 **Requirements:**
-* Serverless *v1.12.x* or higher (Recommended *v1.33.x* or higher because of [this](https://github.com/juanjoDiaz/serverless-plugin-warmup/pull/69)).
+* Serverless *v2.32.x* or higher
 * AWS provider
 
 ## How it works
@@ -43,6 +43,7 @@ custom:
       events:
         - schedule: cron(0/5 8-17 ? * MON-FRI *)
       concurrency: 10
+      logRetentionInDays: 10
     outOfOfficeHoursWarmer:
       enabled: true
       events:
@@ -68,6 +69,7 @@ The options are the same for all the warmers:
 * **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)
+* **logRetentionInDays** Set the retention time in days for the log group associated to this warmer lamba
 * **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.
@@ -103,6 +105,7 @@ custom:
           - ./**
       timeout: 20
       tracing: true
+      logRetentionInDays: 10
       prewarm: true # Run WarmUp immediately after a deploymentlambda
       clientContext:
         source: my-custom-source

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-plugin-warmup",
-  "version": "6.0.0",
+  "version": "6.2.1",
   "description": "Keep your lambdas warm during winter.",
   "main": "src/index.js",
   "scripts": {
@@ -31,8 +31,8 @@
   "homepage": "https://github.com/juanjoDiaz/serverless-plugin-warmup",
   "dependencies": {},
   "devDependencies": {
-    "eslint": "^7.32.0",
-    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint": "^8.5.0",
+    "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.24.2",
     "husky": "^7.0.2",
     "jest": "^27.2.0"

package/src/config.js

@@ -41,6 +41,9 @@ function getWarmerConfig(config, defaultOpts) {
       ? config.environment
       : defaultOpts.environment,
     tracing: (config.tracing !== undefined) ? config.tracing : defaultOpts.tracing,
+    logRetentionInDays: (config.logRetentionInDays !== undefined)
+      ? config.logRetentionInDays
+      : defaultOpts.logRetentionInDays,
     prewarm: (config.prewarm !== undefined) ? config.prewarm : defaultOpts.prewarm,
   };
   /* eslint-enable no-nested-ternary */

package/src/index.js

@@ -116,7 +116,7 @@ class WarmUp {
 
     await Promise.all(foldersToClean.map(async (folderToClean) => {
       try {
-        await fs.rmdir(
+        await fs.rm(
           path.join(this.serviceDir, folderToClean),
           { recursive: true },
         );
@@ -133,7 +133,7 @@ class WarmUp {
         foldersToClean.some((folder) => folder.startsWith('.warmup'))
         && (await fs.readdir(defaultDir)).length === 0
       ) {
-        await fs.rmdir(defaultDir, { recursive: true });
+        await fs.rm(defaultDir, { recursive: true });
       }
     } catch (err) {
       if (err.code !== 'ENOENT') {
@@ -177,6 +177,12 @@ class WarmUp {
       return;
     }
 
+    // Avoid double processing due to the workaround for webpack/bundle plugins
+    // resetting the plugin and ignoring changes
+    if (this.serverless.service.functions[`warmUpPlugin${capitalize(warmerName)}`]) {
+      return;
+    }
+
     this.serverless.cli.log(`WarmUp: Creating warmer "${warmerName}" to warm up ${warmerConfig.functions.length} function${warmerConfig.functions.length === 1 ? '' : 's'}:`);
     warmerConfig.functions.forEach((func) => this.serverless.cli.log(`          * ${func.name}`));
 
@@ -207,7 +213,7 @@ class WarmUp {
       return;
     }
 
-    this.serverless.cli.log(`WarmUp: Prewarming up you functions using warmer "${warmerName}".`);
+    this.serverless.cli.log(`WarmUp: Prewarming up your functions using warmer "${warmerName}".`);
 
     try {
       const { SERVERLESS_ALIAS } = this.serverless.service.getFunction(`warmUpPlugin${capitalize(warmerName)}`).environment || {};

package/src/schema.js

@@ -5,7 +5,7 @@ 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/index.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+\\)$';
@@ -27,59 +27,71 @@ function extendServerlessSchema(serverless) {
       type: 'array',
       items: {
         type: 'object',
-        anyOf: [
-          { type: 'string', pattern: scheduleSyntax },
-          {
-            type: 'object',
-            properties: {
-              rate: { type: 'string', pattern: scheduleSyntax },
-              enabled: { type: 'boolean' },
-              alias: { type: 'string' },
-              name: {
-                type: 'string', minLength: 1, maxLength: 64, pattern: '[\\.\\-_A-Za-z0-9]+',
+        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,
               },
-              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,
       },
     },
     package: {
@@ -95,6 +107,10 @@ function extendServerlessSchema(serverless) {
     timeout: { $ref: '#/definitions/awsLambdaTimeout' },
     environment: { $ref: '#/definitions/awsLambdaEnvironment' },
     tracing: { $ref: '#/definitions/awsLambdaTracing' },
+    logRetentionInDays: {
+      type: 'number',
+      enum: [1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653],
+    },
     prewarm: { type: 'boolean' },
   };
 
@@ -123,10 +139,13 @@ function extendServerlessSchema(serverless) {
     serverless.configSchemaHandler.defineCustomProperties({
       properties: {
         warmup: {
-          '.*': {
-            type: 'object',
-            properties: { ...globalConfigSchemaProperties, ...functionConfigSchemaProperties },
-            additionalProperties: false,
+          type: 'object',
+          patternProperties: {
+            '.*': {
+              type: 'object',
+              properties: { ...globalConfigSchemaProperties, ...functionConfigSchemaProperties },
+              additionalProperties: false,
+            },
           },
         },
       },
@@ -138,10 +157,13 @@ function extendServerlessSchema(serverless) {
       type: 'object',
       properties: {
         warmup: {
-          '.*': {
-            type: 'object',
-            properties: { functionConfigSchemaProperties },
-            additionalProperties: false,
+          type: 'object',
+          patternProperties: {
+            '.*': {
+              type: 'object',
+              properties: functionConfigSchemaProperties,
+              additionalProperties: false,
+            },
           },
         },
       },

package/src/warmer.js

@@ -94,7 +94,7 @@ function addWarmUpFunctionRoleToResources(service, stage, warmerName, warmerConf
                   'lambda:InvokeFunction',
                 ],
                 Resource: warmerConfig.functions.map((fn) => ({
-                  'Fn::Sub': `arn:\${AWS::Partition}:lambda:\${AWS::Region}:\${AWS::AccountId}:function:${fn.name}`,
+                  'Fn::Sub': `arn:\${AWS::Partition}:lambda:\${AWS::Region}:\${AWS::AccountId}:function:${fn.name}*`,
                 })),
               },
               {
@@ -225,9 +225,13 @@ function addWarmUpFunctionToService(service, warmerName, warmerConfig) {
       ? { environment: warmerConfig.environment }
       : {}),
     ...(warmerConfig.tracing !== undefined ? { tracing: warmerConfig.tracing } : {}),
+    ...(warmerConfig.logRetentionInDays !== undefined
+      ? { logRetentionInDays: warmerConfig.logRetentionInDays }
+      : {}),
     ...(warmerConfig.role ? { role: warmerConfig.role } : {}),
     ...(warmerConfig.tags ? { tags: warmerConfig.tags } : {}),
     ...(warmerConfig.vpc ? { vpc: warmerConfig.vpc } : {}),
+    layers: [],
   };
 }