Support stats only version of toolbar.

Removes storing the entire toolbar in the Store.

Author: tim-schilling

debug_toolbar/panels/__init__.py

@@ -38,7 +38,13 @@ def enabled(self):
         else:
             default = "on"
         # The user's cookies should override the default value
-        return self.toolbar.request.COOKIES.get("djdt" + self.panel_id, default) == "on"
+        if self.toolbar.request is not None:
+            return (
+                self.toolbar.request.COOKIES.get("djdt" + self.panel_id, default)
+                == "on"
+            )
+        else:
+            return bool(store.panel(self.toolbar.store_id, self.panel_id))
 
     # Titles and content
 
@@ -151,15 +157,17 @@ def disable_instrumentation(self):
 
     # Store and retrieve stats (shared between panels for no good reason)
 
-    def deserialize_stats(self, data):
+    @classmethod
+    def deserialize_stats(cls, data):
         """
         Deserialize stats coming from the store.
 
         Provided to support future store mechanisms overriding a panel's content.
         """
         return data
 
-    def serialize_stats(self, stats):
+    @classmethod
+    def serialize_stats(cls, stats):
         """
         Serialize stats for the store.
 

debug_toolbar/panels/history/panel.py

@@ -81,10 +81,10 @@ def content(self):
 
         Fetch every store for the toolbar and include it in the template.
         """
