Merge remote-tracking branch 'origin/serializable'

* origin/serializable: (25 commits)
  Removed unnecessary SQLPanel.record_stats
  Updated replaceToolbarState to use request id.
  Move serializable changes into the main change log.
  Fixes #2073 -- Added DatabaseStore for persistent debug data storage. (#2121)
  Added check for pytest as test runner for IS_RUNNING_TESTS.
  Improve clarity of record_stats for serialization. (#1965)
  Hack: Sleep before checking to see if the history panel auto updated.
  Comment out the async button because it breaks the wsgi app.
  Fix tests for serializable changes with selenium.
  Avoid caching the config settings.
  Make template panel serializable.
  Rework the alerts panel to be compatible with serialization.
  Extend example app to have an async version.
  Update all panels to use data from get_stats on render
  Support serialization of FunctionCall
  Force everything to a string if it can't be serialized.
  Make Panel.panel_id a classmember.
  Support serializable sql panel
  Support serializable panels. This is a WIP and needs clean-up.
  Rename store_id variants to request_id
  ...

Author: matthiask

.gitignore

@@ -12,6 +12,7 @@ htmlcov
 .tox
 geckodriver.log
 coverage.xml
+venv
 .direnv/
 .envrc
 venv

Makefile

@@ -7,6 +7,12 @@ example:  ## Run the example application
 		--noinput --username="$(USER)" --email="$(USER)@mailinator.com"
 	python example/manage.py runserver
 
+example_async:
+	python example/manage.py migrate --noinput
+	-DJANGO_SUPERUSER_PASSWORD=p python example/manage.py createsuperuser \
+		--noinput --username="$(USER)" --email="$(USER)@mailinator.com"
+	daphne example.asgi:application
+
 example_test:  ## Run the test suite for the example application
 	python example/manage.py test example
 

debug_toolbar/migrations/0001_initial.py

@@ -0,0 +1,24 @@
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    operations = [
+        migrations.CreateModel(
+            name="HistoryEntry",
+            fields=[
+                (
+                    "request_id",
+                    models.UUIDField(primary_key=True, serialize=False),
+                ),
+                ("data", models.JSONField(default=dict)),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+            ],
+            options={
+                "verbose_name": "history entry",
+                "verbose_name_plural": "history entries",
+                "ordering": ["-created_at"],
+            },
+        ),
+    ]

debug_toolbar/migrations/__init__.py

@@ -0,0 +1,16 @@
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+
+class HistoryEntry(models.Model):
+    request_id = models.UUIDField(primary_key=True)
+    data = models.JSONField(default=dict)
+    created_at = models.DateTimeField(auto_now_add=True)
+
+    class Meta:
+        verbose_name = _("history entry")
+        verbose_name_plural = _("history entries")
+        ordering = ["-created_at"]
+
+    def __str__(self):
+        return str(self.request_id)

debug_toolbar/models.py

@@ -1,5 +1,6 @@
 from django.core.handlers.asgi import ASGIRequest
 from django.template.loader import render_to_string
+from django.utils.functional import classproperty
 
 from debug_toolbar import settings as dt_settings
 from debug_toolbar.utils import get_name_from_obj
@@ -15,19 +16,27 @@ class Panel:
     def __init__(self, toolbar, get_response):
         self.toolbar = toolbar
         self.get_response = get_response
+        self.from_store = False
 
     # Private panel properties
 
-    @property
-    def panel_id(self):
-        return self.__class__.__name__
+    @classproperty
+    def panel_id(cls):
+        return cls.__name__
 
     @property
     def enabled(self) -> bool:
-        # check if the panel is async compatible
+        # Check if the panel is async compatible
         if not self.is_async and isinstance(self.toolbar.request, ASGIRequest):
             return False
 
+        if self.from_store:
+            # If the toolbar was loaded from the store the existence of
+            # recorded data indicates whether it was enabled or not.
+            # We can't use the remainder of the logic since we don't have
+            # a request to work off of.
+            return bool(self.get_stats())
+
         # The user's cookies should override the default value
         cookie_value = self.toolbar.request.COOKIES.get("djdt" + self.panel_id)
         if cookie_value is not None:
@@ -175,9 +184,16 @@ def record_stats(self, stats):
         """
         Store data gathered by the panel. ``stats`` is a :class:`dict`.
 
-        Each call to ``record_stats`` updates the statistics dictionary.
+        Each call to ``record_stats`` updates the store's data for
+        the panel.
+
+        To support backwards compatibility, it will also update the
+        panel's statistics dictionary.
         """
         self.toolbar.stats.setdefault(self.panel_id, {}).update(stats)
+        self.toolbar.store.save_panel(
+            self.toolbar.request_id, self.panel_id, self.toolbar.stats[self.panel_id]
+        )
 
     def get_stats(self):
         """
@@ -261,6 +277,15 @@ def generate_server_timing(self, request, response):
         Does not return a value.
         """
 
+    def load_stats_from_store(self, data):
+        """
+        Instantiate the panel from serialized data.
+
+        Return the panel instance.
+        """
+        self.toolbar.stats.setdefault(self.panel_id, {}).update(data)
+        self.from_store = True
+
     @classmethod
     def run_checks(cls):
         """

debug_toolbar/panels/__init__.py

@@ -141,11 +141,9 @@ def check_invalid_file_form_configuration(self, html_content):
         return self.alerts
 
     def generate_stats(self, request, response):
-        if not is_processable_html_response(response):
-            return
-
-        html_content = response.content.decode(response.charset)
-        self.check_invalid_file_form_configuration(html_content)
+        if is_processable_html_response(response):
+            html_content = response.content.decode(response.charset)
+            self.check_invalid_file_form_configuration(html_content)
 
         # Further alert checks can go here
 

debug_toolbar/panels/alerts.py

@@ -171,16 +171,17 @@ def _record_call(self, cache, name, original_method, args, kwargs):
 
     @property
     def nav_subtitle(self):
-        cache_calls = len(self.calls)
+        stats = self.get_stats()
+        cache_calls = len(stats.get("calls"))
         return ngettext(
             "%(cache_calls)d call in %(time).2fms",
             "%(cache_calls)d calls in %(time).2fms",
             cache_calls,
-        ) % {"cache_calls": cache_calls, "time": self.total_time}
+        ) % {"cache_calls": cache_calls, "time": stats.get("total_time")}
 
     @property
     def title(self):
-        count = len(getattr(settings, "CACHES", ["default"]))
+        count = self.get_stats().get("total_caches")
         return ngettext(
             "Cache calls from %(count)d backend",
             "Cache calls from %(count)d backends",
@@ -216,6 +217,7 @@ def generate_stats(self, request, response):
                 "hits": self.hits,
                 "misses": self.misses,
                 "counts": self.counts,
+                "total_caches": len(getattr(settings, "CACHES", ["default"])),
             }
         )
 

debug_toolbar/panels/cache.py

@@ -1,3 +1,3 @@
 from debug_toolbar.panels.history.panel import HistoryPanel
 
-__all__ = ["HistoryPanel"]
+__all__ = [HistoryPanel.panel_id]

debug_toolbar/panels/history/__init__.py

@@ -5,8 +5,8 @@ class HistoryStoreForm(forms.Form):
     """
     Validate params
 
-        store_id: The key for the store instance to be fetched.
+        request_id: The key for the store instance to be fetched.
     """
 
-    store_id = forms.CharField(widget=forms.HiddenInput())
+    request_id = forms.CharField(widget=forms.HiddenInput())
     exclude_history = forms.BooleanField(widget=forms.HiddenInput(), required=False)