notes.js 51 KB
Newer Older
1
/* eslint-disable no-restricted-properties, func-names, space-before-function-paren, no-var, prefer-rest-params, wrap-iife, no-use-before-define, camelcase, no-unused-expressions, quotes, max-len, one-var, one-var-declaration-per-line, default-case, prefer-template, consistent-return, no-alert, no-return-assign, no-param-reassign, prefer-arrow-callback, no-else-return, comma-dangle, no-new, brace-style, no-lonely-if, vars-on-top, no-unused-vars, no-sequences, no-shadow, newline-per-chained-call, no-useless-escape */
2 3 4
/* global Flash */
/* global Autosave */
/* global ResolveService */
5
/* global mrRefreshWidgetUrl */
Fatih Acet's avatar
Fatih Acet committed
6

7
import $ from 'jquery';
8
import Cookies from 'js-cookie';
9
import CommentTypeToggle from './comment_type_toggle';
10

11 12 13 14 15 16 17
require('./autosave');
window.autosize = require('vendor/autosize');
window.Dropzone = require('dropzone');
require('./dropzone_input');
require('./gfm_auto_complete');
require('vendor/jquery.caret'); // required by jquery.atwho
require('vendor/jquery.atwho');
18
require('./task_list');
Fatih Acet's avatar
Fatih Acet committed
19

20 21 22 23
const normalizeNewlines = function(str) {
  return str.replace(/\r\n/g, '\n');
};

