ref(integrations): Switch to TypedDict and improve logging for external issue AI generation

Replace NamedTuple with TypedDict for GeneratedExternalIssueDetails to
better represent the dict-based return type from Seer. Add exc_info=True
to error and warning logs so tracebacks are captured in Sentry. Fix test
mock that would KeyError on empty TypedDict construction.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Author: leeandher

src/sentry/integrations/mixins/issues.py

@@ -165,13 +165,11 @@ def get_create_issue_config(
         default_title = self.get_group_title(group, event, **kwargs)
         default_description = self.get_group_description(group, event, **kwargs)
 
-        llm_title, llm_description = maybe_generate_external_issue_details(
-            group=group, user=user, event=event
-        )
-        title = llm_title if llm_title else default_title
+        llm_details = maybe_generate_external_issue_details(group=group, user=user, event=event)
+        title = llm_details["title"] if llm_details["title"] else default_title
         description = (
-            f"**{default_title}**\n\n{llm_description}\n\n---\n\n{default_description}"
-            if llm_description
+            f"**{default_title}**\n\n{llm_details['description']}\n\n---\n\n{default_description}"
+            if llm_details["description"]
             else default_description
         )
 

src/sentry/integrations/utils/external_issues.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import logging
-from typing import Any, NamedTuple
+from typing import Any, TypedDict
 
 from sentry import features
 from sentry.models.group import Group
@@ -57,9 +57,14 @@ def _build_event_context(group: Group, event: Any | None = None) -> str:
     return context
 
 
+class GeneratedExternalIssueDetails(TypedDict):
+    title: str | None
+    description: str | None
+
+
 def _make_generate_external_issue_details_request(
     group: Group, event: Any | None = None, viewer_context: SeerViewerContext | None = None
-) -> dict[str, str] | None:
+) -> GeneratedExternalIssueDetails | None:
     logging_ctx: dict[str, Any] = {"group_id": group.id, "viewer_context": viewer_context}
     context = _build_event_context(group, event=event)
 
