serverless-plugin-warmup 6.2.0 → 7.1.0

package/README.md

@@ -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 *v2.32.x* or higher
+* 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
+      verbose: true
       logRetentionInDays: 10
     outOfOfficeHoursWarmer:
       enabled: true
@@ -51,6 +53,7 @@ custom:
         - schedule: cron(0/5 18-23 ? * MON-FRI *)
         - schedule: cron(0/5 * ? * SAT-SUN *)
       concurrency: 1
+      verbose: false
     testWarmer:
       enabled: false
 ```
@@ -69,6 +72,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)
+* **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
 * **prewarm** If set to true, it warms up your lambdas right after deploying (defaults to `false`)
 
@@ -105,6 +109,7 @@ custom:
           - ./**
       timeout: 20
       tracing: true
+      verbose: false # Disable the logs
       logRetentionInDays: 10
       prewarm: true # Run WarmUp immediately after a deploymentlambda
       clientContext:
@@ -603,8 +608,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

@@ -1,6 +1,6 @@
 {
   "name": "serverless-plugin-warmup",
-  "version": "6.2.0",
+  "version": "7.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": "^7.0.2",
-    "jest": "^27.2.0"
+    "jest": "^27.5.0"
   }
 }

package/src/config.js

@@ -41,6 +41,7 @@ function getWarmerConfig(config, defaultOpts) {
       ? config.environment
       : defaultOpts.environment,
     tracing: (config.tracing !== undefined) ? config.tracing : defaultOpts.tracing,
+    verbose: (config.verbose !== undefined) ? config.verbose : defaultOpts.verbose,
     logRetentionInDays: (config.logRetentionInDays !== undefined)
       ? config.logRetentionInDays
       : defaultOpts.logRetentionInDays,
@@ -82,7 +83,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 +101,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 +138,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,
@@ -151,6 +152,7 @@ function getConfigsByWarmer(service, stage) {
     timeout: 10,
     environment: Object.keys(service.provider.environment || [])
       .reduce((obj, k) => ({ ...obj, [k]: undefined }), {}),
+    verbose: true,
     prewarm: false,
   });
 
@@ -170,7 +172,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

@@ -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.',
@@ -70,8 +71,8 @@ class WarmUp {
       'warmup:cleanupTempDir:cleanup': this.cleanUp.bind(this),
       'before:warmup:prewarm:start': this.configPlugin.bind(this),
       'warmup:prewarm:start': this.prewarmFunctions.bind(this),
-      // Workaround webpack/bundle plugins, reset the plugin and ignore changes
-      'before:package:createDeploymentArtifacts': this.initializeWarmers.bind(this),
+      // Workaround webpack/bundle plugins and serverless_sdk
+      'before:package:createDeploymentArtifacts': this.resetWarmerConfigs.bind(this),
     };
 
     // Fixed for issues in Serverles
@@ -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);
   }
 
   /**
@@ -101,6 +102,23 @@ class WarmUp {
       .map(([warmerName, warmerConfig]) => this.configureWarmer(warmerName, warmerConfig)));
   }
 
+  /**
+   * @description Workaround webpack/bundle plugins and serverless_sdk.
+   * Reset the plugin and ignore changes
+   *
+   * @fulfil {} — Warm up set
+   * @reject {Error} Warm up error
+   *
+   * @return {Promise}
+   * */
+  async resetWarmerConfigs() {
+    Object.entries(this.configsByWarmer)
+      .forEach(([warmerName, warmerConfig]) => {
+        if (warmerConfig.functions.length === 0) return;
+        addWarmUpFunctionToService(this.serverless.service, warmerName, warmerConfig);
+      });
+  }
+
   /**
    * @description Warmup cleanup hook.
    *
@@ -122,7 +140,7 @@ class WarmUp {
         );
       } 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}.`);
         }
       }
     }));
