fix(django): Support for Django 3.1 (#707)

    Django 3.1a1 adds more parameters to load_middleware which we do not really care about.

    Django 3.1a1 starts executing exception handlers in a random thread/with the wrong context. Turns out they have their own implementation of context local that is necessary to be able to find the right hub. See also getsentry/sentry-docs#1721

More support is required for supporting async middlewares once Django 3.1 comes out but this should unbreak basic usage of the sdk.

Fix #704

Author: untitaker

mypy.ini

@@ -46,3 +46,5 @@ ignore_missing_imports = True
 ignore_missing_imports = True
 [mypy-pyspark.*]
 ignore_missing_imports = True
+[mypy-asgiref.*]
+ignore_missing_imports = True

sentry_sdk/integrations/django/__init__.py

@@ -120,39 +120,9 @@ def sentry_patched_wsgi_handler(self, environ, start_response):
 
         WSGIHandler.__call__ = sentry_patched_wsgi_handler
 
-        _patch_django_asgi_handler()
-
-        # patch get_response, because at that point we have the Django request
-        # object
-        from django.core.handlers.base import BaseHandler
-
-        old_get_response = BaseHandler.get_response
-
-        def sentry_patched_get_response(self, request):
-            # type: (Any, WSGIRequest) -> Union[HttpResponse, BaseException]
-            hub = Hub.current
-            integration = hub.get_integration(DjangoIntegration)
-            if integration is not None:
-                _patch_drf()
-
-                with hub.configure_scope() as scope:
-                    # Rely on WSGI middleware to start a trace
-                    try:
-                        if integration.transaction_style == "function_name":
-                            scope.transaction = transaction_from_function(
-                                resolve(request.path).func
-                            )
-                        elif integration.transaction_style == "url":
-                            scope.transaction = LEGACY_RESOLVER.resolve(request.path)
-                    except Exception:
-                        pass
-
-                    scope.add_event_processor(
-                        _make_event_processor(weakref.ref(request), integration)
-                    )
-            return old_get_response(self, request)
+        _patch_get_response()
 
-        BaseHandler.get_response = sentry_patched_get_response
+        _patch_django_asgi_handler()
 
         signals.got_request_exception.connect(_got_request_exception)
 
@@ -337,6 +307,54 @@ def _patch_django_asgi_handler():
     patch_django_asgi_handler_impl(ASGIHandler)
 
 
+def _before_get_response(request):
+    # type: (WSGIRequest) -> None
+    hub = Hub.current
+    integration = hub.get_integration(DjangoIntegration)
+    if integration is None:
+        return
+
+    _patch_drf()
+
+    with hub.configure_scope() as scope:
+        # Rely on WSGI middleware to start a trace
+        try:
+            if integration.transaction_style == "function_name":
+                scope.transaction = transaction_from_function(
+                    resolve(request.path).func
+                )
+            elif integration.transaction_style == "url":
+                scope.transaction = LEGACY_RESOLVER.resolve(request.path)
+        except Exception:
+            pass
+
+        scope.add_event_processor(
+            _make_event_processor(weakref.ref(request), integration)
+        )
+
+
+def _patch_get_response():
+    # type: () -> None
+    """
+    patch get_response, because at that point we have the Django request object
+    """
+    from django.core.handlers.base import BaseHandler
+
+    old_get_response = BaseHandler.get_response
+
+    def sentry_patched_get_response(self, request):
+        # type: (Any, WSGIRequest) -> Union[HttpResponse, BaseException]
+        _before_get_response(request)
+        return old_get_response(self, request)
+
+    BaseHandler.get_response = sentry_patched_get_response
+
+    if hasattr(BaseHandler, "get_response_async"):
+        from sentry_sdk.integrations.django.asgi import patch_get_response_async
+
+        patch_get_response_async(BaseHandler, _before_get_response)
+
+
 def _make_event_processor(weak_request, integration):
     # type: (Callable[[], WSGIRequest], DjangoIntegration) -> EventProcessor
     def event_processor(event, hint):

sentry_sdk/integrations/django/asgi.py

@@ -14,6 +14,9 @@
 
 if MYPY:
     from typing import Any
+    from typing import Union
+
+    from django.http.response import HttpResponse
 
 
 def patch_django_asgi_handler_impl(cls):
@@ -33,6 +36,18 @@ async def sentry_patched_asgi_handler(self, scope, receive, send):
     cls.__call__ = sentry_patched_asgi_handler
 
 
+def patch_get_response_async(cls, _before_get_response):
+    # type: (Any, Any) -> None
+    old_get_response_async = cls.get_response_async
+
+    async def sentry_patched_get_response_async(self, request):
+        # type: (Any, Any) -> Union[HttpResponse, BaseException]
+        _before_get_response(request)
+        return await old_get_response_async(self, request)
+
+    cls.get_response_async = sentry_patched_get_response_async
+
+
 def patch_channels_asgi_handler_impl(cls):
     # type: (Any) -> None
     old_app = cls.__call__

sentry_sdk/integrations/django/middleware.py

@@ -49,11 +49,11 @@ def sentry_patched_import_string(dotted_path):
 
     old_load_middleware = base.BaseHandler.load_middleware
 
-    def sentry_patched_load_middleware(self):
-        # type: (base.BaseHandler) -> Any
+    def sentry_patched_load_middleware(*args, **kwargs):
+        # type: (Any, Any) -> Any
         _import_string_should_wrap_middleware.set(True)
         try:
-            return old_load_middleware(self)
+            return old_load_middleware(*args, **kwargs)
         finally:
             _import_string_should_wrap_middleware.set(False)
 

sentry_sdk/utils.py

@@ -751,6 +751,27 @@ def _is_contextvars_broken():
     return False
 
 
+def _make_threadlocal_contextvars(local):
+    # type: (type) -> type
+    class ContextVar(object):
+        # Super-limited impl of ContextVar
+
+        def __init__(self, name):
+            # type: (str) -> None
+            self._name = name
+            self._local = local()
+
+        def get(self, default):
+            # type: (Any) -> Any
+            return getattr(self._local, "value", default)
+
+        def set(self, value):
+            # type: (Any) -> None
+            self._local.value = value
+
+    return ContextVar
+
+
 def _get_contextvars():
     # type: () -> Tuple[bool, type]
     """
@@ -786,23 +807,7 @@ def _get_contextvars():
 
     from threading import local
 
-    class ContextVar(object):
-        # Super-limited impl of ContextVar
-
-        def __init__(self, name):
-            # type: (str) -> None
-            self._name = name
-            self._local = local()
-
-        def get(self, default):
-            # type: (Any) -> Any
-            return getattr(self._local, "value", default)
-
-        def set(self, value):
-            # type: (Any) -> None
-            self._local.value = value
-
-    return False, ContextVar
+    return False, _make_threadlocal_contextvars(local)
 
 
 HAS_REAL_CONTEXTVARS, ContextVar = _get_contextvars()

tests/integrations/django/asgi/test_asgi.py

@@ -18,8 +18,9 @@
 
 @pytest.mark.parametrize("application", APPS)
 @pytest.mark.asyncio
-async def test_basic(sentry_init, capture_events, application):
+async def test_basic(sentry_init, capture_events, application, request):
     sentry_init(integrations=[DjangoIntegration()], send_default_pii=True)
+
     events = capture_events()
 
     comm = HttpCommunicator(application, "GET", "/view-exc?test=query")

tox.ini

@@ -73,10 +73,10 @@ envlist =
 deps =
     -r test-requirements.txt
 
-    django-{1.11,2.0,2.1,2.2,3.0}: djangorestframework>=3.0.0,<4.0.0
-    py3.7-django-{1.11,2.0,2.1,2.2,3.0}: channels>2
-    py3.7-django-{1.11,2.0,2.1,2.2,3.0}: pytest-asyncio==0.10.0
-    {py2.7,py3.7}-django-{1.11,2.2,3.0}: psycopg2-binary
+    django-{1.11,2.0,2.1,2.2,3.0,dev}: djangorestframework>=3.0.0,<4.0.0
+    {py3.7,py3.8}-django-{1.11,2.0,2.1,2.2,3.0,dev}: channels>2
+    {py3.7,py3.8}-django-{1.11,2.0,2.1,2.2,3.0,dev}: pytest-asyncio==0.10.0
+    {py2.7,py3.7,py3.8}-django-{1.11,2.2,3.0,dev}: psycopg2-binary
 
     django-{1.6,1.7,1.8}: pytest-django<3.0
     django-{1.9,1.10,1.11,2.0,2.1,2.2,3.0,dev}: pytest-django>=3.0