add circular inclusion check

digitalfondue · Dec 25, 2024 · 7b0f2cc · 7b0f2cc
1 parent ed9a901
commit 7b0f2cc
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 2 deletions.
diff --git a/data/circular/circular-1.mjml b/data/circular/circular-1.mjml
@@ -0,0 +1,5 @@
+<mj-section css-class="bg-white">
+    <mj-column padding="32px 48px">
+        <mj-include path="circular-2.mjml" />
+    </mj-column>
+</mj-section>
diff --git a/data/circular/circular-2.mjml b/data/circular/circular-2.mjml
@@ -0,0 +1,5 @@
+<mj-section css-class="bg-white">
+    <mj-column padding="32px 48px">
+        <mj-include path="circular-1.mjml" />
+    </mj-column>
+</mj-section>
diff --git a/data/circular/include-circular.mjml b/data/circular/include-circular.mjml
@@ -0,0 +1,14 @@
+<mjml>
+    <mj-body>
+
+        <mj-section css-class="bg-white">
+            <mj-column>
+                <mj-text padding="48px 48px 0 48px">
+                    <p>This is the Index!</p>
+                </mj-text>
+            </mj-column>
+        </mj-section>
+
+        <mj-include path="/circular/circular-1.mjml" />
+    </mj-body>
+</mjml>
diff --git a/src/main/java/ch/digitalfondue/mjml4j/Mjml4j.java b/src/main/java/ch/digitalfondue/mjml4j/Mjml4j.java
@@ -501,7 +501,10 @@ private static BaseComponent handleInclude(Element element, BaseComponent parent
         try {
             resolvedPath = includeResolver.resolvePath(path, context.currentResourcePaths.peek());
             resource = includeResolver.readResource(resolvedPath);
-        } catch (IOException | IllegalStateException e) {
+            if (context.currentResourcePaths.contains(resolvedPath)) {
+                throw new IllegalStateException("Circular inclusion detected on file : " + resolvedPath);
+            }
+        } catch (IOException e) {
             resource = "<!-- mj-include fails to read file : " + path + " at " + resolvedPath + " -->";
             return new MjmlComponentRaw(element, parent, context, resource);
         }

diff --git a/src/test/java/ch/digitalfondue/mjml4j/BaseComponentTests.java b/src/test/java/ch/digitalfondue/mjml4j/BaseComponentTests.java
@@ -5,7 +5,7 @@
 import static ch.digitalfondue.mjml4j.Helpers.testTemplate;
 
 /**
- * Unit test for simple App.
+ * Unit test for base cases.
  */
 class BaseComponentTests {
 

diff --git a/src/test/java/ch/digitalfondue/mjml4j/ComplexTemplateTests.java b/src/test/java/ch/digitalfondue/mjml4j/ComplexTemplateTests.java
@@ -1,5 +1,6 @@
 package ch.digitalfondue.mjml4j;
 
+import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 
 import static ch.digitalfondue.mjml4j.Helpers.testTemplate;
@@ -127,4 +128,10 @@ void testIncludeAbout() {
     void testDividerAttributeAll() {
         testTemplate("mj-divider-mj-all");
     }
+
+    @Test
+    void testCircularInclude() {
+        var t = Assertions.assertThrows(IllegalStateException.class, () -> testTemplate("circular/include-circular"));
+        Assertions.assertTrue(t.getMessage().startsWith("Circular inclusion detected on file"));
+    }
 }