Handle non-JSON keys in toolbar storage

Includes, cache panel regression test for skipped JSON keys.

Author: puneetdixit200

debug_toolbar/store.py

@@ -27,7 +27,7 @@ def serialize(data: Any) -> str:
     # If this starts throwing an exceptions, consider
     # Subclassing DjangoJSONEncoder and using force_str to
     # make it JSON serializable.
-    return json.dumps(data, cls=DebugToolbarJSONEncoder)
+    return json.dumps(data, cls=DebugToolbarJSONEncoder, skipkeys=True)
 
 
 def deserialize(data: str) -> Any:

docs/changes.rst

@@ -5,6 +5,8 @@ Pending
 -------
 
 * Prevent check from failing when ``ROOT_URLCONF`` is not defined.
+* Prevent toolbar storage from failing when serialized panel data contains
+  mapping keys that are not JSON-compatible.
 * Prevent debounce race conditions in the history panel for rapid
   fetch requests.
 * Added a note to the prerequisites section of the installation docs

tests/test_integration.py

@@ -2,12 +2,14 @@
 import re
 import time
 import unittest
+import warnings
 from unittest.mock import patch
 
 import html5lib
 from django.contrib.staticfiles.testing import StaticLiveServerTestCase
 from django.core import signing
 from django.core.cache import cache
+from django.core.cache.backends.base import CacheKeyWarning
 from django.db import connection
 from django.http import HttpResponse
 from django.template.loader import get_template
@@ -209,6 +211,23 @@ def test_low_level_cache_view(self):
             len(response.toolbar.get_panel_by_id(CachePanel.panel_id).calls), 1
         )
 
+    def test_cache_panel_store_skips_non_json_keys(self):
+        cache.clear()
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore", CacheKeyWarning)
+            response = self.client.get("/cache_with_non_json_key/")
+
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(
+            len(response.toolbar.get_panel_by_id(CachePanel.panel_id).calls), 1
+        )
+
+        request_id = list(get_store().request_ids())[-1]
+        toolbar = DebugToolbar.fetch(request_id, CachePanel.panel_id)
+        stats = toolbar.get_panel_by_id(CachePanel.panel_id).get_stats()
+        self.assertEqual(stats["calls"][0]["name"], "set_many")
+        self.assertEqual(stats["calls"][0]["args"], [{"foo": "bar"}])
+
     def test_cache_disable_instrumentation(self):
         """
         Verify that middleware cache usages before and after

tests/test_store.py

@@ -24,6 +24,12 @@ def test_serialize_logs_on_failure(self):
             '{"hello": {"foo": "bar"}}',
         )
 
+    def test_serialize_unexpected(self):
+        self.assertEqual(
+            store.serialize({"hello": {str: "this-is-a-string", "foo": "bar"}}),
+            '{"hello": {"foo": "bar"}}',
+        )
+
     def test_deserialize(self):
         self.assertEqual(
             store.deserialize('{"hello": {"foo": "bar"}}'),

tests/urls.py

@@ -25,6 +25,7 @@
     path("async_execute_sql_concurrently/", views.async_execute_sql_concurrently),
     path("cached_view/", views.cached_view),
     path("cached_low_level_view/", views.cached_low_level_view),
+    path("cache_with_non_json_key/", views.cache_with_non_json_key_view),
     path("json_view/", views.json_view),
     path("redirect/", views.redirect_view),
     path("ajax/", views.ajax_view),

tests/views.py

@@ -106,6 +106,11 @@ def cached_low_level_view(request):
     return render(request, "base.html")
 
 
+def cache_with_non_json_key_view(request):
+    cache.set_many({str: "this-is-a-string", "foo": "bar"})
+    return render(request, "base.html")
+
+
 def json_view(request):
     return JsonResponse({"foo": "bar"})