Fix bug when combine label comments (#14894)

* Fix bug when combine label comments

* Added some code comments

* More comments
This commit is contained in:
Lunny Xiao 2021-03-05 23:17:32 +08:00 committed by GitHub
parent 144cfe5720
commit 9db590f2ee
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 97 additions and 17 deletions

View file

@ -2481,12 +2481,11 @@ func attachmentsHTML(ctx *context.Context, attachments []*models.Attachment, con
return attachHTML return attachHTML
} }
// combineLabelComments combine the nearby label comments as one.
func combineLabelComments(issue *models.Issue) { func combineLabelComments(issue *models.Issue) {
var prev, cur *models.Comment
for i := 0; i < len(issue.Comments); i++ { for i := 0; i < len(issue.Comments); i++ {
var (
prev *models.Comment
cur = issue.Comments[i] cur = issue.Comments[i]
)
if i > 0 { if i > 0 {
prev = issue.Comments[i-1] prev = issue.Comments[i-1]
} }
@ -2503,16 +2502,25 @@ func combineLabelComments(issue *models.Issue) {
continue continue
} }
if cur.Label != nil { if cur.Label != nil { // now cur MUST be label comment
if prev.Type == models.CommentTypeLabel { // we can combine them only prev is a label comment
if cur.Content != "1" { if cur.Content != "1" {
prev.RemovedLabels = append(prev.RemovedLabels, cur.Label) prev.RemovedLabels = append(prev.RemovedLabels, cur.Label)
} else { } else {
prev.AddedLabels = append(prev.AddedLabels, cur.Label) prev.AddedLabels = append(prev.AddedLabels, cur.Label)
} }
}
prev.CreatedUnix = cur.CreatedUnix prev.CreatedUnix = cur.CreatedUnix
// remove the current comment since it has been combined to prev comment
issue.Comments = append(issue.Comments[:i], issue.Comments[i+1:]...) issue.Comments = append(issue.Comments[:i], issue.Comments[i+1:]...)
i-- i--
} else { // if prev is not a label comment, start a new group
if cur.Content != "1" {
cur.RemovedLabels = append(cur.RemovedLabels, cur.Label)
} else {
cur.AddedLabels = append(cur.AddedLabels, cur.Label)
}
}
}
} }
} }

View file

@ -13,10 +13,12 @@ import (
func TestCombineLabelComments(t *testing.T) { func TestCombineLabelComments(t *testing.T) {
var kases = []struct { var kases = []struct {
name string
beforeCombined []*models.Comment beforeCombined []*models.Comment
afterCombined []*models.Comment afterCombined []*models.Comment
}{ }{
{ {
name: "kase 1",
beforeCombined: []*models.Comment{ beforeCombined: []*models.Comment{
{ {
Type: models.CommentTypeLabel, Type: models.CommentTypeLabel,
@ -72,6 +74,7 @@ func TestCombineLabelComments(t *testing.T) {
}, },
}, },
{ {
name: "kase 2",
beforeCombined: []*models.Comment{ beforeCombined: []*models.Comment{
{ {
Type: models.CommentTypeLabel, Type: models.CommentTypeLabel,
@ -136,6 +139,7 @@ func TestCombineLabelComments(t *testing.T) {
}, },
}, },
{ {
name: "kase 3",
beforeCombined: []*models.Comment{ beforeCombined: []*models.Comment{
{ {
Type: models.CommentTypeLabel, Type: models.CommentTypeLabel,
@ -200,6 +204,7 @@ func TestCombineLabelComments(t *testing.T) {
}, },
}, },
{ {
name: "kase 4",
beforeCombined: []*models.Comment{ beforeCombined: []*models.Comment{
{ {
Type: models.CommentTypeLabel, Type: models.CommentTypeLabel,
@ -240,13 +245,80 @@ func TestCombineLabelComments(t *testing.T) {
}, },
}, },
}, },
{
name: "kase 5",
beforeCombined: []*models.Comment{
{
Type: models.CommentTypeLabel,
PosterID: 1,
Content: "1",
Label: &models.Label{
Name: "kind/bug",
},
CreatedUnix: 0,
},
{
Type: models.CommentTypeComment,
PosterID: 2,
Content: "testtest",
CreatedUnix: 0,
},
{
Type: models.CommentTypeLabel,
PosterID: 1,
Content: "",
Label: &models.Label{
Name: "kind/bug",
},
CreatedUnix: 0,
},
},
afterCombined: []*models.Comment{
{
Type: models.CommentTypeLabel,
PosterID: 1,
Content: "1",
Label: &models.Label{
Name: "kind/bug",
},
AddedLabels: []*models.Label{
{
Name: "kind/bug",
},
},
CreatedUnix: 0,
},
{
Type: models.CommentTypeComment,
PosterID: 2,
Content: "testtest",
CreatedUnix: 0,
},
{
Type: models.CommentTypeLabel,
PosterID: 1,
Content: "",
RemovedLabels: []*models.Label{
{
Name: "kind/bug",
},
},
Label: &models.Label{
Name: "kind/bug",
},
CreatedUnix: 0,
},
},
},
} }
for _, kase := range kases { for _, kase := range kases {
t.Run(kase.name, func(t *testing.T) {
var issue = models.Issue{ var issue = models.Issue{
Comments: kase.beforeCombined, Comments: kase.beforeCombined,
} }
combineLabelComments(&issue) combineLabelComments(&issue)
assert.EqualValues(t, kase.afterCombined, issue.Comments) assert.EqualValues(t, kase.afterCombined, issue.Comments)
})
} }
} }