BigW Consortium Gitlab

awards_handler.js 18.6 KB
Newer Older
1 2
/* global Flash */

3
import Cookies from 'js-cookie';
4

5 6 7
import emojiMap from 'emojis/digests.json';
import emojiAliases from 'emojis/aliases.json';
import { glEmojiTag } from './behaviors/gl_emoji';
8
import isEmojiNameValid from './behaviors/gl_emoji/is_emoji_name_valid';
9 10

const animationEndEventString = 'animationend webkitAnimationEnd MSAnimationEnd oAnimationEnd';
11
const transitionEndEventString = 'transitionend webkitTransitionEnd oTransitionEnd MSTransitionEnd';
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
const requestAnimationFrame = window.requestAnimationFrame ||
  window.webkitRequestAnimationFrame ||
  window.mozRequestAnimationFrame ||
  window.setTimeout;

const FROM_SENTENCE_REGEX = /(?:, and | and |, )/; // For separating lists produced by ruby's Array#toSentence

let categoryMap = null;

const categoryLabelMap = {
  activity: 'Activity',
  people: 'People',
  nature: 'Nature',
  food: 'Food',
  travel: 'Travel',
  objects: 'Objects',
  symbols: 'Symbols',
  flags: 'Flags',
};

function buildCategoryMap() {
  return Object.keys(emojiMap).reduce((currentCategoryMap, emojiNameKey) => {
    const emojiInfo = emojiMap[emojiNameKey];
    if (currentCategoryMap[emojiInfo.category]) {
      currentCategoryMap[emojiInfo.category].push(emojiNameKey);
Fatih Acet committed
37 38
    }

39 40 41 42 43 44 45 46 47 48 49 50 51
    return currentCategoryMap;
  }, {
    activity: [],
    people: [],
    nature: [],
    food: [],
    travel: [],
    objects: [],
    symbols: [],
    flags: [],
  });
}

52
function renderCategory(name, emojiList, opts = {}) {
53 54 55 56
  return `
    <h5 class="emoji-menu-title">
      ${name}
    </h5>
57
    <ul class="clearfix emoji-menu-list ${opts.menuListClass || ''}">
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
      ${emojiList.map(emojiName => `
        <li class="emoji-menu-list-item">
          <button class="emoji-menu-btn text-center js-emoji-btn" type="button">
            ${glEmojiTag(emojiName, {
              sprite: true,
            })}
          </button>
        </li>
      `).join('\n')}
    </ul>
  `;
}

function AwardsHandler() {
  this.eventListeners = [];
  this.aliases = emojiAliases;
  // If the user shows intent let's pre-build the menu
  this.registerEventListener('one', $(document), 'mouseenter focus', '.js-add-award', 'mouseenter focus', () => {
    const $menu = $('.emoji-menu');
    if ($menu.length === 0) {
      requestAnimationFrame(() => {
        this.createEmojiMenu();
Fatih Acet committed
80
      });
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
    }
    // Prebuild the categoryMap
    categoryMap = categoryMap || buildCategoryMap();
  });
  this.registerEventListener('on', $(document), 'click', '.js-add-award', (e) => {
    e.stopPropagation();
    e.preventDefault();
    this.showEmojiMenu($(e.currentTarget));
  });

  this.registerEventListener('on', $('html'), 'click', (e) => {
    const $target = $(e.target);
    if (!$target.closest('.emoji-menu-content').length) {
      $('.js-awards-block.current').removeClass('current');
    }
    if (!$target.closest('.emoji-menu').length) {
      if ($('.emoji-menu').is(':visible')) {
        $('.js-add-award.is-active').removeClass('is-active');
        $('.emoji-menu').removeClass('is-visible');
100
      }
101 102 103 104 105 106 107 108
    }
  });
  this.registerEventListener('on', $(document), 'click', '.js-emoji-btn', (e) => {
    e.preventDefault();
    const $target = $(e.currentTarget);
    const $glEmojiElement = $target.find('gl-emoji');
    const $spriteIconElement = $target.find('.icon');
    const emoji = ($glEmojiElement.length ? $glEmojiElement : $spriteIconElement).data('name');
109

110
    $target.closest('.js-awards-block').addClass('current');
111
    this.addAward(this.getVotesBlock(), this.getAwardUrl(), emoji);
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
  });
}

AwardsHandler.prototype.registerEventListener = function registerEventListener(method = 'on', element, ...args) {
  element[method].call(element, ...args);
  this.eventListeners.push({
    element,
    args,
  });
};

