Bug 1868603 - (part 2) Tests for unblocking clear history dialog from data size loading. r=pbz

HarshitSohaney · HarshitSohaney · commit 40e110907cf4 · 2024-03-13T16:30:11.000Z
Differential Revision: https://phabricator.services.mozilla.com/D202343
diff --git a/browser/base/content/test/sanitize/browser_sanitizeDialog_v2.js b/browser/base/content/test/sanitize/browser_sanitizeDialog_v2.js
@@ -200,7 +200,7 @@ async function performActionsOnDialog({
   cache = false,
   siteSettings = false,
 }) {
-  let dh = new ClearHistoryDialogHelper(context);
+  let dh = new ClearHistoryDialogHelper({ mode: context });
   dh.onload = function () {
     this.selectDuration(timespan);
     this.checkPrefCheckbox(
@@ -262,7 +262,7 @@ add_task(async function test_cancel() {
 
 // test remembering user options for various entry points
 add_task(async function test_pref_remembering() {
-  let dh = new ClearHistoryDialogHelper("clearSiteData");
+  let dh = new ClearHistoryDialogHelper({ mode: "clearSiteData" });
   dh.onload = function () {
     this.checkPrefCheckbox("cookiesAndStorage", false);
     this.checkPrefCheckbox("siteSettings", true);
@@ -273,7 +273,7 @@ add_task(async function test_pref_remembering() {
   await dh.promiseClosed;
 
   // validate if prefs are remembered
-  dh = new ClearHistoryDialogHelper("clearSiteData");
+  dh = new ClearHistoryDialogHelper({ mode: "clearSiteData" });
   dh.onload = function () {
     this.validateCheckbox("cookiesAndStorage", false);
     this.validateCheckbox("siteSettings", true);
@@ -289,7 +289,7 @@ add_task(async function test_pref_remembering() {
   await dh.promiseClosed;
 
   // validate if prefs did not change since we cancelled the dialog
-  dh = new ClearHistoryDialogHelper("clearSiteData");
+  dh = new ClearHistoryDialogHelper({ mode: "clearSiteData" });
   dh.onload = function () {
     this.validateCheckbox("cookiesAndStorage", false);
     this.validateCheckbox("siteSettings", true);
@@ -302,7 +302,7 @@ add_task(async function test_pref_remembering() {
   // test rememebering prefs from the clear history context
   // since clear history and clear site data have seperate remembering
   // of prefs
-  dh = new ClearHistoryDialogHelper("clearHistory");
+  dh = new ClearHistoryDialogHelper({ mode: "clearHistory" });
   dh.onload = function () {
     this.checkPrefCheckbox("cookiesAndStorage", true);
     this.checkPrefCheckbox("siteSettings", false);
@@ -314,7 +314,7 @@ add_task(async function test_pref_remembering() {
   await dh.promiseClosed;
 
   // validate if prefs are remembered across both clear history and browser
-  dh = new ClearHistoryDialogHelper("browser");
+  dh = new ClearHistoryDialogHelper({ mode: "browser" });
   dh.onload = function () {
     this.validateCheckbox("cookiesAndStorage", true);
     this.validateCheckbox("siteSettings", false);
@@ -448,7 +448,7 @@ add_task(async function testAcceptButtonDisabled() {
  * Tests to see if the warning box is hidden when opened in the clear on shutdown context
  */
 add_task(async function testWarningBoxInClearOnShutdown() {
-  let dh = new ClearHistoryDialogHelper("clearSiteData");
+  let dh = new ClearHistoryDialogHelper({ mode: "clearSiteData" });
   dh.onload = function () {
     this.selectDuration(Sanitizer.TIMESPAN_EVERYTHING);
     is(
@@ -461,7 +461,7 @@ add_task(async function testWarningBoxInClearOnShutdown() {
   dh.open();
   await dh.promiseClosed;
 
-  dh = new ClearHistoryDialogHelper("clearOnShutdown");
+  dh = new ClearHistoryDialogHelper({ mode: "clearOnShutdown" });
   dh.onload = function () {
     is(
       BrowserTestUtils.isVisible(this.getWarningPanel()),
@@ -639,7 +639,7 @@ add_task(async function test_clear_on_shutdown() {
     set: [["privacy.sanitize.sanitizeOnShutdown", true]],
   });
 
-  let dh = new ClearHistoryDialogHelper("clearOnShutdown");
+  let dh = new ClearHistoryDialogHelper({ mode: "clearOnShutdown" });
   dh.onload = async function () {
     this.uncheckAllCheckboxes();
     this.checkPrefCheckbox("historyFormDataAndDownloads", false);
@@ -708,7 +708,7 @@ add_task(async function test_clear_on_shutdown() {
   await ensureDownloadsClearedState(downloadIDs, false);
   await ensureDownloadsClearedState(olderDownloadIDs, false);
 
-  dh = new ClearHistoryDialogHelper("clearOnShutdown");
+  dh = new ClearHistoryDialogHelper({ mode: "clearOnShutdown" });
   dh.onload = async function () {
     this.uncheckAllCheckboxes();
     this.checkPrefCheckbox("historyFormDataAndDownloads", true);
@@ -908,7 +908,7 @@ add_task(async function testClearHistoryCheckboxStatesAfterMigration() {
     ],
   });
 
-  let dh = new ClearHistoryDialogHelper("clearHistory");
+  let dh = new ClearHistoryDialogHelper({ mode: "clearHistory" });
   dh.onload = function () {
     this.validateCheckbox("cookiesAndStorage", true);
     this.validateCheckbox("historyFormDataAndDownloads", false);
@@ -929,7 +929,7 @@ add_task(async function testClearHistoryCheckboxStatesAfterMigration() {
   );
 
   // make sure the migration doesn't run again
-  dh = new ClearHistoryDialogHelper("clearHistory");
+  dh = new ClearHistoryDialogHelper({ mode: "clearHistory" });
   dh.onload = function () {
     this.validateCheckbox("siteSettings", true);
     this.validateCheckbox("cookiesAndStorage", false);
diff --git a/browser/base/content/test/sanitize/browser_sanitizeDialog_v2_dataSizes.js b/browser/base/content/test/sanitize/browser_sanitizeDialog_v2_dataSizes.js
@@ -5,6 +5,10 @@
 /**
  * This tests the new clear history dialog's data size display functionality
  */
+ChromeUtils.defineESModuleGetters(this, {
+  sinon: "resource://testing-common/Sinon.sys.mjs",
+  Sanitizer: "resource:///modules/Sanitizer.sys.mjs",
+});
 
 add_setup(async function () {
   await blankSlate();
@@ -84,13 +88,12 @@ async function clearAndValidateDataSizes({
 }) {
   await blankSlate();
 
-  await addToDownloadList();
   await addToSiteUsage();
   let promiseSanitized = promiseSanitizationComplete();
 
   await openPreferencesViaOpenPreferencesAPI("privacy", { leaveOpen: true });
 
-  let dh = new ClearHistoryDialogHelper();
+  let dh = new ClearHistoryDialogHelper({ checkingDataSizes: true });
   dh.onload = async function () {
     await validateDataSizes(this);
     this.checkPrefCheckbox("cache", clearCache);
@@ -105,7 +108,7 @@ async function clearAndValidateDataSizes({
   dh.open();
   await dh.promiseClosed;
 
-  let dh2 = new ClearHistoryDialogHelper();
+  let dh2 = new ClearHistoryDialogHelper({ checkingDataSizes: true });
   // Check if the newly cleared values are reflected
   dh2.onload = async function () {
     await validateDataSizes(this);
@@ -180,3 +183,128 @@ add_task(async function test_all_data_sizes() {
     timespan: Sanitizer.TIMESPAN_EVERYTHING,
   });
 });
+
+// This test makes sure that the user can change their timerange option
+// even if the data sizes are not loaded yet.
+add_task(async function testUIWithDataSizesLoading() {
+  await blankSlate();
+  await addToSiteUsage();
+
+  let origGetQuotaUsageForTimeRanges =
+    SiteDataManager.getQuotaUsageForTimeRanges.bind(SiteDataManager);
+  let resolveStubFn;
+  let resolverAssigned = false;
+
+  let dh = new ClearHistoryDialogHelper();
+  // Create a sandbox for isolated stubbing within the test
+  let sandbox = sinon.createSandbox();
+  sandbox
+    .stub(SiteDataManager, "getQuotaUsageForTimeRanges")
+    .callsFake(async (...args) => {
+      info("stub called");
+
+      let dataSizesReadyToLoadPromise = new Promise(resolve => {
+        resolveStubFn = resolve;
+        info("Sending message to notify dialog that the resolver is assigned");
+        window.postMessage("resolver-assigned", "*");
+        resolverAssigned = true;
+      });
+      await dataSizesReadyToLoadPromise;
+      return origGetQuotaUsageForTimeRanges(...args);
+    });
+  dh.onload = async function () {
+    // we add this event listener in the case where init finishes before the resolver is assigned
+    if (!resolverAssigned) {
+      await new Promise(resolve => {
+        let listener = event => {
+          if (event.data === "resolver-assigned") {
+            window.removeEventListener("message", listener);
+            // we are ready to test the dialog without any data sizes loaded
+            resolve();
+          }
+        };
+        window.addEventListener("message", listener);
+      });
+    }
+
+    ok(
+      !this.win.gSanitizePromptDialog._dataSizesUpdated,
+      "Data sizes should not have loaded yet"
+    );
+    this.selectDuration(Sanitizer.TIMESPAN_2HOURS);
+
+    info("triggering loading state end");
+    resolveStubFn();
+
+    await this.win.gSanitizePromptDialog.dataSizesFinishedUpdatingPromise;
+
+    validateDataSizes(this);
+    this.cancelDialog();
+  };
+  dh.open();
+  await dh.promiseClosed;
+
+  // Restore the sandbox after the test is complete
+  sandbox.restore();
+});
+
+add_task(async function testClearingBeforeDataSizesLoad() {
+  await blankSlate();
+  await addToSiteUsage();
+
+  // add site data that we can verify if it gets cleared
+  await createDummyDataForHost("example.org");
+  await createDummyDataForHost("example.com");
+
+  ok(
+    await SiteDataTestUtils.hasIndexedDB("https://example.org"),
+    "We have indexedDB data for example.org"
+  );
+  ok(
+    await SiteDataTestUtils.hasIndexedDB("https://example.com"),
+    "We have indexedDB data for example.com"
+  );
+
+  let dh = new ClearHistoryDialogHelper();
+  let promiseSanitized = promiseSanitizationComplete();
+  // Create a sandbox for isolated stubbing within the test
+  let sandbox = sinon.createSandbox();
+  sandbox
+    .stub(SiteDataManager, "getQuotaUsageForTimeRanges")
+    .callsFake(async () => {
+      info("stub called");
+
+      info("This promise should never resolve");
+      await new Promise(resolve => {});
+    });
+  dh.onload = async function () {
+    // we don't need to initiate a event listener to wait for the resolver to be assigned for this
+    // test since we do not want the data sizes to load
+    ok(
+      !this.win.gSanitizePromptDialog._dataSizesUpdated,
+      "Data sizes should not be loaded yet"
+    );
+    this.selectDuration(Sanitizer.TIMESPAN_2HOURS);
+    this.checkPrefCheckbox("cookiesAndStorage", true);
+    this.acceptDialog();
+  };
+  dh.onunload = async () => {
+    await promiseSanitized;
+  };
+  dh.open();
+  await dh.promiseClosed;
+
+  // Data for example.org should be cleared
+  ok(
+    !(await SiteDataTestUtils.hasIndexedDB("https://example.org")),
+    "We don't have indexedDB data for example.org"
+  );
+  // Data for example.com should be cleared
+  ok(
+    !(await SiteDataTestUtils.hasIndexedDB("https://example.com")),
+    "We don't have indexedDB data for example.com"
+  );
+
+  // Restore the sandbox after the test is complete
+  sandbox.restore();
+});
diff --git a/browser/base/content/test/sanitize/head.js b/browser/base/content/test/sanitize/head.js
@@ -501,21 +501,29 @@ function promiseSanitizationComplete() {
  * This wraps the dialog and provides some convenience methods for interacting
  * with it.
  *
- * @param browserWin (optional)
+ * @param {Window} browserWin (optional)
  *        The browser window that the dialog is expected to open in. If not
  *        supplied, the initial browser window of the test run is used.
- * @param mode (optional)
- *        One of
- *          clear on shutdown settings context ("clearOnShutdown"),
- *          clear site data settings context ("clearSiteData"),
- *          clear history context ("clearHistory"),
- *          browser context ("browser")
- *        "browser" by default
+ * @param {Object} {mode, checkingDataSizes}
+ *        mode: context to open the dialog in
+ *          One of
+ *            clear on shutdown settings context ("clearOnShutdown"),
+ *            clear site data settings context ("clearSiteData"),
+ *            clear history context ("clearHistory"),
+ *            browser context ("browser")
+ *          "browser" by default
+ *        checkingDataSizes: boolean check if we should wait for the data sizes
+ *          to load
+ *
  */
-function ClearHistoryDialogHelper(openContext = "browser") {
+function ClearHistoryDialogHelper({
+  mode = "browser",
+  checkingDataSizes = false,
+} = {}) {
   this._browserWin = window;
   this.win = null;
-  this._mode = openContext;
+  this._mode = mode;
+  this._checkingDataSizes = checkingDataSizes;
   this.promiseClosed = new Promise(resolve => {
     this._resolveClosed = resolve;
   });
@@ -673,7 +681,11 @@ ClearHistoryDialogHelper.prototype = {
       () => {
         // Run onload on next tick so that gSanitizePromptDialog.init can run first.
         executeSoon(async () => {
-          await this.win.gSanitizePromptDialog.dataSizesFinishedUpdatingPromise;
+          if (this._checkingDataSizes) {
+            // we wait for the data sizes to load to avoid async errors when validating sizes
+            await this.win.gSanitizePromptDialog
+              .dataSizesFinishedUpdatingPromise;
+          }
           this.onload();
         });
       },
