fix(django): Deal with template_name being a list (#1054)

Co-authored-by: Christophe Narbonne <christophe31@intra.logikap.com>
Co-authored-by: sentry-bot <markus+ghbot@sentry.io>

Author: 3 people

sentry_sdk/integrations/django/templates.py

@@ -42,6 +42,15 @@ def get_template_frame_from_exception(exc_value):
     return None
 
 
+def _get_template_name_description(template_name):
+    # type: (str) -> str
+    if isinstance(template_name, (list, tuple)):
+        if template_name:
+            return "[{}, ...]".format(template_name[0])
+    else:
+        return template_name
+
+
 def patch_templates():
     # type: () -> None
     from django.template.response import SimpleTemplateResponse
@@ -57,7 +66,8 @@ def rendered_content(self):
             return real_rendered_content.fget(self)
 
         with hub.start_span(
-            op="django.template.render", description=self.template_name
+            op="django.template.render",
+            description=_get_template_name_description(self.template_name),
         ) as span:
             span.set_data("context", self.context_data)
             return real_rendered_content.fget(self)
@@ -78,7 +88,8 @@ def render(request, template_name, context=None, *args, **kwargs):
             return real_render(request, template_name, context, *args, **kwargs)
 
         with hub.start_span(
-            op="django.template.render", description=template_name
+            op="django.template.render",
+            description=_get_template_name_description(template_name),
         ) as span:
             span.set_data("context", context)
             return real_render(request, template_name, context, *args, **kwargs)

tests/integrations/django/myapp/views.py

@@ -122,7 +122,9 @@ def template_test(request, *args, **kwargs):
 
 @csrf_exempt
 def template_test2(request, *args, **kwargs):
-    return TemplateResponse(request, "user_name.html", {"user_age": 25})
+    return TemplateResponse(
+        request, ("user_name.html", "another_template.html"), {"user_age": 25}
+    )
 
 
 @csrf_exempt

tests/integrations/django/test_basic.py

@@ -563,18 +563,25 @@ def test_render_spans(sentry_init, client, capture_events, render_span_tree):
         integrations=[DjangoIntegration()],
         traces_sample_rate=1.0,
     )
-    views_urls = [reverse("template_test2")]
+    views_tests = [
+        (
+            reverse("template_test2"),
+            '- op="django.template.render": description="[user_name.html, ...]"',
+        ),
+    ]
     if DJANGO_VERSION >= (1, 7):
-        views_urls.append(reverse("template_test"))
+        views_tests.append(
+            (
+                reverse("template_test"),
+                '- op="django.template.render": description="user_name.html"',
+            ),
+        )
 
-    for url in views_urls:
+    for url, expected_line in views_tests:
         events = capture_events()
         _content, status, _headers = client.get(url)
         transaction = events[0]
-        assert (
-            '- op="django.template.render": description="user_name.html"'
-            in render_span_tree(transaction)
-        )
+        assert expected_line in render_span_tree(transaction)
 
 
 def test_middleware_spans(sentry_init, client, capture_events, render_span_tree):