From a98e085031bedb53a9776031afde7073af81feaf Mon Sep 17 00:00:00 2001 From: Vladimir Panteleev Date: Fri, 24 May 2019 10:52:05 +0300 Subject: [PATCH] Show git-notes (#6984) * Show git-notes * Make git-notes heading text localizable * Refactor git-notes data fetching to a separate function * Display the author and time of git notes * Move note bubble inside the commit bubble * Revert "Move note bubble inside the commit bubble" This reverts commit c0951fe0e3b4dea38064515546b1825c1bcf19e1. * Add test for git-notes * testing ui * Polish CSS * Apply suggestions from code review Co-Authored-By: Lauris BH --- modules/git/notes.go | 60 ++++++++++++++++++ modules/git/notes_test.go | 24 +++++++ modules/git/repo_ref_test.go | 3 +- .../28/345b214c5967bd9cdd98cc7f88f2f1ac574e02 | Bin 0 -> 85 bytes .../a4/79ead1abb694ffca26f67b09c8313b12fa2a13 | Bin 0 -> 30 bytes .../ca/6b5ddf303169a72d2a2971acde4f6eea194e5c | 4 ++ .../tests/repos/repo1_bare/refs/notes/commits | 1 + modules/templates/helper.go | 12 ++++ options/locale/locale_en-US.ini | 1 + public/css/index.css | 2 + public/less/_repository.less | 9 +++ routers/repo/commit.go | 10 +++ templates/repo/diff/page.tmpl | 21 ++++++ 13 files changed, 146 insertions(+), 1 deletion(-) create mode 100644 modules/git/notes.go create mode 100644 modules/git/notes_test.go create mode 100644 modules/git/tests/repos/repo1_bare/objects/28/345b214c5967bd9cdd98cc7f88f2f1ac574e02 create mode 100644 modules/git/tests/repos/repo1_bare/objects/a4/79ead1abb694ffca26f67b09c8313b12fa2a13 create mode 100644 modules/git/tests/repos/repo1_bare/objects/ca/6b5ddf303169a72d2a2971acde4f6eea194e5c create mode 100644 modules/git/tests/repos/repo1_bare/refs/notes/commits diff --git a/modules/git/notes.go b/modules/git/notes.go new file mode 100644 index 000000000..7aa5d89a7 --- /dev/null +++ b/modules/git/notes.go @@ -0,0 +1,60 @@ +// Copyright 2019 The Gitea Authors. All rights reserved. +// Use of this source code is governed by a MIT-style +// license that can be found in the LICENSE file. + +package git + +import ( + "io/ioutil" + + "gopkg.in/src-d/go-git.v4/plumbing" +) + +// NotesRef is the git ref where Gitea will look for git-notes data. +// The value ("refs/notes/commits") is the default ref used by git-notes. +const NotesRef = "refs/notes/commits" + +// Note stores information about a note created using git-notes. +type Note struct { + Message []byte + Commit *Commit +} + +// GetNote retrieves the git-notes data for a given commit. +func GetNote(repo *Repository, commitID string, note *Note) error { + notes, err := repo.GetCommit(NotesRef) + if err != nil { + return err + } + + entry, err := notes.GetTreeEntryByPath(commitID) + if err != nil { + return err + } + + blob := entry.Blob() + dataRc, err := blob.DataAsync() + if err != nil { + return err + } + + defer dataRc.Close() + d, err := ioutil.ReadAll(dataRc) + if err != nil { + return err + } + note.Message = d + + commit, err := repo.gogitRepo.CommitObject(plumbing.Hash(notes.ID)) + if err != nil { + return err + } + + lastCommits, err := getLastCommitForPaths(commit, "", []string{commitID}) + if err != nil { + return err + } + note.Commit = convertCommit(lastCommits[commitID]) + + return nil +} diff --git a/modules/git/notes_test.go b/modules/git/notes_test.go new file mode 100644 index 000000000..a954377f5 --- /dev/null +++ b/modules/git/notes_test.go @@ -0,0 +1,24 @@ +// Copyright 2019 The Gitea Authors. All rights reserved. +// Use of this source code is governed by a MIT-style +// license that can be found in the LICENSE file. + +package git + +import ( + "path/filepath" + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestGetNotes(t *testing.T) { + bareRepo1Path := filepath.Join(testReposDir, "repo1_bare") + bareRepo1, err := OpenRepository(bareRepo1Path) + assert.NoError(t, err) + + note := Note{} + err = GetNote(bareRepo1, "95bb4d39648ee7e325106df01a621c530863a653", ¬e) + assert.NoError(t, err) + assert.Equal(t, []byte("Note contents\n"), note.Message) + assert.Equal(t, "Vladimir Panteleev", note.Commit.Author.Name) +} diff --git a/modules/git/repo_ref_test.go b/modules/git/repo_ref_test.go index 2a3ea26a7..d32b34994 100644 --- a/modules/git/repo_ref_test.go +++ b/modules/git/repo_ref_test.go @@ -19,13 +19,14 @@ func TestRepository_GetRefs(t *testing.T) { refs, err := bareRepo1.GetRefs() assert.NoError(t, err) - assert.Len(t, refs, 4) + assert.Len(t, refs, 5) expectedRefs := []string{ BranchPrefix + "branch1", BranchPrefix + "branch2", BranchPrefix + "master", TagPrefix + "test", + NotesRef, } for _, ref := range refs { diff --git a/modules/git/tests/repos/repo1_bare/objects/28/345b214c5967bd9cdd98cc7f88f2f1ac574e02 b/modules/git/tests/repos/repo1_bare/objects/28/345b214c5967bd9cdd98cc7f88f2f1ac574e02 new file mode 100644 index 0000000000000000000000000000000000000000..05dc4725eaa5c817fd8af3f6c047b4dc9bad3216 GIT binary patch literal 85 zcmV-b0IL6Z0V^p=O;s?nU@$Z=Ff%bxury6dGD$JEG&8YCO*Kz7HZnCdFiS}@FibQv rGE6o#Hn1==PBb$$W>`}B>f-8cQ~sY)`&P|)!q8gimzFR9EFKteb^{)W literal 0 HcmV?d00001 diff --git a/modules/git/tests/repos/repo1_bare/objects/a4/79ead1abb694ffca26f67b09c8313b12fa2a13 b/modules/git/tests/repos/repo1_bare/objects/a4/79ead1abb694ffca26f67b09c8313b12fa2a13 new file mode 100644 index 0000000000000000000000000000000000000000..35d27dcbe7a6557b8143cd5f57ee6851674b3743 GIT binary patch literal 30 mcmb= 1 diff --git a/options/locale/locale_en-US.ini b/options/locale/locale_en-US.ini index f08bc6b5a..d2079415d 100644 --- a/options/locale/locale_en-US.ini +++ b/options/locale/locale_en-US.ini @@ -1314,6 +1314,7 @@ settings.unarchive.error = An error occured while trying to un-archive the repo. diff.browse_source = Browse Source diff.parent = parent diff.commit = commit +diff.git-notes = Notes diff.data_not_available = Diff Content Not Available diff.show_diff_stats = Show Diff Stats diff.show_split_view = Split View diff --git a/public/css/index.css b/public/css/index.css index fa449ec69..8cea4e2c1 100644 --- a/public/css/index.css +++ b/public/css/index.css @@ -803,6 +803,8 @@ footer .ui.left,footer .ui.right{line-height:40px} .stats-table .table-cell.tiny{height:.5em} tbody.commit-list{vertical-align:baseline} .commit-body{white-space:pre-wrap} +.git-notes.top{text-align:left} +.git-notes .commit-body{margin:0} @media only screen and (max-width:767px){.ui.stackable.menu.mobile--margin-between-items>.item{margin-top:5px;margin-bottom:5px} .ui.stackable.menu.mobile--no-negative-margins{margin-left:0;margin-right:0} } diff --git a/public/less/_repository.less b/public/less/_repository.less index 5970b366e..9956bbce7 100644 --- a/public/less/_repository.less +++ b/public/less/_repository.less @@ -2219,6 +2219,15 @@ tbody.commit-list { white-space: pre-wrap; } +.git-notes { + &.top { + text-align: left; + } + .commit-body { + margin: 0; + } +} + @media only screen and (max-width: 767px) { .ui.stackable.menu { &.mobile--margin-between-items > .item { diff --git a/routers/repo/commit.go b/routers/repo/commit.go index 2978eda6c..870ff568f 100644 --- a/routers/repo/commit.go +++ b/routers/repo/commit.go @@ -15,6 +15,7 @@ import ( "code.gitea.io/gitea/modules/git" "code.gitea.io/gitea/modules/log" "code.gitea.io/gitea/modules/setting" + "code.gitea.io/gitea/modules/templates" ) const ( @@ -246,6 +247,15 @@ func Diff(ctx *context.Context) { ctx.Data["Parents"] = parents ctx.Data["DiffNotAvailable"] = diff.NumFiles() == 0 ctx.Data["SourcePath"] = setting.AppSubURL + "/" + path.Join(userName, repoName, "src", "commit", commitID) + + note := &git.Note{} + err = git.GetNote(ctx.Repo.GitRepo, commitID, note) + if err == nil { + ctx.Data["Note"] = string(templates.ToUTF8WithFallback(note.Message)) + ctx.Data["NoteCommit"] = note.Commit + ctx.Data["NoteAuthor"] = models.ValidateCommitWithEmail(note.Commit) + } + if commit.ParentCount() > 0 { ctx.Data["BeforeSourcePath"] = setting.AppSubURL + "/" + path.Join(userName, repoName, "src", "commit", parents[0]) } diff --git a/templates/repo/diff/page.tmpl b/templates/repo/diff/page.tmpl index c8f5a3d9f..c35e2a415 100644 --- a/templates/repo/diff/page.tmpl +++ b/templates/repo/diff/page.tmpl @@ -65,6 +65,27 @@ {{end}} {{end}} + {{if .Note}} +
+ + {{.i18n.Tr "repo.diff.git-notes"}}: + {{if .NoteAuthor}} + + {{if .NoteAuthor.FullName}} + {{.NoteAuthor.FullName}} + {{else}} + {{.NoteCommit.Author.Name}} + {{end}} + + {{else}} + {{.NoteCommit.Author.Name}} + {{end}} + {{TimeSince .NoteCommit.Author.When $.Lang}} +
+
+ 
{{RenderNote .Note $.RepoLink $.Repository.ComposeMetas}}
+
+ {{end}} {{end}} {{template "repo/diff/box" .}}