feat(aci): add Incident to GroupOpenPeriod lookup endpoint (#103782)

need this endpoint to redirect metric alert urls to the new group open
period

---------

Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>

Author: ameliahsu

src/sentry/workflow_engine/endpoints/organization_incident_groupopenperiod_index.py

@@ -0,0 +1,80 @@
+from drf_spectacular.utils import extend_schema
+from rest_framework.response import Response
+
+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.bases.organization import OrganizationDetectorPermission
+from sentry.api.exceptions import ResourceDoesNotExist
+from sentry.api.serializers import serialize
+from sentry.apidocs.constants import (
+    RESPONSE_BAD_REQUEST,
+    RESPONSE_FORBIDDEN,
+    RESPONSE_NOT_FOUND,
+    RESPONSE_UNAUTHORIZED,
+)
+from sentry.apidocs.parameters import GlobalParams
+from sentry.workflow_engine.endpoints.serializers.incident_groupopenperiod_serializer import (
+    IncidentGroupOpenPeriodSerializer,
+)
+from sentry.workflow_engine.endpoints.validators.incident_groupopenperiod import (
+    IncidentGroupOpenPeriodValidator,
+)
+from sentry.workflow_engine.models.incident_groupopenperiod import IncidentGroupOpenPeriod
+
+
+@region_silo_endpoint
+class OrganizationIncidentGroupOpenPeriodIndexEndpoint(OrganizationEndpoint):
+    publish_status = {
+        "GET": ApiPublishStatus.EXPERIMENTAL,
+    }
+    owner = ApiOwner.ISSUES
+    permission_classes = (OrganizationDetectorPermission,)
+
+    @extend_schema(
+        operation_id="Fetch Incident and Group Open Period Relationship",
+        parameters=[
+            GlobalParams.ORG_ID_OR_SLUG,
+        ],
+        responses={
+            200: IncidentGroupOpenPeriodSerializer,
+            400: RESPONSE_BAD_REQUEST,
+            401: RESPONSE_UNAUTHORIZED,
+            403: RESPONSE_FORBIDDEN,
+            404: RESPONSE_NOT_FOUND,
+        },
+    )
+    def get(self, request, organization):
+        """
+        Returns an incident and group open period relationship.
+        Can optionally filter by incident_id, incident_identifier, group_id, or open_period_id.
+        """
+        validator = IncidentGroupOpenPeriodValidator(data=request.query_params)
+        validator.is_valid(raise_exception=True)
+        incident_id = validator.validated_data.get("incident_id")
+        incident_identifier = validator.validated_data.get("incident_identifier")
+        group_id = validator.validated_data.get("group_id")
+        open_period_id = validator.validated_data.get("open_period_id")
+
+        queryset = IncidentGroupOpenPeriod.objects.filter(
+            group_open_period__project__organization=organization
+        )
+
+        if incident_id:
+            queryset = queryset.filter(incident_id=incident_id)
+
+        if incident_identifier:
+            queryset = queryset.filter(incident_identifier=incident_identifier)
+
+        if group_id:
+            queryset = queryset.filter(group_open_period__group_id=group_id)
+
+        if open_period_id:
+            queryset = queryset.filter(group_open_period_id=open_period_id)
+
+        incident_groupopenperiod = queryset.first()
+        if not incident_groupopenperiod:
+            raise ResourceDoesNotExist
+
+        return Response(serialize(incident_groupopenperiod, request.user))

src/sentry/workflow_engine/endpoints/serializers/incident_groupopenperiod_serializer.py

@@ -0,0 +1,25 @@
+from collections.abc import Mapping
+from typing import Any, TypedDict
+
+from sentry.api.serializers import Serializer, register
+from sentry.workflow_engine.models.incident_groupopenperiod import IncidentGroupOpenPeriod
+
+
+class IncidentGroupOpenPeriodSerializerResponse(TypedDict):
+    incidentId: str | None
+    incidentIdentifier: int | None
+    groupId: str
+    openPeriodId: str
+
+
+@register(IncidentGroupOpenPeriod)
+class IncidentGroupOpenPeriodSerializer(Serializer):
+    def serialize(
+        self, obj: IncidentGroupOpenPeriod, attrs: Mapping[str, Any], user, **kwargs
+    ) -> IncidentGroupOpenPeriodSerializerResponse:
+        return {
+            "incidentId": str(obj.incident_id) if obj.incident_id else None,
+            "incidentIdentifier": obj.incident_identifier,
+            "groupId": str(obj.group_open_period.group_id),
+            "openPeriodId": str(obj.group_open_period.id),
+        }

src/sentry/workflow_engine/endpoints/urls.py

@@ -1,12 +1,7 @@
 from django.urls import re_path
 
-from sentry.workflow_engine.endpoints.organization_alertrule_detector_index import (
-    OrganizationAlertRuleDetectorIndexEndpoint,
-)
-from sentry.workflow_engine.endpoints.organization_alertrule_workflow_index import (
-    OrganizationAlertRuleWorkflowIndexEndpoint,
-)
-
+from .organization_alertrule_detector_index import OrganizationAlertRuleDetectorIndexEndpoint
+from .organization_alertrule_workflow_index import OrganizationAlertRuleWorkflowIndexEndpoint
 from .organization_available_action_index import OrganizationAvailableActionIndexEndpoint
 from .organization_data_condition_index import OrganizationDataConditionIndexEndpoint
 from .organization_detector_count import OrganizationDetectorCountEndpoint
@@ -15,6 +10,9 @@
 from .organization_detector_types import OrganizationDetectorTypeIndexEndpoint
 from .organization_detector_workflow_details import OrganizationDetectorWorkflowDetailsEndpoint
 from .organization_detector_workflow_index import OrganizationDetectorWorkflowIndexEndpoint
+from .organization_incident_groupopenperiod_index import (
+    OrganizationIncidentGroupOpenPeriodIndexEndpoint,
+)
 from .organization_open_periods import OrganizationOpenPeriodsEndpoint
 from .organization_test_fire_action import OrganizationTestFireActionsEndpoint
 from .organization_workflow_details import OrganizationWorkflowDetailsEndpoint
@@ -114,4 +112,9 @@
         OrganizationAlertRuleDetectorIndexEndpoint.as_view(),
         name="sentry-api-0-organization-alert-rule-detector-index",
     ),
