feat: Configure modern logs

serverless-heaven · Nov 24, 2021 · dcd71f9 · dcd71f9
1 parent a8688ce
commit dcd71f9
Show file tree

Hide file tree

Showing 11 changed files with 418 additions and 124 deletions.
diff --git a/index.js b/index.js
@@ -22,10 +22,15 @@ class ServerlessWebpack {
     return lib;
   }
 
-  constructor(serverless, options) {
+  constructor(serverless, options, v3Utils) {
     this.serverless = serverless;
     this.options = options;
 
+    if (v3Utils) {
+      this.log = v3Utils.log;
+      this.progress = v3Utils.progress;
+    }
+
     if (
       ((_.has(this.serverless, 'service.custom.webpack') &&
         _.isString(this.serverless.service.custom.webpack) &&
@@ -101,7 +106,8 @@ class ServerlessWebpack {
         BbPromise.bind(this)
           .then(() => this.serverless.pluginManager.spawn('webpack:validate'))
           .then(() => (this.skipCompile ? BbPromise.resolve() : this.serverless.pluginManager.spawn('webpack:compile')))
-          .then(() => this.serverless.pluginManager.spawn('webpack:package')),
+          .then(() => this.serverless.pluginManager.spawn('webpack:package'))
+          .then(() => this.log && this.progress.get('webpack').remove()),
 
       'after:package:createDeploymentArtifacts': () => BbPromise.bind(this).then(this.cleanup),
 

diff --git a/index.test.js b/index.test.js
@@ -37,7 +37,7 @@ describe('ServerlessWebpack', () => {
   });
 
   beforeEach(() => {
-    serverless = new Serverless();
+    serverless = new Serverless({ commands: ['print'], options: {} });
     serverless.cli = {
       log: sandbox.stub(),
       consoleLog: sandbox.stub()

diff --git a/lib/cleanup.js b/lib/cleanup.js
@@ -11,16 +11,35 @@ module.exports = {
     const cli = this.options.verbose ? this.serverless.cli : { log: _.noop };
 
     if (!keepOutputDirectory) {
-      cli.log(`Remove ${webpackOutputPath}`);
+      if (this.log) {
+        this.log.verbose(`Remove ${webpackOutputPath}`);
+      } else {
+        cli.log(`Remove ${webpackOutputPath}`);
+      }
       if (this.serverless.utils.dirExistsSync(webpackOutputPath)) {
         // Remove async to speed up process
         fse
           .remove(webpackOutputPath)
-          .then(() => cli.log(`Removing ${webpackOutputPath} done`))
-          .catch(error => cli.log(`Error occurred while removing ${webpackOutputPath}: ${error}`));
+          .then(() => {
+            if (this.log) {
+              this.log.verbose(`Removing ${webpackOutputPath} done`);
+            } else {
+              cli.log(`Removing ${webpackOutputPath} done`);
+            }
+            return null;
+          })
+          .catch(error => {
+            if (this.log) {
+              this.log.error(`Error occurred while removing ${webpackOutputPath}: ${error}`);
+            } else {
+              cli.log(`Error occurred while removing ${webpackOutputPath}: ${error}`);
+            }
+          });
       }
     } else {
-      cli.log(`Keeping ${webpackOutputPath}`);
+      if (!this.log) {
+        cli.log(`Keeping ${webpackOutputPath}`);
+      }
     }
 
     return BbPromise.resolve();

diff --git a/lib/compile.js b/lib/compile.js
@@ -10,9 +10,9 @@ function ensureArray(obj) {
   return _.isArray(obj) ? obj : [obj];
 }
 
-function getStatsLogger(statsConfig, consoleLog) {
+function getStatsLogger(statsConfig, consoleLog, { log, ServerlessError }) {
   return stats => {
-    logStats(stats, statsConfig, consoleLog);
+    logStats(stats, statsConfig, consoleLog, { log, ServerlessError });
   };
 }
 
@@ -79,17 +79,12 @@ function getExternalModules({ compilation }) {
   return Array.from(externals);
 }
 
-function webpackCompile(config, logStats, ServerlessError) {
+function webpackCompile(config, logStats) {
   return BbPromise.fromCallback(cb => webpack(config).run(cb)).then(stats => {
     // ensure stats in any array in the case of concurrent build.
     stats = stats.stats ? stats.stats : [stats];
 
-    _.forEach(stats, compileStats => {
-      logStats(compileStats);
-      if (compileStats.hasErrors()) {
-        throw _.assign(new ServerlessError('Webpack compilation error, see stats above'), { stats: compileStats });
-      }
-    });
+    _.forEach(stats, logStats);
 
     return _.map(stats, compileStats => ({
       outputPath: compileStats.compilation.compiler.outputPath,
@@ -103,39 +98,57 @@ function webpackConcurrentCompile(configs, logStats, concurrency, ServerlessErro
   return BbPromise.map(
     configs,
     config =>
-      webpackCompile(config, logStats, ServerlessError).catch(error => {
+      webpackCompile(config, logStats).catch(error => {
         errors.push(error);
         return error.stats;
       }),
     { concurrency }
   ).then(stats => {
     if (errors.length) {
-      if (errors.length === 1) throw errors[0];
-      throw new ServerlessError('Webpack compilation errors, see stats above');
+      if (!this.log) {
+        if (errors.length === 1) throw errors[0];
+        throw new ServerlessError('Webpack compilation errors, see stats above');
+      }
+      throw new ServerlessError(
+        `Webpack compilation failed:\n\n${_.join(
+          _.map(errors, error => error.message),
+          '\n\n'
+        )}`
+      );
     }
     return _.flatten(stats);
   });
 }
 
 module.exports = {
   compile() {
-    this.serverless.cli.log('Bundling with Webpack...');
+    if (this.log) {
+      this.log.verbose('[Webpack] Building with Webpack');
+      this.progress.get('webpack').update('[Webpack] Building with Webpack');
+    } else {
+      this.serverless.cli.log('Bundling with Webpack...');
+    }
 
     const configs = ensureArray(this.webpackConfig);
     if (configs[0] === undefined) {
       return BbPromise.reject('Unable to find Webpack configuration');
     }
 
-    const logStats = getStatsLogger(configs[0].stats, this.serverless.cli.consoleLog);
+    const logStats = getStatsLogger(configs[0].stats, this.serverless.cli.consoleLog, {
+      log: this.log,
+      ServerlessError: this.serverless.classes.Error
+    });
 
     if (!this.configuration) {
       return BbPromise.reject(new this.serverless.classes.Error('Missing plugin configuration'));
     }
     const concurrency = this.configuration.concurrency;
 
-    return webpackConcurrentCompile(configs, logStats, concurrency, this.serverless.classes.Error).then(stats => {
-      this.compileStats = { stats };
-      return BbPromise.resolve();
-    });
+    return webpackConcurrentCompile
+      .call(this, configs, logStats, concurrency, this.serverless.classes.Error)
+      .then(stats => {
+        this.compileStats = { stats };
+        return BbPromise.resolve();
+      });
   }
 };
diff --git a/lib/logStats.js b/lib/logStats.js
@@ -1,5 +1,6 @@
 'use strict';
 
+const _ = require('lodash');
 const tty = require('tty');
 
 const defaultStatsConfig = {
@@ -10,9 +11,49 @@ const defaultStatsConfig = {
   children: false
 };
 
-module.exports = function (stats, statsConfig, consoleLog) {
+module.exports = function (stats, statsConfig, consoleLog, { log, ServerlessError }) {
   const statsOutput = stats.toString(statsConfig || defaultStatsConfig);
-  if (statsOutput) {
-    consoleLog(statsOutput);
+  if (!log) {
+    if (statsOutput) {
+      consoleLog(statsOutput);
+    }
+  } else {
+    if (statsConfig) {
+      if (!statsOutput) return;
+      log();
+      log(`${_.split(_.trim(statsOutput), '\n').join('\n  ')}`);
+    } else {
+      const warningsOutput = stats.toString({
+        all: false,
+        errors: false,
+        errorsCount: false,
+        warnings: true,
+        warningsCount: false,
+        logging: 'warn'
+      });
+      if (warningsOutput) {
+        log.warning();
+        log.warning(`${_.split(_.trim(_.replace(warningsOutput, /WARNING /g, '')), '\n').join('\n  ')}`);
+      }
+    }
+  }
+  if (!stats.hasErrors()) return;
+  if (!log) {
+    throw _.assign(new ServerlessError('Webpack compilation error, see stats above'), { stats });
+  }
+  const errorsOutput = stats.toString({
+    all: false,
+    errors: true,
+    errorsCount: false,
+    errorDetails: true,
+    warnings: false,
+    warningsCount: false,
+    logging: 'error'
+  });
+  if (errorsOutput) {
+    throw _.assign(
+      new ServerlessError(`${_.split(_.trim(_.replace(errorsOutput, /ERROR /g, '')), '\n').join('\n  ')}`),
+      { stats }
+    );
   }
 };