Merge pull request 'Clarify author label in tooltip' (#4201) from 0ko/forgejo:ui-author-tooltip into forgejo
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/4201 Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
This commit is contained in:
commit
282dfa1bea
@ -1618,7 +1618,8 @@ issues.ref_closed_from = `<a href="%[3]s">closed this issue %[4]s</a> <a id="%[1
|
||||
issues.ref_reopened_from = `<a href="%[3]s">reopened this issue %[4]s</a> <a id="%[1]s" href="#%[1]s">%[2]s</a>`
|
||||
issues.ref_from = `from %[1]s`
|
||||
issues.author = Author
|
||||
issues.author_helper = This user is the author.
|
||||
issues.author.tooltip.issue = This user is the author of this issue.
|
||||
issues.author.tooltip.pr = This user is the author of this pull request.
|
||||
issues.role.owner = Owner
|
||||
issues.role.owner_helper = This user is the owner of this repository.
|
||||
issues.role.member = Member
|
||||
|
1
release-notes/8.0.0/4201.md
Normal file
1
release-notes/8.0.0/4201.md
Normal file
@ -0,0 +1 @@
|
||||
Make tooltip of Author label in comments more clear
|
@ -44,7 +44,7 @@
|
||||
{{end}}
|
||||
</div>
|
||||
<div class="comment-header-right actions tw-flex tw-items-center">
|
||||
{{template "repo/issue/view_content/show_role" dict "ShowRole" .Issue.ShowRole "IgnorePoster" true}}
|
||||
{{template "repo/issue/view_content/show_role" dict "ShowRole" .Issue.ShowRole "IgnorePoster" true "IsPull" .Issue.IsPull}}
|
||||
{{if not $.Repository.IsArchived}}
|
||||
{{template "repo/issue/view_content/add_reaction" dict "ctxData" $ "ActionURL" (printf "%s/issues/%d/reactions" $.RepoLink .Issue.Index)}}
|
||||
{{end}}
|
||||
|
@ -51,7 +51,7 @@
|
||||
{{end}}
|
||||
</div>
|
||||
<div class="comment-header-right actions tw-flex tw-items-center">
|
||||
{{template "repo/issue/view_content/show_role" dict "ShowRole" .ShowRole}}
|
||||
{{template "repo/issue/view_content/show_role" dict "ShowRole" .ShowRole "IsPull" .Issue.IsPull}}
|
||||
{{if not $.Repository.IsArchived}}
|
||||
{{template "repo/issue/view_content/add_reaction" dict "ctxData" $ "ActionURL" (printf "%s/comments/%d/reactions" $.RepoLink .ID)}}
|
||||
{{end}}
|
||||
@ -425,7 +425,7 @@
|
||||
</span>
|
||||
</div>
|
||||
<div class="comment-header-right actions tw-flex tw-items-center">
|
||||
{{template "repo/issue/view_content/show_role" dict "ShowRole" .ShowRole}}
|
||||
{{template "repo/issue/view_content/show_role" dict "ShowRole" .ShowRole "IsPull" .Issue.IsPull}}
|
||||
{{if not $.Repository.IsArchived}}
|
||||
{{template "repo/issue/view_content/add_reaction" dict "ctxData" $ "ActionURL" (printf "%s/comments/%d/reactions" $.RepoLink .ID)}}
|
||||
{{template "repo/issue/view_content/context_menu" dict "ctxData" $ "item" . "delete" false "issue" true "diff" false "IsCommentPoster" (and $.IsSigned (eq $.SignedUserID .PosterID))}}
|
||||
|
@ -77,7 +77,7 @@
|
||||
</span>
|
||||
</div>
|
||||
<div class="comment-header-right actions tw-flex tw-items-center">
|
||||
{{template "repo/issue/view_content/show_role" dict "ShowRole" .ShowRole}}
|
||||
{{template "repo/issue/view_content/show_role" dict "ShowRole" .ShowRole "IsPull" .Issue.IsPull}}
|
||||
{{if not $.Repository.IsArchived}}
|
||||
{{template "repo/issue/view_content/add_reaction" dict "ctxData" $ "ActionURL" (printf "%s/comments/%d/reactions" $.RepoLink .ID)}}
|
||||
{{template "repo/issue/view_content/context_menu" dict "ctxData" $ "item" . "delete" true "issue" true "diff" true "IsCommentPoster" (and $.IsSigned (eq $.SignedUserID .PosterID))}}
|
||||
|
@ -1,5 +1,10 @@
|
||||
{{if and .ShowRole.IsPoster (not .IgnorePoster)}}
|
||||
<div class="ui basic label role-label" data-tooltip-content="{{ctx.Locale.Tr "repo.issues.author_helper"}}">
|
||||
<div class="ui basic label role-label" data-tooltip-content="
|
||||
{{if .IsPull}}
|
||||
{{ctx.Locale.Tr "repo.issues.author.tooltip.pr"}}
|
||||
{{else}}
|
||||
{{ctx.Locale.Tr "repo.issues.author.tooltip.issue"}}
|
||||
{{end}}">
|
||||
{{ctx.Locale.Tr "repo.issues.author"}}
|
||||
</div>
|
||||
{{end}}
|
||||
|
143
tests/integration/issues_comment_labels_test.go
Normal file
143
tests/integration/issues_comment_labels_test.go
Normal file
@ -0,0 +1,143 @@
|
||||
// Copyright 2024 The Forgejo Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package integration
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"net/url"
|
||||
"path"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/PuerkitoBio/goquery"
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
// TestIssuesCommentLabels is a test for user (role) labels in comment headers in PRs and issues.
|
||||
// It covers a few labels and combinations.
|
||||
func TestIssuesCommentLabels(t *testing.T) {
|
||||
onGiteaRun(t, func(t *testing.T, giteaURL *url.URL) {
|
||||
user := "user2"
|
||||
repo := "repo1"
|
||||
compareLink := path.Join(user, repo, "compare", "master...comment-labels")
|
||||
sessionUser1 := loginUser(t, "user1")
|
||||
sessionUser2 := loginUser(t, "user2")
|
||||
sessionUser5 := loginUser(t, "user5")
|
||||
|
||||
ownerTooltip := "This user is the owner of this repository."
|
||||
authorTooltipPR := "This user is the author of this pull request."
|
||||
authorTooltipIssue := "This user is the author of this issue."
|
||||
firstTooltip := "This is the first contribution of this user to the repository."
|
||||
|
||||
// Open a new PR as user2
|
||||
testEditFileToNewBranch(t, sessionUser2, user, repo, "master", "comment-labels", "README.md", "test of comment labels")
|
||||
sessionUser2.MakeRequest(t, NewRequestWithValues(t, "POST", compareLink,
|
||||
map[string]string{
|
||||
"_csrf": GetCSRF(t, sessionUser2, compareLink),
|
||||
"title": "Pull used for testing commit labels",
|
||||
},
|
||||
), http.StatusOK)
|
||||
|
||||
// Pull number, expected to be 6
|
||||
testID := "6"
|
||||
// Add a few comments
|
||||
// (first: Owner)
|
||||
testEasyLeavePRComment(t, sessionUser2, user, repo, testID, "New comment from user2 on this PR") // Author, Owner
|
||||
testEasyLeavePRComment(t, sessionUser1, user, repo, testID, "New comment from user1 on this PR") // First-time contributor
|
||||
testEasyLeavePRComment(t, sessionUser5, user, repo, testID, "New comment from user5 on this PR") // no labels
|
||||
|
||||
// Fetch the PR page
|
||||
response := sessionUser2.MakeRequest(t, NewRequest(t, "GET", path.Join(user, repo, "pulls", testID)), http.StatusOK)
|
||||
page := NewHTMLParser(t, response.Body)
|
||||
commentHeads := page.Find(".timeline .comment .comment-header .comment-header-right")
|
||||
assert.EqualValues(t, 4, commentHeads.Length())
|
||||
|
||||
// Test the first comment and it's label "Owner"
|
||||
labels := commentHeads.Eq(0).Find(".role-label")
|
||||
assert.EqualValues(t, 1, labels.Length())
|
||||
testIssueCommentUserLabel(t, labels.Eq(0), "Owner", ownerTooltip)
|
||||
|
||||
// Test the second comment and it's labels "Author" and "Owner"
|
||||
labels = commentHeads.Eq(1).Find(".role-label")
|
||||
assert.EqualValues(t, 2, labels.Length())
|
||||
testIssueCommentUserLabel(t, labels.Eq(0), "Author", authorTooltipPR)
|
||||
testIssueCommentUserLabel(t, labels.Eq(1), "Owner", ownerTooltip)
|
||||
|
||||
// Test the third comment and it's label "First-time contributor"
|
||||
labels = commentHeads.Eq(3).Find(".role-label")
|
||||
assert.EqualValues(t, 1, labels.Length())
|
||||
testIssueCommentUserLabel(t, labels.Eq(0), "First-time contributor", firstTooltip)
|
||||
|
||||
// Test the fourth comment and it's lack of labels
|
||||
labels = commentHeads.Eq(4).Find(".role-label")
|
||||
assert.EqualValues(t, 0, labels.Length())
|
||||
|
||||
// Open a new issue in the same repo
|
||||
sessionUser2.MakeRequest(t, NewRequestWithValues(t, "POST", path.Join(user, repo, "issues/new"),
|
||||
map[string]string{
|
||||
"_csrf": GetCSRF(t, sessionUser2, compareLink),
|
||||
"title": "Issue used for testing commit labels",
|
||||
},
|
||||
), http.StatusOK)
|
||||
|
||||
// Issue number, expected to be 7 after the PR
|
||||
testID = "7"
|
||||
// Add a few comments
|
||||
// (first: Owner)
|
||||
testEasyLeaveIssueComment(t, sessionUser2, user, repo, testID, "New comment from user2 on this issue") // Author, Owner
|
||||
testEasyLeaveIssueComment(t, sessionUser5, user, repo, testID, "New comment from user5 on this issue") // no labels
|
||||
|
||||
// Fetch the issue page
|
||||
response = sessionUser2.MakeRequest(t, NewRequest(t, "GET", path.Join(user, repo, "issues", testID)), http.StatusOK)
|
||||
page = NewHTMLParser(t, response.Body)
|
||||
commentHeads = page.Find(".timeline .comment .comment-header .comment-header-right")
|
||||
assert.EqualValues(t, 3, commentHeads.Length())
|
||||
|
||||
// Test the first comment and it's label "Owner"
|
||||
labels = commentHeads.Eq(0).Find(".role-label")
|
||||
assert.EqualValues(t, 1, labels.Length())
|
||||
testIssueCommentUserLabel(t, labels.Eq(0), "Owner", ownerTooltip)
|
||||
|
||||
// Test the second comment and it's labels "Author" and "Owner"
|
||||
labels = commentHeads.Eq(1).Find(".role-label")
|
||||
assert.EqualValues(t, 2, labels.Length())
|
||||
testIssueCommentUserLabel(t, labels.Eq(0), "Author", authorTooltipIssue)
|
||||
testIssueCommentUserLabel(t, labels.Eq(1), "Owner", ownerTooltip)
|
||||
|
||||
// Test the third comment and it's lack of labels
|
||||
labels = commentHeads.Eq(3).Find(".role-label")
|
||||
assert.EqualValues(t, 0, labels.Length())
|
||||
})
|
||||
}
|
||||
|
||||
// testIssueCommentUserLabel is used to verify properties of a user label from a comment
|
||||
func testIssueCommentUserLabel(t *testing.T, label *goquery.Selection, expectedTitle, expectedTooltip string) {
|
||||
t.Helper()
|
||||
title := label.Text()
|
||||
tooltip, exists := label.Attr("data-tooltip-content")
|
||||
assert.True(t, exists)
|
||||
assert.EqualValues(t, expectedTitle, strings.TrimSpace(title))
|
||||
assert.EqualValues(t, expectedTooltip, strings.TrimSpace(tooltip))
|
||||
}
|
||||
|
||||
// testEasyLeaveIssueComment is used to create a comment on an issue with minimum code and parameters
|
||||
func testEasyLeaveIssueComment(t *testing.T, session *TestSession, user, repo, id, message string) {
|
||||
t.Helper()
|
||||
session.MakeRequest(t, NewRequestWithValues(t, "POST", path.Join(user, repo, "issues", id, "comments"), map[string]string{
|
||||
"_csrf": GetCSRF(t, session, path.Join(user, repo, "issues", id)),
|
||||
"content": message,
|
||||
"status": "",
|
||||
}), 200)
|
||||
}
|
||||
|
||||
// testEasyLeaveIssueComment is used to create a comment on a pull request with minimum code and parameters
|
||||
// The POST request is supposed to use "issues" in the path. The CSRF is supposed to be generated for the PR page.
|
||||
func testEasyLeavePRComment(t *testing.T, session *TestSession, user, repo, id, message string) {
|
||||
t.Helper()
|
||||
session.MakeRequest(t, NewRequestWithValues(t, "POST", path.Join(user, repo, "issues", id, "comments"), map[string]string{
|
||||
"_csrf": GetCSRF(t, session, path.Join(user, repo, "pulls", id)),
|
||||
"content": message,
|
||||
"status": "",
|
||||
}), 200)
|
||||
}
|
Loading…
Reference in New Issue
Block a user