Fix unavailable request data while using with REST framework #591 (#1061)

* Add DjangoRestFrameworkCompatMiddleware

* Update DjangoRestFrameworkCompatMiddleware to not require get_response in constructor

This is for compatibility with Django 1.10 and earlier

* Add unit tests for DjangoRestFrameworkCompatMiddleware

* Update docstring in install_middleware function

* Convert DjangoRestFrameworkCompatMiddleware to be backwards-compatible

* Make sure that middlewares are not set in test_request_data_unavailable_if_request_is_read

2 files changed, 28 insertions, 10 deletions

diff --git a/raven/contrib/django/middleware/__init__.py b/raven/contrib/django/middleware/__init__.py
index fd0486d..809cd82 100644
--- a/raven/contrib/django/middleware/__init__.py
+++ b/raven/contrib/django/middleware/__init__.py
@@ -118,3 +118,18 @@ class SentryMiddleware(MiddlewareMixin):
 
 
 SentryLogMiddleware = SentryMiddleware
+
+
+class DjangoRestFrameworkCompatMiddleware(MiddlewareMixin):
+    def process_request(self, request):
+        """
+        Access request.body, otherwise it might not be accessible later
+        after request has been read/streamed
+        """
+        content_type = request.META.get('CONTENT_TYPE', '')
+        if 'application/x-www-form-urlencoded' in content_type:
+            pass
+        elif 'multipart/form-data' in content_type:
+            pass
+        else:
+            request.body  # forces stream to be read into memory
diff --git a/raven/contrib/django/models.py b/raven/contrib/django/models.py
index 08caa67..149ef9f 100644
--- a/raven/contrib/django/models.py
+++ b/raven/contrib/django/models.py
@@ -212,15 +212,12 @@ def register_serializers():
     import raven.contrib.django.serializers  # NOQA
 
 
-def install_middleware():
+def install_middleware(middleware_name, lookup_names=None):
     """
-    Force installation of SentryMiddlware if it's not explicitly present.
-
-    This ensures things like request context and transaction names are made
-    available.
+    Install specified middleware
     """
-    name = 'raven.contrib.django.middleware.SentryMiddleware'
-    all_names = (name, 'raven.contrib.django.middleware.SentryLogMiddleware')
+    if lookup_names is None:
+        lookup_names = (middleware_name,)
     # default settings.MIDDLEWARE is None
     middleware_attr = 'MIDDLEWARE' if getattr(settings,
                                               'MIDDLEWARE',
@@ -228,10 +225,10 @@ def install_middleware():
         else 'MIDDLEWARE_CLASSES'
     # make sure to get an empty tuple when attr is None
     middleware = getattr(settings, middleware_attr, ()) or ()
-    if set(all_names).isdisjoint(set(middleware)):
+    if set(lookup_names).isdisjoint(set(middleware)):
         setattr(settings,
                 middleware_attr,
-                type(middleware)((name,)) + middleware)
+                type(middleware)((middleware_name,)) + middleware)
 
 
 _setup_lock = Lock()
@@ -250,7 +247,13 @@ def initialize():
 
         try:
             register_serializers()
-            install_middleware()
+            install_middleware(
+                'raven.contrib.django.middleware.SentryMiddleware',
+                (
+                    'raven.contrib.django.middleware.SentryMiddleware',
+                    'raven.contrib.django.middleware.SentryLogMiddleware'))
+            install_middleware(
+                'raven.contrib.django.middleware.DjangoRestFrameworkCompatMiddleware')
 
             # XXX(dcramer): maybe this setting should disable ALL of this?
             if not getattr(settings, 'DISABLE_SENTRY_INSTRUMENTATION', False):