feat(insights): add endpoint to create/delete starred transactions (#89330)

Follow up to #89203
In insights overview pages, we want individual users to be able to star
their own transactions. This PR creates an endpoint to allow users to do
so

Author: DominikB2014

src/sentry/api/urls.py

@@ -122,6 +122,7 @@
     TeamAlertsTriggeredIndexEndpoint,
     TeamAlertsTriggeredTotalsEndpoint,
 )
+from sentry.insights.endpoints.starred_segments import InsightsStarredSegmentsEndpoint
 from sentry.integrations.api.endpoints.doc_integration_avatar import DocIntegrationAvatarEndpoint
 from sentry.integrations.api.endpoints.doc_integration_details import DocIntegrationDetailsEndpoint
 from sentry.integrations.api.endpoints.doc_integrations_index import DocIntegrationsEndpoint
@@ -1325,6 +1326,12 @@ def create_group_urls(name_prefix: str) -> list[URLPattern | URLResolver]:
         ProjectTransactionThresholdOverrideEndpoint.as_view(),
         name="sentry-api-0-organization-project-transaction-threshold-override",
     ),
+    # Insights
+    re_path(
+        r"^(?P<organization_id_or_slug>[^\/]+)/insights/starred-segments/$",
+        InsightsStarredSegmentsEndpoint.as_view(),
+        name="sentry-api-0-insights-starred-segments",
+    ),
     # Explore
     re_path(
         r"^(?P<organization_id_or_slug>[^\/]+)/explore/saved/$",

src/sentry/insights/endpoints/starred_segments.py

@@ -0,0 +1,89 @@
+from django.db import router
+from rest_framework import serializers, status
+from rest_framework.request import Request
+from rest_framework.response import Response
+
+from sentry import features
+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.organization import OrganizationEndpoint, OrganizationPermission
+from sentry.insights.models import InsightsStarredSegment
+from sentry.models.organization import Organization
+from sentry.utils.db import atomic_transaction
+
+
+class StarSegmentSerializer(serializers.Serializer):
+    segment_name = serializers.CharField(required=True)
+    project_id = serializers.IntegerField(required=True)
+
+
+class MemberPermission(OrganizationPermission):
+    scope_map = {
+        "POST": ["member:read", "member:write"],
+        "DELETE": ["member:read", "member:write"],
+    }
+
+
+@region_silo_endpoint
+class InsightsStarredSegmentsEndpoint(OrganizationEndpoint):
+    publish_status = {
+        "POST": ApiPublishStatus.EXPERIMENTAL,
+        "DELETE": ApiPublishStatus.EXPERIMENTAL,
+    }
+    owner = ApiOwner.PERFORMANCE
+    permission_classes = (MemberPermission,)
+
+    def has_feature(self, organization, request):
+        return features.has(
+            "organizations:insights-modules-use-eap", organization, actor=request.user
+        )
+
+    def post(self, request: Request, organization: Organization) -> Response:
+        """
+        Star a segment for the current organization member.
+        """
+        if not self.has_feature(organization, request):
+            return self.respond(status=404)
+
+        serializer = StarSegmentSerializer(data=request.data)
+        if not serializer.is_valid():
+            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+
+        segment_name = serializer.validated_data["segment_name"]
+        project_id = serializer.validated_data["project_id"]
+        with atomic_transaction(using=router.db_for_write(InsightsStarredSegment)):
+            _, created = InsightsStarredSegment.objects.get_or_create(
+                organization=organization,
+                project_id=project_id,
+                user_id=request.user.id,
+                segment_name=segment_name,
+            )
+
+            if not created:
+                return Response(status=status.HTTP_403_FORBIDDEN)
+
+        return Response(status=status.HTTP_200_OK)
+
+    def delete(self, request: Request, organization: Organization) -> Response:
+        """
+        Delete a starred segment for the current organization member.
+        """
+        if not self.has_feature(organization, request):
+            return self.respond(status=404)
+
+        serializer = StarSegmentSerializer(data=request.data)
+        if not serializer.is_valid():
+            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+
+        segment_name = serializer.validated_data["segment_name"]
+        project_id = serializer.validated_data["project_id"]
+
+        InsightsStarredSegment.objects.filter(
+            organization=organization,
+            user_id=request.user.id,
+            project_id=project_id,
+            segment_name=segment_name,
+        ).delete()
+
+        return Response(status=status.HTTP_200_OK)

tests/sentry/insights/__init__.py

@@ -0,0 +1,71 @@
+from django.urls import reverse
+
+from sentry.insights.models import InsightsStarredSegment
+from sentry.testutils.cases import APITestCase, SnubaTestCase
+
+
+class InsightsStarredSegmentTest(APITestCase, SnubaTestCase):
+    feature_name = "organizations:insights-modules-use-eap"
+
+    def setUp(self):
+        super().setUp()
+        self.login_as(user=self.user)
+        self.org = self.create_organization(owner=self.user)
+        self.project_ids = [
+            self.create_project(organization=self.org).id,
+            self.create_project(organization=self.org).id,
+        ]
+
+        self.url = reverse(
+            "sentry-api-0-insights-starred-segments",
+            kwargs={"organization_id_or_slug": self.org.slug},
+        )
+
+    def test_post_and_delete(self):
+        with self.feature(self.feature_name):
+            segment_name = "my_segment"
+
+            assert not InsightsStarredSegment.objects.filter(
+                segment_name=segment_name,
+            ).exists()
+
+            response = self.client.post(
+                self.url, data={"segment_name": segment_name, "project_id": self.project_ids[0]}
+            )
+            assert response.status_code == 200, response.content
+
+            assert InsightsStarredSegment.objects.filter(
+                segment_name=segment_name,
+            ).exists()
+
+            response = self.client.delete(
+                self.url, data={"segment_name": segment_name, "project_id": self.project_ids[0]}
+            )
+            assert response.status_code == 200, response.content
+
+            assert not InsightsStarredSegment.objects.filter(
+                segment_name=segment_name,
+            ).exists()
+
+    def test_no_error_deleting_non_existent_segment(self):
+        with self.feature(self.feature_name):
+            response = self.client.delete(
+                self.url,
+                data={"segment_name": "non_existent_segment", "project_id": self.project_ids[0]},
+            )
+            assert response.status_code == 200, response.content
+
+    def test_error_creating_duplicate_segment(self):
+        with self.feature(self.feature_name):
+            segment_name = "my_segment"
+            InsightsStarredSegment.objects.create(
+                segment_name=segment_name,
+                project_id=self.project_ids[0],
+                organization=self.org,
+                user_id=self.user.id,
+            )
+
+            response = self.client.post(
+                self.url, data={"segment_name": segment_name, "project_id": self.project_ids[0]}
+            )
+            assert response.status_code == 403