test: add regression tests for transclusion changes

quartz/components/renderPage.test.ts

@@ -0,0 +1,268 @@
+import test, { describe } from "node:test"
+import assert from "node:assert"
+import { renderTranscludes } from "./renderPage"
+import { Root, Element } from "hast"
+import { FullSlug } from "../util/path"
+import { GlobalConfiguration } from "../cfg"
+import { QuartzComponentProps } from "./types"
+
+function makeTranscludeBlockquote(targetSlug: string, block?: string): Element {
+  return {
+    type: "element",
+    tagName: "blockquote",
+    properties: {
+      className: ["transclude"],
+      ...(block ? { dataBlock: block } : {}),
+    },
+    children: [
+      {
+        type: "element",
+        tagName: "a",
+        properties: {
+          href: `./${targetSlug}`,
+          "data-slug": targetSlug,
+          className: ["transclude-inner"],
+        },
+        children: [{ type: "text", value: `Transclude of ${targetSlug}` }],
+      },
+    ],
+  }
+}
+
+function makePageData(slug: string, htmlAst: Root, extra?: Record<string, unknown>) {
+  return {
+    slug: slug as FullSlug,
+    htmlAst,
+    frontmatter: { title: slug, tags: [] },
+    ...extra,
+  } as unknown as QuartzComponentProps["allFiles"][number]
+}
+
+const cfg = { locale: "en-US" } as GlobalConfiguration
+
+function makeComponentData(
+  allFiles: QuartzComponentProps["allFiles"],
+): Pick<QuartzComponentProps, "allFiles" | "cfg"> {
+  return { allFiles, cfg } as unknown as QuartzComponentProps
+}
+
+describe("renderTranscludes", () => {
+  test("resolves a single page transclusion", () => {
+    const root: Root = {
+      type: "root",
+      children: [makeTranscludeBlockquote("target")],
+    }
+
+    const targetHtml: Root = {
+      type: "root",
+      children: [
+        {
+          type: "element",
+          tagName: "p",
+          properties: {},
+          children: [{ type: "text", value: "Target content" }],
+        },
+      ],
+    }
+
+    const allFiles = [makePageData("target", targetHtml)]
+    const visited = new Set<FullSlug>(["current" as FullSlug])
+    renderTranscludes(
+      root,
+      cfg,
+      "current" as FullSlug,
+      makeComponentData(allFiles) as QuartzComponentProps,
+      visited,
+    )
+
+    const bq = root.children[0] as Element
+    const texts = JSON.stringify(bq.children)
+    assert.ok(texts.includes("Target content"), "transcluded content should be inlined")
+  })
+
+  test("allows the same page to be embedded twice as siblings", () => {
+    const root: Root = {
+      type: "root",
+      children: [makeTranscludeBlockquote("target"), makeTranscludeBlockquote("target")],
+    }
+
+    const targetHtml: Root = {
+      type: "root",
+      children: [
+        {
+          type: "element",
+          tagName: "p",
+          properties: {},
+          children: [{ type: "text", value: "Duplicated content" }],
+        },
+      ],
+    }
+
+    const allFiles = [makePageData("target", targetHtml)]
+    const visited = new Set<FullSlug>(["current" as FullSlug])
+    renderTranscludes(
+      root,
+      cfg,
+      "current" as FullSlug,
+      makeComponentData(allFiles) as QuartzComponentProps,
+      visited,
+    )
+
+    const first = root.children[0] as Element
+    const second = root.children[1] as Element
+    const firstText = JSON.stringify(first.children)
+    const secondText = JSON.stringify(second.children)
+    assert.ok(firstText.includes("Duplicated content"), "first embed should resolve")
+    assert.ok(
+      secondText.includes("Duplicated content"),
+      "second embed should resolve, not be rejected as circular",
+    )
+    assert.ok(!secondText.includes("Circular transclusion"), "should not show circular warning")
+  })
+
+  test("allows different sections of the same page to be embedded", () => {
+    const root: Root = {
+      type: "root",
+      children: [
+        makeTranscludeBlockquote("target", "#intro"),
+        makeTranscludeBlockquote("target", "#details"),
+      ],
+    }
+
+    const targetHtml: Root = {
+      type: "root",
+      children: [
+        {
+          type: "element",
+          tagName: "h2",
+          properties: { id: "intro" },
+          children: [{ type: "text", value: "Intro" }],
+        },
+        {
+          type: "element",
+          tagName: "p",
+          properties: {},
+          children: [{ type: "text", value: "Intro text" }],
+        },
+        {
+          type: "element",
+          tagName: "h2",
+          properties: { id: "details" },
+          children: [{ type: "text", value: "Details" }],
+        },
+        {
+          type: "element",
+          tagName: "p",
+          properties: {},
+          children: [{ type: "text", value: "Details text" }],
+        },
+      ],
+    }
+
+    const allFiles = [makePageData("target", targetHtml)]
+    const visited = new Set<FullSlug>(["current" as FullSlug])
+    renderTranscludes(
+      root,
+      cfg,
+      "current" as FullSlug,
+      makeComponentData(allFiles) as QuartzComponentProps,
+      visited,
+    )
+
+    const first = root.children[0] as Element
+    const second = root.children[1] as Element
+    const firstText = JSON.stringify(first.children)
+    const secondText = JSON.stringify(second.children)
+    assert.ok(firstText.includes("Intro text"), "first header section should resolve")
+    assert.ok(
+      !firstText.includes("Details text"),
+      "first section should not include second section",
+    )
+    assert.ok(secondText.includes("Details text"), "second header section should resolve")
+    assert.ok(!secondText.includes("Circular transclusion"), "should not show circular warning")
+  })
+
+  test("detects actual circular transclusion (A -> B -> A)", () => {
+    // Page A embeds B, and B's htmlAst contains a transclusion of A
+    const bTranscludesA = makeTranscludeBlockquote("pageA")
+    const pageB_htmlAst: Root = {
+      type: "root",
+      children: [
+        {
+          type: "element",
+          tagName: "p",
+          properties: {},
+          children: [{ type: "text", value: "Page B content" }],
+        },
+        bTranscludesA,
+      ],
+    }
+
+    const pageA_htmlAst: Root = {
+      type: "root",
+      children: [
+        {
+          type: "element",
+          tagName: "p",
+          properties: {},
+          children: [{ type: "text", value: "Page A content" }],
+        },
+      ],
+    }
+
+    const root: Root = {
+      type: "root",
+      children: [makeTranscludeBlockquote("pageB")],
+    }
+
+    const allFiles = [makePageData("pageA", pageA_htmlAst), makePageData("pageB", pageB_htmlAst)]
+
+    const visited = new Set<FullSlug>(["pageA" as FullSlug])
+    renderTranscludes(
+      root,
+      cfg,
+      "pageA" as FullSlug,
+      makeComponentData(allFiles) as QuartzComponentProps,
+      visited,
+    )
+
+    const bq = root.children[0] as Element
+    const fullText = JSON.stringify(bq.children)
+    assert.ok(fullText.includes("Page B content"), "page B content should be inlined")
+    assert.ok(fullText.includes("Circular transclusion"), "circular A->B->A should be detected")
+    assert.ok(!fullText.includes("Page A content"), "page A should not be re-inlined inside B")
+  })
+
+  test("self-referencing transclusion is blocked", () => {
+    const root: Root = {
+      type: "root",
+      children: [makeTranscludeBlockquote("self")],
+    }
+
+    const selfHtml: Root = {
+      type: "root",
+      children: [
+        {
+          type: "element",
+          tagName: "p",
+          properties: {},
+          children: [{ type: "text", value: "Self content" }],
+        },
+      ],
+    }
+
+    const allFiles = [makePageData("self", selfHtml)]
+    const visited = new Set<FullSlug>(["self" as FullSlug])
+    renderTranscludes(
+      root,
+      cfg,
+      "self" as FullSlug,
+      makeComponentData(allFiles) as QuartzComponentProps,
+      visited,
+    )
+
+    const bq = root.children[0] as Element
+    const text = JSON.stringify(bq.children)
+    assert.ok(text.includes("Circular transclusion"), "self-reference should be blocked")
+  })
+})