feat(graphene): Add span for grapqhl operation (#2788)

This commit adds a span for a GraphQL operation to the graphene integration.

Fixes #2765

---------

Co-authored-by: Anton Pirker <[email protected]>
Co-authored-by: Daniel Szoke <[email protected]>

Author: 3 people

sentry_sdk/integrations/graphene.py

@@ -1,4 +1,7 @@
+from contextlib import contextmanager
+
 import sentry_sdk
+from sentry_sdk.consts import OP
 from sentry_sdk.integrations import DidNotEnable, Integration
 from sentry_sdk.scope import Scope, should_send_default_pii
 from sentry_sdk.utils import (
@@ -17,6 +20,7 @@
 
 
 if TYPE_CHECKING:
+    from collections.abc import Generator
     from typing import Any, Dict, Union
     from graphene.language.source import Source  # type: ignore
     from graphql.execution import ExecutionResult  # type: ignore
@@ -52,13 +56,15 @@ def _sentry_patched_graphql_sync(schema, source, *args, **kwargs):
         scope = Scope.get_isolation_scope()
         scope.add_event_processor(_event_processor)
 
-        result = old_graphql_sync(schema, source, *args, **kwargs)
+        with graphql_span(schema, source, kwargs):
+            result = old_graphql_sync(schema, source, *args, **kwargs)
 
         with capture_internal_exceptions():
+            client = sentry_sdk.get_client()
             for error in result.errors or []:
                 event, hint = event_from_exception(
                     error,
-                    client_options=sentry_sdk.get_client().options,
+                    client_options=client.options,
                     mechanism={
                         "type": GrapheneIntegration.identifier,
                         "handled": False,
@@ -70,19 +76,22 @@ def _sentry_patched_graphql_sync(schema, source, *args, **kwargs):
 
     async def _sentry_patched_graphql_async(schema, source, *args, **kwargs):
         # type: (GraphQLSchema, Union[str, Source], Any, Any) -> ExecutionResult
-        if sentry_sdk.get_client().get_integration(GrapheneIntegration) is None:
+        integration = sentry_sdk.get_client().get_integration(GrapheneIntegration)
+        if integration is None:
             return await old_graphql_async(schema, source, *args, **kwargs)
 
         scope = Scope.get_isolation_scope()
         scope.add_event_processor(_event_processor)
 
-        result = await old_graphql_async(schema, source, *args, **kwargs)
+        with graphql_span(schema, source, kwargs):
+            result = await old_graphql_async(schema, source, *args, **kwargs)
 
         with capture_internal_exceptions():
+            client = sentry_sdk.get_client()
             for error in result.errors or []:
                 event, hint = event_from_exception(
                     error,
-                    client_options=sentry_sdk.get_client().options,
+                    client_options=client.options,
                     mechanism={
                         "type": GrapheneIntegration.identifier,
                         "handled": False,
@@ -106,3 +115,43 @@ def _event_processor(event, hint):
         del event["request"]["data"]
 
     return event
+
+
+@contextmanager
+def graphql_span(schema, source, kwargs):
+    # type: (GraphQLSchema, Union[str, Source], Dict[str, Any]) -> Generator[None, None, None]
+    operation_name = kwargs.get("operation_name")
+
+    operation_type = "query"
+    op = OP.GRAPHQL_QUERY
+    if source.strip().startswith("mutation"):
+        operation_type = "mutation"
+        op = OP.GRAPHQL_MUTATION
+    elif source.strip().startswith("subscription"):
+        operation_type = "subscription"
+        op = OP.GRAPHQL_SUBSCRIPTION
+
+    sentry_sdk.add_breadcrumb(
+        crumb={
+            "data": {
+                "operation_name": operation_name,
+                "operation_type": operation_type,
+            },
+            "category": "graphql.operation",
+        },
+    )
+
+    scope = Scope.get_current_scope()
+    if scope.span:
+        _graphql_span = scope.span.start_child(op=op, description=operation_name)
+    else:
+        _graphql_span = sentry_sdk.start_span(op=op, description=operation_name)
+
+    _graphql_span.set_data("graphql.document", source)
+    _graphql_span.set_data("graphql.operation.name", operation_name)
+    _graphql_span.set_data("graphql.operation.type", operation_type)
+
+    try:
+        yield
+    finally:
+        _graphql_span.finish()

tests/integrations/graphene/test_graphene.py

@@ -3,6 +3,7 @@
 from flask import Flask, request, jsonify
 from graphene import ObjectType, String, Schema
 
+from sentry_sdk.consts import OP
 from sentry_sdk.integrations.fastapi import FastApiIntegration
 from sentry_sdk.integrations.flask import FlaskIntegration
 from sentry_sdk.integrations.graphene import GrapheneIntegration
@@ -201,3 +202,82 @@ def graphql_server_sync():
     client.post("/graphql", json=query)
 
     assert len(events) == 0
+
+
+def test_graphql_span_holds_query_information(sentry_init, capture_events):
+    sentry_init(
+        integrations=[GrapheneIntegration(), FlaskIntegration()],
+        enable_tracing=True,
+        default_integrations=False,
+    )
+    events = capture_events()
+
+    schema = Schema(query=Query)
+
+    sync_app = Flask(__name__)
+
+    @sync_app.route("/graphql", methods=["POST"])
+    def graphql_server_sync():
+        data = request.get_json()
+        result = schema.execute(data["query"], operation_name=data.get("operationName"))
+        return jsonify(result.data), 200
+
+    query = {
+        "query": "query GreetingQuery { hello }",
+        "operationName": "GreetingQuery",
+    }
+    client = sync_app.test_client()
+    client.post("/graphql", json=query)
+
+    assert len(events) == 1
+
+    (event,) = events
+    assert len(event["spans"]) == 1
+
+    (span,) = event["spans"]
+    assert span["op"] == OP.GRAPHQL_QUERY
+    assert span["description"] == query["operationName"]
+    assert span["data"]["graphql.document"] == query["query"]
+    assert span["data"]["graphql.operation.name"] == query["operationName"]
+    assert span["data"]["graphql.operation.type"] == "query"
+
+
+def test_breadcrumbs_hold_query_information_on_error(sentry_init, capture_events):
+    sentry_init(
+        integrations=[
+            GrapheneIntegration(),
+        ],
+        default_integrations=False,
+    )
+    events = capture_events()
+
+    schema = Schema(query=Query)
+
+    sync_app = Flask(__name__)
+
+    @sync_app.route("/graphql", methods=["POST"])
+    def graphql_server_sync():
+        data = request.get_json()
+        result = schema.execute(data["query"], operation_name=data.get("operationName"))
+        return jsonify(result.data), 200
+
+    query = {
+        "query": "query ErrorQuery { goodbye }",
+        "operationName": "ErrorQuery",
+    }
+    client = sync_app.test_client()
+    client.post("/graphql", json=query)
+
+    assert len(events) == 1
+
+    (event,) = events
+    assert len(event["breadcrumbs"]) == 1
+
+    breadcrumbs = event["breadcrumbs"]["values"]
+    assert len(breadcrumbs) == 1
+
+    (breadcrumb,) = breadcrumbs
+    assert breadcrumb["category"] == "graphql.operation"
+    assert breadcrumb["data"]["operation_name"] == query["operationName"]
+    assert breadcrumb["data"]["operation_type"] == "query"
+    assert breadcrumb["type"] == "default"