"use strict"; const {strict: assert} = require("assert"); const markdown_test_cases = require("../../zerver/tests/fixtures/markdown_test_cases"); const markdown_assert = require("../zjsunit/markdown_assert"); const {set_global, with_field_rewire, zrequire} = require("../zjsunit/namespace"); const {run_test} = require("../zjsunit/test"); const blueslip = require("../zjsunit/zblueslip"); const {page_params, user_settings} = require("../zjsunit/zpage_params"); const example_realm_linkifiers = [ { pattern: "#(?P[0-9]{2,8})", url_format: "https://trac.example.com/ticket/%(id)s", id: 1, }, { pattern: "ZBUG_(?P[0-9]{2,8})", url_format: "https://trac2.zulip.net/ticket/%(id)s", id: 2, }, { pattern: "ZGROUP_(?P[0-9]{2,8}):(?P[0-9]{1,8})", url_format: "https://zone_%(zone)s.zulip.net/ticket/%(id)s", id: 3, }, ]; user_settings.translate_emoticons = false; function Image() { return {}; } set_global("Image", Image); set_global("document", {compatMode: "CSS1Compat"}); const emoji = zrequire("../shared/js/emoji"); const emoji_codes = zrequire("../generated/emoji/emoji_codes.json"); const linkifiers = zrequire("linkifiers"); const pygments_data = zrequire("../generated/pygments_data.json"); const fenced_code = zrequire("../shared/js/fenced_code"); const markdown_config = zrequire("markdown_config"); const markdown = zrequire("markdown"); const people = zrequire("people"); const stream_data = zrequire("stream_data"); const user_groups = zrequire("user_groups"); const emoji_params = { realm_emoji: { 1: { id: 1, name: "burrito", source_url: "/static/generated/emoji/images/emoji/burrito.png", deactivated: false, }, }, emoji_codes, }; emoji.initialize(emoji_params); fenced_code.initialize(pygments_data); const cordelia = { full_name: "Cordelia, Lear's daughter", user_id: 101, email: "cordelia@zulip.com", }; people.add_active_user(cordelia); people.add_active_user({ full_name: "Leo", user_id: 102, email: "leo@zulip.com", }); people.add_active_user({ full_name: "Bobby

Tables

", user_id: 103, email: "bobby@zulip.com", }); people.add_active_user({ full_name: "Mark Twin", user_id: 104, email: "twin1@zulip.com", }); people.add_active_user({ full_name: "Mark Twin", user_id: 105, email: "twin2@zulip.com", }); people.add_active_user({ full_name: "Brother of Bobby|123", user_id: 106, email: "bobby2@zulip.com", }); people.add_active_user({ full_name: "& & &", user_id: 107, email: "ampampamp@zulip.com", }); people.initialize_current_user(cordelia.user_id); const hamletcharacters = { name: "hamletcharacters", id: 1, description: "Characters of Hamlet", members: [cordelia.user_id], }; const backend = { name: "Backend", id: 2, description: "Backend team", members: [], }; const edgecase_group = { name: "Bobby

Tables

", id: 3, description: "HTML syntax to check for Markdown edge cases.", members: [], }; const amp_group = { name: "& & &", id: 4, description: "Check ampersand escaping", members: [], }; user_groups.add(hamletcharacters); user_groups.add(backend); user_groups.add(edgecase_group); user_groups.add(amp_group); const denmark = { subscribed: false, color: "blue", name: "Denmark", stream_id: 1, is_muted: true, }; const social = { subscribed: true, color: "red", name: "social", stream_id: 2, is_muted: false, invite_only: true, }; const edgecase_stream = { subscribed: true, color: "green", name: "Bobby

Tables

", stream_id: 3, is_muted: false, }; const edgecase_stream_2 = { subscribed: true, color: "yellow", name: "Bobby { page_params.realm_users = []; linkifiers.update_linkifier_rules(example_realm_linkifiers); f({override, override_rewire}); }); } test("markdown_detection", () => { const no_markup = [ "This is a plaintext message", "This is a plaintext: message", "This is a :plaintext message", "This is a :plaintext message: message", "Contains a not an image.jpeg/ok file", "Contains a not an http://www.google.com/ok/image.png/stop file", "No png to be found here, a png", "No user mention **leo**", "No user mention @what there", "No group mention *hamletcharacters*", 'We like to code\n~~~\ndef code():\n we = "like to do"\n~~~', "This is a\nmultiline :emoji: here\n message", "This is an :emoji: message", "User Mention @**leo**", "User Mention @**leo f**", "User Mention @**leo with some name**", "Group Mention @*hamletcharacters*", "Stream #**Verona**", ]; const markup = [ "Contains a https://zulip.com/image.png file", "Contains a https://zulip.com/image.jpg file", "https://zulip.com/image.jpg", "also https://zulip.com/image.jpg", "https://zulip.com/image.jpg too", "Contains a zulip.com/foo.jpeg file", "Contains a https://zulip.com/image.png file", "Twitter URL https://twitter.com/jacobian/status/407886996565016579", "https://twitter.com/jacobian/status/407886996565016579", "then https://twitter.com/jacobian/status/407886996565016579", "Twitter URL http://twitter.com/jacobian/status/407886996565016579", "YouTube URL https://www.youtube.com/watch?v=HHZ8iqswiCw&feature=youtu.be&a", ]; for (const content of no_markup) { assert.equal(markdown.contains_backend_only_syntax(content), false); } for (const content of markup) { assert.equal(markdown.contains_backend_only_syntax(content), true); } }); test("marked_shared", () => { const tests = markdown_test_cases.regular_tests; for (const test of tests) { // Ignore tests if specified if (test.ignore === true) { continue; } const message = {raw_content: test.input}; user_settings.translate_emoticons = test.translate_emoticons || false; markdown.apply_markdown(message); const output = message.content; const error_message = `Failure in test: ${test.name}`; if (test.marked_expected_output) { markdown_assert.notEqual(test.expected_output, output, error_message); markdown_assert.equal(test.marked_expected_output, output, error_message); } else if (test.backend_only_rendering) { assert.equal(markdown.contains_backend_only_syntax(test.input), true); } else { markdown_assert.equal(test.expected_output, output, error_message); } } }); test("message_flags", () => { let message = {raw_content: "@**Leo**"}; markdown.apply_markdown(message); assert.ok(!message.mentioned); assert.ok(!message.mentioned_me_directly); message = {raw_content: "@**Cordelia, Lear's daughter**"}; markdown.apply_markdown(message); assert.ok(message.mentioned); assert.ok(message.mentioned_me_directly); message = {raw_content: "@**all**"}; markdown.apply_markdown(message); assert.ok(message.mentioned); assert.ok(!message.mentioned_me_directly); }); test("marked", () => { const test_cases = [ {input: "hello", expected: "

hello

"}, {input: "hello there", expected: "

hello there

"}, {input: "hello **bold** for you", expected: "

hello bold for you

"}, { input: "hello ***foo*** for you", expected: "

hello foo for you

", }, {input: "__hello__", expected: "

__hello__

"}, { input: "\n```\nfenced code\n```\n\nand then after\n", expected: '
fenced code\n
\n

and then after

', }, { input: "\n```\n fenced code trailing whitespace \n```\n\nand then after\n", expected: '
    fenced code trailing whitespace\n
\n

and then after

', }, { input: "* a\n* list \n* here", expected: "
    \n
  • a
  • \n
  • list
  • \n
  • here
  • \n
", }, { input: "\n```c#\nfenced code special\n```\n\nand then after\n", expected: '
fenced code special\n
\n

and then after

', }, { input: "\n```vb.net\nfenced code dot\n```\n\nand then after\n", expected: '
fenced code dot\n
\n

and then after

', }, { input: "Some text first\n* a\n* list \n* here\n\nand then after", expected: "

Some text first

\n
    \n
  • a
  • \n
  • list
  • \n
  • here
  • \n
\n

and then after

", }, { input: "1. an\n2. ordered \n3. list", expected: "
    \n
  1. an
  2. \n
  3. ordered
  4. \n
  5. list
  6. \n
", }, { input: "\n~~~quote\nquote this for me\n~~~\nthanks\n", expected: "
\n

quote this for me

\n
\n

thanks

", }, { input: "This is a @**CordeLIA, Lear's daughter** mention", expected: '

This is a @Cordelia, Lear's daughter mention

', }, { input: "These @ @**** are not mentions", expected: "

These @ @** are not mentions

", }, { input: "These # #**** are not mentions", expected: "

These # #** are not mentions

", }, {input: "These @* are not mentions", expected: "

These @* are not mentions

"}, { input: "These #* #*** are also not mentions", expected: "

These #* #*** are also not mentions

", }, { input: "This is a #**Denmark** stream link", expected: '

This is a #Denmark stream link

', }, { input: "This is #**Denmark** and #**social** stream links", expected: '

This is #Denmark and #social stream links

', }, { input: "And this is a #**wrong** stream link", expected: "

And this is a #**wrong** stream link

", }, { input: "This is a #**Denmark>some topic** stream_topic link", expected: '

This is a #Denmark > some topic stream_topic link

', }, { input: "This has two links: #**Denmark>some topic** and #**social>other topic**.", expected: '

This has two links: #Denmark > some topic and #social > other topic.

', }, { input: "This is not a #**Denmark>** stream_topic link", expected: "

This is not a #**Denmark>** stream_topic link

", }, { input: "mmm...:burrito:s", expected: '

mmm...:burrito:s

', }, { input: "This is an :poop: message", expected: '

This is an :poop: message

', }, { input: "\uD83D\uDCA9", expected: '

:poop:

', }, { input: "Silent mention: @_**Cordelia, Lear's daughter**", expected: '

Silent mention: Cordelia, Lear's daughter

', }, { input: "> Mention in quote: @**Cordelia, Lear's daughter**\n\nMention outside quote: @**Cordelia, Lear's daughter**", expected: '
\n

Mention in quote: Cordelia, Lear's daughter

\n
\n

Mention outside quote: @Cordelia, Lear's daughter

', }, { input: "Wildcard mention: @**all**\nWildcard silent mention: @_**all**", expected: '

Wildcard mention: @all
\nWildcard silent mention: all

', }, { input: "> Wildcard mention in quote: @**all**\n\n> Another wildcard mention in quote: @_**all**", expected: '
\n

Wildcard mention in quote: all

\n
\n
\n

Another wildcard mention in quote: all

\n
', }, { input: "```quote\nWildcard mention in quote: @**all**\n```\n\n```quote\nAnother wildcard mention in quote: @_**all**\n```", expected: '
\n

Wildcard mention in quote: all

\n
\n
\n

Another wildcard mention in quote: all

\n
', }, { input: "User group mention: @*backend*\nUser group silent mention: @_*hamletcharacters*", expected: '

User group mention: @Backend
\nUser group silent mention: hamletcharacters

', }, { input: "> User group mention in quote: @*backend*\n\n> Another user group mention in quote: @*hamletcharacters*", expected: '
\n

User group mention in quote: Backend

\n
\n
\n

Another user group mention in quote: hamletcharacters

\n
', }, { input: "```quote\nUser group mention in quote: @*backend*\n```\n\n```quote\nAnother user group mention in quote: @*hamletcharacters*\n```", expected: '
\n

User group mention in quote: Backend

\n
\n
\n

Another user group mention in quote: hamletcharacters

\n
', }, // Test only those linkifiers which don't return True for // `contains_backend_only_syntax()`. Those which return True // are tested separately. { input: "This is a linkifier #1234 with text after it", expected: '

This is a linkifier #1234 with text after it

', }, {input: "#1234is not a linkifier.", expected: "

#1234is not a linkifier.

"}, { input: "A pattern written as #1234is not a linkifier.", expected: "

A pattern written as #1234is not a linkifier.

", }, { input: "This is a linkifier with ZGROUP_123:45 groups", expected: '

This is a linkifier with ZGROUP_123:45 groups

', }, {input: "Test *italic*", expected: "

Test italic

"}, { input: "T\n#**Denmark**", expected: '

T
\n#Denmark

', }, { input: "T\n@**Cordelia, Lear's daughter**", expected: '

T
\n@Cordelia, Lear's daughter

', }, { input: "@**Mark Twin|104** and @**Mark Twin|105** are out to confuse you.", expected: '

@Mark Twin and @Mark Twin are out to confuse you.

', }, {input: "@**Invalid User|1234**", expected: "

@**Invalid User|1234**

"}, { input: "@**Cordelia, Lear's daughter|103** has a wrong user_id.", expected: "

@**Cordelia, Lear's daughter|103** has a wrong user_id.

", }, { input: "@**Brother of Bobby|123** is really the full name.", expected: '

@Brother of Bobby|123 is really the full name.

', }, { input: "@**Brother of Bobby|123|106**", expected: '

@Brother of Bobby|123

', }, { input: "@**|106** valid user id.", expected: '

@Brother of Bobby|123 valid user id.

', }, { input: "@**|123|106** comes under user|id case.", expected: "

@**|123|106** comes under user|id case.

", }, {input: "@**|1234** invalid id.", expected: "

@**|1234** invalid id.

"}, {input: "T\n@hamletcharacters", expected: "

T
\n@hamletcharacters

"}, { input: "T\n@*hamletcharacters*", expected: '

T
\n@hamletcharacters

', }, {input: "T\n@*notagroup*", expected: "

T
\n@*notagroup*

"}, { input: "T\n@*backend*", expected: '

T
\n@Backend

', }, {input: "@*notagroup*", expected: "

@*notagroup*

"}, { input: "This is a linkifier `hello` with text after it", expected: "

This is a linkifier hello with text after it

", }, // Test the emoticon conversion {input: ":)", expected: "

:)

"}, { input: ":)", expected: '