+    re_path(
+        r"^(?P<organization_id_or_slug>[^/]+)/incident-groupopenperiod/$",
+        OrganizationIncidentGroupOpenPeriodIndexEndpoint.as_view(),
+        name="sentry-api-0-organization-incident-groupopenperiod-index",
+    ),
 ]

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

@@ -0,0 +1,21 @@
+from rest_framework import serializers
+
+
+class IncidentGroupOpenPeriodValidator(serializers.Serializer):
+    incident_id = serializers.IntegerField(required=False)
+    incident_identifier = serializers.IntegerField(required=False)
+    group_id = serializers.IntegerField(required=False)
+    open_period_id = serializers.IntegerField(required=False)
+
+    def validate(self, attrs):
+        super().validate(attrs)
+        if (
+            not attrs.get("incident_id")
+            and not attrs.get("incident_identifier")
+            and not attrs.get("group_id")
+            and not attrs.get("open_period_id")
+        ):
+            raise serializers.ValidationError(
+                "One of 'incident_id', 'incident_identifier', 'group_id', or 'open_period_id' must be provided."
+            )
+        return attrs

static/app/utils/api/knownSentryApiUrls.generated.ts

@@ -346,6 +346,7 @@ export type KnownSentryApiUrls =
   | '/organizations/$organizationIdOrSlug/groups/$issueId/tags/$key/values/'
   | '/organizations/$organizationIdOrSlug/groups/$issueId/user-feedback/'
   | '/organizations/$organizationIdOrSlug/groups/$issueId/user-reports/'
+  | '/organizations/$organizationIdOrSlug/incident-groupopenperiod/'
   | '/organizations/$organizationIdOrSlug/incidents/'
   | '/organizations/$organizationIdOrSlug/incidents/$incidentIdentifier/'
   | '/organizations/$organizationIdOrSlug/insights/starred-segments/'

tests/sentry/workflow_engine/endpoints/test_organization_incident_groupopenperiod.py

