feat(aci): add detector types endpoint (#87401)

adds endpoint to fetch available detector types for the UI

Author: ameliahsu

src/sentry/workflow_engine/endpoints/organization_detector_types.py

@@ -0,0 +1,54 @@
+from drf_spectacular.utils import extend_schema
+
+from sentry.api.api_owners import ApiOwner
+from sentry.api.api_publish_status import ApiPublishStatus
+from sentry.api.base import region_silo_endpoint
+from sentry.api.bases import OrganizationEndpoint
+from sentry.api.paginator import OffsetPaginator
+from sentry.apidocs.constants import (
+    RESPONSE_BAD_REQUEST,
+    RESPONSE_FORBIDDEN,
+    RESPONSE_NOT_FOUND,
+    RESPONSE_UNAUTHORIZED,
+)
+from sentry.apidocs.parameters import GlobalParams
+from sentry.apidocs.utils import inline_sentry_response_serializer
+from sentry.issues import grouptype
+
+
+@region_silo_endpoint
+class OrganizationDetectorTypeIndexEndpoint(OrganizationEndpoint):
+    publish_status = {
+        "GET": ApiPublishStatus.EXPERIMENTAL,
+    }
+    owner = ApiOwner.ISSUES
+
+    @extend_schema(
+        operation_id="Fetch Detector Types",
+        parameters=[
+            GlobalParams.ORG_ID_OR_SLUG,
+        ],
+        responses={
+            201: inline_sentry_response_serializer("ListDetectorTypes", list[str]),
+            400: RESPONSE_BAD_REQUEST,
+            401: RESPONSE_UNAUTHORIZED,
+            403: RESPONSE_FORBIDDEN,
+            404: RESPONSE_NOT_FOUND,
+        },
+    )
+    def get(self, request, organization):
+        """
+        Returns a list of detector types for a given org
+        """
+        type_slugs = [
+            gt.slug
+            for gt in grouptype.registry.get_visible(organization)
+            if gt.detector_handler is not None
+        ]
+        type_slugs.sort()
+
+        return self.paginate(
+            request=request,
+            queryset=type_slugs,
+            paginator_cls=OffsetPaginator,
+        )

src/sentry/workflow_engine/endpoints/urls.py

@@ -1,6 +1,7 @@
 from django.urls import re_path
 
 from .organization_data_condition_index import OrganizationDataConditionIndexEndpoint
+from .organization_detector_types import OrganizationDetectorTypeIndexEndpoint
 from .organization_workflow_details import OrganizationWorkflowDetailsEndpoint
 from .organization_workflow_index import OrganizationWorkflowIndexEndpoint
 from .project_detector_details import ProjectDetectorDetailsEndpoint
@@ -46,4 +47,9 @@
         OrganizationDataConditionIndexEndpoint.as_view(),
         name="sentry-api-0-organization-data-condition-index",
     ),
+    re_path(
+        r"^(?P<organization_id_or_slug>[^\/]+)/detector_types/$",
+        OrganizationDetectorTypeIndexEndpoint.as_view(),
+        name="sentry-api-0-organization-detector-type-index",
+    ),
 ]

tests/sentry/workflow_engine/endpoints/test_organization_detector_types.py

@@ -0,0 +1,87 @@
+from dataclasses import dataclass
+from unittest.mock import patch
+
+from sentry.incidents.grouptype import MetricAlertFire
+from sentry.issues.grouptype import (
+    GroupCategory,
+    GroupType,
+    GroupTypeRegistry,
+    MonitorIncidentType,
+    PerformanceSlowDBQueryGroupType,
+    UptimeDomainCheckFailure,
+)
+from sentry.testutils.cases import APITestCase
+from sentry.testutils.silo import region_silo_test
+from sentry.workflow_engine.handlers.detector import DetectorEvaluationResult, DetectorHandler
+from sentry.workflow_engine.models import DataPacket
+from sentry.workflow_engine.types import DetectorGroupKey, DetectorPriorityLevel
+
+
+@region_silo_test
+class OrganizationDetectorTypesAPITestCase(APITestCase):
+    endpoint = "sentry-api-0-organization-detector-type-index"
+
+    def setUp(self):
+        super().setUp()
+        self.login_as(user=self.user)
+
+        self.registry_patcher = patch(
+            "sentry.workflow_engine.endpoints.organization_detector_types.grouptype.registry",
+            new=GroupTypeRegistry(),
+        )
+        self.registry_patcher.start()
+
+        class MockDetectorHandler(DetectorHandler[dict]):
+            def evaluate(
+                self, data_packet: DataPacket[dict]
+            ) -> dict[DetectorGroupKey, DetectorEvaluationResult]:
+                return {None: DetectorEvaluationResult(None, True, DetectorPriorityLevel.HIGH)}
+
+        @dataclass(frozen=True)
+        class TestMetricGroupType(GroupType):
+            type_id = 1
+            slug = MetricAlertFire.slug
+            description = "Metric alert"
+            category = GroupCategory.METRIC_ALERT.value
+            detector_handler = MockDetectorHandler
+            released = True
+
+        @dataclass(frozen=True)
+        class TestCronsGroupType(GroupType):
+            type_id = 2
+            slug = MonitorIncidentType.slug
+            description = "Crons"
+            category = GroupCategory.CRON.value
+            detector_handler = MockDetectorHandler
+            released = True
+
+        @dataclass(frozen=True)
+        class TestUptimeGroupType(GroupType):
+            type_id = 3
+            slug = UptimeDomainCheckFailure.slug
+            description = "Uptime"
+            category = GroupCategory.UPTIME.value
+            detector_handler = MockDetectorHandler
+            released = True
+
+        # Should not be included in the response
+        @dataclass(frozen=True)
+        class TestPerformanceGroupType(GroupType):
+            type_id = 4
+            slug = PerformanceSlowDBQueryGroupType.slug
+            description = "Performance"
+            category = GroupCategory.PERFORMANCE.value
+            released = True
+
+    def tearDown(self):
+        super().tearDown()
+        self.registry_patcher.stop()
+
+    def test_simple(self):
+        response = self.get_success_response(self.organization.slug, status_code=200)
+        assert len(response.data) == 3
+        assert response.data == [
+            MetricAlertFire.slug,
+            MonitorIncidentType.slug,
+            UptimeDomainCheckFailure.slug,
+        ]