Skip script tags for root element. Only write window stub for parent elements.

Author: adamghill

src/django_unicorn/components/unicorn_template_response.py

@@ -79,7 +79,7 @@ def get_root_element(content: str) -> html.HtmlElement:
         else:
             # lxml.html.fragments_fromstring returns a list of elements/strings
             fragments = html.fragments_fromstring(content)
-            elements = [f for f in fragments if isinstance(f, html.HtmlElement)]
+            elements = [f for f in fragments if isinstance(f, html.HtmlElement) and f.tag != "script"]
 
             if not elements:
                 raise MissingComponentElementError("No root element for the component was found")
@@ -117,7 +117,7 @@ def assert_has_single_wrapper_element(content: str, component_name: str) -> None
             elements = [content]
         else:
             fragments = html.fragments_fromstring(content)
-            elements = [f for f in fragments if isinstance(f, html.HtmlElement)]
+            elements = [f for f in fragments if isinstance(f, html.HtmlElement) and (f.tag != "script" or f.attrib)]
     except Exception:
         # Should have been caught by get_root_element usually
         return

src/django_unicorn/templatetags/unicorn.py

@@ -85,14 +85,6 @@ def __init__(
         self.parent = None
 
     def render(self, context):
-        # Ensure that window.Unicorn exists before any component is rendered
-        # so that inline scripts can attach functions to it without errors
-        unicorn_stub = ""
-
-        if not context.get("unicorn_stub_rendered"):
-            unicorn_stub = mark_safe("<script>window.Unicorn = window.Unicorn || {};</script>\n")
-            context["unicorn_stub_rendered"] = True
-
         request = None
 
         if hasattr(context, "request"):
@@ -152,6 +144,14 @@ def render(self, context):
             except template.VariableDoesNotExist:
                 pass  # no implicit parent present
 
+        # Ensure that window.Unicorn exists before any component is rendered
+        # so that inline scripts can attach functions to it without errors
+        unicorn_stub = ""
+
+        if not self.parent and not context.get("unicorn_stub_rendered"):
+            unicorn_stub = mark_safe("<script>window.Unicorn = window.Unicorn || {};</script>\n")
+            context["unicorn_stub_rendered"] = True
+
         component_id = None
 
         try:

tests/templatetags/test_unicorn_render.py

@@ -100,17 +100,21 @@ def test_unicorn_template_renders(client):
 
     assert response.wsgi_request.path == "/test"
     assert "WSGIRequest" in content
-    assert content.startswith("<div unicorn:id")
-    assert 'unicorn:name="tests.templatetags.test_unicorn_render.FakeComponentKwargs"' in content
+    root_element = get_root_element(content)
+    assert root_element.tag == "div"
+    assert "unicorn:id" in root_element.attrib
+    assert root_element.attrib.get("unicorn:name") == "tests.templatetags.test_unicorn_render.FakeComponentKwargs"
 
 
 def test_unicorn_template_renders_with_parent_and_child(client):
     response = client.get("/test-parent")
     content = response.content.decode().strip()
 
     assert response.wsgi_request.path == "/test-parent"
-    assert content.startswith("<div unicorn:id")
-    assert 'unicorn:name="tests.templatetags.test_unicorn_render.FakeComponentParent"' in content
+    root_element = get_root_element(content)
+    assert root_element.tag == "div"
+    assert "unicorn:id" in root_element.attrib
+    assert root_element.attrib.get("unicorn:name") == "tests.templatetags.test_unicorn_render.FakeComponentParent"
     assert 'unicorn:name="tests.templatetags.test_unicorn_render.FakeComponentChild"' in content
     assert "--parent--" in content
     assert "==child==" in content
@@ -121,8 +125,10 @@ def test_unicorn_template_renders_with_parent_and_child_with_templateview(client
     content = response.content.decode().strip()
 
     assert response.wsgi_request.path == "/test-parent-template"
-    assert content.startswith("<div unicorn:id")
-    assert 'unicorn:name="tests.templatetags.test_unicorn_render.FakeComponentParent"' in content
+    root_element = get_root_element(content)
+    assert root_element.tag == "div"
+    assert "unicorn:id" in root_element.attrib
+    assert root_element.attrib.get("unicorn:name") == "tests.templatetags.test_unicorn_render.FakeComponentParent"
     assert 'unicorn:name="tests.templatetags.test_unicorn_render.FakeComponentChild"' in content
     assert "--parent--" in content
     assert "==child==" in content
@@ -133,8 +139,12 @@ def test_unicorn_template_renders_with_implicit_parent_and_child(client):
     content = response.content.decode().strip()
 
     assert response.wsgi_request.path == "/test-parent-implicit"
-    assert content.startswith("<div unicorn:id")
-    assert 'unicorn:name="tests.templatetags.test_unicorn_render.FakeComponentParentImplicit"' in content
+    root_element = get_root_element(content)
+    assert root_element.tag == "div"
+    assert "unicorn:id" in root_element.attrib
+    assert (
+        root_element.attrib.get("unicorn:name") == "tests.templatetags.test_unicorn_render.FakeComponentParentImplicit"
+    )
     assert 'unicorn:name="tests.templatetags.test_unicorn_render.FakeComponentChildImplicit"' in content
     assert "--parent--" in content
     assert "==child==" in content