serverless-plugin-warmup 6.2.0 → 7.0.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
@@ -603,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

@@ -1,6 +1,6 @@
 {
   "name": "serverless-plugin-warmup",
-  "version": "6.2.0",
+  "version": "7.0.0",
   "description": "Keep your lambdas warm during winter.",
   "main": "src/index.js",
   "scripts": {

package/src/config.js

@@ -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,
@@ -170,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

@@ -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);
   }
 
   /**
@@ -122,7 +123,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 +138,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 +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,7 +174,7 @@ 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;
     }
 
@@ -183,8 +184,9 @@ class WarmUp {
       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);
 
@@ -209,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 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 +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

@@ -139,6 +139,7 @@ function extendServerlessSchema(serverless) {
     serverless.configSchemaHandler.defineCustomProperties({
       properties: {
         warmup: {
+          type: 'object',
           patternProperties: {
             '.*': {
               type: 'object',
@@ -156,6 +157,7 @@ function extendServerlessSchema(serverless) {
       type: 'object',
       properties: {
         warmup: {
+          type: 'object',
           patternProperties: {
             '.*': {
               type: 'object',