Move get/set default branch from git package to gitrepo package to hide repopath (#29126)

lunny · web-flow · commit 25b842df2614 · 2024-03-08T15:30:10.000+08:00
diff --git a/models/issues/pull.go b/models/issues/pull.go
@@ -901,12 +901,7 @@ func PullRequestCodeOwnersReview(ctx context.Context, pull *Issue, pr *PullReque
 	}
 	defer repo.Close()
 
-	branch, err := repo.GetDefaultBranch()
-	if err != nil {
-		return err
-	}
-
-	commit, err := repo.GetBranchCommit(branch)
+	commit, err := repo.GetBranchCommit(pr.BaseRepo.DefaultBranch)
 	if err != nil {
 		return err
 	}
diff --git a/modules/git/repo_branch.go b/modules/git/repo_branch.go
@@ -55,15 +55,8 @@ func (repo *Repository) GetHEADBranch() (*Branch, error) {
 	}, nil
 }
 
-// SetDefaultBranch sets default branch of repository.
-func (repo *Repository) SetDefaultBranch(name string) error {
-	_, _, err := NewCommand(repo.Ctx, "symbolic-ref", "HEAD").AddDynamicArguments(BranchPrefix + name).RunStdString(&RunOpts{Dir: repo.Path})
-	return err
-}
-
-// GetDefaultBranch gets default branch of repository.
-func (repo *Repository) GetDefaultBranch() (string, error) {
-	stdout, _, err := NewCommand(repo.Ctx, "symbolic-ref", "HEAD").RunStdString(&RunOpts{Dir: repo.Path})
+func GetDefaultBranch(ctx context.Context, repoPath string) (string, error) {
+	stdout, _, err := NewCommand(ctx, "symbolic-ref", "HEAD").RunStdString(&RunOpts{Dir: repoPath})
 	if err != nil {
 		return "", err
 	}
diff --git a/modules/gitrepo/branch.go b/modules/gitrepo/branch.go
@@ -30,3 +30,20 @@ func GetBranchCommitID(ctx context.Context, repo Repository, branch string) (str
 
 	return gitRepo.GetBranchCommitID(branch)
 }
+
+// SetDefaultBranch sets default branch of repository.
+func SetDefaultBranch(ctx context.Context, repo Repository, name string) error {
+	_, _, err := git.NewCommand(ctx, "symbolic-ref", "HEAD").
+		AddDynamicArguments(git.BranchPrefix + name).
+		RunStdString(&git.RunOpts{Dir: repoPath(repo)})
+	return err
+}
+
+// GetDefaultBranch gets default branch of repository.
+func GetDefaultBranch(ctx context.Context, repo Repository) (string, error) {
+	return git.GetDefaultBranch(ctx, repoPath(repo))
+}
+
+func GetWikiDefaultBranch(ctx context.Context, repo Repository) (string, error) {
+	return git.GetDefaultBranch(ctx, wikiPath(repo))
+}
diff --git a/routers/api/v1/repo/repo.go b/routers/api/v1/repo/repo.go
@@ -720,7 +720,7 @@ func updateBasicProperties(ctx *context.APIContext, opts api.EditRepoOption) err
 
 	if ctx.Repo.GitRepo == nil && !repo.IsEmpty {
 		var err error
-		ctx.Repo.GitRepo, err = gitrepo.OpenRepository(ctx, ctx.Repo.Repository)
+		ctx.Repo.GitRepo, err = gitrepo.OpenRepository(ctx, repo)
 		if err != nil {
 			ctx.Error(http.StatusInternalServerError, "Unable to OpenRepository", err)
 			return err
@@ -731,7 +731,7 @@ func updateBasicProperties(ctx *context.APIContext, opts api.EditRepoOption) err
 	// Default branch only updated if changed and exist or the repository is empty
 	if opts.DefaultBranch != nil && repo.DefaultBranch != *opts.DefaultBranch && (repo.IsEmpty || ctx.Repo.GitRepo.IsBranchExist(*opts.DefaultBranch)) {
 		if !repo.IsEmpty {
-			if err := ctx.Repo.GitRepo.SetDefaultBranch(*opts.DefaultBranch); err != nil {
+			if err := gitrepo.SetDefaultBranch(ctx, ctx.Repo.Repository, *opts.DefaultBranch); err != nil {
 				if !git.IsErrUnsupportedVersion(err) {
 					ctx.Error(http.StatusInternalServerError, "SetDefaultBranch", err)
 					return err
diff --git a/routers/private/default_branch.go b/routers/private/default_branch.go
@@ -9,6 +9,7 @@ import (
 
 	repo_model "code.gitea.io/gitea/models/repo"
 	"code.gitea.io/gitea/modules/git"
+	"code.gitea.io/gitea/modules/gitrepo"
 	"code.gitea.io/gitea/modules/private"
 	gitea_context "code.gitea.io/gitea/services/context"
 )
@@ -20,7 +21,7 @@ func SetDefaultBranch(ctx *gitea_context.PrivateContext) {
 	branch := ctx.Params(":branch")
 
 	ctx.Repo.Repository.DefaultBranch = branch
-	if err := ctx.Repo.GitRepo.SetDefaultBranch(ctx.Repo.Repository.DefaultBranch); err != nil {
+	if err := gitrepo.SetDefaultBranch(ctx, ctx.Repo.Repository, ctx.Repo.Repository.DefaultBranch); err != nil {
 		if !git.IsErrUnsupportedVersion(err) {
 			ctx.JSON(http.StatusInternalServerError, private.Response{
 				Err: fmt.Sprintf("Unable to set default branch on repository: %s/%s Error: %v", ownerName, repoName, err),
diff --git a/routers/web/repo/wiki.go b/routers/web/repo/wiki.go
@@ -102,7 +102,7 @@ func findWikiRepoCommit(ctx *context.Context) (*git.Repository, *git.Commit, err
 	commit, errCommit := wikiGitRepo.GetBranchCommit(ctx.Repo.Repository.DefaultWikiBranch)
 	if git.IsErrNotExist(errCommit) {
 		// if the default branch recorded in database is out of sync, then re-sync it
-		gitRepoDefaultBranch, errBranch := wikiGitRepo.GetDefaultBranch()
+		gitRepoDefaultBranch, errBranch := gitrepo.GetWikiDefaultBranch(ctx, ctx.Repo.Repository)
 		if errBranch != nil {
 			return wikiGitRepo, nil, errBranch
 		}
diff --git a/services/context/repo.go b/services/context/repo.go
@@ -681,7 +681,7 @@ func RepoAssignment(ctx *Context) context.CancelFunc {
 		if len(ctx.Repo.Repository.DefaultBranch) > 0 && gitRepo.IsBranchExist(ctx.Repo.Repository.DefaultBranch) {
 			ctx.Repo.BranchName = ctx.Repo.Repository.DefaultBranch
 		} else {
-			ctx.Repo.BranchName, _ = gitRepo.GetDefaultBranch()
+			ctx.Repo.BranchName, _ = gitrepo.GetDefaultBranch(ctx, ctx.Repo.Repository)
 			if ctx.Repo.BranchName == "" {
 				// If it still can't get a default branch, fall back to default branch from setting.
 				// Something might be wrong. Either site admin should fix the repo sync or Gitea should fix a potential bug.
diff --git a/services/mirror/mirror_pull.go b/services/mirror/mirror_pull.go
@@ -593,7 +593,7 @@ func checkAndUpdateEmptyRepository(ctx context.Context, m *repo_model.Mirror, gi
 			m.Repo.DefaultBranch = firstName
 		}
 		// Update the git repository default branch
-		if err := gitRepo.SetDefaultBranch(m.Repo.DefaultBranch); err != nil {
+		if err := gitrepo.SetDefaultBranch(ctx, m.Repo, m.Repo.DefaultBranch); err != nil {
 			if !git.IsErrUnsupportedVersion(err) {
 				log.Error("Failed to update default branch of underlying git repository %-v. Error: %v", m.Repo, err)
 				desc := fmt.Sprintf("Failed to update default branch of underlying git repository '%s': %v", m.Repo.RepoPath(), err)
diff --git a/services/repository/adopt.go b/services/repository/adopt.go
@@ -127,24 +127,17 @@ func adoptRepository(ctx context.Context, repoPath string, u *user_model.User, r
 
 	repo.IsEmpty = false
 
-	// Don't bother looking this repo in the context it won't be there
-	gitRepo, err := gitrepo.OpenRepository(ctx, repo)
-	if err != nil {
-		return fmt.Errorf("openRepository: %w", err)
-	}
-	defer gitRepo.Close()
-
 	if len(defaultBranch) > 0 {
 		repo.DefaultBranch = defaultBranch
 
-		if err = gitRepo.SetDefaultBranch(repo.DefaultBranch); err != nil {
+		if err = gitrepo.SetDefaultBranch(ctx, repo, repo.DefaultBranch); err != nil {
 			return fmt.Errorf("setDefaultBranch: %w", err)
 		}
 	} else {
-		repo.DefaultBranch, err = gitRepo.GetDefaultBranch()
+		repo.DefaultBranch, err = gitrepo.GetDefaultBranch(ctx, repo)
 		if err != nil {
 			repo.DefaultBranch = setting.Repository.DefaultBranch
-			if err = gitRepo.SetDefaultBranch(repo.DefaultBranch); err != nil {
+			if err = gitrepo.SetDefaultBranch(ctx, repo, repo.DefaultBranch); err != nil {
 				return fmt.Errorf("setDefaultBranch: %w", err)
 			}
 		}
@@ -188,7 +181,7 @@ func adoptRepository(ctx context.Context, repoPath string, u *user_model.User, r
 			repo.DefaultBranch = setting.Repository.DefaultBranch
 		}
 
-		if err = gitRepo.SetDefaultBranch(repo.DefaultBranch); err != nil {
+		if err = gitrepo.SetDefaultBranch(ctx, repo, repo.DefaultBranch); err != nil {
 			return fmt.Errorf("setDefaultBranch: %w", err)
 		}
 	}
@@ -197,6 +190,13 @@ func adoptRepository(ctx context.Context, repoPath string, u *user_model.User, r
 		return fmt.Errorf("updateRepository: %w", err)
 	}
 
+	// Don't bother looking this repo in the context it won't be there
+	gitRepo, err := gitrepo.OpenRepository(ctx, repo)
+	if err != nil {
+		return fmt.Errorf("openRepository: %w", err)
+	}
+	defer gitRepo.Close()
+
 	if err = repo_module.SyncReleasesWithTags(ctx, repo, gitRepo); err != nil {
 		return fmt.Errorf("SyncReleasesWithTags: %w", err)
 	}
diff --git a/services/repository/branch.go b/services/repository/branch.go
@@ -375,7 +375,7 @@ func RenameBranch(ctx context.Context, repo *repo_model.Repository, doer *user_m
 				log.Error("CancelRunningJobs: %v", err)
 			}
 
-			err2 = gitRepo.SetDefaultBranch(to)
+			err2 = gitrepo.SetDefaultBranch(ctx, repo, to)
 			if err2 != nil {
 				return err2
 			}
@@ -540,7 +540,7 @@ func SetRepoDefaultBranch(ctx context.Context, repo *repo_model.Repository, gitR
 			log.Error("CancelRunningJobs: %v", err)
 		}
 
-		if err := gitRepo.SetDefaultBranch(newBranchName); err != nil {
+		if err := gitrepo.SetDefaultBranch(ctx, repo, newBranchName); err != nil {
 			if !git.IsErrUnsupportedVersion(err) {
 				return err
 			}
diff --git a/services/repository/create.go b/services/repository/create.go
@@ -177,12 +177,7 @@ func initRepository(ctx context.Context, repoPath string, u *user_model.User, re
 
 	if len(opts.DefaultBranch) > 0 {
 		repo.DefaultBranch = opts.DefaultBranch
-		gitRepo, err := gitrepo.OpenRepository(ctx, repo)
-		if err != nil {
-			return fmt.Errorf("openRepository: %w", err)
-		}
-		defer gitRepo.Close()
-		if err = gitRepo.SetDefaultBranch(repo.DefaultBranch); err != nil {
+		if err = gitrepo.SetDefaultBranch(ctx, repo, repo.DefaultBranch); err != nil {
 			return fmt.Errorf("setDefaultBranch: %w", err)
 		}
 
diff --git a/services/repository/generate.go b/services/repository/generate.go
@@ -272,12 +272,7 @@ func generateGitContent(ctx context.Context, repo, templateRepo, generateRepo *r
 		repo.DefaultBranch = templateRepo.DefaultBranch
 	}
 
-	gitRepo, err := gitrepo.OpenRepository(ctx, repo)
-	if err != nil {
-		return fmt.Errorf("openRepository: %w", err)
-	}
-	defer gitRepo.Close()
-	if err = gitRepo.SetDefaultBranch(repo.DefaultBranch); err != nil {
+	if err = gitrepo.SetDefaultBranch(ctx, repo, repo.DefaultBranch); err != nil {
 		return fmt.Errorf("setDefaultBranch: %w", err)
 	}
 	if err = UpdateRepository(ctx, repo, false); err != nil {
diff --git a/services/repository/migrate.go b/services/repository/migrate.go
@@ -57,14 +57,7 @@ func cloneWiki(ctx context.Context, u *user_model.User, opts migration.MigrateOp
 		return "", err
 	}
 
-	wikiRepo, err := git.OpenRepository(ctx, wikiPath)
-	if err != nil {
-		cleanIncompleteWikiPath()
-		return "", fmt.Errorf("failed to open wiki repo %q, err: %w", wikiPath, err)
-	}
-	defer wikiRepo.Close()
-
-	defaultBranch, err := wikiRepo.GetDefaultBranch()
+	defaultBranch, err := git.GetDefaultBranch(ctx, wikiPath)
 	if err != nil {
 		cleanIncompleteWikiPath()
 		return "", fmt.Errorf("failed to get wiki repo default branch for %q, err: %w", wikiPath, err)
diff --git a/services/repository/push.go b/services/repository/push.go
@@ -182,7 +182,7 @@ func pushUpdates(optsList []*repo_module.PushUpdateOptions) error {
 						repo.DefaultBranch = refName
 						repo.IsEmpty = false
 						if repo.DefaultBranch != setting.Repository.DefaultBranch {
-							if err := gitRepo.SetDefaultBranch(repo.DefaultBranch); err != nil {
+							if err := gitrepo.SetDefaultBranch(ctx, repo, repo.DefaultBranch); err != nil {
 								if !git.IsErrUnsupportedVersion(err) {
 									return err
 								}
diff --git a/services/wiki/wiki.go b/services/wiki/wiki.go
@@ -370,6 +370,14 @@ func ChangeDefaultWikiBranch(ctx context.Context, repo *repo_model.Repository, n
 			return fmt.Errorf("unable to update database: %w", err)
 		}
 
+		oldDefBranch, err := gitrepo.GetWikiDefaultBranch(ctx, repo)
+		if err != nil {
+			return fmt.Errorf("unable to get default branch: %w", err)
+		}
+		if oldDefBranch == newBranch {
+			return nil
+		}
+
 		gitRepo, err := gitrepo.OpenWikiRepository(ctx, repo)
 		if errors.Is(err, util.ErrNotExist) {
 			return nil // no git repo on storage, no need to do anything else
@@ -378,14 +386,6 @@ func ChangeDefaultWikiBranch(ctx context.Context, repo *repo_model.Repository, n
 		}
 		defer gitRepo.Close()
 
-		oldDefBranch, err := gitRepo.GetDefaultBranch()
-		if err != nil {
-			return fmt.Errorf("unable to get default branch: %w", err)
-		}
-		if oldDefBranch == newBranch {
-			return nil
-		}
-
 		err = gitRepo.RenameBranch(oldDefBranch, newBranch)
 		if err != nil {
 			return fmt.Errorf("unable to rename default branch: %w", err)

Original file line number	Diff line number	Diff line change
`@@ -901,12 +901,7 @@ func PullRequestCodeOwnersReview(ctx context.Context, pull Issue, pr PullReque`
`901`	`901`	`}`
`902`	`902`	`defer repo.Close()`
`903`	`903`
`904`		`- branch, err := repo.GetDefaultBranch()`
`905`		`- if err != nil {`
`906`		`- return err`
`907`		`- }`
`908`		`-`
`909`		`- commit, err := repo.GetBranchCommit(branch)`
	`904`	`+ commit, err := repo.GetBranchCommit(pr.BaseRepo.DefaultBranch)`
`910`	`905`	`if err != nil {`
`911`	`906`	`return err`
`912`	`907`	`}`
Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ func findWikiRepoCommit(ctx context.Context) (git.Repository, *git.Commit, err`
`102`	`102`	`commit, errCommit := wikiGitRepo.GetBranchCommit(ctx.Repo.Repository.DefaultWikiBranch)`
`103`	`103`	`if git.IsErrNotExist(errCommit) {`
`104`	`104`	`// if the default branch recorded in database is out of sync, then re-sync it`
`105`		`- gitRepoDefaultBranch, errBranch := wikiGitRepo.GetDefaultBranch()`
	`105`	`+ gitRepoDefaultBranch, errBranch := gitrepo.GetWikiDefaultBranch(ctx, ctx.Repo.Repository)`
`106`	`106`	`if errBranch != nil {`
`107`	`107`	`return wikiGitRepo, nil, errBranch`
`108`	`108`	`}`
Original file line number	Diff line number	Diff line change
`@@ -593,7 +593,7 @@ func checkAndUpdateEmptyRepository(ctx context.Context, m *repo_model.Mirror, gi`
`593`	`593`	`m.Repo.DefaultBranch = firstName`
`594`	`594`	`}`
`595`	`595`	`// Update the git repository default branch`
`596`		`- if err := gitRepo.SetDefaultBranch(m.Repo.DefaultBranch); err != nil {`
	`596`	`+ if err := gitrepo.SetDefaultBranch(ctx, m.Repo, m.Repo.DefaultBranch); err != nil {`
`597`	`597`	`if !git.IsErrUnsupportedVersion(err) {`
`598`	`598`	`log.Error("Failed to update default branch of underlying git repository %-v. Error: %v", m.Repo, err)`
`599`	`599`	`desc := fmt.Sprintf("Failed to update default branch of underlying git repository '%s': %v", m.Repo.RepoPath(), err)`
Original file line number	Diff line number	Diff line change
`@@ -127,24 +127,17 @@ func adoptRepository(ctx context.Context, repoPath string, u *user_model.User, r`
`127`	`127`
`128`	`128`	`repo.IsEmpty = false`
`129`	`129`
`130`		`- // Don't bother looking this repo in the context it won't be there`
`131`		`- gitRepo, err := gitrepo.OpenRepository(ctx, repo)`
`132`		`- if err != nil {`
`133`		`- return fmt.Errorf("openRepository: %w", err)`
`134`		`- }`
`135`		`- defer gitRepo.Close()`
`136`		`-`
`137`	`130`	`if len(defaultBranch) > 0 {`
`138`	`131`	`repo.DefaultBranch = defaultBranch`
`139`	`132`
`140`		`- if err = gitRepo.SetDefaultBranch(repo.DefaultBranch); err != nil {`
	`133`	`+ if err = gitrepo.SetDefaultBranch(ctx, repo, repo.DefaultBranch); err != nil {`
`141`	`134`	`return fmt.Errorf("setDefaultBranch: %w", err)`
`142`	`135`	`}`
`143`	`136`	`} else {`
`144`		`- repo.DefaultBranch, err = gitRepo.GetDefaultBranch()`
	`137`	`+ repo.DefaultBranch, err = gitrepo.GetDefaultBranch(ctx, repo)`
`145`	`138`	`if err != nil {`
`146`	`139`	`repo.DefaultBranch = setting.Repository.DefaultBranch`
`147`		`- if err = gitRepo.SetDefaultBranch(repo.DefaultBranch); err != nil {`
	`140`	`+ if err = gitrepo.SetDefaultBranch(ctx, repo, repo.DefaultBranch); err != nil {`
`148`	`141`	`return fmt.Errorf("setDefaultBranch: %w", err)`
`149`	`142`	`}`
`150`	`143`	`}`
`@@ -188,7 +181,7 @@ func adoptRepository(ctx context.Context, repoPath string, u *user_model.User, r`
`188`	`181`	`repo.DefaultBranch = setting.Repository.DefaultBranch`
`189`	`182`	`}`
`190`	`183`
`191`		`- if err = gitRepo.SetDefaultBranch(repo.DefaultBranch); err != nil {`
	`184`	`+ if err = gitrepo.SetDefaultBranch(ctx, repo, repo.DefaultBranch); err != nil {`
`192`	`185`	`return fmt.Errorf("setDefaultBranch: %w", err)`
`193`	`186`	`}`
`194`	`187`	`}`
`@@ -197,6 +190,13 @@ func adoptRepository(ctx context.Context, repoPath string, u *user_model.User, r`
`197`	`190`	`return fmt.Errorf("updateRepository: %w", err)`
`198`	`191`	`}`
`199`	`192`
	`193`	`+ // Don't bother looking this repo in the context it won't be there`
	`194`	`+ gitRepo, err := gitrepo.OpenRepository(ctx, repo)`
	`195`	`+ if err != nil {`
	`196`	`+ return fmt.Errorf("openRepository: %w", err)`
	`197`	`+ }`
	`198`	`+ defer gitRepo.Close()`
	`199`	`+`
`200`	`200`	`if err = repo_module.SyncReleasesWithTags(ctx, repo, gitRepo); err != nil {`
`201`	`201`	`return fmt.Errorf("SyncReleasesWithTags: %w", err)`
`202`	`202`	`}`
Original file line number	Diff line number	Diff line change
`@@ -375,7 +375,7 @@ func RenameBranch(ctx context.Context, repo repo_model.Repository, doer user_m`
`375`	`375`	`log.Error("CancelRunningJobs: %v", err)`
`376`	`376`	`}`
`377`	`377`
`378`		`- err2 = gitRepo.SetDefaultBranch(to)`
	`378`	`+ err2 = gitrepo.SetDefaultBranch(ctx, repo, to)`
`379`	`379`	`if err2 != nil {`
`380`	`380`	`return err2`
`381`	`381`	`}`
`@@ -540,7 +540,7 @@ func SetRepoDefaultBranch(ctx context.Context, repo *repo_model.Repository, gitR`
`540`	`540`	`log.Error("CancelRunningJobs: %v", err)`
`541`	`541`	`}`
`542`	`542`
`543`		`- if err := gitRepo.SetDefaultBranch(newBranchName); err != nil {`
	`543`	`+ if err := gitrepo.SetDefaultBranch(ctx, repo, newBranchName); err != nil {`
`544`	`544`	`if !git.IsErrUnsupportedVersion(err) {`
`545`	`545`	`return err`
`546`	`546`	`}`
Original file line number	Diff line number	Diff line change
`@@ -272,12 +272,7 @@ func generateGitContent(ctx context.Context, repo, templateRepo, generateRepo *r`
`272`	`272`	`repo.DefaultBranch = templateRepo.DefaultBranch`
`273`	`273`	`}`
`274`	`274`
`275`		`- gitRepo, err := gitrepo.OpenRepository(ctx, repo)`
`276`		`- if err != nil {`
`277`		`- return fmt.Errorf("openRepository: %w", err)`
`278`		`- }`
`279`		`- defer gitRepo.Close()`
`280`		`- if err = gitRepo.SetDefaultBranch(repo.DefaultBranch); err != nil {`
	`275`	`+ if err = gitrepo.SetDefaultBranch(ctx, repo, repo.DefaultBranch); err != nil {`
`281`	`276`	`return fmt.Errorf("setDefaultBranch: %w", err)`
`282`	`277`	`}`
`283`	`278`	`if err = UpdateRepository(ctx, repo, false); err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -182,7 +182,7 @@ func pushUpdates(optsList []*repo_module.PushUpdateOptions) error {`
`182`	`182`	`repo.DefaultBranch = refName`
`183`	`183`	`repo.IsEmpty = false`
`184`	`184`	`if repo.DefaultBranch != setting.Repository.DefaultBranch {`
`185`		`- if err := gitRepo.SetDefaultBranch(repo.DefaultBranch); err != nil {`
	`185`	`+ if err := gitrepo.SetDefaultBranch(ctx, repo, repo.DefaultBranch); err != nil {`
`186`	`186`	`if !git.IsErrUnsupportedVersion(err) {`
`187`	`187`	`return err`
`188`	`188`	`}`