auto_submit/lib/action/git_cli_revert_method.dart

// Copyright 2023 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:io';

import 'package:cocoon_server/logging.dart';
import 'package:github/github.dart' as github;
import 'package:retry/retry.dart';

import '../git/cli_command.dart';
import '../git/git_cli.dart';
import '../git/git_repository_manager.dart';
import '../git/utilities.dart';
import '../requests/exceptions.dart';
import '../revert/revert_issue_body_formatter.dart';
import '../service/config.dart';
import '../service/github_service.dart';
import 'revert_method.dart';

class GitCliRevertMethod implements RevertMethod {
  @override
  Future<github.PullRequest?> createRevert(
    Config config,
    String initiatingAuthor,
    String reasonForRevert,
    github.PullRequest pullRequestToRevert,
  ) async {
    final slug = pullRequestToRevert.base!.repo!.slug();
    final commitSha = pullRequestToRevert.mergeCommitSha!;
    // we will need to collect the pr number after the revert request is generated.

    final repositoryConfiguration = await config.getRepositoryConfiguration(
      slug,
    );
    final baseBranch = repositoryConfiguration.defaultBranch;

    final cloneToDirectory = '${slug.name}_$commitSha';
    final gitRepositoryManager = GitRepositoryManager(
      slug: slug,
      workingDirectory: Directory.current.path,
      cloneToDirectory: cloneToDirectory,
      gitCli: GitCli(GitAccessMethod.HTTP, CliCommand()),
    );

    // The exception is caught by the thrower.
    try {
      await gitRepositoryManager.cloneRepository();
      await gitRepositoryManager.setupConfig();
      await gitRepositoryManager.revertCommit(
        baseBranch,
        commitSha,
        slug,
        await config.generateGithubToken(slug),
      );
    } finally {
      await gitRepositoryManager.deleteRepository();
    }

    final gitRevertBranchName = GitRevertBranchName(commitSha);
    final githubService = await config.createGithubService(slug);

    const retryOptions = RetryOptions(
      delayFactor: Duration(seconds: 1),
      maxDelay: Duration(seconds: 1),
      maxAttempts: 4,
    );

    github.Branch? branch;
    // Attempt a few times to get the branch name. This may not be needed.
    // Let the exception bubble up from here.
    await retryOptions.retry(() async {
      branch = await githubService.getBranch(slug, gitRevertBranchName.branch);
    }, retryIf: (Exception e) => e is NotFoundException);

    log.info(
      'found branch ${slug.fullName}/${branch!.name}, safe to create revert request of ${pullRequestToRevert.number!}.',
    );

    final prToRevertReviewers = await getOriginalPrReviewers(
      githubService,
      slug,
      pullRequestToRevert.number!,
    );

    final formatter =
        RevertIssueBodyFormatter(
          slug: slug,
          prToRevertNumber: pullRequestToRevert.number!,
          initiatingAuthor: initiatingAuthor,
          revertReason: reasonForRevert,
          prToRevertAuthor: pullRequestToRevert.user!.login,
          prToRevertReviewers: prToRevertReviewers,
          prToRevertTitle: pullRequestToRevert.title,
          prToRevertBody: pullRequestToRevert.body,
        ).format;

    log.info(
      'Attempting to create pull request with ${slug.fullName}/${gitRevertBranchName.branch}.',
    );
    final revertPullRequest = await githubService.createPullRequest(
      slug: slug,
      title: formatter.revertPrTitle,
      head: gitRevertBranchName.branch,
      base: baseBranch,
      draft: false,
      body: formatter.revertPrBody,
    );

    log.info(
      'pull request number is: ${slug.fullName}/${revertPullRequest.number}',
    );

    return revertPullRequest;
  }

  /// Get the list of reviewers that ultimately approved the original pull request.
  /// The reviews come in oldest to newest in ascending order so we reverse them.
  /// Note: no attempt is made to validate if changes were requested then approved
  /// or not approved. We simply take the approvers from newest to oldest.
  Future<Set<String>> getOriginalPrReviewers(
    GithubService githubService,
    github.RepositorySlug slug,
    int prNumber,
  ) async {
    final pullRequestReviews = await githubService.getPullRequestReviews(
      slug,
      prNumber,
    );
    final reversedPullRequestReviews = pullRequestReviews.reversed.toList();
    final approvers = <String>{};
    for (var review in reversedPullRequestReviews) {
      if (review.state == 'APPROVED') {
        approvers.add(review.user!.login!);
      }
    }
    return approvers;
  }
}