Throw an error if a circular layout chain is detected (#2064)

src/TemplateLayout.js

@@ -70,11 +70,25 @@ class TemplateLayout extends TemplateContent {
     let cfgKey = this.config.keys.layout;
     let map = [];
     let mapEntry = await this.getTemplateLayoutMapEntry();
+
+    // Keep track of every layout we see so we can detect cyclical layout chains (e.g., a => b => c => a).
+    const seenLayoutKeys = new Set();
+    seenLayoutKeys.add(mapEntry.key);
     map.push(mapEntry);
 
     while (mapEntry.frontMatterData && cfgKey in mapEntry.frontMatterData) {
+      // Layout of the current layout
+      const parentLayoutKey = mapEntry.frontMatterData[cfgKey];
+      // Abort if a circular layout chain is detected. Otherwise, we'll time out and run out of memory.
+      if (seenLayoutKeys.has(parentLayoutKey)) {
+        throw new Error(
+          `Circular layout chain detected starting at ${map[0].key}. The layout ${parentLayoutKey} was specified twice in this layout chain.`
+        );
+      }
+      // Keep track of this layout so we can detect duplicates in subsequent iterations
+      seenLayoutKeys.add(parentLayoutKey);
       let layout = TemplateLayout.getTemplate(
-        mapEntry.frontMatterData[cfgKey],
+        parentLayoutKey,
         mapEntry.inputDir,
         this.config,
         this.extensionMap

test/TemplateLayoutTest.js

@@ -55,6 +55,28 @@ test("Get Layout Chain", async (t) => {
   ]);
 });
 
+test("Throw an error if a layout references itself as the layout", async (t) => {
+  await t.throwsAsync(async () => {
+    const tl = getTemplateLayoutInstance(
+      "layouts/layout-cycle-self.njk",
+      "./test/stubs"
+    );
+    const layoutChain = await tl._testGetLayoutChain();
+    return layoutChain;
+  });
+});
+
+test("Throw an error if a circular layout chain is detected", async (t) => {
+  await t.throwsAsync(async () => {
+    const tl = getTemplateLayoutInstance(
+      "layouts/layout-cycle-a.njk",
+      "./test/stubs"
+    );
+    const layoutChain = await tl._testGetLayoutChain();
+    return layoutChain;
+  });
+});
+
 test("Get Front Matter Data", async (t) => {
   let tl = getTemplateLayoutInstance(
     "layouts/layout-inherit-a.njk",

test/stubs/_includes/layouts/layout-cycle-a.njk

@@ -0,0 +1,5 @@
+---
+inherits: a
+layout: layouts/layout-cycle-b.njk
+---
+{{content}} {{inherits}}

test/stubs/_includes/layouts/layout-cycle-b.njk

@@ -0,0 +1,6 @@
+---
+inherits: b
+secondinherits: b
+layout: layouts/layout-cycle-c.njk
+---
+{{ content | safe }} {{secondinherits}}

test/stubs/_includes/layouts/layout-cycle-c.njk

@@ -0,0 +1,7 @@
+---
+inherits: c
+secondinherits: c
+thirdinherits: c
+layout: layouts/layout-cycle-a.njk
+---
+{{ content | safe }} {{inherits}} {{thirdinherits}}

test/stubs/_includes/layouts/layout-cycle-self.njk

@@ -0,0 +1,3 @@
+---
+layout: layouts/layout-cycle-self.njk
+---