refactor: add TRACK_DDT_MODELS to override tracking DDT models

Author: theShinigami

debug_toolbar/panels/sql/tracking.py

@@ -8,6 +8,7 @@
 from django.apps import apps
 from django.utils.encoding import force_str
 
+from debug_toolbar import settings as dt_settings
 from debug_toolbar.utils import get_stack_trace, get_template_info
 
 try:
@@ -40,6 +41,11 @@
 }
 
 
+DDT_MODELS = {
+    m._meta.db_table for m in apps.get_app_config("debug_toolbar").get_models()
+}
+
+
 class SQLQueryTriggered(Exception):
     """Thrown when template panel triggers a query"""
 
@@ -236,8 +242,9 @@ def _record(self, method, sql, params):
                     }
                 )
 
-            # Skip recording if query includes DDT models.
-            if allow_ddt_models_tracking.get() or not any(
+            # Skip tracking for DDT models by default.
+            # This can be overridden by setting TRACK_DDT_MODELS = True
+            if dt_settings.get_config()["TRACK_DDT_MODELS"] or not any(
                 table in sql for table in DDT_MODELS
             ):
                 # We keep `sql` to maintain backwards compatibility

tests/panels/test_sql.py

@@ -119,12 +119,10 @@ async def test_recording_concurrent_async(self):
         # ensure the stacktrace is populated
         self.assertTrue(len(query["stacktrace"]) > 0)
 
+    @override_settings(DEBUG_TOOLBAR_CONFIG={"TRACK_DDT_MODELS": True})
     def test_ddt_models_tracking(self):
         self.assertEqual(len(self.panel._queries), 0)
 
-        # enable ddt tracking
-        sql_tracking.allow_ddt_models_tracking.set(True)
-
         sql_call_ddt()
 
         # ensure query was logged
@@ -136,14 +134,12 @@ def test_ddt_models_tracking(self):
         self.assertTrue("stacktrace" in query)
 
         # ensure the stacktrace is populated
-        self.assertTrue(len(self.panel._queries), 0)
+        self.assertTrue(len(query["stacktrace"]) > 0)
 
+    @override_settings(DEBUG_TOOLBAR_CONFIG={"TRACK_DDT_MODELS": True})
     async def test_ddt_models_tracking_async(self):
         self.assertEqual(len(self.panel._queries), 0)
 
-        # enable ddt tracking
-        sql_tracking.allow_ddt_models_tracking.set(True)
-
         await async_sql_call_ddt()
 
         # ensure query was logged
@@ -155,24 +151,18 @@ async def test_ddt_models_tracking_async(self):
         self.assertTrue("stacktrace" in query)
 
         # ensure the stacktrace is populated
-        self.assertTrue(len(self.panel._queries), 0)
+        self.assertTrue(len(query["stacktrace"]) > 0)
 
     def test_ddt_models_untracking(self):
         self.assertEqual(len(self.panel._queries), 0)
 
-        # disable ddt tracking
-        sql_tracking.allow_ddt_models_tracking.set(False)
-
         sql_call_ddt()
 
         self.assertEqual(len(self.panel._queries), 0)
 
     async def test_ddt_models_untracking_async(self):
         self.assertEqual(len(self.panel._queries), 0)
 
-        # enable ddt tracking
-        sql_tracking.allow_ddt_models_tracking.set(False)
-
         await async_sql_call_ddt()
 
         self.assertEqual(len(self.panel._queries), 0)