ref: fix typing for endpoints.project_rule_preview (#82089)

<!-- Describe your PR here. -->

Author: asottile-sentry

Diff for: pyproject.toml

@@ -150,7 +150,6 @@ module = [
     "sentry.api.endpoints.project_ownership",
     "sentry.api.endpoints.project_release_files",
     "sentry.api.endpoints.project_repo_path_parsing",
-    "sentry.api.endpoints.project_rule_preview",
     "sentry.api.endpoints.project_rules_configuration",
     "sentry.api.endpoints.project_transaction_names",
     "sentry.api.endpoints.team_details",

Diff for: src/sentry/api/endpoints/project_rule_preview.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from collections.abc import Mapping
 from typing import Any
 
@@ -10,10 +12,11 @@
 from sentry.api.api_publish_status import ApiPublishStatus
 from sentry.api.base import region_silo_endpoint
 from sentry.api.bases.project import ProjectAlertRulePermission, ProjectEndpoint
-from sentry.api.serializers import GroupSerializer, serialize
+from sentry.api.serializers import serialize
+from sentry.api.serializers.models.group import BaseGroupSerializerResponse, GroupSerializer
 from sentry.api.serializers.rest_framework.rule import RulePreviewSerializer
 from sentry.models.group import Group
-from sentry.models.groupinbox import get_inbox_details
+from sentry.models.groupinbox import InboxDetails, get_inbox_details
 from sentry.rules.history.preview import preview
 
 
@@ -86,12 +89,19 @@ def post(self, request: Request, project) -> Response:
         return response
 
 
+class _PreviewResponse(BaseGroupSerializerResponse):
+    inbox: InboxDetails
+    lastTriggered: int
+
+
 class PreviewSerializer(GroupSerializer):
     def serialize(
-        self, obj: dict[str, Any], attrs: Mapping[Any, Any], user: Any, **kwargs: Any
-    ) -> dict[str, Any]:
+        self, obj: Group, attrs: Mapping[Any, Any], user: Any, **kwargs: Any
+    ) -> _PreviewResponse:
         result = super().serialize(obj, attrs, user, **kwargs)
         group_id = int(result["id"])
-        result["inbox"] = kwargs["inbox_details"].get(group_id)
-        result["lastTriggered"] = kwargs["group_fires"][group_id]
-        return result
+        return {
+            **result,
+            "inbox": kwargs["inbox_details"].get(group_id),
+            "lastTriggered": kwargs["group_fires"][group_id],
+        }

Diff for: src/sentry/api/serializers/models/group.py

@@ -317,7 +317,7 @@ def get_attrs(
         return result
 
     def serialize(
-        self, obj: Group, attrs: MutableMapping[str, Any], user: Any, **kwargs: Any
+        self, obj: Group, attrs: Mapping[str, Any], user: Any, **kwargs: Any
     ) -> BaseGroupSerializerResponse:
         status_details, status_label = self._get_status(attrs, obj)
         permalink = self._get_permalink(attrs, obj)
@@ -390,7 +390,7 @@ def _collapse(self, key) -> bool:
             return False
         return key in self.collapse
 
-    def _get_status(self, attrs: MutableMapping[str, Any], obj: Group):
+    def _get_status(self, attrs: Mapping[str, Any], obj: Group):
         status = obj.status
         status_details = {}
         if attrs["ignore_until"]:
@@ -850,7 +850,7 @@ def __seen_stats_impl(
 
 class SharedGroupSerializer(GroupSerializer):
     def serialize(
-        self, obj: Group, attrs: MutableMapping[str, Any], user: Any, **kwargs: Any
+        self, obj: Group, attrs: Mapping[str, Any], user: Any, **kwargs: Any
     ) -> BaseGroupSerializerResponse:
         result = super().serialize(obj, attrs, user)
 

Diff for: src/sentry/models/groupinbox.py

@@ -1,5 +1,10 @@
+from __future__ import annotations
+
 import logging
+from collections.abc import Iterable
+from datetime import datetime
 from enum import Enum
+from typing import TypedDict
 
 import jsonschema
 import sentry_sdk
@@ -135,16 +140,28 @@ def bulk_remove_groups_from_inbox(groups, action=None, user=None, referrer=None)
             pass
 
 
-def get_inbox_details(group_list):
+class InboxReasonDetails(TypedDict):
+    until: str | None
+    count: int | None
+    window: int | None
+    user_count: int | None
+    user_window: int | None
+
+
+class InboxDetails(TypedDict):
+    reason: int
+    reason_details: InboxReasonDetails | None
+    date_added: datetime
+
+
+def get_inbox_details(group_list: Iterable[Group]) -> dict[int, InboxDetails]:
     group_ids = [g.id for g in group_list]
     group_inboxes = GroupInbox.objects.filter(group__in=group_ids)
-    inbox_stats = {
+    return {
         gi.group_id: {
             "reason": gi.reason,
             "reason_details": gi.reason_details,
             "date_added": gi.date_added,
         }
         for gi in group_inboxes
     }
-
-    return inbox_stats