Track proper user info in sentry

main/middlewares.py

@@ -1,31 +1,33 @@
-import json
-
+from asgiref.sync import iscoroutinefunction
 from django.urls import reverse
-from sentry_sdk import Scope
-
-
-class SentryTransactionMiddleware:
-    graphql_url = reverse("graphql")
-
-    def __init__(self, get_response):
-        self.get_response = get_response
-
-    def __call__(self, request):
-        if request.path == self.graphql_url:
-            operation_type = "Query"
-            operation_name = "Unknown"
-            try:
-                body = request.body.decode("utf-8")
-                if body:
-                    # XXX: This will be repeated by Strawberry as well.
-                    data = json.loads(body)
-                    operation_name = data.get("operationName", operation_name)
-                    if data.get("query", "").startswith("mutation"):
-                        operation_type = "Mutation"
-            except Exception:
-                ...
-
-            scope = Scope.get_current_scope()
-            scope.set_transaction_name(f"GraphQL/{operation_type}/{operation_name}")
-
-        return self.get_response(request)
+from django.utils.decorators import sync_and_async_middleware
+
+from main.sentry import SentryTransactionMiddlewareHelper
+
+
+@sync_and_async_middleware
+def sentry_middleware(get_response):
+    from django.conf import settings
+
+    # One-time configuration and initialization goes here.
+    graphql_urls = set([reverse("graphql")])
+    if settings.DEBUG:
+        graphql_urls.add(reverse("graphiql"))
+
+    if iscoroutinefunction(get_response):
+
+        async def amiddleware(request):
+            if settings.SENTRY_ENABLED:
+                await SentryTransactionMiddlewareHelper.atrack_transaction(graphql_urls, request)
+            response = await get_response(request)
+            return response
+
+        return amiddleware
+
+    def middleware(request):
+        if settings.SENTRY_ENABLED:
+            SentryTransactionMiddlewareHelper.track_transaction(graphql_urls, request)
+        response = get_response(request)
+        return response
+
+    return middleware

main/sentry.py

@@ -1,4 +1,8 @@
+import json
+
 import sentry_sdk
+from asgiref.sync import sync_to_async
+from sentry_sdk import Scope, set_user
 from sentry_sdk.integrations.celery import CeleryIntegration
 from sentry_sdk.integrations.django import DjangoIntegration
 from sentry_sdk.integrations.logging import ignore_logger
@@ -31,3 +35,37 @@ def init_sentry(app_type, tags={}, **config):
         scope.set_tag("app_type", app_type)
         for tag, value in tags.items():
             scope.set_tag(tag, value)
+
+
+class SentryTransactionMiddlewareHelper:
+    @classmethod
+    @sync_to_async
+    def atrack_transaction(cls, graphql_urls: set[str], request):
+        return cls.track_transaction(graphql_urls, request)
+
+    @staticmethod
+    def track_transaction(graphql_urls: set[str], request):
+        if request.path in graphql_urls:
+            operation_type = "Query"
+            operation_name = "Unknown"
+            try:
+                body = request.body.decode("utf-8")
+                if body:
+                    # XXX: This will be repeated by Strawberry as well.
+                    data = json.loads(body)
+                    operation_name = data.get("operationName", operation_name)
+                    if data.get("query", "").startswith("mutation"):
+                        operation_type = "Mutation"
+            except Exception:
+                ...
+
+            scope = Scope.get_current_scope()
+            scope.set_transaction_name(f"GraphQL/{operation_type}/{operation_name}")
+            if (user := request.user) and user.pk:
+                set_user(
+                    {
+                        "id": user.pk,
+                        "email": user.email,
+                        "is_superuser": user.is_superuser,
+                    }
+                )

main/settings.py

@@ -156,7 +156,7 @@
     "django.contrib.auth.middleware.AuthenticationMiddleware",
     "django.contrib.messages.middleware.MessageMiddleware",
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
-    "main.middlewares.SentryTransactionMiddleware",
+    "main.middlewares.sentry_middleware",
 ]
 
 ROOT_URLCONF = "main.urls"

main/urls.py

@@ -31,7 +31,7 @@
 if settings.DEBUG:
     urlpatterns.extend(
         [
-            path("graphiql/", CustomAsyncGraphQLView.as_view(schema=graphql_schema)),
+            path("graphiql/", CustomAsyncGraphQLView.as_view(schema=graphql_schema), name="graphiql"),
             path("dev/sign_in/", dev_sign_in, name="dev-sign-in"),
         ]
     )