polygerrit-ui/app/elements/change/gr-comment-list/gr-comment-list.js

/**
 * @license
 * Copyright (C) 2015 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/*
  The custom CSS property `--gr-formatted-text-prose-max-width` controls the max
  width of formatted text blocks that are not code.
*/
/*
  FIXME(polymer-modulizer): the above comments were extracted
  from HTML and may be out of place here. Review them and
  then delete this comment!
*/

import '../../../scripts/bundled-polymer.js';
import '../../shared/gr-formatted-text/gr-formatted-text.js';
import '../../../styles/shared-styles.js';
import {mixinBehaviors} from '@polymer/polymer/lib/legacy/class.js';
import {GestureEventListeners} from '@polymer/polymer/lib/mixins/gesture-event-listeners.js';
import {LegacyElementMixin} from '@polymer/polymer/lib/legacy/legacy-element-mixin.js';
import {PolymerElement} from '@polymer/polymer/polymer-element.js';
import {htmlTemplate} from './gr-comment-list_html.js';
import {BaseUrlBehavior} from '../../../behaviors/base-url-behavior/base-url-behavior.js';
import {PathListBehavior} from '../../../behaviors/gr-path-list-behavior/gr-path-list-behavior.js';
import {URLEncodingBehavior} from '../../../behaviors/gr-url-encoding-behavior/gr-url-encoding-behavior.js';
import {GerritNav} from '../../core/gr-navigation/gr-navigation.js';

/**
 * @extends Polymer.Element
 */
class GrCommentList extends mixinBehaviors( [
  BaseUrlBehavior,
  PathListBehavior,
  URLEncodingBehavior,
], GestureEventListeners(
    LegacyElementMixin(
        PolymerElement))) {
  static get template() { return htmlTemplate; }

  static get is() { return 'gr-comment-list'; }

  static get properties() {
    return {
      changeNum: Number,
      comments: Object,
      patchNum: Number,
      projectName: String,
      /** @type {?} */
      projectConfig: Object,
    };
  }

  _computeFilesFromComments(comments) {
    const arr = Object.keys(comments || {});
    return arr.sort(this.specialFilePathCompare);
  }

  _isOnParent(comment) {
    return comment.side === 'PARENT';
  }

  _computeDiffURL(filePath, changeNum, allComments) {
    if ([filePath, changeNum, allComments].some(arg => arg === undefined)) {
      return;
    }
    const fileComments = this._computeCommentsForFile(allComments, filePath);
    // This can happen for files that don't exist anymore in the current ps.
    if (fileComments.length === 0) return;
    return GerritNav.getUrlForDiffById(changeNum, this.projectName,
        filePath, fileComments[0].patch_set);
  }

  _computeDiffLineURL(filePath, changeNum, patchNum, comment) {
    const basePatchNum = comment.hasOwnProperty('parent') ?
      -comment.parent : null;
    return GerritNav.getUrlForDiffById(changeNum, this.projectName,
        filePath, patchNum, basePatchNum, comment.line,
        this._isOnParent(comment));
  }

  _computeCommentsForFile(comments, filePath) {
    // Changes are not picked up by the dom-repeat due to the array instance
    // identity not changing even when it has elements added/removed from it.
    return (comments[filePath] || []).slice();
  }

  _computePatchDisplayName(comment) {
    if (this._isOnParent(comment)) {
      return 'Base, ';
    }
    if (comment.patch_set != this.patchNum) {
      return `PS${comment.patch_set}, `;
    }
    return '';
  }
}

customElements.define(GrCommentList.is, GrCommentList);