ref: remove EnvironmentMixin (#89313)

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

Author: asottile-sentry

pyproject.toml

@@ -187,6 +187,7 @@ module = [
     "sentry.api.endpoints.release_thresholds.health_checks.*",
     "sentry.api.event_search",
     "sentry.api.helpers.deprecation",
+    "sentry.api.helpers.environments",
     "sentry.api.helpers.group_index.update",
     "sentry.api.helpers.source_map_helper",
     "sentry.api.permissions",

src/sentry/api/base.py

@@ -31,7 +31,6 @@
 from sentry.auth import access
 from sentry.auth.staff import has_staff_option
 from sentry.middleware import is_frontend_request
-from sentry.models.environment import Environment
 from sentry.organizations.absolute_url import generate_organization_url
 from sentry.ratelimits.config import DEFAULT_RATE_LIMIT_CONFIG, RateLimitConfig
 from sentry.silo.base import SiloLimit, SiloMode
@@ -70,7 +69,6 @@
 
 __all__ = [
     "Endpoint",
-    "EnvironmentMixin",
     "StatsMixin",
     "control_silo_endpoint",
     "region_silo_endpoint",
@@ -567,47 +565,6 @@ def get_request_source(self, request: Request) -> QuerySource:
         return QuerySource.API
 
 
-class EnvironmentMixin:
-    def _get_environment_func(
-        self, request: Request, organization_id: int
-    ) -> Callable[[], Environment | None]:
-        """\
-        Creates a function that when called returns the ``Environment``
-        associated with a request object, or ``None`` if no environment was
-        provided. If the environment doesn't exist, an ``Environment.DoesNotExist``
-        exception will be raised.
-
-        This returns as a callable since some objects outside of the API
-        endpoint need to handle the "environment was provided but does not
-        exist" state in addition to the two non-exceptional states (the
-        environment was provided and exists, or the environment was not
-        provided.)
-        """
-        return functools.partial(self._get_environment_from_request, request, organization_id)
-
-    def _get_environment_id_from_request(
-        self, request: Request, organization_id: int
-    ) -> int | None:
-        environment = self._get_environment_from_request(request, organization_id)
-        return environment.id if environment is not None else None
-
-    def _get_environment_from_request(
-        self, request: Request, organization_id: int
-    ) -> Environment | None:
-        if not hasattr(request, "_cached_environment"):
-            environment_param = request.GET.get("environment")
-            if environment_param is None:
-                environment = None
-            else:
-                environment = Environment.get_for_organization_id(
-                    name=environment_param, organization_id=organization_id
-                )
-
-            request._cached_environment = environment
-
-        return request._cached_environment
-
-
 class StatsArgsDict(TypedDict):
     start: datetime
     end: datetime

src/sentry/api/endpoints/group_attachments.py

@@ -7,7 +7,7 @@
 
 from sentry import features
 from sentry.api.api_publish_status import ApiPublishStatus
-from sentry.api.base import EnvironmentMixin, region_silo_endpoint
+from sentry.api.base import region_silo_endpoint
 from sentry.api.bases.group import GroupEndpoint
 from sentry.api.exceptions import ResourceDoesNotExist
 from sentry.api.helpers.environments import get_environments
@@ -69,7 +69,7 @@ def get_event_ids_from_filters(
 
 
 @region_silo_endpoint
-class GroupAttachmentsEndpoint(GroupEndpoint, EnvironmentMixin):
+class GroupAttachmentsEndpoint(GroupEndpoint):
     publish_status = {
         "GET": ApiPublishStatus.PRIVATE,
     }

src/sentry/api/endpoints/group_current_release.py

@@ -3,7 +3,7 @@
 from rest_framework.response import Response
 
 from sentry.api.api_publish_status import ApiPublishStatus
-from sentry.api.base import EnvironmentMixin, region_silo_endpoint
+from sentry.api.base import region_silo_endpoint
 from sentry.api.bases import GroupEndpoint
 from sentry.api.helpers.environments import get_environments
 from sentry.api.serializers import serialize
@@ -14,7 +14,7 @@
 
 
 @region_silo_endpoint
-class GroupCurrentReleaseEndpoint(GroupEndpoint, EnvironmentMixin):
+class GroupCurrentReleaseEndpoint(GroupEndpoint):
     publish_status = {
         "GET": ApiPublishStatus.PRIVATE,
     }

src/sentry/api/endpoints/group_first_last_release.py

@@ -2,14 +2,14 @@
 from rest_framework.response import Response
 
 from sentry.api.api_publish_status import ApiPublishStatus
-from sentry.api.base import EnvironmentMixin, region_silo_endpoint
+from sentry.api.base import region_silo_endpoint
 from sentry.api.bases import GroupEndpoint
 from sentry.api.helpers.group_index import get_first_last_release
 from sentry.types.ratelimit import RateLimit, RateLimitCategory
 
 
 @region_silo_endpoint
-class GroupFirstLastReleaseEndpoint(GroupEndpoint, EnvironmentMixin):
+class GroupFirstLastReleaseEndpoint(GroupEndpoint):
     publish_status = {
         "GET": ApiPublishStatus.PRIVATE,
     }

src/sentry/api/endpoints/group_stats.py

@@ -3,24 +3,23 @@
 
 from sentry import tsdb
 from sentry.api.api_publish_status import ApiPublishStatus
-from sentry.api.base import EnvironmentMixin, StatsMixin, region_silo_endpoint
+from sentry.api.base import StatsMixin, region_silo_endpoint
 from sentry.api.bases.group import GroupEndpoint
 from sentry.api.exceptions import ResourceDoesNotExist
+from sentry.api.helpers.environments import get_environment_id
 from sentry.models.environment import Environment
 from sentry.tsdb.base import TSDBModel
 
 
 @region_silo_endpoint
-class GroupStatsEndpoint(GroupEndpoint, EnvironmentMixin, StatsMixin):
+class GroupStatsEndpoint(GroupEndpoint, StatsMixin):
     publish_status = {
         "GET": ApiPublishStatus.UNKNOWN,
     }
 
     def get(self, request: Request, group) -> Response:
         try:
-            environment_id = self._get_environment_id_from_request(
-                request, group.project.organization_id
-            )
+            environment_id = get_environment_id(request, group.project.organization_id)
         except Environment.DoesNotExist:
             raise ResourceDoesNotExist
 

src/sentry/api/endpoints/group_tagkey_details.py

@@ -5,9 +5,10 @@
 from sentry import tagstore
 from sentry.api.api_owners import ApiOwner
 from sentry.api.api_publish_status import ApiPublishStatus
-from sentry.api.base import EnvironmentMixin, region_silo_endpoint
+from sentry.api.base import region_silo_endpoint
 from sentry.api.bases.group import GroupEndpoint
 from sentry.api.exceptions import ResourceDoesNotExist
+from sentry.api.helpers.environments import get_environment_id
 from sentry.api.serializers import serialize
 from sentry.apidocs.constants import (
     RESPONSE_BAD_REQUEST,
@@ -24,7 +25,7 @@
 
 @extend_schema(tags=["Events"])
 @region_silo_endpoint
-class GroupTagKeyDetailsEndpoint(GroupEndpoint, EnvironmentMixin):
+class GroupTagKeyDetailsEndpoint(GroupEndpoint):
     publish_status = {
         "GET": ApiPublishStatus.PUBLIC,
     }
@@ -56,9 +57,7 @@ def get(self, request: Request, group, key) -> Response:
         lookup_key = tagstore.backend.prefix_reserved_key(key)
         tenant_ids = {"organization_id": group.project.organization_id}
         try:
-            environment_id = self._get_environment_id_from_request(
-                request, group.project.organization_id
-            )
+            environment_id = get_environment_id(request, group.project.organization_id)
         except Environment.DoesNotExist:
             # if the environment doesn't exist then the tag can't possibly exist
             raise ResourceDoesNotExist

src/sentry/api/endpoints/group_tagkey_values.py

@@ -5,7 +5,7 @@
 from sentry import analytics, tagstore
 from sentry.api.api_owners import ApiOwner
 from sentry.api.api_publish_status import ApiPublishStatus
-from sentry.api.base import EnvironmentMixin, region_silo_endpoint
+from sentry.api.base import region_silo_endpoint
 from sentry.api.bases.group import GroupEndpoint
 from sentry.api.exceptions import ResourceDoesNotExist
 from sentry.api.helpers.environments import get_environments
@@ -25,7 +25,7 @@
 
 @extend_schema(tags=["Events"])
 @region_silo_endpoint
-class GroupTagKeyValuesEndpoint(GroupEndpoint, EnvironmentMixin):
+class GroupTagKeyValuesEndpoint(GroupEndpoint):
     publish_status = {
         "GET": ApiPublishStatus.PUBLIC,
     }

src/sentry/api/endpoints/group_user_reports.py

@@ -2,16 +2,17 @@
 from rest_framework.response import Response
 
 from sentry.api.api_publish_status import ApiPublishStatus
-from sentry.api.base import EnvironmentMixin, region_silo_endpoint
+from sentry.api.base import region_silo_endpoint
 from sentry.api.bases.group import GroupEndpoint
+from sentry.api.helpers.environments import get_environment
 from sentry.api.paginator import DateTimePaginator
 from sentry.api.serializers import serialize
 from sentry.models.environment import Environment
 from sentry.models.userreport import UserReport
 
 
 @region_silo_endpoint
-class GroupUserReportsEndpoint(GroupEndpoint, EnvironmentMixin):
+class GroupUserReportsEndpoint(GroupEndpoint):
     publish_status = {
         "GET": ApiPublishStatus.PRIVATE,
     }
@@ -29,7 +30,7 @@ def get(self, request: Request, group) -> Response:
         """
 
         try:
-            environment = self._get_environment_from_request(request, group.organization.id)
+            environment = get_environment(request, group.organization.id)
         except Environment.DoesNotExist:
             report_list = UserReport.objects.none()
         else:

src/sentry/api/endpoints/organization_events_meta.py

@@ -7,13 +7,14 @@
 
 from sentry import features, options, search
 from sentry.api.api_publish_status import ApiPublishStatus
-from sentry.api.base import EnvironmentMixin, region_silo_endpoint
+from sentry.api.base import region_silo_endpoint
 from sentry.api.bases import (
     NoProjects,
     OrganizationEventsEndpointBase,
     OrganizationEventsV2EndpointBase,
 )
 from sentry.api.event_search import parse_search_query
+from sentry.api.helpers.environments import get_environment_func
 from sentry.api.helpers.group_index import build_query_params_from_request
 from sentry.api.serializers import serialize
 from sentry.api.serializers.models.group import GroupSerializer
@@ -108,7 +109,7 @@ def get(self, request: Request, organization) -> Response:
 
 
 @region_silo_endpoint
-class OrganizationEventsRelatedIssuesEndpoint(OrganizationEventsEndpointBase, EnvironmentMixin):
+class OrganizationEventsRelatedIssuesEndpoint(OrganizationEventsEndpointBase):
     publish_status = {
         "GET": ApiPublishStatus.PRIVATE,
     }
@@ -162,9 +163,7 @@ def get(self, request: Request, organization) -> Response:
             context = serialize(
                 results,
                 request.user,
-                GroupSerializer(
-                    environment_func=self._get_environment_func(request, organization.id)
-                ),
+                GroupSerializer(environment_func=get_environment_func(request, organization.id)),
             )
 
         return Response(context)

src/sentry/api/endpoints/organization_issues_resolved_in_release.py

@@ -3,7 +3,7 @@
 
 from sentry.api.api_owners import ApiOwner
 from sentry.api.api_publish_status import ApiPublishStatus
-from sentry.api.base import EnvironmentMixin, region_silo_endpoint
+from sentry.api.base import region_silo_endpoint
 from sentry.api.bases.organization import OrganizationEndpoint, OrganizationPermission
 from sentry.api.helpers.releases import get_group_ids_resolved_in_release
 from sentry.api.serializers import serialize
@@ -12,7 +12,7 @@
 
 
 @region_silo_endpoint
-class OrganizationIssuesResolvedInReleaseEndpoint(OrganizationEndpoint, EnvironmentMixin):
+class OrganizationIssuesResolvedInReleaseEndpoint(OrganizationEndpoint):
     owner = ApiOwner.ISSUES
     publish_status = {
         "GET": ApiPublishStatus.PRIVATE,

src/sentry/api/endpoints/organization_projects.py

@@ -8,8 +8,9 @@
 from rest_framework.response import Response
 
 from sentry.api.api_publish_status import ApiPublishStatus
-from sentry.api.base import EnvironmentMixin, region_silo_endpoint
+from sentry.api.base import region_silo_endpoint
 from sentry.api.bases.organization import OrganizationAndStaffPermission, OrganizationEndpoint
+from sentry.api.helpers.environments import get_environment_id
 from sentry.api.paginator import OffsetPaginator
 from sentry.api.serializers import serialize
 from sentry.api.serializers.models.project import (
@@ -44,7 +45,7 @@ def get_dataset(dataset_label: str) -> Any:
 
 @extend_schema(tags=["Organizations"])
 @region_silo_endpoint
-class OrganizationProjectsEndpoint(OrganizationEndpoint, EnvironmentMixin):
+class OrganizationProjectsEndpoint(OrganizationEndpoint):
     publish_status = {
         "GET": ApiPublishStatus.PUBLIC,
     }
@@ -177,7 +178,7 @@ def get(self, request: Request, organization) -> Response:
                 expand.add("options")
 
             def serialize_on_result(result):
-                environment_id = self._get_environment_id_from_request(request, organization.id)
+                environment_id = get_environment_id(request, organization.id)
                 serializer = ProjectSummarySerializer(
                     environment_id=environment_id,
                     stats_period=stats_period,
@@ -198,7 +199,7 @@ def serialize_on_result(result):
 
 
 @region_silo_endpoint
-class OrganizationProjectsCountEndpoint(OrganizationEndpoint, EnvironmentMixin):
+class OrganizationProjectsCountEndpoint(OrganizationEndpoint):
     publish_status = {
         "GET": ApiPublishStatus.PRIVATE,
     }

src/sentry/api/endpoints/organization_releases.py

@@ -12,7 +12,7 @@
 
 from sentry import analytics, release_health
 from sentry.api.api_publish_status import ApiPublishStatus
-from sentry.api.base import EnvironmentMixin, ReleaseAnalyticsMixin, region_silo_endpoint
+from sentry.api.base import ReleaseAnalyticsMixin, region_silo_endpoint
 from sentry.api.bases import NoProjects
 from sentry.api.bases.organization import OrganizationReleasesBaseEndpoint
 from sentry.api.exceptions import ConflictError, InvalidRepository
@@ -228,9 +228,7 @@ def debounce_update_release_health_data(organization, project_ids: list[int]):
 
 
 @region_silo_endpoint
-class OrganizationReleasesEndpoint(
-    OrganizationReleasesBaseEndpoint, EnvironmentMixin, ReleaseAnalyticsMixin
-):
+class OrganizationReleasesEndpoint(OrganizationReleasesBaseEndpoint, ReleaseAnalyticsMixin):
     publish_status = {
         "GET": ApiPublishStatus.UNKNOWN,
         "POST": ApiPublishStatus.UNKNOWN,
@@ -632,7 +630,7 @@ def post(self, request: Request, organization) -> Response:
 
 
 @region_silo_endpoint
-class OrganizationReleasesStatsEndpoint(OrganizationReleasesBaseEndpoint, EnvironmentMixin):
+class OrganizationReleasesStatsEndpoint(OrganizationReleasesBaseEndpoint):
     publish_status = {
         "GET": ApiPublishStatus.UNKNOWN,
     }

src/sentry/api/endpoints/organization_stats.py

@@ -4,17 +4,18 @@
 from sentry import tsdb
 from sentry.api.api_owners import ApiOwner
 from sentry.api.api_publish_status import ApiPublishStatus
-from sentry.api.base import EnvironmentMixin, StatsMixin, region_silo_endpoint
+from sentry.api.base import StatsMixin, region_silo_endpoint
 from sentry.api.bases.organization import OrganizationEndpoint
 from sentry.api.exceptions import ResourceDoesNotExist
+from sentry.api.helpers.environments import get_environment_id
 from sentry.models.environment import Environment
 from sentry.models.project import Project
 from sentry.models.team import Team
 from sentry.tsdb.base import TSDBModel
 
 
 @region_silo_endpoint
-class OrganizationStatsEndpoint(OrganizationEndpoint, EnvironmentMixin, StatsMixin):
+class OrganizationStatsEndpoint(OrganizationEndpoint, StatsMixin):
     publish_status = {
         # Deprecated APIs remain private until removed
         "GET": ApiPublishStatus.PRIVATE,
@@ -91,9 +92,7 @@ def get(self, request: Request, organization) -> Response:
             if group == "project":
                 stat_model = TSDBModel.project
                 try:
-                    query_kwargs["environment_id"] = self._get_environment_id_from_request(
-                        request, organization.id
-                    )
+                    query_kwargs["environment_id"] = get_environment_id(request, organization.id)
                 except Environment.DoesNotExist:
                     raise ResourceDoesNotExist