awards_handler_spec.js 15.6 KB
Newer Older
1
/* eslint-disable space-before-function-paren, no-var, one-var, one-var-declaration-per-line, no-unused-expressions, comma-dangle, new-parens, no-unused-vars, quotes, jasmine/no-spec-dupes, prefer-template, max-len */
F
Fatih Acet 已提交
2

3
import Cookies from 'js-cookie';
4
import loadAwardsHandler from '~/awards_handler';
E
Eric Eastwood 已提交
5

6
import '~/lib/utils/common_utils';
B
barthc 已提交
7

F
Fatih Acet 已提交
8
(function() {
E
Eric Eastwood 已提交
9
  var awardsHandler, lazyAssert, urlRoot, openAndWaitForEmojiMenu;
F
Fatih Acet 已提交
10 11 12 13 14 15 16

  awardsHandler = null;

  window.gl || (window.gl = {});

  window.gon || (window.gon = {});

17
  urlRoot = gon.relative_url_root;
F
Fatih Acet 已提交
18 19 20 21 22

  lazyAssert = function(done, assertFn) {
    return setTimeout(function() {
      assertFn();
      return done();
23
    // Maybe jasmine.clock here?
F
Fatih Acet 已提交
24 25 26 27
    }, 333);
  };

  describe('AwardsHandler', function() {
F
Filipa Lacerda 已提交
28
    preloadFixtures('merge_requests/diff_comment.html.raw');
29
    beforeEach(function(done) {
F
Filipa Lacerda 已提交
30
      loadFixtures('merge_requests/diff_comment.html.raw');
31
      $('body').attr('data-page', 'projects:merge_requests:show');
32 33 34 35 36
      loadAwardsHandler(true).then((obj) => {
        awardsHandler = obj;
        spyOn(awardsHandler, 'postEmoji').and.callFake((button, url, emoji, cb) => cb());
        done();
      }).catch(fail);
E
Eric Eastwood 已提交
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52

      let isEmojiMenuBuilt = false;
      openAndWaitForEmojiMenu = function() {
        return new Promise((resolve, reject) => {
          if (isEmojiMenuBuilt) {
            resolve();
          } else {
            $('.js-add-award').eq(0).click();
            const $menu = $('.emoji-menu');
            $menu.one('build-emoji-menu-finish', () => {
              isEmojiMenuBuilt = true;
              resolve();
            });
          }
        });
      };
53 54 55 56
    });
    afterEach(function() {
      // restore original url root value
      gon.relative_url_root = urlRoot;
E
Eric Eastwood 已提交
57

58 59 60
      // Undo what we did to the shared <body>
      $('body').removeAttr('data-page');

E
Eric Eastwood 已提交
61
      awardsHandler.destroy();
F
Fatih Acet 已提交
62 63 64 65 66 67 68 69 70
    });
    describe('::showEmojiMenu', function() {
      it('should show emoji menu when Add emoji button clicked', function(done) {
        $('.js-add-award').eq(0).click();
        return lazyAssert(done, function() {
          var $emojiMenu;
          $emojiMenu = $('.emoji-menu');
          expect($emojiMenu.length).toBe(1);
          expect($emojiMenu.hasClass('is-visible')).toBe(true);
71
          expect($emojiMenu.find('.js-emoji-menu-search').length).toBe(1);
F
Fatih Acet 已提交
72 73 74 75
          return expect($('.js-awards-block.current').length).toBe(1);
        });
      });
      it('should also show emoji menu for the smiley icon in notes', function(done) {
E
Eric Eastwood 已提交
76
        $('.js-add-award.note-action-button').click();
F
Fatih Acet 已提交
77
        return lazyAssert(done, function() {
E
Eric Eastwood 已提交
78
          var $emojiMenu = $('.emoji-menu');
F
Fatih Acet 已提交
79 80 81
          return expect($emojiMenu.length).toBe(1);
        });
      });
82
      it('should remove emoji menu when body is clicked', function(done) {
F
Fatih Acet 已提交
83 84 85 86 87 88 89 90 91 92
        $('.js-add-award').eq(0).click();
        return lazyAssert(done, function() {
          var $emojiMenu;
          $emojiMenu = $('.emoji-menu');
          $('body').click();
          expect($emojiMenu.length).toBe(1);
          expect($emojiMenu.hasClass('is-visible')).toBe(false);
          return expect($('.js-awards-block.current').length).toBe(0);
        });
      });
93 94 95 96 97 98 99 100 101 102 103
      it('should not remove emoji menu when search is clicked', function(done) {
        $('.js-add-award').eq(0).click();
        return lazyAssert(done, function() {
          var $emojiMenu;
          $emojiMenu = $('.emoji-menu');
          $('.emoji-search').click();
          expect($emojiMenu.length).toBe(1);
          expect($emojiMenu.hasClass('is-visible')).toBe(true);
          return expect($('.js-awards-block.current').length).toBe(1);
        });
      });
F
Fatih Acet 已提交
104 105 106 107 108 109
    });
    describe('::addAwardToEmojiBar', function() {
      it('should add emoji to votes block', function() {
        var $emojiButton, $votesBlock;
        $votesBlock = $('.js-awards-block').eq(0);
        awardsHandler.addAwardToEmojiBar($votesBlock, 'heart', false);
E
Eric Eastwood 已提交
110
        $emojiButton = $votesBlock.find('[data-name=heart]');
F
Fatih Acet 已提交
111 112 113 114 115 116 117 118 119
        expect($emojiButton.length).toBe(1);
        expect($emojiButton.next('.js-counter').text()).toBe('1');
        return expect($votesBlock.hasClass('hidden')).toBe(false);
      });
      it('should remove the emoji when we click again', function() {
        var $emojiButton, $votesBlock;
        $votesBlock = $('.js-awards-block').eq(0);
        awardsHandler.addAwardToEmojiBar($votesBlock, 'heart', false);
        awardsHandler.addAwardToEmojiBar($votesBlock, 'heart', false);
E
Eric Eastwood 已提交
120
        $emojiButton = $votesBlock.find('[data-name=heart]');
F
Fatih Acet 已提交
121 122 123 124 125 126
        return expect($emojiButton.length).toBe(0);
      });
      return it('should decrement the emoji counter', function() {
        var $emojiButton, $votesBlock;
        $votesBlock = $('.js-awards-block').eq(0);
        awardsHandler.addAwardToEmojiBar($votesBlock, 'heart', false);
E
Eric Eastwood 已提交
127
        $emojiButton = $votesBlock.find('[data-name=heart]');
F
Fatih Acet 已提交
128 129 130 131 132 133
        $emojiButton.next('.js-counter').text(5);
        awardsHandler.addAwardToEmojiBar($votesBlock, 'heart', false);
        expect($emojiButton.length).toBe(1);
        return expect($emojiButton.next('.js-counter').text()).toBe('4');
      });
    });
B
barthc 已提交
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
    describe('::userAuthored', function() {
      it('should update tooltip to user authored title', function() {
        var $thumbsUpEmoji, $votesBlock;
        $votesBlock = $('.js-awards-block').eq(0);
        $thumbsUpEmoji = $votesBlock.find('[data-name=thumbsup]').parent();
        $thumbsUpEmoji.attr('data-title', 'sam');
        awardsHandler.userAuthored($thumbsUpEmoji);
        return expect($thumbsUpEmoji.data("original-title")).toBe("You cannot vote on your own issue, MR and note");
      });
      it('should restore tooltip back to initial vote list', function() {
        var $thumbsUpEmoji, $votesBlock;
        jasmine.clock().install();
        $votesBlock = $('.js-awards-block').eq(0);
        $thumbsUpEmoji = $votesBlock.find('[data-name=thumbsup]').parent();
        $thumbsUpEmoji.attr('data-title', 'sam');
        awardsHandler.userAuthored($thumbsUpEmoji);
        jasmine.clock().tick(2801);
        jasmine.clock().uninstall();
        return expect($thumbsUpEmoji.data("original-title")).toBe("sam");
      });
    });
F
Fatih Acet 已提交
155
    describe('::getAwardUrl', function() {
V
Valery Sizov 已提交
156
      return it('returns the url for request', function() {
F
Filipa Lacerda 已提交
157
        return expect(awardsHandler.getAwardUrl()).toBe('http://test.host/frontend-fixtures/merge-requests-project/merge_requests/1/toggle_award_emoji');
F
Fatih Acet 已提交
158 159 160 161 162 163 164
      });
    });
    describe('::addAward and ::checkMutuality', function() {
      return it('should handle :+1: and :-1: mutuality', function() {
        var $thumbsDownEmoji, $thumbsUpEmoji, $votesBlock, awardUrl;
        awardUrl = awardsHandler.getAwardUrl();
        $votesBlock = $('.js-awards-block').eq(0);
E
Eric Eastwood 已提交
165 166
        $thumbsUpEmoji = $votesBlock.find('[data-name=thumbsup]').parent();
        $thumbsDownEmoji = $votesBlock.find('[data-name=thumbsdown]').parent();
F
Fatih Acet 已提交
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
        awardsHandler.addAward($votesBlock, awardUrl, 'thumbsup', false);
        expect($thumbsUpEmoji.hasClass('active')).toBe(true);
        expect($thumbsDownEmoji.hasClass('active')).toBe(false);
        $thumbsUpEmoji.tooltip();
        $thumbsDownEmoji.tooltip();
        awardsHandler.addAward($votesBlock, awardUrl, 'thumbsdown', true);
        expect($thumbsUpEmoji.hasClass('active')).toBe(false);
        return expect($thumbsDownEmoji.hasClass('active')).toBe(true);
      });
    });
    describe('::removeEmoji', function() {
      return it('should remove emoji', function() {
        var $votesBlock, awardUrl;
        awardUrl = awardsHandler.getAwardUrl();
        $votesBlock = $('.js-awards-block').eq(0);
        awardsHandler.addAward($votesBlock, awardUrl, 'fire', false);
E
Eric Eastwood 已提交
183 184 185
        expect($votesBlock.find('[data-name=fire]').length).toBe(1);
        awardsHandler.removeEmoji($votesBlock.find('[data-name=fire]').closest('button'));
        return expect($votesBlock.find('[data-name=fire]').length).toBe(0);
F
Fatih Acet 已提交
186 187
      });
    });
188 189
    describe('::addYouToUserList', function() {
      it('should prepend "You" to the award tooltip', function() {
190 191 192
        var $thumbsUpEmoji, $votesBlock, awardUrl;
        awardUrl = awardsHandler.getAwardUrl();
        $votesBlock = $('.js-awards-block').eq(0);
E
Eric Eastwood 已提交
193
        $thumbsUpEmoji = $votesBlock.find('[data-name=thumbsup]').parent();
194
        $thumbsUpEmoji.attr('data-title', 'sam, jerry, max, and andy');
195 196
        awardsHandler.addAward($votesBlock, awardUrl, 'thumbsup', false);
        $thumbsUpEmoji.tooltip();
197
        return expect($thumbsUpEmoji.data("original-title")).toBe('You, sam, jerry, max, and andy');
198
      });
199
      return it('handles the special case where "You" is not cleanly comma seperated', function() {
200 201 202
        var $thumbsUpEmoji, $votesBlock, awardUrl;
        awardUrl = awardsHandler.getAwardUrl();
        $votesBlock = $('.js-awards-block').eq(0);
E
Eric Eastwood 已提交
203
        $thumbsUpEmoji = $votesBlock.find('[data-name=thumbsup]').parent();
204 205 206
        $thumbsUpEmoji.attr('data-title', 'sam');
        awardsHandler.addAward($votesBlock, awardUrl, 'thumbsup', false);
        $thumbsUpEmoji.tooltip();
207
        return expect($thumbsUpEmoji.data("original-title")).toBe('You and sam');
208 209
      });
    });
210 211
    describe('::removeYouToUserList', function() {
      it('removes "You" from the front of the tooltip', function() {
212 213 214
        var $thumbsUpEmoji, $votesBlock, awardUrl;
        awardUrl = awardsHandler.getAwardUrl();
        $votesBlock = $('.js-awards-block').eq(0);
E
Eric Eastwood 已提交
215
        $thumbsUpEmoji = $votesBlock.find('[data-name=thumbsup]').parent();
216
        $thumbsUpEmoji.attr('data-title', 'You, sam, jerry, max, and andy');
217 218 219 220 221
        $thumbsUpEmoji.addClass('active');
        awardsHandler.addAward($votesBlock, awardUrl, 'thumbsup', false);
        $thumbsUpEmoji.tooltip();
        return expect($thumbsUpEmoji.data("original-title")).toBe('sam, jerry, max, and andy');
      });
222
      return it('handles the special case where "You" is not cleanly comma seperated', function() {
223 224 225
        var $thumbsUpEmoji, $votesBlock, awardUrl;
        awardUrl = awardsHandler.getAwardUrl();
        $votesBlock = $('.js-awards-block').eq(0);
E
Eric Eastwood 已提交
226
        $thumbsUpEmoji = $votesBlock.find('[data-name=thumbsup]').parent();
227
        $thumbsUpEmoji.attr('data-title', 'You and sam');
228 229 230
        $thumbsUpEmoji.addClass('active');
        awardsHandler.addAward($votesBlock, awardUrl, 'thumbsup', false);
        $thumbsUpEmoji.tooltip();
231
        return expect($thumbsUpEmoji.data("original-title")).toBe('sam');
232 233
      });
    });
234 235
    describe('::searchEmojis', () => {
      it('should filter the emoji', function(done) {
E
Eric Eastwood 已提交
236 237 238 239
        return openAndWaitForEmojiMenu()
          .then(() => {
            expect($('[data-name=angel]').is(':visible')).toBe(true);
            expect($('[data-name=anger]').is(':visible')).toBe(true);
240
            awardsHandler.searchEmojis('ali');
E
Eric Eastwood 已提交
241 242 243
            expect($('[data-name=angel]').is(':visible')).toBe(false);
            expect($('[data-name=anger]').is(':visible')).toBe(false);
            expect($('[data-name=alien]').is(':visible')).toBe(true);
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
            expect($('.js-emoji-menu-search').val()).toBe('ali');
          })
          .then(done)
          .catch((err) => {
            done.fail(`Failed to open and build emoji menu: ${err.message}`);
          });
      });
      it('should clear the search when searching for nothing', function(done) {
        return openAndWaitForEmojiMenu()
          .then(() => {
            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('');
E
Eric Eastwood 已提交
263 264
          })
          .then(done)
265 266
          .catch((err) => {
            done.fail(`Failed to open and build emoji menu: ${err.message}`);
E
Eric Eastwood 已提交
267
          });
F
Fatih Acet 已提交
268 269
      });
    });
270

E
Eric Eastwood 已提交
271
    describe('emoji menu', function() {
272
      const emojiSelector = '[data-name="sunglasses"]';
E
Eric Eastwood 已提交
273 274 275 276 277 278 279 280 281 282 283 284 285
      const openEmojiMenuAndAddEmoji = function() {
        return openAndWaitForEmojiMenu()
          .then(() => {
            const $menu = $('.emoji-menu');
            const $block = $('.js-awards-block');
            const $emoji = $menu.find('.emoji-menu-list:not(.frequent-emojis) ' + emojiSelector);

            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);
          });
F
Fatih Acet 已提交
286
      };
E
Eric Eastwood 已提交
287 288 289
      it('should add selected emoji to awards block', function(done) {
        return openEmojiMenuAndAddEmoji()
          .then(done)
290 291
          .catch((err) => {
            done.fail(`Failed to open and build emoji menu: ${err.message}`);
E
Eric Eastwood 已提交
292
          });
F
Fatih Acet 已提交
293
      });
E
Eric Eastwood 已提交
294 295 296 297 298 299 300 301 302 303 304
      it('should remove already selected emoji', function(done) {
        return openEmojiMenuAndAddEmoji()
          .then(() => {
            $('.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);
          })
          .then(done)
          .catch((err) => {
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
            done.fail(`Failed to open and build emoji menu: ${err.message}`);
          });
      });
    });

    describe('frequently used emojis', function() {
      beforeEach(() => {
        // Clear it out
        Cookies.set('frequently_used_emojis', '');
      });

      it('shouldn\'t have any "Frequently used" heading if no frequently used emojis', function(done) {
        return openAndWaitForEmojiMenu()
          .then(() => {
            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');
            });
          })
          .then(done)
          .catch((err) => {
            done.fail(`Failed to open and build emoji menu: ${err.message}`);
          });
      });

      it('should have any frequently used section when there are frequently used emojis', function(done) {
        awardsHandler.addEmojiToFrequentlyUsedList('8ball');

        return openAndWaitForEmojiMenu()
          .then(() => {
            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);
          })
          .then(done)
          .catch((err) => {
            done.fail(`Failed to open and build emoji menu: ${err.message}`);
E
Eric Eastwood 已提交
345
          });
F
Fatih Acet 已提交
346
      });
347 348 349 350 351 352 353 354 355 356 357 358 359 360

      it('should disregard invalid frequently used emoji that are being attempted to be added', function() {
        awardsHandler.addEmojiToFrequentlyUsedList('8ball');
        awardsHandler.addEmojiToFrequentlyUsedList('invalid_emoji');
        awardsHandler.addEmojiToFrequentlyUsedList('grinning');

        expect(awardsHandler.getFrequentlyUsedEmojis()).toEqual(['8ball', 'grinning']);
      });

      it('should disregard invalid frequently used emoji already set in cookie', function() {
        Cookies.set('frequently_used_emojis', '8ball,invalid_emoji,grinning');

        expect(awardsHandler.getFrequentlyUsedEmojis()).toEqual(['8ball', 'grinning']);
      });
F
Fatih Acet 已提交
361 362
    });
  });
363
}).call(window);