3601 - [blackbox] sources should be persisted (firefox-devtools#5583)

* 3601 - [blackbox] blackbox sources should be persisted

* Add pref to asset list so Firefox will build.

* Lint

Author: Fischer-L

assets/panel/prefs.js

@@ -35,6 +35,7 @@ pref("devtools.debugger.expressions-visible", true);
 pref("devtools.debugger.start-panel-collapsed", false);
 pref("devtools.debugger.end-panel-collapsed", false);
 pref("devtools.debugger.tabs", "[]");
+pref("devtools.debugger.tabsBlackBoxed", "[]");
 pref("devtools.debugger.pending-selected-location", "{}");
 pref("devtools.debugger.pending-breakpoints", "{}");
 pref("devtools.debugger.expressions", "[]");

src/actions/sources/newSources.js

@@ -8,14 +8,15 @@
  * Redux actions for the sources state
  * @module actions/sources
  */
-
+import { toggleBlackBox } from "./blackbox";
 import { syncBreakpoint } from "../breakpoints";
 import { loadSourceText } from "./loadSourceText";
 import { togglePrettyPrint } from "./prettyPrint";
 import { selectLocation } from "../sources";
 import { getRawSourceURL, isPrettyURL } from "../../utils/source";
 
 import {
+  getBlackBoxList,
   getSource,
   getPendingSelectedLocation,
   getPendingBreakpointsForSource
@@ -124,6 +125,20 @@ function checkPendingBreakpoints(sourceId: string) {
   };
 }
 
+function restoreBlackBoxedSources(sources: Source[]) {
+  return async ({ dispatch }: ThunkArgs) => {
+    const tabs = getBlackBoxList();
+    if (tabs.length == 0) {
+      return;
+    }
+    for (const source of sources) {
+      if (tabs.includes(source.url) && !source.isBlackBoxed) {
+        dispatch(toggleBlackBox(source));
+      }
+    }
+  };
+}
+
 /**
  * Handler for the debugger client's unsolicited newSource notification.
  * @memberof actions/sources
@@ -155,8 +170,11 @@ export function newSources(sources: Source[]) {
       dispatch(checkPendingBreakpoints(source.id));
     }
 
-    return Promise.all(
+    await Promise.all(
       filteredSources.map(source => dispatch(loadSourceMap(source)))
     );
+    // We would like to restore the blackboxed state
+    // after loading all states to make sure the correctness.
+    dispatch(restoreBlackBoxedSources(filteredSources));
   };
 }

src/reducers/sources.js

@@ -138,9 +138,12 @@ function update(
 
     case "BLACKBOX":
       if (action.status === "done") {
+        const url = action.source.url;
+        const isBlackBoxed = action.value.isBlackBoxed;
+        updateBlackBoxList(url, isBlackBoxed);
         return state.setIn(
           ["sources", action.source.id, "isBlackBoxed"],
-          action.value.isBlackBoxed
+          isBlackBoxed
         );
       }
       break;
@@ -237,6 +240,23 @@ function updateTabList(state: OuterState, url: ?string, tabIndex?: number) {
   return tabs;
 }
 
+function updateBlackBoxList(url, isBlackBoxed) {
+  const tabs = getBlackBoxList();
+  const i = tabs.indexOf(url);
+  if (i >= 0) {
+    if (!isBlackBoxed) {
+      tabs.splice(i, 1);
+    }
+  } else if (isBlackBoxed) {
+    tabs.push(url);
+  }
+  prefs.tabsBlackBoxed = tabs;
+}
+
+export function getBlackBoxList() {
+  return prefs.tabsBlackBoxed || [];
+}
+
 /**
  * Gets the next tab to select when a tab closes. Heuristics:
  * 1. if the selected tab is available, it remains selected

src/utils/prefs.js

@@ -25,6 +25,7 @@ if (isDevelopment()) {
   pref("devtools.debugger.start-panel-collapsed", false);
   pref("devtools.debugger.end-panel-collapsed", false);
   pref("devtools.debugger.tabs", "[]");
+  pref("devtools.debugger.tabsBlackBoxed", "[]");
   pref("devtools.debugger.ui.framework-grouping-on", true);
   pref("devtools.debugger.pending-selected-location", "{}");
   pref("devtools.debugger.pending-breakpoints", "{}");
@@ -67,6 +68,7 @@ export const prefs = new PrefsHelper("devtools", {
   endPanelCollapsed: ["Bool", "debugger.end-panel-collapsed"],
   frameworkGroupingOn: ["Bool", "debugger.ui.framework-grouping-on"],
   tabs: ["Json", "debugger.tabs", []],
+  tabsBlackBoxed: ["Json", "debugger.tabsBlackBoxed", []],
   pendingSelectedLocation: ["Json", "debugger.pending-selected-location", {}],
   pendingBreakpoints: ["Json", "debugger.pending-breakpoints", {}],
   expressions: ["Json", "debugger.expressions", []],