AwardsHandler.prototype.showEmojiMenu = function showEmojiMenu($addBtn) {
  if ($addBtn.hasClass('js-note-emoji')) {
    $addBtn.closest('.note').find('.js-awards-block').addClass('current');
  } else {
    $addBtn.closest('.js-awards-block').addClass('current');
  }

  const $menu = $('.emoji-menu');
131 132
  const $thumbsBtn = $menu.find('[data-name="thumbsup"], [data-name="thumbsdown"]').parent();
  const $userAuthored = this.isUserAuthored($addBtn);
133 134 135 136
  if ($menu.length) {
    if ($menu.is('.is-visible')) {
      $addBtn.removeClass('is-active');
      $menu.removeClass('is-visible');
137
      $('.js-emoji-menu-search').blur();
138 139 140 141
    } else {
      $addBtn.addClass('is-active');
      this.positionMenu($menu, $addBtn);
      $menu.addClass('is-visible');
142
      $('.js-emoji-menu-search').focus();
143 144 145 146 147 148 149 150 151
    }
  } else {
    $addBtn.addClass('is-loading is-active');
    this.createEmojiMenu(() => {
      const $createdMenu = $('.emoji-menu');
      $addBtn.removeClass('is-loading');
      this.positionMenu($createdMenu, $addBtn);
      return setTimeout(() => {
        $createdMenu.addClass('is-visible');
152
        $('.js-emoji-menu-search').focus();
153 154 155
      }, 200);
    });
  }
156 157

  $thumbsBtn.toggleClass('disabled', $userAuthored);
158 159 160
};

// Create the emoji menu with the first category of emojis.
161
// Then render the remaining categories of emojis one by one to avoid jank.
162 163 164 165 166 167 168 169 170 171 172 173
AwardsHandler.prototype.createEmojiMenu = function createEmojiMenu(callback) {
  if (this.isCreatingEmojiMenu) {
    return;
  }
  this.isCreatingEmojiMenu = true;

  // Render the first category
  categoryMap = categoryMap || buildCategoryMap();
  const categoryNameKey = Object.keys(categoryMap)[0];
  const emojisInCategory = categoryMap[categoryNameKey];
  const firstCategory = renderCategory(categoryLabelMap[categoryNameKey], emojisInCategory);

174 175 176 177 178 179 180 181 182
  // Render the frequently used
  const frequentlyUsedEmojis = this.getFrequentlyUsedEmojis();
  let frequentlyUsedCatgegory = '';
  if (frequentlyUsedEmojis.length > 0) {
    frequentlyUsedCatgegory = renderCategory('Frequently used', frequentlyUsedEmojis, {
      menuListClass: 'frequent-emojis',
    });
  }

183 184
  const emojiMenuMarkup = `
    <div class="emoji-menu">
185
      <input type="text" name="emoji-menu-search" value="" class="js-emoji-menu-search emoji-search search-input form-control" placeholder="Search emoji" />
186 187

      <div class="emoji-menu-content">
188
        ${frequentlyUsedCatgegory}
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
        ${firstCategory}
      </div>
    </div>
  `;

  document.body.insertAdjacentHTML('beforeend', emojiMenuMarkup);

  this.addRemainingEmojiMenuCategories();
  this.setupSearch();
  if (callback) {
    callback();
  }
};

AwardsHandler
  .prototype
  .addRemainingEmojiMenuCategories = function addRemainingEmojiMenuCategories() {
    if (this.isAddingRemainingEmojiMenuCategories) {
      return;
    }
    this.isAddingRemainingEmojiMenuCategories = true;

    categoryMap = categoryMap || buildCategoryMap();

    // Avoid the jank and render the remaining categories separately
    // This will take more time, but makes UI more responsive
215 216
    const menu = document.querySelector('.emoji-menu');
    const emojiContentElement = menu.querySelector('.emoji-menu-content');
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
    const remainingCategories = Object.keys(categoryMap).slice(1);
    const allCategoriesAddedPromise = remainingCategories.reduce(
      (promiseChain, categoryNameKey) =>
        promiseChain.then(() =>
          new Promise((resolve) => {
            const emojisInCategory = categoryMap[categoryNameKey];
            const categoryMarkup = renderCategory(
              categoryLabelMap[categoryNameKey],
              emojisInCategory,
            );
            requestAnimationFrame(() => {
              emojiContentElement.insertAdjacentHTML('beforeend', categoryMarkup);
              resolve();
            });
          }),
      ),
      Promise.resolve(),
    );

    allCategoriesAddedPromise.then(() => {
      // Used for tests
      // We check for the menu in case it was destroyed in the meantime
      if (menu) {
        menu.dispatchEvent(new CustomEvent('build-emoji-menu-finish'));
Fatih Acet committed
241
      }
242 243 244
    }).catch((err) => {
      emojiContentElement.insertAdjacentHTML('beforeend', '<p>We encountered an error while adding the remaining categories</p>');
      throw new Error(`Error occurred in addRemainingEmojiMenuCategories: ${err.message}`);
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
    });
  };

