com.google.gerrit.server.restapi.change.ListRobotComments Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gerrit-plugin-api Show documentation
API for Gerrit Plugins
There is a newer version: 3.10.1
// Copyright (C) 2016 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.

package com.google.gerrit.server.restapi.change;

import static java.util.stream.Collectors.toList;

import com.google.common.collect.ImmutableList;
import com.google.gerrit.entities.ChangeMessage;
import com.google.gerrit.entities.RobotComment;
import com.google.gerrit.extensions.common.RobotCommentInfo;
import com.google.gerrit.extensions.restapi.Response;
import com.google.gerrit.extensions.restapi.RestReadView;
import com.google.gerrit.server.ChangeMessagesUtil;
import com.google.gerrit.server.CommentsUtil;
import com.google.gerrit.server.change.RevisionResource;
import com.google.gerrit.server.permissions.PermissionBackendException;
import com.google.gerrit.server.restapi.change.CommentJson.RobotCommentFormatter;
import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton;
import java.util.List;
import java.util.Map;

@Singleton
public class ListRobotComments implements RestReadView {
  protected final Provider commentJson;
  protected final CommentsUtil commentsUtil;
  protected final ChangeMessagesUtil changeMessagesUtil;

  @Inject
  ListRobotComments(
      Provider commentJson,
      CommentsUtil commentsUtil,
      ChangeMessagesUtil changeMessagesUtil) {
    this.commentJson = commentJson;
    this.commentsUtil = commentsUtil;
    this.changeMessagesUtil = changeMessagesUtil;
  }

  @Override
  public Response>> apply(RevisionResource rsrc)
      throws PermissionBackendException {
    return Response.ok(getAsMap(listComments(rsrc), rsrc));
  }

  public ImmutableList getComments(RevisionResource rsrc)
      throws PermissionBackendException {
    return getAsList(listComments(rsrc), rsrc);
  }

  private ImmutableList getAsList(
      Iterable comments, RevisionResource rsrc) throws PermissionBackendException {
    ImmutableList commentInfos = getCommentFormatter().formatAsList(comments);
    List changeMessages = changeMessagesUtil.byChange(rsrc.getNotes());
    CommentsUtil.linkCommentsToChangeMessages(commentInfos, changeMessages, false);
    return commentInfos;
  }

  private Map> getAsMap(
      Iterable comments, RevisionResource rsrc) throws PermissionBackendException {
    Map> commentInfosMap = getCommentFormatter().format(comments);
    List commentInfos =
        commentInfosMap.values().stream().flatMap(List::stream).collect(toList());
    List changeMessages = changeMessagesUtil.byChange(rsrc.getNotes());
    CommentsUtil.linkCommentsToChangeMessages(commentInfos, changeMessages, false);
    return commentInfosMap;
  }

  private List listComments(RevisionResource rsrc) {
    return commentsUtil.robotCommentsByPatchSet(rsrc.getNotes(), rsrc.getPatchSet().id());
  }

  private RobotCommentFormatter getCommentFormatter() {
    return commentJson.get().setFillAccounts(true).newRobotCommentFormatter();
  }
}