Fixup console pretty print test (#5689)

* Fixup console pretty print test

* Make selectSource more paranoid

Author: jasonLaster

src/test/mochitest/browser_dbg-content-script-sources.js

@@ -1,8 +1,5 @@
 "use strict";
 
-/* global ExtensionTestUtils, closeTab, openToolboxForTab, assertDebugLine,
-          waitForSelectedSource */
-
 // Tests that the content scripts are listed in the source tree.
 
 async function selectContentScriptSources(dbg) {
@@ -67,8 +64,8 @@ add_task(async function() {
     info(`Reloading tab (${i} time)`);
     gBrowser.reloadTab(gBrowser.selectedTab);
     await waitForPaused(dbg);
-    await waitForSources(dbg, "content_script.js");
     await waitForSelectedSource(dbg, "content_script.js");
+
     ok(
       findElementWithSelector(dbg, ".sources-list .focused"),
       "Source is focused"

src/test/mochitest/browser_dbg-editor-highlight.js

@@ -13,12 +13,8 @@ add_task(async function() {
   // The source itself doesn't even exist yet, and using
   // `selectSourceURL` will set a pending request to load this source
   // and highlight a specific line.
-  dbg.actions.selectSourceURL(sourceUrl, { location: { line: 66 } });
 
-  // Wait for the source text to load and make sure we're in the right
-  // place.
-  await waitForSelectedSource(dbg, sourceUrl);
-  log(`loaded source`);
+  await selectSource(dbg, sourceUrl, 66)
 
   // TODO: revisit highlighting lines when the debugger opens
   // assertHighlightLocation(dbg, "long.js", 66);

src/test/mochitest/browser_dbg-outline.js

@@ -17,7 +17,6 @@ add_task(async function() {
   const { selectors: { getSelectedSource }, getState } = dbg;
 
   await selectSource(dbg, "simple1", 1);
-  await waitForSelectedSource(dbg, "simple1");
 
   findElementWithSelector(dbg, ".outline-tab").click();
   is(getItems(dbg).length, 5, "5 items in the list");

src/test/mochitest/browser_dbg-pretty-print-console.js

@@ -3,48 +3,43 @@
 
 "use strict";
 
-// Tests that pretty-printing updates console messages.
+async function waitForConsoleLink(dbg, text) {
+  const toolbox = dbg.toolbox;
+  const console = await toolbox.selectTool("webconsole");
+  const hud = console.hud;
+
+  return waitFor(() => {
+    // Wait until the message updates.
+    const found = hud.ui.outputNode.querySelector(".frame-link-source");
+    if (!found) {
+      return false;
+    }
+
+    const linkText = found.textContent;
+    if (!text) {
+      return linkText;
+    }
+
+    return linkText == text ? linkText : null;
+  });
+}
 
+// Tests that pretty-printing updates console messages.
 add_task(async function() {
   const dbg = await initDebugger("doc-minified.html");
   invokeInTab("arithmetic");
 
   info("Switch to console and check message");
-  const toolbox = dbg.toolbox;
-  const console = await toolbox.selectTool("webconsole");
-  const hud = console.hud;
-
-  let node = await waitFor(() =>
-    hud.ui.outputNode.querySelector(".frame-link-source")
-  );
-  const initialLocation = "math.min.js:3:65";
-  is(node.textContent, initialLocation, "location is correct in minified code");
+  await waitForConsoleLink(dbg,  "math.min.js:3:65");
 
   info("Switch back to debugger and pretty-print");
-  await toolbox.selectTool("jsdebugger");
+  await dbg.toolbox.selectTool("jsdebugger");
   await selectSource(dbg, "math.min.js", 2);
-  await waitForSelectedSource(dbg, "math.min.js");
 
   clickElement(dbg, "prettyPrintButton");
-
-  await waitForSource(dbg, "math.min.js:formatted");
-  const ppSrc = findSource(dbg, "math.min.js:formatted");
-
-  ok(ppSrc, "Pretty-printed source exists");
+  await waitForSelectedSource(dbg, "math.min.js:formatted");
 
   info("Switch back to console and check message");
-  node = await waitFor(() => {
-    // Wait until the message updates.
-    const found = hud.ui.outputNode.querySelector(".frame-link-source");
-    if (found.textContent == initialLocation) {
-      return null;
-    }
-    return found;
-  });
-
-  is(
-    node.textContent,
-    "math.min.js:formatted:22",
-    "location is correct in minified code"
-  );
+  await waitForConsoleLink(dbg, "math.min.js:formatted:22");
+  ok(true);
 });

src/test/mochitest/browser_dbg-reload.js

@@ -21,8 +21,6 @@ add_task(async function() {
   const dbg = await initDebugger("reload/doc-reload.html");
   await waitForSource(dbg, "sjs_code_reload");
   await selectSource(dbg, "sjs_code_reload");
-  await waitForSelectedSource(dbg, "sjs_code_reload");
-
   await addBreakpoint(dbg, "sjs_code_reload", 2);
 
   await reload(dbg, "sjs_code_reload");

src/test/mochitest/browser_dbg-sourcemaps2.js

@@ -45,7 +45,6 @@ add_task(async function() {
   // Tests the existence of the sourcemap link in the original source.
   ok(findElement(dbg, "sourceMapLink"), "Sourcemap link in original source");
   await selectSource(dbg, "main.min.js");
-  await waitForSelectedSource(dbg, "main.min.js");
 
   ok(
     !findElement(dbg, "sourceMapLink"),

src/test/mochitest/head.js

@@ -177,10 +177,11 @@ function waitForState(dbg, predicate, msg) {
     }
 
     const unsubscribe = dbg.store.subscribe(() => {
-      if (predicate(dbg.store.getState())) {
+      const result = predicate(dbg.store.getState())
+      if (result) {
         info(`Finished waiting for state change: ${msg || ""}`);
         unsubscribe();
-        resolve();
+        resolve(result);
       }
     });
   });
@@ -230,7 +231,7 @@ function waitForSource(dbg, url) {
   return waitForState(dbg, state => {
     const sources = dbg.selectors.getSources(state);
     return sources.find(s => (s.get("url") || "").includes(url));
-  });
+  }, `source exists`);
 }
 
 async function waitForElement(dbg, name) {
@@ -592,9 +593,10 @@ function waitForLoadedSources(dbg) {
  * @return {Promise}
  * @static
  */
-function selectSource(dbg, url, line) {
+async function selectSource(dbg, url, line) {
   const source = findSource(dbg, url);
-  return dbg.actions.selectLocation({ sourceId: source.id, line });
+  await dbg.actions.selectLocation({ sourceId: source.id, line });
+  return waitForSelectedSource(dbg, url);
 }
 
 function closeTab(dbg, url) {