-        stores = OrderedDict()
-        for id, toolbar in reversed(store.all()):
-            stores[id] = {
-                "toolbar": toolbar,
+        histories = OrderedDict()
+        for id in reversed(store.ids()):
+            histories[id] = {
+                "stats": self.deserialize_stats(store.panel(id, self.panel_id)),
                 "form": SignedDataForm(
                     initial=HistoryStoreForm(initial={"store_id": id}).initial
                 ),
@@ -94,10 +94,10 @@ def content(self):
             self.template,
             {
                 "current_store_id": self.toolbar.store_id,
-                "stores": stores,
+                "histories": histories,
                 "refresh_form": SignedDataForm(
                     initial=HistoryStoreForm(
-                        initial={"store_id": self.toolbar.store_id}
+                        initial={"store_id": str(self.toolbar.store_id)}
                     ).initial
                 ),
             },

debug_toolbar/panels/history/views.py

@@ -5,6 +5,7 @@
 from debug_toolbar.forms import SignedDataForm
 from debug_toolbar.panels.history.forms import HistoryStoreForm
 from debug_toolbar.store import store
+from debug_toolbar.toolbar import stats_only_toolbar
 
 
 @require_show_toolbar
@@ -15,7 +16,8 @@ def history_sidebar(request, verified_data):
 
     if form.is_valid():
         store_id = form.cleaned_data["store_id"]
-        toolbar = store.get(store_id)
+        toolbar = stats_only_toolbar(store_id)
+
         context = {}
         if toolbar is None:
             # When the store_id has been popped already due to
@@ -25,6 +27,7 @@ def history_sidebar(request, verified_data):
             if not panel.is_historical:
                 continue
             panel_context = {"panel": panel}
+
             context[panel.panel_id] = {
                 "button": render_to_string(
                     "debug_toolbar/includes/panel_button.html", panel_context
@@ -45,16 +48,19 @@ def history_refresh(request, verified_data):
 
     if form.is_valid():
         requests = []
-        for id, toolbar in list(reversed(store.all())):
+        for id in reversed(store.ids()):
+            toolbar = stats_only_toolbar(id)
             requests.append(
                 {
                     "id": id,
                     "content": render_to_string(
                         "debug_toolbar/panels/history_tr.html",
                         {
                             "id": id,
-                            "store_context": {
-                                "toolbar": toolbar,
+                            "history": {
+                                "stats": toolbar.get_panel_by_id(
+                                    "HistoryPanel"
+                                ).get_stats(),
                                 "form": SignedDataForm(
                                     initial=HistoryStoreForm(
                                         initial={"store_id": id}

debug_toolbar/store.py

@@ -1,5 +1,5 @@
 import json
-from collections import OrderedDict, defaultdict
+from collections import defaultdict
 
 from django.core.serializers.json import DjangoJSONEncoder
 from django.utils.module_loading import import_string
@@ -31,47 +31,47 @@ class BaseStore:
     config = dt_settings.get_config().copy()
 
     @classmethod
-    def get(cls, store_id):
+    def ids(cls):
         raise NotImplementedError
 
     @classmethod
-    def all(cls):
+    def exists(cls, store_id):
         raise NotImplementedError
 
     @classmethod
-    def set(cls, store_id, toolbar):
+    def set(cls, store_id):
         raise NotImplementedError
 
     @classmethod
     def delete(cls, store_id):
         raise NotImplementedError
 
-    @classmethod
-    def record_stats(cls, store_id, panel_id, stats):
-        raise NotImplementedError
-
 
 class MemoryStore(BaseStore):
-    _store = OrderedDict()
+    _ids = list()
     _stats = defaultdict(dict)
 
     @classmethod
-    def get(cls, store_id):
-        return cls._store.get(store_id)
+    def ids(cls):
+        return cls._ids
 
     @classmethod
-    def all(cls):
-        return cls._store.items()
+    def exists(cls, store_id):
+        return store_id in cls._ids
 
     @classmethod
-    def set(cls, store_id, toolbar):
-        cls._store[store_id] = toolbar
-        for _ in range(cls.config["RESULTS_CACHE_SIZE"], len(cls._store)):
-            cls._store.popitem(last=False)
+    def set(cls, store_id):
+        if store_id not in cls._ids:
+            cls._ids.append(store_id)
+        if len(cls._ids) > cls.config["RESULTS_CACHE_SIZE"]:
+            cls.delete(cls._ids[0])
 
     @classmethod
     def delete(cls, store_id):
-        del cls._store[store_id]
+        if store_id in cls._stats:
+            del cls._stats[store_id]
+        if store_id in cls._ids:
+            cls._ids.remove(store_id)
 
     @classmethod
     def save_panel(cls, store_id, panel_id, stats=None):

debug_toolbar/templates/debug_toolbar/panels/history.html

@@ -15,7 +15,7 @@
         </tr>
     </thead>
     <tbody id="djdtHistoryRequests">
-        {% for id, store_context in stores.items %}
+        {% for id, history in histories.items %}
             {% include "debug_toolbar/panels/history_tr.html" %}
         {% endfor %}
     </tbody>

debug_toolbar/templates/debug_toolbar/panels/history_tr.html

@@ -1,13 +1,13 @@
 {% load i18n %}
 <tr class="{% if id == current_store_id %}djdt-highlighted{% endif %}" id="historyMain_{{ id }}" data-store-id="{{ id }}">
     <td>
-        {{ store_context.toolbar.stats.HistoryPanel.time|escape }}
+        {{ history.stats.time|escape }}
     </td>
     <td>
-        <p>{{ store_context.toolbar.stats.HistoryPanel.request_method|escape }}</p>
+        <p>{{ history.stats.request_method|escape }}</p>
     </td>
     <td>
-        <p>{{ store_context.toolbar.stats.HistoryPanel.request_url|truncatechars:100|escape }}</p>
+        <p>{{ history.stats.request_url|truncatechars:100|escape }}</p>
     </td>
     <td>
         <button type="button" class="djToggleSwitch" data-toggle-name="historyMain" data-toggle-id="{{ id }}">+</button>
@@ -24,7 +24,7 @@
               </tr>
             </thead>
             <tbody>
-              {% for key, value in store_context.toolbar.stats.HistoryPanel.data.items %}
+              {% for key, value in history.stats.data.items %}
                 <tr>
                   <td><code>{{ key|pprint }}</code></td>
                   <td><code>{{ value|pprint }}</code></td>
@@ -43,7 +43,7 @@
     </td>
     <td class="djdt-actions">
         <form method="get" action="{% url 'djdt:history_sidebar' %}">
-            {{ store_context.form }}
+            {{ history.form }}
             <button data-store-id="{{ id }}" class="switchHistory">Switch</button>
         </form>
     </td>

debug_toolbar/toolbar.py

@@ -18,7 +18,8 @@
 
 
 class DebugToolbar:
-    def __init__(self, request, get_response):
+    def __init__(self, request, get_response, store_id=None):
+        self.store_id = store_id or uuid.uuid4().hex
         self.request = request
         self.config = dt_settings.get_config().copy()
         panels = []
@@ -34,7 +35,6 @@ def __init__(self, request, get_response):
             self._panels[panel.panel_id] = panel
         self.stats = {}
         self.server_timing_stats = {}
-        self.store_id = uuid.uuid4().hex
 
     # Manage panels
 
@@ -64,8 +64,7 @@ def render_toolbar(self):
         """
         Renders the overall Toolbar with panels inside.
         """
-        if not self.should_render_panels():
-            self.store()
+        self.store()
         try:
             context = {"toolbar": self}
             return render_to_string("debug_toolbar/base.html", context)
@@ -90,7 +89,7 @@ def should_render_panels(self):
         return render_panels
 
     def store(self):
-        store.set(self.store_id, self)
+        store.set(self.store_id)
 
     # Manually implement class-level caching of panel classes and url patterns
     # because it's more obvious than going through an abstraction.
@@ -141,5 +140,9 @@ def is_toolbar_request(cls, request):
         return resolver_match.namespaces and resolver_match.namespaces[-1] == app_name
 
 
+def stats_only_toolbar(store_id):
+    return DebugToolbar(request=None, get_response=lambda r: r, store_id=store_id)
+
+
 app_name = "djdt"
 urlpatterns = DebugToolbar.get_urls()

debug_toolbar/views.py

@@ -4,20 +4,22 @@
 
 from debug_toolbar.decorators import require_show_toolbar
 from debug_toolbar.store import store
+from debug_toolbar.toolbar import stats_only_toolbar
 
 
 @require_show_toolbar
 def render_panel(request):
     """Render the contents of a panel"""
-    toolbar = store.get(request.GET["store_id"])
-    if toolbar is None:
+    store_id = request.GET["store_id"]
+    if not store.exists(store_id):
         content = _(
             "Data for this panel isn't available anymore. "
             "Please reload the page and retry."
         )
         content = "<p>%s</p>" % escape(content)
         scripts = []
     else:
+        toolbar = stats_only_toolbar(store_id)
         panel = toolbar.get_panel_by_id(request.GET["panel_id"])
         content = panel.content
         scripts = panel.scripts

tests/base.py

@@ -53,6 +53,6 @@ def setUp(self):
         # The HistoryPanel keeps track of previous stores in memory.
         # This bleeds into other tests and violates their idempotency.
         # Clear the store before each test.
-        for key, _ in list(store.all()):
+        for key in list(store.ids()):
             store.delete(key)
         super().setUp()

tests/panels/test_history.py

@@ -5,6 +5,7 @@
 
 from debug_toolbar.forms import SignedDataForm
 from debug_toolbar.store import store
+from debug_toolbar.toolbar import stats_only_toolbar
 
 from ..base import BaseTestCase, IntegrationTestCase
 
@@ -83,14 +84,14 @@ class HistoryViewsTestCase(IntegrationTestCase):
 
     def test_history_panel_integration_content(self):
         """Verify the history panel's content renders properly.."""
-        self.assertEqual(len(store.all()), 0)
+        self.assertEqual(len(store.ids()), 0)
 
         data = {"foo": "bar"}
         self.client.get("/json_view/", data, content_type="application/json")
 
         # Check the history panel's stats to verify the toolbar rendered properly.
-        self.assertEqual(len(store.all()), 1)
-        toolbar = list(store.all())[0][1]
+        self.assertEqual(len(store.ids()), 1)
+        toolbar = stats_only_toolbar(store.ids()[0])
         content = toolbar.get_panel_by_id("HistoryPanel").content
         self.assertIn("bar", content)
 
@@ -99,21 +100,34 @@ def test_history_sidebar_invalid(self):
         self.assertEqual(response.status_code, 400)
 
         self.client.get("/json_view/")
-        store_id = list(store.all())[0][0]
+        store_id = store.ids()[0]
         data = {"signed": SignedDataForm.sign({"store_id": store_id}) + "invalid"}
         response = self.client.get(reverse("djdt:history_sidebar"), data=data)
         self.assertEqual(response.status_code, 400)
 
     def test_history_sidebar_hash(self):
         """Validate the hashing mechanism."""
         self.client.get("/json_view/")
-        store_id = list(store.all())[0][0]
+        store_id = store.ids()[0]
         data = {"signed": SignedDataForm.sign({"store_id": store_id})}
         response = self.client.get(reverse("djdt:history_sidebar"), data=data)
         self.assertEqual(response.status_code, 200)
         self.assertEqual(
-            set(response.json()),
-            self.PANEL_KEYS,
+            list(response.json().keys()),
+            [
+                "VersionsPanel",
+                "TimerPanel",
+                "SettingsPanel",
+                "HeadersPanel",
+                "RequestPanel",
+                "SQLPanel",
+                "StaticFilesPanel",
+                "TemplatesPanel",
+                "CachePanel",
+                "SignalsPanel",
+                "LoggingPanel",
+                "ProfilingPanel",
+            ],
         )
 
     @override_settings(
@@ -122,7 +136,7 @@ def test_history_sidebar_hash(self):
     def test_history_sidebar_expired_store_id(self):
         """Validate the history sidebar view."""
         self.client.get("/json_view/")
-        store_id = list(store.all())[0][0]
+        store_id = list(store.ids())[0]
         data = {"signed": SignedDataForm.sign({"store_id": store_id})}
         response = self.client.get(reverse("djdt:history_sidebar"), data=data)
         self.assertEqual(response.status_code, 200)
@@ -142,7 +156,7 @@ def test_history_sidebar_expired_store_id(self):
         )
 
         # Querying with latest store_id
-        latest_store_id = list(store.all())[-1][0]
+        latest_store_id = store.ids()[-1]
         self.assertNotEqual(latest_store_id, store_id)
         data = {"signed": SignedDataForm.sign({"store_id": latest_store_id})}
         response = self.client.get(reverse("djdt:history_sidebar"), data=data)
@@ -170,7 +184,7 @@ def test_history_refresh(self):
         data = response.json()
         self.assertEqual(len(data["requests"]), 1)
 
-        store_id = list(store.all())[0][0]
+        store_id = store.ids()[0]
         signature = SignedDataForm.sign({"store_id": store_id})
         self.assertIn(html.escape(signature), data["requests"][0]["content"])