Bug 1703578 - Part 4: Record setAsDefaultUserChoice() result telemetry. r=bytesized

Depends on D113428

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

Author: agashlin

browser/components/shell/ShellService.jsm

@@ -145,36 +145,65 @@ let ShellServiceInternal = {
     // quarrantine any program that writes UserChoice, though this has not
     // occurred during extensive testing.
 
-    if (!ShellService.checkAllProgIDsExist()) {
-      throw new Error("checkAllProgIDsExist() failed");
-    }
-
-    if (!ShellService.checkBrowserUserChoiceHashes()) {
-      throw new Error("checkBrowserUserChoiceHashes() failed");
-    }
+    let telemetryResult = "ErrOther";
 
-    const wdba = Services.dirsvc.get("XREExeF", Ci.nsIFile);
-    wdba.leafName = "default-browser-agent.exe";
-    const aumi = XreDirProvider.getInstallHash();
+    try {
+      if (!ShellService.checkAllProgIDsExist()) {
+        telemetryResult = "ErrProgID";
+        throw new Error("checkAllProgIDsExist() failed");
+      }
 
-    const exeProcess = await Subprocess.call({
-      command: wdba.path,
-      arguments: ["set-default-browser-user-choice", aumi],
-    });
+      if (!ShellService.checkBrowserUserChoiceHashes()) {
+        telemetryResult = "ErrHash";
+        throw new Error("checkBrowserUserChoiceHashes() failed");
+      }
 
-    // exit codes
-    const S_OK = 0;
-    const STILL_ACTIVE = 0x103;
+      const wdba = Services.dirsvc.get("XREExeF", Ci.nsIFile);
+      wdba.leafName = "default-browser-agent.exe";
+      const aumi = XreDirProvider.getInstallHash();
 
-    const exeWaitTimeoutMs = 2000; // 2 seconds
-    const exeWaitPromise = exeProcess.wait();
-    const timeoutPromise = new Promise(function(resolve, reject) {
-      setTimeout(() => resolve({ exitCode: STILL_ACTIVE }), exeWaitTimeoutMs);
-    });
-    const { exitCode } = await Promise.race([exeWaitPromise, timeoutPromise]);
+      telemetryResult = "ErrLaunchExe";
+      const exeProcess = await Subprocess.call({
+        command: wdba.path,
+        arguments: ["set-default-browser-user-choice", aumi],
+      });
+      telemetryResult = "ErrOther";
+
+      // Exit codes, see toolkit/mozapps/defaultagent/SetDefaultBrowser.h
+      const S_OK = 0;
+      const STILL_ACTIVE = 0x103;
+      const MOZ_E_NO_PROGID = 0xa0000001;
+      const MOZ_E_HASH_CHECK = 0xa0000002;
+      const MOZ_E_REJECTED = 0xa0000003;
+
+      const exeWaitTimeoutMs = 2000; // 2 seconds
+      const exeWaitPromise = exeProcess.wait();
+      const timeoutPromise = new Promise(function(resolve, reject) {
+        setTimeout(() => resolve({ exitCode: STILL_ACTIVE }), exeWaitTimeoutMs);
+      });
+      const { exitCode } = await Promise.race([exeWaitPromise, timeoutPromise]);
+
+      if (exitCode != S_OK) {
+        telemetryResult =
+          new Map([
+            [STILL_ACTIVE, "ErrExeTimeout"],
+            [MOZ_E_NO_PROGID, "ErrExeProgID"],
+            [MOZ_E_HASH_CHECK, "ErrExeHash"],
+            [MOZ_E_REJECTED, "ErrExeRejected"],
+          ]).get(exitCode) ?? "ErrExeOther";
+        throw new Error(
+          `WDBA nonzero exit code ${exitCode}: ${telemetryResult}`
+        );
+      }
 
-    if (exitCode != S_OK) {
-      throw new Error(`WDBA nonzero exit code ${exitCode}`);
+      telemetryResult = "Success";
+    } finally {
+      try {
+        const histogram = Services.telemetry.getHistogramById(
+          "BROWSER_SET_DEFAULT_USER_CHOICE_RESULT"
+        );
+        histogram.add(telemetryResult);
+      } catch (ex) {}
     }
   },
 

toolkit/components/telemetry/Histograms.json

@@ -11826,6 +11826,18 @@
     "releaseChannelCollection": "opt-out",
     "description": "True if the browser was unable to set Firefox as the default browser"
   },
+  "BROWSER_SET_DEFAULT_USER_CHOICE_RESULT": {
+    "record_in_processes": ["main"],
+    "products": ["firefox"],
+    "operating_systems": ["windows"],
+    "expires_in_version": "96",
+    "kind": "categorical",
+    "labels": ["Success", "ErrProgID", "ErrHash", "ErrLaunchExe", "ErrExeTimeout", "ErrExeProgID", "ErrExeHash", "ErrExeRejected", "ErrExeOther", "ErrOther"],
+    "releaseChannelCollection": "opt-out",
+    "bug_numbers": [1703578],
+    "alert_emails": ["application-update-telemetry-alerts@mozilla.com", "agashlin@mozilla.com"],
+    "description": "Result of each attempt to set the default browser with SetDefaultBrowserUserChoice()"
+  },
   "BROWSER_IS_ASSIST_DEFAULT": {
     "record_in_processes": ["main"],
     "products": ["firefox", "fennec"],