:smile:

', translate_emoticons: true, }, // Test HTML escaping in custom Zulip rules { input: "@**

The Rogue One

**", expected: "

@**<h1>The Rogue One</h1>**

", }, { input: "#**

The Rogue One

**", expected: "

#**<h1>The Rogue One</h1>**

", }, { input: ":

The Rogue One

:", expected: "

:<h1>The Rogue One</h1>:

", }, {input: "@**O'Connell**", expected: "

@**O'Connell**

"}, { input: "@*Bobby

Tables

*", expected: '

@Bobby <h1>Tables</h1>

', }, { input: "@*& & &amp;*", expected: '

@& & &amp;

', }, { input: "@**Bobby

Tables

**", expected: '

@Bobby <h1>Tables</h1>

', }, { input: "@**& & &amp;**", expected: '

@& & &amp;

', }, { input: "#**Bobby

Tables

**", expected: '

#Bobby <h1 > Tables</h1>

', }, { input: "#**& & &amp;**", expected: '

#& & &amp;

', }, { input: "#**& & &amp;>& & &amp;**", expected: '

#& & &amp; > & & &amp;

', }, ]; for (const test_case of test_cases) { // Disable emoji conversion by default. user_settings.translate_emoticons = test_case.translate_emoticons || false; const input = test_case.input; const expected = test_case.expected; const message = {raw_content: input}; markdown.apply_markdown(message); const output = message.content; assert.equal(output, expected); } }); test("topic_links", () => { let message = {type: "stream", topic: "No links here"}; markdown.add_topic_links(message); assert.equal(message.topic_links.length, 0); message = {type: "stream", topic: "One #123 link here"}; markdown.add_topic_links(message); assert.equal(message.topic_links.length, 1); assert.deepEqual(message.topic_links[0], { url: "https://trac.example.com/ticket/123", text: "#123", }); message = {type: "stream", topic: "Two #123 #456 link here"}; markdown.add_topic_links(message); assert.equal(message.topic_links.length, 2); assert.deepEqual(message.topic_links[0], { url: "https://trac.example.com/ticket/123", text: "#123", }); assert.deepEqual(message.topic_links[1], { url: "https://trac.example.com/ticket/456", text: "#456", }); message = {type: "stream", topic: "New ZBUG_123 link here"}; markdown.add_topic_links(message); assert.equal(message.topic_links.length, 1); assert.deepEqual(message.topic_links[0], { url: "https://trac2.zulip.net/ticket/123", text: "ZBUG_123", }); message = {type: "stream", topic: "New ZBUG_123 with #456 link here"}; markdown.add_topic_links(message); assert.equal(message.topic_links.length, 2); assert.deepEqual(message.topic_links[0], { url: "https://trac2.zulip.net/ticket/123", text: "ZBUG_123", }); assert.deepEqual(message.topic_links[1], { url: "https://trac.example.com/ticket/456", text: "#456", }); message = {type: "stream", topic: "One ZGROUP_123:45 link here"}; markdown.add_topic_links(message); assert.equal(message.topic_links.length, 1); assert.deepEqual(message.topic_links[0], { url: "https://zone_45.zulip.net/ticket/123", text: "ZGROUP_123:45", }); message = {type: "stream", topic: "Hello https://google.com"}; markdown.add_topic_links(message); assert.equal(message.topic_links.length, 1); assert.deepEqual(message.topic_links[0], { url: "https://google.com", text: "https://google.com", }); message = {type: "stream", topic: "#456 https://google.com https://github.com"}; markdown.add_topic_links(message); assert.equal(message.topic_links.length, 3); assert.deepEqual(message.topic_links[0], { url: "https://trac.example.com/ticket/456", text: "#456", }); assert.deepEqual(message.topic_links[1], { url: "https://google.com", text: "https://google.com", }); assert.deepEqual(message.topic_links[2], { url: "https://github.com", text: "https://github.com", }); message = {type: "not-stream"}; markdown.add_topic_links(message); assert.equal(message.topic_links.length, 0); }); test("message_flags", () => { let input = "/me is testing this"; let message = {topic: "No links here", raw_content: input}; markdown.apply_markdown(message); assert.equal(message.is_me_message, true); assert.ok(!message.unread); input = "/me is testing\nthis"; message = {topic: "No links here", raw_content: input}; markdown.apply_markdown(message); assert.equal(message.is_me_message, true); input = "testing this @**all** @**Cordelia, Lear's daughter**"; message = {topic: "No links here", raw_content: input}; markdown.apply_markdown(message); assert.equal(message.is_me_message, false); assert.equal(message.mentioned, true); assert.equal(message.mentioned_me_directly, true); input = "test @**everyone**"; message = {topic: "No links here", raw_content: input}; markdown.apply_markdown(message); assert.equal(message.is_me_message, false); assert.equal(message.mentioned, true); assert.equal(message.mentioned_me_directly, false); input = "test @**stream**"; message = {topic: "No links here", raw_content: input}; markdown.apply_markdown(message); assert.equal(message.is_me_message, false); assert.equal(message.mentioned, true); assert.equal(message.mentioned_me_directly, false); input = "test @all"; message = {topic: "No links here", raw_content: input}; markdown.apply_markdown(message); assert.equal(message.mentioned, false); input = "test @everyone"; message = {topic: "No links here", raw_content: input}; markdown.apply_markdown(message); assert.equal(message.mentioned, false); input = "test @any"; message = {topic: "No links here", raw_content: input}; markdown.apply_markdown(message); assert.equal(message.mentioned, false); input = "test @alleycat.com"; message = {topic: "No links here", raw_content: input}; markdown.apply_markdown(message); assert.equal(message.mentioned, false); input = "test @*hamletcharacters*"; message = {topic: "No links here", raw_content: input}; markdown.apply_markdown(message); assert.equal(message.mentioned, true); input = "test @*backend*"; message = {topic: "No links here", raw_content: input}; markdown.apply_markdown(message); assert.equal(message.mentioned, false); input = "test @**invalid_user**"; message = {topic: "No links here", raw_content: input}; markdown.apply_markdown(message); assert.equal(message.mentioned, false); input = "test @_**all**"; message = {topic: "No links here", raw_content: input}; markdown.apply_markdown(message); assert.equal(message.mentioned, false); input = "> test @**all**"; message = {topic: "No links here", raw_content: input}; markdown.apply_markdown(message); assert.equal(message.mentioned, false); input = "test @_*hamletcharacters*"; message = {topic: "No links here", raw_content: input}; markdown.apply_markdown(message); assert.equal(message.mentioned, false); input = "> test @*hamletcharacters*"; message = {topic: "No links here", raw_content: input}; markdown.apply_markdown(message); assert.equal(message.mentioned, false); }); test("backend_only_linkifiers", () => { const backend_only_linkifiers = [ "Here is the PR-#123.", "Function abc() was introduced in (PR)#123.", ]; for (const content of backend_only_linkifiers) { assert.equal(markdown.contains_backend_only_syntax(content), true); } }); test("translate_emoticons_to_names", () => { // Simple test const test_text = "Testing :)"; const expected = "Testing :smile:"; const result = markdown.translate_emoticons_to_names(test_text); assert.equal(result, expected); // Extensive tests. // The following code loops over the test cases and each emoticon conversion // to generate multiple test cases. for (const [shortcut, full_name] of Object.entries(emoji_codes.emoticon_conversions)) { for (const {original, expected} of [ {name: `only emoticon`, original: shortcut, expected: full_name}, {name: `space at start`, original: ` ${shortcut}`, expected: ` ${full_name}`}, {name: `space at end`, original: `${shortcut} `, expected: `${full_name} `}, {name: `symbol at end`, original: `${shortcut}!`, expected: `${full_name}!`}, { name: `symbol at start`, original: `Hello,${shortcut}`, expected: `Hello,${full_name}`, }, {name: `after a word`, original: `Hello${shortcut}`, expected: `Hello${shortcut}`}, { name: `between words`, original: `Hello${shortcut}World`, expected: `Hello${shortcut}World`, }, { name: `end of sentence`, original: `End of sentence. ${shortcut}`, expected: `End of sentence. ${full_name}`, }, { name: `between symbols`, original: `Hello.${shortcut}! World.`, expected: `Hello.${shortcut}! World.`, }, { name: `before end of sentence`, original: `Hello ${shortcut}!`, expected: `Hello ${full_name}!`, }, ]) { const result = markdown.translate_emoticons_to_names(original); assert.equal(result, expected); } } }); test("missing unicode emojis", ({override_rewire}) => { const message = {raw_content: "\u{1F6B2}"}; markdown.apply_markdown(message); assert.equal( message.content, '

:bike:

', ); override_rewire(emoji, "get_emoji_name", (codepoint) => { // Now simulate that we don't know any emoji names. assert.equal(codepoint, "1f6b2"); // return undefined }); markdown.apply_markdown(message); assert.equal(message.content, "

\u{1F6B2}

"); }); test("katex_throws_unexpected_exceptions", () => { blueslip.expect("error", "Error: some-exception"); const message = {raw_content: "$$a$$"}; with_field_rewire( markdown, "katex", { renderToString: () => { throw new Error("some-exception"); }, }, () => { markdown.apply_markdown(message); }, ); });