Debug logging toggle via global boolean

infra/testing/validator/service-worker-runtime.js

@@ -135,7 +135,7 @@ function setupSpiesAndContextForGenerateSW() {
   return {addEventListener, context, methodsToSpies: workboxContext};
 }
 
-function validateMethodCalls({methodsToSpies, expectedMethodCalls}) {
+function validateMethodCalls({methodsToSpies, expectedMethodCalls, context}) {
   for (const [method, spy] of Object.entries(methodsToSpies)) {
     if (spy.called) {
       // Special-case handling for importScripts(), as the first call may be
@@ -157,6 +157,13 @@ function validateMethodCalls({methodsToSpies, expectedMethodCalls}) {
           `while testing method calls for ${method}`).to.be.undefined;
     }
   }
+
+  // Special validation for __WB_DISABLE_DEBUG_LOGS, which is a boolean
+  // assignment, so we can't stub it out.
+  if ('__WB_DISABLE_DEBUG_LOGS' in expectedMethodCalls) {
+    expect(context.self.__WB_DISABLE_DEBUG_LOGS).to.eql(
+        expectedMethodCalls.__WB_DISABLE_DEBUG_LOGS, `__WB_DISABLE_DEBUG_LOGS`);
+  }
 }
 
 /**
@@ -194,7 +201,7 @@ module.exports = async ({
 
   vm.runInNewContext(swString, context);
 
-  validateMethodCalls({methodsToSpies, expectedMethodCalls});
+  validateMethodCalls({methodsToSpies, expectedMethodCalls, context});
 
   // Optionally check the usage of addEventListener().
   if (addEventListenerValidation) {

packages/workbox-build/src/lib/populate-sw-template.js

@@ -19,6 +19,7 @@ module.exports = ({
   cleanupOutdatedCaches,
   clientsClaim,
   directoryIndex,
+  disableDebugLogs,
   ignoreURLParametersMatching,
   importScripts,
   manifestEntries = [],
@@ -73,6 +74,7 @@ module.exports = ({
       cacheId,
       cleanupOutdatedCaches,
       clientsClaim,
+      disableDebugLogs,
       importScripts,
       manifestEntries,
       navigateFallback,

packages/workbox-build/src/lib/write-sw-using-default-template.js

@@ -19,6 +19,7 @@ module.exports = async ({
   cleanupOutdatedCaches,
   clientsClaim,
   directoryIndex,
+  disableDebugLogs,
   ignoreURLParametersMatching,
   importScripts,
   inlineWorkboxRuntime,
@@ -47,6 +48,7 @@ module.exports = async ({
     cleanupOutdatedCaches,
     clientsClaim,
     directoryIndex,
+    disableDebugLogs,
     ignoreURLParametersMatching,
     importScripts,
     manifestEntries,

packages/workbox-build/src/options/defaults.js

@@ -10,6 +10,7 @@ module.exports = {
   babelPresetEnvTargets: ['chrome >= 56'],
   cleanupOutdatedCaches: false,
   clientsClaim: false,
+  disableDebugLogs: false,
   exclude: [
     /\.map$/,
     /^manifest.*\.js$/,

packages/workbox-build/src/options/partials/generate.js

@@ -18,6 +18,7 @@ module.exports = {
   cleanupOutdatedCaches: joi.boolean().default(defaults.cleanupOutdatedCaches),
   clientsClaim: joi.boolean().default(defaults.clientsClaim),
   directoryIndex: joi.string(),
+  disableDebugLogs: joi.boolean().default(defaults.disableDebugLogs),
   ignoreURLParametersMatching: joi.array().items(regExpObject),
   importScripts: joi.array().items(joi.string()),
   inlineWorkboxRuntime: joi.boolean().default(defaults.inlineWorkboxRuntime),

packages/workbox-build/src/templates/sw-template.js

@@ -55,4 +55,6 @@ self.addEventListener('message', (event) => {
 
 <% if (runtimeCaching) { runtimeCaching.forEach(runtimeCachingString => {%><%= runtimeCachingString %><% });} %>
 
-<% if (offlineAnalyticsConfigString) { %><%= use('workbox-google-analytics', 'initialize') %>(<%= offlineAnalyticsConfigString %>);<% } %>`;
+<% if (offlineAnalyticsConfigString) { %><%= use('workbox-google-analytics', 'initialize') %>(<%= offlineAnalyticsConfigString %>);<% } %>
+
+<% if (disableDebugLogs) { %>self.__WB_DISABLE_DEBUG_LOGS = true;<% } %>`;

packages/workbox-core/src/_private/logger.ts

@@ -7,11 +7,17 @@
 
 import '../_version.js';
 
+declare global {
+  interface WorkerGlobalScope {
+    __WB_DISABLE_DEBUG_LOGS: boolean;
+  }
+}
 
 type LoggerMethods = 'debug'|'log'|'warn'|'error'|'groupCollapsed'|'groupEnd';
-
 
 const logger = <Console> (process.env.NODE_ENV === 'production' ? null : (() => {
+  self.__WB_DISABLE_DEBUG_LOGS = false;
+
   let inGroup = false;
 
   const methodToColorMap: {[methodName: string]: string|null} = {
@@ -24,6 +30,10 @@ const logger = <Console> (process.env.NODE_ENV === 'production' ? null : (() =>
   };
 
   const print = function(method: LoggerMethods, args: any[]) {
+    if (self.__WB_DISABLE_DEBUG_LOGS) {
+      return;
+    }
+
     if (method === 'groupCollapsed') {
       // Safari doesn't print all console.groupCollapsed() arguments:
       // https://bugs.webkit.org/show_bug.cgi?id=182754

test/workbox-build/node/generate-sw.js

@@ -33,6 +33,7 @@ describe(`[workbox-build] generate-sw.js (End to End)`, function() {
     'cacheId',
     'clientsClaim',
     'directoryIndex',
+    'disableDebugLogs',
     'dontCacheBustURLsMatching',
     'globDirectory',
     'globFollow',
@@ -138,6 +139,47 @@ describe(`[workbox-build] generate-sw.js (End to End)`, function() {
       confirmDirectoryContains(outputDir, filePaths);
 
       await validateServiceWorkerRuntime({swFile: swDest, expectedMethodCalls: {
+        __WB_DISABLE_DEBUG_LOGS: undefined,
+        importScripts: [],
+        precacheAndRoute: [[[{
+          url: 'index.html',
+          revision: '3883c45b119c9d7e9ad75a1b4a4672ac',
+        }, {
+          url: 'page-1.html',
+          revision: '544658ab25ee8762dc241e8b1c5ed96d',
+        }, {
+          url: 'page-2.html',
+          revision: 'a3a71ce0b9b43c459cf58bd37e911b74',
+        }, {
+          url: 'styles/stylesheet-1.css',
+          revision: '934823cbc67ccf0d67aa2a2eeb798f12',
+        }, {
+          url: 'styles/stylesheet-2.css',
+          revision: '884f6853a4fc655e4c2dc0c0f27a227c',
+        }, {
+          url: 'webpackEntry.js',
+          revision: '5b652181a25e96f255d0490203d3c47e',
+        }], {}]],
+      }});
+    });
+
+    it(`should disable logging when disableDebugLogs is set to true`, async function() {
+      const outputDir = tempy.directory();
+      const swDest = upath.join(outputDir, 'sw.js');
+      const options = Object.assign({}, BASE_OPTIONS, {
+        disableDebugLogs: true,
+        swDest,
+      });
+
+      const {count, filePaths, size, warnings} = await generateSW(options);
+      expect(warnings).to.be.empty;
+      expect(count).to.eql(6);
+      expect(size).to.eql(2604);
+
+      confirmDirectoryContains(outputDir, filePaths);
+
+      await validateServiceWorkerRuntime({swFile: swDest, expectedMethodCalls: {
+        __WB_DISABLE_DEBUG_LOGS: true,
         importScripts: [],
         precacheAndRoute: [[[{
           url: 'index.html',

test/workbox-core/sw/_private/test-logger.mjs

@@ -26,6 +26,8 @@ describe(`logger`, function() {
         }
       });
     }
+
+    self.__WB_DISABLE_DEBUG_LOGS = false;
   });
 
   after(function() {
@@ -59,6 +61,20 @@ describe(`logger`, function() {
     expect(logger).to.equal(null);
   });
 
+  it(`should toggle logging based on the value of __WB_DISABLE_DEBUG_LOGS`, function() {
+    if (process.env.NODE_ENV === 'production') this.skip();
+
+    const logStub = sandbox.stub(console, 'log');
+
+    self.__WB_DISABLE_DEBUG_LOGS = true;
+    logger.log('');
+    expect(logStub.callCount).to.eql(0);
+
+    self.__WB_DISABLE_DEBUG_LOGS = false;
+    logger.log('');
+    expect(logStub.callCount).to.eql(1);
+  });
+
   consoleLevels.forEach((consoleLevel) => {
     describe(`.${consoleLevel}()`, function() {
       it(`should work without input`, function() {