AwardsHandler.prototype.positionMenu = function positionMenu($menu, $addBtn) {
  const position = $addBtn.data('position');
  // The menu could potentially be off-screen or in a hidden overflow element
  // So we position the element absolute in the body
  const css = {
    top: `${$addBtn.offset().top + $addBtn.outerHeight()}px`,
  };
  if (position === 'right') {
    css.left = `${($addBtn.offset().left - $menu.outerWidth()) + 20}px`;
    $menu.addClass('is-aligned-right');
  } else {
    css.left = `${$addBtn.offset().left}px`;
    $menu.removeClass('is-aligned-right');
  }
  return $menu.css(css);
};

AwardsHandler.prototype.addAward = function addAward(
  votesBlock,
  awardUrl,
  emoji,
  checkMutuality,
  callback,
) {
  const normalizedEmoji = this.normalizeEmojiName(emoji);
273 274
  const $emojiButton = this.findEmojiIcon(votesBlock, normalizedEmoji).parent();
  this.postEmoji($emojiButton, awardUrl, normalizedEmoji, () => {
275 276 277
    this.addAwardToEmojiBar(votesBlock, normalizedEmoji, checkMutuality);
    return typeof callback === 'function' ? callback() : undefined;
  });
278 279
  $('.emoji-menu').removeClass('is-visible');
  $('.js-add-award.is-active').removeClass('is-active');
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
};

AwardsHandler.prototype.addAwardToEmojiBar = function addAwardToEmojiBar(
  votesBlock,
  emoji,
  checkForMutuality,
) {
  if (checkForMutuality || checkForMutuality === null) {
    this.checkMutuality(votesBlock, emoji);
  }
  this.addEmojiToFrequentlyUsedList(emoji);
  const normalizedEmoji = this.normalizeEmojiName(emoji);
  const $emojiButton = this.findEmojiIcon(votesBlock, normalizedEmoji).parent();
  if ($emojiButton.length > 0) {
    if (this.isActive($emojiButton)) {
      this.decrementCounter($emojiButton, normalizedEmoji);
    } else {
      const counter = $emojiButton.find('.js-counter');
      counter.text(parseInt(counter.text(), 10) + 1);
      $emojiButton.addClass('active');
      this.addYouToUserList(votesBlock, normalizedEmoji);
Fatih Acet committed
301
      this.animateEmoji($emojiButton);
302 303 304 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
    }
  } else {
    votesBlock.removeClass('hidden');
    this.createEmoji(votesBlock, normalizedEmoji);
  }
};

AwardsHandler.prototype.getVotesBlock = function getVotesBlock() {
  const currentBlock = $('.js-awards-block.current');
  let resultantVotesBlock = currentBlock;
  if (currentBlock.length === 0) {
    resultantVotesBlock = $('.js-awards-block').eq(0);
  }

  return resultantVotesBlock;
};

AwardsHandler.prototype.getAwardUrl = function getAwardUrl() {
  return this.getVotesBlock().data('award-url');
};

AwardsHandler.prototype.checkMutuality = function checkMutuality(votesBlock, emoji) {
  const awardUrl = this.getAwardUrl();
  if (emoji === 'thumbsup' || emoji === 'thumbsdown') {
    const mutualVote = emoji === 'thumbsup' ? 'thumbsdown' : 'thumbsup';
    const $emojiButton = votesBlock.find(`[data-name="${mutualVote}"]`).parent();
    const isAlreadyVoted = $emojiButton.hasClass('active');
    if (isAlreadyVoted) {
      this.addAward(votesBlock, awardUrl, mutualVote, false);
    }
  }
};

AwardsHandler.prototype.isActive = function isActive($emojiButton) {
  return $emojiButton.hasClass('active');
};

339 340 341 342
AwardsHandler.prototype.isUserAuthored = function isUserAuthored($button) {
  return $button.hasClass('js-user-authored');
};

