Feat: Serverless v3 logs (floydspace#282)

* chore: bump @types/serverless to 3.0.0 * feat(logger): add new backward-compatible log interface * feat(logger): use new backward-compatible logger
mishabruml · Feb 26, 2022 · e9b1196 · e9b1196
1 parent c30bf53
commit e9b1196
Show file tree

Hide file tree

Showing 9 changed files with 82 additions and 54 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -49,7 +49,7 @@
     "@types/node": "^12.12.38",
     "@types/ramda": "0.27.40",
     "@types/semver": "^7.3.8",
-    "@types/serverless": "^1.78.25",
+    "@types/serverless": "^3.0.0",
     "@typescript-eslint/eslint-plugin": "^4.2.0",
     "@typescript-eslint/parser": "^4.2.0",
     "esbuild": "^0.14.2",

diff --git a/src/helper.ts b/src/helper.ts
@@ -3,6 +3,7 @@ import path from 'path';
 import os from 'os';
 import { uniq } from 'ramda';
 import Serverless from 'serverless';
+import ServerlessPlugin from 'serverless/classes/Plugin';
 import matchAll from 'string.prototype.matchall';
 import { DependencyMap } from './types';
 
@@ -145,3 +146,16 @@ export const providerRuntimeMatcher = Object.freeze({
     'nodejs12.x': 'node12',
   },
 });
+
+export const buildServerlessV3LoggerFromLegacyLogger = (
+  legacyLogger: (text: string) => void,
+  verbose?: boolean
+): ServerlessPlugin.Logging['log'] => ({
+  error: legacyLogger,
+  warning: legacyLogger,
+  notice: legacyLogger,
+  info: legacyLogger,
+  debug: legacyLogger,
+  verbose: verbose ? legacyLogger : () => null,
+  success: legacyLogger,
+});
diff --git a/src/index.ts b/src/index.ts
@@ -8,7 +8,11 @@ import Serverless from 'serverless';
 import ServerlessPlugin from 'serverless/classes/Plugin';
 import chokidar from 'chokidar';
 
-import { extractFileNames, providerRuntimeMatcher } from './helper';
+import {
+  buildServerlessV3LoggerFromLegacyLogger,
+  extractFileNames,
+  providerRuntimeMatcher,
+} from './helper';
 import { packExternalModules } from './pack-externals';
 import { pack } from './pack';
 import { preOffline } from './pre-offline';
