debian-mirror-gitlab/spec/frontend/emoji/index_spec.js

635 lines
16 KiB
JavaScript
Raw Normal View History

2021-03-11 19:13:27 +05:30
import { emojiFixtureMap, mockEmojiData, initEmojiMock } from 'helpers/emoji';
2020-10-24 23:57:45 +05:30
import { trimText } from 'helpers/text_helper';
2021-03-11 19:13:27 +05:30
import { glEmojiTag, searchEmoji, getEmojiInfo, sortEmoji } from '~/emoji';
2017-09-10 17:25:29 +05:30
import isEmojiUnicodeSupported, {
2017-08-17 22:00:37 +05:30
isFlagEmoji,
2018-03-17 18:26:18 +05:30
isRainbowFlagEmoji,
2017-08-17 22:00:37 +05:30
isKeycapEmoji,
isSkinToneComboEmoji,
isHorceRacingSkinToneComboEmoji,
isPersonZwjEmoji,
2017-09-10 17:25:29 +05:30
} from '~/emoji/support/is_emoji_unicode_supported';
2021-11-11 11:23:49 +05:30
import { sanitize } from '~/lib/dompurify';
2017-08-17 22:00:37 +05:30
const emptySupportMap = {
personZwj: false,
horseRacing: false,
flag: false,
skinToneModifier: false,
'9.0': false,
'8.0': false,
'7.0': false,
6.1: false,
'6.0': false,
5.2: false,
5.1: false,
4.1: false,
'4.0': false,
3.2: false,
'3.0': false,
1.1: false,
};
2021-03-11 19:13:27 +05:30
describe('emoji', () => {
2020-07-28 23:09:34 +05:30
let mock;
2017-08-17 22:00:37 +05:30
2021-01-03 14:25:43 +05:30
beforeEach(async () => {
mock = await initEmojiMock();
2020-07-28 23:09:34 +05:30
});
afterEach(() => {
mock.restore();
});
2017-08-17 22:00:37 +05:30
describe('glEmojiTag', () => {
it('bomb emoji', () => {
const emojiKey = 'bomb';
2021-03-11 19:13:27 +05:30
const markup = glEmojiTag(emojiKey);
2017-08-17 22:00:37 +05:30
2020-07-28 23:09:34 +05:30
expect(trimText(markup)).toMatchInlineSnapshot(
`"<gl-emoji data-name=\\"bomb\\"></gl-emoji>"`,
2017-08-17 22:00:37 +05:30
);
});
it('bomb emoji with sprite fallback readiness', () => {
const emojiKey = 'bomb';
2021-03-11 19:13:27 +05:30
const markup = glEmojiTag(emojiKey, {
2017-08-17 22:00:37 +05:30
sprite: true,
});
2020-07-28 23:09:34 +05:30
expect(trimText(markup)).toMatchInlineSnapshot(
`"<gl-emoji data-fallback-sprite-class=\\"emoji-bomb\\" data-name=\\"bomb\\"></gl-emoji>"`,
2017-08-17 22:00:37 +05:30
);
});
});
describe('isFlagEmoji', () => {
2017-09-10 17:25:29 +05:30
it('should gracefully handle empty string', () => {
expect(isFlagEmoji('')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should detect flag_ac', () => {
expect(isFlagEmoji('🇦🇨')).toBeTruthy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should detect flag_us', () => {
expect(isFlagEmoji('🇺🇸')).toBeTruthy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should detect flag_zw', () => {
expect(isFlagEmoji('🇿🇼')).toBeTruthy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should not detect flags', () => {
expect(isFlagEmoji('🎏')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should not detect triangular_flag_on_post', () => {
expect(isFlagEmoji('🚩')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should not detect single letter', () => {
expect(isFlagEmoji('🇦')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should not detect >2 letters', () => {
expect(isFlagEmoji('🇦🇧🇨')).toBeFalsy();
});
});
2018-03-17 18:26:18 +05:30
describe('isRainbowFlagEmoji', () => {
it('should gracefully handle empty string', () => {
expect(isRainbowFlagEmoji('')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2018-03-17 18:26:18 +05:30
it('should detect rainbow_flag', () => {
expect(isRainbowFlagEmoji('🏳🌈')).toBeTruthy();
});
2018-12-13 13:39:08 +05:30
it("should not detect flag_white on its' own", () => {
2018-03-17 18:26:18 +05:30
expect(isRainbowFlagEmoji('🏳')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
it("should not detect rainbow on its' own", () => {
2018-03-17 18:26:18 +05:30
expect(isRainbowFlagEmoji('🌈')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2018-03-17 18:26:18 +05:30
it('should not detect flag_white with something else', () => {
expect(isRainbowFlagEmoji('🏳🔵')).toBeFalsy();
});
});
2017-08-17 22:00:37 +05:30
describe('isKeycapEmoji', () => {
2017-09-10 17:25:29 +05:30
it('should gracefully handle empty string', () => {
expect(isKeycapEmoji('')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should detect one(keycap)', () => {
expect(isKeycapEmoji('1⃣')).toBeTruthy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should detect nine(keycap)', () => {
expect(isKeycapEmoji('9⃣')).toBeTruthy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should not detect ten(keycap)', () => {
expect(isKeycapEmoji('🔟')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should not detect hash(keycap)', () => {
expect(isKeycapEmoji('#⃣')).toBeFalsy();
});
});
describe('isSkinToneComboEmoji', () => {
2017-09-10 17:25:29 +05:30
it('should gracefully handle empty string', () => {
expect(isSkinToneComboEmoji('')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should detect hand_splayed_tone5', () => {
expect(isSkinToneComboEmoji('🖐🏿')).toBeTruthy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should not detect hand_splayed', () => {
expect(isSkinToneComboEmoji('🖐')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should detect lifter_tone1', () => {
expect(isSkinToneComboEmoji('🏋🏻')).toBeTruthy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should not detect lifter', () => {
expect(isSkinToneComboEmoji('🏋')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should detect rowboat_tone4', () => {
expect(isSkinToneComboEmoji('🚣🏾')).toBeTruthy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should not detect rowboat', () => {
expect(isSkinToneComboEmoji('🚣')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should not detect individual tone emoji', () => {
expect(isSkinToneComboEmoji('🏻')).toBeFalsy();
});
});
describe('isHorceRacingSkinToneComboEmoji', () => {
2017-09-10 17:25:29 +05:30
it('should gracefully handle empty string', () => {
expect(isHorceRacingSkinToneComboEmoji('')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should detect horse_racing_tone2', () => {
expect(isHorceRacingSkinToneComboEmoji('🏇🏼')).toBeTruthy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should not detect horse_racing', () => {
expect(isHorceRacingSkinToneComboEmoji('🏇')).toBeFalsy();
});
});
describe('isPersonZwjEmoji', () => {
2017-09-10 17:25:29 +05:30
it('should gracefully handle empty string', () => {
expect(isPersonZwjEmoji('')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should detect couple_mm', () => {
expect(isPersonZwjEmoji('👨‍❤️‍👨')).toBeTruthy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should not detect couple_with_heart', () => {
expect(isPersonZwjEmoji('💑')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should not detect couplekiss', () => {
expect(isPersonZwjEmoji('💏')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should detect family_mmb', () => {
expect(isPersonZwjEmoji('👨‍👨‍👦')).toBeTruthy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should detect family_mwgb', () => {
expect(isPersonZwjEmoji('👨‍👩‍👧‍👦')).toBeTruthy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should not detect family', () => {
expect(isPersonZwjEmoji('👪')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should detect kiss_ww', () => {
expect(isPersonZwjEmoji('👩‍❤️‍💋‍👩')).toBeTruthy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should not detect girl', () => {
expect(isPersonZwjEmoji('👧')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should not detect girl_tone5', () => {
expect(isPersonZwjEmoji('👧🏿')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should not detect man', () => {
expect(isPersonZwjEmoji('👨')).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('should not detect woman', () => {
expect(isPersonZwjEmoji('👩')).toBeFalsy();
});
});
describe('isEmojiUnicodeSupported', () => {
2017-09-10 17:25:29 +05:30
it('should gracefully handle empty string with unicode support', () => {
2018-12-13 13:39:08 +05:30
const isSupported = isEmojiUnicodeSupported({ '1.0': true }, '', '1.0');
2017-09-10 17:25:29 +05:30
expect(isSupported).toBeTruthy();
});
2018-12-13 13:39:08 +05:30
2017-09-10 17:25:29 +05:30
it('should gracefully handle empty string without unicode support', () => {
2018-12-13 13:39:08 +05:30
const isSupported = isEmojiUnicodeSupported({}, '', '1.0');
2017-09-10 17:25:29 +05:30
expect(isSupported).toBeFalsy();
});
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
it('bomb(6.0) with 6.0 support', () => {
const emojiKey = 'bomb';
2020-05-24 23:13:21 +05:30
const unicodeSupportMap = { ...emptySupportMap, '6.0': true };
2017-08-17 22:00:37 +05:30
const isSupported = isEmojiUnicodeSupported(
unicodeSupportMap,
emojiFixtureMap[emojiKey].moji,
emojiFixtureMap[emojiKey].unicodeVersion,
);
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
expect(isSupported).toBeTruthy();
});
it('bomb(6.0) without 6.0 support', () => {
const emojiKey = 'bomb';
const unicodeSupportMap = emptySupportMap;
const isSupported = isEmojiUnicodeSupported(
unicodeSupportMap,
emojiFixtureMap[emojiKey].moji,
emojiFixtureMap[emojiKey].unicodeVersion,
);
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
expect(isSupported).toBeFalsy();
});
it('bomb(6.0) without 6.0 but with 9.0 support', () => {
const emojiKey = 'bomb';
2020-05-24 23:13:21 +05:30
const unicodeSupportMap = { ...emptySupportMap, '9.0': true };
2017-08-17 22:00:37 +05:30
const isSupported = isEmojiUnicodeSupported(
unicodeSupportMap,
emojiFixtureMap[emojiKey].moji,
emojiFixtureMap[emojiKey].unicodeVersion,
);
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
expect(isSupported).toBeFalsy();
});
it('construction_worker_tone5(8.0) without skin tone modifier support', () => {
const emojiKey = 'construction_worker_tone5';
2020-05-24 23:13:21 +05:30
const unicodeSupportMap = {
...emptySupportMap,
2017-08-17 22:00:37 +05:30
skinToneModifier: false,
'9.0': true,
'8.0': true,
'7.0': true,
6.1: true,
'6.0': true,
5.2: true,
5.1: true,
4.1: true,
'4.0': true,
3.2: true,
'3.0': true,
1.1: true,
2020-05-24 23:13:21 +05:30
};
2017-08-17 22:00:37 +05:30
const isSupported = isEmojiUnicodeSupported(
unicodeSupportMap,
emojiFixtureMap[emojiKey].moji,
emojiFixtureMap[emojiKey].unicodeVersion,
);
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
expect(isSupported).toBeFalsy();
});
it('use native keycap on >=57 chrome', () => {
const emojiKey = 'five';
2020-05-24 23:13:21 +05:30
const unicodeSupportMap = {
...emptySupportMap,
2017-08-17 22:00:37 +05:30
'3.0': true,
meta: {
isChrome: true,
chromeVersion: 57,
},
2020-05-24 23:13:21 +05:30
};
2017-08-17 22:00:37 +05:30
const isSupported = isEmojiUnicodeSupported(
unicodeSupportMap,
emojiFixtureMap[emojiKey].moji,
emojiFixtureMap[emojiKey].unicodeVersion,
);
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
expect(isSupported).toBeTruthy();
});
it('fallback keycap on <57 chrome', () => {
const emojiKey = 'five';
2020-05-24 23:13:21 +05:30
const unicodeSupportMap = {
...emptySupportMap,
2017-08-17 22:00:37 +05:30
'3.0': true,
meta: {
isChrome: true,
chromeVersion: 50,
},
2020-05-24 23:13:21 +05:30
};
2017-08-17 22:00:37 +05:30
const isSupported = isEmojiUnicodeSupported(
unicodeSupportMap,
emojiFixtureMap[emojiKey].moji,
emojiFixtureMap[emojiKey].unicodeVersion,
);
2018-12-13 13:39:08 +05:30
2017-08-17 22:00:37 +05:30
expect(isSupported).toBeFalsy();
});
});
2021-01-03 14:25:43 +05:30
2021-03-11 19:13:27 +05:30
describe('getEmojiInfo', () => {
it.each(['atom', 'five', 'black_heart'])("should return a correct emoji for '%s'", (name) => {
expect(getEmojiInfo(name)).toEqual(mockEmojiData[name]);
2021-01-03 14:25:43 +05:30
});
2021-03-11 19:13:27 +05:30
it('should return fallback emoji by default', () => {
expect(getEmojiInfo('atjs')).toEqual(mockEmojiData.grey_question);
2021-01-03 14:25:43 +05:30
});
2021-03-11 19:13:27 +05:30
it('should return null when fallback is false', () => {
expect(getEmojiInfo('atjs', false)).toBe(null);
2021-01-03 14:25:43 +05:30
});
2021-03-11 19:13:27 +05:30
describe('when query is undefined', () => {
it('should return fallback emoji by default', () => {
expect(getEmojiInfo()).toEqual(mockEmojiData.grey_question);
2021-01-03 14:25:43 +05:30
});
2021-03-11 19:13:27 +05:30
it('should return null when fallback is false', () => {
expect(getEmojiInfo(undefined, false)).toBe(null);
2021-01-03 14:25:43 +05:30
});
});
2021-03-11 19:13:27 +05:30
});
2021-01-03 14:25:43 +05:30
2021-03-11 19:13:27 +05:30
describe('searchEmoji', () => {
const emojiFixture = Object.keys(mockEmojiData).reduce((acc, k) => {
const { name, e, u, d } = mockEmojiData[k];
2021-11-11 11:23:49 +05:30
acc[k] = { name, e: sanitize(e), u, d };
2021-03-11 19:13:27 +05:30
return acc;
}, {});
it.each([undefined, null, ''])("should return all emoji when the input is '%s'", (input) => {
const search = searchEmoji(input);
const expected = [
'atom',
'bomb',
'construction_worker_tone5',
'five',
'grey_question',
'black_heart',
'heart',
'custard',
'star',
2021-11-11 11:23:49 +05:30
'xss',
2021-03-11 19:13:27 +05:30
].map((name) => {
return {
emoji: emojiFixture[name],
field: 'd',
fieldValue: emojiFixture[name].d,
score: 0,
};
2021-01-03 14:25:43 +05:30
});
2021-03-11 19:13:27 +05:30
expect(search).toEqual(expected);
});
it.each([
[
'searching by unicode value',
'⚛',
[
{
name: 'atom',
field: 'e',
fieldValue: 'atom',
score: 0,
},
],
],
[
'searching by partial alias',
'_symbol',
[
{
name: 'atom',
field: 'alias',
fieldValue: 'atom_symbol',
score: 4,
},
],
],
[
'searching by full alias',
'atom_symbol',
[
{
name: 'atom',
field: 'alias',
fieldValue: 'atom_symbol',
score: 0,
},
],
],
])('should return a correct result when %s', (_, query, searchResult) => {
const expected = searchResult.map((item) => {
const { field, score, fieldValue, name } = item;
return {
emoji: emojiFixture[name],
field,
fieldValue,
score,
};
2021-01-03 14:25:43 +05:30
});
2021-03-11 19:13:27 +05:30
expect(searchEmoji(query)).toEqual(expected);
});
it.each([
['searching with a non-existing emoji name', 'asdf', []],
[
'searching by full name',
'atom',
[
{
name: 'atom',
field: 'd',
score: 0,
},
],
],
[
'searching by full description',
'atom symbol',
[
{
name: 'atom',
field: 'd',
score: 0,
},
],
],
[
'searching by partial name',
'question',
[
{
name: 'grey_question',
field: 'name',
score: 5,
},
],
],
[
'searching by partial description',
'ment',
[
{
name: 'grey_question',
field: 'd',
score: 24,
},
],
],
[
'searching with query "heart"',
'heart',
[
{
name: 'black_heart',
field: 'd',
score: 6,
},
{
name: 'heart',
field: 'name',
score: 0,
},
],
],
[
'searching with query "HEART"',
'HEART',
[
{
name: 'black_heart',
field: 'd',
score: 6,
},
{
name: 'heart',
field: 'name',
score: 0,
},
],
],
[
'searching with query "star"',
'star',
[
{
name: 'custard',
field: 'd',
score: 2,
},
{
name: 'star',
field: 'name',
score: 0,
},
],
],
])('should return a correct result when %s', (_, query, searchResult) => {
const expected = searchResult.map((item) => {
const { field, score, name } = item;
return {
emoji: emojiFixture[name],
field,
fieldValue: emojiFixture[name][field],
score,
};
2021-01-03 14:25:43 +05:30
});
2021-03-11 19:13:27 +05:30
expect(searchEmoji(query)).toEqual(expected);
});
});
describe('sortEmoji', () => {
const testCases = [
[
'should correctly sort by score',
[
{ score: 10, fieldValue: '', emoji: { name: 'a' } },
{ score: 5, fieldValue: '', emoji: { name: 'b' } },
{ score: 0, fieldValue: '', emoji: { name: 'c' } },
],
[
{ score: 0, fieldValue: '', emoji: { name: 'c' } },
{ score: 5, fieldValue: '', emoji: { name: 'b' } },
{ score: 10, fieldValue: '', emoji: { name: 'a' } },
],
],
[
'should correctly sort by fieldValue',
[
{ score: 0, fieldValue: 'y', emoji: { name: 'b' } },
{ score: 0, fieldValue: 'x', emoji: { name: 'a' } },
{ score: 0, fieldValue: 'z', emoji: { name: 'c' } },
],
[
{ score: 0, fieldValue: 'x', emoji: { name: 'a' } },
{ score: 0, fieldValue: 'y', emoji: { name: 'b' } },
{ score: 0, fieldValue: 'z', emoji: { name: 'c' } },
],
],
[
'should correctly sort by score and then by fieldValue (in order)',
[
{ score: 5, fieldValue: 'y', emoji: { name: 'c' } },
{ score: 0, fieldValue: 'z', emoji: { name: 'a' } },
{ score: 5, fieldValue: 'x', emoji: { name: 'b' } },
],
[
{ score: 0, fieldValue: 'z', emoji: { name: 'a' } },
{ score: 5, fieldValue: 'x', emoji: { name: 'b' } },
{ score: 5, fieldValue: 'y', emoji: { name: 'c' } },
],
],
];
it.each(testCases)('%s', (_, scoredItems, expected) => {
expect(sortEmoji(scoredItems)).toEqual(expected);
2021-01-03 14:25:43 +05:30
});
});
2021-11-11 11:23:49 +05:30
describe('sanitize emojis', () => {
it('should return sanitized emoji', () => {
expect(getEmojiInfo('xss')).toEqual({
...mockEmojiData.xss,
e: '<img src="x">',
});
});
});
2017-08-17 22:00:37 +05:30
});