ref: fix types for sentry.api.base

Author: asottile-sentry

pyproject.toml

@@ -111,7 +111,6 @@ ignore_missing_imports = true
 # - python3 -m tools.mypy_helpers.find_easiest_modules
 [[tool.mypy.overrides]]
 module = [
-    "sentry.api.base",
     "sentry.api.endpoints.group_integration_details",
     "sentry.api.endpoints.organization_events_meta",
     "sentry.api.endpoints.organization_events_spans_performance",

src/sentry/api/base.py

@@ -401,6 +401,7 @@ def dispatch(self, request: Request, *args, **kwargs) -> Response:
                 self.initial(request, *args, **kwargs)
 
                 # Get the appropriate handler method
+                assert request.method is not None
                 method = request.method.lower()
                 if method in self.http_method_names and hasattr(self, method):
                     handler = getattr(self, method)
@@ -445,6 +446,7 @@ def dispatch(self, request: Request, *args, **kwargs) -> Response:
 
         # Only enforced in dev environment
         if settings.ENFORCE_PAGINATION:
+            assert request.method is not None
             if request.method.lower() == "get":
                 status = getattr(self.response, "status_code", 0)
                 # Response can either be Response or HttpResponse, check if

src/sentry/auth/services/auth/model.py

@@ -55,7 +55,7 @@ class RpcAuthState(RpcModel):
 
 
 class AuthenticatedToken(RpcModel):
-    allowed_origins: list[str] = Field(default_factory=list)
+    allowed_origins: frozenset[str] = Field(default_factory=frozenset)
     audit_log_data: dict[str, Any] = Field(default_factory=dict)
     scopes: list[str] = Field(default_factory=list)
     entity_id: int | None = None
@@ -119,7 +119,7 @@ def from_token(cls, token: Any) -> Optional["AuthenticatedToken"]:
     def get_audit_log_data(self) -> Mapping[str, Any]:
         return self.audit_log_data
 
-    def get_allowed_origins(self) -> list[str]:
+    def get_allowed_origins(self) -> frozenset[str]:
         return self.allowed_origins
 
     def get_scopes(self) -> list[str]:

src/sentry/auth/system.py

@@ -81,8 +81,8 @@ def is_expired(self) -> bool:
     def user(self) -> AnonymousUser:
         return AnonymousUser()
 
-    def get_allowed_origins(self) -> list[str]:
-        return []
+    def get_allowed_origins(self) -> frozenset[str]:
+        return frozenset()
 
     def get_audit_log_data(self) -> dict[str, Any]:
         return {"label": "System", "key": "<system>", "scopes": -1}

src/sentry/hybridcloud/models/apikeyreplica.py

@@ -46,10 +46,10 @@ def entity_id(self) -> int:
     def is_active(self) -> bool:
         return self.status == ApiKeyStatus.ACTIVE
 
-    def get_allowed_origins(self) -> list[str]:
+    def get_allowed_origins(self) -> frozenset[str]:
         if not self.allowed_origins:
-            return []
-        return list(filter(bool, self.allowed_origins.split("\n")))
+            return frozenset()
+        return frozenset(origin for origin in self.allowed_origins.splitlines() if origin)
 
     def get_audit_log_data(self) -> dict[str, Any]:
         return {

src/sentry/hybridcloud/models/apitokenreplica.py

@@ -51,10 +51,10 @@ def is_expired(self) -> bool:
 
         return timezone.now() >= self.expires_at
 
-    def get_allowed_origins(self) -> list[str]:
+    def get_allowed_origins(self) -> frozenset[str]:
         if not self.allowed_origins:
-            return []
-        return [origin for origin in self.allowed_origins.split()]
+            return frozenset()
+        return frozenset(origin for origin in self.allowed_origins.split())
 
     def get_audit_log_data(self) -> dict[str, Any]:
         return {"scopes": self.get_scopes()}

src/sentry/hybridcloud/models/orgauthtokenreplica.py

@@ -45,8 +45,8 @@ def entity_id(self) -> int:
     def get_audit_log_data(self) -> dict[str, Any]:
         return {"name": self.name, "scopes": self.get_scopes()}
 
-    def get_allowed_origins(self) -> list[str]:
-        return []
+    def get_allowed_origins(self) -> frozenset[str]:
+        return frozenset()
 
     def get_scopes(self) -> list[str]:
         return self.scope_list

src/sentry/models/apiapplication.py

@@ -145,10 +145,10 @@ def is_valid_redirect_uri(self, value):
     def get_default_redirect_uri(self):
         return self.redirect_uris.split()[0]
 
-    def get_allowed_origins(self):
+    def get_allowed_origins(self) -> frozenset[str]:
         if not self.allowed_origins:
-            return []
-        return [origin for origin in self.allowed_origins.split()]
+            return frozenset()
+        return frozenset(origin for origin in self.allowed_origins.split())
 
     def get_redirect_uris(self):
         if not self.redirect_uris:

src/sentry/models/apikey.py

@@ -77,10 +77,10 @@ def save(self, *args, **kwargs):
             self.key = ApiKey.generate_api_key()
         super().save(*args, **kwargs)
 
-    def get_allowed_origins(self):
+    def get_allowed_origins(self) -> frozenset[str]:
         if not self.allowed_origins:
-            return []
-        return list(filter(bool, self.allowed_origins.split("\n")))
+            return frozenset()
+        return frozenset(origin for origin in self.allowed_origins.split("\n") if origin)
 
     def get_audit_log_data(self):
         return {

src/sentry/models/apitoken.py

@@ -299,10 +299,10 @@ def is_expired(self):
     def get_audit_log_data(self):
         return {"scopes": self.get_scopes()}
 
-    def get_allowed_origins(self):
+    def get_allowed_origins(self) -> frozenset[str]:
         if self.application:
             return self.application.get_allowed_origins()
-        return ()
+        return frozenset()
 
     def refresh(self, expires_at=None):
         if self.token_type == AuthTokenType.USER:

src/sentry/models/orgauthtoken.py

@@ -73,8 +73,8 @@ def __str__(self):
     def get_audit_log_data(self):
         return {"name": self.name, "scopes": self.get_scopes()}
 
-    def get_allowed_origins(self):
-        return []
+    def get_allowed_origins(self) -> frozenset[str]:
+        return frozenset()
 
     def get_scopes(self):
         return self.scope_list

src/sentry/models/projectkey.py

@@ -310,7 +310,7 @@ def get_endpoint(self) -> str:
 
         return endpoint
 
-    def get_allowed_origins(self):
+    def get_allowed_origins(self) -> frozenset[str]:
         from sentry.utils.http import get_origins
 
         return get_origins(self.project)

tests/sentry/models/test_apiapplication.py

@@ -40,11 +40,13 @@ def test_get_allowed_origins_space_separated(self):
             allowed_origins="http://example.com http://example2.com http://example.io",
         )
 
-        assert app.get_allowed_origins() == [
-            "http://example.com",
-            "http://example2.com",
-            "http://example.io",
-        ]
+        assert app.get_allowed_origins() == frozenset(
+            (
+                "http://example.com",
+                "http://example2.com",
+                "http://example.io",
+            )
+        )
 
     def test_get_allowed_origins_newline_separated(self):
         app = ApiApplication.objects.create(
@@ -53,24 +55,26 @@ def test_get_allowed_origins_newline_separated(self):
             allowed_origins="http://example.com\nhttp://example2.com\nhttp://example.io",
         )
 
-        assert app.get_allowed_origins() == [
-            "http://example.com",
-            "http://example2.com",
-            "http://example.io",
-        ]
+        assert app.get_allowed_origins() == frozenset(
+            (
+                "http://example.com",
+                "http://example2.com",
+                "http://example.io",
+            )
+        )
 
     def test_get_allowed_origins_none(self):
         app = ApiApplication.objects.create(
             name="origins_test",
             redirect_uris="http://example.com",
         )
 
-        assert app.get_allowed_origins() == []
+        assert app.get_allowed_origins() == frozenset()
 
     def test_get_allowed_origins_empty_string(self):
         app = ApiApplication.objects.create(name="origins_test", redirect_uris="")
 
-        assert app.get_allowed_origins() == []
+        assert app.get_allowed_origins() == frozenset()
 
     def test_get_redirect_uris_space_separated(self):
         app = ApiApplication.objects.create(

tests/sentry/sentry_apps/api/endpoints/test_sentry_app_details.py

@@ -130,7 +130,7 @@ def _validate_updated_published_app(self, response):
             "clientId": self.published_app.application.client_id,
             "clientSecret": self.published_app.application.client_secret,
             "overview": self.published_app.overview,
-            "allowedOrigins": [],
+            "allowedOrigins": frozenset(),
             "schema": {},
             "owner": {"id": self.organization.id, "slug": self.organization.slug},
             "featureData": [
@@ -687,7 +687,9 @@ def test_set_allowed_origins(self):
             allowedOrigins=["google.com", "sentry.io"],
             status_code=200,
         )
-        assert self.published_app.application.get_allowed_origins() == ["google.com", "sentry.io"]
+        assert self.published_app.application.get_allowed_origins() == frozenset(
+            ("google.com", "sentry.io")
+        )
 
     def test_allowed_origins_with_star(self):
         response = self.get_error_response(

tests/sentry/sentry_apps/api/endpoints/test_sentry_apps.py

@@ -730,7 +730,9 @@ def test_create_integration_with_allowed_origins(self):
         )
         sentry_app = SentryApp.objects.get(slug=response.data["slug"])
         assert sentry_app.application is not None
-        assert sentry_app.application.get_allowed_origins() == ["google.com", "example.com"]
+        assert sentry_app.application.get_allowed_origins() == frozenset(
+            ("google.com", "example.com")
+        )
 
     def test_create_internal_integration_with_allowed_origins_and_test_route(self):
         self.create_project(organization=self.organization)
@@ -743,7 +745,7 @@ def test_create_internal_integration_with_allowed_origins_and_test_route(self):
         response = self.get_success_response(**data, status_code=201)
         sentry_app = SentryApp.objects.get(slug=response.data["slug"])
         assert sentry_app.application is not None
-        assert sentry_app.application.get_allowed_origins() == ["example.com"]
+        assert sentry_app.application.get_allowed_origins() == frozenset(("example.com",))
 
         self.assert_sentry_app_status_code(sentry_app, status_code=200)
 
@@ -754,7 +756,7 @@ def test_create_internal_integration_without_allowed_origins_and_test_route(self
         response = self.get_success_response(**data, status_code=201)
         sentry_app = SentryApp.objects.get(slug=response.data["slug"])
         assert sentry_app.application is not None
-        assert sentry_app.application.get_allowed_origins() == []
+        assert sentry_app.application.get_allowed_origins() == frozenset()
 
         self.assert_sentry_app_status_code(sentry_app, status_code=400)