summaryrefslogtreecommitdiffstats
path: root/services/automerge
diff options
context:
space:
mode:
authorDaniel Baumann <daniel@debian.org>2024-10-18 20:33:49 +0200
committerDaniel Baumann <daniel@debian.org>2024-10-18 20:33:49 +0200
commitdd136858f1ea40ad3c94191d647487fa4f31926c (patch)
tree58fec94a7b2a12510c9664b21793f1ed560c6518 /services/automerge
parentInitial commit. (diff)
downloadforgejo-dd136858f1ea40ad3c94191d647487fa4f31926c.tar.xz
forgejo-dd136858f1ea40ad3c94191d647487fa4f31926c.zip
Adding upstream version 9.0.0.
Signed-off-by: Daniel Baumann <daniel@debian.org>
Diffstat (limited to 'services/automerge')
-rw-r--r--services/automerge/automerge.go306
-rw-r--r--services/automerge/notify.go46
2 files changed, 352 insertions, 0 deletions
diff --git a/services/automerge/automerge.go b/services/automerge/automerge.go
new file mode 100644
index 0000000..a1ee204
--- /dev/null
+++ b/services/automerge/automerge.go
@@ -0,0 +1,306 @@
+// Copyright 2021 Gitea. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package automerge
+
+import (
+ "context"
+ "errors"
+ "fmt"
+ "strconv"
+ "strings"
+
+ "code.gitea.io/gitea/models/db"
+ issues_model "code.gitea.io/gitea/models/issues"
+ access_model "code.gitea.io/gitea/models/perm/access"
+ pull_model "code.gitea.io/gitea/models/pull"
+ repo_model "code.gitea.io/gitea/models/repo"
+ user_model "code.gitea.io/gitea/models/user"
+ "code.gitea.io/gitea/modules/git"
+ "code.gitea.io/gitea/modules/gitrepo"
+ "code.gitea.io/gitea/modules/graceful"
+ "code.gitea.io/gitea/modules/log"
+ "code.gitea.io/gitea/modules/process"
+ "code.gitea.io/gitea/modules/queue"
+ notify_service "code.gitea.io/gitea/services/notify"
+ pull_service "code.gitea.io/gitea/services/pull"
+)
+
+// prAutoMergeQueue represents a queue to handle update pull request tests
+var prAutoMergeQueue *queue.WorkerPoolQueue[string]
+
+// Init runs the task queue to that handles auto merges
+func Init() error {
+ notify_service.RegisterNotifier(NewNotifier())
+
+ prAutoMergeQueue = queue.CreateUniqueQueue(graceful.GetManager().ShutdownContext(), "pr_auto_merge", handler)
+ if prAutoMergeQueue == nil {
+ return fmt.Errorf("unable to create pr_auto_merge queue")
+ }
+ go graceful.GetManager().RunWithCancel(prAutoMergeQueue)
+ return nil
+}
+
+// handle passed PR IDs and test the PRs
+func handler(items ...string) []string {
+ for _, s := range items {
+ var id int64
+ var sha string
+ if _, err := fmt.Sscanf(s, "%d_%s", &id, &sha); err != nil {
+ log.Error("could not parse data from pr_auto_merge queue (%v): %v", s, err)
+ continue
+ }
+ handlePullRequestAutoMerge(id, sha)
+ }
+ return nil
+}
+
+func addToQueue(pr *issues_model.PullRequest, sha string) {
+ log.Trace("Adding pullID: %d to the pull requests patch checking queue with sha %s", pr.ID, sha)
+ if err := prAutoMergeQueue.Push(fmt.Sprintf("%d_%s", pr.ID, sha)); err != nil {
+ log.Error("Error adding pullID: %d to the pull requests patch checking queue %v", pr.ID, err)
+ }
+}
+
+// ScheduleAutoMerge if schedule is false and no error, pull can be merged directly
+func ScheduleAutoMerge(ctx context.Context, doer *user_model.User, pull *issues_model.PullRequest, style repo_model.MergeStyle, message string) (scheduled bool, err error) {
+ err = db.WithTx(ctx, func(ctx context.Context) error {
+ if err := pull_model.ScheduleAutoMerge(ctx, doer, pull.ID, style, message); err != nil {
+ return err
+ }
+ scheduled = true
+
+ _, err = issues_model.CreateAutoMergeComment(ctx, issues_model.CommentTypePRScheduledToAutoMerge, pull, doer)
+ return err
+ })
+ return scheduled, err
+}
+
+// RemoveScheduledAutoMerge cancels a previously scheduled pull request
+func RemoveScheduledAutoMerge(ctx context.Context, doer *user_model.User, pull *issues_model.PullRequest) error {
+ return db.WithTx(ctx, func(ctx context.Context) error {
+ if err := pull_model.DeleteScheduledAutoMerge(ctx, pull.ID); err != nil {
+ return err
+ }
+
+ _, err := issues_model.CreateAutoMergeComment(ctx, issues_model.CommentTypePRUnScheduledToAutoMerge, pull, doer)
+ return err
+ })
+}
+
+// StartPRCheckAndAutoMergeBySHA start an automerge check and auto merge task for all pull requests of repository and SHA
+func StartPRCheckAndAutoMergeBySHA(ctx context.Context, sha string, repo *repo_model.Repository) error {
+ pulls, err := getPullRequestsByHeadSHA(ctx, sha, repo, func(pr *issues_model.PullRequest) bool {
+ return !pr.HasMerged && pr.CanAutoMerge()
+ })
+ if err != nil {
+ return err
+ }
+
+ for _, pr := range pulls {
+ addToQueue(pr, sha)
+ }
+
+ return nil
+}
+
+// StartPRCheckAndAutoMerge start an automerge check and auto merge task for a pull request
+func StartPRCheckAndAutoMerge(ctx context.Context, pull *issues_model.PullRequest) {
+ if pull == nil || pull.HasMerged || !pull.CanAutoMerge() {
+ return
+ }
+
+ if err := pull.LoadBaseRepo(ctx); err != nil {
+ log.Error("LoadBaseRepo: %v", err)
+ return
+ }
+
+ gitRepo, err := gitrepo.OpenRepository(ctx, pull.BaseRepo)
+ if err != nil {
+ log.Error("OpenRepository: %v", err)
+ return
+ }
+ defer gitRepo.Close()
+ commitID, err := gitRepo.GetRefCommitID(pull.GetGitRefName())
+ if err != nil {
+ log.Error("GetRefCommitID: %v", err)
+ return
+ }
+
+ addToQueue(pull, commitID)
+}
+
+func getPullRequestsByHeadSHA(ctx context.Context, sha string, repo *repo_model.Repository, filter func(*issues_model.PullRequest) bool) (map[int64]*issues_model.PullRequest, error) {
+ gitRepo, err := gitrepo.OpenRepository(ctx, repo)
+ if err != nil {
+ return nil, err
+ }
+ defer gitRepo.Close()
+
+ refs, err := gitRepo.GetRefsBySha(sha, "")
+ if err != nil {
+ return nil, err
+ }
+
+ pulls := make(map[int64]*issues_model.PullRequest)
+
+ for _, ref := range refs {
+ // Each pull branch starts with refs/pull/ we then go from there to find the index of the pr and then
+ // use that to get the pr.
+ if strings.HasPrefix(ref, git.PullPrefix) {
+ parts := strings.Split(ref[len(git.PullPrefix):], "/")
+
+ // e.g. 'refs/pull/1/head' would be []string{"1", "head"}
+ if len(parts) != 2 {
+ log.Error("getPullRequestsByHeadSHA found broken pull ref [%s] on repo [%-v]", ref, repo)
+ continue
+ }
+
+ prIndex, err := strconv.ParseInt(parts[0], 10, 64)
+ if err != nil {
+ log.Error("getPullRequestsByHeadSHA found broken pull ref [%s] on repo [%-v]", ref, repo)
+ continue
+ }
+
+ p, err := issues_model.GetPullRequestByIndex(ctx, repo.ID, prIndex)
+ if err != nil {
+ // If there is no pull request for this branch, we don't try to merge it.
+ if issues_model.IsErrPullRequestNotExist(err) {
+ continue
+ }
+ return nil, err
+ }
+
+ if filter(p) {
+ pulls[p.ID] = p
+ }
+ }
+ }
+
+ return pulls, nil
+}
+
+// handlePullRequestAutoMerge merge the pull request if all checks are successful
+func handlePullRequestAutoMerge(pullID int64, sha string) {
+ ctx, _, finished := process.GetManager().AddContext(graceful.GetManager().HammerContext(),
+ fmt.Sprintf("Handle AutoMerge of PR[%d] with sha[%s]", pullID, sha))
+ defer finished()
+
+ pr, err := issues_model.GetPullRequestByID(ctx, pullID)
+ if err != nil {
+ log.Error("GetPullRequestByID[%d]: %v", pullID, err)
+ return
+ }
+
+ // Check if there is a scheduled pr in the db
+ exists, scheduledPRM, err := pull_model.GetScheduledMergeByPullID(ctx, pr.ID)
+ if err != nil {
+ log.Error("%-v GetScheduledMergeByPullID: %v", pr, err)
+ return
+ }
+ if !exists {
+ return
+ }
+
+ if err = pr.LoadBaseRepo(ctx); err != nil {
+ log.Error("%-v LoadBaseRepo: %v", pr, err)
+ return
+ }
+
+ // check the sha is the same as pull request head commit id
+ baseGitRepo, err := gitrepo.OpenRepository(ctx, pr.BaseRepo)
+ if err != nil {
+ log.Error("OpenRepository: %v", err)
+ return
+ }
+ defer baseGitRepo.Close()
+
+ headCommitID, err := baseGitRepo.GetRefCommitID(pr.GetGitRefName())
+ if err != nil {
+ log.Error("GetRefCommitID: %v", err)
+ return
+ }
+ if headCommitID != sha {
+ log.Warn("Head commit id of auto merge %-v does not match sha [%s], it may means the head branch has been updated. Just ignore this request because a new request expected in the queue", pr, sha)
+ return
+ }
+
+ // Get all checks for this pr
+ // We get the latest sha commit hash again to handle the case where the check of a previous push
+ // did not succeed or was not finished yet.
+ if err = pr.LoadHeadRepo(ctx); err != nil {
+ log.Error("%-v LoadHeadRepo: %v", pr, err)
+ return
+ }
+
+ var headGitRepo *git.Repository
+ if pr.BaseRepoID == pr.HeadRepoID {
+ headGitRepo = baseGitRepo
+ } else {
+ headGitRepo, err = gitrepo.OpenRepository(ctx, pr.HeadRepo)
+ if err != nil {
+ log.Error("OpenRepository %-v: %v", pr.HeadRepo, err)
+ return
+ }
+ defer headGitRepo.Close()
+ }
+
+ switch pr.Flow {
+ case issues_model.PullRequestFlowGithub:
+ headBranchExist := headGitRepo.IsBranchExist(pr.HeadBranch)
+ if pr.HeadRepo == nil || !headBranchExist {
+ log.Warn("Head branch of auto merge %-v does not exist [HeadRepoID: %d, Branch: %s]", pr, pr.HeadRepoID, pr.HeadBranch)
+ return
+ }
+ case issues_model.PullRequestFlowAGit:
+ headBranchExist := git.IsReferenceExist(ctx, baseGitRepo.Path, pr.GetGitRefName())
+ if !headBranchExist {
+ log.Warn("Head branch of auto merge %-v does not exist [HeadRepoID: %d, Branch(Agit): %s]", pr, pr.HeadRepoID, pr.HeadBranch)
+ return
+ }
+ default:
+ log.Error("wrong flow type %d", pr.Flow)
+ return
+ }
+
+ // Check if all checks succeeded
+ pass, err := pull_service.IsPullCommitStatusPass(ctx, pr)
+ if err != nil {
+ log.Error("%-v IsPullCommitStatusPass: %v", pr, err)
+ return
+ }
+ if !pass {
+ log.Info("Scheduled auto merge %-v has unsuccessful status checks", pr)
+ return
+ }
+
+ // Merge if all checks succeeded
+ doer, err := user_model.GetUserByID(ctx, scheduledPRM.DoerID)
+ if err != nil {
+ log.Error("Unable to get scheduled User[%d]: %v", scheduledPRM.DoerID, err)
+ return
+ }
+
+ perm, err := access_model.GetUserRepoPermission(ctx, pr.HeadRepo, doer)
+ if err != nil {
+ log.Error("GetUserRepoPermission %-v: %v", pr.HeadRepo, err)
+ return
+ }
+
+ if err := pull_service.CheckPullMergeable(ctx, doer, &perm, pr, pull_service.MergeCheckTypeGeneral, false); err != nil {
+ if errors.Is(err, pull_service.ErrUserNotAllowedToMerge) {
+ log.Info("%-v was scheduled to automerge by an unauthorized user", pr)
+ return
+ }
+ log.Error("%-v CheckPullMergeable: %v", pr, err)
+ return
+ }
+
+ if err := pull_service.Merge(ctx, pr, doer, baseGitRepo, scheduledPRM.MergeStyle, "", scheduledPRM.Message, true); err != nil {
+ log.Error("pull_service.Merge: %v", err)
+ // FIXME: if merge failed, we should display some error message to the pull request page.
+ // The resolution is add a new column on automerge table named `error_message` to store the error message and displayed
+ // on the pull request page. But this should not be finished in a bug fix PR which will be backport to release branch.
+ return
+ }
+}
diff --git a/services/automerge/notify.go b/services/automerge/notify.go
new file mode 100644
index 0000000..cb07821
--- /dev/null
+++ b/services/automerge/notify.go
@@ -0,0 +1,46 @@
+// Copyright 2024 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package automerge
+
+import (
+ "context"
+
+ issues_model "code.gitea.io/gitea/models/issues"
+ user_model "code.gitea.io/gitea/models/user"
+ "code.gitea.io/gitea/modules/log"
+ notify_service "code.gitea.io/gitea/services/notify"
+)
+
+type automergeNotifier struct {
+ notify_service.NullNotifier
+}
+
+var _ notify_service.Notifier = &automergeNotifier{}
+
+// NewNotifier create a new automergeNotifier notifier
+func NewNotifier() notify_service.Notifier {
+ return &automergeNotifier{}
+}
+
+func (n *automergeNotifier) PullRequestReview(ctx context.Context, pr *issues_model.PullRequest, review *issues_model.Review, comment *issues_model.Comment, mentions []*user_model.User) {
+ // as a missing / blocking reviews could have blocked a pending automerge let's recheck
+ if review.Type == issues_model.ReviewTypeApprove {
+ if err := StartPRCheckAndAutoMergeBySHA(ctx, review.CommitID, pr.BaseRepo); err != nil {
+ log.Error("StartPullRequestAutoMergeCheckBySHA: %v", err)
+ }
+ }
+}
+
+func (n *automergeNotifier) PullReviewDismiss(ctx context.Context, doer *user_model.User, review *issues_model.Review, comment *issues_model.Comment) {
+ if err := review.LoadIssue(ctx); err != nil {
+ log.Error("LoadIssue: %v", err)
+ return
+ }
+ if err := review.Issue.LoadPullRequest(ctx); err != nil {
+ log.Error("LoadPullRequest: %v", err)
+ return
+ }
+ // as reviews could have blocked a pending automerge let's recheck
+ StartPRCheckAndAutoMerge(ctx, review.Issue.PullRequest)
+}