Bug 1933847 - Schema updates for stub installer exit code enhancements

schemas/firefox-installer/install/install.1.schema.json

@@ -44,7 +44,11 @@
       "type": "boolean"
     },
     "disk_space_error": {
-      "description": "True if the installation failed because the drive we're trying to install to does not have enough space",
+      "description": "[DEPRECATED] Use `disk_space_req_not_met` instead.",
+      "type": "boolean"
+    },
+    "disk_space_req_not_met": {
+      "description": "True if the installation failed because the drive we're trying to install to does not have enough space.",
       "type": "boolean"
     },
     "distribution_id": {
@@ -100,6 +104,10 @@
       "description": "True if at least one existing installation of Firefox was found on the system prior to this installation",
       "type": "boolean"
     },
+    "hardware_req_not_met": {
+      "description": "True if the system hardware does not meet the minimum hardware requirements.",
+      "type": "boolean"
+    },
     "install_time": {
       "description": "For a stub ping, seconds the full installer ran for. For a full ping, seconds spent on the install progress page.",
       "minimum": 0,
@@ -139,7 +147,7 @@
       "type": "boolean"
     },
     "no_write_access": {
-      "description": "True if the installation failed because the user doesn’t have permission to write to the path we’re trying to install to.",
+      "description": "[DEPRECATED] Use `writeable_req_not_met` instead.",
       "type": "boolean"
     },
     "old_build_id": {
@@ -151,7 +159,7 @@
       "type": "boolean"
     },
     "old_running": {
-      "description": "True if the installation succeeded and we weren’t able to launch the newly installed application because a copy of Firefox was already running.",
+      "description": "[DEPRECATED] Should always be false since Firefox 74, since this check was removed in that version.",
       "type": "boolean"
     },
     "old_version": {
@@ -167,6 +175,10 @@
       "description": "Windows version number in major.minor.build format",
       "type": "string"
     },
+    "os_version_req_not_met": {
+      "description": " True if the system does not meet the minimum OS version requirements.",
+      "type": "boolean"
+    },
     "out_of_retries": {
       "description": "True if the installation failed because the download had to be retried too many times (currently 10)",
       "type": "boolean"
@@ -200,6 +212,10 @@
       "description": "True if the option to set the new installation as the default browser was selected",
       "type": "boolean"
     },
+    "sig_check_timeout": {
+      "description": "True if there was a timeout on the the certificate checks",
+      "type": "boolean"
+    },
     "sig_not_trusted": {
       "description": "True if the installation failed because the signature on the downloaded file wasn’t valid and/or wasn’t signed by a trusted authority",
       "type": "boolean"
@@ -220,6 +236,10 @@
       "description": "True if a new installation was successfully created. If false, check the error status fields for the failure reason.",
       "type": "boolean"
     },
+    "unknown_error": {
+      "description": "Default failure exit code. Seeing this in telemetry indicates that the stub installer has exited unsuccessfully, but no reason has been specified",
+      "type": "boolean"
+    },
     "update_channel": {
       "description": "Value of MOZ_UPDATE_CHANNEL the installer was built with. Generally the same as build_channel",
       "type": "string"
@@ -235,6 +255,10 @@
     "windows_ubr": {
       "description": "The Windows Update Build Revision of the installation device, 0 if it does not exist",
       "type": "integer"
+    },
+    "writeable_req_not_met": {
+      "description": "True if the installation failed because the user doesn't have permission to write to the path we're trying to install to.",
+      "type": "boolean"
     }
   },
   "required": [

templates/firefox-installer/install/install.1.schema.json

@@ -157,11 +157,11 @@
       "type": "boolean"
     },
     "disk_space_error": {
-      "description": "True if the installation failed because the drive we're trying to install to does not have enough space",
+      "description": "[DEPRECATED] Use `disk_space_req_not_met` instead.",
       "type": "boolean"
     },
     "no_write_access": {
-      "description": "True if the installation failed because the user doesn’t have permission to write to the path we’re trying to install to.",
+      "description": "[DEPRECATED] Use `writeable_req_not_met` instead.",
       "type": "boolean"
     },
     "user_cancelled": {
@@ -193,7 +193,7 @@
       "type": "boolean"
     },
     "old_running": {
-      "description": "True if the installation succeeded and we weren’t able to launch the newly installed application because a copy of Firefox was already running.",
+      "description": "[DEPRECATED] Should always be false since Firefox 74, since this check was removed in that version.",
       "type": "boolean"
     },
     "attribution": {
@@ -235,6 +235,30 @@
     "windows_ubr": {
       "description": "The Windows Update Build Revision of the installation device, 0 if it does not exist",
       "type": "integer"
+    },
+    "disk_space_req_not_met": {
+      "description": "True if the installation failed because the drive we're trying to install to does not have enough space.",
+      "type": "boolean"
+    },
+    "hardware_req_not_met": {
+      "description": "True if the system hardware does not meet the minimum hardware requirements.",
+      "type": "boolean"
+    },
+    "os_version_req_not_met": {
+      "description": " True if the system does not meet the minimum OS version requirements.",
+      "type": "boolean"
+    },
+    "sig_check_timeout": {
+      "description": "True if there was a timeout on the the certificate checks",
+      "type": "boolean"
+    },
+    "unknown_error": {
+      "description": "Default failure exit code. Seeing this in telemetry indicates that the stub installer has exited unsuccessfully, but no reason has been specified",
+      "type": "boolean"
+    },
+    "writeable_req_not_met": {
+      "description": "True if the installation failed because the user doesn't have permission to write to the path we're trying to install to.",
+      "type": "boolean"
     }
   }
 }

validation/firefox-installer/install.1.stub-detailed-exit-status.pass.json

@@ -0,0 +1,41 @@
+{
+    "installer_type": "stub",
+    "installer_version": "132.0.0.1",
+    "build_channel": "release",
+    "update_channel": "release",
+    "version": "132.0.0.1",
+    "build_id": "20180816100035",
+    "locale": "en-US",
+    "64bit_build": true,
+    "64bit_os": true,
+    "os_version": "10.0.17134",
+    "server_os": false,
+    "admin_user": true,
+    "default_path": true,
+    "old_default": true,
+    "had_old_install": true,
+    "old_version": "63.0a1",
+    "old_build_id": "20180816100035",
+    "bytes_downloaded": 46201336,
+    "download_size": 46201336,
+    "download_retries": 0,
+    "download_time": 3,
+    "download_latency": 0,
+    "download_ip": "2600:9000:2145:f400:e:19d6:1546:5981",
+    "manual_download": true,
+    "options_time": 1,
+    "preinstall_time": 0,
+    "install_time": 7,
+    "finish_time": 1,
+    "succeeded": false,
+    "new_launched": false,
+    "attribution": "campaign%3Dtestcampaign%26content%3Dtestcontent%26medium%3Dtestmedium%26source%3Dmozilla.com",
+    "profile_cleanup_prompt": "paveover",
+    "profile_cleanup_requested": true,
+    "disk_space_req_not_met": false,
+    "hardware_req_not_met": false,
+    "os_version_req_not_met": true,
+    "sig_check_timeout": false,
+    "unknown_error": false,
+    "writeable_req_not_met": false
+  }