test: adding tests for (de-)serializing without markdown

Author: justjanne

test/editor/deserialize-test.ts

@@ -331,4 +331,78 @@ describe('editor/deserialize', function() {
             expect(parts).toMatchSnapshot();
         });
     });
+    describe('plaintext messages', function() {
+        it('turns html tags back into markdown', function() {
+            const html = "<strong>bold</strong> and <em>emphasized</em> text <a href=\"http://example.com/\">this</a>!";
+            const parts = normalize(parseEvent(htmlMessage(html), createPartCreator(), { shouldEscape: false }));
+            expect(parts.length).toBe(1);
+            expect(parts[0]).toStrictEqual({
+                type: "plain",
+                text: "**bold** and _emphasized_ text [this](http://example.com/)!",
+            });
+        });
+        it('keeps backticks unescaped', () => {
+            const html = "this → ` is a backtick and here are 3 of them:\n```";
+            const parts = normalize(parseEvent(htmlMessage(html), createPartCreator(), { shouldEscape: false }));
+            expect(parts.length).toBe(1);
+            expect(parts[0]).toStrictEqual({
+                type: "plain",
+                text: "this → ` is a backtick and here are 3 of them:\n```",
+            });
+        });
+        it('keeps backticks outside of code blocks', () => {
+            const html = "some `backticks`";
+            const parts = normalize(parseEvent(htmlMessage(html), createPartCreator(), { shouldEscape: false }));
+            expect(parts.length).toBe(1);
+            expect(parts[0]).toStrictEqual({
+                type: "plain",
+                text: "some `backticks`",
+            });
+        });
+        it('keeps backslashes', () => {
+            const html = "C:\\My Documents";
+            const parts = normalize(parseEvent(htmlMessage(html), createPartCreator(), { shouldEscape: false }));
+            expect(parts.length).toBe(1);
+            expect(parts[0]).toStrictEqual({
+                type: "plain",
+                text: "C:\\My Documents",
+            });
+        });
+        it('keeps asterisks', () => {
+            const html = "*hello*";
+            const parts = normalize(parseEvent(htmlMessage(html), createPartCreator(), { shouldEscape: false }));
+            expect(parts.length).toBe(1);
+            expect(parts[0]).toStrictEqual({
+                type: "plain",
+                text: "*hello*",
+            });
+        });
+        it('keeps underscores', () => {
+            const html = "__emphasis__";
+            const parts = normalize(parseEvent(htmlMessage(html), createPartCreator(), { shouldEscape: false }));
+            expect(parts.length).toBe(1);
+            expect(parts[0]).toStrictEqual({
+                type: "plain",
+                text: "__emphasis__",
+            });
+        });
+        it('keeps square brackets', () => {
+            const html = "[not an actual link](https://example.org)";
+            const parts = normalize(parseEvent(htmlMessage(html), createPartCreator(), { shouldEscape: false }));
+            expect(parts.length).toBe(1);
+            expect(parts[0]).toStrictEqual({
+                type: "plain",
+                text: "[not an actual link](https://example.org)",
+            });
+        });
+        it('escapes angle brackets', () => {
+            const html = "> &lt;del&gt;no formatting here&lt;/del&gt;";
+            const parts = normalize(parseEvent(htmlMessage(html), createPartCreator(), { shouldEscape: false }));
+            expect(parts.length).toBe(1);
+            expect(parts[0]).toStrictEqual({
+                type: "plain",
+                text: "> <del>no formatting here</del>",
+            });
+        });
+    });
 });

test/editor/serialize-test.ts

@@ -19,58 +19,80 @@ import { htmlSerializeIfNeeded } from "../../src/editor/serialize";
 import { createPartCreator } from "./mock";
 
 describe('editor/serialize', 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("<a href=\"https://matrix.to/#/@alice:hs.tld\">Alice</a>");
+    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("<a href=\"https://matrix.to/#/@alice:hs.tld\">Alice</a>");
+        });
+        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("<a href=\"https://matrix.to/#/#room:hs.tld\">#room:hs.tld</a>");
+        });
+        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("<em>hello</em> 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("<a href=\"https://matrix.to/#/@user:server\">Displayname\\</a>");
+        });
+        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("<a href=\"https://matrix.to/#/@user:server\">Displayname[[</a>");
+        });
+        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("<a href=\"https://matrix.to/#/@user:server\">Displayname]</a>");
+        });
+        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 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 &lt; hey world!');
+        });
     });
-    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("<a href=\"https://matrix.to/#/#room:hs.tld\">#room:hs.tld</a>");
-    });
-    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("<em>hello</em> 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("<a href=\"https://matrix.to/#/@user:server\">Displayname\\</a>");
-    });
-    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("<a href=\"https://matrix.to/#/@user:server\">Displayname[[</a>");
-    });
-    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("<a href=\"https://matrix.to/#/@user:server\">Displayname]</a>");
-    });
-    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 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 &lt; hey world!');
+    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 &lt; hey world!');
+        });
     });
 });