Bug 1852963 - Fix tests awaiting on BrowserTestUtils.loadURIString(). r=dao,webdriver-reviewers,devtools-reviewers,whimboo

mak77 · mak77 · commit 2d21eb4e9920 · 2023-09-14T16:33:13.000Z
BrowserTestUtils.loadURIString() is not async, nor returning a promise, it's effectively not awaiting for the page to be loaded. Differential Revision: https://phabricator.services.mozilla.com/D188211
diff --git a/browser/base/content/test/tabs/browser_navigate_through_urls_origin_attributes.js b/browser/base/content/test/tabs/browser_navigate_through_urls_origin_attributes.js
@@ -140,7 +140,7 @@ async function loadURIAndCheckRemoteType(
   );
   let loaded = BrowserTestUtils.browserLoaded(aBrowser, false, aURI);
   info(`About to load ${aURI} in ${aText}`);
-  await BrowserTestUtils.loadURIString(aBrowser, aURI);
+  BrowserTestUtils.loadURIString(aBrowser, aURI);
   await loaded;
 
   // Verify correct remote type
diff --git a/browser/components/contextualidentity/test/browser/browser_originattrs_reopenin.js b/browser/components/contextualidentity/test/browser/browser_originattrs_reopenin.js
@@ -106,7 +106,7 @@ add_task(async function testReopen() {
       false,
       uri
     );
-    await BrowserTestUtils.loadURIString(regularPage.tab.linkedBrowser, uri);
+    BrowserTestUtils.loadURIString(regularPage.tab.linkedBrowser, uri);
     await loaded;
     info(`Start Opened ${uri} in a regular tab`);
     currRemoteType = regularPage.tab.linkedBrowser.remoteType;
diff --git a/browser/components/newtab/test/browser/browser_asrouter_snippets.js b/browser/components/newtab/test/browser/browser_asrouter_snippets.js
@@ -149,7 +149,7 @@ add_task(async function test_snippets_telemetry() {
       url: "about:blank",
     },
     async browser => {
-      await BrowserTestUtils.loadURIString(browser, "about:home");
+      BrowserTestUtils.loadURIString(browser, "about:home");
       await BrowserTestUtils.browserLoaded(browser);
       let text = await SpecialPowers.spawn(browser, [], async () => {
         await ContentTaskUtils.waitForCondition(
diff --git a/browser/components/search/test/browser/telemetry/browser_search_telemetry_engagement_query_params.js b/browser/components/search/test/browser/telemetry/browser_search_telemetry_engagement_query_params.js
@@ -101,7 +101,7 @@ add_task(async function test_click_links() {
   ]);
 
   info("Load SERP again.");
-  await BrowserTestUtils.loadURIString(gBrowser, url);
+  BrowserTestUtils.loadURIString(gBrowser, url);
   pageLoadPromise = BrowserTestUtils.waitForLocationChange(gBrowser);
   await waitForPageWithAdImpressions();
 
diff --git a/browser/components/urlbar/tests/browser/browser_switchToTab_chiclet.js b/browser/components/urlbar/tests/browser/browser_switchToTab_chiclet.js
@@ -12,7 +12,13 @@ const TEST_URL = `${TEST_BASE_URL}dummy_page.html`;
 
 add_task(async function test_with_oneoff_button() {
   info("Loading test page into first tab");
-  await BrowserTestUtils.loadURIString(gBrowser, TEST_URL);
+  let promiseLoad = BrowserTestUtils.browserLoaded(
+    gBrowser.selectedBrowser,
+    false,
+    TEST_URL
+  );
+  BrowserTestUtils.loadURIString(gBrowser.selectedBrowser, TEST_URL);
+  await promiseLoad;
 
   info("Opening a new tab");
   const tab = await BrowserTestUtils.openNewForegroundTab(gBrowser);
@@ -65,7 +71,13 @@ add_task(async function test_with_oneoff_button() {
 
 add_task(async function test_with_keytype() {
   info("Loading test page into first tab");
-  await BrowserTestUtils.loadURIString(gBrowser, TEST_URL);
+  let promiseLoad = BrowserTestUtils.browserLoaded(
+    gBrowser.selectedBrowser,
+    false,
+    TEST_URL
+  );
+  BrowserTestUtils.loadURIString(gBrowser, TEST_URL);
+  await promiseLoad;
 
   info("Opening a new tab");
   const tab = await BrowserTestUtils.openNewForegroundTab(gBrowser);
diff --git a/devtools/shared/commands/resource/tests/browser_resources_console_messages_navigation.js b/devtools/shared/commands/resource/tests/browser_resources_console_messages_navigation.js
@@ -47,7 +47,7 @@ async function testCrossProcessTabNavigation(browser, resourceCommand) {
   );
 
   const onLoaded = BrowserTestUtils.browserLoaded(browser);
-  await BrowserTestUtils.loadURIString(browser, TEST_URL);
+  BrowserTestUtils.loadURIString(browser, TEST_URL);
   await onLoaded;
 
   info("Wait for log message");
diff --git a/devtools/shared/commands/resource/tests/browser_resources_sources.js b/devtools/shared/commands/resource/tests/browser_resources_sources.js
@@ -255,7 +255,13 @@ add_task(async function testSourcesOnload() {
     onAvailable: resources => availableResources.push(...resources),
   });
 
-  await BrowserTestUtils.loadURIString(tab.linkedBrowser, TEST_URL);
+  const promiseLoad = BrowserTestUtils.browserLoaded(
+    gBrowser.selectedBrowser,
+    false,
+    TEST_URL
+  );
+  BrowserTestUtils.loadURIString(tab.linkedBrowser, TEST_URL);
+  await promiseLoad;
 
   // Some sources may be created after the document is done loading (like eventHandler usecase)
   // so we may be received *after* watchResource resolved
diff --git a/devtools/shared/commands/resource/tests/browser_resources_stylesheets_navigation.js b/devtools/shared/commands/resource/tests/browser_resources_stylesheets_navigation.js
@@ -183,7 +183,7 @@ add_task(async function () {
   );
   const previousBrowsingContextId = tab.linkedBrowser.browsingContext.id;
   const onLoaded = BrowserTestUtils.browserLoaded(tab.linkedBrowser);
-  await BrowserTestUtils.loadURIString(
+  BrowserTestUtils.loadURIString(
     tab.linkedBrowser,
     TEST_URI_NEW_BROWSING_CONTEXT
   );
diff --git a/devtools/shared/commands/target/tests/browser_target_command_frames.js b/devtools/shared/commands/target/tests/browser_target_command_frames.js
@@ -93,7 +93,7 @@ async function testNavigationToParentProcessDocument() {
   const onSwitchedTarget = targetCommand.once("switched-target");
   const browser = tab.linkedBrowser;
   const onLoaded = BrowserTestUtils.browserLoaded(browser);
-  await BrowserTestUtils.loadURIString(browser, secondLocation);
+  BrowserTestUtils.loadURIString(browser, secondLocation);
   await onLoaded;
   is(
     browser.browsingContext.currentWindowGlobal.osPid,
@@ -162,7 +162,7 @@ async function testNavigationToAboutBlankDocument() {
   const onSwitchedTarget = targetCommand.once("switched-target");
   const browser = tab.linkedBrowser;
   const onLoaded = BrowserTestUtils.browserLoaded(browser);
-  await BrowserTestUtils.loadURIString(browser, secondLocation);
+  BrowserTestUtils.loadURIString(browser, secondLocation);
   await onLoaded;
 
   await onSwitchedTarget;
@@ -493,7 +493,7 @@ async function testTabFrames(mainRoot) {
 
   const browser = tab.linkedBrowser;
   const onLoaded = BrowserTestUtils.browserLoaded(browser);
-  await BrowserTestUtils.loadURIString(browser, SECOND_PAGE_URL);
+  BrowserTestUtils.loadURIString(browser, SECOND_PAGE_URL);
   await onLoaded;
 
   if (isFissionEnabled() || isEveryFrameTargetEnabled()) {
diff --git a/devtools/shared/commands/target/tests/browser_target_command_various_descriptors.js b/devtools/shared/commands/target/tests/browser_target_command_various_descriptors.js
@@ -151,7 +151,7 @@ async function testRemoteTab() {
 
   const browser = tab.linkedBrowser;
   const onLoaded = BrowserTestUtils.browserLoaded(browser);
-  await BrowserTestUtils.loadURIString(browser, SECOND_TEST_URL);
+  BrowserTestUtils.loadURIString(browser, SECOND_TEST_URL);
   await onLoaded;
 
   info("Wait for the new target");
diff --git a/dom/ipc/tests/JSWindowActor/browser_contentWindow.js b/dom/ipc/tests/JSWindowActor/browser_contentWindow.js
@@ -21,7 +21,7 @@ declTest("contentWindow null when inner window inactive", {
 
     let url = CONTENT_WINDOW_URL + "?2";
     let loaded = BrowserTestUtils.browserLoaded(browser, false, url);
-    await BrowserTestUtils.loadURIString(browser, url);
+    BrowserTestUtils.loadURIString(browser, url);
     await loaded;
 
     let result = await actorParent.sendQuery("checkActor");
diff --git a/dom/security/test/https-first/browser_downgrade_mixed_content_auto_upgrade_console.js b/dom/security/test/https-first/browser_downgrade_mixed_content_auto_upgrade_console.js
@@ -40,7 +40,13 @@ add_task(async function () {
   });
   Services.console.registerListener(on_new_message);
   // 1. Upgrade page to https://
-  await BrowserTestUtils.loadURIString(gBrowser.selectedBrowser, kTestURI);
+  let promiseLoaded = BrowserTestUtils.browserLoaded(
+    gBrowser.selectedBrowser,
+    false,
+    kTestURI
+  );
+  BrowserTestUtils.loadURIString(gBrowser.selectedBrowser, kTestURI);
+  await promiseLoaded;
 
   await BrowserTestUtils.waitForCondition(() => tests.length === 0);
 
diff --git a/dom/security/test/https-first/browser_httpsfirst_console_logging.js b/dom/security/test/https-first/browser_httpsfirst_console_logging.js
@@ -37,11 +37,16 @@ add_task(async function () {
   });
   Services.console.registerListener(on_new_message);
   // 1. Upgrade page to https://
-  await BrowserTestUtils.loadURIString(
+  let promiseLoaded = BrowserTestUtils.browserLoaded(
     gBrowser.selectedBrowser,
+    false,
     "http://httpsfirst.com"
   );
-
+  BrowserTestUtils.loadURIString(
+    gBrowser.selectedBrowser,
+    "http://httpsfirst.com"
+  );
+  await promiseLoaded;
   await BrowserTestUtils.waitForCondition(() => tests.length === 0);
 
   // Clean up
diff --git a/dom/security/test/https-first/browser_httpsfirst_speculative_connect.js b/dom/security/test/https-first/browser_httpsfirst_speculative_connect.js
@@ -58,10 +58,16 @@ add_task(async function () {
   });
   Services.console.registerListener(on_new_console_messages);
 
-  await BrowserTestUtils.loadURIString(
+  let promiseLoaded = BrowserTestUtils.browserLoaded(
+    gBrowser.selectedBrowser,
+    false,
+    "http://httpsfirst.com"
+  );
+  BrowserTestUtils.loadURIString(
     gBrowser.selectedBrowser,
     `${TEST_PATH_HTTP}file_httpsfirst_speculative_connect.html`
   );
+  await promiseLoaded;
 
   await BrowserTestUtils.waitForCondition(() => console_messages.length === 0);
 
diff --git a/dom/security/test/https-only/browser_hsts_host.js b/dom/security/test/https-only/browser_hsts_host.js
@@ -16,7 +16,14 @@ add_task(async function see_hsts_header() {
       "https://example.com"
     ) + "hsts_headers.sjs";
   Services.obs.addObserver(observer, "http-on-examine-response");
-  await BrowserTestUtils.loadURIString(gBrowser.selectedBrowser, setHstsUrl);
+
+  let promiseLoaded = BrowserTestUtils.browserLoaded(
+    gBrowser.selectedBrowser,
+    false,
+    setHstsUrl
+  );
+  BrowserTestUtils.loadURIString(gBrowser.selectedBrowser, setHstsUrl);
+  await promiseLoaded;
 
   await BrowserTestUtils.waitForCondition(() => readMessage);
   // Clean up
@@ -42,7 +49,13 @@ add_task(async function () {
     ) + "hsts_headers.sjs";
 
   // 1. Upgrade page to https://
-  await BrowserTestUtils.loadURIString(gBrowser.selectedBrowser, RESOURCE_LINK);
+  let promiseLoaded = BrowserTestUtils.browserLoaded(
+    gBrowser.selectedBrowser,
+    false,
+    RESOURCE_LINK
+  );
+  BrowserTestUtils.loadURIString(gBrowser.selectedBrowser, RESOURCE_LINK);
+  await promiseLoaded;
 
   await BrowserTestUtils.waitForCondition(() => testFinished);
 
@@ -119,7 +132,13 @@ add_task(async function () {
 
   Services.obs.addObserver(observer, "http-on-examine-response");
   // reset hsts header
+  let promiseLoaded = BrowserTestUtils.browserLoaded(
+    gBrowser.selectedBrowser,
+    false,
+    clearHstsUrl
+  );
   await BrowserTestUtils.loadURIString(gBrowser.selectedBrowser, clearHstsUrl);
+  await promiseLoaded;
   await BrowserTestUtils.waitForCondition(() => readMessage);
   // Clean up
   Services.obs.removeObserver(observer, "http-on-examine-response");
diff --git a/dom/security/test/https-only/browser_httpsonly_speculative_connect.js b/dom/security/test/https-only/browser_httpsonly_speculative_connect.js
@@ -58,10 +58,16 @@ add_task(async function () {
   });
   Services.console.registerListener(on_new_console_messages);
 
+  let promiseLoaded = BrowserTestUtils.browserLoaded(
+    gBrowser.selectedBrowser,
+    false,
+    `${TEST_PATH_HTTP}file_httpsonly_speculative_connect.html`
+  );
   await BrowserTestUtils.loadURIString(
     gBrowser.selectedBrowser,
     `${TEST_PATH_HTTP}file_httpsonly_speculative_connect.html`
   );
+  await promiseLoaded;
 
   await BrowserTestUtils.waitForCondition(() => console_messages.length === 0);
 
diff --git a/remote/shared/messagehandler/test/browser/browser_session_data.js b/remote/shared/messagehandler/test/browser/browser_session_data.js
@@ -181,10 +181,7 @@ add_task(async function test_sessionDataRootOnlyModule() {
   const rootMessageHandler = createRootMessageHandler(sessionId);
   ok(rootMessageHandler, "Valid ROOT MessageHandler created");
 
-  await BrowserTestUtils.loadURIString(
-    gBrowser,
-    "https://example.com/document-builder.sjs?html=tab"
-  );
+  await loadURL(gBrowser, "https://example.com/document-builder.sjs?html=tab");
 
   const windowGlobalCreated = rootMessageHandler.once(
     "window-global-handler-created"
diff --git a/toolkit/components/cookiebanners/test/browser/browser_cookieinjector.js b/toolkit/components/cookiebanners/test/browser/browser_cookieinjector.js
@@ -48,7 +48,7 @@ async function visitTestSites(urls = [ORIGIN_A, ORIGIN_B, ORIGIN_C]) {
   let tab = BrowserTestUtils.addTab(gBrowser, "about:blank");
 
   for (let url of urls) {
-    await BrowserTestUtils.loadURIString(tab.linkedBrowser, url);
+    BrowserTestUtils.loadURIString(tab.linkedBrowser, url);
     await BrowserTestUtils.browserLoaded(tab.linkedBrowser);
   }
 
@@ -343,7 +343,7 @@ add_task(async function test_pbm() {
     private: true,
   });
   let tab = BrowserTestUtils.addTab(pbmWindow.gBrowser, "about:blank");
-  await BrowserTestUtils.loadURIString(tab.linkedBrowser, ORIGIN_A);
+  BrowserTestUtils.loadURIString(tab.linkedBrowser, ORIGIN_A);
   await BrowserTestUtils.browserLoaded(tab.linkedBrowser);
 
   ok(
@@ -396,7 +396,7 @@ add_task(async function test_container_tab() {
   let tab = BrowserTestUtils.addTab(gBrowser, ORIGIN_B, {
     userContextId: 1,
   });
-  await BrowserTestUtils.loadURIString(tab.linkedBrowser, ORIGIN_B);
+  BrowserTestUtils.loadURIString(tab.linkedBrowser, ORIGIN_B);
   await BrowserTestUtils.browserLoaded(tab.linkedBrowser);
 
   ok(
@@ -579,7 +579,7 @@ add_task(async function test_site_preference_pbm() {
     private: true,
   });
   let tab = BrowserTestUtils.addTab(pbmWindow.gBrowser, "about:blank");
-  await BrowserTestUtils.loadURIString(tab.linkedBrowser, ORIGIN_B);
+  BrowserTestUtils.loadURIString(tab.linkedBrowser, ORIGIN_B);
   await BrowserTestUtils.browserLoaded(tab.linkedBrowser);
 
   ok(
@@ -601,7 +601,7 @@ add_task(async function test_site_preference_pbm() {
     true
   );
 
-  await BrowserTestUtils.loadURIString(tab.linkedBrowser, ORIGIN_B);
+  BrowserTestUtils.loadURIString(tab.linkedBrowser, ORIGIN_B);
   await BrowserTestUtils.browserLoaded(tab.linkedBrowser);
 
   ok(
diff --git a/toolkit/components/reader/test/browser_readerMode_samesite_cookie_redirect.js b/toolkit/components/reader/test/browser_readerMode_samesite_cookie_redirect.js
@@ -36,7 +36,7 @@ add_task(async function test_ss_cookie_redirect() {
       browser,
       "AboutReaderContentReady"
     );
-    await BrowserTestUtils.loadURIString(
+    BrowserTestUtils.loadURIString(
       browser,
       "about:reader?url=" + encodeURIComponent(serverURL)
     );