343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
AwardsHandler.prototype.decrementCounter = function decrementCounter($emojiButton, emoji) {
  const counter = $('.js-counter', $emojiButton);
  const counterNumber = parseInt(counter.text(), 10);
  if (counterNumber > 1) {
    counter.text(counterNumber - 1);
    this.removeYouFromUserList($emojiButton);
  } else if (emoji === 'thumbsup' || emoji === 'thumbsdown') {
    $emojiButton.tooltip('destroy');
    counter.text('0');
    this.removeYouFromUserList($emojiButton);
    if ($emojiButton.parents('.note').length) {
      this.removeEmoji($emojiButton);
    }
  } else {
    this.removeEmoji($emojiButton);
  }
  return $emojiButton.removeClass('active');
};

AwardsHandler.prototype.removeEmoji = function removeEmoji($emojiButton) {
  $emojiButton.tooltip('destroy');
  $emojiButton.remove();
  const $votesBlock = this.getVotesBlock();
  if ($votesBlock.find('.js-emoji-btn').length === 0) {
    $votesBlock.addClass('hidden');
  }
};

AwardsHandler.prototype.getAwardTooltip = function getAwardTooltip($awardBlock) {
  return $awardBlock.attr('data-original-title') || $awardBlock.attr('data-title') || '';
};

AwardsHandler.prototype.toSentence = function toSentence(list) {
  let sentence;
  if (list.length <= 2) {
    sentence = list.join(' and ');
  } else {
    sentence = `${list.slice(0, -1).join(', ')}, and ${list[list.length - 1]}`;
  }

  return sentence;
};

AwardsHandler.prototype.removeYouFromUserList = function removeYouFromUserList($emojiButton) {
  const awardBlock = $emojiButton;
  const originalTitle = this.getAwardTooltip(awardBlock);
  const authors = originalTitle.split(FROM_SENTENCE_REGEX);
  authors.splice(authors.indexOf('You'), 1);
  return awardBlock
    .closest('.js-emoji-btn')
    .removeData('title')
    .removeAttr('data-title')
    .removeAttr('data-original-title')
    .attr('title', this.toSentence(authors))
    .tooltip('fixTitle');
};

AwardsHandler.prototype.addYouToUserList = function addYouToUserList(votesBlock, emoji) {
  const awardBlock = this.findEmojiIcon(votesBlock, emoji).parent();
  const origTitle = this.getAwardTooltip(awardBlock);
  let users = [];
  if (origTitle) {
    users = origTitle.trim().split(FROM_SENTENCE_REGEX);
  }
  users.unshift('You');
  return awardBlock
    .attr('title', this.toSentence(users))
    .tooltip('fixTitle');
};

AwardsHandler
  .prototype
  .createAwardButtonForVotesBlock = function createAwardButtonForVotesBlock(votesBlock, emojiName) {
    const buttonHtml = `
      <button class="btn award-control js-emoji-btn has-tooltip active" title="You" data-placement="bottom">
        ${glEmojiTag(emojiName)}
        <span class="award-control-text js-counter">1</span>
      </button>
    `;
    const $emojiButton = $(buttonHtml);
    $emojiButton.insertBefore(votesBlock.find('.js-award-holder')).find('.emoji-icon').data('name', emojiName);
    this.animateEmoji($emojiButton);
    $('.award-control').tooltip();
    votesBlock.removeClass('current');
  };

AwardsHandler.prototype.animateEmoji = function animateEmoji($emoji) {
  const className = 'pulse animated once short';
  $emoji.addClass(className);

  this.registerEventListener('on', $emoji, animationEndEventString, (e) => {
    $(e.currentTarget).removeClass(className);
  });
};

AwardsHandler.prototype.createEmoji = function createEmoji(votesBlock, emoji) {
  if ($('.emoji-menu').length) {
    this.createAwardButtonForVotesBlock(votesBlock, emoji);
  }
  this.createEmojiMenu(() => {
    this.createAwardButtonForVotesBlock(votesBlock, emoji);
  });
};

447 448 449 450 451 452 453 454 455 456 457 458
AwardsHandler.prototype.postEmoji = function postEmoji($emojiButton, awardUrl, emoji, callback) {
  if (this.isUserAuthored($emojiButton)) {
    this.userAuthored($emojiButton);
  } else {
    $.post(awardUrl, {
      name: emoji,
    }, (data) => {
      if (data.ok) {
        callback();
      }
    }).fail(() => new Flash('Something went wrong on our end.'));
  }
459 460 461 462 463 464
};

AwardsHandler.prototype.findEmojiIcon = function findEmojiIcon(votesBlock, emoji) {
  return votesBlock.find(`.js-emoji-btn [data-name="${emoji}"]`);
};

