Work in preperation of an autorefresh

adding view that will return the toolbar for a given store id
Adding header containing toolbar url
Refactoring history javascript to allow switching state by store id

Author: gone

debug_toolbar/panels/history/panel.py

@@ -4,7 +4,7 @@
 from django.http.request import RawPostDataException
 from django.template.loader import render_to_string
 from django.templatetags.static import static
-from django.urls import path
+from django.urls import path, reverse
 from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
 
@@ -21,6 +21,15 @@ class HistoryPanel(Panel):
     nav_title = _("History")
     template = "debug_toolbar/panels/history.html"
 
+    def process_request(self, request):
+        response = super().process_request(request)
+        if not self.toolbar.should_render_panels():
+            self.toolbar.store()
+            response["DJ-TOOLBAR-URL"] = (
+                reverse("djdt:render_base") + f"?store_id={self.toolbar.store_id}"
+            )
+        return response
+
     @property
     def enabled(self):
         # Do not show the history panel if the panels are rendered on request

debug_toolbar/static/debug_toolbar/js/history.js

@@ -10,6 +10,26 @@ function difference(setA, setB) {
     return _difference;
 }
 
+function replaceToolbarState(newStoreId, data) {
+    djDebug.setAttribute("data-store-id", newStoreId);
+    // Check if response is empty, it could be due to an expired store_id.
+    if (Object.keys(data).length === 0) {
+        const container = document.getElementById("djdtHistoryRequests");
+        container.querySelector(
+            'button[data-store-id="' + newStoreId + '"]'
+        ).innerHTML = "Switch [EXPIRED]";
+    } else {
+        Object.keys(data).forEach(function (panelId) {
+            const panel = document.getElementById(panelId);
+            if (panel) {
+                panel.outerHTML = data[panelId].content;
+                document.getElementById("djdt-" + panelId).outerHTML =
+                    data[panelId].button;
+            }
+        });
+    }
+}
+
 function switchHistory(newStoreId) {
     const formTarget = djDebug.querySelector(
         ".switchHistory[data-store-id='" + newStoreId + "']"
@@ -23,23 +43,7 @@ function switchHistory(newStoreId) {
     formTarget.closest("tr").classList.add("djdt-highlighted");
 
     ajaxForm(formTarget).then(function (data) {
-        djDebug.setAttribute("data-store-id", newStoreId);
-        // Check if response is empty, it could be due to an expired store_id.
-        if (Object.keys(data).length === 0) {
-            const container = document.getElementById("djdtHistoryRequests");
-            container.querySelector(
-                'button[data-store-id="' + newStoreId + '"]'
-            ).innerHTML = "Switch [EXPIRED]";
-        } else {
-            Object.keys(data).forEach(function (panelId) {
-                const panel = document.getElementById(panelId);
-                if (panel) {
-                    panel.outerHTML = data[panelId].content;
-                    document.getElementById("djdt-" + panelId).outerHTML =
-                        data[panelId].button;
-                }
-            });
-        }
+        replaceToolbarState(newStoreId, data);
     });
 }
 

debug_toolbar/toolbar.py

@@ -132,7 +132,8 @@ def get_urls(cls):
             # Load URLs in a temporary variable for thread safety.
             # Global URLs
             urlpatterns = [
-                path("render_panel/", views.render_panel, name="render_panel")
+                path("render_panel/", views.render_panel, name="render_panel"),
+                path("render_base/", views.render_base, name="render_base"),
             ]
             # Per-panel URLs
             for panel_class in cls.get_panel_classes():

debug_toolbar/views.py

@@ -1,4 +1,4 @@
-from django.http import JsonResponse
+from django.http import HttpResponse, JsonResponse
 from django.utils.html import escape
 from django.utils.translation import gettext as _
 
@@ -22,3 +22,17 @@ def render_panel(request):
         content = panel.content
         scripts = panel.scripts
     return JsonResponse({"content": content, "scripts": scripts})
+
+
+@require_show_toolbar
+def render_base(request):
+    """Render the contents of a panel"""
+    toolbar = DebugToolbar.fetch(request.GET["store_id"])
+    if toolbar is None:
+        content = _(
+            "Data for this toolbar isn't available anymore. "
+            "Please reload the page and retry."
+        )
+        content = "<p>%s</p>" % escape(content)
+    content = toolbar.render_toolbar()
+    return HttpResponse(content)