[3.1.x] Fixed #32299 -- Prevented mutating handlers when processing middlewares marking as unused in an async context.

felixxm · felixxm · commit 6b4b7da740ce · 2020-12-29T09:06:03.000+01:00
Thanks Hubert Bielenia for the report. Backport of 98ad327 from master
diff --git a/django/core/handlers/base.py b/django/core/handlers/base.py
@@ -51,18 +51,20 @@ def load_middleware(self, is_async=False):
                 middleware_is_async = middleware_can_async
             try:
                 # Adapt handler, if needed.
-                handler = self.adapt_method_mode(
+                adapted_handler = self.adapt_method_mode(
                     middleware_is_async, handler, handler_is_async,
                     debug=settings.DEBUG, name='middleware %s' % middleware_path,
                 )
-                mw_instance = middleware(handler)
+                mw_instance = middleware(adapted_handler)
             except MiddlewareNotUsed as exc:
                 if settings.DEBUG:
                     if str(exc):
                         logger.debug('MiddlewareNotUsed(%r): %s', middleware_path, exc)
                     else:
                         logger.debug('MiddlewareNotUsed: %r', middleware_path)
                 continue
+            else:
+                handler = adapted_handler
 
             if mw_instance is None:
                 raise ImproperlyConfigured(
diff --git a/docs/releases/3.1.5.txt b/docs/releases/3.1.5.txt
@@ -12,3 +12,7 @@ Bugfixes
 * Fixed ``__isnull=True`` lookup on key transforms for
   :class:`~django.db.models.JSONField` with Oracle and SQLite
   (:ticket:`32252`).
+
+* Fixed a bug in Django 3.1 that caused a crash when processing middlewares in
+  an async context with a middleware that raises a ``MiddlewareNotUsed``
+  exception (:ticket:`32299`).
diff --git a/tests/middleware_exceptions/tests.py b/tests/middleware_exceptions/tests.py
@@ -181,6 +181,25 @@ def test_do_not_log_when_debug_is_false(self):
             with self.assertLogs('django.request', 'DEBUG'):
                 self.client.get('/middleware_exceptions/view/')
 
+    @override_settings(MIDDLEWARE=[
+        'middleware_exceptions.middleware.SyncAndAsyncMiddleware',
+        'middleware_exceptions.tests.MyMiddleware',
+    ])
+    async def test_async_and_sync_middleware_chain_async_call(self):
+        with self.assertLogs('django.request', 'DEBUG') as cm:
+            response = await self.async_client.get('/middleware_exceptions/view/')
+        self.assertEqual(response.content, b'OK')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(
+            cm.records[0].getMessage(),
+            'Asynchronous middleware middleware_exceptions.tests.MyMiddleware '
+            'adapted.',
+        )
+        self.assertEqual(
+            cm.records[1].getMessage(),
+            "MiddlewareNotUsed: 'middleware_exceptions.tests.MyMiddleware'",
+        )
+
 
 @override_settings(
     DEBUG=True,