465 466 467 468 469 470 471 472 473 474 475
AwardsHandler.prototype.userAuthored = function userAuthored($emojiButton) {
  const oldTitle = this.getAwardTooltip($emojiButton);
  const newTitle = 'You cannot vote on your own issue, MR and note';
  gl.utils.updateTooltipTitle($emojiButton, newTitle).tooltip('show');
  // Restore tooltip back to award list
  return setTimeout(() => {
    $emojiButton.tooltip('hide');
    gl.utils.updateTooltipTitle($emojiButton, oldTitle);
  }, 2800);
};

476 477 478 479 480 481 482 483
AwardsHandler.prototype.scrollToAwards = function scrollToAwards() {
  const options = {
    scrollTop: $('.awards').offset().top - 110,
  };
  return $('body, html').animate(options, 200);
};

AwardsHandler.prototype.normalizeEmojiName = function normalizeEmojiName(emoji) {
484
  return Object.prototype.hasOwnProperty.call(this.aliases, emoji) ? this.aliases[emoji] : emoji;
485 486 487 488 489
};

AwardsHandler
  .prototype
  .addEmojiToFrequentlyUsedList = function addEmojiToFrequentlyUsedList(emoji) {
490 491 492 493
    if (isEmojiNameValid(emoji)) {
      this.frequentlyUsedEmojis = _.uniq(this.getFrequentlyUsedEmojis().concat(emoji));
      Cookies.set('frequently_used_emojis', this.frequentlyUsedEmojis.join(','), { expires: 365 });
    }
494 495 496
  };

AwardsHandler.prototype.getFrequentlyUsedEmojis = function getFrequentlyUsedEmojis() {
497 498 499 500 501 502 503 504
  return this.frequentlyUsedEmojis || (() => {
    const frequentlyUsedEmojis = _.uniq((Cookies.get('frequently_used_emojis') || '').split(','));
    this.frequentlyUsedEmojis = frequentlyUsedEmojis.filter(
      inputName => isEmojiNameValid(inputName),
    );

    return this.frequentlyUsedEmojis;
  })();
505 506 507
};

AwardsHandler.prototype.setupSearch = function setupSearch() {
508 509 510
  const $search = $('.js-emoji-menu-search');

  this.registerEventListener('on', $search, 'input', (e) => {
511
    const term = $(e.target).val().trim();
512 513 514 515 516 517 518 519
    this.searchEmojis(term);
  });

  const $menu = $('.emoji-menu');
  this.registerEventListener('on', $menu, transitionEndEventString, (e) => {
    if (e.target === e.currentTarget) {
      // Clear the search
      this.searchEmojis('');
520 521 522
    }
  });
};
523

524
AwardsHandler.prototype.searchEmojis = function searchEmojis(term) {
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
  const $search = $('.js-emoji-menu-search');
  $search.val(term);

  // Clean previous search results
  $('ul.emoji-menu-search, h5.emoji-search-title').remove();
  if (term.length > 0) {
    // Generate a search result block
    const h5 = $('<h5 class="emoji-search-title"/>').text('Search results');
    const foundEmojis = this.findMatchingEmojiElements(term).show();
    const ul = $('<ul>').addClass('emoji-menu-list emoji-menu-search').append(foundEmojis);
    $('.emoji-menu-content ul, .emoji-menu-content h5').hide();
    $('.emoji-menu-content').append(h5).append(ul);
  } else {
    $('.emoji-menu-content').children().show();
  }
};

AwardsHandler.prototype.findMatchingEmojiElements = function findMatchingEmojiElements(term) {
543
  const safeTerm = term.toLowerCase();
Fatih Acet committed
544

545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
  const namesMatchingAlias = [];
  Object.keys(emojiAliases).forEach((alias) => {
    if (alias.indexOf(safeTerm) >= 0) {
      namesMatchingAlias.push(emojiAliases[alias]);
    }
  });
  const $matchingElements = namesMatchingAlias.concat(safeTerm)
    .reduce(
      ($result, searchTerm) =>
        $result.add($(`.emoji-menu-list:not(.frequent-emojis) [data-name*="${searchTerm}"]`)),
      $([]),
    );
  return $matchingElements.closest('li').clone();
};

AwardsHandler.prototype.destroy = function destroy() {
  this.eventListeners.forEach((entry) => {
    entry.element.off.call(entry.element, ...entry.args);
  });
  $('.emoji-menu').remove();
};

567
export default AwardsHandler;