Bug 1533502 - Debugger dumps log of every action while using it r=davidwalsh

Differential Revision: https://phabricator.services.mozilla.com/D23965

--HG--
extra : moz-landing-system : lando

devtools/client/debugger/src/actions/utils/middleware/log.js

@@ -7,6 +7,7 @@
 
 import { isTesting } from "devtools-environment";
 import type { ThunkArgs } from "../../types";
+import { prefs } from "../../../utils/prefs";
 
 const blacklist = [
   "ADD_BREAKPOINT_POSITIONS",
@@ -95,7 +96,7 @@ export function log({ dispatch, getState }: ThunkArgs) {
   return (next: any) => (action: any) => {
     const asyncMsg = !action.status ? "" : `[${action.status}]`;
 
-    if (isTesting()) {
+    if (isTesting() && prefs.logActions) {
       // $FlowIgnore
       dump(
         `[ACTION] ${action.type} ${asyncMsg} - ${serializeAction(action)}\n`

devtools/client/debugger/src/utils/prefs.js

@@ -68,6 +68,7 @@ if (isDevelopment()) {
   pref("devtools.debugger.features.windowless-workers", true);
   pref("devtools.debugger.features.event-listeners-breakpoints", true);
   pref("devtools.debugger.features.log-points", true);
+  pref("devtools.debugger.log-actions", true);
 }
 
 export const prefs = new PrefsHelper("devtools", {
@@ -102,7 +103,8 @@ export const prefs = new PrefsHelper("devtools", {
   debuggerPrefsSchemaVersion: ["Char", "debugger.prefs-schema-version"],
   projectDirectoryRoot: ["Char", "debugger.project-directory-root", ""],
   skipPausing: ["Bool", "debugger.skip-pausing"],
-  mapScopes: ["Bool", "debugger.map-scopes-enabled"]
+  mapScopes: ["Bool", "debugger.map-scopes-enabled"],
+  logActions: ["Bool", "debugger.log-actions"]
 });
 
 export const features = new PrefsHelper("devtools.debugger.features", {

devtools/client/debugger/test/mochitest/helpers.js

@@ -524,7 +524,7 @@ function isSelectedFrameSelected(dbg, state) {
 /**
  * Clear all the debugger related preferences.
  */
-function clearDebuggerPreferences() {
+async function clearDebuggerPreferences() {
   asyncStorage.clear();
   Services.prefs.clearUserPref("devtools.recordreplay.enabled");
   Services.prefs.clearUserPref("devtools.debugger.pause-on-exceptions");
@@ -536,6 +536,7 @@ function clearDebuggerPreferences() {
   Services.prefs.clearUserPref("devtools.debugger.scopes-visible");
   Services.prefs.clearUserPref("devtools.debugger.skip-pausing");
   Services.prefs.clearUserPref("devtools.debugger.map-scopes-enabled");
+  await pushPref("devtools.debugger.log-actions", true);
 }
 
 /**
@@ -547,7 +548,7 @@ function clearDebuggerPreferences() {
  * @static
  */
 async function initDebugger(url, ...sources) {
-  clearDebuggerPreferences();
+  await clearDebuggerPreferences();
   const toolbox = await openNewTabAndToolbox(EXAMPLE_URL + url, "jsdebugger");
   const dbg = createDebuggerContext(toolbox);
   dbg.client.waitForWorkers(false);
@@ -557,7 +558,7 @@ async function initDebugger(url, ...sources) {
 }
 
 async function initPane(url, pane) {
-  clearDebuggerPreferences();
+  await clearDebuggerPreferences();
   return openNewTabAndToolbox(EXAMPLE_URL + url, pane);
 }
 

devtools/client/preferences/debugger.js

@@ -54,6 +54,7 @@ pref("devtools.debugger.project-directory-root", "");
 pref("devtools.debugger.skip-pausing", false);
 pref("devtools.debugger.logging", false);
 pref("devtools.debugger.map-scopes-enabled", false);
+pref("devtools.debugger.log-actions", false);
 
 pref("devtools.debugger.features.wasm", true);
 pref("devtools.debugger.features.shortcuts", true);