From f7a86554a147a101726bcbd42f33aeef85ffd93f Mon Sep 17 00:00:00 2001
From: Hubert Boma Manilla <hmanilla@mozilla.com>
Date: Thu, 4 May 2023 00:23:44 +0000
Subject: [PATCH] Bug 1824701 - [devtools] Change the styling for blackboxing
 r=devtools-reviewers,nchevobbe

1) This patch cleanups the styling for blackboxing
- Ignored sources in the source tree are colored out and the icoon colors are consistent.
- Source content for ignored sources are also colored out.
- Ignored lines are colored out.
- The tab content for ignored sources are also abit lighter.

2) Also added tests to assert the lines in the sources are styled correcty
Thanks

Differential Revision: https://phabricator.services.mozilla.com/D173688
---
 .../debugger/src/components/Editor/Footer.css |   2 +-
 .../debugger/src/components/Editor/Tab.js     |   1 +
 .../debugger/src/components/Editor/Tabs.css   |   2 +-
 .../src/components/PrimaryPanes/Sources.css   |   6 +-
 .../PrimaryPanes/SourcesTreeItem.js           |   5 +-
 .../test/mochitest/browser_dbg-blackbox.js    | 164 ++++++++++++++++--
 devtools/client/themes/dark-theme.css         |   6 +-
 devtools/client/themes/light-theme.css        |   6 +-
 8 files changed, 165 insertions(+), 27 deletions(-)

