feat(aci): Add available detector types to validation error (#93203)

Author: scttcper

src/sentry/workflow_engine/endpoints/organization_detector_details.py

@@ -28,6 +28,7 @@
 from sentry.utils.audit import create_audit_entry
 from sentry.workflow_engine.endpoints.serializers import DetectorSerializer
 from sentry.workflow_engine.endpoints.validators.detector_workflow import can_edit_detector
+from sentry.workflow_engine.endpoints.validators.utils import get_unknown_detector_type_error
 from sentry.workflow_engine.models import Detector
 
 
@@ -36,7 +37,8 @@ def get_detector_validator(
 ):
     detector_type = grouptype.registry.get_by_slug(detector_type_slug)
     if detector_type is None:
-        raise ValidationError({"detectorType": ["Unknown detector type"]})
+        error_message = get_unknown_detector_type_error(detector_type_slug, project.organization)
+        raise ValidationError({"detectorType": [error_message]})
 
     if detector_type.detector_settings is None or detector_type.detector_settings.validator is None:
         raise ValidationError({"detectorType": ["Detector type not compatible with detectors"]})

src/sentry/workflow_engine/endpoints/organization_detector_index.py

@@ -26,6 +26,7 @@
 from sentry.workflow_engine.endpoints.serializers import DetectorSerializer
 from sentry.workflow_engine.endpoints.utils.sortby import SortByParam
 from sentry.workflow_engine.endpoints.validators.base import BaseDetectorTypeValidator
+from sentry.workflow_engine.endpoints.validators.utils import get_unknown_detector_type_error
 from sentry.workflow_engine.models import Detector
 
 # Maps API field name to database field name, with synthetic aggregate fields keeping
@@ -43,7 +44,8 @@ def get_detector_validator(
 ) -> BaseDetectorTypeValidator:
     detector_type = grouptype.registry.get_by_slug(detector_type_slug)
     if detector_type is None:
-        raise ValidationError({"detectorType": ["Unknown detector type"]})
+        error_message = get_unknown_detector_type_error(detector_type_slug, project.organization)
+        raise ValidationError({"detectorType": [error_message]})
 
     if detector_type.detector_settings is None or detector_type.detector_settings.validator is None:
         raise ValidationError({"detectorType": ["Detector type not compatible with detectors"]})

src/sentry/workflow_engine/endpoints/validators/base/detector.py

@@ -10,6 +10,7 @@
     BaseDataConditionValidator,
     BaseDataSourceValidator,
 )
+from sentry.workflow_engine.endpoints.validators.utils import get_unknown_detector_type_error
 from sentry.workflow_engine.models import (
     DataConditionGroup,
     DataSource,
@@ -31,7 +32,12 @@ class BaseDetectorTypeValidator(CamelSnakeSerializer):
     def validate_detector_type(self, value: str) -> type[GroupType]:
         detector_type = grouptype.registry.get_by_slug(value)
         if detector_type is None:
-            raise serializers.ValidationError("Unknown detector type")
+            organization = self.context.get("organization")
+            if organization:
+                error_message = get_unknown_detector_type_error(value, organization)
+            else:
+                error_message = f"Unknown detector type '{value}'"
+            raise serializers.ValidationError(error_message)
         if (
             detector_type.detector_settings is None
             or detector_type.detector_settings.validator is None

src/sentry/workflow_engine/endpoints/validators/utils.py

@@ -4,6 +4,9 @@
 from jsonschema import ValidationError as JsonValidationError
 from jsonschema import validate
 
+from sentry.issues import grouptype
+from sentry.models.organization import Organization
+
 
 def validate_json_schema(value, schema):
     try:
@@ -33,3 +36,18 @@ def remove_items_by_api_input(
     if has_items_removed:
         filter_kwargs = {f"{values_list_field}__in": data_ids}
         instance.exclude(**filter_kwargs).delete()
+
+
+def get_unknown_detector_type_error(bad_value: str, organization: Organization) -> str:
+    available_types = [
+        gt.slug
+        for gt in grouptype.registry.get_visible(organization)
+        if gt.detector_settings is not None and gt.detector_settings.validator is not None
+    ]
+    available_types.sort()
+
+    if available_types:
+        available_str = ", ".join(available_types)
+        return f"Unknown detector type '{bad_value}'. Must be one of: {available_str}"
+    else:
+        return f"Unknown detector type '{bad_value}'. No detector types are available."

tests/sentry/incidents/endpoints/validators/test_validators.py

@@ -202,7 +202,9 @@ def test_invalid_detector_type(self):
         validator = MetricAlertsDetectorValidator(data=data, context=self.context)
         assert not validator.is_valid()
         assert validator.errors.get("detectorType") == [
-            ErrorDetail(string="Unknown detector type", code="invalid")
+            ErrorDetail(
+                string="Unknown detector type 'invalid_type'. Must be one of: error", code="invalid"
+            )
         ]
 
     def test_too_many_conditions(self):

tests/sentry/workflow_engine/endpoints/test_organization_detector_index.py

@@ -321,7 +321,9 @@ def test_invalid_group_type(self):
             **data,
             status_code=400,
         )
-        assert response.data == {"detectorType": ["Unknown detector type"]}
+        assert response.data == {
+            "detectorType": ["Unknown detector type 'invalid_type'. Must be one of: error"]
+        }
 
     def test_incompatible_group_type(self):
         with mock.patch("sentry.issues.grouptype.registry.get_by_slug") as mock_get:

tests/sentry/workflow_engine/endpoints/test_validators.py

@@ -131,7 +131,7 @@ def test_validate_detector_type_unknown(self):
             validator = self.validator_class()
             with pytest.raises(
                 ValidationError,
-                match="[ErrorDetail(string='Unknown detector type', code='invalid')]",
+                match="[ErrorDetail(string='Unknown detector type 'unknown_type'. Must be one of: error', code='invalid')]",
             ):
                 validator.validate_detector_type("unknown_type")
 
@@ -233,7 +233,7 @@ def test_validate_detector_type_unknown(self):
         validator = MockDetectorValidator(data={**self.valid_data, "detectorType": "unknown_type"})
         assert not validator.is_valid()
         assert validator.errors.get("detectorType") == [
-            ErrorDetail(string="Unknown detector type", code="invalid")
+            ErrorDetail(string="Unknown detector type 'unknown_type'", code="invalid")
         ], validator.errors
 
     def test_validate_detector_type_incompatible(self):