feat: Adapt to serverless@3 logging interface (#174)

* feat: Adapt to `serverless@3` logging interface * refactor(test/index): switch to test cases. * chore: changelog + CI updates. * fix: sls@3 tag. * fix: don't run int tests for sls 3 on Node 10. Co-authored-by: Mark Tse <mark.tse@neverendingqs.com>
neverendingqs · Dec 30, 2021 · d8aaff3 · d8aaff3
1 parent 7ea3618
commit d8aaff3
Show file tree

Hide file tree

Showing 5 changed files with 118 additions and 39 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,10 @@ Breaking changes are introduced when going from version 3.x.x to 4.x.x:
     * This is because your environment variables might not be stored in dotenv files in all environments.
     * Setting `required.file` to `true` will continue to cause the plugin to halt if no dotenv files are found.
 
+## 3.12.x
+
+* feat: Adapt to `serverless@3` logging interface ([#174](https://github.com/neverendingqs/serverless-dotenv-plugin/pull/174))
+
 ## 3.11.x
 
 * feat: add support for `serverless@3`. ([#178](https://github.com/neverendingqs/serverless-dotenv-plugin/pull/178))

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "serverless-dotenv-plugin",
-  "version": "3.11.2",
+  "version": "3.12.0",
   "description": "Preload environment variables with dotenv into serverless.",
   "main": "src/index.js",
   "files": [

diff --git a/src/index.js b/src/index.js
@@ -11,7 +11,7 @@ const errorTypes = {
 };
 
 class ServerlessPlugin {
-  constructor(serverless, options) {
+  constructor(serverless, options, v3Utils) {
     this.serverless = serverless;
     this.serverless.service.provider.environment =
       this.serverless.service.provider.environment || {};
@@ -37,12 +37,21 @@ class ServerlessPlugin {
       );
     }
 
+    this.v3Utils = v3Utils;
     this.loadEnv(this.getEnvironment(options));
   }
 
-  log(...args) {
+  log(msg) {
     if (this.config.logging) {
-      this.serverless.cli.log(...args);
+      if (this.v3Utils) {
+        if (msg.includes('WARNING')) {
+          this.v3Utils.log.warning(msg);
+        } else {
+          this.v3Utils.log.notice(msg);
+        }
+      } else {
+        this.serverless.cli.log(msg);
+      }
     }
   }
 

diff --git a/test/index.js b/test/index.js
@@ -47,9 +47,24 @@ describe('ServerlessPlugin', function () {
       },
     };
     this.options = {};
+    this.v3Utils = {
+      log: {
+        notice: this.sandbox.stub(),
+        warning: this.sandbox.stub(),
+      },
+    };
 
-    this.createPlugin = () =>
-      new this.ServerlessPlugin(this.serverless, this.options);
+    this.createPlugin = ({ withV3Utils } = {}) => {
+      if (withV3Utils) {
+        return new this.ServerlessPlugin(
+          this.serverless,
+          this.options,
+          this.v3Utils,
+        );
+      } else {
+        return new this.ServerlessPlugin(this.serverless, this.options);
+      }
+    };
   });
 
   afterEach(function () {
@@ -82,22 +97,45 @@ describe('ServerlessPlugin', function () {
   });
 
   describe('log()', function () {
-    it('logs by default', function () {
-      const msg = 'msg';
-      this.createPlugin().log(msg);
-      this.serverless.cli.log.should.be.calledWith(msg);
-    });
+    [true, false].forEach((withV3Utils) => {
+      describe(JSON.stringify({ withV3Utils }), function () {
+        it('logs by default', function () {
+          const msg = 'msg';
+          this.createPlugin({ withV3Utils }).log(msg);
+          if (withV3Utils) {
+            this.serverless.cli.log.should.not.be.called;
+            this.v3Utils.log.notice.should.be.calledWith(msg);
+          } else {
+            this.serverless.cli.log.should.be.calledWith(msg);
+            this.v3Utils.log.notice.should.not.be.called;
+          }
+        });
 
-    it('does nothing if logging is disabled', function () {
-      this.serverless.service.custom = {
-        dotenv: {
-          logging: false,
-        },
-      };
+        it('logs by default and uses warning method if needed', function () {
+          const msg = 'WARNING: msg';
+          this.createPlugin({ withV3Utils }).log(msg);
+
+          if (withV3Utils) {
+            this.serverless.cli.log.should.not.be.called;
+            this.v3Utils.log.warning.should.be.calledWith(msg);
+          } else {
+            this.serverless.cli.log.should.be.calledWith(msg);
+            this.v3Utils.log.notice.should.not.be.called;
+          }
+        });
 
-      this.createPlugin().log('msg');
+        it('does nothing if logging is disabled', function () {
+          this.serverless.service.custom = {
+            dotenv: {
+              logging: false,
+            },
+          };
 
-      this.serverless.cli.log.should.not.be.called;
+          this.createPlugin({ withV3Utils }).log('msg');
+          this.serverless.cli.log.should.not.be.called;
+          this.v3Utils.log.notice.should.not.be.called;
+        });
+      });
     });
   });
 
@@ -148,21 +186,32 @@ describe('ServerlessPlugin', function () {
         this.createPlugin().resolveEnvFileNames('env').should.deep.equal(path);
       });
 
-      it('logs an error if basePath is also set', function () {
-        const path = '.env.unittest';
-        this.serverless.service.custom = {
-          dotenv: {
-            basePath: 'base/path/',
-            path,
-          },
-        };
-
-        this.createPlugin()
-          .resolveEnvFileNames('env')
-          .should.deep.equal([path]);
-        this.serverless.cli.log.should.have.been.calledWith(
-          sinon.match(/basePath/),
-        );
+      [true, false].forEach((withV3Utils) => {
+        describe(JSON.stringify({ withV3Utils }), function () {
+          it('logs an error if basePath is also set', function () {
+            const path = '.env.unittest';
+            this.serverless.service.custom = {
+              dotenv: {
+                basePath: 'base/path/',
+                path,
+              },
+            };
+
+            this.createPlugin({ withV3Utils })
+              .resolveEnvFileNames('env')
+              .should.deep.equal([path]);
+
+            if (withV3Utils) {
+              this.v3Utils.log.warning.should.have.been.calledWith(
+                sinon.match(/basePath/),
+              );
+            } else {
+              this.serverless.cli.log.should.have.been.calledWith(
+                sinon.match(/basePath/),
+              );
+            }
+          });
+        });
       });
     });
 
@@ -334,14 +383,31 @@ describe('ServerlessPlugin', function () {
       });
     });
 
-    it('logs an error if no .env files are required and none are found', function () {
-      const log = this.sandbox.stub(this.ServerlessPlugin.prototype, 'log');
+    [true, false].forEach((withV3Utils) => {
+      describe(JSON.stringify({ withV3Utils }), function () {
+        it('logs an error if no .env files are required and none are found', function () {
+          const resolveEnvFileNames = this.setupResolveEnvFileNames();
+          resolveEnvFileNames.withArgs(this.env).returns([]);
+
+          this.createPlugin({ withV3Utils });
 
+          const expectedMsg = 'DOTENV: Could not find .env file.';
+          if (withV3Utils) {
+            this.v3Utils.log.notice.should.have.been.calledWith(expectedMsg);
+          } else {
+            this.serverless.cli.log.should.have.been.calledWith(expectedMsg);
+          }
+        });
+      });
+    });
+    it('logs an error with V3Utils if no .env files are required and none are found', function () {
       const resolveEnvFileNames = this.setupResolveEnvFileNames();
       resolveEnvFileNames.withArgs(this.env).returns([]);
 
-      this.createPlugin();
-      log.should.have.been.calledWith('DOTENV: Could not find .env file.');
+      this.createPlugin({ withV3Utils: true });
+      this.v3Utils.log.notice.should.have.been.calledWith(
+        'DOTENV: Could not find .env file.',
+      );
     });
 
     it('throws an error if no .env files are found but at least one is required', function () {