feat(artifacts): Emit granular installable app error codes (EME-883) (#603)

Author: runningcode

src/launchpad/artifact_processor.py

@@ -334,13 +334,19 @@ def _do_distribution(
             if not apple_info.is_code_signature_valid:
                 logger.warning(f"BUILD_DISTRIBUTION skipped for {artifact_id}: invalid code signature")
                 self._update_distribution_error(
-                    organization_id, artifact_id, InstallableAppErrorCode.SKIPPED, "invalid_signature"
+                    organization_id,
+                    artifact_id,
+                    InstallableAppErrorCode.INVALID_CODE_SIGNATURE,
+                    "The build's code signature could not be verified.",
                 )
                 return
             if apple_info.is_simulator:
                 logger.warning(f"BUILD_DISTRIBUTION skipped for {artifact_id}: simulator build")
                 self._update_distribution_error(
-                    organization_id, artifact_id, InstallableAppErrorCode.SKIPPED, "simulator"
+                    organization_id,
+                    artifact_id,
+                    InstallableAppErrorCode.SIMULATOR_BUILD,
+                    "Simulator builds cannot be distributed.",
                 )
                 return
             with tempfile.TemporaryDirectory() as temp_dir_str:
@@ -368,7 +374,10 @@ def _do_distribution(
         else:
             logger.error(f"BUILD_DISTRIBUTION failed for {artifact_id}: unsupported artifact type")
             self._update_distribution_error(
-                organization_id, artifact_id, InstallableAppErrorCode.PROCESSING_ERROR, "unsupported artifact type"
+                organization_id,
+                artifact_id,
+                InstallableAppErrorCode.UNSUPPORTED_ARTIFACT_TYPE,
+                "This artifact type is not supported for distribution.",
             )
 
     def _do_size(
@@ -465,7 +474,6 @@ def _update_distribution_error(
             "distribution.processing.error",
             tags=[
                 f"error_code:{error_code.value}",
-                f"error_message:{error_message}",
                 f"organization_id:{organization_id}",
             ],
         )

src/launchpad/constants.py

@@ -3,10 +3,8 @@
 from enum import Enum
 
 
-# Error code constants (matching the Django model)
+# Must stay in sync with PreprodArtifact.ErrorCode in sentry.
 class ProcessingErrorCode(Enum):
-    """Error codes for artifact processing (matching the Django model)."""
-
     UNKNOWN = 0
     UPLOAD_TIMEOUT = 1
     ARTIFACT_PROCESSING_TIMEOUT = 2
@@ -29,12 +27,19 @@ class PreprodFeature(Enum):
     BUILD_DISTRIBUTION = "build_distribution"
 
 
-# Matches InstallableApp.ErrorCode in sentry
+# Must stay in sync with PreprodArtifact.InstallableAppErrorCode in sentry.
+# Adding a value here without adding it on the sentry side will make the
+# distribution PUT 400 on pydantic validation.
 class InstallableAppErrorCode(Enum):
     UNKNOWN = 0
     NO_QUOTA = 1
     SKIPPED = 2
     PROCESSING_ERROR = 3
+    DISTRIBUTION_DISABLED = 4
+    DISTRIBUTION_FILTERED = 5
+    INVALID_CODE_SIGNATURE = 6
+    SIMULATOR_BUILD = 7
+    UNSUPPORTED_ARTIFACT_TYPE = 8
 
 
 # Health check threshold - consider unhealthy if file not touched in 60 seconds

tests/unit/artifacts/test_artifact_processor.py

@@ -155,15 +155,14 @@ def test_do_distribution_unknown_artifact_type_reports_error(self):
             org="test-org-id",
             artifact_id="test-artifact-id",
             data={
-                "error_code": InstallableAppErrorCode.PROCESSING_ERROR.value,
-                "error_message": "unsupported artifact type",
+                "error_code": InstallableAppErrorCode.UNSUPPORTED_ARTIFACT_TYPE.value,
+                "error_message": "This artifact type is not supported for distribution.",
             },
         )
         mock_statsd.increment.assert_called_once_with(
             "distribution.processing.error",
             tags=[
-                f"error_code:{InstallableAppErrorCode.PROCESSING_ERROR.value}",
-                "error_message:unsupported artifact type",
+                f"error_code:{InstallableAppErrorCode.UNSUPPORTED_ARTIFACT_TYPE.value}",
                 "organization_id:test-org-id",
             ],
         )
@@ -186,15 +185,14 @@ def test_do_distribution_invalid_code_signature_reports_skip(self):
             org="test-org-id",
             artifact_id="test-artifact-id",
             data={
-                "error_code": InstallableAppErrorCode.SKIPPED.value,
-                "error_message": "invalid_signature",
+                "error_code": InstallableAppErrorCode.INVALID_CODE_SIGNATURE.value,
+                "error_message": "The build's code signature could not be verified.",
             },
         )
         mock_statsd.increment.assert_called_once_with(
             "distribution.processing.error",
             tags=[
-                f"error_code:{InstallableAppErrorCode.SKIPPED.value}",
-                "error_message:invalid_signature",
+                f"error_code:{InstallableAppErrorCode.INVALID_CODE_SIGNATURE.value}",
                 "organization_id:test-org-id",
             ],
         )
@@ -218,15 +216,14 @@ def test_do_distribution_simulator_build_reports_skip(self):
             org="test-org-id",
             artifact_id="test-artifact-id",
             data={
-                "error_code": InstallableAppErrorCode.SKIPPED.value,
-                "error_message": "simulator",
+                "error_code": InstallableAppErrorCode.SIMULATOR_BUILD.value,
+                "error_message": "Simulator builds cannot be distributed.",
             },
         )
         mock_statsd.increment.assert_called_once_with(
             "distribution.processing.error",
             tags=[
-                f"error_code:{InstallableAppErrorCode.SKIPPED.value}",
-                "error_message:simulator",
+                f"error_code:{InstallableAppErrorCode.SIMULATOR_BUILD.value}",
                 "organization_id:test-org-id",
             ],
         )