Deprecate RedirectsPanel and update tests for deprecation warning

Author: JohananOppongAmoateng

debug_toolbar/panels/redirects.py

@@ -1,3 +1,4 @@
+import warnings
 from inspect import iscoroutine
 
 from django.template.response import SimpleTemplateResponse
@@ -17,6 +18,17 @@ class RedirectsPanel(Panel):
 
     nav_title = _("Intercept redirects")
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        warnings.warn(
+            "The RedirectsPanel is deprecated and will be removed in a future version. "
+            "The HistoryPanel now provides the ability to view toolbar data for redirected requests. "
+            "If you still have a use case for this panel, please comment on "
+            "https://github.com/django-commons/django-debug-toolbar/issues/2216",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+
     def _process_response(self, response):
         """
         Common response processing logic.

docs/changes.rst

@@ -15,6 +15,8 @@ Pending
 * Added ``CommunityPanel`` containing links to documentation and resources.
 * Added how to generate the documentation locally to the contributing
   documentation.
+* Deprecated ``RedirectsPanel`` in favor of ``HistoryPanel`` for viewing
+  toolbar data from redirected requests.
 
 6.0.0 (2025-07-22)
 ------------------

docs/panels.rst

@@ -120,6 +120,13 @@ Redirects
 
 .. class:: debug_toolbar.panels.redirects.RedirectsPanel
 
+.. deprecated:: 6.0
+
+The RedirectsPanel is deprecated and will be removed in a future version.
+The HistoryPanel now provides the ability to view toolbar data for redirected
+requests. If you have a use case for this panel, please comment on the
+GitHub issue <https://github.com/django-commons/django-debug-toolbar/issues/2216>`_.
+
 When this panel is enabled, the debug toolbar will show an intermediate page
 upon redirect so you can view any debug information prior to redirecting. This
 page will provide a link to the redirect destination you can follow when

tests/panels/test_redirects.py

@@ -1,4 +1,5 @@
 import copy
+import warnings
 
 from django.conf import settings
 from django.http import HttpResponse
@@ -12,6 +13,12 @@
 class RedirectsPanelTestCase(BaseTestCase):
     panel_id = RedirectsPanel.panel_id
 
+    def setUp(self):
+        # Suppress the deprecation warning during setup
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore", DeprecationWarning)
+            super().setUp()
+
     def test_regular_response(self):
         not_redirect = HttpResponse()
         self._get_response = lambda request: not_redirect
@@ -100,3 +107,14 @@ def test_original_response_preserved(self):
         self.assertEqual(
             response.original_response.get("Location"), "http://somewhere/else/"
         )
+
+    def test_deprecation_warning(self):
+        """Test that a deprecation warning is shown when RedirectsPanel is instantiated."""
+        from debug_toolbar.toolbar import DebugToolbar
+
+        with self.assertWarns(DeprecationWarning) as cm:
+            toolbar = DebugToolbar(self.request, self._get_response)
+            toolbar.get_panel_by_id(RedirectsPanel.panel_id)
+
+        self.assertIn("RedirectsPanel is deprecated", str(cm.warning))
+        self.assertIn("HistoryPanel", str(cm.warning))