Skip to content

Commit d703488

Browse files
GiteaBotchangchaishiwxiaoguang
authored
Fix sync fork for consistency (#33147) (#33192)
Backport #33147 by changchaishi Fixes #33145 An integration test could be added. --------- Co-authored-by: Chai-Shi <[email protected]> Co-authored-by: wxiaoguang <[email protected]>
1 parent 940a930 commit d703488

File tree

8 files changed

+309
-12
lines changed

8 files changed

+309
-12
lines changed

‎modules/structs/repo_branch.go

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,3 +133,11 @@ type EditBranchProtectionOption struct {
133133
type UpdateBranchProtectionPriories struct {
134134
IDs []int64 `json:"ids"`
135135
}
136+
137+
type MergeUpstreamRequest struct {
138+
Branch string `json:"branch"`
139+
}
140+
141+
type MergeUpstreamResponse struct {
142+
MergeStyle string `json:"merge_type"`
143+
}

‎routers/api/v1/api.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1190,6 +1190,7 @@ func Routes() *web.Router {
11901190
m.Get("/archive/*", reqRepoReader(unit.TypeCode), repo.GetArchive)
11911191
m.Combo("/forks").Get(repo.ListForks).
11921192
Post(reqToken(), reqRepoReader(unit.TypeCode), bind(api.CreateForkOption{}), repo.CreateFork)
1193+
m.Post("/merge-upstream", reqToken(), mustNotBeArchived, reqRepoWriter(unit.TypeCode), bind(api.MergeUpstreamRequest{}), repo.MergeUpstream)
11931194
m.Group("/branches", func() {
11941195
m.Get("", repo.ListBranches)
11951196
m.Get("/*", repo.GetBranch)

‎routers/api/v1/repo/branch.go

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import (
1919
"code.gitea.io/gitea/modules/optional"
2020
repo_module "code.gitea.io/gitea/modules/repository"
2121
api "code.gitea.io/gitea/modules/structs"
22+
"code.gitea.io/gitea/modules/util"
2223
"code.gitea.io/gitea/modules/web"
2324
"code.gitea.io/gitea/routers/api/v1/utils"
2425
"code.gitea.io/gitea/services/context"
@@ -1194,3 +1195,47 @@ func UpdateBranchProtectionPriories(ctx *context.APIContext) {
11941195

11951196
ctx.Status(http.StatusNoContent)
11961197
}
1198+
1199+
func MergeUpstream(ctx *context.APIContext) {
1200+
// swagger:operation POST /repos/{owner}/{repo}/merge-upstream repository repoMergeUpstream
1201+
// ---
1202+
// summary: Merge a branch from upstream
1203+
// produces:
1204+
// - application/json
1205+
// parameters:
1206+
// - name: owner
1207+
// in: path
1208+
// description: owner of the repo
1209+
// type: string
1210+
// required: true
1211+
// - name: repo
1212+
// in: path
1213+
// description: name of the repo
1214+
// type: string
1215+
// required: true
1216+
// - name: body
1217+
// in: body
1218+
// schema:
1219+
// "$ref": "#/definitions/MergeUpstreamRequest"
1220+
// responses:
1221+
// "200":
1222+
// "$ref": "#/responses/MergeUpstreamResponse"
1223+
// "400":
1224+
// "$ref": "#/responses/error"
1225+
// "404":
1226+
// "$ref": "#/responses/notFound"
1227+
form := web.GetForm(ctx).(*api.MergeUpstreamRequest)
1228+
mergeStyle, err := repo_service.MergeUpstream(ctx, ctx.Doer, ctx.Repo.Repository, form.Branch)
1229+
if err != nil {
1230+
if errors.Is(err, util.ErrInvalidArgument) {
1231+
ctx.Error(http.StatusBadRequest, "MergeUpstream", err)
1232+
return
1233+
} else if errors.Is(err, util.ErrNotExist) {
1234+
ctx.Error(http.StatusNotFound, "MergeUpstream", err)
1235+
return
1236+
}
1237+
ctx.Error(http.StatusInternalServerError, "MergeUpstream", err)
1238+
return
1239+
}
1240+
ctx.JSON(http.StatusOK, &api.MergeUpstreamResponse{MergeStyle: mergeStyle})
1241+
}

‎routers/api/v1/swagger/repo.go

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -448,3 +448,15 @@ type swaggerCompare struct {
448448
// in:body
449449
Body api.Compare `json:"body"`
450450
}
451+
452+
// swagger:response MergeUpstreamRequest
453+
type swaggerMergeUpstreamRequest struct {
454+
// in:body
455+
Body api.MergeUpstreamRequest `json:"body"`
456+
}
457+
458+
// swagger:response MergeUpstreamResponse
459+
type swaggerMergeUpstreamResponse struct {
460+
// in:body
461+
Body api.MergeUpstreamResponse `json:"body"`
462+
}

‎services/repository/merge_upstream.go

Lines changed: 40 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,19 @@ import (
1212
repo_model "code.gitea.io/gitea/models/repo"
1313
user_model "code.gitea.io/gitea/models/user"
1414
"code.gitea.io/gitea/modules/git"
15+
"code.gitea.io/gitea/modules/gitrepo"
1516
repo_module "code.gitea.io/gitea/modules/repository"
1617
"code.gitea.io/gitea/modules/util"
1718
"code.gitea.io/gitea/services/pull"
1819
)
1920

2021
type UpstreamDivergingInfo struct {
21-
BaseIsNewer bool
22-
CommitsBehind int
23-
CommitsAhead int
22+
BaseHasNewCommits bool
23+
CommitsBehind int
24+
CommitsAhead int
2425
}
2526

27+
// MergeUpstream merges the base repository's default branch into the fork repository's current branch.
2628
func MergeUpstream(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, branch string) (mergeStyle string, err error) {
2729
if err = repo.MustNotBeArchived(); err != nil {
2830
return "", err
@@ -32,7 +34,7 @@ func MergeUpstream(ctx context.Context, doer *user_model.User, repo *repo_model.
3234
}
3335
err = git.Push(ctx, repo.BaseRepo.RepoPath(), git.PushOptions{
3436
Remote: repo.RepoPath(),
35-
Branch: fmt.Sprintf("%s:%s", branch, branch),
37+
Branch: fmt.Sprintf("%s:%s", repo.BaseRepo.DefaultBranch, branch),
3638
Env: repo_module.PushingEnvironment(doer, repo),
3739
})
3840
if err == nil {
@@ -64,7 +66,7 @@ func MergeUpstream(ctx context.Context, doer *user_model.User, repo *repo_model.
6466
BaseRepoID: repo.BaseRepo.ID,
6567
BaseRepo: repo.BaseRepo,
6668
HeadBranch: branch, // maybe HeadCommitID is not needed
67-
BaseBranch: branch,
69+
BaseBranch: repo.BaseRepo.DefaultBranch,
6870
}
6971
fakeIssue.PullRequest = fakePR
7072
err = pull.Update(ctx, fakePR, doer, "merge upstream", false)
@@ -74,6 +76,7 @@ func MergeUpstream(ctx context.Context, doer *user_model.User, repo *repo_model.
7476
return "merge", nil
7577
}
7678

79+
// GetUpstreamDivergingInfo returns the information about the divergence between the fork repository's branch and the base repository's default branch.
7780
func GetUpstreamDivergingInfo(ctx context.Context, repo *repo_model.Repository, branch string) (*UpstreamDivergingInfo, error) {
7881
if !repo.IsFork {
7982
return nil, util.NewInvalidArgumentErrorf("repo is not a fork")
@@ -92,7 +95,7 @@ func GetUpstreamDivergingInfo(ctx context.Context, repo *repo_model.Repository,
9295
return nil, err
9396
}
9497

95-
baseBranch, err := git_model.GetBranch(ctx, repo.BaseRepo.ID, branch)
98+
baseBranch, err := git_model.GetBranch(ctx, repo.BaseRepo.ID, repo.BaseRepo.DefaultBranch)
9699
if err != nil {
97100
return nil, err
98101
}
@@ -102,14 +105,42 @@ func GetUpstreamDivergingInfo(ctx context.Context, repo *repo_model.Repository,
102105
return info, nil
103106
}
104107

105-
// TODO: if the fork repo has new commits, this call will fail:
108+
// if the fork repo has new commits, this call will fail because they are not in the base repo
106109
// exit status 128 - fatal: Invalid symmetric difference expression aaaaaaaaaaaa...bbbbbbbbbbbb
107-
// so at the moment, we are not able to handle this case, should be improved in the future
110+
// so at the moment, we first check the update time, then check whether the fork branch has base's head
108111
diff, err := git.GetDivergingCommits(ctx, repo.BaseRepo.RepoPath(), baseBranch.CommitID, forkBranch.CommitID)
109112
if err != nil {
110-
info.BaseIsNewer = baseBranch.UpdatedUnix > forkBranch.UpdatedUnix
113+
info.BaseHasNewCommits = baseBranch.UpdatedUnix > forkBranch.UpdatedUnix
114+
if info.BaseHasNewCommits {
115+
return info, nil
116+
}
117+
118+
// if the base's update time is before the fork, check whether the base's head is in the fork
119+
baseGitRepo, baseGitRepoCloser, err := gitrepo.RepositoryFromContextOrOpen(ctx, repo.BaseRepo)
120+
if err != nil {
121+
return nil, err
122+
}
123+
defer baseGitRepoCloser.Close()
124+
125+
headGitRepo, headGitRepoCloser, err := gitrepo.RepositoryFromContextOrOpen(ctx, repo)
126+
if err != nil {
127+
return nil, err
128+
}
129+
defer headGitRepoCloser.Close()
130+
131+
baseCommitID, err := baseGitRepo.ConvertToGitID(baseBranch.CommitID)
132+
if err != nil {
133+
return nil, err
134+
}
135+
headCommit, err := headGitRepo.GetCommit(forkBranch.CommitID)
136+
if err != nil {
137+
return nil, err
138+
}
139+
hasPreviousCommit, _ := headCommit.HasPreviousCommit(baseCommitID)
140+
info.BaseHasNewCommits = !hasPreviousCommit
111141
return info, nil
112142
}
143+
113144
info.CommitsBehind, info.CommitsAhead = diff.Behind, diff.Ahead
114145
return info, nil
115146
}

‎templates/repo/code/upstream_diverging_info.tmpl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
{{if and .UpstreamDivergingInfo (or .UpstreamDivergingInfo.BaseIsNewer .UpstreamDivergingInfo.CommitsBehind)}}
1+
{{if and .UpstreamDivergingInfo (or .UpstreamDivergingInfo.BaseHasNewCommits .UpstreamDivergingInfo.CommitsBehind)}}
22
<div class="ui message flex-text-block">
33
<div class="tw-flex-1">
4-
{{$upstreamLink := printf "%s/src/branch/%s" .Repository.BaseRepo.Link (.BranchName|PathEscapeSegments)}}
5-
{{$upstreamHtml := HTMLFormat `<a href="%s">%s:%s</a>` $upstreamLink .Repository.BaseRepo.FullName .BranchName}}
4+
{{$upstreamLink := printf "%s/src/branch/%s" .Repository.BaseRepo.Link (.Repository.BaseRepo.DefaultBranch|PathEscapeSegments)}}
5+
{{$upstreamHtml := HTMLFormat `<a href="%s">%s:%s</a>` $upstreamLink .Repository.BaseRepo.FullName .Repository.BaseRepo.DefaultBranch}}
66
{{if .UpstreamDivergingInfo.CommitsBehind}}
77
{{ctx.Locale.TrN .UpstreamDivergingInfo.CommitsBehind "repo.pulls.upstream_diverging_prompt_behind_1" "repo.pulls.upstream_diverging_prompt_behind_n" .UpstreamDivergingInfo.CommitsBehind $upstreamHtml}}
88
{{else}}

‎templates/swagger/v1_json.tmpl

Lines changed: 78 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)