@@ -137,7 +155,7 @@ class WarmUp {
       }
     } 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 +169,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 +178,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,24 +191,20 @@ 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.`);
-      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)}`]) {
+      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}`));
+    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);
 
     await createWarmUpFunctionArtifact(
       warmerConfig.functions,
       warmerConfig.tracing,
+      warmerConfig.verbose,
       this.provider.getRegion(),
       handlerFolder,
     );
@@ -209,11 +223,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 your 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 || {};
@@ -226,9 +240,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

@@ -107,6 +107,7 @@ function extendServerlessSchema(serverless) {
     timeout: { $ref: '#/definitions/awsLambdaTimeout' },
     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],
@@ -139,6 +140,7 @@ function extendServerlessSchema(serverless) {
     serverless.configSchemaHandler.defineCustomProperties({
       properties: {
         warmup: {
+          type: 'object',
           patternProperties: {
             '.*': {
               type: 'object',
@@ -156,6 +158,7 @@ function extendServerlessSchema(serverless) {
       type: 'object',
       properties: {
         warmup: {
+          type: 'object',
           patternProperties: {
             '.*': {
               type: 'object',

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}*`,
                 })),
               },
               {
@@ -125,7 +125,7 @@ function addWarmUpFunctionRoleToResources(service, stage, warmerName, warmerConf
  *
  * @return {Promise}
  * */
-async function createWarmUpFunctionArtifact(functions, tracing, region, handlerFolder) {
+async function createWarmUpFunctionArtifact(functions, tracing, verbose, region, handlerFolder) {
   const warmUpFunction = `'use strict';
 
 /** Generated by Serverless WarmUp Plugin **/
@@ -143,28 +143,32 @@ const lambda = new AWS.Lambda({
 });
 const functions = ${JSON.stringify(functions, null, '  ')};
 
+function logVerbose(str) {
+  ${verbose ? 'console.log(str);' : ''}
+}
+
 function getConcurrency(func, envVars) {
   const functionConcurrency = envVars[\`WARMUP_CONCURRENCY_\${func.name.toUpperCase().replace(/-/g, '_')}\`];
 
   if (functionConcurrency) {
     const concurrency = parseInt(functionConcurrency);
-    console.log(\`Warming up function: \${func.name} with concurrency: \${concurrency} (from function-specific environment variable)\`);
+    logVerbose(\`Warming up function: \${func.name} with concurrency: \${concurrency} (from function-specific environment variable)\`);
     return concurrency;
   }
 
   if (envVars.WARMUP_CONCURRENCY) {
     const concurrency = parseInt(envVars.WARMUP_CONCURRENCY);
-    console.log(\`Warming up function: \${func.name} with concurrency: \${concurrency} (from global environment variable)\`);
+    logVerbose(\`Warming up function: \${func.name} with concurrency: \${concurrency} (from global environment variable)\`);
     return concurrency;
   }
 
   const concurrency = parseInt(func.config.concurrency);
-  console.log(\`Warming up function: \${func.name} with concurrency: \${concurrency}\`);
+  logVerbose(\`Warming up function: \${func.name} with concurrency: \${concurrency}\`);
   return concurrency;
 }
 
 module.exports.warmUp = async (event, context) => {
-  console.log('Warm Up Start');
+  logVerbose('Warm Up Start');
 
   const invokes = await Promise.all(functions.map(async (func) => {
     const concurrency = getConcurrency(func, process.env);
@@ -186,15 +190,15 @@ module.exports.warmUp = async (event, context) => {
 
     try {
       await Promise.all(Array(concurrency).fill(0).map(async () => await lambda.invoke(params).promise()));
-      console.log(\`Warm Up Invoke Success: \${func.name}\`);
+      logVerbose(\`Warm Up Invoke Success: \${func.name}\`);
       return true;
     } catch (e) {
-      console.log(\`Warm Up Invoke Error: \${func.name}\`, e);
+      console.error(\`Warm Up Invoke Error: \${func.name}\`, e);
       return false;
     }
   }));
 
-  console.log(\`Warm Up Finished with \${invokes.filter(r => !r).length} invoke errors\`);
+  logVerbose(\`Warm Up Finished with \${invokes.filter(r => !r).length} invoke errors\`);
 }`;
 
   /** Write warm up file */