Show template context on included templates

Author: gilmrjc

debug_toolbar/utils.py

@@ -135,7 +135,10 @@ def get_template_context(node, context, context_lines=3):
 
 
 def get_template_source_from_exception_info(node, context):
-    exception_info = context.template.get_exception_info(Exception("DDT"), node.token)
+    if context.template.origin == node.origin:
+        exception_info = context.template.get_exception_info(Exception("DDT"), node.token)
+    else:
+        exception_info = context.render_context.template.get_exception_info(Exception("DDT"), node.token)
     line = exception_info["line"]
     source_lines = exception_info["source_lines"]
     name = exception_info["name"]

tests/panels/test_sql.py

@@ -1,4 +1,5 @@
 import datetime
+import os
 import unittest
 
 import django
@@ -357,3 +358,47 @@ def test_regression_infinite_recursion(self):
 
         # ensure the stacktrace is populated
         self.assertTrue(len(query[1]["stacktrace"]) > 0)
+
+    @override_settings(
+        DEBUG=True,
+    )
+    def test_flat_template_information(self):
+        """
+        Test case for when the query is used in a flat template hierarchy
+        (without included templates).
+        """
+        self.assertEqual(len(self.panel._queries), 0)
+
+        users = User.objects.all()
+        render(self.request, "sql/flat.html", {"users": users})
+
+        self.assertEqual(len(self.panel._queries), 1)
+
+        query = self.panel._queries[0]
+        template_info = query[1]["template_info"]
+        template_name = os.path.basename(template_info["name"])
+        self.assertEqual(template_name, "flat.html")
+        self.assertEqual(template_info["context"][2]["content"].strip(), "{{ users }}")
+        self.assertEqual(template_info["context"][2]["highlight"], True)
+
+    @override_settings(
+        DEBUG=True,
+    )
+    def test_nested_template_information(self):
+        """
+        Test case for when the query is used in a nested template
+        hierarchy (with included templates).
+        """
+        self.assertEqual(len(self.panel._queries), 0)
+
+        users = User.objects.all()
+        render(self.request, "sql/nested.html", {"users": users})
+
+        self.assertEqual(len(self.panel._queries), 1)
+
+        query = self.panel._queries[0]
+        template_info = query[1]["template_info"]
+        template_name = os.path.basename(template_info["name"])
+        self.assertEqual(template_name, "included.html")
+        self.assertEqual(template_info["context"][0]["content"].strip(), "{{ users }}")
+        self.assertEqual(template_info["context"][0]["highlight"], True)

tests/templates/sql/flat.html

@@ -0,0 +1,4 @@
+{% extends "base.html" %}
+{% block content %}
+  {{ users }}
+{% endblock %}

tests/templates/sql/included.html

@@ -0,0 +1 @@
+{{ users }}

tests/templates/sql/nested.html

@@ -0,0 +1,4 @@
+{% extends "base.html" %}
+{% block content %}
+  {% include "sql/included.html" %}
+{% endblock %}