@archipelagolab/lobi 1.0.0

package/src/matrix/format.test.ts

@@ -0,0 +1,340 @@
+import { describe, expect, it } from "vitest";
+import { markdownToMatrixHtml, renderMarkdownToMatrixHtmlWithMentions } from "./format.js";
+
+function createMentionClient(selfUserId = "@bot:example.org") {
+  return {
+    getUserId: async () => selfUserId,
+  } as unknown as import("./sdk.js").MatrixClient;
+}
+
+describe("markdownToMatrixHtml", () => {
+  it("renders basic inline formatting", () => {
+    const html = markdownToMatrixHtml("hi _there_ **boss** `code`");
+    expect(html).toContain("<em>there</em>");
+    expect(html).toContain("<strong>boss</strong>");
+    expect(html).toContain("<code>code</code>");
+  });
+
+  it("renders links as HTML", () => {
+    const html = markdownToMatrixHtml("see [docs](https://example.com)");
+    expect(html).toContain('<a href="https://example.com">docs</a>');
+  });
+
+  it("does not auto-link bare file references into external urls", () => {
+    const html = markdownToMatrixHtml("Check README.md and backup.sh");
+    expect(html).toContain("README.md");
+    expect(html).toContain("backup.sh");
+    expect(html).not.toContain('href="http://README.md"');
+    expect(html).not.toContain('href="http://backup.sh"');
+  });
+
+  it("keeps real domains linked even when path segments look like filenames", () => {
+    const html = markdownToMatrixHtml("See https://docs.example.com/backup.sh");
+    expect(html).toContain('href="https://docs.example.com/backup.sh"');
+  });
+
+  it("escapes raw HTML", () => {
+    const html = markdownToMatrixHtml("<b>nope</b>");
+    expect(html).toContain("&lt;b&gt;nope&lt;/b&gt;");
+    expect(html).not.toContain("<b>nope</b>");
+  });
+
+  it("flattens images into alt text", () => {
+    const html = markdownToMatrixHtml("![alt](https://example.com/img.png)");
+    expect(html).toContain("alt");
+    expect(html).not.toContain("<img");
+  });
+
+  it("preserves line breaks", () => {
+    const html = markdownToMatrixHtml("line1\nline2");
+    expect(html).toContain("<br");
+  });
+
+  it("compacts loose ordered lists without paragraph tags", () => {
+    const html = markdownToMatrixHtml("1. first\n\n2. second\n\n3. third");
+    expect(html).toContain("<ol>");
+    expect(html).toContain("<li>");
+    expect(html).not.toContain("<p>");
+  });
+
+  it("compacts loose unordered lists without paragraph tags", () => {
+    const html = markdownToMatrixHtml("- one\n\n- two\n\n- three");
+    expect(html).toContain("<ul>");
+    expect(html).not.toContain("<p>");
+  });
+
+  it("keeps tight lists unchanged", () => {
+    const html = markdownToMatrixHtml("- one\n- two");
+    expect(html).toContain("<ul>");
+    expect(html).not.toContain("<p>");
+  });
+
+  it("preserves inline formatting in loose lists", () => {
+    const html = markdownToMatrixHtml("1. **bold**\n\n2. _italic_");
+    expect(html).toContain("<strong>bold</strong>");
+    expect(html).toContain("<em>italic</em>");
+    expect(html).not.toContain("<p>");
+  });
+
+  it("does not strip paragraph tags outside lists", () => {
+    const html = markdownToMatrixHtml("Hello\n\nWorld");
+    expect(html).toContain("<p>Hello</p>");
+    expect(html).toContain("<p>World</p>");
+  });
+
+  it("compacts nested sublists without paragraph tags", () => {
+    const html = markdownToMatrixHtml("1. parent\n\n   - child\n\n2. other");
+    expect(html).toContain("<ol>");
+    expect(html).toContain("<ul>");
+    expect(html).not.toContain("<p>");
+  });
+
+  it("compacts loose lists with mentions via renderMarkdownToMatrixHtmlWithMentions", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "1. hello @alice:example.org\n\n2. bye",
+      client: createMentionClient(),
+    });
+    expect(result.html).not.toContain("<p>");
+    expect(result.html).toContain('href="https://matrix.to/#/%40alice%3Aexample.org"');
+    expect(result.mentions).toEqual({ user_ids: ["@alice:example.org"] });
+  });
+
+  it("preserves paragraph wrappers for multi-paragraph list items", () => {
+    const html = markdownToMatrixHtml("1. First sentence.\n\n   Second sentence in the same item.");
+    expect(html).toContain("<li>");
+    expect(html).toContain("<p>First sentence.</p>");
+    expect(html).toContain("<p>Second sentence in the same item.</p>");
+  });
+
+  it("renders qualified Matrix user mentions as matrix.to links and m.mentions metadata", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "hello @alice:example.org",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain('href="https://matrix.to/#/%40alice%3Aexample.org"');
+    expect(result.mentions).toEqual({
+      user_ids: ["@alice:example.org"],
+    });
+  });
+
+  it("url-encodes matrix.to hrefs for valid mxids with path characters", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "hello @foo/bar:example.org",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain('href="https://matrix.to/#/%40foo%2Fbar%3Aexample.org"');
+    expect(result.mentions).toEqual({
+      user_ids: ["@foo/bar:example.org"],
+    });
+  });
+
+  it("treats mxids that begin with room as user mentions", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "hello @room:example.org",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain('href="https://matrix.to/#/%40room%3Aexample.org"');
+    expect(result.mentions).toEqual({
+      user_ids: ["@room:example.org"],
+    });
+  });
+
+  it("treats hyphenated room-prefixed mxids as user mentions", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "hello @room-admin:example.org",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain('href="https://matrix.to/#/%40room-admin%3Aexample.org"');
+    expect(result.mentions).toEqual({
+      user_ids: ["@room-admin:example.org"],
+    });
+  });
+
+  it("keeps explicit room mentions as room mentions", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "hello @room",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain("@room");
+    expect(result.html).not.toContain("matrix.to");
+    expect(result.mentions).toEqual({
+      room: true,
+    });
+  });
+
+  it("treats sentence-ending room mentions as room mentions", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "hello @room.",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain("hello @room.");
+    expect(result.html).not.toContain("matrix.to");
+    expect(result.mentions).toEqual({
+      room: true,
+    });
+  });
+
+  it("treats colon-suffixed room mentions as room mentions", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "hello @room:",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain("hello @room:");
+    expect(result.html).not.toContain("matrix.to");
+    expect(result.mentions).toEqual({
+      room: true,
+    });
+  });
+
+  it("trims punctuation before storing mentioned user ids", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "hello @alice:example.org.",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain('href="https://matrix.to/#/%40alice%3Aexample.org"');
+    expect(result.html).toContain("@alice:example.org</a>.");
+    expect(result.mentions).toEqual({
+      user_ids: ["@alice:example.org"],
+    });
+  });
+
+  it("does not emit mentions for mxid-like tokens with path suffixes", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "hello @alice:example.org/path",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain("@alice:example.org/path");
+    expect(result.html).not.toContain("matrix.to");
+    expect(result.mentions).toEqual({});
+  });
+
+  it("accepts bracketed homeservers in matrix mentions", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "hello @alice:[2001:db8::1]",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain('href="https://matrix.to/#/%40alice%3A%5B2001%3Adb8%3A%3A1%5D"');
+    expect(result.mentions).toEqual({
+      user_ids: ["@alice:[2001:db8::1]"],
+    });
+  });
+
+  it("accepts bracketed homeservers with ports in matrix mentions", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "hello @alice:[2001:db8::1]:8448.",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain(
+      'href="https://matrix.to/#/%40alice%3A%5B2001%3Adb8%3A%3A1%5D%3A8448"',
+    );
+    expect(result.html).toContain("@alice:[2001:db8::1]:8448</a>.");
+    expect(result.mentions).toEqual({
+      user_ids: ["@alice:[2001:db8::1]:8448"],
+    });
+  });
+
+  it("leaves bare localpart text unmentioned", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "hello @alice",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).not.toContain("matrix.to");
+    expect(result.mentions).toEqual({});
+  });
+
+  it("does not convert escaped qualified mentions", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "\\@alice:example.org",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain("@alice:example.org");
+    expect(result.html).not.toContain("matrix.to");
+    expect(result.mentions).toEqual({});
+  });
+
+  it("does not convert escaped room mentions", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "\\@room",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain("@room");
+    expect(result.mentions).toEqual({});
+  });
+
+  it("keeps escaped mentions literal after escaped backticks", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "\\`literal then \\@alice:example.org",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain("`literal then @alice:example.org");
+    expect(result.html).not.toContain("matrix.to");
+    expect(result.mentions).toEqual({});
+  });
+
+  it("restores escaped mentions in markdown link labels without linking them", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "[\\@alice:example.org](https://example.com)",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain('<a href="https://example.com">@alice:example.org</a>');
+    expect(result.html).not.toContain("matrix.to");
+    expect(result.mentions).toEqual({});
+  });
+
+  it("keeps backslashes inside code spans", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "`\\@alice:example.org`",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain("<code>\\@alice:example.org</code>");
+    expect(result.mentions).toEqual({});
+  });
+
+  it("does not convert mentions inside code spans", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "`@alice:example.org`",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain("<code>@alice:example.org</code>");
+    expect(result.html).not.toContain("matrix.to");
+    expect(result.mentions).toEqual({});
+  });
+
+  it("keeps backslashes inside tilde fenced code blocks", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "~~~\n\\@alice:example.org\n~~~",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain("<pre><code>\\@alice:example.org\n</code></pre>");
+    expect(result.mentions).toEqual({});
+  });
+
+  it("keeps backslashes inside indented code blocks", async () => {
+    const result = await renderMarkdownToMatrixHtmlWithMentions({
+      markdown: "    \\@alice:example.org",
+      client: createMentionClient(),
+    });
+
+    expect(result.html).toContain("<pre><code>\\@alice:example.org\n</code></pre>");
+    expect(result.mentions).toEqual({});
+  });
+});