ref: standardize user param as User | RpcUser | AnonymousUser in Serializers (#83436)

a tiny step to making these more typesafe

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

Author: asottile-sentry

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

@@ -7,7 +7,7 @@
 import orjson
 import requests
 from django.conf import settings
-from django.contrib.auth.models import AbstractBaseUser, AnonymousUser
+from django.contrib.auth.models import AnonymousUser
 from rest_framework.response import Response
 
 from sentry import eventstore, features
@@ -23,6 +23,7 @@
 from sentry.tasks.autofix import check_autofix_status
 from sentry.types.ratelimit import RateLimit, RateLimitCategory
 from sentry.users.models.user import User
+from sentry.users.services.user.model import RpcUser
 from sentry.users.services.user.service import user_service
 
 logger = logging.getLogger(__name__)
@@ -49,7 +50,7 @@ class GroupAutofixEndpoint(GroupEndpoint):
     }
 
     def _get_serialized_event(
-        self, event_id: str, group: Group, user: AbstractBaseUser | AnonymousUser
+        self, event_id: str, group: Group, user: User | RpcUser | AnonymousUser
     ) -> dict[str, Any] | None:
         event = eventstore.backend.get_event_by_id(group.project.id, event_id, group_id=group.id)
 

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

@@ -7,7 +7,7 @@
 import orjson
 import requests
 from django.conf import settings
-from django.contrib.auth.models import AbstractBaseUser, AnonymousUser
+from django.contrib.auth.models import AnonymousUser
 from pydantic import BaseModel
 from rest_framework.response import Response
 
@@ -24,6 +24,8 @@
 from sentry.models.project import Project
 from sentry.seer.signed_seer_api import get_seer_salted_url, sign_with_seer_secret
 from sentry.types.ratelimit import RateLimit, RateLimitCategory
+from sentry.users.models.user import User
+from sentry.users.services.user.model import RpcUser
 from sentry.utils.cache import cache
 
 logger = logging.getLogger(__name__)
@@ -59,7 +61,7 @@ class GroupAiSummaryEndpoint(GroupEndpoint):
     def _get_event(
         self,
         group: Group,
-        user: AbstractBaseUser | AnonymousUser,
+        user: User | RpcUser | AnonymousUser,
         provided_event_id: str | None = None,
     ) -> tuple[dict[str, Any] | None, GroupEvent | None]:
         event = None

Diff for: src/sentry/api/serializers/base.py

@@ -7,6 +7,9 @@
 import sentry_sdk
 from django.contrib.auth.models import AnonymousUser
 
+from sentry.users.models.user import User
+from sentry.users.services.user.model import RpcUser
+
 logger = logging.getLogger(__name__)
 
 K = TypeVar("K")
@@ -26,7 +29,7 @@ def wrapped(cls: type[K]) -> type[K]:
 
 def serialize(
     objects: Any | Sequence[Any],
-    user: Any | None = None,
+    user: User | RpcUser | AnonymousUser | None = None,
     serializer: Any | None = None,
     **kwargs: Any,
 ) -> Any:
@@ -81,15 +84,19 @@ class Serializer:
     """A Serializer class contains the logic to serialize a specific type of object."""
 
     def __call__(
-        self, obj: Any, attrs: Mapping[Any, Any], user: Any, **kwargs: Any
+        self,
+        obj: Any,
+        attrs: Mapping[Any, Any],
+        user: User | RpcUser | AnonymousUser,
+        **kwargs: Any,
     ) -> Mapping[str, Any] | None:
         """See documentation for `serialize`."""
         if obj is None:
             return None
         return self._serialize(obj, attrs, user, **kwargs)
 
     def get_attrs(
-        self, item_list: Sequence[Any], user: Any, **kwargs: Any
+        self, item_list: Sequence[Any], user: User | RpcUser | AnonymousUser, **kwargs: Any
     ) -> MutableMapping[Any, Any]:
         """
         Fetch all of the associated data needed to serialize the objects in `item_list`.
@@ -102,7 +109,11 @@ def get_attrs(
         return {}
 
     def _serialize(
-        self, obj: Any, attrs: Mapping[Any, Any], user: Any, **kwargs: Any
+        self,
+        obj: Any,
+        attrs: Mapping[Any, Any],
+        user: User | RpcUser | AnonymousUser,
+        **kwargs: Any,
     ) -> Mapping[str, Any] | None:
         try:
             return self.serialize(obj, attrs, user, **kwargs)
@@ -111,7 +122,11 @@ def _serialize(
             return None
 
     def serialize(
-        self, obj: Any, attrs: Mapping[Any, Any], user: Any, **kwargs: Any
+        self,
+        obj: Any,
+        attrs: Mapping[Any, Any],
+        user: User | RpcUser | AnonymousUser,
+        **kwargs: Any,
     ) -> Mapping[str, Any]:
         """
         Convert an arbitrary python object `obj` to an object that only contains primitives.