Fatih Acet's avatar
Fatih Acet committed
24
(function() {
25
  var bind = function(fn, me) { return function() { return fn.apply(me, arguments); }; };
Fatih Acet's avatar
Fatih Acet committed
26 27

  this.Notes = (function() {
28
    const MAX_VISIBLE_COMMIT_LIST_COUNT = 3;
29
    const REGEX_SLASH_COMMANDS = /^\/\w+/gm;
Fatih Acet's avatar
Fatih Acet committed
30 31 32 33 34

    Notes.interval = null;

    function Notes(notes_url, note_ids, last_fetched_at, view) {
      this.updateTargetButtons = bind(this.updateTargetButtons, this);
35
      this.updateComment = bind(this.updateComment, this);
Fatih Acet's avatar
Fatih Acet committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49
      this.visibilityChange = bind(this.visibilityChange, this);
      this.cancelDiscussionForm = bind(this.cancelDiscussionForm, this);
      this.addDiffNote = bind(this.addDiffNote, this);
      this.setupDiscussionNoteForm = bind(this.setupDiscussionNoteForm, this);
      this.replyToDiscussionNote = bind(this.replyToDiscussionNote, this);
      this.removeNote = bind(this.removeNote, this);
      this.cancelEdit = bind(this.cancelEdit, this);
      this.updateNote = bind(this.updateNote, this);
      this.addDiscussionNote = bind(this.addDiscussionNote, this);
      this.addNoteError = bind(this.addNoteError, this);
      this.addNote = bind(this.addNote, this);
      this.resetMainTargetForm = bind(this.resetMainTargetForm, this);
      this.refresh = bind(this.refresh, this);
      this.keydownNoteText = bind(this.keydownNoteText, this);
50
      this.toggleCommitList = bind(this.toggleCommitList, this);
51
      this.postComment = bind(this.postComment, this);
52

Fatih Acet's avatar
Fatih Acet committed
53 54
      this.notes_url = notes_url;
      this.note_ids = note_ids;
55 56
      // Used to keep track of updated notes while people are editing things
      this.updatedNotesTrackingMap = {};
Fatih Acet's avatar
Fatih Acet committed
57 58 59 60 61
      this.last_fetched_at = last_fetched_at;
      this.noteable_url = document.URL;
      this.notesCountBadge || (this.notesCountBadge = $(".issuable-details").find(".notes-tab .badge"));
      this.basePollingInterval = 15000;
      this.maxPollingSteps = 4;
62

Fatih Acet's avatar
Fatih Acet committed
63 64 65 66
      this.cleanBinding();
      this.addBinding();
      this.setPollingInterval();
      this.setupMainTargetNoteForm();
67 68
      this.taskList = new gl.TaskList({
        dataType: 'note',
69
        fieldName: 'note',
70
        selector: '.notes'
71
      });
72
      this.collapseLongCommitList();
73
      this.setViewType(view);
74 75 76 77

      // We are in the Merge Requests page so we need another edit form for Changes tab
      if (gl.utils.getPagePath(1) === 'merge_requests') {
        $('.note-edit-form').clone()
78
          .addClass('mr-note-edit-form').insertAfter('.note-edit-form');
79
      }
Fatih Acet's avatar
Fatih Acet committed
80 81
    }

82 83 84 85
    Notes.prototype.setViewType = function(view) {
      this.view = Cookies.get('diff_view') || view;
    };

Fatih Acet's avatar
Fatih Acet committed
86
    Notes.prototype.addBinding = function() {
87
      // Edit note link
88
      $(document).on("click", ".js-note-edit", this.showEditForm.bind(this));
Fatih Acet's avatar
Fatih Acet committed
89
      $(document).on("click", ".note-edit-cancel", this.cancelEdit);
90
      // Reopen and close actions for Issue/MR combined with note form submit
91 92
      $(document).on("click", ".js-comment-submit-button", this.postComment);
      $(document).on("click", ".js-comment-save-button", this.updateComment);
Fatih Acet's avatar
Fatih Acet committed
93
      $(document).on("keyup input", ".js-note-text", this.updateTargetButtons);
94
      // resolve a discussion
95
      $(document).on('click', '.js-comment-resolve-button', this.postComment);
96
      // remove a note (in general)
Fatih Acet's avatar
Fatih Acet committed
97
      $(document).on("click", ".js-note-delete", this.removeNote);
98
      // delete note attachment
Fatih Acet's avatar
Fatih Acet committed
99
      $(document).on("click", ".js-note-attachment-delete", this.removeAttachment);
100
      // reset main target form when clicking discard
Fatih Acet's avatar
Fatih Acet committed
101
      $(document).on("click", ".js-note-discard", this.resetMainTargetForm);
102
      // update the file name when an attachment is selected
Fatih Acet's avatar
Fatih Acet committed
103
      $(document).on("change", ".js-note-attachment-input", this.updateFormAttachment);
104
      // reply to diff/discussion notes
Fatih Acet's avatar
Fatih Acet committed
105
      $(document).on("click", ".js-discussion-reply-button", this.replyToDiscussionNote);
106
      // add diff note
Fatih Acet's avatar
Fatih Acet committed
107
      $(document).on("click", ".js-add-diff-note-button", this.addDiffNote);
108
      // hide diff note form
Fatih Acet's avatar
Fatih Acet committed
109
      $(document).on("click", ".js-close-discussion-note-form", this.cancelDiscussionForm);
110 111
      // toggle commit list
      $(document).on("click", '.system-note-commit-list-toggler', this.toggleCommitList);
112
      // fetch notes when tab becomes visible
Fatih Acet's avatar
Fatih Acet committed
113
      $(document).on("visibilitychange", this.visibilityChange);
114
      // when issue status changes, we need to refresh data
Fatih Acet's avatar
Fatih Acet committed
115
      $(document).on("issuable:change", this.refresh);
116 117 118 119 120
      // ajax:events that happen on Form when actions like Reopen, Close are performed on Issues and MRs.
      $(document).on("ajax:success", ".js-main-target-form", this.addNote);
      $(document).on("ajax:success", ".js-discussion-note-form", this.addDiscussionNote);
      $(document).on("ajax:success", ".js-main-target-form", this.resetMainTargetForm);
      $(document).on("ajax:complete", ".js-main-target-form", this.reenableTargetFormSubmitButton);
121
      // when a key is clicked on the notes
Fatih Acet's avatar
Fatih Acet committed
122 123 124 125 126 127 128 129 130 131 132
      return $(document).on("keydown", ".js-note-text", this.keydownNoteText);
    };

    Notes.prototype.cleanBinding = function() {
      $(document).off("click", ".js-note-edit");
      $(document).off("click", ".note-edit-cancel");
      $(document).off("click", ".js-note-delete");
      $(document).off("click", ".js-note-attachment-delete");
      $(document).off("click", ".js-discussion-reply-button");
      $(document).off("click", ".js-add-diff-note-button");
      $(document).off("visibilitychange");
133
      $(document).off("keyup input", ".js-note-text");
Fatih Acet's avatar
Fatih Acet committed
134 135 136 137
      $(document).off("click", ".js-note-target-reopen");
      $(document).off("click", ".js-note-target-close");
      $(document).off("click", ".js-note-discard");
      $(document).off("keydown", ".js-note-text");
138
      $(document).off('click', '.js-comment-resolve-button');
139
      $(document).off("click", '.system-note-commit-list-toggler');
140 141 142
      $(document).off("ajax:success", ".js-main-target-form");
      $(document).off("ajax:success", ".js-discussion-note-form");
      $(document).off("ajax:complete", ".js-main-target-form");
Fatih Acet's avatar
Fatih Acet committed
143 144
    };

145 146 147 148 149 150
    Notes.initCommentTypeToggle = function (form) {
      const dropdownTrigger = form.querySelector('.js-comment-type-dropdown .dropdown-toggle');
      const dropdownList = form.querySelector('.js-comment-type-dropdown .dropdown-menu');
      const noteTypeInput = form.querySelector('#note_type');
      const submitButton = form.querySelector('.js-comment-type-dropdown .js-comment-submit-button');
      const closeButton = form.querySelector('.js-note-target-close');
151
      const reopenButton = form.querySelector('.js-note-target-reopen');
152 153 154 155 156 157 158 159 160

      const commentTypeToggle = new CommentTypeToggle({
        dropdownTrigger,
        dropdownList,
        noteTypeInput,
        submitButton,
        closeButton,
        reopenButton,
      });
161

162
      commentTypeToggle.initDroplab();
163 164
    };

Fatih Acet's avatar
Fatih Acet committed
165 166
    Notes.prototype.keydownNoteText = function(e) {
      var $textarea, discussionNoteForm, editNote, myLastNote, myLastNoteEditBtn, newText, originalText;
167
      if (gl.utils.isMetaKey(e)) {
Fatih Acet's avatar
Fatih Acet committed
168 169
        return;
      }
170

Fatih Acet's avatar
Fatih Acet committed
171
      $textarea = $(e.target);
172
      // Edit previous note when UP arrow is hit
Fatih Acet's avatar
Fatih Acet committed
173 174 175 176 177 178 179 180 181 182 183
      switch (e.which) {
        case 38:
          if ($textarea.val() !== '') {
            return;
          }
          myLastNote = $("li.note[data-author-id='" + gon.current_user_id + "'][data-editable]:last");
          if (myLastNote.length) {
            myLastNoteEditBtn = myLastNote.find('.js-note-edit');
            return myLastNoteEditBtn.trigger('click', [true, myLastNote]);
          }
          break;
184
        // Cancel creating diff note or editing any note when ESCAPE is hit
Fatih Acet's avatar
Fatih Acet committed
185 186 187 188 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 215 216 217 218 219
        case 27:
          discussionNoteForm = $textarea.closest('.js-discussion-note-form');
          if (discussionNoteForm.length) {
            if ($textarea.val() !== '') {
              if (!confirm('Are you sure you want to cancel creating this comment?')) {
                return;
              }
            }
            this.removeDiscussionNoteForm(discussionNoteForm);
            return;
          }
          editNote = $textarea.closest('.note');
          if (editNote.length) {
            originalText = $textarea.closest('form').data('original-note');
            newText = $textarea.val();
            if (originalText !== newText) {
              if (!confirm('Are you sure you want to cancel editing this comment?')) {
                return;
              }
            }
            return this.removeNoteEditForm(editNote);
          }
      }
    };

    Notes.prototype.initRefresh = function() {
      clearInterval(Notes.interval);
      return Notes.interval = setInterval((function(_this) {
        return function() {
          return _this.refresh();
        };
      })(this), this.pollingInterval);
    };

    Notes.prototype.refresh = function() {
Douwe Maan's avatar
Douwe Maan committed
220
      if (!document.hidden) {
Fatih Acet's avatar
Fatih Acet committed
221 222 223 224 225 226 227 228 229 230 231
        return this.getContent();
      }
    };

    Notes.prototype.getContent = function() {
      if (this.refreshing) {
        return;
      }
      this.refreshing = true;
      return $.ajax({
        url: this.notes_url,
232
        headers: { "X-Last-Fetched-At": this.last_fetched_at },
Fatih Acet's avatar
Fatih Acet committed
233 234 235 236 237 238 239 240
        dataType: "json",
        success: (function(_this) {
          return function(data) {
            var notes;
            notes = data.notes;
            _this.last_fetched_at = data.last_fetched_at;
            _this.setPollingInterval(data.notes.length);
            return $.each(notes, function(i, note) {
241
              _this.renderNote(note);
Fatih Acet's avatar
Fatih Acet committed
242 243 244 245 246 247 248 249 250 251 252 253 254 255
            });
          };
        })(this)
      }).always((function(_this) {
        return function() {
          return _this.refreshing = false;
        };
      })(this));
    };

    /*
    Increase @pollingInterval up to 120 seconds on every function call,
    if `shouldReset` has a truthy value, 'null' or 'undefined' the variable
    will reset to @basePollingInterval.
256

Fatih Acet's avatar
Fatih Acet committed
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
    Note: this function is used to gradually increase the polling interval
    if there aren't new notes coming from the server
     */

    Notes.prototype.setPollingInterval = function(shouldReset) {
      var nthInterval;
      if (shouldReset == null) {
        shouldReset = true;
      }
      nthInterval = this.basePollingInterval * Math.pow(2, this.maxPollingSteps - 1);
      if (shouldReset) {
        this.pollingInterval = this.basePollingInterval;
      } else if (this.pollingInterval < nthInterval) {
        this.pollingInterval *= 2;
      }
      return this.initRefresh();
    };

275
    Notes.prototype.handleSlashCommands = function(noteEntity) {
mhasbini's avatar
mhasbini committed
276
      var votesBlock;
277 278
      if (noteEntity.commands_changes) {
        if ('merge' in noteEntity.commands_changes) {
279
          Notes.checkMergeRequestStatus();
mhasbini's avatar
mhasbini committed
280 281
        }

282
        if ('emoji_award' in noteEntity.commands_changes) {
mhasbini's avatar
mhasbini committed
283
          votesBlock = $('.js-awards-block').eq(0);
284
          gl.awardsHandler.addAwardToEmojiBar(votesBlock, noteEntity.commands_changes.emoji_award);
mhasbini's avatar
mhasbini committed
285 286
          return gl.awardsHandler.scrollToAwards();
        }
287 288 289
      }
    };

Fatih Acet's avatar
Fatih Acet committed
290 291
    /*
    Render note in main comments area.
292

Fatih Acet's avatar
Fatih Acet committed
293 294 295
    Note: for rendering inline notes use renderDiscussionNote
     */

296 297 298
    Notes.prototype.renderNote = function(noteEntity, $form, $notesList = $('.main-notes-list')) {
      if (noteEntity.discussion_html != null) {
        return this.renderDiscussionNote(noteEntity, $form);
299 300
      }

301 302 303
      if (!noteEntity.valid) {
        if (noteEntity.errors.commands_only) {
          new Flash(noteEntity.errors.commands_only, 'notice', this.parentTimeline);
mhasbini's avatar
mhasbini committed
304
          this.refresh();
Fatih Acet's avatar
Fatih Acet committed
305 306 307
        }
        return;
      }
mhasbini's avatar
mhasbini committed
308

309 310 311
      const $note = $notesList.find(`#note_${noteEntity.id}`);
      if (this.isNewNote(noteEntity)) {
        this.note_ids.push(noteEntity.id);
312

313
        const $newNote = Notes.animateAppendNote(noteEntity.html, $notesList);
314

315
        // Update datetime format on the recent note
316
        gl.utils.localTimeAgo($newNote.find('.js-timeago'), false);
317
        this.collapseLongCommitList();
318
        this.taskList.init();
319
        this.refresh();
Fatih Acet's avatar
Fatih Acet committed
320 321
        return this.updateNotesCount(1);
      }
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
      // The server can send the same update multiple times so we need to make sure to only update once per actual update.
      else if (this.isUpdatedNote(noteEntity, $note)) {
        const isEditing = $note.hasClass('is-editing');
        const initialContent = normalizeNewlines(
          $note.find('.original-note-content').text().trim()
        );
        const $textarea = $note.find('.js-note-text');
        const currentContent = $textarea.val();
        // There can be CRLF vs LF mismatches if we don't sanitize and compare the same way
        const sanitizedNoteNote = normalizeNewlines(noteEntity.note);
        const isTextareaUntouched = currentContent === initialContent || currentContent === sanitizedNoteNote;

        if (isEditing && isTextareaUntouched) {
          $textarea.val(noteEntity.note);
          this.updatedNotesTrackingMap[noteEntity.id] = noteEntity;
        }
        else if (isEditing && !isTextareaUntouched) {
          this.putConflictEditWarningInPlace(noteEntity, $note);
          this.updatedNotesTrackingMap[noteEntity.id] = noteEntity;
        }
        else {
          const $updatedNote = Notes.animateUpdateNote(noteEntity.html, $note);

          // Update datetime format on the recent note
          gl.utils.localTimeAgo($updatedNote.find('.js-timeago'), false);
        }
      }
Fatih Acet's avatar
Fatih Acet committed
349 350 351 352 353 354
    };

    /*
    Check if note does not exists on page
     */

355 356 357 358 359 360 361 362 363 364 365
    Notes.prototype.isNewNote = function(noteEntity) {
      return $.inArray(noteEntity.id, this.note_ids) === -1;
    };

    Notes.prototype.isUpdatedNote = function(noteEntity, $note) {
      // There can be CRLF vs LF mismatches if we don't sanitize and compare the same way
      const sanitizedNoteNote = normalizeNewlines(noteEntity.note);
      const currentNoteText = normalizeNewlines(
        $note.find('.original-note-content').text().trim()
      );
      return sanitizedNoteNote !== currentNoteText;
Fatih Acet's avatar
Fatih Acet committed
366 367 368
    };

    Notes.prototype.isParallelView = function() {
369
      return Cookies.get('diff_view') === 'parallel';
Fatih Acet's avatar
Fatih Acet committed
370 371 372 373
    };

    /*
    Render note in discussion area.
374

Fatih Acet's avatar
Fatih Acet committed
375 376 377
    Note: for rendering inline notes use renderDiscussionNote
     */

378
    Notes.prototype.renderDiscussionNote = function(noteEntity, $form) {
379
      var discussionContainer, form, row, lineType, diffAvatarContainer;
380
      if (!this.isNewNote(noteEntity)) {
Fatih Acet's avatar
Fatih Acet committed
381 382
        return;
      }
383 384
      this.note_ids.push(noteEntity.id);
      form = $form || $(".js-discussion-note-form[data-discussion-id='" + noteEntity.discussion_id + "']");
Fatih Acet's avatar
Fatih Acet committed
385
      row = form.closest("tr");
386 387
      lineType = this.isParallelView() ? form.find('#line_type').val() : 'old';
      diffAvatarContainer = row.prevAll('.line_holder').first().find('.js-avatar-container.' + lineType + '_line');
388
      // is this the first note of discussion?
389
      discussionContainer = $(`.notes[data-discussion-id="${noteEntity.discussion_id}"]`);
390 391
      if (!discussionContainer.length) {
        discussionContainer = form.closest('.discussion').find('.notes');
Fatih Acet's avatar
Fatih Acet committed
392 393
      }
      if (discussionContainer.length === 0) {
394 395
        if (noteEntity.diff_discussion_html) {
          var $discussion = $(noteEntity.diff_discussion_html).renderGFM();
396 397 398 399 400 401

          if (!this.isParallelView() || row.hasClass('js-temp-notes-holder')) {
            // insert the note and the reply button after the temp row
            row.after($discussion);
          } else {
            // Merge new discussion HTML in
402
            var $notes = $discussion.find('.notes[data-discussion-id="' + noteEntity.discussion_id + '"]');
403 404 405 406 407 408 409
            var contentContainerClass = '.' + $notes.closest('.notes_content')
              .attr('class')
              .split(' ')
              .join('.');

            row.find(contentContainerClass + ' .content').append($notes.closest('.content').children());
          }
410
        }
411
        // Init discussion on 'Discussion' page if it is merge request page
412 413 414
        const page = $('body').attr('data-page');
        if ((page && page.indexOf('projects:merge_request') === 0) || !noteEntity.diff_discussion_html) {
          Notes.animateAppendNote(noteEntity.discussion_html, $('.main-notes-list'));
Fatih Acet's avatar
Fatih Acet committed
415 416
        }
      } else {
417
        // append new note to all matching discussions
418
        Notes.animateAppendNote(noteEntity.html, discussionContainer);
Fatih Acet's avatar
Fatih Acet committed
419
      }
420

421
      if (typeof gl.diffNotesCompileComponents !== 'undefined' && noteEntity.discussion_resolvable) {
422
        gl.diffNotesCompileComponents();
423
        this.renderDiscussionAvatar(diffAvatarContainer, noteEntity);
424 425
      }

426
      gl.utils.localTimeAgo($('.js-timeago'), false);
427
      Notes.checkMergeRequestStatus();
Fatih Acet's avatar
Fatih Acet committed
428 429 430
      return this.updateNotesCount(1);
    };

431 432 433 434 435 436 437
    Notes.prototype.getLineHolder = function(changesDiscussionContainer) {
      return $(changesDiscussionContainer).closest('.notes_holder')
        .prevAll('.line_holder')
        .first()
        .get(0);
    };

438
    Notes.prototype.renderDiscussionAvatar = function(diffAvatarContainer, noteEntity) {
439 440 441 442 443
      var commentButton = diffAvatarContainer.find('.js-add-diff-note-button');
      var avatarHolder = diffAvatarContainer.find('.diff-comment-avatar-holders');

      if (!avatarHolder.length) {
        avatarHolder = document.createElement('diff-note-avatars');
444
        avatarHolder.setAttribute('discussion-id', noteEntity.discussion_id);
445 446 447 448 449 450 451 452 453 454 455

        diffAvatarContainer.append(avatarHolder);

        gl.diffNotesCompileComponents();
      }

      if (commentButton.length) {
        commentButton.remove();
      }
    };

Fatih Acet's avatar
Fatih Acet committed
456 457
    /*
    Called in response the main target form has been successfully submitted.
458

Fatih Acet's avatar
Fatih Acet committed
459 460 461 462 463 464 465 466
    Removes any errors.
    Resets text and preview.
    Resets buttons.
     */

    Notes.prototype.resetMainTargetForm = function(e) {
      var form;
      form = $(".js-main-target-form");
467
      // remove validation errors
Fatih Acet's avatar
Fatih Acet committed
468
      form.find(".js-errors").remove();
469
      // reset text and preview
Fatih Acet's avatar
Fatih Acet committed
470 471 472
      form.find(".js-md-write-button").click();
      form.find(".js-note-text").val("").trigger("input");
      form.find(".js-note-text").data("autosave").reset();
473 474 475 476 477 478

      var event = document.createEvent('Event');
      event.initEvent('autosize:update', true, false);
      form.find('.js-autosize')[0].dispatchEvent(event);

      this.updateTargetButtons(e);
Fatih Acet's avatar
Fatih Acet committed
479 480 481 482 483 484 485 486 487 488
    };

    Notes.prototype.reenableTargetFormSubmitButton = function() {
      var form;
      form = $(".js-main-target-form");
      return form.find(".js-note-text").trigger("input");
    };

    /*
    Shows the main form and does some setup on it.
489

Fatih Acet's avatar
Fatih Acet committed
490 491 492 493 494
    Sets some hidden fields in the form.
     */

    Notes.prototype.setupMainTargetNoteForm = function() {
      var form;
495
      // find the form
Fatih Acet's avatar
Fatih Acet committed
496
      form = $(".js-new-note-form");
497
      // Set a global clone of the form for later cloning
Fatih Acet's avatar
Fatih Acet committed
498
      this.formClone = form.clone();
499
      // show the form
Fatih Acet's avatar
Fatih Acet committed
500
      this.setupNoteForm(form);
501
      // fix classes
Fatih Acet's avatar
Fatih Acet committed
502 503 504 505
      form.removeClass("js-new-note-form");
      form.addClass("js-main-target-form");
      form.find("#note_line_code").remove();
      form.find("#note_position").remove();
506
      form.find("#note_type").val('');
Douwe Maan's avatar
Douwe Maan committed
507
      form.find("#in_reply_to_discussion_id").remove();
508
      form.find('.js-comment-resolve-button').closest('comment-and-resolve-btn').remove();
509 510
      this.parentTimeline = form.parents('.timeline');

511
      if (form.length) {
512
        Notes.initCommentTypeToggle(form.get(0));
513
      }
Fatih Acet's avatar
Fatih Acet committed
514 515 516 517
    };

    /*
    General note form setup.
518

Fatih Acet's avatar
Fatih Acet committed
519 520 521 522 523 524 525
    deactivates the submit button when text is empty
    hides the preview button when text is empty
    setup GFM auto complete
    show the form
     */

    Notes.prototype.setupNoteForm = function(form) {
526
      var textarea, key;
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
527
      new gl.GLForm(form);
Fatih Acet's avatar
Fatih Acet committed
528
      textarea = form.find(".js-note-text");
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
      key = [
        "Note",
        form.find("#note_noteable_type").val(),
        form.find("#note_noteable_id").val(),
        form.find("#note_commit_id").val(),
        form.find("#note_type").val(),
        form.find("#in_reply_to_discussion_id").val(),

        // LegacyDiffNote
        form.find("#note_line_code").val(),

        // DiffNote
        form.find("#note_position").val()
      ];
      return new Autosave(textarea, key);
Fatih Acet's avatar
Fatih Acet committed
544 545 546 547
    };

    /*
    Called in response to the new note form being submitted
548

Fatih Acet's avatar
Fatih Acet committed
549 550 551
    Adds new note to list.
     */

552
    Notes.prototype.addNote = function($form, note) {
Fatih Acet's avatar
Fatih Acet committed
553 554 555
      return this.renderNote(note);
    };

556 557 558 559 560 561 562 563
    Notes.prototype.addNoteError = ($form) => {
      let formParentTimeline;
      if ($form.hasClass('js-main-target-form')) {
        formParentTimeline = $form.parents('.timeline');
      } else if ($form.hasClass('js-discussion-note-form')) {
        formParentTimeline = $form.closest('.discussion-notes').find('.notes');
      }
      return new Flash('Your comment could not be submitted! Please check your network connection and try again.', 'alert', formParentTimeline);
Fatih Acet's avatar
Fatih Acet committed
564 565
    };

566 567
    Notes.prototype.updateNoteError = $parentTimeline => new Flash('Your comment could not be updated! Please check your network connection and try again.');

Fatih Acet's avatar
Fatih Acet committed
568 569
    /*
    Called in response to the new note form being submitted
570

Fatih Acet's avatar
Fatih Acet committed
571 572 573
    Adds new note to list.
     */

574
    Notes.prototype.addDiscussionNote = function($form, note, isNewDiffComment) {
575
      if ($form.attr('data-resolve-all') != null) {
576 577 578
        var projectPath = $form.data('project-path');
        var discussionId = $form.data('discussion-id');
        var mergeRequestId = $form.data('noteable-iid');
579 580

        if (ResolveService != null) {
581
          ResolveService.toggleResolveForDiscussion(mergeRequestId, discussionId);
582 583
        }
      }
584

585
      this.renderNote(note, $form);
586
      // cleanup after successfully creating a diff/discussion note
587 588 589
      if (isNewDiffComment) {
        this.removeDiscussionNoteForm($form);
      }
Fatih Acet's avatar
Fatih Acet committed
590 591 592 593
    };

    /*
    Called in response to the edit note form being submitted
594

Fatih Acet's avatar
Fatih Acet committed
595 596 597
    Updates the current note field.
     */

598
    Notes.prototype.updateNote = function(_xhr, noteEntity, _status) {
599
      var $noteEntityEl, $note_li;
600
      // Convert returned HTML to a jQuery object so we can modify it further
601 602
      $noteEntityEl = $(noteEntity.html);
      $noteEntityEl.addClass('fade-in-full');
603
      this.revertNoteEditForm();
604 605 606
      gl.utils.localTimeAgo($('.js-timeago', $noteEntityEl));
      $noteEntityEl.renderGFM();
      $noteEntityEl.find('.js-task-list-container').taskList('enable');
607
      // Find the note's `li` element by ID and replace it with the updated HTML
608
      $note_li = $('.note-row-' + noteEntity.id);
609

610
      $note_li.replaceWith($noteEntityEl);
611

612 613
      if (typeof gl.diffNotesCompileComponents !== 'undefined') {
        gl.diffNotesCompileComponents();
614
      }
Fatih Acet's avatar
Fatih Acet committed
615 616
    };

617 618
    Notes.prototype.checkContentToAllowEditing = function($el) {
      var initialContent = $el.find('.original-note-content').text().trim();
619
      var currentContent = $el.find('.js-note-text').val();
620 621 622 623 624 625 626
      var isAllowed = true;

      if (currentContent === initialContent) {
        this.removeNoteEditForm($el);
      }
      else {
        var $buttons = $el.find('.note-form-actions');
Fatih Acet's avatar
Fatih Acet committed
627
        var isWidgetVisible = gl.utils.isInViewport($el.get(0));
628

629
        if (!isWidgetVisible) {
Fatih Acet's avatar
Fatih Acet committed
630
          gl.utils.scrollToElement($el);
631 632
        }

633
        $el.find('.js-finish-edit-warning').show();
634 635 636 637
        isAllowed = false;
      }

      return isAllowed;
638
    };
639

Fatih Acet's avatar
Fatih Acet committed
640 641
    /*
    Called in response to clicking the edit note link
642

Fatih Acet's avatar
Fatih Acet committed
643 644
    Replaces the note text with the note edit form
    Adds a data attribute to the form with the original content of the note for cancellations
645
    */
Fatih Acet's avatar
Fatih Acet committed
646 647
    Notes.prototype.showEditForm = function(e, scrollTo, myLastNote) {
      e.preventDefault();
648

649
      var $target = $(e.target);
650
      var $editForm = $(this.getEditFormSelector($target));
651
      var $note = $target.closest('.note');
652
      var $currentlyEditing = $('.note.is-editing:visible');
653

654 655 656 657 658 659 660 661
      if ($currentlyEditing.length) {
        var isEditAllowed = this.checkContentToAllowEditing($currentlyEditing);

        if (!isEditAllowed) {
          return;
        }
      }

662
      $note.find('.js-note-attachment-delete').show();
663
      $editForm.addClass('current-note-edit-form');
664
      $note.addClass('is-editing');
665
      this.putEditFormInPlace($target);
Fatih Acet's avatar
Fatih Acet committed
666 667 668 669
    };

    /*
    Called in response to clicking the edit note link
670

Fatih Acet's avatar
Fatih Acet committed
671 672 673 674 675
    Hides edit form and restores the original note text to the editor textarea.
     */

    Notes.prototype.cancelEdit = function(e) {
      e.preventDefault();
676 677 678 679
      const $target = $(e.target);
      const $note = $target.closest('.note');
      const noteId = $note.attr('data-note-id');

680
      this.revertNoteEditForm($target);
681 682 683 684 685 686 687 688 689 690 691 692 693

      if (this.updatedNotesTrackingMap[noteId]) {
        const $newNote = $(this.updatedNotesTrackingMap[noteId].html);
        $note.replaceWith($newNote);
        this.updatedNotesTrackingMap[noteId] = null;

        // Update datetime format on the recent note
        gl.utils.localTimeAgo($newNote.find('.js-timeago'), false);
      }
      else {
        $note.find('.js-finish-edit-warning').hide();
        this.removeNoteEditForm($note);
      }
Fatih Acet's avatar
Fatih Acet committed
694 695
    };

696
    Notes.prototype.revertNoteEditForm = function($target) {
697
      $target = $target || $('.note.is-editing:visible');
698 699
      var selector = this.getEditFormSelector($target);
      var $editForm = $(selector);
700 701

      $editForm.insertBefore('.notes-form');
702
      $editForm.find('.js-comment-save-button').enable();
703
      $editForm.find('.js-finish-edit-warning').hide();
704
    };
705

706
    Notes.prototype.getEditFormSelector = function($el) {
707
      var selector = '.note-edit-form:not(.mr-note-edit-form)';
708 709

      if ($el.parents('#diffs').length) {
710
        selector = '.note-edit-form.mr-note-edit-form';
711 712 713 714
      }

      return selector;
    };
715

716 717 718
    Notes.prototype.removeNoteEditForm = function($note) {
      var form = $note.find('.current-note-edit-form');
      $note.removeClass('is-editing');
719
      form.removeClass('current-note-edit-form');
720
      form.find('.js-finish-edit-warning').hide();
721
      // Replace markdown textarea text with original note text.
722
      return form.find('.js-note-text').val(form.find('form.edit-note').data('original-note'));
Fatih Acet's avatar
Fatih Acet committed
723 724 725 726
    };

    /*
    Called in response to deleting a note of any kind.
727

Fatih Acet's avatar
Fatih Acet committed
728 729 730 731 732
    Removes the actual note from view.
    Removes the whole discussion if the last note is being removed.
     */

    Notes.prototype.removeNote = function(e) {
733 734 735 736 737 738 739 740
      var noteElId, noteId, dataNoteId, $note, lineHolder;
      $note = $(e.currentTarget).closest('.note');
      noteElId = $note.attr('id');
      noteId = $note.attr('data-note-id');
      lineHolder = $(e.currentTarget).closest('.notes[data-discussion-id]')
        .closest('.notes_holder')
        .prev('.line_holder');
      $(".note[id='" + noteElId + "']").each((function(_this) {
741 742 743
        // A same note appears in the "Discussion" and in the "Changes" tab, we have
        // to remove all. Using $(".note[id='noteId']") ensure we get all the notes,
        // where $("#noteId") would return only one.
Fatih Acet's avatar
Fatih Acet committed
744
        return function(i, el) {
745 746 747
          var $note, $notes;
          $note = $(el);
          $notes = $note.closest(".discussion-notes");
748

749
          if (typeof gl.diffNotesCompileComponents !== 'undefined') {
750 751
            if (gl.diffNoteApps[noteElId]) {
              gl.diffNoteApps[noteElId].$destroy();
752 753 754
            }
          }

755
          $note.remove();
756

757
          // check if this is the last note for this line
758 759
          if ($notes.find(".note").length === 0) {
            var notesTr = $notes.closest("tr");
760

761
            // "Discussions" tab
762
            $notes.closest(".timeline-entry").remove();
763

764 765
            // The notes tr can contain multiple lists of notes, like on the parallel diff
            if (notesTr.find('.discussion-notes').length > 1) {
766
              $notes.remove();
767
            } else {
768
              notesTr.remove();
769
            }
Fatih Acet's avatar
Fatih Acet committed
770 771 772
          }
        };
      })(this));
773 774

      Notes.checkMergeRequestStatus();
Fatih Acet's avatar
Fatih Acet committed
775 776 777 778 779
      return this.updateNotesCount(-1);
    };

    /*
    Called in response to clicking the delete attachment link
780

Fatih Acet's avatar
Fatih Acet committed
781 782 783 784 785
    Removes the attachment wrapper view, including image tag if it exists
    Resets the note editing form
     */

    Notes.prototype.removeAttachment = function() {
786 787 788 789 790
      const $note = $(this).closest(".note");
      $note.find(".note-attachment").remove();
      $note.find(".note-body > .note-text").show();
      $note.find(".note-header").show();
      return $note.find(".current-note-edit-form").remove();
Fatih Acet's avatar
Fatih Acet committed
791 792 793 794
    };

    /*
    Called when clicking on the "reply" button for a diff line.
795

Fatih Acet's avatar
Fatih Acet committed
796 797 798 799 800
    Shows the note form below the notes.
     */

    Notes.prototype.replyToDiscussionNote = function(e) {
      var form, replyLink;
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
801
      form = this.cleanForm(this.formClone.clone());
Fatih Acet's avatar
Fatih Acet committed
802
      replyLink = $(e.target).closest(".js-discussion-reply-button");
803
      // insert the form after the button
804 805 806 807
      replyLink
        .closest('.discussion-reply-holder')
        .hide()
        .after(form);
808
      // show the form
Fatih Acet's avatar
Fatih Acet committed
809 810 811 812 813
      return this.setupDiscussionNoteForm(replyLink, form);
    };

    /*
    Shows the diff or discussion form and does some setup on it.
814

Fatih Acet's avatar
Fatih Acet committed
815
    Sets some hidden fields in the form.
816

817
    Note: dataHolder must have the "discussionId" and "lineCode" data attributes set.
Fatih Acet's avatar
Fatih Acet committed
818 819 820
     */

    Notes.prototype.setupDiscussionNoteForm = function(dataHolder, form) {
821
      // setup note target
822 823
      var discussionID = dataHolder.data("discussionId");

824 825 826 827
      if (discussionID) {
        form.attr("data-discussion-id", discussionID);
        form.find("#in_reply_to_discussion_id").val(discussionID);
      }
828

829
      form.attr("data-line-code", dataHolder.data("lineCode"));
Fatih Acet's avatar
Fatih Acet committed
830
      form.find("#line_type").val(dataHolder.data("lineType"));
831 832 833

      form.find("#note_noteable_type").val(dataHolder.data("noteableType"));
      form.find("#note_noteable_id").val(dataHolder.data("noteableId"));
Fatih Acet's avatar
Fatih Acet committed
834
      form.find("#note_commit_id").val(dataHolder.data("commitId"));
835 836 837
      form.find("#note_type").val(dataHolder.data("noteType"));

      // LegacyDiffNote
Fatih Acet's avatar
Fatih Acet committed
838
      form.find("#note_line_code").val(dataHolder.data("lineCode"));
839 840

      // DiffNote
Fatih Acet's avatar
Fatih Acet committed
841
      form.find("#note_position").val(dataHolder.attr("data-position"));
842

Fatih Acet's avatar
Fatih Acet committed
843
      form.find('.js-note-discard').show().removeClass('js-note-discard').addClass('js-close-discussion-note-form').text(form.find('.js-close-discussion-note-form').data('cancel-text'));
844
      form.find('.js-note-target-close').remove();
845
      form.find('.js-note-new-discussion').remove();
Fatih Acet's avatar
Fatih Acet committed
846
      this.setupNoteForm(form);
847

Douwe Maan's avatar
Douwe Maan committed
848 849 850 851
      form
        .removeClass('js-main-target-form')
        .addClass("discussion-form js-discussion-note-form");

852
      if (typeof gl.diffNotesCompileComponents !== 'undefined') {
853
        var $commentBtn = form.find('comment-and-resolve-btn');
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
854
        $commentBtn.attr(':discussion-id', `'${discussionID}'`);
Phil Hughes's avatar
Phil Hughes committed
855

856
        gl.diffNotesCompileComponents();
857 858
      }

Fatih Acet's avatar
Fatih Acet committed
859
      form.find(".js-note-text").focus();
860 861
      form
        .find('.js-comment-resolve-button')
862
        .attr('data-discussion-id', discussionID);
Fatih Acet's avatar
Fatih Acet committed
863 864 865 866
    };

    /*
    Called when clicking on the "add a comment" button on the side of a diff line.
867

Fatih Acet's avatar
Fatih Acet committed
868 869 870 871 872
    Inserts a temporary row for the form below the line.
    Sets up the form and shows it.
     */

    Notes.prototype.addDiffNote = function(e) {
873
      var $link, addForm, hasNotes, lineType, newForm, nextRow, noteForm, notesContent, notesContentSelector, replyButton, row, rowCssToAdd, targetContent, isDiffCommentAvatar;
Fatih Acet's avatar
Fatih Acet committed
874
      e.preventDefault();
875
      $link = $(e.currentTarget || e.target);
Fatih Acet's avatar
Fatih Acet committed
876 877 878 879
      row = $link.closest("tr");
      nextRow = row.next();
      hasNotes = nextRow.is(".notes_holder");
      addForm = false;
880 881
      notesContentSelector = ".notes_content";
      rowCssToAdd = "<tr class=\"notes_holder js-temp-notes-holder\"><td class=\"notes_line\" colspan=\"2\"></td><td class=\"notes_content\"><div class=\"content\"></div></td></tr>";
882
      isDiffCommentAvatar = $link.hasClass('js-diff-comment-avatar');
883
      // In parallel view, look inside the correct left/right pane
Fatih Acet's avatar
Fatih Acet committed
884 885
      if (this.isParallelView()) {
        lineType = $link.data("lineType");
886 887
        notesContentSelector += "." + lineType;
        rowCssToAdd = "<tr class=\"notes_holder js-temp-notes-holder\"><td class=\"notes_line old\"></td><td class=\"notes_content parallel old\"><div class=\"content\"></div></td><td class=\"notes_line new\"></td><td class=\"notes_content parallel new\"><div class=\"content\"></div></td></tr>";
Fatih Acet's avatar
Fatih Acet committed
888
      }
889
      notesContentSelector += " .content";
890 891 892
      notesContent = nextRow.find(notesContentSelector);

      if (hasNotes && !isDiffCommentAvatar) {
893 894
        nextRow.show();
        notesContent = nextRow.find(notesContentSelector);
Fatih Acet's avatar
Fatih Acet committed
895
        if (notesContent.length) {
896
          notesContent.show();
Fatih Acet's avatar
Fatih Acet committed
897 898 899 900 901
          replyButton = notesContent.find(".js-discussion-reply-button:visible");
          if (replyButton.length) {
            e.target = replyButton[0];
            $.proxy(this.replyToDiscussionNote, replyButton[0], e).call();
          } else {
902
            // In parallel view, the form may not be present in one of the panes
Fatih Acet's avatar
Fatih Acet committed
903 904 905 906 907 908
            noteForm = notesContent.find(".js-discussion-note-form");
            if (noteForm.length === 0) {
              addForm = true;
            }
          }
        }
909
      } else if (!isDiffCommentAvatar) {
910
        // add a notes row and insert the form
Fatih Acet's avatar
Fatih Acet committed
911
        row.after(rowCssToAdd);
912 913
        nextRow = row.next();
        notesContent = nextRow.find(notesContentSelector);
Fatih Acet's avatar
Fatih Acet committed
914
        addForm = true;
915 916 917 918 919 920 921
      } else {
        nextRow.show();
        notesContent.toggle(!notesContent.is(':visible'));

        if (!nextRow.find('.content:not(:empty)').is(':visible')) {
          nextRow.hide();
        }
Fatih Acet's avatar
Fatih Acet committed
922
      }
923

Fatih Acet's avatar
Fatih Acet committed
924
      if (addForm) {
925
        newForm = this.cleanForm(this.formClone.clone());
926
        newForm.appendTo(notesContent);
927
        // show the form
Fatih Acet's avatar
Fatih Acet committed
928 929 930 931 932 933
        return this.setupDiscussionNoteForm($link, newForm);
      }
    };

    /*
    Called in response to "cancel" on a diff note form.
934

Fatih Acet's avatar
Fatih Acet committed
935 936 937 938 939 940 941 942 943 944
    Shows the reply button again.
    Removes the form and if necessary it's temporary row.
     */

    Notes.prototype.removeDiscussionNoteForm = function(form) {
      var glForm, row;
      row = form.closest("tr");
      glForm = form.data('gl-form');
      glForm.destroy();
      form.find(".js-note-text").data("autosave").reset();
945
      // show the reply button (will only work for replies)
946 947 948
      form
        .prev('.discussion-reply-holder')
        .show();
Fatih Acet's avatar
Fatih Acet committed
949
      if (row.is(".js-temp-notes-holder")) {
950
        // remove temporary row for diff lines
Fatih Acet's avatar
Fatih Acet committed
951 952
        return row.remove();
      } else {
953
        // only remove the form
Fatih Acet's avatar
Fatih Acet committed
954 955 956 957 958 959 960 961 962 963 964 965 966
        return form.remove();
      }
    };

    Notes.prototype.cancelDiscussionForm = function(e) {
      var form;
      e.preventDefault();
      form = $(e.target).closest(".js-discussion-note-form");
      return this.removeDiscussionNoteForm(form);
    };

    /*
    Called after an attachment file has been selected.
967

Fatih Acet's avatar
Fatih Acet committed
968 969 970 971 972 973
    Updates the file name for the selected attachment.
     */

    Notes.prototype.updateFormAttachment = function() {
      var filename, form;
      form = $(this).closest("form");
974
      // get only the basename
Fatih Acet's avatar
Fatih Acet committed
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
      filename = $(this).val().replace(/^.*[\\\/]/, "");
      return form.find(".js-attachment-filename").text(filename);
    };

    /*
    Called when the tab visibility changes
     */

    Notes.prototype.visibilityChange = function() {
      return this.refresh();
    };

    Notes.prototype.updateTargetButtons = function(e) {
      var closebtn, closetext, discardbtn, form, reopenbtn, reopentext, textarea;
      textarea = $(e.target);
      form = textarea.parents('form');
      reopenbtn = form.find('.js-note-target-reopen');
      closebtn = form.find('.js-note-target-close');
      discardbtn = form.find('.js-note-discard');
994

Fatih Acet's avatar
Fatih Acet committed
995
      if (textarea.val().trim().length > 0) {
996
        reopentext = reopenbtn.attr('data-alternative-text');
997
        closetext = closebtn.attr('data-alternative-text');
Fatih Acet's avatar
Fatih Acet committed
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
        if (reopenbtn.text() !== reopentext) {
          reopenbtn.text(reopentext);
        }
        if (closebtn.text() !== closetext) {
          closebtn.text(closetext);
        }
        if (reopenbtn.is(':not(.btn-comment-and-reopen)')) {
          reopenbtn.addClass('btn-comment-and-reopen');
        }
        if (closebtn.is(':not(.btn-comment-and-close)')) {
          closebtn.addClass('btn-comment-and-close');
        }
        if (discardbtn.is(':hidden')) {
          return discardbtn.show();
        }
      } else {
        reopentext = reopenbtn.data('original-text');
        closetext = closebtn.data('original-text');
        if (reopenbtn.text() !== reopentext) {
          reopenbtn.text(reopentext);
        }
        if (closebtn.text() !== closetext) {
          closebtn.text(closetext);
        }
        if (reopenbtn.is('.btn-comment-and-reopen')) {
          reopenbtn.removeClass('btn-comment-and-reopen');
        }
        if (closebtn.is('.btn-comment-and-close')) {
          closebtn.removeClass('btn-comment-and-close');
        }
        if (discardbtn.is(':visible')) {
          return discardbtn.hide();
        }
      }
    };

1034
    Notes.prototype.putEditFormInPlace = function($el) {
1035
      var $editForm = $(this.getEditFormSelector($el));
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
      var $note = $el.closest('.note');

      $editForm.insertAfter($note.find('.note-text'));

      var $originalContentEl = $note.find('.original-note-content');
      var originalContent = $originalContentEl.text().trim();
      var postUrl = $originalContentEl.data('post-url');
      var targetId = $originalContentEl.data('target-id');
      var targetType = $originalContentEl.data('target-type');

Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
1046
      new gl.GLForm($editForm.find('form'));
1047

1048 1049 1050
      $editForm.find('form')
        .attr('action', postUrl)
        .attr('data-remote', 'true');
Fatih Acet's avatar
Fatih Acet committed
1051 1052
      $editForm.find('.js-form-target-id').val(targetId);
      $editForm.find('.js-form-target-type').val(targetType);
1053
      $editForm.find('.js-note-text').focus().val(originalContent);
Fatih Acet's avatar
Fatih Acet committed
1054 1055
      $editForm.find('.js-md-write-button').trigger('click');
      $editForm.find('.referenced-users').hide();
1056
    };
1057

1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
    Notes.prototype.putConflictEditWarningInPlace = function(noteEntity, $note) {
      if ($note.find('.js-conflict-edit-warning').length === 0) {
        const $alert = $(`<div class="js-conflict-edit-warning alert alert-danger">
          This comment has changed since you started editing, please review the
          <a href="#note_${noteEntity.id}" target="_blank" rel="noopener noreferrer">
            updated comment
          </a>
          to ensure information is not lost
        </div>`);
        $alert.insertAfter($note.find('.note-text'));
      }
    };

Fatih Acet's avatar
Fatih Acet committed
1071
    Notes.prototype.updateNotesCount = function(updateCount) {
1072
      return this.notesCountBadge.text(parseInt(this.notesCountBadge.text(), 10) + updateCount);
Fatih Acet's avatar
Fatih Acet committed
1073 1074
    };

1075
    Notes.prototype.toggleCommitList = function(e) {
1076
      const $element = $(e.currentTarget);
1077 1078
      const $closestSystemCommitList = $element.siblings('.system-note-commit-list');

1079
      $element.find('.fa').toggleClass('fa-angle-down').toggleClass('fa-angle-up');
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
      $closestSystemCommitList.toggleClass('hide-shade');
    };

    /**
    Scans system notes with `ul` elements in system note body
    then collapse long commit list pushed by user to make it less
    intrusive.
     */
    Notes.prototype.collapseLongCommitList = function() {
      const systemNotes = $('#notes-list').find('li.system-note').has('ul');

      $.each(systemNotes, function(index, systemNote) {
        const $systemNote = $(systemNote);
        const headerMessage = $systemNote.find('.note-text').find('p:first').text().replace(':', '');

        $systemNote.find('.note-header .system-note-message').html(headerMessage);

        if ($systemNote.find('li').length > MAX_VISIBLE_COMMIT_LIST_COUNT) {
          $systemNote.find('.note-text').addClass('system-note-commit-list');
          $systemNote.find('.system-note-commit-list-toggler').show();
        } else {
          $systemNote.find('.note-text').addClass('system-note-commit-list hide-shade');
        }
      });
    };

1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
    Notes.prototype.cleanForm = function($form) {
      // Remove JS classes that are not needed here
      $form
        .find('.js-comment-type-dropdown')
        .removeClass('btn-group');

      // Remove dropdown
      $form
        .find('.dropdown-menu')
        .remove();

      return $form;
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
1118
    };
1119

1120 1121 1122 1123 1124 1125 1126 1127
    Notes.checkMergeRequestStatus = function() {
      if (gl.utils.getPagePath(1) === 'merge_requests') {
        gl.mrWidget.checkStatus();
      }
    };

    Notes.animateAppendNote = function(noteHTML, $notesList) {
      const $note = window.$(noteHTML);
1128

1129
      $note.addClass('fade-in-full').renderGFM();
1130
      $notesList.append($note);
1131 1132 1133 1134 1135 1136 1137 1138 1139
      return $note;
    };

    Notes.animateUpdateNote = function(noteHtml, $note) {
      const $updatedNote = $(noteHtml);

      $updatedNote.addClass('fade-in').renderGFM();
      $note.replaceWith($updatedNote);
      return $updatedNote;
1140 1141
    };

1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366
    /**
     * Get data from Form attributes to use for saving/submitting comment.
     */
    Notes.prototype.getFormData = function($form) {
      return {
        formData: $form.serialize(),
        formContent: $form.find('.js-note-text').val(),
        formAction: $form.attr('action'),
      };
    };

    /**
     * Identify if comment has any slash commands
     */
    Notes.prototype.hasSlashCommands = function(formContent) {
      return REGEX_SLASH_COMMANDS.test(formContent);
    };

    /**
     * Remove slash commands and leave comment with pure message
     */
    Notes.prototype.stripSlashCommands = function(formContent) {
      return formContent.replace(REGEX_SLASH_COMMANDS, '').trim();
    };

    /**
     * Create placeholder note DOM element populated with comment body
     * that we will show while comment is being posted.
     * Once comment is _actually_ posted on server, we will have final element
     * in response that we will show in place of this temporary element.
     */
    Notes.prototype.createPlaceholderNote = function({ formContent, uniqueId, isDiscussionNote, currentUsername, currentUserFullname }) {
      const discussionClass = isDiscussionNote ? 'discussion' : '';
      const $tempNote = $(
        `<li id="${uniqueId}" class="note being-posted fade-in-half timeline-entry">
           <div class="timeline-entry-inner">
              <div class="timeline-icon">
                 <a href="/${currentUsername}"><span class="dummy-avatar"></span></a>
              </div>
              <div class="timeline-content ${discussionClass}">
                 <div class="note-header">
                    <div class="note-header-info">
                       <a href="/${currentUsername}">
                         <span class="hidden-xs">${currentUserFullname}</span>
                         <span class="note-headline-light">@${currentUsername}</span>
                       </a>
                       <span class="note-headline-light">
                          <i class="fa fa-spinner fa-spin" aria-label="Comment is being posted" aria-hidden="true"></i>
                       </span>
                    </div>
                 </div>
                 <div class="note-body">
                   <div class="note-text">
                     <p>${formContent}</p>
                   </div>
                 </div>
              </div>
           </div>
        </li>`
      );

      return $tempNote;
    };

    /**
     * This method does following tasks step-by-step whenever a new comment
     * is submitted by user (both main thread comments as well as discussion comments).
     *
     * 1) Get Form metadata
     * 2) Identify comment type; a) Main thread b) Discussion thread c) Discussion resolve
     * 3) Build temporary placeholder element (using `createPlaceholderNote`)
     * 4) Show placeholder note on UI
     * 5) Perform network request to submit the note using `gl.utils.ajaxPost`
     *    a) If request is successfully completed
     *        1. Remove placeholder element
     *        2. Show submitted Note element
     *        3. Perform post-submit errands
     *           a. Mark discussion as resolved if comment submission was for resolve.
     *           b. Reset comment form to original state.
     *    b) If request failed
     *        1. Remove placeholder element
     *        2. Show error Flash message about failure
     */
    Notes.prototype.postComment = function(e) {
      e.preventDefault();

      // Get Form metadata
      const $submitBtn = $(e.target);
      let $form = $submitBtn.parents('form');
      const $closeBtn = $form.find('.js-note-target-close');
      const isDiscussionNote = $submitBtn.parent().find('li.droplab-item-selected').attr('id') === 'discussion';
      const isMainForm = $form.hasClass('js-main-target-form');
      const isDiscussionForm = $form.hasClass('js-discussion-note-form');
      const isDiscussionResolve = $submitBtn.hasClass('js-comment-resolve-button');
      const { formData, formContent, formAction } = this.getFormData($form);
      const uniqueId = _.uniqueId('tempNote_');
      let $notesContainer;
      let tempFormContent;

      // Get reference to notes container based on type of comment
      if (isDiscussionForm) {
        $notesContainer = $form.parent('.discussion-notes').find('.notes');
      } else if (isMainForm) {
        $notesContainer = $('ul.main-notes-list');
      }

      // If comment is to resolve discussion, disable submit buttons while
      // comment posting is finished.
      if (isDiscussionResolve) {
        $submitBtn.disable();
        $form.find('.js-comment-submit-button').disable();
      }

      tempFormContent = formContent;
      if (this.hasSlashCommands(formContent)) {
        tempFormContent = this.stripSlashCommands(formContent);
      }

      if (tempFormContent) {
        // Show placeholder note
        $notesContainer.append(this.createPlaceholderNote({
          formContent: tempFormContent,
          uniqueId,
          isDiscussionNote,
          currentUsername: gon.current_username,
          currentUserFullname: gon.current_user_fullname,
        }));
      }

      // Clear the form textarea
      if ($notesContainer.length) {
        if (isMainForm) {
          this.resetMainTargetForm(e);
        } else if (isDiscussionForm) {
          this.removeDiscussionNoteForm($form);
        }
      }

      /* eslint-disable promise/catch-or-return */
      // Make request to submit comment on server
      gl.utils.ajaxPost(formAction, formData)
        .then((note) => {
          // Submission successful! remove placeholder
          $notesContainer.find(`#${uniqueId}`).remove();

          // Check if this was discussion comment
          if (isDiscussionForm) {
            // Remove flash-container
            $notesContainer.find('.flash-container').remove();

            // If comment intends to resolve discussion, do the same.
            if (isDiscussionResolve) {
              $form
                .attr('data-discussion-id', $submitBtn.data('discussion-id'))
                .attr('data-resolve-all', 'true')
                .attr('data-project-path', $submitBtn.data('project-path'));
            }

            // Show final note element on UI
            this.addDiscussionNote($form, note, $notesContainer.length === 0);

            // append flash-container to the Notes list
            if ($notesContainer.length) {
              $notesContainer.append('<div class="flash-container" style="display: none;"></div>');
            }
          } else if (isMainForm) { // Check if this was main thread comment
            // Show final note element on UI and perform form and action buttons cleanup
            this.addNote($form, note);
            this.reenableTargetFormSubmitButton(e);
          }

          if (note.commands_changes) {
            this.handleSlashCommands(note);
          }

          $form.trigger('ajax:success', [note]);
        }).fail(() => {
          // Submission failed, remove placeholder note and show Flash error message
          $notesContainer.find(`#${uniqueId}`).remove();

          // Show form again on UI on failure
          if (isDiscussionForm && $notesContainer.length) {
            const replyButton = $notesContainer.parent().find('.js-discussion-reply-button');
            $.proxy(this.replyToDiscussionNote, replyButton[0], { target: replyButton[0] }).call();
            $form = $notesContainer.parent().find('form');
          }

          $form.find('.js-note-text').val(formContent);
          this.reenableTargetFormSubmitButton(e);
          this.addNoteError($form);
        });

      return $closeBtn.text($closeBtn.data('original-text'));
    };

    /**
     * This method does following tasks step-by-step whenever an existing comment
     * is updated by user (both main thread comments as well as discussion comments).
     *
     * 1) Get Form metadata
     * 2) Update note element with new content
     * 3) Perform network request to submit the updated note using `gl.utils.ajaxPost`
     *    a) If request is successfully completed
     *        1. Show submitted Note element
     *    b) If request failed
     *        1. Revert Note element to original content
     *        2. Show error Flash message about failure
     */
    Notes.prototype.updateComment = function(e) {
      e.preventDefault();

      // Get Form metadata
      const $submitBtn = $(e.target);
      const $form = $submitBtn.parents('form');
      const $closeBtn = $form.find('.js-note-target-close');
      const $editingNote = $form.parents('.note.is-editing');
      const $noteBody = $editingNote.find('.js-task-list-container');
      const $noteBodyText = $noteBody.find('.note-text');
      const { formData, formContent, formAction } = this.getFormData($form);

      // Cache original comment content
      const cachedNoteBodyText = $noteBodyText.html();

      // Show updated comment content temporarily
      $noteBodyText.html(formContent);
1367
      $editingNote.removeClass('is-editing fade-in-full').addClass('being-posted fade-in-half');
1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389
      $editingNote.find('.note-headline-meta a').html('<i class="fa fa-spinner fa-spin" aria-label="Comment is being updated" aria-hidden="true"></i>');

      /* eslint-disable promise/catch-or-return */
      // Make request to update comment on server
      gl.utils.ajaxPost(formAction, formData)
        .then((note) => {
          // Submission successful! render final note element
          this.updateNote(null, note, null);
        })
        .fail(() => {
          // Submission failed, revert back to original note
          $noteBodyText.html(cachedNoteBodyText);
          $editingNote.removeClass('being-posted fade-in');
          $editingNote.find('.fa.fa-spinner').remove();

          // Show Flash message about failure
          this.updateNoteError();
        });

      return $closeBtn.text($closeBtn.data('original-text'));
    };

Fatih Acet's avatar
Fatih Acet committed
1390 1391
    return Notes;
  })();
1392
}).call(window);