@@ -89,13 +94,17 @@ def _make_generate_external_issue_details_request(
     try:
         data = response.json()
     except (json.JSONDecodeError, ValueError):
-        logger.warning("external_issues.seer_response_json_failed", extra=logging_ctx)
+        logger.warning(
+            "external_issues.seer_response_json_failed", extra=logging_ctx, exc_info=True
+        )
         return None
     content = data.get("content")
     try:
         content = json.loads(content)
     except (json.JSONDecodeError, TypeError, ValueError):
-        logger.warning("external_issues.seer_response_parse_failed", extra=logging_ctx)
+        logger.warning(
+            "external_issues.seer_response_parse_failed", extra=logging_ctx, exc_info=True
+        )
         return None
 
     title = content.get("title")
@@ -109,35 +118,28 @@ def _make_generate_external_issue_details_request(
     return None
 
 
-class GeneratedIssueDetails(NamedTuple):
-    title: str | None = None
-    description: str | None = None
-
-
 def maybe_generate_external_issue_details(
     *, group: Group, user: User | RpcUser, event: GroupEvent | None = None
-) -> GeneratedIssueDetails:
+) -> GeneratedExternalIssueDetails:
     organization = group.organization
+    empty_result = GeneratedExternalIssueDetails(title=None, description=None)
     if not features.has("organizations:gen-ai-features", organization, actor=user):
-        return GeneratedIssueDetails()
+        return empty_result
     if organization.get_option("sentry:hide_ai_features", False):
-        return GeneratedIssueDetails()
+        return empty_result
     if not features.has("organizations:external-issues-ai-generate", organization, actor=user):
-        return GeneratedIssueDetails()
+        return empty_result
 
     try:
         viewer_context = SeerViewerContext(organization_id=organization.id, user_id=user.id)
         result = _make_generate_external_issue_details_request(
             group, event=event, viewer_context=viewer_context
         )
-    # Open except block is wide but allows us to fallback to default title/description if anything fails.
     except Exception:
-        logger.error("external_issues.generate_issue_details_failed")
-        return GeneratedIssueDetails()
+        logger.error("external_issues.generate_issue_details_failed", exc_info=True)
+        return empty_result
 
     if not result:
-        return GeneratedIssueDetails()
+        return empty_result
 
-    title: str | None = result.get("title")
-    description: str | None = result.get("description")
-    return GeneratedIssueDetails(title=title, description=description)
+    return result

tests/sentry/integrations/test_issues.py

@@ -9,7 +9,7 @@
 from sentry.integrations.models.external_issue import ExternalIssue
 from sentry.integrations.models.organization_integration import OrganizationIntegration
 from sentry.integrations.services.integration import integration_service
-from sentry.integrations.utils.external_issues import GeneratedIssueDetails
+from sentry.integrations.utils.external_issues import GeneratedExternalIssueDetails
 from sentry.models.activity import Activity
 from sentry.models.group import Group, GroupStatus
 from sentry.models.grouplink import GroupLink
@@ -743,7 +743,7 @@ def test_annotations(self) -> None:
 
     @patch("sentry.integrations.mixins.issues.maybe_generate_external_issue_details")
     def test_ai_text_replaces_defaults(self, mock_generate: MagicMock) -> None:
-        mock_generate.return_value = GeneratedIssueDetails(
+        mock_generate.return_value = GeneratedExternalIssueDetails(
             title="LLM Title",
             description="LLM Description",
         )
@@ -759,7 +759,7 @@ def test_ai_text_replaces_defaults(self, mock_generate: MagicMock) -> None:
 
     @patch("sentry.integrations.mixins.issues.maybe_generate_external_issue_details")
     def test_falls_back_when_ai_returns_empty(self, mock_generate: MagicMock) -> None:
-        mock_generate.return_value = GeneratedIssueDetails()
+        mock_generate.return_value = GeneratedExternalIssueDetails(title=None, description=None)
 
         config = self.installation.get_create_issue_config(self.group, self.user)
 

tests/sentry/integrations/utils/test_external_issues.py

@@ -4,7 +4,7 @@
 
 from sentry.integrations.utils.external_issues import (
     MAX_CONTEXT_LENGTH,
-    GeneratedIssueDetails,
+    GeneratedExternalIssueDetails,
     _make_generate_external_issue_details_request,
     maybe_generate_external_issue_details,
 )
@@ -108,7 +108,7 @@ def setUp(self) -> None:
     def test_feature_flag_disabled_returns_empty(self, mock_request: MagicMock) -> None:
         result = maybe_generate_external_issue_details(group=self.group, user=self.user)
 
-        assert result == GeneratedIssueDetails()
+        assert result == GeneratedExternalIssueDetails(title=None, description=None)
         mock_request.assert_not_called()
 
     @patch("sentry.integrations.utils.external_issues.make_llm_generate_request")
@@ -120,15 +120,15 @@ def test_hide_ai_features_returns_empty(self, mock_request: MagicMock) -> None:
         ):
             result = maybe_generate_external_issue_details(group=self.group, user=self.user)
 
-        assert result == GeneratedIssueDetails()
+        assert result == GeneratedExternalIssueDetails(title=None, description=None)
         mock_request.assert_not_called()
 
     @patch("sentry.integrations.utils.external_issues.make_llm_generate_request")
     def test_gen_ai_features_disabled_returns_empty(self, mock_request: MagicMock) -> None:
         with self.feature("organizations:external-issues-ai-generate"):
             result = maybe_generate_external_issue_details(group=self.group, user=self.user)
 
-        assert result == GeneratedIssueDetails()
+        assert result == GeneratedExternalIssueDetails(title=None, description=None)
         mock_request.assert_not_called()
 
     @patch("sentry.integrations.utils.external_issues.make_llm_generate_request")
@@ -140,7 +140,7 @@ def test_exception_returns_empty(self, mock_request: MagicMock) -> None:
         ):
             result = maybe_generate_external_issue_details(group=self.group, user=self.user)
 
-        assert result == GeneratedIssueDetails()
+        assert result == GeneratedExternalIssueDetails(title=None, description=None)
 
     @patch("sentry.integrations.utils.external_issues.make_llm_generate_request")
     def test_successful_returns_details(self, mock_request: MagicMock) -> None:
@@ -155,4 +155,6 @@ def test_successful_returns_details(self, mock_request: MagicMock) -> None:
         ):
             result = maybe_generate_external_issue_details(group=self.group, user=self.user)
 
-        assert result == GeneratedIssueDetails(title="AI Title", description="AI Description")
+        assert result == GeneratedExternalIssueDetails(
+            title="AI Title", description="AI Description"
+        )