From 0c4716b047bff067566ecbd5100a0ed971a8796b Mon Sep 17 00:00:00 2001 From: 0ko <0ko@noreply.codeberg.org> Date: Mon, 24 Jun 2024 20:18:27 +0500 Subject: [PATCH] Clarify author label in tooltip --- options/locale/locale_en-US.ini | 3 +- release-notes/8.0.0/4201.md | 1 + templates/repo/issue/view_content.tmpl | 2 +- .../repo/issue/view_content/comments.tmpl | 4 +- .../repo/issue/view_content/conversation.tmpl | 2 +- .../repo/issue/view_content/show_role.tmpl | 7 +- .../integration/issues_comment_labels_test.go | 143 ++++++++++++++++++ 7 files changed, 156 insertions(+), 6 deletions(-) create mode 100644 release-notes/8.0.0/4201.md create mode 100644 tests/integration/issues_comment_labels_test.go diff --git a/options/locale/locale_en-US.ini b/options/locale/locale_en-US.ini index b89ab0827..af8a95b22 100644 --- a/options/locale/locale_en-US.ini +++ b/options/locale/locale_en-US.ini @@ -1612,7 +1612,8 @@ issues.ref_closed_from = `closed this issue %[4]s reopened this issue %[4]s %[2]s` 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 diff --git a/release-notes/8.0.0/4201.md b/release-notes/8.0.0/4201.md new file mode 100644 index 000000000..ea2797f32 --- /dev/null +++ b/release-notes/8.0.0/4201.md @@ -0,0 +1 @@ +Make tooltip of Author label in comments more clear diff --git a/templates/repo/issue/view_content.tmpl b/templates/repo/issue/view_content.tmpl index 9db480bca..543191e02 100644 --- a/templates/repo/issue/view_content.tmpl +++ b/templates/repo/issue/view_content.tmpl @@ -44,7 +44,7 @@ {{end}}
- {{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}} diff --git a/templates/repo/issue/view_content/comments.tmpl b/templates/repo/issue/view_content/comments.tmpl index 5aeb0ff94..6d14d7264 100644 --- a/templates/repo/issue/view_content/comments.tmpl +++ b/templates/repo/issue/view_content/comments.tmpl @@ -51,7 +51,7 @@ {{end}}
- {{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 @@
- {{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))}} diff --git a/templates/repo/issue/view_content/conversation.tmpl b/templates/repo/issue/view_content/conversation.tmpl index 948135260..8e37b5487 100644 --- a/templates/repo/issue/view_content/conversation.tmpl +++ b/templates/repo/issue/view_content/conversation.tmpl @@ -77,7 +77,7 @@
- {{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))}} diff --git a/templates/repo/issue/view_content/show_role.tmpl b/templates/repo/issue/view_content/show_role.tmpl index 40c8b67fa..0f1b89550 100644 --- a/templates/repo/issue/view_content/show_role.tmpl +++ b/templates/repo/issue/view_content/show_role.tmpl @@ -1,5 +1,10 @@ {{if and .ShowRole.IsPoster (not .IgnorePoster)}} -
+
{{ctx.Locale.Tr "repo.issues.author"}}
{{end}} diff --git a/tests/integration/issues_comment_labels_test.go b/tests/integration/issues_comment_labels_test.go new file mode 100644 index 000000000..b122219d8 --- /dev/null +++ b/tests/integration/issues_comment_labels_test.go @@ -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) +}