gitlab-org--gitlab-foss/spec/frontend/awards_handler_spec.js

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

410 lines
13 KiB
JavaScript
Raw Normal View History

import $ from 'jquery';
import Cookies from '~/lib/utils/cookies';
import { loadHTMLFixture, resetHTMLFixture } from 'helpers/fixtures';
import { initEmojiMock, clearEmojiMock } from 'helpers/emoji';
import { useFakeRequestAnimationFrame } from 'helpers/fake_request_animation_frame';
import loadAwardsHandler from '~/awards_handler';
2016-09-08 06:08:09 -04:00
2018-10-17 03:07:04 -04:00
window.gl = window.gl || {};
window.gon = window.gon || {};
let awardsHandler = null;
const urlRoot = gon.relative_url_root;
describe('AwardsHandler', () => {
useFakeRequestAnimationFrame();
const emojiData = {
'8ball': {
c: 'activity',
e: '🎱',
d: 'billiards',
u: '6.0',
},
grinning: {
c: 'people',
e: '😀',
d: 'grinning face',
u: '6.1',
},
angel: {
c: 'people',
e: '👼',
d: 'baby angel',
u: '6.0',
},
anger: {
c: 'symbols',
e: '💢',
d: 'anger symbol',
u: '6.0',
},
alien: {
c: 'people',
e: '👽',
d: 'extraterrestrial alien',
u: '6.0',
},
sunglasses: {
c: 'people',
e: '😎',
d: 'smiling face with sunglasses',
u: '6.0',
},
grey_question: {
c: 'symbols',
e: '❔',
d: 'white question mark ornament',
u: '6.0',
},
thumbsup: {
c: 'people',
e: '👍',
d: 'thumbs up sign',
u: '6.0',
},
thumbsdown: {
c: 'people',
e: '👎',
d: 'thumbs down sign',
u: '6.0',
},
};
const openAndWaitForEmojiMenu = (sel = '.js-add-award') => {
$(sel).eq(0).click();
jest.runOnlyPendingTimers();
const $menu = $('.emoji-menu');
return new Promise((resolve) => {
$menu.one('build-emoji-menu-finish', () => {
resolve();
});
});
};
beforeEach(async () => {
await initEmojiMock(emojiData);
loadHTMLFixture('snippets/show.html');
awardsHandler = await loadAwardsHandler(true);
jest.spyOn(awardsHandler, 'postEmoji').mockImplementation((button, url, emoji, cb) => cb());
2018-10-17 03:07:04 -04:00
});
2016-07-24 16:45:11 -04:00
afterEach(() => {
2018-10-17 03:07:04 -04:00
// restore original url root value
gon.relative_url_root = urlRoot;
2016-07-24 16:45:11 -04:00
clearEmojiMock();
2018-10-17 03:07:04 -04:00
// Undo what we did to the shared <body>
$('body').removeAttr('data-page');
2016-07-24 16:45:11 -04:00
2018-10-17 03:07:04 -04:00
awardsHandler.destroy();
resetHTMLFixture();
2018-10-17 03:07:04 -04:00
});
2016-07-24 16:45:11 -04:00
describe('::showEmojiMenu', () => {
it('should show emoji menu when Add emoji button clicked', async () => {
await openAndWaitForEmojiMenu();
2018-10-17 03:07:04 -04:00
const $emojiMenu = $('.emoji-menu');
expect($emojiMenu.length).toBe(1);
expect($emojiMenu.hasClass('is-visible')).toBe(true);
expect($emojiMenu.find('.js-emoji-menu-search').length).toBe(1);
expect($('.js-awards-block.current').length).toBe(1);
2018-10-17 03:07:04 -04:00
});
2016-07-24 16:45:11 -04:00
it('should also show emoji menu for the smiley icon in notes', async () => {
await openAndWaitForEmojiMenu('.js-add-award.note-action-button');
2016-07-24 16:45:11 -04:00
const $emojiMenu = $('.emoji-menu');
expect($emojiMenu.length).toBe(1);
2018-10-17 03:07:04 -04:00
});
it('should remove emoji menu when body is clicked', async () => {
await openAndWaitForEmojiMenu();
2018-10-17 03:07:04 -04:00
const $emojiMenu = $('.emoji-menu');
$('body').click();
expect($emojiMenu.length).toBe(1);
expect($emojiMenu.hasClass('is-visible')).toBe(false);
expect($('.js-awards-block.current').length).toBe(0);
});
it('should not remove emoji menu when search is clicked', async () => {
await openAndWaitForEmojiMenu();
2018-10-17 03:07:04 -04:00
const $emojiMenu = $('.emoji-menu');
$('.emoji-search').click();
expect($emojiMenu.length).toBe(1);
expect($emojiMenu.hasClass('is-visible')).toBe(true);
expect($('.js-awards-block.current').length).toBe(1);
2018-10-17 03:07:04 -04:00
});
});
describe('::addAwardToEmojiBar', () => {
it('should add emoji to votes block', () => {
2018-10-17 03:07:04 -04:00
const $votesBlock = $('.js-awards-block').eq(0);
awardsHandler.addAwardToEmojiBar($votesBlock, 'heart', false);
const $emojiButton = $votesBlock.find('[data-name=heart]');
2018-10-17 03:07:04 -04:00
expect($emojiButton.length).toBe(1);
expect($emojiButton.next('.js-counter').text()).toBe('1');
expect($votesBlock.hasClass('hidden')).toBe(false);
2016-07-24 16:45:11 -04:00
});
it('should remove the emoji when we click again', () => {
2018-10-17 03:07:04 -04:00
const $votesBlock = $('.js-awards-block').eq(0);
awardsHandler.addAwardToEmojiBar($votesBlock, 'heart', false);
awardsHandler.addAwardToEmojiBar($votesBlock, 'heart', false);
const $emojiButton = $votesBlock.find('[data-name=heart]');
2018-10-17 03:07:04 -04:00
expect($emojiButton.length).toBe(0);
});
2018-10-09 14:03:09 -04:00
it('should decrement the emoji counter', () => {
2018-10-17 03:07:04 -04:00
const $votesBlock = $('.js-awards-block').eq(0);
awardsHandler.addAwardToEmojiBar($votesBlock, 'heart', false);
const $emojiButton = $votesBlock.find('[data-name=heart]');
$emojiButton.next('.js-counter').text(5);
awardsHandler.addAwardToEmojiBar($votesBlock, 'heart', false);
2018-10-17 03:07:04 -04:00
expect($emojiButton.length).toBe(1);
expect($emojiButton.next('.js-counter').text()).toBe('4');
});
});
describe('::getAwardUrl', () => {
it('returns the url for request', () => {
expect(awardsHandler.getAwardUrl()).toBe('http://test.host/-/snippets/1/toggle_award_emoji');
2018-10-17 03:07:04 -04:00
});
});
2018-10-09 14:03:09 -04:00
describe('::addAward and ::checkMutuality', () => {
it('should handle :+1: and :-1: mutuality', () => {
2018-10-17 03:07:04 -04:00
const awardUrl = awardsHandler.getAwardUrl();
const $votesBlock = $('.js-awards-block').eq(0);
const $thumbsUpEmoji = $votesBlock.find('[data-name=thumbsup]').parent();
const $thumbsDownEmoji = $votesBlock.find('[data-name=thumbsdown]').parent();
awardsHandler.addAward($votesBlock, awardUrl, 'thumbsup', false);
expect($thumbsUpEmoji.hasClass('active')).toBe(true);
expect($thumbsDownEmoji.hasClass('active')).toBe(false);
awardsHandler.addAward($votesBlock, awardUrl, 'thumbsdown', true);
expect($thumbsUpEmoji.hasClass('active')).toBe(false);
expect($thumbsDownEmoji.hasClass('active')).toBe(true);
2016-07-24 16:45:11 -04:00
});
2018-10-17 03:07:04 -04:00
});
describe('::removeEmoji', () => {
it('should remove emoji', () => {
2018-10-17 03:07:04 -04:00
const awardUrl = awardsHandler.getAwardUrl();
const $votesBlock = $('.js-awards-block').eq(0);
awardsHandler.addAward($votesBlock, awardUrl, 'fire', false);
2018-10-17 03:07:04 -04:00
expect($votesBlock.find('[data-name=fire]').length).toBe(1);
awardsHandler.removeEmoji($votesBlock.find('[data-name=fire]').closest('button'));
expect($votesBlock.find('[data-name=fire]').length).toBe(0);
2016-09-08 06:08:09 -04:00
});
2018-10-17 03:07:04 -04:00
});
describe('::addYouToUserList', () => {
it('should prepend "You" to the award tooltip', () => {
2018-10-17 03:07:04 -04:00
const awardUrl = awardsHandler.getAwardUrl();
const $votesBlock = $('.js-awards-block').eq(0);
const $thumbsUpEmoji = $votesBlock.find('[data-name=thumbsup]').parent();
$thumbsUpEmoji.attr('data-title', 'sam, jerry, max, and andy');
awardsHandler.addAward($votesBlock, awardUrl, 'thumbsup', false);
2018-10-09 14:03:09 -04:00
expect($thumbsUpEmoji.attr('title')).toBe('You, sam, jerry, max, and andy');
2016-07-24 16:45:11 -04:00
});
it('handles the special case where "You" is not cleanly comma separated', () => {
2018-10-17 03:07:04 -04:00
const awardUrl = awardsHandler.getAwardUrl();
const $votesBlock = $('.js-awards-block').eq(0);
const $thumbsUpEmoji = $votesBlock.find('[data-name=thumbsup]').parent();
$thumbsUpEmoji.attr('data-title', 'sam');
awardsHandler.addAward($votesBlock, awardUrl, 'thumbsup', false);
expect($thumbsUpEmoji.attr('title')).toBe('You and sam');
2016-07-24 16:45:11 -04:00
});
2018-10-17 03:07:04 -04:00
});
describe('::removeYouToUserList', () => {
it('removes "You" from the front of the tooltip', () => {
2018-10-17 03:07:04 -04:00
const awardUrl = awardsHandler.getAwardUrl();
const $votesBlock = $('.js-awards-block').eq(0);
const $thumbsUpEmoji = $votesBlock.find('[data-name=thumbsup]').parent();
$thumbsUpEmoji.attr('data-title', 'You, sam, jerry, max, and andy');
$thumbsUpEmoji.addClass('active');
awardsHandler.addAward($votesBlock, awardUrl, 'thumbsup', false);
expect($thumbsUpEmoji.attr('title')).toBe('sam, jerry, max, and andy');
2018-10-17 03:07:04 -04:00
});
2018-10-09 14:03:09 -04:00
it('handles the special case where "You" is not cleanly comma separated', () => {
2018-10-17 03:07:04 -04:00
const awardUrl = awardsHandler.getAwardUrl();
const $votesBlock = $('.js-awards-block').eq(0);
const $thumbsUpEmoji = $votesBlock.find('[data-name=thumbsup]').parent();
$thumbsUpEmoji.attr('data-title', 'You and sam');
$thumbsUpEmoji.addClass('active');
awardsHandler.addAward($votesBlock, awardUrl, 'thumbsup', false);
2018-10-09 14:03:09 -04:00
expect($thumbsUpEmoji.attr('title')).toBe('sam');
2016-07-24 16:45:11 -04:00
});
2018-10-17 03:07:04 -04:00
});
2018-10-17 03:07:04 -04:00
describe('::searchEmojis', () => {
it('should filter the emoji', async () => {
await openAndWaitForEmojiMenu();
expect($('[data-name=angel]').is(':visible')).toBe(true);
expect($('[data-name=anger]').is(':visible')).toBe(true);
awardsHandler.searchEmojis('ali');
expect($('[data-name=angel]').is(':visible')).toBe(false);
expect($('[data-name=anger]').is(':visible')).toBe(false);
expect($('[data-name=alien]').is(':visible')).toBe(true);
expect($('.js-emoji-menu-search').val()).toBe('ali');
});
it('should clear the search when searching for nothing', async () => {
await openAndWaitForEmojiMenu();
awardsHandler.searchEmojis('ali');
expect($('[data-name=angel]').is(':visible')).toBe(false);
expect($('[data-name=anger]').is(':visible')).toBe(false);
expect($('[data-name=alien]').is(':visible')).toBe(true);
awardsHandler.searchEmojis('');
expect($('[data-name=angel]').is(':visible')).toBe(true);
expect($('[data-name=anger]').is(':visible')).toBe(true);
expect($('[data-name=alien]').is(':visible')).toBe(true);
expect($('.js-emoji-menu-search').val()).toBe('');
});
it('should filter by emoji description', async () => {
await openAndWaitForEmojiMenu();
awardsHandler.searchEmojis('baby');
expect($('[data-name=angel]').is(':visible')).toBe(true);
});
it('should filter by emoji unicode value', async () => {
await openAndWaitForEmojiMenu();
awardsHandler.searchEmojis('👼');
expect($('[data-name=angel]').is(':visible')).toBe(true);
});
it('should show positive intent emoji first', async () => {
await openAndWaitForEmojiMenu();
awardsHandler.searchEmojis('thumb');
const $menu = $('.emoji-menu');
const $thumbsUpItem = $menu.find('[data-name=thumbsup]');
const $thumbsDownItem = $menu.find('[data-name=thumbsdown]');
expect($thumbsUpItem.is(':visible')).toBe(true);
expect($thumbsDownItem.is(':visible')).toBe(true);
expect($thumbsUpItem.parents('.emoji-menu-list-item').index()).toBeLessThan(
$thumbsDownItem.parents('.emoji-menu-list-item').index(),
);
});
2018-10-17 03:07:04 -04:00
});
describe('emoji menu', () => {
2018-10-17 03:07:04 -04:00
const emojiSelector = '[data-name="sunglasses"]';
const openEmojiMenuAndAddEmoji = () => {
2018-10-17 03:07:04 -04:00
return openAndWaitForEmojiMenu().then(() => {
const $menu = $('.emoji-menu');
const $block = $('.js-awards-block');
const $emoji = $menu.find(`.emoji-menu-list:not(.frequent-emojis) ${emojiSelector}`);
2018-10-17 03:07:04 -04:00
expect($emoji.length).toBe(1);
expect($block.find(emojiSelector).length).toBe(0);
$emoji.click();
expect($menu.hasClass('.is-visible')).toBe(false);
expect($block.find(emojiSelector).length).toBe(1);
2016-07-24 16:45:11 -04:00
});
2018-10-17 03:07:04 -04:00
};
it('should add selected emoji to awards block', async () => {
await openEmojiMenuAndAddEmoji();
2016-07-24 16:45:11 -04:00
});
it('should remove already selected emoji', async () => {
await openEmojiMenuAndAddEmoji();
$('.js-add-award').eq(0).click();
const $block = $('.js-awards-block');
const $emoji = $('.emoji-menu').find(
`.emoji-menu-list:not(.frequent-emojis) ${emojiSelector}`,
);
$emoji.click();
expect($block.find(emojiSelector).length).toBe(0);
2018-10-17 03:07:04 -04:00
});
});
describe('frequently used emojis', () => {
2018-10-17 03:07:04 -04:00
beforeEach(() => {
// Clear it out
Cookies.set('frequently_used_emojis', '');
});
it('shouldn\'t have any "Frequently used" heading if no frequently used emojis', async () => {
await openAndWaitForEmojiMenu();
const emojiMenu = document.querySelector('.emoji-menu');
Array.prototype.forEach.call(emojiMenu.querySelectorAll('.emoji-menu-title'), (title) => {
expect(title.textContent.trim().toLowerCase()).not.toBe('frequently used');
});
});
it('should have any frequently used section when there are frequently used emojis', async () => {
2018-10-17 03:07:04 -04:00
awardsHandler.addEmojiToFrequentlyUsedList('8ball');
await openAndWaitForEmojiMenu();
const emojiMenu = document.querySelector('.emoji-menu');
const hasFrequentlyUsedHeading = Array.prototype.some.call(
emojiMenu.querySelectorAll('.emoji-menu-title'),
(title) => title.textContent.trim().toLowerCase() === 'frequently used',
);
expect(hasFrequentlyUsedHeading).toBe(true);
2018-10-17 03:07:04 -04:00
});
it('should disregard invalid frequently used emoji that are being attempted to be added', () => {
2018-10-17 03:07:04 -04:00
awardsHandler.addEmojiToFrequentlyUsedList('8ball');
awardsHandler.addEmojiToFrequentlyUsedList('invalid_emoji');
awardsHandler.addEmojiToFrequentlyUsedList('grinning');
2018-10-17 03:07:04 -04:00
expect(awardsHandler.getFrequentlyUsedEmojis()).toEqual(['8ball', 'grinning']);
});
it('should disregard invalid frequently used emoji already set in cookie', () => {
2018-10-17 03:07:04 -04:00
Cookies.set('frequently_used_emojis', '8ball,invalid_emoji,grinning');
2018-10-17 03:07:04 -04:00
expect(awardsHandler.getFrequentlyUsedEmojis()).toEqual(['8ball', 'grinning']);
2016-07-24 16:45:11 -04:00
});
});
2018-10-17 03:07:04 -04:00
});