Bug 1494781 - Include install error when reporting add-on study enroll errors r=aswan

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

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

toolkit/components/normandy/actions/AddonStudyAction.jsm

@@ -27,8 +27,14 @@ var EXPORTED_SYMBOLS = ["AddonStudyAction"];
 const OPT_OUT_STUDIES_ENABLED_PREF = "app.shield.optoutstudies.enabled";
 
 class AddonStudyEnrollError extends Error {
-  constructor(studyName, reason) {
+  /**
+   * @param {string} studyName
+   * @param {object} extra Extra details to include when reporting the error to telemetry.
+   * @param {string} extra.reason The specific reason for the failure.
+   */
+  constructor(studyName, extra) {
     let message;
+    let { reason } = extra;
     switch (reason) {
       case "conflicting-addon-id": {
         message = "an add-on with this ID is already installed";
@@ -44,7 +50,7 @@ class AddonStudyEnrollError extends Error {
     }
     super(new Error(`Cannot install study add-on for ${studyName}: ${message}.`));
     this.studyName = studyName;
-    this.reason = reason;
+    this.extra = extra;
   }
 }
 
@@ -146,7 +152,10 @@ class AddonStudyAction extends BaseAction {
 
     const listener = {
       onDownloadFailed() {
-        downloadDeferred.reject(new AddonStudyEnrollError(name, "download-failure"));
+        downloadDeferred.reject(new AddonStudyEnrollError(name, {
+          reason: "download-failure",
+          detail: AddonManager.errorToString(install.error),
+        }));
       },
 
       onDownloadEnded() {
@@ -156,14 +165,17 @@ class AddonStudyAction extends BaseAction {
 
       onInstallStarted(cbInstall) {
         if (cbInstall.existingAddon) {
-          installDeferred.reject(new AddonStudyEnrollError(name, "conflicting-addon-id"));
+          installDeferred.reject(new AddonStudyEnrollError(name, {reason: "conflicting-addon-id"}));
           return false; // cancel the installation, no upgrades allowed
         }
         return true;
       },
 
       onInstallFailed() {
-        installDeferred.reject(new AddonStudyEnrollError(name, "failed-to-install"));
+        installDeferred.reject(new AddonStudyEnrollError(name, {
+          reason: "failed-to-install",
+          detail: AddonManager.errorToString(install.error),
+        }));
       },
 
       onInstallEnded() {
@@ -228,7 +240,7 @@ class AddonStudyAction extends BaseAction {
   reportEnrollError(error) {
     if (error instanceof AddonStudyEnrollError) {
       // One of our known errors. Report it nicely to telemetry
-      TelemetryEvents.sendEvent("enrollFailed", "addon_study", error.studyName, { reason: error.reason });
+      TelemetryEvents.sendEvent("enrollFailed", "addon_study", error.studyName, error.extra);
     } else {
       /*
         * Some unknown error. Add some helpful details, and report it to

toolkit/components/normandy/lib/TelemetryEvents.jsm

@@ -21,7 +21,7 @@ const TelemetryEvents = {
     enroll_failed: {
       methods: ["enrollFailed"],
       objects: ["addon_study", "preference_rollout", "preference_study"],
-      extra_keys: ["reason", "preference"],
+      extra_keys: ["reason", "preference", "detail"],
       record_on_release: true,
     },
 

toolkit/components/normandy/test/browser/browser_actions_AddonStudyAction.js

@@ -77,7 +77,7 @@ decorate_task(
 
     Assert.deepEqual(
       sendEventStub.args,
-      [["enrollFailed", "addon_study", recipe.arguments.name, {reason: "download-failure"}]],
+      [["enrollFailed", "addon_study", recipe.arguments.name, {reason: "download-failure", detail: "ERROR_NETWORK_FAILURE"}]],
       "An enrollFailed event should be sent",
     );
   }