java/com/google/gerrit/server/CommentContextLoader.java

// Copyright (C) 2020 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;

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

import com.google.auto.value.AutoValue;
import com.google.common.flogger.FluentLogger;
import com.google.gerrit.entities.Project;
import com.google.gerrit.exceptions.StorageException;
import com.google.gerrit.extensions.common.CommentInfo;
import com.google.gerrit.extensions.common.ContextLineInfo;
import com.google.gerrit.server.git.GitRepositoryManager;
import com.google.gerrit.server.patch.Text;
import com.google.inject.Inject;
import com.google.inject.assistedinject.Assisted;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import org.eclipse.jgit.lib.Constants;
import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.revwalk.RevCommit;
import org.eclipse.jgit.revwalk.RevWalk;
import org.eclipse.jgit.treewalk.TreeWalk;

/**
 * Computes the list of {@link ContextLineInfo} for a given comment, that is, the lines of the
 * source file surrounding and including the area where the comment was written.
 */
public class CommentContextLoader {
  private static final FluentLogger logger = FluentLogger.forEnclosingClass();

  private final GitRepositoryManager repoManager;
  private final Project.NameKey project;
  private Map<ContextData, List<ContextLineInfo>> candidates;

  public interface Factory {
    CommentContextLoader create(Project.NameKey project);
  }

  @Inject
  CommentContextLoader(GitRepositoryManager repoManager, @Assisted Project.NameKey project) {
    this.repoManager = repoManager;
    this.project = project;
    this.candidates = new HashMap<>();
  }

  /**
   * Returns an empty list of {@link ContextLineInfo}. Clients are expected to call this method one
   * or more times. Each call returns a reference to an empty {@link List
   * List&lt;ContextLineInfo&gt;}.
   *
   * <p>A single call to {@link #fill()} will cause all list references returned from this method to
   * be populated. If a client calls this method again with a comment that was passed before calling
   * {@link #fill()}, the new populated list will be returned.
   *
   * @param comment the comment entity for which we want to load the context
   * @return a list of {@link ContextLineInfo}
   */
  public List<ContextLineInfo> getContext(CommentInfo comment) {
    ContextData key =
        ContextData.create(
            comment.id,
            ObjectId.fromString(comment.commitId),
            comment.path,
            getStartAndEndLines(comment));
    List<ContextLineInfo> context = candidates.get(key);
    if (context == null) {
      context = new ArrayList<>();
      candidates.put(key, context);
    }
    return context;
  }

  /**
   * A call to this method loads the context for all comments stored in {@link
   * CommentContextLoader#candidates}. This is useful so that the repository is opened once for all
   * comments.
   */
  public void fill() {
    // Group comments by commit ID so that each commit is parsed only once
    Map<ObjectId, List<ContextData>> commentsByCommitId =
        candidates.keySet().stream().collect(groupingBy(ContextData::commitId));

    try (Repository repo = repoManager.openRepository(project);
        RevWalk rw = new RevWalk(repo)) {
      for (ObjectId commitId : commentsByCommitId.keySet()) {
        RevCommit commit = rw.parseCommit(commitId);
        for (ContextData k : commentsByCommitId.get(commitId)) {
          if (!k.range().isPresent()) {
            continue;
          }
          try (TreeWalk tw = TreeWalk.forPath(rw.getObjectReader(), k.path(), commit.getTree())) {
            if (tw == null) {
              logger.atWarning().log(
                  "Failed to find path %s in the git tree of ID %s.",
                  k.path(), commit.getTree().getId());
              continue;
            }
            ObjectId id = tw.getObjectId(0);
            Text src = new Text(repo.open(id, Constants.OBJ_BLOB));
            List<ContextLineInfo> contextLines = candidates.get(k);
            Range r = k.range().get();
            for (int i = r.start(); i <= r.end(); i++) {
              contextLines.add(new ContextLineInfo(i, src.getString(i - 1)));
            }
          }
        }
      }
    } catch (IOException e) {
      throw new StorageException("Failed to load the comment context", e);
    }
  }

  private static Optional<Range> getStartAndEndLines(CommentInfo comment) {
    if (comment.range != null) {
      return Optional.of(Range.create(comment.range.startLine, comment.range.endLine));
    } else if (comment.line != null) {
      return Optional.of(Range.create(comment.line, comment.line));
    }
    return Optional.empty();
  }

  @AutoValue
  abstract static class Range {
    static Range create(int start, int end) {
      return new AutoValue_CommentContextLoader_Range(start, end);
    }

    abstract int start();

    abstract int end();
  }

  @AutoValue
  abstract static class ContextData {
    static ContextData create(String id, ObjectId commitId, String path, Optional<Range> range) {
      return new AutoValue_CommentContextLoader_ContextData(id, commitId, path, range);
    }

    abstract String id();

    abstract ObjectId commitId();

    abstract String path();

    abstract Optional<Range> range();
  }
}