573 lines
23 KiB
TypeScript
573 lines
23 KiB
TypeScript
import { expect } from 'chai'
|
|
import Long from 'long'
|
|
import { describe, it } from 'mocha'
|
|
|
|
import { MessageEntity, TextWithEntities, tl } from '@mtcute/client'
|
|
|
|
// prettier has "html" special-cased which breaks the formatting
|
|
// this is not an issue when using normally, since we properly handle newlines/spaces,
|
|
// but here we want to test everything as it is
|
|
import { html as htm, HtmlUnparseOptions } from '../src/index.js'
|
|
|
|
const createEntity = <T extends tl.TypeMessageEntity['_']>(
|
|
type: T,
|
|
offset: number,
|
|
length: number,
|
|
additional?: Omit<tl.FindByName<tl.TypeMessageEntity, T>, '_' | 'offset' | 'length'>,
|
|
): tl.TypeMessageEntity => {
|
|
return {
|
|
_: type,
|
|
offset,
|
|
length,
|
|
...(additional ?? {}),
|
|
} as tl.TypeMessageEntity
|
|
}
|
|
|
|
describe('HtmlMessageEntityParser', () => {
|
|
describe('unparse', () => {
|
|
const test = (
|
|
text: string,
|
|
entities: tl.TypeMessageEntity[],
|
|
expected: string,
|
|
params?: HtmlUnparseOptions,
|
|
): void => {
|
|
expect(htm.unparse({ text, entities }, params)).eq(expected)
|
|
}
|
|
|
|
it('should return the same text if there are no entities or text', () => {
|
|
test('', [], '')
|
|
test('some text', [], 'some text')
|
|
})
|
|
|
|
it('should handle <b>, <i>, <u>, <s> tags', () => {
|
|
test(
|
|
'plain bold italic underline strikethrough plain',
|
|
[
|
|
createEntity('messageEntityBold', 6, 4),
|
|
createEntity('messageEntityItalic', 11, 6),
|
|
createEntity('messageEntityUnderline', 18, 9),
|
|
createEntity('messageEntityStrike', 28, 13),
|
|
],
|
|
'plain <b>bold</b> <i>italic</i> <u>underline</u> <s>strikethrough</s> plain',
|
|
)
|
|
})
|
|
|
|
it('should handle <code>, <pre>, <blockquote>, <spoiler> tags', () => {
|
|
test(
|
|
'plain code pre blockquote spoiler plain',
|
|
[
|
|
createEntity('messageEntityCode', 6, 4),
|
|
createEntity('messageEntityPre', 11, 3),
|
|
createEntity('messageEntityBlockquote', 15, 10),
|
|
createEntity('messageEntitySpoiler', 26, 7),
|
|
],
|
|
'plain <code>code</code> <pre>pre</pre> <blockquote>blockquote</blockquote> <spoiler>spoiler</spoiler> plain',
|
|
)
|
|
})
|
|
|
|
it('should handle links and text mentions', () => {
|
|
test(
|
|
'plain https://google.com google @durov Pavel Durov mail@mail.ru plain',
|
|
[
|
|
createEntity('messageEntityUrl', 6, 18),
|
|
createEntity('messageEntityTextUrl', 25, 6, {
|
|
url: 'https://google.com',
|
|
}),
|
|
createEntity('messageEntityMention', 32, 6),
|
|
createEntity('messageEntityMentionName', 39, 11, {
|
|
userId: 36265675,
|
|
}),
|
|
createEntity('messageEntityEmail', 51, 12),
|
|
],
|
|
'plain <a href="https://google.com">https://google.com</a> <a href="https://google.com">google</a> @durov <a href="tg://user?id=36265675">Pavel Durov</a> <a href="mailto:mail@mail.ru">mail@mail.ru</a> plain',
|
|
)
|
|
})
|
|
|
|
it('should handle language in <pre>', () => {
|
|
test(
|
|
'plain console.log("Hello, world!") some code plain',
|
|
[
|
|
createEntity('messageEntityPre', 6, 28, {
|
|
language: 'javascript',
|
|
}),
|
|
createEntity('messageEntityPre', 35, 9, { language: '' }),
|
|
],
|
|
'plain <pre language="javascript">console.log("Hello, world!")</pre> <pre>some code</pre> plain',
|
|
)
|
|
})
|
|
|
|
it('should support entities on the edges', () => {
|
|
test(
|
|
'Hello, world',
|
|
[createEntity('messageEntityBold', 0, 5), createEntity('messageEntityBold', 7, 5)],
|
|
'<b>Hello</b>, <b>world</b>',
|
|
)
|
|
})
|
|
|
|
it('should clamp out-of-range entities', () => {
|
|
test(
|
|
'Hello, world',
|
|
[createEntity('messageEntityBold', -2, 7), createEntity('messageEntityBold', 7, 10)],
|
|
'<b>Hello</b>, <b>world</b>',
|
|
)
|
|
})
|
|
|
|
it('should ignore entities outside the length', () => {
|
|
test('Hello, world', [createEntity('messageEntityBold', 50, 5)], 'Hello, world')
|
|
})
|
|
|
|
it('should support entities followed by each other', () => {
|
|
test(
|
|
'plain Hello, world plain',
|
|
[createEntity('messageEntityBold', 6, 6), createEntity('messageEntityItalic', 12, 6)],
|
|
'plain <b>Hello,</b><i> world</i> plain',
|
|
)
|
|
})
|
|
|
|
it('should support nested entities', () => {
|
|
test(
|
|
'Welcome to the gym zone!',
|
|
[createEntity('messageEntityItalic', 0, 24), createEntity('messageEntityBold', 15, 8)],
|
|
'<i>Welcome to the <b>gym zone</b>!</i>',
|
|
)
|
|
})
|
|
|
|
it('should support nested entities with the same edges', () => {
|
|
test(
|
|
'Welcome to the gym zone!',
|
|
[createEntity('messageEntityItalic', 0, 24), createEntity('messageEntityBold', 15, 9)],
|
|
'<i>Welcome to the <b>gym zone!</b></i>',
|
|
)
|
|
test(
|
|
'Welcome to the gym zone!',
|
|
[createEntity('messageEntityBold', 0, 24), createEntity('messageEntityItalic', 15, 9)],
|
|
'<b>Welcome to the <i>gym zone!</i></b>',
|
|
)
|
|
test(
|
|
'Welcome to the gym zone!',
|
|
[createEntity('messageEntityItalic', 0, 24), createEntity('messageEntityBold', 0, 7)],
|
|
'<i><b>Welcome</b> to the gym zone!</i>',
|
|
)
|
|
test(
|
|
'Welcome to the gym zone!',
|
|
[createEntity('messageEntityItalic', 0, 24), createEntity('messageEntityBold', 0, 24)],
|
|
'<i><b>Welcome to the gym zone!</b></i>',
|
|
)
|
|
})
|
|
|
|
it('should support overlapping entities', () => {
|
|
test(
|
|
'Welcome to the gym zone!',
|
|
[createEntity('messageEntityItalic', 0, 14), createEntity('messageEntityBold', 8, 10)],
|
|
'<i>Welcome <b>to the</b></i><b> gym</b> zone!',
|
|
)
|
|
test(
|
|
'plain bold bold-italic bold-italic-underline underline plain',
|
|
[
|
|
createEntity('messageEntityBold', 6, 38),
|
|
createEntity('messageEntityItalic', 11, 33),
|
|
createEntity('messageEntityUnderline', 23, 31),
|
|
],
|
|
'plain <b>bold <i>bold-italic <u>bold-italic-underline</u></i></b><u> underline</u> plain',
|
|
)
|
|
test(
|
|
'plain bold bold-italic bold-italic-underline italic-underline underline plain',
|
|
[
|
|
createEntity('messageEntityBold', 6, 38),
|
|
createEntity('messageEntityItalic', 11, 50),
|
|
createEntity('messageEntityUnderline', 23, 48),
|
|
],
|
|
// not the most efficient way (in the second part we could do <u><i>...</i>...</u>), but whatever
|
|
'plain <b>bold <i>bold-italic <u>bold-italic-underline</u></i></b><i><u> italic-underline</u></i><u> underline</u> plain',
|
|
)
|
|
})
|
|
|
|
it('should properly handle emojis', () => {
|
|
test(
|
|
"best flower: 🌸. don't you even doubt it.",
|
|
[
|
|
createEntity('messageEntityItalic', 0, 11),
|
|
createEntity('messageEntityBold', 13, 2),
|
|
createEntity('messageEntityItalic', 17, 5),
|
|
],
|
|
"<i>best flower</i>: <b>🌸</b>. <i>don't</i> you even doubt it.",
|
|
)
|
|
})
|
|
|
|
it('should escape special symbols', () => {
|
|
test(
|
|
'<&> < & > <&>',
|
|
[createEntity('messageEntityBold', 4, 5)],
|
|
'<&> <b>< & ></b> <&>',
|
|
)
|
|
})
|
|
|
|
it('should work with custom syntax highlighter', () => {
|
|
test(
|
|
'plain console.log("Hello, world!") some code plain',
|
|
[
|
|
createEntity('messageEntityPre', 6, 28, {
|
|
language: 'javascript',
|
|
}),
|
|
createEntity('messageEntityPre', 35, 9, { language: '' }),
|
|
],
|
|
'plain <pre language="javascript">lang: <b>javascript</b><br>console.log("Hello, world!")</pre> <pre>some code</pre> plain',
|
|
{
|
|
syntaxHighlighter: (code, lang) => `lang: <b>${lang}</b><br>${code}`,
|
|
},
|
|
)
|
|
})
|
|
|
|
it('should replace newlines with <br> outside pre', () => {
|
|
test('plain\n\nplain', [], 'plain<br><br>plain')
|
|
test('plain\n\nplain', [createEntity('messageEntityBold', 0, 12)], '<b>plain<br><br>plain</b>')
|
|
test('plain\n\nplain', [createEntity('messageEntityPre', 0, 12)], '<pre>plain\n\nplain</pre>')
|
|
})
|
|
|
|
it('should replace multiple spaces with ', () => {
|
|
test('plain plain', [], 'plain plain')
|
|
})
|
|
})
|
|
|
|
describe('parse', () => {
|
|
const test = (text: TextWithEntities, expectedEntities: tl.TypeMessageEntity[], expectedText: string): void => {
|
|
expect(text.text).eql(expectedText)
|
|
expect(text.entities ?? []).eql(expectedEntities)
|
|
}
|
|
|
|
it('should handle <b>, <i>, <u>, <s> tags', () => {
|
|
test(
|
|
htm`plain <b>bold</b> <i>italic</i> <u>underline</u> <s>strikethrough</s> plain`,
|
|
[
|
|
createEntity('messageEntityBold', 6, 4),
|
|
createEntity('messageEntityItalic', 11, 6),
|
|
createEntity('messageEntityUnderline', 18, 9),
|
|
createEntity('messageEntityStrike', 28, 13),
|
|
],
|
|
'plain bold italic underline strikethrough plain',
|
|
)
|
|
})
|
|
|
|
it('should handle <code>, <pre>, <blockquote>, <spoiler> tags', () => {
|
|
test(
|
|
htm`plain <code>code</code> <pre>pre</pre> <blockquote>blockquote</blockquote> <spoiler>spoiler</spoiler> plain`,
|
|
[
|
|
createEntity('messageEntityCode', 6, 4),
|
|
createEntity('messageEntityPre', 11, 3, { language: '' }),
|
|
createEntity('messageEntityBlockquote', 15, 10),
|
|
createEntity('messageEntitySpoiler', 26, 7),
|
|
],
|
|
'plain code pre blockquote spoiler plain',
|
|
)
|
|
})
|
|
|
|
it('should handle links and text mentions', () => {
|
|
test(
|
|
htm`plain https://google.com <a href="https://google.com">google</a> @durov <a href="tg://user?id=36265675">Pavel Durov</a> plain`,
|
|
[
|
|
createEntity('messageEntityTextUrl', 25, 6, {
|
|
url: 'https://google.com',
|
|
}),
|
|
createEntity('messageEntityMentionName', 39, 11, {
|
|
userId: 36265675,
|
|
}),
|
|
],
|
|
'plain https://google.com google @durov Pavel Durov plain',
|
|
)
|
|
|
|
test(
|
|
htm`<a href="tg://user?id=1234567&hash=aabbccddaabbccdd">user</a>`,
|
|
[
|
|
createEntity('inputMessageEntityMentionName', 0, 4, {
|
|
userId: {
|
|
_: 'inputUser',
|
|
userId: 1234567,
|
|
accessHash: Long.fromString('aabbccddaabbccdd', 16),
|
|
},
|
|
}),
|
|
],
|
|
'user',
|
|
)
|
|
})
|
|
|
|
it('should handle language in <pre>', () => {
|
|
test(
|
|
htm`plain <pre language="javascript">console.log("Hello, world!")</pre> <pre>some code</pre> plain`,
|
|
[
|
|
createEntity('messageEntityPre', 6, 28, {
|
|
language: 'javascript',
|
|
}),
|
|
createEntity('messageEntityPre', 35, 9, { language: '' }),
|
|
],
|
|
'plain console.log("Hello, world!") some code plain',
|
|
)
|
|
})
|
|
|
|
it('should ignore other tags inside <pre>', () => {
|
|
test(
|
|
htm`<pre><b>bold</b> and not bold</pre>`,
|
|
[createEntity('messageEntityPre', 0, 17, { language: '' })],
|
|
'bold and not bold',
|
|
)
|
|
test(
|
|
htm`<pre><pre>pre inside pre</pre> so cool</pre>`,
|
|
[createEntity('messageEntityPre', 0, 22, { language: '' })],
|
|
'pre inside pre so cool',
|
|
)
|
|
})
|
|
|
|
it('should ignore newlines and indentation', () => {
|
|
test(htm`this is some text\n\nwith newlines`, [], 'this is some text with newlines')
|
|
test(
|
|
htm`<b>this is some text\n\nwith</b> newlines`,
|
|
[createEntity('messageEntityBold', 0, 22)],
|
|
'this is some text with newlines',
|
|
)
|
|
test(
|
|
htm`<b>this is some text ending with\n\n</b> newlines`,
|
|
[createEntity('messageEntityBold', 0, 29)],
|
|
'this is some text ending with newlines',
|
|
)
|
|
test(
|
|
htm`
|
|
this is some indented text
|
|
with newlines and
|
|
<b>
|
|
indented tags
|
|
</b> yeah <i>so cool
|
|
</i>
|
|
`,
|
|
[createEntity('messageEntityBold', 45, 13), createEntity('messageEntityItalic', 64, 7)],
|
|
'this is some indented text with newlines and indented tags yeah so cool',
|
|
)
|
|
})
|
|
|
|
it('should not ignore newlines and indentation in pre', () => {
|
|
test(
|
|
htm`<pre>this is some text\n\nwith newlines</pre>`,
|
|
[createEntity('messageEntityPre', 0, 32, { language: '' })],
|
|
'this is some text\n\nwith newlines',
|
|
)
|
|
|
|
// fuck my life
|
|
const indent = ' '
|
|
test(
|
|
htm`<pre>
|
|
this is some indented text
|
|
with newlines and
|
|
<b>
|
|
indented tags
|
|
</b> yeah <i>so cool
|
|
</i>
|
|
</pre>`,
|
|
[createEntity('messageEntityPre', 0, 203, { language: '' })],
|
|
'\n' +
|
|
indent +
|
|
'this is some indented text\n' +
|
|
indent +
|
|
'with newlines and\n' +
|
|
indent +
|
|
'\n' +
|
|
indent +
|
|
' indented tags\n' +
|
|
indent +
|
|
' yeah so cool\n' +
|
|
indent +
|
|
'\n' +
|
|
indent,
|
|
)
|
|
})
|
|
|
|
it('should handle <br>', () => {
|
|
test(htm`this is some text<br><br>with actual newlines`, [], 'this is some text\n\nwith actual newlines')
|
|
test(
|
|
htm`<b>this is some text<br><br></b>with actual newlines`,
|
|
// note that the <br> (i.e. \n) is not included in the entity
|
|
// this is expected, and the result is the same
|
|
[createEntity('messageEntityBold', 0, 17)],
|
|
'this is some text\n\nwith actual newlines',
|
|
)
|
|
})
|
|
|
|
it('should handle ', () => {
|
|
test(
|
|
htm`one space, many spaces, and<br>a newline`,
|
|
[],
|
|
'one space, many spaces, and\na newline',
|
|
)
|
|
})
|
|
|
|
it('should support entities on the edges', () => {
|
|
test(
|
|
htm`<b>Hello</b>, <b>world</b>`,
|
|
[createEntity('messageEntityBold', 0, 5), createEntity('messageEntityBold', 7, 5)],
|
|
'Hello, world',
|
|
)
|
|
})
|
|
|
|
it('should return empty array if there are no entities', () => {
|
|
test(htm`Hello, world`, [], 'Hello, world')
|
|
})
|
|
|
|
it('should support entities followed by each other', () => {
|
|
test(
|
|
htm`plain <b>Hello,</b><i> world</i> plain`,
|
|
[createEntity('messageEntityBold', 6, 6), createEntity('messageEntityItalic', 12, 6)],
|
|
'plain Hello, world plain',
|
|
)
|
|
})
|
|
|
|
it('should support nested entities', () => {
|
|
test(
|
|
htm`<i>Welcome to the <b>gym zone</b>!</i>`,
|
|
[createEntity('messageEntityBold', 15, 8), createEntity('messageEntityItalic', 0, 24)],
|
|
'Welcome to the gym zone!',
|
|
)
|
|
})
|
|
|
|
it('should support nested entities with the same edges', () => {
|
|
test(
|
|
htm`<i>Welcome to the <b>gym zone!</b></i>`,
|
|
[createEntity('messageEntityBold', 15, 9), createEntity('messageEntityItalic', 0, 24)],
|
|
'Welcome to the gym zone!',
|
|
)
|
|
test(
|
|
htm`<b>Welcome to the <i>gym zone!</i></b>`,
|
|
[createEntity('messageEntityItalic', 15, 9), createEntity('messageEntityBold', 0, 24)],
|
|
'Welcome to the gym zone!',
|
|
)
|
|
test(
|
|
htm`<i><b>Welcome</b> to the gym zone!</i>`,
|
|
[createEntity('messageEntityBold', 0, 7), createEntity('messageEntityItalic', 0, 24)],
|
|
'Welcome to the gym zone!',
|
|
)
|
|
test(
|
|
htm`<i><b>Welcome to the gym zone!</b></i>`,
|
|
[createEntity('messageEntityBold', 0, 24), createEntity('messageEntityItalic', 0, 24)],
|
|
'Welcome to the gym zone!',
|
|
)
|
|
})
|
|
|
|
it('should properly handle emojis', () => {
|
|
test(
|
|
htm`<i>best flower</i>: <b>🌸</b>. <i>don't</i> you even doubt it.`,
|
|
[
|
|
createEntity('messageEntityItalic', 0, 11),
|
|
createEntity('messageEntityBold', 13, 2),
|
|
createEntity('messageEntityItalic', 17, 5),
|
|
],
|
|
"best flower: 🌸. don't you even doubt it.",
|
|
)
|
|
})
|
|
|
|
it('should handle non-escaped special symbols', () => {
|
|
test(htm`<&> <b>< & ></b> <&>`, [createEntity('messageEntityBold', 4, 5)], '<&> < & > <&>')
|
|
})
|
|
|
|
it('should unescape special symbols', () => {
|
|
test(
|
|
htm`<&> <b>< & ></b> <&> <a href="/?a="hello"&b">link</a>`,
|
|
[
|
|
createEntity('messageEntityBold', 4, 5),
|
|
createEntity('messageEntityTextUrl', 14, 4, {
|
|
url: '/?a="hello"&b',
|
|
}),
|
|
],
|
|
'<&> < & > <&> link',
|
|
)
|
|
})
|
|
|
|
it('should ignore other tags', () => {
|
|
test(htm`<script>alert(1)</script>`, [], 'alert(1)')
|
|
})
|
|
|
|
it('should ignore empty urls', () => {
|
|
test(htm`<a href="">link</a> <a>link</a>`, [], 'link link')
|
|
})
|
|
|
|
describe('template', () => {
|
|
it('should add plain strings as is', () => {
|
|
test(
|
|
htm`some text ${'<b>not bold yea</b>'} some more text`,
|
|
[],
|
|
'some text <b>not bold yea</b> some more text',
|
|
)
|
|
})
|
|
|
|
it('should skip falsy values', () => {
|
|
test(htm`some text ${null} some ${false} more text`, [], 'some text some more text')
|
|
})
|
|
|
|
it('should process entities', () => {
|
|
const inner = htm`<b>bold</b>`
|
|
test(
|
|
htm`some text ${inner} some more text`,
|
|
[createEntity('messageEntityBold', 10, 4)],
|
|
'some text bold some more text',
|
|
)
|
|
test(
|
|
htm`some text ${inner} some more ${inner} text`,
|
|
[createEntity('messageEntityBold', 10, 4), createEntity('messageEntityBold', 25, 4)],
|
|
'some text bold some more bold text',
|
|
)
|
|
})
|
|
|
|
it('should process entities on edges', () => {
|
|
test(
|
|
htm`${htm`<b>bold</b>`} and ${htm`<i>italic</i>`}`,
|
|
[createEntity('messageEntityBold', 0, 4), createEntity('messageEntityItalic', 9, 6)],
|
|
'bold and italic',
|
|
)
|
|
})
|
|
|
|
it('should process nested entities', () => {
|
|
test(
|
|
htm`<b>bold ${htm`<i>bold italic</i>`} more bold</b>`,
|
|
[createEntity('messageEntityItalic', 5, 11), createEntity('messageEntityBold', 0, 26)],
|
|
'bold bold italic more bold',
|
|
)
|
|
test(
|
|
htm`<b>bold ${htm`<i>bold italic</i> <u>and some underline</u>`} more bold</b>`,
|
|
[
|
|
createEntity('messageEntityItalic', 5, 11),
|
|
createEntity('messageEntityUnderline', 17, 18),
|
|
createEntity('messageEntityBold', 0, 45),
|
|
],
|
|
'bold bold italic and some underline more bold',
|
|
)
|
|
test(
|
|
htm`<b>${htm`<i>bold italic <u>underline</u></i>`}</b>`,
|
|
[
|
|
createEntity('messageEntityUnderline', 12, 9),
|
|
createEntity('messageEntityItalic', 0, 21),
|
|
createEntity('messageEntityBold', 0, 21),
|
|
],
|
|
'bold italic underline',
|
|
)
|
|
})
|
|
|
|
it('should process MessageEntity', () => {
|
|
test(
|
|
htm`<b>bold ${new MessageEntity(
|
|
createEntity('messageEntityItalic', 0, 11),
|
|
'bold italic',
|
|
)} more bold</b>`,
|
|
[createEntity('messageEntityItalic', 5, 11), createEntity('messageEntityBold', 0, 26)],
|
|
'bold bold italic more bold',
|
|
)
|
|
})
|
|
|
|
it('should support simple function usage', () => {
|
|
// assuming we are receiving it e.g. from a server
|
|
const someHtml = '<b>bold</b>'
|
|
|
|
test(htm(someHtml), [createEntity('messageEntityBold', 0, 4)], 'bold')
|
|
test(
|
|
htm`text ${htm(someHtml)} more text`,
|
|
[createEntity('messageEntityBold', 5, 4)],
|
|
'text bold more text',
|
|
)
|
|
})
|
|
})
|
|
})
|
|
})
|