npm - serverless-plugin-warmup - Versions diffs - 5.3.1 → 7.0.0 - Mend

serverless-plugin-warmup 5.3.1 → 7.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/.eslintignore CHANGED Viewed

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

package/LICENSE CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -2,14 +2,15 @@
 [![Serverless][serverless-badge]](serverless-badge-url)
 [![npm version][npm-version-badge]][npm-version-badge-url]
 [![npm monthly downloads][npm-downloads-badge]][npm-version-badge-url]
-[![Build Status][travis-badge]][travis-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)
 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)).
+* Node *v14.x* or higher
+* Serverless *v3.x* or higher
 * AWS provider
 ## How it works
@@ -43,6 +44,7 @@ custom:
       events:
         - schedule: cron(0/5 8-17 ? * MON-FRI *)
       concurrency: 10
+      logRetentionInDays: 10
     outOfOfficeHoursWarmer:
       enabled: true
       events:
@@ -64,10 +66,11 @@ 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)
+* **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.
@@ -97,13 +100,13 @@ 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
+      logRetentionInDays: 10
       prewarm: true # Run WarmUp immediately after a deploymentlambda
       clientContext:
         source: my-custom-source
@@ -450,6 +453,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
@@ -568,8 +604,6 @@ 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
-[travis-badge]: https://travis-ci.org/juanjoDiaz/serverless-plugin-warmup.svg
-[travis-badge-url]: https://travis-ci.org/juanjoDiaz/serverless-plugin-warmup
 [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

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "serverless-plugin-warmup",
-  "version": "5.3.1",
+  "version": "7.0.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.28.0",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-plugin-import": "^2.23.4",
-    "husky": "^6.0.0",
-    "jest": "^27.0.4"
+    "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 CHANGED Viewed

@@ -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,
@@ -44,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 */
@@ -82,7 +82,7 @@ function getFunctionConfig(config, defaultOpts) {
  *
  * @return {Array} - List of functions to be warmed up and their specific configs
  * */
-function getFunctionsByWarmer(service, stage, configsByWarmer) {
+function getFunctionsByWarmer(service, stage, configsByWarmer, serverlessClasses) {
   const functions = service.getAllFunctions()
     .map((name) => service.getFunction(name))
     .map((config) => {
@@ -100,7 +100,7 @@ function getFunctionsByWarmer(service, stage, configsByWarmer) {
       const unknownWarmers = Object.keys(config.warmup)
         .filter((warmerName) => configsByWarmer[warmerName] === undefined);
       if (unknownWarmers.length > 0) {
-        throw new Error(`WarmUp: Invalid function-level warmup configuration (${unknownWarmers.join(', ')}) in function ${config.name}. Every warmer should be declared in the custom section.`);
+        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 {
@@ -137,7 +137,7 @@ function getFunctionsByWarmer(service, stage, configsByWarmer) {
  *
  * @return {Object} - Configuration options to be used by the plugin
  * */
-function getConfigsByWarmer(service, stage) {
+function getConfigsByWarmer({ service, classes }, stage) {
   const getWarmerDefaultOpts = (warmerName) => ({
     folderName: path.join('.warmup', warmerName),
     cleanFolder: true,
@@ -146,13 +146,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 || [])
@@ -176,7 +170,7 @@ function getConfigsByWarmer(service, stage) {
       },
     }), {});
-  const functionsByWarmer = getFunctionsByWarmer(service, stage, configsByWarmer);
+  const functionsByWarmer = getFunctionsByWarmer(service, stage, configsByWarmer, classes);
   return Object.entries(configsByWarmer).reduce((warmers, [warmerName, warmerConfig]) => ({
     ...warmers,

package/src/index.js CHANGED Viewed

@@ -28,12 +28,13 @@ class WarmUp {
    * @constructor
    *
    * @param {!Object} serverless - Serverless object
-   * @param {!Object} options - Serverless options
+   * @param {!Object} cliOptions - Serverless cliOptions
    * */
-  constructor(serverless, options) {
+  constructor(serverless, cliOptions, { log }) {
     /** Serverless variables */
     this.serverless = serverless;
-    this.options = options;
+    this.cliOptions = cliOptions;
+    this.log = log;
     this.provider = this.serverless.getProvider('aws');
@@ -46,7 +47,7 @@ class WarmUp {
           cleanupTempDir: { lifecycleEvents: ['cleanup'] },
           prewarm: {
             lifecycleEvents: ['start', 'end'],
-            options: {
+            cliOptions: {
               warmers: {
                 shortcut: 'w',
                 usage: 'Comma-separated list of warmer names to prewarm.',
@@ -85,7 +86,7 @@ class WarmUp {
   configPlugin() {
     this.stage = this.stage || this.provider.getStage();
     this.configsByWarmer = this.configsByWarmer
-      || getConfigsByWarmer(this.serverless.service, this.stage);
+      || getConfigsByWarmer(this.serverless, this.stage);
   }
   /**
@@ -116,13 +117,13 @@ class WarmUp {
     await Promise.all(foldersToClean.map(async (folderToClean) => {
       try {
-        await fs.rmdir(
+        await fs.rm(
           path.join(this.serviceDir, folderToClean),
           { recursive: true },
         );
       } catch (err) {
         if (err.code !== 'ENOENT') {
-          this.serverless.cli.log(`WarmUp: Couldn't clean up temporary folder ${folderToClean}.`);
+          this.log.error(`WarmUp: Couldn't clean up temporary folder ${folderToClean}.`);
         }
       }
     }));
@@ -133,11 +134,11 @@ 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') {
-        this.serverless.cli.log('WarmUp: Couldn\'t clean up temporary folder .warmup.');
+        this.log.error('WarmUp: Couldn\'t clean up temporary folder .warmup.');
       }
     }
   }
@@ -151,8 +152,8 @@ class WarmUp {
    * @return {Promise}
    * */
   async prewarmFunctions() {
-    const warmerNames = (this.options.warmers)
-      ? this.options.warmers.split(',')
+    const warmerNames = (this.cliOptions.warmers)
+      ? this.cliOptions.warmers.split(',')
       : Object.entries(this.configsByWarmer)
         .filter(([, warmerConfig]) => warmerConfig.prewarm)
         .map(([warmerName]) => warmerName);
@@ -160,7 +161,7 @@ class WarmUp {
     await Promise.all(warmerNames.map(async (warmerName) => {
       const warmerConfig = this.configsByWarmer[warmerName];
       if (!warmerConfig) {
-        throw new Error(`Warmer names ${warmerName} doesn't exist.`);
+        throw new this.serverless.classes.Error(`Warmer names ${warmerName} doesn't exist.`);
       }
       addWarmUpFunctionToService(this.serverless.service, warmerName, warmerConfig);
       await this.invokeWarmer(warmerName, warmerConfig);
@@ -173,12 +174,19 @@ class WarmUp {
    * */
   async configureWarmer(warmerName, warmerConfig) {
     if (warmerConfig.functions.length === 0) {
-      this.serverless.cli.log(`WarmUp: Skipping warmer "${warmerName}" creation. No functions to warm up.`);
+      this.log.warning(`WarmUp: Skipping warmer "${warmerName}" creation. No functions to warm up.`);
       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}`));
+    // 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.log.notice(`WarmUp: Creating warmer "${warmerName}" to warm up ${warmerConfig.functions.length} function${warmerConfig.functions.length === 1 ? '' : 's'}`);
+    this.log.info(':');
+    warmerConfig.functions.forEach((func) => this.log.info(`          * ${func.name}`));
     const handlerFolder = path.join(this.serviceDir, warmerConfig.folderName);
@@ -203,11 +211,11 @@ class WarmUp {
   async invokeWarmer(warmerName, warmerConfig) {
     if (warmerConfig.functions.length === 0) {
-      this.serverless.cli.log(`WarmUp: Skipping prewarming using warmer "${warmerName}". No functions to warm up.`);
+      this.log.warning(`WarmUp: Skipping prewarming using warmer "${warmerName}". No functions to warm up.`);
       return;
     }
-    this.serverless.cli.log(`WarmUp: Prewarming up you functions using warmer "${warmerName}".`);
+    this.log.notice(`WarmUp: Prewarming up your functions using warmer "${warmerName}".`);
     try {
       const { SERVERLESS_ALIAS } = this.serverless.service.getFunction(`warmUpPlugin${capitalize(warmerName)}`).environment || {};
@@ -220,9 +228,9 @@ class WarmUp {
       };
       await this.provider.request('Lambda', 'invoke', params);
-      this.serverless.cli.log(`WarmUp: Warmer "${warmerName}" successfully prewarmed your functions.`);
+      this.log.notice(`WarmUp: Warmer "${warmerName}" successfully prewarmed your functions.`);
     } catch (err) {
-      this.serverless.cli.log(`WarmUp: Error while prewarming your functions using warmer "${warmerName}".`, err);
+      this.log.error(`WarmUp: Error while prewarming your functions using warmer "${warmerName}".`, err);
     }
   }
 }

package/src/schema.js CHANGED Viewed

@@ -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,
@@ -96,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' },
   };
@@ -124,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,
+            },
           },
         },
       },
@@ -139,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 CHANGED Viewed

@@ -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: [],
   };
 }