Merge branch 'main' into serialize-panels

.gitignore

@@ -13,3 +13,5 @@ htmlcov
 geckodriver.log
 coverage.xml
 venv
+.direnv/
+.envrc

Makefile

@@ -12,6 +12,8 @@ example_async:
 		--noinput --username="$(USER)" --email="$(USER)@mailinator.com"
 	daphne example.asgi:application
 
+example_test:
+	python example/manage.py test example
 
 test:
 	DJANGO_SETTINGS_MODULE=tests.settings \

debug_toolbar/panels/templates/panel.py

@@ -112,7 +112,7 @@ def title(self):
     def nav_subtitle(self):
         templates = self.get_stats()["templates"]
         if templates:
-            return templates[0]["name"]
+            return self.templates[0]["template"].name
         return ""
 
     template = "debug_toolbar/panels/templates.html"
@@ -187,6 +187,7 @@ def process_context_list(self, context_layers):
     def generate_stats(self, request, response):
         template_context = []
         for template_data in self.templates:
+            info = {}
             # Clean up some info about templates
             template = template_data["template"]
             if hasattr(template, "origin") and template.origin and template.origin.name:
@@ -195,15 +196,15 @@ def generate_stats(self, request, response):
             else:
                 template.origin_name = _("No origin")
                 template.origin_hash = ""
-            context = {
-                "template": force_str(template),
-                "name": template.name,
-            }
+            info["template"] = template
             # Clean up context for better readability
             if self.toolbar.config["SHOW_TEMPLATE_CONTEXT"]:
-                context_list = template_data.get("context", [])
-                context["context"] = "\n".join(context_list)
-            template_context.append(context)
+                if "context_list" not in template_data:
+                    template_data["context_list"] = self.process_context_list(
+                        template_data.get("context", [])
+                    )
+                info["context"] = "\n".join(template_data["context_list"])
+            template_context.append(info)
 
         # Fetch context_processors/template_dirs from any template
         if self.templates:

debug_toolbar/settings.py

@@ -44,6 +44,9 @@
     "OBSERVE_REQUEST_CALLBACK": "debug_toolbar.toolbar.observe_request",
     "TOOLBAR_LANGUAGE": None,
     "TOOLBAR_STORE_CLASS": "debug_toolbar.store.MemoryStore",
+    "IS_RUNNING_TESTS": "test" in sys.argv,
+    "UPDATE_ON_FETCH": False,
+    "DEFAULT_THEME": "auto",
 }
 
 

debug_toolbar/static/debug_toolbar/js/toolbar.js

@@ -299,7 +299,9 @@ const djdt = {
             requestId = encodeURIComponent(requestId);
             const dest = `${sidebarUrl}?request_id=${requestId}`;
             slowjax(dest).then(function (data) {
-                replaceToolbarState(requestId, data);
+                if (djdt.needUpdateOnFetch) {
+                    replaceToolbarState(requestId, data);
+                }
             });
         }
 

debug_toolbar/templates/debug_toolbar/panels/history_tr.html

@@ -43,7 +43,7 @@
     </td>
     <td class="djdt-actions">
         <form method="get" action="{% url 'djdt:history_sidebar' %}">
-            {{ history_context.form }}
+            {{ history_context.form.as_div }}
             <button data-request-id="{{ request_id }}" class="switchHistory">Switch</button>
         </form>
     </td>

debug_toolbar/toolbar.py

@@ -1,7 +1,9 @@
 """
 The main DebugToolbar class that loads and renders the Toolbar.
 """
+
 import logging
+import re
 import uuid
 from functools import lru_cache
 
@@ -177,7 +179,7 @@ def observe_request(request):
     """
     Determine whether to update the toolbar from a client side request.
     """
-    return not DebugToolbar.is_toolbar_request(request)
+    return True
 
 
 def from_store_get_response(request):
@@ -213,3 +215,27 @@ def from_store(cls, request_id, panel_id=None):
                 panel.load_stats_from_store(data)
                 toolbar._panels[panel.panel_id] = panel
         return toolbar
+
+
+def debug_toolbar_urls(prefix="__debug__"):
+    """
+    Return a URL pattern for serving toolbar in debug mode.
+
+    from django.conf import settings
+    from debug_toolbar.toolbar import debug_toolbar_urls
+
+    urlpatterns = [
+        # ... the rest of your URLconf goes here ...
+    ] + debug_toolbar_urls()
+    """
+    if not prefix:
+        raise ImproperlyConfigured("Empty urls prefix not permitted")
+    elif not settings.DEBUG:
+        # No-op if not in debug mode.
+        return []
+    return [
+        re_path(
+            r"^%s/" % re.escape(prefix.lstrip("/")),
+            include("debug_toolbar.urls"),
+        ),
+    ]

tests/panels/test_staticfiles.py

@@ -47,33 +47,3 @@ def test_insert_content(self):
             "django.contrib.staticfiles.finders.AppDirectoriesFinder", content
         )
         self.assertValidHTML(content)
-
-    @unittest.skipIf(django.VERSION >= (4,), "Django>=4 handles missing dirs itself.")
-    @override_settings(
-        STATICFILES_DIRS=[PATH_DOES_NOT_EXIST] + settings.STATICFILES_DIRS,
-        STATIC_ROOT=PATH_DOES_NOT_EXIST,
-    )
-    def test_finder_directory_does_not_exist(self):
-        """Misconfigure the static files settings and verify the toolbar runs.
-
-        The test case is that the STATIC_ROOT is in STATICFILES_DIRS and that
-        the directory of STATIC_ROOT does not exist.
-        """
-        response = self.panel.process_request(self.request)
-        self.panel.generate_stats(self.request, response)
-        content = self.panel.content
-        self.assertIn(
-            "django.contrib.staticfiles.finders.AppDirectoriesFinder", content
-        )
-        self.assertNotIn(
-            "django.contrib.staticfiles.finders.FileSystemFinder (2 files)", content
-        )
-        self.assertEqual(self.panel.get_stats()["num_used"], 0)
-        self.assertNotEqual(self.panel.get_stats()["num_found"], 0)
-        expected_apps = ["django.contrib.admin", "debug_toolbar"]
-        if settings.USE_GIS:
-            expected_apps = ["django.contrib.gis"] + expected_apps
-        self.assertEqual(self.panel.get_staticfiles_apps(), expected_apps)
-        self.assertEqual(
-            self.panel.get_staticfiles_dirs(), finders.FileSystemFinder().locations
-        )

tests/settings.py

@@ -128,4 +128,6 @@
     # Django's test client sets wsgi.multiprocess to True inappropriately
     "RENDER_PANELS": False,
     "RESULTS_CACHE_SIZE": 3,
+    # IS_RUNNING_TESTS must be False even though we're running tests because we're running the toolbar's own tests.
+    "IS_RUNNING_TESTS": False,
 }

tests/test_integration.py

@@ -645,9 +645,10 @@ def test_basic_jinja(self):
         # Click to show the template panel
         self.selenium.find_element(By.CLASS_NAME, TemplatesPanel.panel_id).click()
 
-        self.assertIn("Templates (2 rendered)", template_panel.text)
+        # This should be 2 templates rendered, including base.html See
+        # JinjaTemplateTestCase.test_django_jinja2_parent_template_instrumented
+        self.assertIn("Templates (1 rendered)", template_panel.text)
         self.assertIn("base.html", template_panel.text)
-        self.assertIn("jinja2/basic.jinja", template_panel.text)
 
     @override_settings(
         DEBUG_TOOLBAR_CONFIG={