fix: display code comments on removed lines-of-code to correct locations in PR view (#12092)
With the completion of #12015, when a comment is left on a changed line in a pull request, we track the comment against the line of code with `git blame` and then identify where it currently is in any diff with `git blame --reverse`. However, this strategy only works for the *modified* lines of code -- eg. the `+...` in diffs, and not the `-...` in diffs. The reason is that `git blame --reverse` can't track a line of code's location past the commit that it was removed in. To permit comments that are left on lines of code that are removed to appear correctly in the UI, a separate approach is required for those comments. This PR performs two major changes, which have been complex to figure out, but are reasonably easy to understand: - When a comment is placed on a removed line in a PR, perform a `git blame --reverse` from the PR's base to the currently viewed commit, and use this information to record in the comment: - the **last commit that the line of code existed in** (stored in the `commit_sha` field) - the **line of code as of that commit** (stored in the `line` field, negative, to indicate that the comment is on a removal). - the **patch** where the comment was placed (stored in the field `patch`); existing functionality unchanged in this PR - When viewing any diff in the PR, for each comment on a removal, perform a diff from the `commit_sha` (last commit that the line of code existed in) to the current commit being viewed, and verify that within that diff the left-hand-side line removal still exists at the same line of code in the diff, by comparing the current diff with the stored patch. - If present, place the commit in the UI at the line number. - If the line of code no longer exists in the diff at that point (for example, it was removed, commented upon, and then re-added in a later commit), then the comment is considered outdated and isn't displayed. The algorithm used for marking a comment as "outdated" is also updated to use this approach. ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. All work and communication must conform to Forgejo's [AI Agreement](https://codeberg.org/forgejo/governance/src/branch/main/AIAgreement.md). There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests for Go changes - I added test coverage for Go changes... - [x] in their respective `*_test.go` for unit tests. - [x] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I ran... - [x] `make pr-go` before pushing ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [x] This change will be noticed by a Forgejo user or admin (feature, bug fix, performance, etc.). I suggest to include a release note for this change. - [ ] This change is not visible to a Forgejo user or admin (refactor, dependency upgrade, etc.). I think there is no need to add a release note for this change. Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/12092 Reviewed-by: Andreas Ahlenstorf <aahlenst@noreply.codeberg.org> Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net> Co-committed-by: Mathieu Fenniak <mathieu@fenniak.net>
This commit is contained in:
Mathieu Fenniak
committed by
Mathieu Fenniak
Mathieu Fenniak
parent
86898a7d05
commit
a797a71dea
@@ -167,3 +167,215 @@ func TestParseDiffHunkString(t *testing.T) {
|
||||
assert.Equal(t, 19, rightLine)
|
||||
assert.Equal(t, 5, rightHunk)
|
||||
}
|
||||
|
||||
func TestFindAdjustedLineNumber(t *testing.T) {
|
||||
commentCutDiff := `diff --git a/file1.md b/file1.md
|
||||
--- a/file1.md
|
||||
+++ b/file1.md
|
||||
@@ -47,7 +47,6 @@ Line 46
|
||||
Line 47
|
||||
Line 48
|
||||
Line 49
|
||||
-Line 50`
|
||||
|
||||
t.Run("no additional changes", func(t *testing.T) {
|
||||
diff := `diff --git a/file1.md b/file1.md
|
||||
index 2d203fb..b21df3f 100644
|
||||
--- a/file1.md
|
||||
+++ b/file1.md
|
||||
@@ -47,7 +47,6 @@ Line 46
|
||||
Line 47
|
||||
Line 48
|
||||
Line 49
|
||||
-Line 50
|
||||
Line 51
|
||||
Line 52
|
||||
Line 53`
|
||||
lineNumber, err := FindAdjustedLineNumber(commentCutDiff, 50, strings.NewReader(diff))
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, LinePlacement{Left: 50, Right: 50}, lineNumber)
|
||||
})
|
||||
|
||||
t.Run("removed lines before location", func(t *testing.T) {
|
||||
diff := `diff --git a/file1.md b/file1.md
|
||||
index 2d203fb..c85b903 100644
|
||||
--- a/file1.md
|
||||
+++ b/file1.md
|
||||
@@ -1,13 +1,3 @@
|
||||
-Line 1
|
||||
-Line 2
|
||||
-Line 3
|
||||
-Line 4
|
||||
-Line 5
|
||||
-Line 6
|
||||
-Line 7
|
||||
-Line 8
|
||||
-Line 9
|
||||
-Line 10
|
||||
Line 11
|
||||
Line 12
|
||||
Line 13
|
||||
@@ -47,7 +37,6 @@ Line 46
|
||||
Line 47
|
||||
Line 48
|
||||
Line 49
|
||||
-Line 50
|
||||
Line 51
|
||||
Line 52
|
||||
Line 53`
|
||||
lineNumber, err := FindAdjustedLineNumber(commentCutDiff, 50, strings.NewReader(diff))
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, LinePlacement{Left: 50, Right: 40}, lineNumber)
|
||||
})
|
||||
|
||||
t.Run("added lines before location", func(t *testing.T) {
|
||||
diff := `diff --git a/file1.md b/file1.md
|
||||
index 2d203fb..24b1aa6 100644
|
||||
--- a/file1.md
|
||||
+++ b/file1.md
|
||||
@@ -8,6 +8,11 @@ Line 7
|
||||
Line 8
|
||||
Line 9
|
||||
Line 10
|
||||
+Line 10.1
|
||||
+Line 10.2
|
||||
+Line 10.3
|
||||
+Line 10.4
|
||||
+Line 10.5
|
||||
Line 11
|
||||
Line 12
|
||||
Line 13
|
||||
@@ -47,7 +52,6 @@ Line 46
|
||||
Line 47
|
||||
Line 48
|
||||
Line 49
|
||||
-Line 50
|
||||
Line 51
|
||||
Line 52
|
||||
Line 53`
|
||||
lineNumber, err := FindAdjustedLineNumber(commentCutDiff, 50, strings.NewReader(diff))
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, LinePlacement{Left: 50, Right: 55}, lineNumber)
|
||||
})
|
||||
|
||||
t.Run("added and removed in lines before location", func(t *testing.T) {
|
||||
diff := `diff --git a/file1.md b/file1.md
|
||||
index 2d203fb..d0cb63f 100644
|
||||
--- a/file1.md
|
||||
+++ b/file1.md
|
||||
@@ -5,9 +5,11 @@ Line 4
|
||||
Line 5
|
||||
Line 6
|
||||
Line 7
|
||||
-Line 8
|
||||
-Line 9
|
||||
-Line 10
|
||||
+Line 10.1
|
||||
+Line 10.2
|
||||
+Line 10.3
|
||||
+Line 10.4
|
||||
+Line 10.5
|
||||
Line 11
|
||||
Line 12
|
||||
Line 13
|
||||
@@ -47,7 +49,6 @@ Line 46
|
||||
Line 47
|
||||
Line 48
|
||||
Line 49
|
||||
-Line 50
|
||||
Line 51
|
||||
Line 52
|
||||
Line 53`
|
||||
lineNumber, err := FindAdjustedLineNumber(commentCutDiff, 50, strings.NewReader(diff))
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, LinePlacement{Left: 50, Right: 52}, lineNumber)
|
||||
})
|
||||
|
||||
t.Run("changes above in the same hunk", func(t *testing.T) {
|
||||
diff := `diff --git a/file1.md b/file1.md
|
||||
index 2d203fb..f35a466 100644
|
||||
--- a/file1.md
|
||||
+++ b/file1.md
|
||||
@@ -42,12 +42,6 @@ Line 41
|
||||
Line 42
|
||||
Line 43
|
||||
Line 44
|
||||
-Line 45
|
||||
-Line 46
|
||||
-Line 47
|
||||
-Line 48
|
||||
-Line 49
|
||||
-Line 50
|
||||
Line 51
|
||||
Line 52
|
||||
Line 53`
|
||||
lineNumber, err := FindAdjustedLineNumber(commentCutDiff, 50, strings.NewReader(diff))
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, LinePlacement{Left: 50, Right: 45}, lineNumber)
|
||||
})
|
||||
|
||||
t.Run("first line in diff", func(t *testing.T) {
|
||||
commentCutDiff := `diff --git a/file1.md b/file1.md
|
||||
--- a/file1.md
|
||||
+++ b/file1.md
|
||||
@@ -1,4 +1,3 @@
|
||||
-Line 1`
|
||||
diff := `diff --git a/file1.md b/file1.md
|
||||
index 2d203fb..a490028 100644
|
||||
--- a/file1.md
|
||||
+++ b/file1.md
|
||||
@@ -1,4 +1,3 @@
|
||||
-Line 1
|
||||
Line 2
|
||||
Line 3
|
||||
Line 4`
|
||||
lineNumber, err := FindAdjustedLineNumber(commentCutDiff, 1, strings.NewReader(diff))
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, LinePlacement{Left: 1, Right: 1}, lineNumber)
|
||||
})
|
||||
|
||||
t.Run("adjusted line not found", func(t *testing.T) {
|
||||
// "Line 50" is present here but it's no longer "-Line 50", so it should not be identified as present
|
||||
diff := `diff --git a/file1.md b/file1.md
|
||||
index 2d203fb..09dd95a 100644
|
||||
--- a/file1.md
|
||||
+++ b/file1.md
|
||||
@@ -42,10 +42,6 @@ Line 41
|
||||
Line 42
|
||||
Line 43
|
||||
Line 44
|
||||
-Line 45
|
||||
-Line 46
|
||||
-Line 47
|
||||
-Line 48
|
||||
Line 49
|
||||
Line 50
|
||||
Line 51`
|
||||
_, err := FindAdjustedLineNumber(commentCutDiff, 50, strings.NewReader(diff))
|
||||
require.ErrorIs(t, err, ErrLineNotFound)
|
||||
})
|
||||
|
||||
t.Run("adjusted line hunk not present - not changed anymore", func(t *testing.T) {
|
||||
diff := `diff --git a/file1.md b/file1.md
|
||||
index 2d203fb..d0cb63f 100644
|
||||
--- a/file1.md
|
||||
+++ b/file1.md
|
||||
@@ -5,9 +5,11 @@ Line 4
|
||||
Line 5
|
||||
Line 6
|
||||
Line 7
|
||||
-Line 8
|
||||
-Line 9
|
||||
-Line 10
|
||||
+Line 10.1
|
||||
+Line 10.2
|
||||
+Line 10.3
|
||||
+Line 10.4
|
||||
+Line 10.5
|
||||
Line 11
|
||||
Line 12
|
||||
Line 13`
|
||||
_, err := FindAdjustedLineNumber(commentCutDiff, 50, strings.NewReader(diff))
|
||||
require.ErrorIs(t, err, ErrLineNotFound)
|
||||
})
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user