serverless-plugin-warmup 5.2.3 → 6.1.0

package/.eslintignore

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

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Juanjo Diaz
+Copyright (c) 2021 Juanjo Diaz
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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
@@ -64,7 +64,7 @@ The options are the same for all the warmers:
 * **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)`)
-* **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, exclude: ['**'], include: ['.warmup/${warmerName}/**'] }`)
+* **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)
@@ -97,10 +97,9 @@ custom:
         - schedule: 'cron(0/5 8-17 ? * MON-FRI *)' # Run WarmUp every 5 minutes Mon-Fri between 8:00am and 5:55pm (UTC)
       package:
         individually: true
-        exclude: # exclude additional binaries that are included at the serverless package level
-          - ../**
-          - ../../**
-        include:
+        patterns:
+          - '!../**'
+          - '!../../**'
           - ./**
       timeout: 20
       tracing: true
@@ -191,7 +190,7 @@ If no role is provided at the `custom.warmup` level, each warmer function gets a
 * Invoke the functions that it should warm (and only those)
 * Create and attach elastic network interfaces (ENIs) which is necessary if deploying to a VPC
 
-The default role looks like:
+The default role for each warmer looks like:
 
 ```yaml
 resources:
@@ -219,18 +218,20 @@ resources:
                     - logs:CreateLogGroup
                     - logs:CreateLogStream
                   Resource: 
-                    - !Sub arn:aws:logs:${AWS::Region}:${AWS::AccountId}:log-group:/aws/${self:service}-${opt:stage, self:provider.stage}/*:*
+                    - !Sub arn:aws:logs:${AWS::Region}:${AWS::AccountId}:log-group:/aws/lambda/${warmer.name}:*
                 - Effect: Allow
                   Action:
                     - logs:PutLogEvents
                   Resource: 
-                    - !Sub arn:aws:logs:${AWS::Region}:${AWS::AccountId}:log-group:/aws/${self:service}-${opt:stage, self:provider.stage}/*:*:*
+                    - !Sub arn:aws:logs:${AWS::Region}:${AWS::AccountId}:log-group:/aws/lambda/${warmer.name}:*:*
                 # Warmer lambda to invoke the functions to be warmed
                 - Effect: 'Allow'
                   Action:
                     - lambda:InvokeFunction
                   Resource:
-                    - !Sub arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${self:service}-${opt:stage, self:provider.stage}-*
+                    - !Sub arn:${AWS::Partition}:lambda:${AWS::Region}:${AWS::AccountId}:function:${fn1.name}
+                    - !Sub arn:${AWS::Partition}:lambda:${AWS::Region}:${AWS::AccountId}:function:${fn2.name}
+                    # and one more row for each function that must be warmed up by the warmer
                 # Warmer lambda to manage ENIS (only needed if deploying to VPC, https://docs.aws.amazon.com/lambda/latest/dg/vpc.html)
                 - Effect: Allow
                   Action:
@@ -448,6 +449,39 @@ The `warmers` flag takes a comma-separated list of warmer names. If it's nor pro
 
 ## Migrations
 
+### v5.X to v6.X
+
+#### Removed include/exclude in favour of patterns
+
+From Serverless 2.32.0 the `patterns` option is the recommended approach to include/exclude files from packaging. In version 3.X, the `include` and `exclude` are removed.
+
+This plugin applies the same philosophy.
+
+What used to be:
+```yaml
+custom:
+  warmup:
+    default:
+      enabled: 'prod'
+      package:
+        individually: true
+        exclude: '../**',
+        include: 'myFolder'
+```
+
+is the same as
+```yaml
+custom:
+  warmup:
+    default:
+      enabled: 'prod'
+      package:
+        individually: true
+        patterns:
+          - '!../**',
+          - 'myFolder'
+```
+
 ### v4.X to v5.X
 
 #### Support multiple warmer

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-plugin-warmup",
-  "version": "5.2.3",
+  "version": "6.1.0",
   "description": "Keep your lambdas warm during winter.",
   "main": "src/index.js",
   "scripts": {
@@ -31,10 +31,10 @@
   "homepage": "https://github.com/juanjoDiaz/serverless-plugin-warmup",
   "dependencies": {},
   "devDependencies": {
-    "eslint": "^7.24.0",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-plugin-import": "^2.22.1",
-    "husky": "^6.0.0",
-    "jest": "^26.6.3"
+    "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

@@ -25,18 +25,15 @@ function getWarmerConfig(config, defaultOpts) {
         individually: (config.package.individually !== undefined)
           ? config.package.individually
           : defaultOpts.package.individually,
-        exclude: Array.isArray(config.package.exclude)
-          ? config.package.exclude
-          : defaultOpts.package.exclude,
-        include: Array.isArray(config.package.include)
-          ? (config.package.include.includes(path.join(folderName, '**'))
-            ? config.package.include
-            : [...config.package.include, path.join(folderName, '**')])
-          : [...defaultOpts.package.include, path.join(folderName, '**')],
+        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,
-        include: [...defaultOpts.package.include, path.join(folderName, '**')],
+        patterns: ['!**', ...defaultOpts.package.patterns, path.join(folderName, '**')],
       },
     memorySize: (config.memorySize !== undefined) ? config.memorySize : defaultOpts.memorySize,
     timeout: (config.timeout !== undefined) ? config.timeout : defaultOpts.timeout,
@@ -146,13 +143,7 @@ function getConfigsByWarmer(service, stage) {
     events: [{ schedule: 'rate(5 minutes)' }],
     package: {
       individually: true,
-      // Negating the includes to work around https://github.com/serverless/serverless/issues/8093
-      include: service.package && service.package.include
-        ? service.package.include
-          .filter((pattern) => !pattern.startsWith('!'))
-          .map((pattern) => `!${pattern}`)
-        : [],
-      exclude: ['**'],
+      patterns: [],
     },
     timeout: 10,
     environment: Object.keys(service.provider.environment || [])

package/src/index.js

@@ -63,6 +63,7 @@ class WarmUp {
       'after:package:initialize': () => this.serverless.pluginManager.spawn('warmup:addWarmers'),
       'after:package:createDeploymentArtifacts': () => this.serverless.pluginManager.spawn('warmup:cleanupTempDir'),
       'after:deploy:deploy': () => this.serverless.pluginManager.spawn('warmup:prewarm'),
+      'after:deploy:function:deploy': () => this.serverless.pluginManager.spawn('warmup:prewarm'),
       'before:warmup:addWarmers:addWarmers': this.configPlugin.bind(this),
       'warmup:addWarmers:addWarmers': this.initializeWarmers.bind(this),
       'before:warmup:cleanupTempDir:cleanup': this.configPlugin.bind(this),
@@ -115,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 },
         );
@@ -132,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') {
@@ -176,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}`));
 
@@ -206,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,67 +27,78 @@ 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: {
       type: 'object',
       properties: {
         artifact: { type: 'string' },
-        exclude: { type: 'array', items: { type: 'string' } },
-        include: { type: 'array', items: { type: 'string' } },
+        patterns: { type: 'array', items: { type: 'string' } },
         individually: { type: 'boolean' },
       },
       additionalProperties: false,
@@ -124,10 +135,12 @@ function extendServerlessSchema(serverless) {
     serverless.configSchemaHandler.defineCustomProperties({
       properties: {
         warmup: {
-          '.*': {
-            type: 'object',
-            properties: { ...globalConfigSchemaProperties, ...functionConfigSchemaProperties },
-            additionalProperties: false,
+          patternProperties: {
+            '.*': {
+              type: 'object',
+              properties: { ...globalConfigSchemaProperties, ...functionConfigSchemaProperties },
+              additionalProperties: false,
+            },
           },
         },
       },
@@ -139,10 +152,12 @@ function extendServerlessSchema(serverless) {
       type: 'object',
       properties: {
         warmup: {
-          '.*': {
-            type: 'object',
-            properties: { functionConfigSchemaProperties },
-            additionalProperties: false,
+          patternProperties: {
+            '.*': {
+              type: 'object',
+              properties: { functionConfigSchemaProperties },
+              additionalProperties: false,
+            },
           },
         },
       },

package/src/warmer.js

@@ -128,7 +128,7 @@ function addWarmUpFunctionRoleToResources(service, stage, warmerName, warmerConf
 async function createWarmUpFunctionArtifact(functions, tracing, region, handlerFolder) {
   const warmUpFunction = `'use strict';
 
-/** Generated by Serverless WarmUp Plugin at ${new Date().toISOString()} */
+/** Generated by Serverless WarmUp Plugin **/
 
 ${tracing
     ? `const AWSXRay = require('aws-xray-sdk-core');
@@ -228,6 +228,7 @@ function addWarmUpFunctionToService(service, warmerName, warmerConfig) {
     ...(warmerConfig.role ? { role: warmerConfig.role } : {}),
     ...(warmerConfig.tags ? { tags: warmerConfig.tags } : {}),
     ...(warmerConfig.vpc ? { vpc: warmerConfig.vpc } : {}),
+    layers: [],
   };
 }