From 7e4db07081973810ebee511b5686d2baa9f698d5 Mon Sep 17 00:00:00 2001 From: wxiaoguang Date: Sat, 12 Jul 2025 10:48:12 +0800 Subject: [PATCH] simplify --- modules/git/commit_info_gogit.go | 4 ++-- modules/git/commit_info_nogogit.go | 4 ++-- modules/git/commit_info_test.go | 4 ++-- modules/git/commit_submodule_file.go | 29 +++++++++++++---------- modules/git/commit_submodule_file_test.go | 20 +++++++--------- routers/web/repo/view.go | 2 +- routers/web/repo/wiki.go | 3 +-- services/gitdiff/gitdiff.go | 4 ++-- services/gitdiff/submodule.go | 13 +++++----- services/gitdiff/submodule_test.go | 2 +- services/repository/files/tree.go | 16 ++++++------- services/repository/files/tree_test.go | 2 +- templates/repo/view_list.tmpl | 2 +- 13 files changed, 53 insertions(+), 52 deletions(-) diff --git a/modules/git/commit_info_gogit.go b/modules/git/commit_info_gogit.go index 204a026043..7bce1f57fb 100644 --- a/modules/git/commit_info_gogit.go +++ b/modules/git/commit_info_gogit.go @@ -16,7 +16,7 @@ import ( ) // GetCommitsInfo gets information of all commits that are corresponding to these entries -func (tes Entries) GetCommitsInfo(ctx context.Context, commit *Commit, treePath string) ([]CommitInfo, *Commit, error) { +func (tes Entries) GetCommitsInfo(ctx context.Context, repoLink string, commit *Commit, treePath string) ([]CommitInfo, *Commit, error) { entryPaths := make([]string, len(tes)+1) // Get the commit for the treePath itself entryPaths[0] = "" @@ -85,7 +85,7 @@ func (tes Entries) GetCommitsInfo(ctx context.Context, commit *Commit, treePath } else if subModule != nil { subModuleURL = subModule.URL } - subModuleFile := NewCommitSubmoduleFile(fullPath, subModuleURL, entry.ID.String()) + subModuleFile := NewCommitSubmoduleFile(repoLink, fullPath, subModuleURL, entry.ID.String()) commitsInfo[i].SubmoduleFile = subModuleFile } } diff --git a/modules/git/commit_info_nogogit.go b/modules/git/commit_info_nogogit.go index dcc0212dbe..4a1cf3f627 100644 --- a/modules/git/commit_info_nogogit.go +++ b/modules/git/commit_info_nogogit.go @@ -15,7 +15,7 @@ import ( ) // GetCommitsInfo gets information of all commits that are corresponding to these entries -func (tes Entries) GetCommitsInfo(ctx context.Context, commit *Commit, treePath string) ([]CommitInfo, *Commit, error) { +func (tes Entries) GetCommitsInfo(ctx context.Context, repoLink string, commit *Commit, treePath string) ([]CommitInfo, *Commit, error) { entryPaths := make([]string, len(tes)+1) // Get the commit for the treePath itself entryPaths[0] = "" @@ -76,7 +76,7 @@ func (tes Entries) GetCommitsInfo(ctx context.Context, commit *Commit, treePath } else if subModule != nil { subModuleURL = subModule.URL } - subModuleFile := NewCommitSubmoduleFile(fullPath, subModuleURL, entry.ID.String()) + subModuleFile := NewCommitSubmoduleFile(repoLink, fullPath, subModuleURL, entry.ID.String()) commitsInfo[i].SubmoduleFile = subModuleFile } } diff --git a/modules/git/commit_info_test.go b/modules/git/commit_info_test.go index ba518ab245..caaa6a502b 100644 --- a/modules/git/commit_info_test.go +++ b/modules/git/commit_info_test.go @@ -82,7 +82,7 @@ func testGetCommitsInfo(t *testing.T, repo1 *Repository) { } // FIXME: Context.TODO() - if graceful has started we should use its Shutdown context otherwise use install signals in TestMain. - commitsInfo, treeCommit, err := entries.GetCommitsInfo(t.Context(), commit, testCase.Path) + commitsInfo, treeCommit, err := entries.GetCommitsInfo(t.Context(), "/any/repo-link", commit, testCase.Path) assert.NoError(t, err, "Unable to get commit information for entries of subtree: %s in commit: %s from testcase due to error: %v", testCase.Path, testCase.CommitID, err) if err != nil { t.FailNow() @@ -159,7 +159,7 @@ func BenchmarkEntries_GetCommitsInfo(b *testing.B) { b.ResetTimer() b.Run(benchmark.name, func(b *testing.B) { for b.Loop() { - _, _, err := entries.GetCommitsInfo(b.Context(), commit, "") + _, _, err := entries.GetCommitsInfo(b.Context(), "/any/repo-link", commit, "") if err != nil { b.Fatal(err) } diff --git a/modules/git/commit_submodule_file.go b/modules/git/commit_submodule_file.go index 07502796b1..2d2dcf5255 100644 --- a/modules/git/commit_submodule_file.go +++ b/modules/git/commit_submodule_file.go @@ -14,6 +14,7 @@ import ( // CommitSubmoduleFile represents a file with submodule type. type CommitSubmoduleFile struct { + repoLink string fullPath string refURL string refID string @@ -23,20 +24,16 @@ type CommitSubmoduleFile struct { } // NewCommitSubmoduleFile create a new submodule file -func NewCommitSubmoduleFile(fullPath, refURL, refID string) *CommitSubmoduleFile { - return &CommitSubmoduleFile{fullPath: fullPath, refURL: refURL, refID: refID} +func NewCommitSubmoduleFile(repoLink, fullPath, refURL, refID string) *CommitSubmoduleFile { + return &CommitSubmoduleFile{repoLink: repoLink, fullPath: fullPath, refURL: refURL, refID: refID} } -func (sf *CommitSubmoduleFile) RefID() string { - return sf.refID -} - -func (sf *CommitSubmoduleFile) getWebLinkInTargetRepo(ctx context.Context, currentRepoHomeLink, moreLinkPath string) *SubmoduleWebLink { +func (sf *CommitSubmoduleFile) getWebLinkInTargetRepo(ctx context.Context, moreLinkPath string) *SubmoduleWebLink { if sf == nil { return nil } if strings.HasPrefix(sf.refURL, "../") { - targetLink := path.Join(currentRepoHomeLink, path.Dir(sf.fullPath), sf.refURL) + targetLink := path.Join(sf.repoLink, path.Dir(sf.fullPath), sf.refURL) return &SubmoduleWebLink{RepoWebLink: targetLink, CommitWebLink: targetLink + moreLinkPath} } if !sf.parsed { @@ -50,12 +47,20 @@ func (sf *CommitSubmoduleFile) getWebLinkInTargetRepo(ctx context.Context, curre return &SubmoduleWebLink{RepoWebLink: sf.parsedTargetLink, CommitWebLink: sf.parsedTargetLink + moreLinkPath} } +// RefID returns the commit ref id of the submodule file, it also works on "nil" receiver +func (sf *CommitSubmoduleFile) RefID() string { + if sf == nil { + return "" + } + return sf.refID +} + // SubmoduleWebLinkTree tries to make the submodule's tree link in its own repo, it also works on "nil" receiver -func (sf *CommitSubmoduleFile) SubmoduleWebLinkTree(ctx context.Context, currentRepoHomeLink, refCommitID string) *SubmoduleWebLink { - return sf.getWebLinkInTargetRepo(ctx, currentRepoHomeLink, "/tree/"+refCommitID) +func (sf *CommitSubmoduleFile) SubmoduleWebLinkTree(ctx context.Context, refCommitID string) *SubmoduleWebLink { + return sf.getWebLinkInTargetRepo(ctx, "/tree/"+refCommitID) } // SubmoduleWebLinkCompare tries to make the submodule's compare link in its own repo, it also works on "nil" receiver -func (sf *CommitSubmoduleFile) SubmoduleWebLinkCompare(ctx context.Context, currentRepoHomeLink, commitID1, commitID2 string) *SubmoduleWebLink { - return sf.getWebLinkInTargetRepo(ctx, currentRepoHomeLink, "/compare/"+commitID1+"..."+commitID2) +func (sf *CommitSubmoduleFile) SubmoduleWebLinkCompare(ctx context.Context, commitID1, commitID2 string) *SubmoduleWebLink { + return sf.getWebLinkInTargetRepo(ctx, "/compare/"+commitID1+"..."+commitID2) } diff --git a/modules/git/commit_submodule_file_test.go b/modules/git/commit_submodule_file_test.go index 3398623ce4..7809ac9b6a 100644 --- a/modules/git/commit_submodule_file_test.go +++ b/modules/git/commit_submodule_file_test.go @@ -10,30 +10,28 @@ import ( ) func TestCommitSubmoduleLink(t *testing.T) { - assert.Nil(t, (*CommitSubmoduleFile)(nil).SubmoduleWebLinkTree(t.Context(), "", "")) - assert.Nil(t, (*CommitSubmoduleFile)(nil).SubmoduleWebLinkCompare(t.Context(), "", "", "")) + assert.Nil(t, (*CommitSubmoduleFile)(nil).SubmoduleWebLinkTree(t.Context(), "")) + assert.Nil(t, (*CommitSubmoduleFile)(nil).SubmoduleWebLinkCompare(t.Context(), "", "")) t.Run("GitHubRepo", func(t *testing.T) { - curRepoLink := "/any/repo-home-link" - sf := NewCommitSubmoduleFile("full-path", "git@github.com:user/repo.git", "aaaa") - wl := sf.SubmoduleWebLinkTree(t.Context(), curRepoLink, sf.RefID()) + sf := NewCommitSubmoduleFile("/any/repo-link", "full-path", "git@github.com:user/repo.git", "aaaa") + wl := sf.SubmoduleWebLinkTree(t.Context(), sf.RefID()) assert.Equal(t, "https://github.com/user/repo", wl.RepoWebLink) assert.Equal(t, "https://github.com/user/repo/tree/aaaa", wl.CommitWebLink) - wl = sf.SubmoduleWebLinkCompare(t.Context(), curRepoLink, "1111", "2222") + wl = sf.SubmoduleWebLinkCompare(t.Context(), "1111", "2222") assert.Equal(t, "https://github.com/user/repo", wl.RepoWebLink) assert.Equal(t, "https://github.com/user/repo/compare/1111...2222", wl.CommitWebLink) }) t.Run("RelativePath", func(t *testing.T) { - curRepoLink := "/subpath/any/repo-home-link" - sf := NewCommitSubmoduleFile("full-path", "../../user/repo", "aaaa") - wl := sf.SubmoduleWebLinkTree(t.Context(), curRepoLink, sf.RefID()) + sf := NewCommitSubmoduleFile("/subpath/any/repo-home-link", "full-path", "../../user/repo", "aaaa") + wl := sf.SubmoduleWebLinkTree(t.Context(), sf.RefID()) assert.Equal(t, "/subpath/user/repo", wl.RepoWebLink) assert.Equal(t, "/subpath/user/repo/tree/aaaa", wl.CommitWebLink) - sf = NewCommitSubmoduleFile("dir/submodule", "../../../user/repo", "aaaa") - wl = sf.SubmoduleWebLinkCompare(t.Context(), curRepoLink, "1111", "2222") + sf = NewCommitSubmoduleFile("/subpath/any/repo-home-link", "dir/submodule", "../../../user/repo", "aaaa") + wl = sf.SubmoduleWebLinkCompare(t.Context(), "1111", "2222") assert.Equal(t, "/subpath/user/repo", wl.RepoWebLink) assert.Equal(t, "/subpath/user/repo/compare/1111...2222", wl.CommitWebLink) }) diff --git a/routers/web/repo/view.go b/routers/web/repo/view.go index 773919c054..e47bc56d08 100644 --- a/routers/web/repo/view.go +++ b/routers/web/repo/view.go @@ -305,7 +305,7 @@ func renderDirectoryFiles(ctx *context.Context, timeout time.Duration) git.Entri defer cancel() } - files, latestCommit, err := allEntries.GetCommitsInfo(commitInfoCtx, ctx.Repo.Commit, ctx.Repo.TreePath) + files, latestCommit, err := allEntries.GetCommitsInfo(commitInfoCtx, ctx.Repo.RepoLink, ctx.Repo.Commit, ctx.Repo.TreePath) if err != nil { ctx.ServerError("GetCommitsInfo", err) return nil diff --git a/routers/web/repo/wiki.go b/routers/web/repo/wiki.go index 69858c9692..a35b7b86e1 100644 --- a/routers/web/repo/wiki.go +++ b/routers/web/repo/wiki.go @@ -6,7 +6,6 @@ package repo import ( "bytes" - gocontext "context" "html/template" "io" "net/http" @@ -569,7 +568,7 @@ func WikiPages(ctx *context.Context) { } allEntries.CustomSort(base.NaturalSortLess) - entries, _, err := allEntries.GetCommitsInfo(gocontext.Context(ctx), commit, treePath) + entries, _, err := allEntries.GetCommitsInfo(ctx, ctx.Repo.RepoLink, commit, treePath) if err != nil { ctx.ServerError("GetCommitsInfo", err) return diff --git a/services/gitdiff/gitdiff.go b/services/gitdiff/gitdiff.go index 55a169997f..e2cd01e25c 100644 --- a/services/gitdiff/gitdiff.go +++ b/services/gitdiff/gitdiff.go @@ -1185,7 +1185,7 @@ func GetDiffForAPI(ctx context.Context, gitRepo *git.Repository, opts *DiffOptio return diff, err } -func GetDiffForRender(ctx context.Context, repoHomeLink string, gitRepo *git.Repository, opts *DiffOptions, files ...string) (*Diff, error) { +func GetDiffForRender(ctx context.Context, repoLink string, gitRepo *git.Repository, opts *DiffOptions, files ...string) (*Diff, error) { diff, beforeCommit, afterCommit, err := getDiffBasic(ctx, gitRepo, opts, files...) if err != nil { return nil, err @@ -1211,7 +1211,7 @@ func GetDiffForRender(ctx context.Context, repoHomeLink string, gitRepo *git.Rep // Populate Submodule URLs if diffFile.SubmoduleDiffInfo != nil { - diffFile.SubmoduleDiffInfo.PopulateURL(repoHomeLink, diffFile, beforeCommit, afterCommit) + diffFile.SubmoduleDiffInfo.PopulateURL(repoLink, diffFile, beforeCommit, afterCommit) } if !isVendored.Has() { diff --git a/services/gitdiff/submodule.go b/services/gitdiff/submodule.go index 0d50bcdda6..1bc83ebf63 100644 --- a/services/gitdiff/submodule.go +++ b/services/gitdiff/submodule.go @@ -14,15 +14,14 @@ import ( ) type SubmoduleDiffInfo struct { - RepoHomeLink string SubmoduleName string SubmoduleFile *git.CommitSubmoduleFile // it might be nil if the submodule is not found or unable to parse NewRefID string PreviousRefID string } -func (si *SubmoduleDiffInfo) PopulateURL(repoHomeLink string, diffFile *DiffFile, leftCommit, rightCommit *git.Commit) { - si.RepoHomeLink, si.SubmoduleName = repoHomeLink, diffFile.Name +func (si *SubmoduleDiffInfo) PopulateURL(repoLink string, diffFile *DiffFile, leftCommit, rightCommit *git.Commit) { + si.SubmoduleName = diffFile.Name submoduleCommit := rightCommit // If the submodule is added or updated, check at the right commit if diffFile.IsDeleted { submoduleCommit = leftCommit // If the submodule is deleted, check at the left commit @@ -38,12 +37,12 @@ func (si *SubmoduleDiffInfo) PopulateURL(repoHomeLink string, diffFile *DiffFile return // ignore the error, do not cause 500 errors for end users } if submodule != nil { - si.SubmoduleFile = git.NewCommitSubmoduleFile(submoduleFullPath, submodule.URL, submoduleCommit.ID.String()) + si.SubmoduleFile = git.NewCommitSubmoduleFile(repoLink, submoduleFullPath, submodule.URL, submoduleCommit.ID.String()) } } func (si *SubmoduleDiffInfo) CommitRefIDLinkHTML(ctx context.Context, commitID string) template.HTML { - webLink := si.SubmoduleFile.SubmoduleWebLinkTree(ctx, si.RepoHomeLink, commitID) + webLink := si.SubmoduleFile.SubmoduleWebLinkTree(ctx, commitID) if webLink == nil { return htmlutil.HTMLFormat("%s", base.ShortSha(commitID)) } @@ -51,7 +50,7 @@ func (si *SubmoduleDiffInfo) CommitRefIDLinkHTML(ctx context.Context, commitID s } func (si *SubmoduleDiffInfo) CompareRefIDLinkHTML(ctx context.Context) template.HTML { - webLink := si.SubmoduleFile.SubmoduleWebLinkCompare(ctx, si.RepoHomeLink, si.PreviousRefID, si.NewRefID) + webLink := si.SubmoduleFile.SubmoduleWebLinkCompare(ctx, si.PreviousRefID, si.NewRefID) if webLink == nil { return htmlutil.HTMLFormat("%s...%s", base.ShortSha(si.PreviousRefID), base.ShortSha(si.NewRefID)) } @@ -59,7 +58,7 @@ func (si *SubmoduleDiffInfo) CompareRefIDLinkHTML(ctx context.Context) template. } func (si *SubmoduleDiffInfo) SubmoduleRepoLinkHTML(ctx context.Context) template.HTML { - webLink := si.SubmoduleFile.SubmoduleWebLinkTree(ctx, si.RepoHomeLink, si.SubmoduleFile.RefID()) + webLink := si.SubmoduleFile.SubmoduleWebLinkTree(ctx, si.SubmoduleFile.RefID()) if webLink == nil { return htmlutil.HTMLFormat("%s", si.SubmoduleName) } diff --git a/services/gitdiff/submodule_test.go b/services/gitdiff/submodule_test.go index d689a9dbd9..c793969f0e 100644 --- a/services/gitdiff/submodule_test.go +++ b/services/gitdiff/submodule_test.go @@ -227,7 +227,7 @@ func TestSubmoduleInfo(t *testing.T) { assert.EqualValues(t, "aaaa...bbbb", sdi.CompareRefIDLinkHTML(ctx)) assert.EqualValues(t, "name", sdi.SubmoduleRepoLinkHTML(ctx)) - sdi.SubmoduleFile = git.NewCommitSubmoduleFile("fullpath", "https://github.com/owner/repo", "1234") + sdi.SubmoduleFile = git.NewCommitSubmoduleFile("/any/repo-link", "fullpath", "https://github.com/owner/repo", "1234") assert.EqualValues(t, `1111`, sdi.CommitRefIDLinkHTML(ctx, "1111")) assert.EqualValues(t, `aaaa...bbbb`, sdi.CompareRefIDLinkHTML(ctx)) assert.EqualValues(t, `name`, sdi.SubmoduleRepoLinkHTML(ctx)) diff --git a/services/repository/files/tree.go b/services/repository/files/tree.go index 78f3324afe..f8f77c6735 100644 --- a/services/repository/files/tree.go +++ b/services/repository/files/tree.go @@ -154,7 +154,7 @@ func (node *TreeViewNode) sortLevel() int { return util.Iif(node.EntryMode == "tree" || node.EntryMode == "commit", 0, 1) } -func newTreeViewNodeFromEntry(ctx context.Context, repoHomeLink string, renderedIconPool *fileicon.RenderedIconPool, commit *git.Commit, parentDir string, entry *git.TreeEntry) *TreeViewNode { +func newTreeViewNodeFromEntry(ctx context.Context, repoLink string, renderedIconPool *fileicon.RenderedIconPool, commit *git.Commit, parentDir string, entry *git.TreeEntry) *TreeViewNode { node := &TreeViewNode{ EntryName: entry.Name(), EntryMode: entryModeString(entry.Mode()), @@ -172,8 +172,8 @@ func newTreeViewNodeFromEntry(ctx context.Context, repoHomeLink string, rendered if subModule, err := commit.GetSubModule(node.FullPath); err != nil { log.Error("GetSubModule: %v", err) } else if subModule != nil { - submoduleFile := git.NewCommitSubmoduleFile(node.FullPath, subModule.URL, entry.ID.String()) - webLink := submoduleFile.SubmoduleWebLinkTree(ctx, repoHomeLink, submoduleFile.RefID()) + submoduleFile := git.NewCommitSubmoduleFile(repoLink, node.FullPath, subModule.URL, entry.ID.String()) + webLink := submoduleFile.SubmoduleWebLinkTree(ctx, submoduleFile.RefID()) node.SubmoduleURL = webLink.CommitWebLink } } @@ -192,7 +192,7 @@ func sortTreeViewNodes(nodes []*TreeViewNode) { }) } -func listTreeNodes(ctx context.Context, repoHomeLink string, renderedIconPool *fileicon.RenderedIconPool, commit *git.Commit, tree *git.Tree, treePath, subPath string) ([]*TreeViewNode, error) { +func listTreeNodes(ctx context.Context, repoLink string, renderedIconPool *fileicon.RenderedIconPool, commit *git.Commit, tree *git.Tree, treePath, subPath string) ([]*TreeViewNode, error) { entries, err := tree.ListEntries() if err != nil { return nil, err @@ -201,14 +201,14 @@ func listTreeNodes(ctx context.Context, repoHomeLink string, renderedIconPool *f subPathDirName, subPathRemaining, _ := strings.Cut(subPath, "/") nodes := make([]*TreeViewNode, 0, len(entries)) for _, entry := range entries { - node := newTreeViewNodeFromEntry(ctx, repoHomeLink, renderedIconPool, commit, treePath, entry) + node := newTreeViewNodeFromEntry(ctx, repoLink, renderedIconPool, commit, treePath, entry) nodes = append(nodes, node) if entry.IsDir() && subPathDirName == entry.Name() { subTreePath := treePath + "/" + node.EntryName if subTreePath[0] == '/' { subTreePath = subTreePath[1:] } - subNodes, err := listTreeNodes(ctx, repoHomeLink, renderedIconPool, commit, entry.Tree(), subTreePath, subPathRemaining) + subNodes, err := listTreeNodes(ctx, repoLink, renderedIconPool, commit, entry.Tree(), subTreePath, subPathRemaining) if err != nil { log.Error("listTreeNodes: %v", err) } else { @@ -220,10 +220,10 @@ func listTreeNodes(ctx context.Context, repoHomeLink string, renderedIconPool *f return nodes, nil } -func GetTreeViewNodes(ctx context.Context, repoHomeLink string, renderedIconPool *fileicon.RenderedIconPool, commit *git.Commit, treePath, subPath string) ([]*TreeViewNode, error) { +func GetTreeViewNodes(ctx context.Context, repoLink string, renderedIconPool *fileicon.RenderedIconPool, commit *git.Commit, treePath, subPath string) ([]*TreeViewNode, error) { entry, err := commit.GetTreeEntryByPath(treePath) if err != nil { return nil, err } - return listTreeNodes(ctx, repoHomeLink, renderedIconPool, commit, entry.Tree(), treePath, subPath) + return listTreeNodes(ctx, repoLink, renderedIconPool, commit, entry.Tree(), treePath, subPath) } diff --git a/services/repository/files/tree_test.go b/services/repository/files/tree_test.go index f15aa47d4a..38ac9f25fc 100644 --- a/services/repository/files/tree_test.go +++ b/services/repository/files/tree_test.go @@ -64,7 +64,7 @@ func TestGetTreeViewNodes(t *testing.T) { contexttest.LoadGitRepo(t, ctx) defer ctx.Repo.GitRepo.Close() - curRepoLink := "/any/repo-home-link" + curRepoLink := "/any/repo-link" renderedIconPool := fileicon.NewRenderedIconPool() mockIconForFile := func(id string) template.HTML { return template.HTML(``) diff --git a/templates/repo/view_list.tmpl b/templates/repo/view_list.tmpl index 97e3f98673..6fe1ae134b 100644 --- a/templates/repo/view_list.tmpl +++ b/templates/repo/view_list.tmpl @@ -18,7 +18,7 @@
{{index $.FileIcons $entry.Name}} {{if $entry.IsSubModule}} - {{$submoduleLink := $submoduleFile.SubmoduleWebLinkTree ctx $.RepoLink $submoduleFile.RefID}} + {{$submoduleLink := $submoduleFile.SubmoduleWebLinkTree ctx $submoduleFile.RefID}} {{if $submoduleLink}} {{$entry.Name}} @ {{ShortSha $submoduleFile.RefID}}