Bug 1830725: Synchronous nsWindowsPackageManager::GetCampaignId blocks main thread for many seconds r=nrishel

Made GetCampaignId asynchronous to not block anything.
Also fix Bug 1872933 (broken build)

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

Author: mhughes-mozilla

browser/components/attribution/AttributionCode.sys.mjs

@@ -64,10 +64,12 @@ export var AttributionCode = {
    * Wrapper to pull campaign IDs from MSIX builds.
    * This function solely exists to make it easy to mock out for tests.
    */
-  get msixCampaignId() {
-    return Cc["@mozilla.org/windows-package-manager;1"]
-      .createInstance(Ci.nsIWindowsPackageManager)
-      .getCampaignId();
+  async msixCampaignId() {
+    const windowsPackageManager = Cc[
+      "@mozilla.org/windows-package-manager;1"
+    ].createInstance(Ci.nsIWindowsPackageManager);
+
+    return windowsPackageManager.campaignId();
   },
 
   /**
@@ -346,7 +348,7 @@ export var AttributionCode = {
           )}`
         );
         let encoder = new TextEncoder();
-        bytes = encoder.encode(encodeURIComponent(this.msixCampaignId));
+        bytes = encoder.encode(encodeURIComponent(await this.msixCampaignId()));
       } else {
         bytes = await AttributionIOUtils.read(attributionFile.path);
       }

browser/components/attribution/test/browser/browser_AttributionCode_telemetry.js

@@ -80,9 +80,17 @@ add_task(async function test_read_error() {
     throw new Error("read_error");
   };
 
+  // On MSIX builds, AttributionIOUtils.read is not used; AttributionCode.msixCampaignId is.
+  // Ensure we override that as well.
+  let oldMsixCampaignId = AttributionCode.msixCampaignId;
+  AttributionCode.msixCampaignId = async () => {
+    throw new Error("read_error");
+  };
+
   registerCleanupFunction(() => {
     AttributionIOUtils.exists = oldExists;
     AttributionIOUtils.read = oldRead;
+    AttributionCode.msixCampaignId = oldMsixCampaignId;
   });
 
   // Try to read the file

browser/components/attribution/test/xpcshell/test_AttributionCode.js

@@ -20,6 +20,8 @@ add_task(async () => {
  * to make sure we reject bad ones and accept good ones.
  */
 add_task(async function testValidAttrCodes() {
+  let msixCampaignIdStub = sinon.stub(AttributionCode, "msixCampaignId");
+
   let currentCode = null;
   for (let entry of validAttrCodes) {
     currentCode = entry.code;
@@ -36,28 +38,32 @@ add_task(async function testValidAttrCodes() {
       // In real life, the attribution codes returned from Microsoft APIs
       // are not URI encoded, and the AttributionCode code that deals with
       // them expects that - so we have to simulate that as well.
-      sinon
-        .stub(AttributionCode, "msixCampaignId")
-        .get(() => decodeURIComponent(currentCode));
+      msixCampaignIdStub.callsFake(async () => decodeURIComponent(currentCode));
     } else {
       await AttributionCode.writeAttributionFile(currentCode);
     }
     AttributionCode._clearCache();
     let result = await AttributionCode.getAttrDataAsync();
+
     Assert.deepEqual(
       result,
       entry.parsed,
       "Parsed code should match expected value, code was: " + currentCode
     );
   }
   AttributionCode._clearCache();
+
+  // Restore the msixCampaignId stub so that other tests don't fail stubbing it
+  msixCampaignIdStub.restore();
 });
 
 /**
  * Make sure codes with various formatting errors are not seen as valid.
  */
 add_task(async function testInvalidAttrCodes() {
+  let msixCampaignIdStub = sinon.stub(AttributionCode, "msixCampaignId");
   let currentCode = null;
+
   for (let code of invalidAttrCodes) {
     currentCode = code;
 
@@ -73,9 +79,7 @@ add_task(async function testInvalidAttrCodes() {
         continue;
       }
 
-      sinon
-        .stub(AttributionCode, "msixCampaignId")
-        .get(() => decodeURIComponent(currentCode));
+      msixCampaignIdStub.callsFake(async () => decodeURIComponent(currentCode));
     } else {
       await AttributionCode.writeAttributionFile(currentCode);
     }
@@ -88,6 +92,9 @@ add_task(async function testInvalidAttrCodes() {
     );
   }
   AttributionCode._clearCache();
+
+  // Restore the msixCampaignId stub so that other tests don't fail stubbing it
+  msixCampaignIdStub.restore();
 });
 
 /**

toolkit/system/windowsPackageManager/nsIWindowsPackageManager.idl

@@ -23,7 +23,7 @@ interface nsIWindowsPackageManager : nsISupports
  */
     unsigned long long getInstalledDate();
 
-/* Retrieves the campaignId, if any, a user's Microsoft Store install is
+/* Asynchronously retrieves the campaignId, if any, a user's Microsoft Store install is
  * associated with. These are present if the user clicked a "ms-window-store://"
  * or "https://" link that included a "cid" query argument the very first time
  * they installed the app. (This value appears to be cached forever, so
@@ -37,5 +37,6 @@ interface nsIWindowsPackageManager : nsISupports
  * a non-packaged build.
  * @throw NS_ERROR_FAILURE for any other errors
  */
-    AString getCampaignId();
+    [implicit_jscontext]
+    Promise campaignId();
 };