feat(investigations): Add response serializers

This splits out the response serializers from #121403 to keep the total pr size down, and restructures them into separate folders.

Author: wedamija

src/sentry/investigations/endpoints/serializers/__init__.py

@@ -0,0 +1,23 @@
+__all__ = (
+    "InvestigationBlockSerializer",
+    "InvestigationBlockSerializerResponse",
+    "InvestigationDetailsSerializer",
+    "InvestigationDetailsSerializerResponse",
+    "InvestigationParameterSerializer",
+    "InvestigationParameterSerializerResponse",
+    "InvestigationSerializer",
+    "InvestigationSerializerResponse",
+)
+
+
+from .block import InvestigationBlockSerializer, InvestigationBlockSerializerResponse
+from .investigation import (
+    InvestigationDetailsSerializer,
+    InvestigationDetailsSerializerResponse,
+    InvestigationSerializer,
+    InvestigationSerializerResponse,
+)
+from .parameter import (
+    InvestigationParameterSerializer,
+    InvestigationParameterSerializerResponse,
+)

src/sentry/investigations/endpoints/serializers/block.py

@@ -0,0 +1,183 @@
+from __future__ import annotations
+
+from collections import defaultdict
+from collections.abc import Mapping, MutableMapping, Sequence
+from datetime import datetime
+from typing import Any, TypedDict, override
+
+from django.contrib.auth.models import AnonymousUser
+
+from sentry.api.serializers import Serializer
+from sentry.investigations.models import (
+    InvestigationBlock,
+    InvestigationBlockDependency,
+    InvestigationBlockExecution,
+    InvestigationBlockExecutionStatus,
+    InvestigationBlockKind,
+    InvestigationBlockParameter,
+)
+from sentry.users.models.user import User
+from sentry.users.services.user.model import RpcUser
+
+
+class InvestigationBlockExecutionSerializerResponse(TypedDict):
+    id: str
+    status: str
+    executor: str
+    schemaVersion: int
+    startedAt: datetime | None
+    completedAt: datetime | None
+    error: Any | None
+
+
+class InvestigationBlockSerializerResponse(TypedDict):
+    id: str
+    position: int
+    kind: str
+    title: str
+    content: str
+    generationPrompt: str
+    generatedContent: str
+    output: Any | None
+    outputStatus: str
+    currentExecution: InvestigationBlockExecutionSerializerResponse | None
+    config: dict[str, Any]
+    display: dict[str, Any]
+    dependencies: list[str]
+    parameterKeys: list[str]
+    version: int
+    staleAt: datetime | None
+    createdBy: str | None
+    lastEditedBy: str | None
+
+
+class InvestigationBlockSerializer(Serializer[InvestigationBlockSerializerResponse]):
+    """
+    Serializes a block, hiding output the viewer may not see.
+
+    ``accessible_project_ids`` is the set of projects the viewer can read. A
+    block's persisted output is withheld unless every project that contributed
+    to it is in that set, so it must be supplied by the caller.
+    """
+
+    def __init__(self, accessible_project_ids: set[int]) -> None:
+        self.accessible_project_ids = accessible_project_ids
+
+    @override
+    def get_attrs(
+        self,
+        item_list: Sequence[InvestigationBlock],
+        user: User | RpcUser | AnonymousUser,
+        **kwargs: Any,
+    ) -> MutableMapping[InvestigationBlock, dict[str, Any]]:
+        dependencies: MutableMapping[int, list[str]] = defaultdict(list)
+        for link in (
+            InvestigationBlockDependency.objects.filter(block__in=item_list)
+            .values_list("block_id", "depends_on_id")
+            .order_by("id")
+        ):
+            dependencies[link[0]].append(str(link[1]))
+
+        parameter_keys: MutableMapping[int, list[str]] = defaultdict(list)
+        for block_id, key in (
+            InvestigationBlockParameter.objects.filter(block__in=item_list)
+            .values_list("block_id", "parameter__key")
+            .order_by("parameter__position")
+        ):
+            parameter_keys[block_id].append(key)
+
+        return {
+            block: {
+                "dependencies": dependencies[block.id],
+                "parameter_keys": parameter_keys[block.id],
+            }
+            for block in item_list
+        }
+
+    def _execution_project_ids(self, execution: InvestigationBlockExecution) -> set[int]:
+        return {project.id for project in execution.data_projects.all()}
+
+    @override
+    def serialize(
+        self,
+        obj: InvestigationBlock,
+        attrs: Mapping[Any, Any],
+        user: User | RpcUser | AnonymousUser,
+        **kwargs: Any,
+    ) -> InvestigationBlockSerializerResponse:
+        execution = obj.current_execution
+        result_execution = obj.result_execution
+        content_execution = obj.content_execution
+        content_restricted = bool(
+            obj.kind == InvestigationBlockKind.TEXT
+            and content_execution is not None
+            and not self._execution_project_ids(content_execution).issubset(
+                self.accessible_project_ids
+            )
+        )
+        if execution is None:
+            output = None
+            output_status = "notRun"
+        else:
+            visible_execution = (
+                result_execution if obj.kind == InvestigationBlockKind.QUERY else execution
+            )
+            data_project_ids = (
+                self._execution_project_ids(visible_execution)
+                if visible_execution is not None
+                else set()
+            )
+            if not data_project_ids.issubset(self.accessible_project_ids):
+                output = None
+                output_status = "restricted"
+            else:
+                output = visible_execution.result if visible_execution is not None else None
+                output_status = (
+                    "available"
+                    if execution.status == InvestigationBlockExecutionStatus.COMPLETED
+                    else execution.status
+                )
+        if content_restricted:
+            output = None
+            output_status = "restricted"
+
+        content = obj.content
+        generated_content = obj.generated_content
+        if obj.kind == InvestigationBlockKind.TEXT and output_status == "restricted":
+            content = ""
+            generated_content = ""
+
+        return {
+            "id": str(obj.id),
+            "position": obj.position,
+            "kind": obj.kind,
+            "title": obj.title,
+            "content": content,
+            "generationPrompt": obj.prompt,
+            "generatedContent": generated_content,
+            "output": output,
+            "outputStatus": output_status,
+            "currentExecution": (
+                {
+                    "id": str(execution.id),
+                    "status": execution.status,
+                    "executor": execution.executor,
+                    "schemaVersion": execution.result_schema_version,
+                    "startedAt": execution.started_at,
+                    "completedAt": execution.completed_at,
+                    "error": execution.error,
+                }
+                if execution is not None
+                else None
+            ),
+            "config": obj.config,
+            "display": obj.display,
+            "dependencies": attrs["dependencies"],
+            "parameterKeys": attrs["parameter_keys"],
+            "version": obj.version,
+            "staleAt": obj.stale_at,
+            "createdBy": str(obj.created_by_id) if obj.created_by_id is not None else None,
+            "lastEditedBy": (
+                str(obj.last_edited_by_id) if obj.last_edited_by_id is not None else None
+            ),
+        }