lint

reddit · Apr 30, 2024 · a8f6641 · a8f6641
1 parent 01445a9
commit a8f6641
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 179 deletions.
diff --git a/lib/go/edgecontext/oauth_client.go b/lib/go/edgecontext/oauth_client.go
@@ -23,11 +23,11 @@ func (o OAuthClient) ID() string {
 //
 // For example, use:
 //
-//     if client.IsType("third_party")
+//	if client.IsType("third_party")
 //
 // Instead of:
 //
-//     if !client.IsType("first_party")
+//	if !client.IsType("first_party")
 func (o OAuthClient) IsType(types ...string) bool {
 	clientType := AuthenticationToken(o).OAuthClientType
 	for _, t := range types {

diff --git a/lib/go/edgecontext/service.go b/lib/go/edgecontext/service.go
@@ -27,6 +27,10 @@ func (s Service) Name() (name string, ok bool) {
 	return
 }
 
+// OnBehalfOfID returns the ID of the user on whose behalf the service is acting.
+//
+// If it's not coming from an authenticated service,
+// ("", false) will be returned.
 func (s Service) OnBehalfOfID() (id string, ok bool) {
 	if s.isService() {
 		token := AuthenticationToken(s)
@@ -41,6 +45,10 @@ func (s Service) OnBehalfOfID() (id string, ok bool) {
 	return
 }
 
+// OnBehalfOfRoles returns the roles of the user on whose behalf the service is acting.
+//
+// If it's not coming from an authenticated service,
+// (nil, false) will be returned.
 func (s Service) OnBehalfOfRoles() (roles []string, ok bool) {
 	if s.isService() {
 		token := AuthenticationToken(s)
@@ -52,6 +60,7 @@ func (s Service) OnBehalfOfRoles() (roles []string, ok bool) {
 	return
 }
 
+// IsElevatedAccess returns whether the service requested elevated access.
 func (s Service) IsElevatedAccess() bool {
 	if s.isService() {
 		return AuthenticationToken(s).ServiceRequestedElevatedAccess

diff --git a/lib/py/reddit_edgecontext/__init__.py b/lib/py/reddit_edgecontext/__init__.py
@@ -17,9 +17,6 @@
 from baseplate.lib.edgecontext import EdgeContextFactory as BaseEdgeContextFactory
 from baseplate.lib.secrets import SecretsStore
 from jwt.algorithms import get_default_algorithms
-from thrift import TSerialization
-from thrift.protocol.TBinaryProtocol import TBinaryProtocolAcceleratedFactory
-
 from reddit_edgecontext.thrift.ttypes import Device as TDevice
 from reddit_edgecontext.thrift.ttypes import Geolocation as TGeolocation
 from reddit_edgecontext.thrift.ttypes import Locale as TLocale
@@ -28,6 +25,8 @@
 from reddit_edgecontext.thrift.ttypes import Request as TRequest
 from reddit_edgecontext.thrift.ttypes import RequestId as TRequestId
 from reddit_edgecontext.thrift.ttypes import Session as TSession
+from thrift import TSerialization
+from thrift.protocol.TBinaryProtocol import TBinaryProtocolAcceleratedFactory
 
 
 logger = logging.getLogger(__name__)
@@ -537,9 +536,7 @@ def request_id(self) -> RequestId:
     @cached_property
     def locale(self) -> Locale:
         """:py:class:`~reddit_edgecontext.Locale` object for the current context."""
-        return Locale(
-            locale_code=self._t_request.locale.locale_code,
-        )
+        return Locale(locale_code=self._t_request.locale.locale_code)
 
     @cached_property
     def _t_request(self) -> TRequest:

diff --git a/lib/py/reddit_edgecontext/thrift/ttypes.py b/lib/py/reddit_edgecontext/thrift/ttypes.py
diff --git a/lib/py/tests/edge_context_tests.py b/lib/py/tests/edge_context_tests.py
@@ -2,7 +2,6 @@
 import unittest
 
 from baseplate.testing.lib.secrets import FakeSecretsStore
-
 from reddit_edgecontext import EdgeContextFactory
 from reddit_edgecontext import InvalidAuthenticationToken
 from reddit_edgecontext import NoAuthenticationError
@@ -135,10 +134,7 @@ def test_validated_service_authentication_token(self):
         payload = {
             "sub": "service/test-service",
             "exp": 1574458470,
-            "obo": {
-                "aid": "t2_deadbeef",
-                "roles": ["admin"],
-            },
+            "obo": {"aid": "t2_deadbeef", "roles": ["admin"]},
             "sea": True,
         }
 
@@ -208,9 +204,7 @@ def test_create_empty_context(self):
         self.assertEqual(
             request_context._header,
             # loid
-            b"\x0c\x00"  # STRUCT
-            b"\x01"  # tag number
-            b"\x00"  # END STRUCT
+            b"\x0c\x00" b"\x01" b"\x00"  # STRUCT  # tag number  # END STRUCT
             # session
             b"\x0c\x00\x02\x00"
             # device