/* Copyright 2024 New Vector Ltd. Copyright 2019 The Matrix.org Foundation C.I.C. SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only Please see LICENSE files in the repository root for full details. */ import { mocked } from "jest-mock"; import EditorModel from "../../../src/editor/model"; import { htmlSerializeFromMdIfNeeded, htmlSerializeIfNeeded } from "../../../src/editor/serialize"; import { createPartCreator } from "./mock"; import { IConfigOptions } from "../../../src/IConfigOptions"; import SettingsStore from "../../../src/settings/SettingsStore"; import SdkConfig from "../../../src/SdkConfig"; describe("editor/serialize", function () { describe("with markdown", function () { it("user pill turns message into html", function () { const pc = createPartCreator(); const model = new EditorModel([pc.userPill("Alice", "@alice:hs.tld")], pc); const html = htmlSerializeIfNeeded(model, {}); expect(html).toBe('Alice'); }); it("room pill turns message into html", function () { const pc = createPartCreator(); const model = new EditorModel([pc.roomPill("#room:hs.tld")], pc); const html = htmlSerializeIfNeeded(model, {}); expect(html).toBe('#room:hs.tld'); }); it("@room pill turns message into html", function () { const pc = createPartCreator(); const model = new EditorModel([pc.atRoomPill("@room")], pc); const html = htmlSerializeIfNeeded(model, {}); expect(html).toBeFalsy(); }); it("any markdown turns message into html", function () { const pc = createPartCreator(); const model = new EditorModel([pc.plain("*hello* world")], pc); const html = htmlSerializeIfNeeded(model, {}); expect(html).toBe("hello world"); }); it("displaynames ending in a backslash work", function () { const pc = createPartCreator(); const model = new EditorModel([pc.userPill("Displayname\\", "@user:server")], pc); const html = htmlSerializeIfNeeded(model, {}); expect(html).toBe('Displayname\\'); }); it("displaynames containing an opening square bracket work", function () { const pc = createPartCreator(); const model = new EditorModel([pc.userPill("Displayname[[", "@user:server")], pc); const html = htmlSerializeIfNeeded(model, {}); expect(html).toBe('Displayname[['); }); it("displaynames containing a closing square bracket work", function () { const pc = createPartCreator(); const model = new EditorModel([pc.userPill("Displayname]", "@user:server")], pc); const html = htmlSerializeIfNeeded(model, {}); expect(html).toBe('Displayname]'); }); it("displaynames containing a newline work", function () { const pc = createPartCreator(); const model = new EditorModel([pc.userPill("Display\nname", "@user:server")], pc); const html = htmlSerializeIfNeeded(model, {}); expect(html).toBe('Display
name
'); }); it("escaped markdown should not retain backslashes", function () { const pc = createPartCreator(); const model = new EditorModel([pc.plain("\\*hello\\* world")], pc); const html = htmlSerializeIfNeeded(model, {}); expect(html).toBe("*hello* world"); }); it("escaped markdown should not retain backslashes around other markdown", function () { const pc = createPartCreator(); const model = new EditorModel([pc.plain("\\*hello\\* **world**")], pc); const html = htmlSerializeIfNeeded(model, {}); expect(html).toBe("*hello* world"); }); it("escaped markdown should convert HTML entities", function () { const pc = createPartCreator(); const model = new EditorModel([pc.plain("\\*hello\\* world < hey world!")], pc); const html = htmlSerializeIfNeeded(model, {}); expect(html).toBe("*hello* world < hey world!"); }); it("lists with a single empty item are not considered markdown", function () { const pc = createPartCreator(); const model1 = new EditorModel([pc.plain("-")], pc); const html1 = htmlSerializeIfNeeded(model1, {}); expect(html1).toBe(undefined); const model2 = new EditorModel([pc.plain("* ")], pc); const html2 = htmlSerializeIfNeeded(model2, {}); expect(html2).toBe(undefined); const model3 = new EditorModel([pc.plain("2021.")], pc); const html3 = htmlSerializeIfNeeded(model3, {}); expect(html3).toBe(undefined); }); it("lists with a single non-empty item are still markdown", function () { const pc = createPartCreator(); const model = new EditorModel([pc.plain("2021. foo")], pc); const html = htmlSerializeIfNeeded(model, {}); expect(html).toBe('
    \n
  1. foo
  2. \n
\n'); }); describe("with permalink_prefix set", function () { const sdkConfigGet = SdkConfig.get; beforeEach(() => { jest.spyOn(SdkConfig, "get").mockImplementation((key: keyof IConfigOptions, altCaseName?: string) => { if (key === "permalink_prefix") { return "https://element.fs.tld"; } else return sdkConfigGet(key, altCaseName); }); }); it("user pill uses matrix.to", function () { const pc = createPartCreator(); const model = new EditorModel([pc.userPill("Alice", "@alice:hs.tld")], pc); const html = htmlSerializeIfNeeded(model, {}); expect(html).toBe('Alice'); }); it("room pill uses matrix.to", function () { const pc = createPartCreator(); const model = new EditorModel([pc.roomPill("#room:hs.tld")], pc); const html = htmlSerializeIfNeeded(model, {}); expect(html).toBe('#room:hs.tld'); }); afterEach(() => { mocked(SdkConfig.get).mockRestore(); }); }); }); describe("with plaintext", function () { it("markdown remains plaintext", function () { const pc = createPartCreator(); const model = new EditorModel([pc.plain("*hello* world")], pc); const html = htmlSerializeIfNeeded(model, { useMarkdown: false }); expect(html).toBe("*hello* world"); }); it("markdown should retain backslashes", function () { const pc = createPartCreator(); const model = new EditorModel([pc.plain("\\*hello\\* world")], pc); const html = htmlSerializeIfNeeded(model, { useMarkdown: false }); expect(html).toBe("\\*hello\\* world"); }); it("markdown should convert HTML entities", function () { const pc = createPartCreator(); const model = new EditorModel([pc.plain("\\*hello\\* world < hey world!")], pc); const html = htmlSerializeIfNeeded(model, { useMarkdown: false }); expect(html).toBe("\\*hello\\* world < hey world!"); }); it("plaintext remains plaintext even when forcing html", function () { const pc = createPartCreator(); const model = new EditorModel([pc.plain("hello world")], pc); const html = htmlSerializeIfNeeded(model, { forceHTML: true, useMarkdown: false }); expect(html).toBe("hello world"); }); it("should treat tags not in allowlist as plaintext", () => { const html = htmlSerializeFromMdIfNeeded("test", {}); expect(html).toBeUndefined(); }); it("should treat tags not in allowlist as plaintext even if escaped", () => { const html = htmlSerializeFromMdIfNeeded("\\test", {}); expect(html).toBe("<b>test</b>"); }); }); describe("feature_latex_maths", () => { beforeEach(() => { jest.spyOn(SettingsStore, "getValue").mockImplementation((feature) => feature === "feature_latex_maths"); }); it("should support inline katex", () => { const pc = createPartCreator(); const model = new EditorModel([pc.plain("hello $\\xi$ world")], pc); const html = htmlSerializeIfNeeded(model, {}); expect(html).toMatchInlineSnapshot(`"hello \\xi world"`); }); it("should support block katex", () => { const pc = createPartCreator(); const model = new EditorModel([pc.plain("hello \n$$\\xi$$\n world")], pc); const html = htmlSerializeIfNeeded(model, {}); expect(html).toMatchInlineSnapshot(` "

hello

\\xi

world

" `); }); it("should not mangle code blocks", () => { const pc = createPartCreator(); const model = new EditorModel([pc.plain("hello\n```\n$\\xi$\n```\nworld")], pc); const html = htmlSerializeIfNeeded(model, {}); expect(html).toMatchInlineSnapshot(` "

hello

$\\xi$
                

world

" `); }); }); });