Bug 1468355 - Optimize checking for site data usage for the site identity panel. r=Gijs

The idea here is that we avoid updating all site data in SiteDataManager.jsm
just for checking a single host/origin and that we optimize performance by prioritizing
the most common data type (cookies) and synchronous lookups (AppCache) and returning
early if any data was found.

We will still refresh the site data list for clearing once the user clicks on "Clear Site Data".

Differential Revision: https://phabricator.services.mozilla.com/D42800

--HG--
extra : moz-landing-system : lando

browser/base/content/browser-siteIdentity.js

@@ -938,14 +938,8 @@ var gIdentityHandler = {
     // "Clear Site Data" button if the site is storing local data.
     this._clearSiteDataFooter.hidden = true;
     if (this._uriHasHost) {
-      let host = this._uri.host;
-      SiteDataManager.updateSites().then(async () => {
-        let baseDomain = SiteDataManager.getBaseDomainFromHost(host);
-        let siteData = await SiteDataManager.getSites(baseDomain);
-
-        if (siteData && siteData.length) {
-          this._clearSiteDataFooter.hidden = false;
-        }
+      SiteDataManager.hasSiteData(this._uri.asciiHost).then(hasData => {
+        this._clearSiteDataFooter.hidden = !hasData;
       });
     }
 

browser/base/content/browser.js

@@ -7965,38 +7965,13 @@ var OfflineApps = {
     );
   },
 
-  // XXX: duplicated in preferences/advanced.js
-  _getOfflineAppUsage(host, groups) {
-    let cacheService = Cc[
-      "@mozilla.org/network/application-cache-service;1"
-    ].getService(Ci.nsIApplicationCacheService);
-    if (!groups) {
-      try {
-        groups = cacheService.getGroups();
-      } catch (ex) {
-        return 0;
-      }
-    }
-
-    let usage = 0;
-    for (let group of groups) {
-      let uri = Services.io.newURI(group);
-      if (uri.asciiHost == host) {
-        let cache = cacheService.getActiveCache(group);
-        usage += cache.usage;
-      }
-    }
-
-    return usage;
-  },
-
   _usedMoreThanWarnQuota(uri) {
     // if the user has already allowed excessive usage, don't bother checking
     if (
       Services.perms.testExactPermission(uri, "offline-app") !=
       Ci.nsIOfflineCacheUpdateService.ALLOW_NO_WARN
     ) {
-      let usageBytes = this._getOfflineAppUsage(uri.asciiHost);
+      let usageBytes = SiteDataManager.getAppCacheUsageByHost(uri.asciiHost);
       let warnQuotaKB = Services.prefs.getIntPref("offline-apps.quota.warn");
       // The pref is in kb, the usage we get is in bytes, so multiply the quota
       // to compare correctly:

browser/base/content/test/siteIdentity/browser_identityPopup_clearSiteData.js

@@ -6,6 +6,12 @@ const TEST_SUB_ORIGIN = "https://test1.example.com";
 const REMOVE_DIALOG_URL =
   "chrome://browser/content/preferences/siteDataRemoveSelected.xul";
 
+// Greek IDN for 'example.test'.
+const TEST_IDN_ORIGIN =
+  "https://\u03C0\u03B1\u03C1\u03AC\u03B4\u03B5\u03B9\u03B3\u03BC\u03B1.\u03B4\u03BF\u03BA\u03B9\u03BC\u03AE";
+const TEST_PUNY_ORIGIN = "https://xn--hxajbheg2az3al.xn--jxalpdlp/";
+const TEST_PUNY_SUB_ORIGIN = "https://sub1.xn--hxajbheg2az3al.xn--jxalpdlp/";
+
 ChromeUtils.defineModuleGetter(
   this,
   "SiteDataTestUtils",
@@ -21,27 +27,33 @@ add_task(async function setup() {
   });
 });
 
-async function testClearing(testQuota, testCookies) {
+async function testClearing(
+  testQuota,
+  testCookies,
+  testURI,
+  origin,
+  subOrigin
+) {
   // Add some test quota storage.
   if (testQuota) {
-    await SiteDataTestUtils.addToIndexedDB(TEST_ORIGIN);
-    await SiteDataTestUtils.addToIndexedDB(TEST_SUB_ORIGIN);
+    await SiteDataTestUtils.addToIndexedDB(origin);
+    await SiteDataTestUtils.addToIndexedDB(subOrigin);
   }
 
   // Add some test cookies.
   if (testCookies) {
-    SiteDataTestUtils.addToCookies(TEST_ORIGIN, "test1", "1");
-    SiteDataTestUtils.addToCookies(TEST_ORIGIN, "test2", "2");
-    SiteDataTestUtils.addToCookies(TEST_SUB_ORIGIN, "test3", "1");
+    SiteDataTestUtils.addToCookies(origin, "test1", "1");
+    SiteDataTestUtils.addToCookies(origin, "test2", "2");
+    SiteDataTestUtils.addToCookies(subOrigin, "test3", "1");
   }
 
-  await BrowserTestUtils.withNewTab(TEST_ORIGIN, async function(browser) {
+  await BrowserTestUtils.withNewTab(testURI, async function(browser) {
     // Verify we have added quota storage.
     if (testQuota) {
-      let usage = await SiteDataTestUtils.getQuotaUsage(TEST_ORIGIN);
+      let usage = await SiteDataTestUtils.getQuotaUsage(origin);
       Assert.greater(usage, 0, "Should have data for the base origin.");
 
-      usage = await SiteDataTestUtils.getQuotaUsage(TEST_SUB_ORIGIN);
+      usage = await SiteDataTestUtils.getQuotaUsage(subOrigin);
       Assert.greater(usage, 0, "Should have data for the sub origin.");
     }
 
@@ -51,12 +63,8 @@ async function testClearing(testQuota, testCookies) {
       gIdentityHandler._identityPopup,
       "popupshown"
     );
-    let siteDataUpdated = TestUtils.topicObserved(
-      "sitedatamanager:sites-updated"
-    );
     gIdentityHandler._identityBox.click();
     await promisePanelOpen;
-    await siteDataUpdated;
 
     let clearFooter = document.getElementById(
       "identity-popup-clear-sitedata-footer"
@@ -64,7 +72,10 @@ async function testClearing(testQuota, testCookies) {
     let clearButton = document.getElementById(
       "identity-popup-clear-sitedata-button"
     );
-    ok(!clearFooter.hidden, "The clear data footer is not hidden.");
+    TestUtils.waitForCondition(
+      () => !clearFooter.hidden,
+      "The clear data footer is not hidden."
+    );
 
     let cookiesCleared;
     if (testCookies) {
@@ -87,7 +98,9 @@ async function testClearing(testQuota, testCookies) {
     Services.telemetry.clearEvents();
 
     // Click the "Clear data" button.
-    siteDataUpdated = TestUtils.topicObserved("sitedatamanager:sites-updated");
+    let siteDataUpdated = TestUtils.topicObserved(
+      "sitedatamanager:sites-updated"
+    );
     let hideEvent = BrowserTestUtils.waitForEvent(
       gIdentityHandler._identityPopup,
       "popuphidden"
@@ -116,13 +129,13 @@ async function testClearing(testQuota, testCookies) {
     // Check that cookies were deleted.
     if (testCookies) {
       await cookiesCleared;
-      let uri = Services.io.newURI(TEST_ORIGIN);
+      let uri = Services.io.newURI(origin);
       is(
         Services.cookies.countCookiesFromHost(uri.host),
         0,
         "Cookies from the base domain should be cleared"
       );
-      uri = Services.io.newURI(TEST_SUB_ORIGIN);
+      uri = Services.io.newURI(subOrigin);
       is(
         Services.cookies.countCookiesFromHost(uri.host),
         0,
@@ -133,11 +146,11 @@ async function testClearing(testQuota, testCookies) {
     // Check that quota storage was deleted.
     if (testQuota) {
       await TestUtils.waitForCondition(async () => {
-        let usage = await SiteDataTestUtils.getQuotaUsage(TEST_ORIGIN);
+        let usage = await SiteDataTestUtils.getQuotaUsage(origin);
         return usage == 0;
       }, "Should have no data for the base origin.");
 
-      let usage = await SiteDataTestUtils.getQuotaUsage(TEST_SUB_ORIGIN);
+      let usage = await SiteDataTestUtils.getQuotaUsage(subOrigin);
       is(usage, 0, "Should have no data for the sub origin.");
     }
 
@@ -146,10 +159,12 @@ async function testClearing(testQuota, testCookies) {
       gIdentityHandler._identityPopup,
       "popupshown"
     );
-    siteDataUpdated = TestUtils.topicObserved("sitedatamanager:sites-updated");
     gIdentityHandler._identityBox.click();
     await promisePanelOpen;
-    await siteDataUpdated;
+
+    // Wait for a second to see if the button is shown.
+    // eslint-disable-next-line mozilla/no-arbitrary-setTimeout
+    await new Promise(c => setTimeout(c, 1000));
 
     ok(
       clearFooter.hidden,
@@ -160,15 +175,26 @@ async function testClearing(testQuota, testCookies) {
 
 // Test removing quota managed storage.
 add_task(async function test_ClearSiteData() {
-  await testClearing(true, false);
+  await testClearing(true, false, TEST_ORIGIN, TEST_ORIGIN, TEST_SUB_ORIGIN);
 });
 
 // Test removing cookies.
 add_task(async function test_ClearCookies() {
-  await testClearing(false, true);
+  await testClearing(false, true, TEST_ORIGIN, TEST_ORIGIN, TEST_SUB_ORIGIN);
 });
 
 // Test removing both.
 add_task(async function test_ClearCookiesAndSiteData() {
-  await testClearing(true, true);
+  await testClearing(true, true, TEST_ORIGIN, TEST_ORIGIN, TEST_SUB_ORIGIN);
+});
+
+// Test IDN Domains
+add_task(async function test_IDN_ClearCookiesAndSiteData() {
+  await testClearing(
+    true,
+    true,
+    TEST_IDN_ORIGIN,
+    TEST_PUNY_ORIGIN,
+    TEST_PUNY_SUB_ORIGIN
+  );
 });

browser/modules/SiteDataManager.jsm

@@ -24,8 +24,6 @@ XPCOMUtils.defineLazyGetter(this, "gBrandBundle", function() {
 });
 
 var SiteDataManager = {
-  _qms: Services.qms,
-
   _appCache: Cc["@mozilla.org/network/application-cache-service;1"].getService(
     Ci.nsIApplicationCacheService
   ),
@@ -174,7 +172,7 @@ var SiteDataManager = {
       // XXX: The work of integrating localStorage into Quota Manager is in progress.
       //      After the bug 742822 and 1286798 landed, localStorage usage will be included.
       //      So currently only get indexedDB usage.
-      this._quotaUsageRequest = this._qms.getUsage(onUsageResult);
+      this._quotaUsageRequest = Services.qms.getUsage(onUsageResult);
     });
     return this._getQuotaUsagePromise;
   },
@@ -228,6 +226,94 @@ var SiteDataManager = {
     }
   },
 
+  /**
+   * Gets the current AppCache usage by host. This is using asciiHost to compare
+   * against the provided host.
+   *
+   * @param {String} the ascii host to check usage for
+   * @returns the usage in bytes
+   */
+  getAppCacheUsageByHost(host) {
+    let usage = 0;
+
+    let groups;
+    try {
+      groups = this._appCache.getGroups();
+    } catch (e) {
+      // NS_ERROR_NOT_AVAILABLE means that appCache is not initialized,
+      // which probably means the user has disabled it. Otherwise, log an
+      // error. Either way, there's nothing we can do here.
+      if (e.result != Cr.NS_ERROR_NOT_AVAILABLE) {
+        Cu.reportError(e);
+      }
+      return usage;
+    }
+
+    for (let group of groups) {
+      let uri = Services.io.newURI(group);
+      if (uri.asciiHost == host) {
+        let cache = this._appCache.getActiveCache(group);
+        usage += cache.usage;
+      }
+    }
+
+    return usage;
+  },
+
+  /**
+   * Checks if the site with the provided ASCII host is using any site data at all.
+   * This will check for:
+   *   - Cookies (incl. subdomains)
+   *   - AppCache
+   *   - Quota Usage
+   * in that order. This function is meant to be fast, and thus will
+   * end searching and return true once the first trace of site data is found.
+   *
+   * @param {String} the ASCII host to check
+   * @returns {Boolean} whether the site has any data associated with it
+   */
+  async hasSiteData(asciiHost) {
+    if (Services.cookies.countCookiesFromHost(asciiHost)) {
+      return true;
+    }
+
+    let appCacheUsage = this.getAppCacheUsageByHost(asciiHost);
+    if (appCacheUsage > 0) {
+      return true;
+    }
+
+    let hasQuota = await new Promise(resolve => {
+      Services.qms.getUsage(request => {
+        if (request.resultCode != Cr.NS_OK) {
+          resolve(false);
+          return;
+        }
+
+        for (let item of request.result) {
+          if (!item.persisted && item.usage <= 0) {
+            continue;
+          }
+
+          let principal = Services.scriptSecurityManager.createContentPrincipalFromOrigin(
+            item.origin
+          );
+          if (principal.URI.asciiHost == asciiHost) {
+            resolve(true);
+            return;
+          }
+        }
+
+        resolve(false);
+      });
+    });
+
+    if (hasQuota) {
+      return true;
+    }
+
+    return false;
+  },
+
   getTotalUsage() {
     return this._getQuotaUsagePromise.then(() => {
       let usage = 0;