implementing webpack-log, cleaning up sinon sandboxes in tests

Author: shellscape

lib/context.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const logger = require('./log');
+const weblog = require('webpack-log');
 
 module.exports = function ctx(compiler, options) {
   const context = {
@@ -16,7 +16,11 @@ module.exports = function ctx(compiler, options) {
   if (options.logger) {
     context.log = options.logger;
   } else {
-    context.log = logger(options);
+    context.log = weblog({
+      level: options.logLevel || 'info',
+      name: 'wdm',
+      timestamp: options.logTime
+    });
   }
 
   const { log } = context;

lib/log.js

@@ -34,18 +34,13 @@
     "webpack": "^2.2.0 || ^3.0.0 || ^4.0.0-alpha"
   },
   "dependencies": {
-    "chalk": "^2.3.0",
-    "log-symbols": "^2.1.0",
-    "loglevel": "^1.6.0",
-    "loglevel-plugin-prefix": "^0.5.3",
     "loud-rejection": "^1.6.0",
     "memory-fs": "~0.4.1",
     "mime": "^2.0.3",
     "path-is-absolute": "^1.0.0",
     "range-parser": "^1.0.3",
-    "time-stamp": "^2.0.0",
     "url-join": "^2.0.2",
-    "uuid": "^3.1.0"
+    "webpack-log": "^1.0.1"
   },
   "devDependencies": {
     "assert": "^1.4.1",

package-lock.json

@@ -2,13 +2,12 @@
 
 const assert = require('assert');
 const sinon = require('sinon'); // eslint-disable-line import/no-extraneous-dependencies
+const weblog = require('webpack-log');
 const middleware = require('../../');
-const log = require('../../lib/log');
 
 describe('CompilerCallbacks', () => {
   let plugins = {};
-  let sandbox;
-
+  const sandbox = sinon.sandbox.create();
   const compiler = {
     watch() {},
     plugin(name, callback) {
@@ -17,7 +16,6 @@ describe('CompilerCallbacks', () => {
   };
 
   beforeEach(() => {
-    sandbox = sinon.sandbox.create();
     plugins = {};
   });
 
@@ -28,7 +26,7 @@ describe('CompilerCallbacks', () => {
   it('watch error should be reported to console', () => {
     const err = new Error('Oh noes!');
     const stub = sandbox.stub(compiler, 'watch');
-    const logger = log({ logLevel: 'silent' });
+    const logger = weblog({ level: 'silent' });
     const error = sandbox.spy(logger, 'error');
 
     stub.callsFake((opts, callback) => {

package.json

@@ -15,6 +15,7 @@ const doneStats = {
 
 describe('Lazy mode', () => {
   let plugins = [];
+  const sandbox = sinon.sandbox.create();
   const res = {};
   const compiler = {
     plugin(name, callback) {
@@ -26,8 +27,12 @@ describe('Lazy mode', () => {
 
   beforeEach(() => {
     plugins = {};
-    compiler.run = sinon.stub();
-    next = sinon.stub();
+    compiler.run = sandbox.stub();
+    next = sandbox.stub();
+  });
+
+  afterEach(() => {
+    sandbox.restore();
   });
 
   describe('builds', () => {
@@ -61,7 +66,7 @@ describe('Lazy mode', () => {
     it('should pass through compiler error', (done) => {
       const err = new Error('MyCompilerError');
       const { log } = instance.context;
-      const spy = sinon.spy(log, 'error');
+      const spy = sandbox.spy(log, 'error');
 
       compiler.run.callsArgWith(0, err);
 

test/tests/compiler-callbacks.js

@@ -2,6 +2,7 @@
 
 const assert = require('assert');
 const sinon = require('sinon'); // eslint-disable-line import/no-extraneous-dependencies
+const weblog = require('webpack-log');
 const middleware = require('../../');
 
 // @note logLevel testing is handled by the loglevel module
@@ -48,14 +49,18 @@ describe('Logging', () => {
   });
 
   it('should log with a timestamp', () => {
+    // we need to kill this logger as it's cached, and new options won't be
+    // applied. isn't something we're going to do in the module, but needed for
+    // testing
+    weblog.delLogger('wdm');
+
     const sandbox = sinon.sandbox.create();
-    const infoSpy = sandbox.spy(console, 'info');
+    const info = sandbox.spy(console, 'info');
     const instance = middleware(compiler, { logTime: true });
     const { log } = instance.context;
 
     spy(instance, sandbox);
 
-
     log.info('bar');
     log.warn('bar');
     log.error('bar');
@@ -64,7 +69,8 @@ describe('Logging', () => {
     assert.strictEqual(log.warn.callCount, 1);
     assert.strictEqual(log.error.callCount, 1);
     assert(/bar/.test(log.info.firstCall.args[0]));
-    assert(/[\d{2}:\d{2}:\d{2}]/.test(infoSpy.firstCall.args[0]));
+
+    assert(/[\d{2}:\d{2}:\d{2}]/.test(info.firstCall.args[0]));
 
     sandbox.restore();
   });

test/tests/lazy.js

@@ -14,7 +14,7 @@ const rawStats = fs.readFileSync(statsPath, 'utf8');
 
 describe('Reporter', () => {
   let plugins = {};
-  let sandbox;
+  const sandbox = sinon.sandbox.create();
   const defaults = { logLevel: 'silent' };
   const compiler = {
     watch() {
@@ -46,7 +46,7 @@ describe('Reporter', () => {
   }
 
   beforeEach(() => {
-    sandbox = sinon.sandbox.create();
+    // sandbox = sinon.sandbox.create();
     plugins = {};
   });