ref(grpc): Use new scopes API (#2886)

Author: sentrivana

sentry_sdk/integrations/grpc/aio/client.py

@@ -9,19 +9,20 @@
 )
 from google.protobuf.message import Message
 
-from sentry_sdk import Hub
+import sentry_sdk
 from sentry_sdk.consts import OP
+from sentry_sdk.scope import Scope
 
 
 class ClientInterceptor:
     @staticmethod
-    def _update_client_call_details_metadata_from_hub(
-        client_call_details: ClientCallDetails, hub: Hub
+    def _update_client_call_details_metadata_from_scope(
+        client_call_details: ClientCallDetails,
     ) -> ClientCallDetails:
         metadata = (
             list(client_call_details.metadata) if client_call_details.metadata else []
         )
-        for key, value in hub.iter_trace_propagation_headers():
+        for key, value in Scope.get_current_scope().iter_trace_propagation_headers():
             metadata.append((key, value))
 
         client_call_details = ClientCallDetails(
@@ -42,17 +43,16 @@ async def intercept_unary_unary(
         client_call_details: ClientCallDetails,
         request: Message,
     ) -> Union[UnaryUnaryCall, Message]:
-        hub = Hub.current
         method = client_call_details.method
 
-        with hub.start_span(
+        with sentry_sdk.start_span(
             op=OP.GRPC_CLIENT, description="unary unary call to %s" % method.decode()
         ) as span:
             span.set_data("type", "unary unary")
             span.set_data("method", method)
 
-            client_call_details = self._update_client_call_details_metadata_from_hub(
-                client_call_details, hub
+            client_call_details = self._update_client_call_details_metadata_from_scope(
+                client_call_details
             )
 
             response = await continuation(client_call_details, request)
@@ -71,17 +71,16 @@ async def intercept_unary_stream(
         client_call_details: ClientCallDetails,
         request: Message,
     ) -> Union[AsyncIterable[Any], UnaryStreamCall]:
-        hub = Hub.current
         method = client_call_details.method
 
-        with hub.start_span(
+        with sentry_sdk.start_span(
             op=OP.GRPC_CLIENT, description="unary stream call to %s" % method.decode()
         ) as span:
             span.set_data("type", "unary stream")
             span.set_data("method", method)
 
-            client_call_details = self._update_client_call_details_metadata_from_hub(
-                client_call_details, hub
+            client_call_details = self._update_client_call_details_metadata_from_scope(
+                client_call_details
             )
 
             response = await continuation(client_call_details, request)

sentry_sdk/integrations/grpc/aio/server.py

@@ -1,11 +1,11 @@
-from sentry_sdk import Hub
-from sentry_sdk._types import MYPY
+import sentry_sdk
+from sentry_sdk._types import TYPE_CHECKING
 from sentry_sdk.consts import OP
 from sentry_sdk.integrations import DidNotEnable
 from sentry_sdk.tracing import Transaction, TRANSACTION_SOURCE_CUSTOM
 from sentry_sdk.utils import event_from_exception
 
-if MYPY:
+if TYPE_CHECKING:
     from collections.abc import Awaitable, Callable
     from typing import Any
 
@@ -39,8 +39,6 @@ async def wrapped(request, context):
                 if not name:
                     return await handler(request, context)
 
-                hub = Hub.current
-
                 # What if the headers are empty?
                 transaction = Transaction.continue_from_headers(
                     dict(context.invocation_metadata()),
@@ -49,7 +47,7 @@ async def wrapped(request, context):
                     source=TRANSACTION_SOURCE_CUSTOM,
                 )
 
-                with hub.start_transaction(transaction=transaction):
+                with sentry_sdk.start_transaction(transaction=transaction):
                     try:
                         return await handler.unary_unary(request, context)
                     except AbortError:
@@ -59,7 +57,7 @@ async def wrapped(request, context):
                             exc,
                             mechanism={"type": "grpc", "handled": False},
                         )
-                        hub.capture_event(event, hint=hint)
+                        sentry_sdk.capture_event(event, hint=hint)
                         raise
 
         elif not handler.request_streaming and handler.response_streaming:

sentry_sdk/integrations/grpc/client.py

@@ -1,9 +1,10 @@
-from sentry_sdk import Hub
-from sentry_sdk._types import MYPY
+import sentry_sdk
+from sentry_sdk._types import TYPE_CHECKING
 from sentry_sdk.consts import OP
 from sentry_sdk.integrations import DidNotEnable
+from sentry_sdk.scope import Scope
 
-if MYPY:
+if TYPE_CHECKING:
     from typing import Any, Callable, Iterator, Iterable, Union
 
 try:
@@ -23,17 +24,16 @@ class ClientInterceptor(
 
     def intercept_unary_unary(self, continuation, client_call_details, request):
         # type: (ClientInterceptor, Callable[[ClientCallDetails, Message], _UnaryOutcome], ClientCallDetails, Message) -> _UnaryOutcome
-        hub = Hub.current
         method = client_call_details.method
 
-        with hub.start_span(
+        with sentry_sdk.start_span(
             op=OP.GRPC_CLIENT, description="unary unary call to %s" % method
         ) as span:
             span.set_data("type", "unary unary")
             span.set_data("method", method)
 
-            client_call_details = self._update_client_call_details_metadata_from_hub(
-                client_call_details, hub
+            client_call_details = self._update_client_call_details_metadata_from_scope(
+                client_call_details
             )
 
             response = continuation(client_call_details, request)
@@ -43,17 +43,16 @@ def intercept_unary_unary(self, continuation, client_call_details, request):
 
     def intercept_unary_stream(self, continuation, client_call_details, request):
         # type: (ClientInterceptor, Callable[[ClientCallDetails, Message], Union[Iterable[Any], UnaryStreamCall]], ClientCallDetails, Message) -> Union[Iterator[Message], Call]
-        hub = Hub.current
         method = client_call_details.method
 
-        with hub.start_span(
+        with sentry_sdk.start_span(
             op=OP.GRPC_CLIENT, description="unary stream call to %s" % method
         ) as span:
             span.set_data("type", "unary stream")
             span.set_data("method", method)
 
-            client_call_details = self._update_client_call_details_metadata_from_hub(
-                client_call_details, hub
+            client_call_details = self._update_client_call_details_metadata_from_scope(
+                client_call_details
             )
 
             response = continuation(
@@ -65,12 +64,12 @@ def intercept_unary_stream(self, continuation, client_call_details, request):
             return response
 
     @staticmethod
-    def _update_client_call_details_metadata_from_hub(client_call_details, hub):
-        # type: (ClientCallDetails, Hub) -> ClientCallDetails
+    def _update_client_call_details_metadata_from_scope(client_call_details):
+        # type: (ClientCallDetails) -> ClientCallDetails
         metadata = (
             list(client_call_details.metadata) if client_call_details.metadata else []
         )
-        for key, value in hub.iter_trace_propagation_headers():
+        for key, value in Scope.get_current_scope().iter_trace_propagation_headers():
             metadata.append((key, value))
 
         client_call_details = grpc._interceptor._ClientCallDetails(

sentry_sdk/integrations/grpc/server.py

@@ -1,10 +1,10 @@
-from sentry_sdk import Hub
-from sentry_sdk._types import MYPY
+import sentry_sdk
+from sentry_sdk._types import TYPE_CHECKING
 from sentry_sdk.consts import OP
 from sentry_sdk.integrations import DidNotEnable
 from sentry_sdk.tracing import Transaction, TRANSACTION_SOURCE_CUSTOM
 
-if MYPY:
+if TYPE_CHECKING:
     from typing import Callable, Optional
     from google.protobuf.message import Message
 
@@ -30,27 +30,26 @@ def intercept_service(self, continuation, handler_call_details):
 
         def behavior(request, context):
             # type: (Message, ServicerContext) -> Message
-            hub = Hub(Hub.current)
-
-            name = self._find_method_name(context)
-
-            if name:
-                metadata = dict(context.invocation_metadata())
-
-                transaction = Transaction.continue_from_headers(
-                    metadata,
-                    op=OP.GRPC_SERVER,
-                    name=name,
-                    source=TRANSACTION_SOURCE_CUSTOM,
-                )
-
-                with hub.start_transaction(transaction=transaction):
-                    try:
-                        return handler.unary_unary(request, context)
-                    except BaseException as e:
-                        raise e
-            else:
-                return handler.unary_unary(request, context)
+            with sentry_sdk.isolation_scope():
+                name = self._find_method_name(context)
+
+                if name:
+                    metadata = dict(context.invocation_metadata())
+
+                    transaction = Transaction.continue_from_headers(
+                        metadata,
+                        op=OP.GRPC_SERVER,
+                        name=name,
+                        source=TRANSACTION_SOURCE_CUSTOM,
+                    )
+
+                    with sentry_sdk.start_transaction(transaction=transaction):
+                        try:
+                            return handler.unary_unary(request, context)
+                        except BaseException as e:
+                            raise e
+                else:
+                    return handler.unary_unary(request, context)
 
         return grpc.unary_unary_rpc_method_handler(
             behavior,

tests/integrations/grpc/test_grpc.py

@@ -6,7 +6,7 @@
 import grpc
 import pytest
 
-from sentry_sdk import Hub, start_transaction
+from sentry_sdk import start_span, start_transaction
 from sentry_sdk.consts import OP
 from sentry_sdk.integrations.grpc import GRPCIntegration
 from tests.integrations.grpc.grpc_test_service_pb2 import gRPCTestMessage
@@ -310,8 +310,7 @@ class TestService(gRPCTestServiceServicer):
 
     @staticmethod
     def TestServe(request, context):  # noqa: N802
-        hub = Hub.current
-        with hub.start_span(op="test", description="test"):
+        with start_span(op="test", description="test"):
             pass
 
         return gRPCTestMessage(text=request.text)