Diff for: src/sentry/api/serializers/models/organization_member/base.py

@@ -2,12 +2,14 @@
 from collections.abc import Mapping, MutableMapping, Sequence
 from typing import Any
 
+from django.contrib.auth.models import AnonymousUser
+
 from sentry import roles
 from sentry.api.serializers import Serializer, register, serialize
 from sentry.integrations.models.external_actor import ExternalActor
 from sentry.models.organizationmember import OrganizationMember
 from sentry.users.models.user import User
-from sentry.users.services.user import RpcUser
+from sentry.users.services.user.model import RpcUser
 from sentry.users.services.user.service import user_service
 
 from .response import OrganizationMemberResponse
@@ -20,7 +22,10 @@ def __init__(self, expand: Sequence[str] | None = None) -> None:
         self.expand = expand or []
 
     def get_attrs(
-        self, item_list: Sequence[OrganizationMember], user: User, **kwargs: Any
+        self,
+        item_list: Sequence[OrganizationMember],
+        user: User | RpcUser | AnonymousUser,
+        **kwargs: Any,
     ) -> MutableMapping[OrganizationMember, MutableMapping[str, Any]]:
         """
         Fetch all of the associated Users and ExternalActors needed to serialize
@@ -85,19 +90,23 @@ def get_attrs(
         return attrs
 
     def serialize(
-        self, obj: OrganizationMember, attrs: Mapping[str, Any], user: Any, **kwargs: Any
+        self,
+        obj: OrganizationMember,
+        attrs: Mapping[str, Any],
+        user: User | RpcUser | AnonymousUser,
+        **kwargs: Any,
     ) -> OrganizationMemberResponse:
         inviter_name = None
         if obj.inviter_id:
             inviter = attrs["inviter"]
             if inviter:
                 inviter_name = inviter.get_display_name()
-        user = attrs["user"]
+        serialized_user = attrs["user"]
         email = attrs["email"]
         data: OrganizationMemberResponse = {
             "id": str(obj.id),
             "email": email,
-            "name": user["name"] if user else email,
+            "name": serialized_user["name"] if serialized_user else email,
             "user": attrs["user"],
             "orgRole": obj.role,
             "pending": obj.is_pending,

Diff for: src/sentry/api/serializers/models/organization_member/expand/projects.py

@@ -2,11 +2,14 @@
 from collections.abc import Mapping, MutableMapping, Sequence
 from typing import Any, cast
 
+from django.contrib.auth.models import AnonymousUser
+
 from sentry.models.organizationmember import OrganizationMember
 from sentry.models.organizationmemberteam import OrganizationMemberTeam
 from sentry.models.projectteam import ProjectTeam
 from sentry.models.team import TeamStatus
 from sentry.users.models.user import User
+from sentry.users.services.user.model import RpcUser
 
 from ..base import OrganizationMemberSerializer
 from ..response import OrganizationMemberWithProjectsResponse
@@ -19,7 +22,10 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         super().__init__(*args, **kwargs)
 
     def get_attrs(
-        self, item_list: Sequence[OrganizationMember], user: User, **kwargs: Any
+        self,
+        item_list: Sequence[OrganizationMember],
+        user: User | RpcUser | AnonymousUser,
+        **kwargs: Any,
     ) -> MutableMapping[OrganizationMember, MutableMapping[str, Any]]:
         attrs = super().get_attrs(item_list, user)
 

Diff for: src/sentry/api/serializers/models/organization_member/expand/roles.py

@@ -3,12 +3,15 @@
 from collections.abc import Iterable, Mapping, MutableMapping, Sequence
 from typing import Any, cast
 
+from django.contrib.auth.models import AnonymousUser
+
 from sentry.api.serializers import serialize
 from sentry.models.organizationmember import OrganizationMember
 from sentry.roles import organization_roles, team_roles
 from sentry.roles.manager import OrganizationRole, Role
 from sentry.users.models.user import User
 from sentry.users.services.user import UserSerializeType
+from sentry.users.services.user.model import RpcUser
 from sentry.users.services.user.service import user_service
 
 from ...role import OrganizationRoleSerializer, TeamRoleSerializer
@@ -40,7 +43,10 @@ def __init__(
         self.allowed_roles = allowed_roles
 
     def get_attrs(
-        self, item_list: Sequence[OrganizationMember], user: User, **kwargs: Any
+        self,
+        item_list: Sequence[OrganizationMember],
+        user: User | RpcUser | AnonymousUser,
+        **kwargs: Any,
     ) -> MutableMapping[OrganizationMember, MutableMapping[str, Any]]:
         result = super().get_attrs(item_list, user, **kwargs)
         users_by_id = {
@@ -58,7 +64,7 @@ def serialize(
         self,
         obj: OrganizationMember,
         attrs: Mapping[str, Any],
-        user: User,
+        user: User | RpcUser | AnonymousUser,
         **kwargs: Any,
     ) -> OrganizationMemberWithRolesResponse:
         context = cast(

Diff for: src/sentry/api/serializers/models/organization_member/expand/teams.py

@@ -1,8 +1,11 @@
 from collections.abc import Mapping, MutableMapping, Sequence
 from typing import Any, cast
 
+from django.contrib.auth.models import AnonymousUser
+
 from sentry.models.organizationmember import OrganizationMember
 from sentry.users.models.user import User
+from sentry.users.services.user.model import RpcUser
 
 from ..base import OrganizationMemberSerializer
 from ..response import OrganizationMemberWithTeamsResponse
@@ -11,7 +14,10 @@
 
 class OrganizationMemberWithTeamsSerializer(OrganizationMemberSerializer):
     def get_attrs(
-        self, item_list: Sequence[OrganizationMember], user: User, **kwargs: Any
+        self,
+        item_list: Sequence[OrganizationMember],
+        user: User | RpcUser | AnonymousUser,
+        **kwargs: Any,
     ) -> MutableMapping[OrganizationMember, MutableMapping[str, Any]]:
         attrs = super().get_attrs(item_list, user)
         teams, teams_with_role = get_teams_by_organization_member_id(item_list)
@@ -29,7 +35,11 @@ def get_attrs(
         return attrs
 
     def serialize(
-        self, obj: OrganizationMember, attrs: Mapping[str, Any], user: Any, **kwargs: Any
+        self,
+        obj: OrganizationMember,
+        attrs: Mapping[str, Any],
+        user: User | RpcUser | AnonymousUser,
+        **kwargs: Any,
     ) -> OrganizationMemberWithTeamsResponse:
         d = cast(OrganizationMemberWithTeamsResponse, super().serialize(obj, attrs, user))
         d["teams"] = attrs.get("teams", [])  # Deprecated

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

@@ -4,12 +4,14 @@
 from enum import StrEnum
 from typing import Any, TypedDict
 
+from django.contrib.auth.models import AnonymousUser
 from rest_framework import serializers
 
 from sentry.api.serializers import Serializer, register
 from sentry.models.options.project_template_option import TProjectOptions
 from sentry.models.projecttemplate import ProjectTemplate
 from sentry.users.models.user import User
+from sentry.users.services.user import RpcUser
 
 
 class ProjectTemplateAttributes(StrEnum):
@@ -32,7 +34,12 @@ def __init__(self, expand: Iterable[ProjectTemplateAttributes] | None = None) ->
     def _expand(self, key: ProjectTemplateAttributes) -> bool:
         return self.expand is not None and key in self.expand
 
-    def get_attrs(self, item_list: Sequence[ProjectTemplate], user: User, **kwargs: Any):
+    def get_attrs(
+        self,
+        item_list: Sequence[ProjectTemplate],
+        user: User | RpcUser | AnonymousUser,
+        **kwargs: Any,
+    ):
         attrs = super().get_attrs(item_list, user, **kwargs)
         all_attrs: dict[ProjectTemplate, dict[ProjectTemplateAttributes, Any]] = defaultdict(dict)
 
@@ -52,7 +59,11 @@ def get_attrs(self, item_list: Sequence[ProjectTemplate], user: User, **kwargs:
         return all_attrs
 
     def serialize(
-        self, obj: ProjectTemplate, attrs: Mapping[str, Any], user: User, **kwargs: Any
+        self,
+        obj: ProjectTemplate,
+        attrs: Mapping[str, Any],
+        user: User | RpcUser | AnonymousUser,
+        **kwargs: Any,
     ) -> SerializedProjectTemplate:
         response: SerializedProjectTemplate = {
             "id": obj.id,

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

@@ -2,6 +2,7 @@
 from collections.abc import Mapping, MutableMapping, Sequence
 from typing import Any
 
+from django.contrib.auth.models import AnonymousUser
 from django.db.models import QuerySet
 
 from sentry.api.serializers import Serializer, register
@@ -46,7 +47,7 @@ def serialize(
         self,
         obj: Relocation,
         attrs: Any,
-        user: User,
+        user: User | RpcUser | AnonymousUser,
         **kwargs: Any,
     ) -> Mapping[str, Any]:
         scheduled_at_pause_step = (
@@ -109,7 +110,7 @@ def serialize(
         }
 
     def get_attrs(
-        self, item_list: Sequence[Relocation], user: User, **kwargs: Any
+        self, item_list: Sequence[Relocation], user: User | RpcUser | AnonymousUser, **kwargs: Any
     ) -> MutableMapping[Relocation, RelocationMetadata]:
         metadata_map = {}
         for relocation in item_list: