From d7bc52beeadff4be5f5690de4d5de42abd10affe Mon Sep 17 00:00:00 2001 From: wxiaoguang Date: Mon, 27 Jul 2026 01:32:02 +0800 Subject: [PATCH] refactor: git patch apply (#38637) (#38638) Backport #38637 --- services/repository/files/cherry_pick.go | 99 +++--------------------- services/repository/files/patch.go | 50 +++++++----- services/repository/files/patch_test.go | 36 +++++++++ services/repository/files/update.go | 2 +- 4 files changed, 78 insertions(+), 109 deletions(-) create mode 100644 services/repository/files/patch_test.go diff --git a/services/repository/files/cherry_pick.go b/services/repository/files/cherry_pick.go index 479c76b965d..e4f779e2eb8 100644 --- a/services/repository/files/cherry_pick.go +++ b/services/repository/files/cherry_pick.go @@ -4,7 +4,6 @@ package files import ( - "context" "errors" "fmt" "strings" @@ -13,7 +12,7 @@ import ( user_model "gitea.dev/models/user" "gitea.dev/modules/git" "gitea.dev/modules/gitrepo" - "gitea.dev/modules/log" + "gitea.dev/modules/reqctx" "gitea.dev/modules/structs" "gitea.dev/services/pull" ) @@ -35,57 +34,23 @@ func (err ErrCommitIDDoesNotMatch) Error() string { } // CherryPick cherry-picks or reverts a commit to the given repository -func CherryPick(ctx context.Context, repo *repo_model.Repository, doer *user_model.User, revert bool, opts *ApplyDiffPatchOptions) (*structs.FileResponse, error) { - gitRepo, closer, err := gitrepo.RepositoryFromContextOrOpen(ctx, repo) +func CherryPick(ctx reqctx.RequestContext, repo *repo_model.Repository, doer *user_model.User, revert bool, opts *ApplyDiffPatchOptions) (*structs.FileResponse, error) { + gitRepo, err := gitrepo.RepositoryFromRequestContextOrOpen(ctx, repo) if err != nil { return nil, err } - defer closer.Close() - - if err := opts.Validate(ctx, repo, gitRepo, doer); err != nil { - return nil, err - } - message := strings.TrimSpace(opts.Message) - - t, err := NewTemporaryUploadRepository(repo) + t, err := gitPatchPrepare(ctx, repo, gitRepo, doer, opts) if err != nil { - log.Error("NewTemporaryUploadRepository failed: %v", err) + return nil, err } defer t.Close() - if err := t.Clone(ctx, opts.OldBranch, false); err != nil { - return nil, err - } - if err := t.SetDefaultIndex(ctx); err != nil { - return nil, err - } - if err := t.RefreshIndex(ctx); err != nil { - return nil, err - } - // Get the commit of the original branch - commit, err := t.GetBranchCommit(opts.OldBranch) + err = t.RefreshIndex(ctx) if err != nil { - return nil, err // Couldn't get a commit for the branch + return nil, err } - // Assigned LastCommitID in opts if it hasn't been set - if opts.LastCommitID == "" { - opts.LastCommitID = commit.ID.String() - } else { - lastCommitID, err := t.gitRepo.ConvertToGitID(opts.LastCommitID) - if err != nil { - return nil, fmt.Errorf("CherryPick: Invalid last commit ID: %w", err) - } - opts.LastCommitID = lastCommitID.String() - if commit.ID.String() != opts.LastCommitID { - return nil, ErrCommitIDDoesNotMatch{ - GivenCommitID: opts.LastCommitID, - CurrentCommitID: opts.LastCommitID, - } - } - } - - commit, err = t.GetCommit(strings.TrimSpace(opts.Content)) + commit, err := t.GetCommit(strings.TrimSpace(opts.Content)) if err != nil { return nil, err } @@ -101,8 +66,7 @@ func CherryPick(ctx context.Context, repo *repo_model.Repository, doer *user_mod } description := fmt.Sprintf("CherryPick %s onto %s", right, opts.OldBranch) - conflict, _, err := pull.AttemptThreeWayMerge(ctx, - t.basePath, t.gitRepo, base, opts.LastCommitID, right, description) + conflict, _, err := pull.AttemptThreeWayMerge(ctx, t.basePath, t.gitRepo, base, opts.LastCommitID, right, description) if err != nil { return nil, fmt.Errorf("failed to three-way merge %s onto %s: %w", right, opts.OldBranch, err) } @@ -111,48 +75,5 @@ func CherryPick(ctx context.Context, repo *repo_model.Repository, doer *user_mod return nil, errors.New("failed to merge due to conflicts") } - treeHash, err := t.WriteTree(ctx) - if err != nil { - // likely non-sensical tree due to merge conflicts... - return nil, err - } - - // Now commit the tree - commitOpts := &CommitTreeUserOptions{ - ParentCommitID: "HEAD", - TreeHash: treeHash, - CommitMessage: message, - SignOff: opts.Signoff, - DoerUser: doer, - AuthorIdentity: opts.Author, - AuthorTime: nil, - CommitterIdentity: opts.Committer, - CommitterTime: nil, - } - if opts.Dates != nil { - commitOpts.AuthorTime, commitOpts.CommitterTime = &opts.Dates.Author, &opts.Dates.Committer - } - commitHash, err := t.CommitTree(ctx, commitOpts) - if err != nil { - return nil, err - } - - // Then push this tree to NewBranch - if err := t.Push(ctx, doer, commitHash, opts.NewBranch, false); err != nil { - return nil, err - } - - commit, err = t.GetCommit(commitHash) - if err != nil { - return nil, err - } - - fileCommitResponse, _ := GetFileCommitResponse(repo, commit) // ok if fails, then will be nil - verification := GetPayloadCommitVerification(ctx, commit) - fileResponse := &structs.FileResponse{ - Commit: fileCommitResponse, - Verification: verification, - } - - return fileResponse, nil + return gitPatchCommitPush(ctx, t, repo, doer, opts) } diff --git a/services/repository/files/patch.go b/services/repository/files/patch.go index 8c797a24ec6..53db2502c25 100644 --- a/services/repository/files/patch.go +++ b/services/repository/files/patch.go @@ -14,7 +14,7 @@ import ( "gitea.dev/modules/git" "gitea.dev/modules/git/gitcmd" "gitea.dev/modules/gitrepo" - "gitea.dev/modules/log" + "gitea.dev/modules/reqctx" "gitea.dev/modules/structs" "gitea.dev/modules/util" asymkey_service "gitea.dev/services/asymkey" @@ -110,31 +110,27 @@ func (opts *ApplyDiffPatchOptions) Validate(ctx context.Context, repo *repo_mode return nil } -// ApplyDiffPatch applies a patch to the given repository -func ApplyDiffPatch(ctx context.Context, repo *repo_model.Repository, doer *user_model.User, opts *ApplyDiffPatchOptions) (*structs.FileResponse, error) { +func gitPatchPrepare(ctx context.Context, repo *repo_model.Repository, gitRepo *git.Repository, doer *user_model.User, opts *ApplyDiffPatchOptions) (_ *TemporaryUploadRepository, retErr error) { err := repo.MustNotBeArchived() if err != nil { return nil, err } - gitRepo, closer, err := gitrepo.RepositoryFromContextOrOpen(ctx, repo) - if err != nil { - return nil, err - } - defer closer.Close() - if err := opts.Validate(ctx, repo, gitRepo, doer); err != nil { return nil, err } - message := strings.TrimSpace(opts.Message) - t, err := NewTemporaryUploadRepository(repo) if err != nil { - log.Error("NewTemporaryUploadRepository failed: %v", err) + return nil, fmt.Errorf("NewTemporaryUploadRepository failed: %w", err) } - defer t.Close() - if err := t.Clone(ctx, opts.OldBranch, true); err != nil { + defer func() { + if retErr != nil { + t.Close() + } + }() + // here must NOT use bare repo, because the following git commands might operate working tree ("--index") directly + if err := t.Clone(ctx, opts.OldBranch, false); err != nil { return nil, err } if err := t.SetDefaultIndex(ctx); err != nil { @@ -153,7 +149,7 @@ func ApplyDiffPatch(ctx context.Context, repo *repo_model.Repository, doer *user } else { lastCommitID, err := t.gitRepo.ConvertToGitID(opts.LastCommitID) if err != nil { - return nil, fmt.Errorf("ApplyPatch: Invalid last commit ID: %w", err) + return nil, fmt.Errorf("invalid last commit ID: %w", err) } opts.LastCommitID = lastCommitID.String() if commit.ID.String() != opts.LastCommitID { @@ -163,6 +159,20 @@ func ApplyDiffPatch(ctx context.Context, repo *repo_model.Repository, doer *user } } } + return t, nil +} + +// ApplyDiffPatch applies a patch to the given repository +func ApplyDiffPatch(ctx reqctx.RequestContext, repo *repo_model.Repository, doer *user_model.User, opts *ApplyDiffPatchOptions) (*structs.FileResponse, error) { + gitRepo, err := gitrepo.RepositoryFromRequestContextOrOpen(ctx, repo) + if err != nil { + return nil, err + } + t, err := gitPatchPrepare(ctx, repo, gitRepo, doer, opts) + if err != nil { + return nil, err + } + defer t.Close() cmdApply := gitcmd.NewCommand("apply", "--index", "--recount", "--cached", "--ignore-whitespace", "--whitespace=fix", "--binary") if git.DefaultFeatures().CheckVersionAtLeast("2.32") { @@ -175,17 +185,19 @@ func ApplyDiffPatch(ctx context.Context, repo *repo_model.Repository, doer *user return nil, fmt.Errorf("git apply error: %w", err) } - // Now write the tree + return gitPatchCommitPush(ctx, t, repo, doer, opts) +} + +func gitPatchCommitPush(ctx context.Context, t *TemporaryUploadRepository, repo *repo_model.Repository, doer *user_model.User, opts *ApplyDiffPatchOptions) (*structs.FileResponse, error) { treeHash, err := t.WriteTree(ctx) if err != nil { return nil, err } - // Now commit the tree commitOpts := &CommitTreeUserOptions{ ParentCommitID: "HEAD", TreeHash: treeHash, - CommitMessage: message, + CommitMessage: strings.TrimSpace(opts.Message), SignOff: opts.Signoff, DoerUser: doer, AuthorIdentity: opts.Author, @@ -206,7 +218,7 @@ func ApplyDiffPatch(ctx context.Context, repo *repo_model.Repository, doer *user return nil, err } - commit, err = t.GetCommit(commitHash) + commit, err := t.GetCommit(commitHash) if err != nil { return nil, err } diff --git a/services/repository/files/patch_test.go b/services/repository/files/patch_test.go new file mode 100644 index 00000000000..37d21b4dada --- /dev/null +++ b/services/repository/files/patch_test.go @@ -0,0 +1,36 @@ +// Copyright 2026 The Gitea Authors. All rights reserved. +// SPDX-License-Identifier: MIT + +package files + +import ( + "os" + "path/filepath" + "testing" + + repo_model "gitea.dev/models/repo" + "gitea.dev/models/unittest" + user_model "gitea.dev/models/user" + "gitea.dev/modules/gitrepo" + + "github.com/stretchr/testify/require" +) + +func TestGitPatchPrepare(t *testing.T) { + unittest.PrepareTestEnv(t) + user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2}) + repo1 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1}) + + gitRepo, err := gitrepo.OpenRepository(t.Context(), repo1) + require.NoError(t, err) + defer gitRepo.Close() + + opts := &ApplyDiffPatchOptions{} + tmpRepo, err := gitPatchPrepare(t.Context(), repo1, gitRepo, user2, opts) + require.NoError(t, err) + defer tmpRepo.Close() + // temporary repository for patch should not be a bare repo because "--index" argument is used, + // while it is questionable whether "--index" argument should be really used, need to figure out in the future. + _, err = os.Stat(filepath.Join(tmpRepo.basePath, ".git")) + require.NoError(t, err) +} diff --git a/services/repository/files/update.go b/services/repository/files/update.go index 8da9021a407..4fab88af04b 100644 --- a/services/repository/files/update.go +++ b/services/repository/files/update.go @@ -175,7 +175,7 @@ func ChangeRepoFiles(ctx context.Context, repo *repo_model.Repository, doer *use t, err := NewTemporaryUploadRepository(repo) if err != nil { - log.Error("NewTemporaryUploadRepository failed: %v", err) + return nil, fmt.Errorf("NewTemporaryUploadRepository failed: %w", err) } defer t.Close() hasOldBranch := true