fix: Fix crash on Django function-based middleware (getsentry#541)

untitaker · web-flow · commit ad23d1c66aca · 2019-10-24T13:18:53.000+02:00
* Test showing failure of function-based middleware in django.

* fix: Fix crash of Django integration on Django 1.11 with function-based middleware

* fix: Formatting

* fix: Linters
diff --git a/sentry_sdk/integrations/django/middleware.py b/sentry_sdk/integrations/django/middleware.py
@@ -7,7 +7,11 @@
 from django import VERSION as DJANGO_VERSION
 
 from sentry_sdk import Hub
-from sentry_sdk.utils import ContextVar, transaction_from_function
+from sentry_sdk.utils import (
+    ContextVar,
+    transaction_from_function,
+    capture_internal_exceptions,
+)
 
 from sentry_sdk._types import MYPY
 
@@ -64,29 +68,36 @@ def _wrap_middleware(middleware, middleware_name):
 
     def _get_wrapped_method(old_method):
         # type: (F) -> F
-        @wraps(old_method)
-        def sentry_wrapped_method(*args, **kwargs):
-            # type: (*Any, **Any) -> Any
-            hub = Hub.current
-            integration = hub.get_integration(DjangoIntegration)
-            if integration is None or not integration.middleware_spans:
-                return old_method(*args, **kwargs)
-
-            function_name = transaction_from_function(old_method)
-
-            description = middleware_name
-            function_basename = getattr(old_method, "__name__", None)
-            if function_basename:
-                description = "{}.{}".format(description, function_basename)
-
-            with hub.start_span(
-                op="django.middleware", description=description
-            ) as span:
-                span.set_tag("django.function_name", function_name)
-                span.set_tag("django.middleware_name", middleware_name)
-                return old_method(*args, **kwargs)
-
-        return sentry_wrapped_method  # type: ignore
+        with capture_internal_exceptions():
+
+            def sentry_wrapped_method(*args, **kwargs):
+                # type: (*Any, **Any) -> Any
+                hub = Hub.current
+                integration = hub.get_integration(DjangoIntegration)
+                if integration is None or not integration.middleware_spans:
+                    return old_method(*args, **kwargs)
+
+                function_name = transaction_from_function(old_method)
+
+                description = middleware_name
+                function_basename = getattr(old_method, "__name__", None)
+                if function_basename:
+                    description = "{}.{}".format(description, function_basename)
+
+                with hub.start_span(
+                    op="django.middleware", description=description
+                ) as span:
+                    span.set_tag("django.function_name", function_name)
+                    span.set_tag("django.middleware_name", middleware_name)
+                    return old_method(*args, **kwargs)
+
+            try:
+                # fails for __call__ of function on Python 2 (see py2.7-django-1.11)
+                return wraps(old_method)(sentry_wrapped_method)  # type: ignore
+            except Exception:
+                return sentry_wrapped_method  # type: ignore
+
+        return old_method
 
     class SentryWrappingMiddleware(object):
         def __init__(self, *args, **kwargs):
diff --git a/tests/integrations/django/myapp/settings.py b/tests/integrations/django/myapp/settings.py
@@ -66,14 +66,23 @@ def process_response(self, request, response):
         return response
 
 
+def TestFunctionMiddleware(get_response):
+    def middleware(request):
+        return get_response(request)
+
+    return middleware
+
+
 MIDDLEWARE_CLASSES = [
     "django.contrib.sessions.middleware.SessionMiddleware",
     "django.contrib.auth.middleware.AuthenticationMiddleware",
     "tests.integrations.django.myapp.settings.TestMiddleware",
 ]
 
 if MiddlewareMixin is not object:
-    MIDDLEWARE = MIDDLEWARE_CLASSES
+    MIDDLEWARE = MIDDLEWARE_CLASSES + [
+        "tests.integrations.django.myapp.settings.TestFunctionMiddleware"
+    ]
 
 
 ROOT_URLCONF = "tests.integrations.django.myapp.urls"
diff --git a/tests/integrations/django/test_basic.py b/tests/integrations/django/test_basic.py
@@ -519,6 +519,7 @@ def test_middleware_spans(sentry_init, client, capture_events):
 
     if DJANGO_VERSION >= (1, 10):
         reference_value = [
+            "tests.integrations.django.myapp.settings.TestFunctionMiddleware.__call__",
             "tests.integrations.django.myapp.settings.TestMiddleware.__call__",
             "django.contrib.auth.middleware.AuthenticationMiddleware.__call__",
             "django.contrib.sessions.middleware.SessionMiddleware.__call__",