diff --git a/devtools/client/debugger/src/components/Editor/Footer.css b/devtools/client/debugger/src/components/Editor/Footer.css
index 701c7d0a50e7..aee6c51d3849 100644
--- a/devtools/client/debugger/src/components/Editor/Footer.css
+++ b/devtools/client/debugger/src/components/Editor/Footer.css
@@ -60,7 +60,7 @@
 }
 
 .source-footer .blackboxed .img.blackBox {
-  background-color: var(--red-40);
+  background-color: #806414;
 }
 
 .source-footer .commands button.prettyPrint:disabled {
diff --git a/devtools/client/debugger/src/components/Editor/Tab.js b/devtools/client/debugger/src/components/Editor/Tab.js
index b675b6164e70..71b73265e0ff 100644
--- a/devtools/client/debugger/src/components/Editor/Tab.js
+++ b/devtools/client/debugger/src/components/Editor/Tab.js
@@ -206,6 +206,7 @@ class Tab extends PureComponent {
     const className = classnames("source-tab", {
       active,
       pretty: isPrettyCode,
+      blackboxed: this.props.isBlackBoxed,
     });
 
     const path = getDisplayPath(source, tabSources);
diff --git a/devtools/client/debugger/src/components/Editor/Tabs.css b/devtools/client/debugger/src/components/Editor/Tabs.css
index 6c1e378d7ece..565d8588f1b5 100644
--- a/devtools/client/debugger/src/components/Editor/Tabs.css
+++ b/devtools/client/debugger/src/components/Editor/Tabs.css
@@ -84,7 +84,7 @@
 }
 
 .source-tab .img.source-icon.blackBox {
-  background-color: var(--red-40);
+  background-color: #806414;
 }
 
 .source-tab .filename {
diff --git a/devtools/client/debugger/src/components/PrimaryPanes/Sources.css b/devtools/client/debugger/src/components/PrimaryPanes/Sources.css
index 9d2ae6f295a9..f9849de39628 100644
--- a/devtools/client/debugger/src/components/PrimaryPanes/Sources.css
+++ b/devtools/client/debugger/src/components/PrimaryPanes/Sources.css
@@ -123,9 +123,13 @@
   background-color: var(--theme-tab-toolbar-background);
 }
 
+.sources-list .tree .blackboxed {
+  color: #806414;
+}
+
 .sources-list .img.blackBox {
   mask-size: 13px;
-  background-color: var(--red-40);
+  background-color: #806414;
 }
 
 .sources-list .tree .label {
diff --git a/devtools/client/debugger/src/components/PrimaryPanes/SourcesTreeItem.js b/devtools/client/debugger/src/components/PrimaryPanes/SourcesTreeItem.js
index 37d5089dde88..017f03a3870b 100644
--- a/devtools/client/debugger/src/components/PrimaryPanes/SourcesTreeItem.js
+++ b/devtools/client/debugger/src/components/PrimaryPanes/SourcesTreeItem.js
@@ -382,7 +382,10 @@ class SourceTreeItem extends Component {
 
     return (
       <div
-        className={classnames("node", { focused })}
+        className={classnames("node", {
+          focused,
+          blackboxed: item.type == "source" && item.isBlackBoxed,
+        })}
         key={item.path}
         onClick={this.onClick}
         onContextMenu={this.onContextMenu}
diff --git a/devtools/client/debugger/test/mochitest/browser_dbg-blackbox.js b/devtools/client/debugger/test/mochitest/browser_dbg-blackbox.js
index c008efd75c61..4536ef7a3d93 100644
--- a/devtools/client/debugger/test/mochitest/browser_dbg-blackbox.js
+++ b/devtools/client/debugger/test/mochitest/browser_dbg-blackbox.js
@@ -197,6 +197,16 @@ async function testBlackBoxSource(dbg, source) {
   await openContextMenu(dbg, "CodeMirrorLines");
   await selectBlackBoxContextMenuItem(dbg, "blackbox");
 
+  info("Assert that all lines in the source are styled correctly");
+  assertIgnoredStyleInSourceLines(dbg, { hasBlackboxedLinesClass: true });
+
+  info("Assert that the source tree for simple4.js has the ignored style");
+  const node = findSourceNodeWithText(dbg, "simple4.js");
+  ok(
+    node.querySelector(".blackboxed"),
+    "simple4.js node does not have the ignored style"
+  );
+
   invokeInTab("funcA");
 
   info(
@@ -230,6 +240,18 @@ async function testBlackBoxSource(dbg, source) {
   await waitForContextMenu(dbg);
   await selectBlackBoxContextMenuItem(dbg, "blackbox");
 
+  info("Assert that all lines in the source are un-styled correctly");
+  assertIgnoredStyleInSourceLines(dbg, { hasBlackboxedLinesClass: false });
+
+  info(
+    "Assert that the source tree for simple4.js does not have the ignored style"
+  );
+  const nodeAfterBlackbox = findSourceNodeWithText(dbg, "simple4.js");
+  ok(
+    !nodeAfterBlackbox.querySelector(".blackboxed"),
+    "simple4.js node still has the ignored style"
+  );
+
   invokeInTab("funcA");
 
   info("assert the pause at the debugger statement on line 2");
@@ -289,6 +311,20 @@ async function testBlackBoxMultipleLines(dbg, source) {
     nonBlackBoxedSourceTreeNode: findSourceNodeWithText(dbg, "simple2.js"),
   });
 
+  info("Assert that the ignored lines are styled correctly");
+  assertIgnoredStyleInSourceLines(dbg, {
+    lines: [7, 13],
+    hasBlackboxedLinesClass: true,
+  });
+
+  info("Assert that the source tree for simple4.js has the ignored style");
+  const node = findSourceNodeWithText(dbg, "simple4.js");
+
+  ok(
+    node.querySelector(".blackboxed"),
+    "simple4.js node does not have the ignored style"
+  );
+
   invokeInTab("funcA");
 
   info("assert the pause at the debugger statement on line 2");
@@ -324,6 +360,21 @@ async function testBlackBoxMultipleLines(dbg, source) {
     nonBlackBoxedSourceTreeNode: findSourceNodeWithText(dbg, "simple2.js"),
   });
 
+  info("Assert that the un-ignored lines are no longer have the style");
+  assertIgnoredStyleInSourceLines(dbg, {
+    lines: [7, 13],
+    hasBlackboxedLinesClass: false,
+  });
+
+  info(
+    "Assert that the source tree for simple4.js does not have the ignored style"
+  );
+  const nodeAfterBlackbox = findSourceNodeWithText(dbg, "simple4.js");
+  ok(
+    !nodeAfterBlackbox.querySelector(".blackboxed"),
+    "simple4.js still has the ignored style"
+  );
+
   invokeInTab("funcA");
 
   // assert the pause at the debugger statement on line 2
@@ -363,6 +414,22 @@ async function testBlackBoxSingleLine(dbg, source) {
     nonBlackBoxedSourceTreeNode: findSourceNodeWithText(dbg, "simple2.js"),
   });
 
+  info("Assert that the ignored line 2 is styled correctly");
+  assertIgnoredStyleInSourceLines(dbg, {
+    lines: [2],
+    hasBlackboxedLinesClass: true,
+  });
+
+  info("Black box line 4 of funcC() with the debugger statement");
+  await openContextMenu(dbg, "gutter", 4);
+  await selectBlackBoxContextMenuItem(dbg, "blackbox-line");
+
+  info("Assert that the ignored line 4 is styled correctly");
+  assertIgnoredStyleInSourceLines(dbg, {
+    lines: [4],
+    hasBlackboxedLinesClass: true,
+  });
+
   invokeInTab("funcA");
 
   // assert the pause at the breakpoint set on line 8
@@ -378,17 +445,17 @@ async function testBlackBoxSingleLine(dbg, source) {
   await selectBlackBoxContextMenuItem(dbg, "blackbox-line");
 
   await assertEditorBlackBoxBoxContextMenuItems(dbg, {
-    blackboxedLine: null,
-    nonBlackBoxedLine: 4,
+    blackboxedLine: 4,
+    nonBlackBoxedLine: 3,
     blackBoxedLines: null,
-    nonBlackBoxedLines: [3, 4],
-    blackboxedSourceState: SOURCE_IS_NOT_IGNORED,
+    nonBlackBoxedLines: [11, 12],
+    blackboxedSourceState: SOURCE_LINES_ARE_IGNORED,
   });
 
   await assertGutterBlackBoxBoxContextMenuItems(dbg, {
-    blackboxedLine: null,
-    nonBlackBoxedLine: 4,
-    blackboxedSourceState: SOURCE_IS_NOT_IGNORED,
+    blackboxedLine: 4,
+    nonBlackBoxedLine: 3,
+    blackboxedSourceState: SOURCE_LINES_ARE_IGNORED,
   });
 
   await assertSourceTreeBlackBoxBoxContextMenuItems(dbg, {
@@ -396,6 +463,12 @@ async function testBlackBoxSingleLine(dbg, source) {
     nonBlackBoxedSourceTreeNode: findSourceNodeWithText(dbg, "simple2.js"),
   });
 
+  info("Assert that the un-ignored line 2 is styled correctly");
+  assertIgnoredStyleInSourceLines(dbg, {
+    lines: [2],
+    hasBlackboxedLinesClass: false,
+  });
+
   invokeInTab("funcA");
 
   // assert the pause at the debugger statement on line 2
@@ -657,10 +730,10 @@ async function selectEditorLinesAndOpenContextMenu(dbg, lines) {
 /**
  * Opens the debugger editor context menu in either codemirror or the
  * the debugger gutter.
- * @params {Object} dbg
- * @params {String} elementName
+ * @param {Object} dbg
+ * @param {String} elementName
  *                  The element to select
- * @params {Number} line
+ * @param {Number} line
  *                  The line to open the context menu on.
  */
 async function openContextMenu(dbg, elementName, line) {
@@ -672,8 +745,8 @@ async function openContextMenu(dbg, elementName, line) {
 
 /**
  * Selects the specific black box context menu item
- * @params {Object} dbg
- * @params {String} itemName
+ * @param {Object} dbg
+ * @param {String} itemName
  *                  The name of the context menu item.
  */
 async function selectBlackBoxContextMenuItem(dbg, itemName) {
@@ -697,9 +770,9 @@ async function selectBlackBoxContextMenuItem(dbg, itemName) {
 
 /**
  * Selects a range of lines
- * @params {Object} dbg
- * @params {Number} startLine
- * @params {Number} endLine
+ * @param {Object} dbg
+ * @param {Number} startLine
+ * @param {Number} endLine
  */
 function selectEditorLines(dbg, startLine, endLine) {
   getCM(dbg).setSelection(
@@ -707,3 +780,64 @@ function selectEditorLines(dbg, startLine, endLine) {
     { line: endLine, ch: 0 }
   );
 }
+/**
+ * Asserts that the styling for ignored lines are applied
+ * @param {Object} dbg
+ * @param {Object} options
+ *                 lines {null | Number | Number[]} [lines] Line(s) to assert.
+ *                   - If null is passed, the assertion is on all the blackboxed lines
+ *                   - If a line number is passed, the assertion is on the specified line
+ *                   - If an array (start and end lines) is passed, the assertion is on the multiple lines seelected
+ *                 hasBlackboxedLinesClass
+ *                   If `true` assert that style exist, else assert that style does not exist
+ */
+function assertIgnoredStyleInSourceLines(
+  dbg,
+  { lines, hasBlackboxedLinesClass }
+) {
+  if (lines) {
+    if (!lines[1]) {
+      // Single line ignored
+      const element = findElement(dbg, "line", lines[0]);
+      const hasStyle = hasBlackboxedLinesClass
+        ? element.parentNode.classList.contains("blackboxed-line")
+        : !element.parentNode.classList.contains("blackboxed-line");
+      ok(
+        hasStyle,
+        `Line ${lines[0]} ${
+          hasBlackboxedLinesClass ? "does not have" : "has"
+        } ignored styling`
+      );
+    } else {
+      // Multiple lines ignored
+      let currentLine = lines[0];
+      while (currentLine <= lines[1]) {
+        const element = findElement(dbg, "line", currentLine);
+        const hasStyle = hasBlackboxedLinesClass
+          ? element.parentNode.classList.contains("blackboxed-line")
+          : !element.parentNode.classList.contains("blackboxed-line");
+        ok(
+          hasStyle,
+          `Line ${currentLine} ${
+            hasBlackboxedLinesClass ? "does not have" : "has"
+          } ignored styling`
+        );
+        currentLine = currentLine + 1;
+      }
+    }
+  } else {
+    const codeLines = findAllElementsWithSelector(
+      dbg,
+      ".CodeMirror-code .CodeMirror-line"
+    );
+    const blackboxedLines = findAllElementsWithSelector(
+      dbg,
+      ".CodeMirror-code .blackboxed-line"
+    );
+    is(
+      hasBlackboxedLinesClass ? codeLines.length : 0,
+      blackboxedLines.length,
+      `${blackboxedLines.length} of ${codeLines.length} lines are blackboxed`
+    );
+  }
+}
diff --git a/devtools/client/themes/dark-theme.css b/devtools/client/themes/dark-theme.css
index 0eff73a78318..2eae01ef475e 100644
--- a/devtools/client/themes/dark-theme.css
+++ b/devtools/client/themes/dark-theme.css
@@ -238,10 +238,8 @@ div.CodeMirror span.marked-text {
 }
 
 /* Blackboxing lines */
-.CodeMirror-lines .blackboxed-line,
-.CodeMirror-lines .blackboxed-line .CodeMirror-gutter-elt {
-  /* Same color hue than the one used for the icon, but with different saturation/light */
-  background-color: hsl(347.8, 5%, 20%);
+.CodeMirror-lines .blackboxed-line :is(span, .cm-comment, .CodeMirror-gutter-elt) {
+  color: #806414cc;
 }
 
 /* Highlight for evaluating current statement. */
diff --git a/devtools/client/themes/light-theme.css b/devtools/client/themes/light-theme.css
index f355f2e8ae57..b61a5e2a05c0 100644
--- a/devtools/client/themes/light-theme.css
+++ b/devtools/client/themes/light-theme.css
@@ -225,10 +225,8 @@ div.CodeMirror span.marked-text {
 }
 
 /* Blackboxing lines */
-.CodeMirror-lines .blackboxed-line,
-.CodeMirror-lines .blackboxed-line .CodeMirror-gutter-elt {
-  /* Same color hue than the one used for the icon, but with different saturation/light */
-  background-color: hsl(347.8, 15%, 90%);
+.CodeMirror-lines .blackboxed-line :is(span, .cm-comment, .CodeMirror-gutter-elt) {
+  color: #806414cc;
 }
 
 /* Highlight for evaluating current statement. */