@@ -44,6 +48,7 @@ class EsbuildServerlessPlugin implements ServerlessPlugin {
   serviceDirPath: string;
   workDirPath: string;
   buildDirPath: string;
+  log: ServerlessPlugin.Logging['log'];
 
   serverless: Serverless;
   options: OptionsExtended;
@@ -54,9 +59,16 @@ class EsbuildServerlessPlugin implements ServerlessPlugin {
   preOffline: () => Promise<void>;
   preLocal: () => void;
 
-  constructor(serverless: Serverless, options: OptionsExtended) {
+  constructor(
+    serverless: Serverless,
+    options: OptionsExtended,
+    logging?: ServerlessPlugin.Logging
+  ) {
     this.serverless = serverless;
     this.options = options;
+    this.log =
+      logging?.log ||
+      buildServerlessV3LoggerFromLegacyLogger(this.serverless.cli.log, this.options.verbose);
     this.packExternalModules = packExternalModules.bind(this);
     this.pack = pack.bind(this);
     this.preOffline = preOffline.bind(this);
@@ -202,10 +214,8 @@ class EsbuildServerlessPlugin implements ServerlessPlugin {
 
     chokidar.watch(this.buildOptions.watch.pattern, options).on('all', () =>
       this.bundle(true)
-        .then(() => this.serverless.cli.log('Watching files for changes...'))
-        .catch(() =>
-          this.serverless.cli.log('Bundle error, waiting for a file change to reload...')
-        )
+        .then(() => this.log.verbose('Watching files for changes...'))
+        .catch(() => this.log.error('Bundle error, waiting for a file change to reload...'))
     );
   }
 
@@ -241,7 +251,7 @@ class EsbuildServerlessPlugin implements ServerlessPlugin {
 
   async bundle(incremental = false): Promise<BuildResult[]> {
     this.prepare();
-    this.serverless.cli.log(`Compiling to ${this.buildOptions.target} bundle with esbuild...`);
+    this.log.verbose(`Compiling to ${this.buildOptions.target} bundle with esbuild...`);
     if (this.buildOptions.disableIncremental === true) {
       incremental = false;
     }
@@ -295,13 +305,11 @@ class EsbuildServerlessPlugin implements ServerlessPlugin {
 
       return { result, bundlePath, func, functionAlias };
     };
-    this.serverless.cli.log(
-      `Compiling with concurrency: ${this.buildOptions.concurrency ?? 'Infinity'}`
-    );
+    this.log.verbose(`Compiling with concurrency: ${this.buildOptions.concurrency ?? 'Infinity'}`);
     this.buildResults = await pMap(this.rootFileNames, bundleMapper, {
       concurrency: this.buildOptions.concurrency,
     });
-    this.serverless.cli.log('Compiling completed.');
+    this.log.verbose('Compiling completed.');
     return this.buildResults.map((r) => r.result);
   }
 

diff --git a/src/pack-externals.ts b/src/pack-externals.ts
@@ -90,10 +90,9 @@ function getProdModules(
       !packageJson.dependencies[externalModule.external] &&
       !packageJson.devDependencies[externalModule.external]
     ) {
-      this.options.verbose &&
-        this.serverless.cli.log(
-          `INFO: Runtime dependency '${externalModule.external}' not found in dependencies or devDependencies. It has been excluded automatically.`
-        );
+      this.log.verbose(
+        `INFO: Runtime dependency '${externalModule.external}' not found in dependencies or devDependencies. It has been excluded automatically.`
+      );
 
       return;
     }
@@ -109,18 +108,17 @@ function getProdModules(
 
       if (!includes(externalModule.external, ignoredDevDependencies)) {
         // Runtime dependency found in devDependencies but not forcefully excluded
-        this.serverless.cli.log(
+        this.log.error(
           `ERROR: Runtime dependency '${externalModule.external}' found in devDependencies.`
         );
         throw new this.serverless.classes.Error(
           `Serverless-webpack dependency error: ${externalModule.external}.`
         );
       }
 
-      this.options.verbose &&
-        this.serverless.cli.log(
-          `INFO: Runtime dependency '${externalModule.external}' found in devDependencies. It has been excluded automatically.`
-        );
+      this.log.verbose(
+        `INFO: Runtime dependency '${externalModule.external}' found in devDependencies. It has been excluded automatically.`
+      );
 
       return;
     }
@@ -167,10 +165,9 @@ function getProdModules(
       );
 
       if (!isEmpty(peerDependenciesWithoutOptionals)) {
-        this.options.verbose &&
-          this.serverless.cli.log(
-            `Adding explicit non-optionals peers for dependency ${externalModule.external}`
-          );
+        this.log.verbose(
+          `Adding explicit non-optionals peers for dependency ${externalModule.external}`
+        );
         const peerModules = getProdModules.call(
           this,
           compose(
@@ -183,7 +180,7 @@ function getProdModules(
         Array.prototype.push.apply(prodModules, peerModules);
       }
     } catch (e) {
-      this.serverless.cli.log(
+      this.log.warning(
         `WARNING: Could not check for peer dependencies of ${externalModule.external}`
       );
     }
@@ -270,12 +267,11 @@ export async function packExternalModules(this: EsbuildServerlessPlugin) {
   const packageSections = pick(sectionNames, packageJson);
 
   if (!isEmpty(packageSections)) {
-    this.options.verbose &&
-      this.serverless.cli.log(`Using package.json sections ${join(', ', keys(packageSections))}`);
+    this.log.verbose(`Using package.json sections ${join(', ', keys(packageSections))}`);
   }
 
   // Get first level dependency graph
-  this.options.verbose && this.serverless.cli.log(`Fetch dependency graph from ${packageJson}`);
+  this.log.verbose(`Fetch dependency graph from ${packageJson}`);
 
   // (1) Generate dependency composition
   const externalModules = map((external) => ({ external }), externals);
@@ -285,7 +281,7 @@ export async function packExternalModules(this: EsbuildServerlessPlugin) {
 
   if (isEmpty(compositeModules)) {
     // The compiled code does not reference any external modules at all
-    this.serverless.cli.log('No external modules needed');
+    this.log.warning('No external modules needed');
     return;
   }
 
@@ -315,7 +311,7 @@ export async function packExternalModules(this: EsbuildServerlessPlugin) {
   const packageLockPath = path.join(path.dirname(packageJsonPath), packager.lockfileName);
   const exists = await fse.pathExists(packageLockPath);
   if (exists) {
-    this.serverless.cli.log('Package lock found - Using locked versions');
+    this.log.verbose('Package lock found - Using locked versions');
     try {
       let packageLockFile = this.serverless.utils.readFileSync(packageLockPath);
       packageLockFile = packager.rebaseLockfile(relativePath, packageLockFile);
@@ -328,7 +324,7 @@ export async function packExternalModules(this: EsbuildServerlessPlugin) {
         packageLockFile as string
       );
     } catch (err) {
-      this.serverless.cli.log(`Warning: Could not read lock file: ${err.message}`);
+      this.log.warning(`Warning: Could not read lock file: ${err.message}`);
     }
   }
 
@@ -339,28 +335,26 @@ export async function packExternalModules(this: EsbuildServerlessPlugin) {
   }
 
   const start = Date.now();
-  this.serverless.cli.log('Packing external modules: ' + compositeModules.join(', '));
+  this.log.verbose('Packing external modules: ' + compositeModules.join(', '));
   const installExtraArgs = this.buildOptions.installExtraArgs;
   await packager.install(compositeModulePath, installExtraArgs, exists);
-  this.options.verbose && this.serverless.cli.log(`Package took [${Date.now() - start} ms]`);
+  this.log.verbose(`Package took [${Date.now() - start} ms]`);
 
   // Prune extraneous packages - removes not needed ones
   const startPrune = Date.now();
   await packager.prune(compositeModulePath);
-  this.options.verbose &&
-    this.serverless.cli.log(`Prune: ${compositeModulePath} [${Date.now() - startPrune} ms]`);
+
+  this.log.verbose(`Prune: ${compositeModulePath} [${Date.now() - startPrune} ms]`);
 
   // Run packager scripts
   if (Object.keys(packagerScripts).length > 0) {
     const startScripts = Date.now();
     await packager.runScripts(this.buildDirPath, Object.keys(packagerScripts));
-    this.options.verbose &&
-      this.serverless.cli.log(
-        `Packager scripts took [${
-          Date.now() - startScripts
-        } ms].\nExecuted scripts: ${Object.values(packagerScripts).map(
-          (script) => `\n  ${script}`
-        )}`
-      );
+
+    this.log.verbose(
+      `Packager scripts took [${Date.now() - startScripts} ms].\nExecuted scripts: ${Object.values(
+        packagerScripts
+      ).map((script) => `\n  ${script}`)}`
+    );
   }
 }
diff --git a/src/pack.ts b/src/pack.ts
@@ -27,9 +27,7 @@ function setFunctionArtifactPath(this: EsbuildServerlessPlugin, func, artifactPa
   if (semver.lt(version, '1.18.0')) {
     func.artifact = artifactPath;
     func.package = Object.assign({}, func.package, { disable: true });
-    this.serverless.cli.log(
-      `${func.name} is packaged by the esbuild plugin. Ignore messages from SLS.`
-    );
+    this.log.verbose(`${func.name} is packaged by the esbuild plugin. Ignore messages from SLS.`);
   } else {
     func.package = {
       artifact: artifactPath,
@@ -128,7 +126,7 @@ export async function pack(this: EsbuildServerlessPlugin) {
     await zip(artifactPath, filesPathList, this.buildOptions.nativeZip);
     const { size } = fs.statSync(artifactPath);
 
-    this.serverless.cli.log(
+    this.log.verbose(
       `Zip service ${this.serverless.service.service} - ${humanSize(size)} [${
         Date.now() - startZip
       } ms]`
@@ -208,7 +206,7 @@ export async function pack(this: EsbuildServerlessPlugin) {
 
       const { size } = fs.statSync(artifactPath);
 
-      this.serverless.cli.log(
+      this.log.verbose(
         `Zip function: ${functionAlias} - ${humanSize(size)} [${Date.now() - startZip} ms]`
       );
 

diff --git a/src/packagers/index.ts b/src/packagers/index.ts
@@ -37,7 +37,7 @@ const registeredPackagers = {
 export function get(packagerId: string): Promise<Packager> {
   if (!(packagerId in registeredPackagers)) {
     const message = `Could not find packager '${packagerId}'`;
-    this.serverless.cli.log(`ERROR: ${message}`);
+    this.log.error(`ERROR: ${message}`);
     throw new this.serverless.classes.Error(message);
   }
   return registeredPackagers[packagerId];

diff --git a/src/tests/index.test.ts b/src/tests/index.test.ts
@@ -46,11 +46,16 @@ const mockServerlessConfig = (serviceOverride?: Partial<Service>): Serverless =>
     ...serviceOverride,
   } as Service;
 
+  const mockCli = {
+    log: jest.fn(),
+  };
+
   return {
     service,
     config: {
       servicePath: '/workDir',
     },
+    cli: mockCli,
   } as Partial<Serverless> as Serverless;
 };
 

diff --git a/src/tests/pack.test.ts b/src/tests/pack.test.ts
@@ -106,6 +106,15 @@ describe('pack', () => {
         workDirPath: '/workdir/serverless-esbuild/examples/individually/.esbuild/',
         serviceDirPath: '/workdir/serverless-esbuild/examples/individually',
         buildResults,
+        log: {
+          error: jest.fn(),
+          warning: jest.fn(),
+          notice: jest.fn(),
+          info: jest.fn(),
+          debug: jest.fn(),
+          verbose: jest.fn(),
+          success: jest.fn(),
+        },
       };
 
       await pack.call(esbuildPlugin);