@@ -0,0 +1,105 @@
+from sentry.api.serializers import serialize
+from sentry.incidents.grouptype import MetricIssue
+from sentry.models.groupopenperiod import GroupOpenPeriod
+from sentry.testutils.cases import APITestCase
+from sentry.testutils.silo import region_silo_test
+
+
+class OrganizationIncidentGroupOpenPeriodAPITestCase(APITestCase):
+    endpoint = "sentry-api-0-organization-incident-groupopenperiod-index"
+
+    def setUp(self) -> None:
+        super().setUp()
+        self.login_as(user=self.user)
+
+        # Create groups and incidents
+        self.group_1 = self.create_group(type=MetricIssue.type_id)
+        self.group_2 = self.create_group(type=MetricIssue.type_id)
+        self.group_3 = self.create_group(type=MetricIssue.type_id)
+
+        # Get the open periods created automatically with the groups
+        self.open_period_1 = GroupOpenPeriod.objects.get(group=self.group_1)
+        self.open_period_2 = GroupOpenPeriod.objects.get(group=self.group_2)
+        self.open_period_3 = GroupOpenPeriod.objects.get(group=self.group_3)
+
+        # Create incidents
+        self.alert_rule = self.create_alert_rule()
+        self.incident_1 = self.create_incident(
+            organization=self.organization, projects=[self.project], alert_rule=self.alert_rule
+        )
+        self.incident_2 = self.create_incident(
+            organization=self.organization, projects=[self.project], alert_rule=self.alert_rule
+        )
+        self.incident_3 = self.create_incident(
+            organization=self.organization, projects=[self.project], alert_rule=self.alert_rule
+        )
+
+        # Create incident-group-open-period relationships
+        self.igop_1 = self.create_incident_group_open_period(
+            incident=self.incident_1, group_open_period=self.open_period_1
+        )
+        self.igop_2 = self.create_incident_group_open_period(
+            incident=self.incident_2, group_open_period=self.open_period_2
+        )
+        self.igop_3 = self.create_incident_group_open_period(
+            incident=self.incident_3, group_open_period=self.open_period_3
+        )
+
+
+@region_silo_test
+class OrganizationIncidentGroupOpenPeriodIndexGetTest(
+    OrganizationIncidentGroupOpenPeriodAPITestCase
+):
+    def test_get_with_incident_id_filter(self) -> None:
+        response = self.get_success_response(
+            self.organization.slug, incident_id=str(self.incident_1.id)
+        )
+        assert response.data == serialize(self.igop_1, self.user)
+
+    def test_get_with_incident_identifier_filter(self) -> None:
+        response = self.get_success_response(
+            self.organization.slug, incident_identifier=str(self.incident_1.identifier)
+        )
+        assert response.data == serialize(self.igop_1, self.user)
+
+    def test_get_with_group_id_filter(self) -> None:
+        response = self.get_success_response(self.organization.slug, group_id=str(self.group_2.id))
+        assert response.data == serialize(self.igop_2, self.user)
+
+    def test_get_with_open_period_id_filter(self) -> None:
+        response = self.get_success_response(
+            self.organization.slug, open_period_id=str(self.open_period_3.id)
+        )
+        assert response.data == serialize(self.igop_3, self.user)
+
+    def test_get_with_multiple_filters(self) -> None:
+        response = self.get_success_response(
+            self.organization.slug,
+            incident_id=str(self.incident_1.id),
+            group_id=str(self.group_1.id),
+        )
+        assert response.data == serialize(self.igop_1, self.user)
+
+    def test_get_with_multiple_filters_with_invalid_filter(self) -> None:
+        self.get_error_response(
+            self.organization.slug,
+            incident_id=str(self.incident_1.id),
+            group_id="99999",
+        )
+
+    def test_get_with_nonexistent_incident_id(self) -> None:
+        self.get_error_response(self.organization.slug, incident_id="99999", status_code=404)
+
+    def test_get_with_nonexistent_incident_identifier(self) -> None:
+        self.get_error_response(
+            self.organization.slug, incident_identifier="99999", status_code=404
+        )
+
+    def test_get_with_nonexistent_group_id(self) -> None:
+        self.get_error_response(self.organization.slug, group_id="99999", status_code=404)
+
+    def test_get_with_nonexistent_open_period_id(self) -> None:
+        self.get_error_response(self.organization.slug, open_period_id="99999", status_code=404)
+
+    def test_no_filter_provided(self) -> None:
+        self.get_error_response(self.organization.slug, status_code=400)