Fix cannot reopen after pushing commits to a closed PR (#23189)

Close: #22784

1. On GH, we can reopen a PR which was closed before after pushing
commits. After reopening PR, we can see the commits that were pushed
after closing PR in the time line. So the case of
[issue](https://github.com/go-gitea/gitea/issues/22784) is a bug which
needs to be fixed.

2. After closing a PR and pushing commits, `headBranchSha` is not equal
to `sha`(which is the last commit ID string of reference). If the
judgement exists, the button of reopen will not display. So, skip the
judgement if the status of PR is closed.

![image](https://user-images.githubusercontent.com/33891828/222037529-651fccf9-0bba-433e-b2f0-79c17e0cc812.png)

3. Even if PR is already close, we should still insert comment record
into DB when we push commits.
So we should still call  function `CreatePushPullComment()`.

https://github.com/go-gitea/gitea/blob/067b0c2664d127c552ccdfd264257caca4907a77/services/pull/pull.go#L260-L282
So, I add a switch(`includeClosed`) to the
`GetUnmergedPullRequestsByHeadInfo` func to control whether the status
of PR must be open. In this case, by setting `includeClosed` to `true`,
we can query the closed PR.

![image](https://user-images.githubusercontent.com/33891828/222621045-bb80987c-10c5-4eac-aa0c-1fb9c6aefb51.png)

4. In the loop of comments, I use the`latestCloseCommentID` variable to
record the last occurrence of the close comment.
In the go template, if the status of PR is closed, the comments whose
type is `CommentTypePullRequestPush(29)` after `latestCloseCommentID`
won't be rendered.

![image](https://user-images.githubusercontent.com/33891828/222058913-c91cf3e3-819b-40c5-8015-654b31eeccff.png)
e.g.
1). The initial status of the PR is opened.

![image](https://user-images.githubusercontent.com/33891828/222453617-33c5093e-f712-4cd6-8489-9f87e2075869.png)
2). Then I click the button of `Close`.  PR is closed now.

![image](https://user-images.githubusercontent.com/33891828/222453694-25c588a9-c121-4897-9ae5-0b13cf33d20b.png)
3). I try to push a commit to this PR, even though its current status is
closed.

![image](https://user-images.githubusercontent.com/33891828/222453916-361678fb-7321-410d-9e37-5a26e8095638.png)
But in comments list, this commit do not display.This is as expected ：）

![image](https://user-images.githubusercontent.com/33891828/222454169-7617a791-78d2-404e-be5e-77d555f93313.png)
4). Click the `Reopen` button, the commit which is pushed after closing
PR display now.

![image](https://user-images.githubusercontent.com/33891828/222454533-897893b6-b96e-4701-b5cb-b1800f382b8f.png)

---------

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>

diff --git a/models/issues/pull_list.go b/models/issues/pull_list.go
index 6c9e8c4e05fb20fa59c79d85d818ce3a93f0651f..9d361c5c5da919013acac0e49cf03976e5c34597 100644 (file)
--- a/models/issues/pull_list.go
+++ b/models/issues/pull_list.go
@@ -52,13 +52,16 @@ func listPullRequestStatement(baseRepoID int64, opts *PullRequestsOptions) (*xor
 
 // GetUnmergedPullRequestsByHeadInfo returns all pull requests that are open and has not been merged
 // by given head information (repo and branch).
-func GetUnmergedPullRequestsByHeadInfo(repoID int64, branch string) ([]*PullRequest, error) {
+// arg `includeClosed` controls whether the SQL returns closed PRs
+func GetUnmergedPullRequestsByHeadInfo(repoID int64, branch string, includeClosed bool) ([]*PullRequest, error) {
        prs := make([]*PullRequest, 0, 2)
-       return prs, db.GetEngine(db.DefaultContext).
-               Where("head_repo_id = ? AND head_branch = ? AND has_merged = ? AND issue.is_closed = ? AND flow = ?",
-                       repoID, branch, false, false, PullRequestFlowGithub).
+       sess := db.GetEngine(db.DefaultContext).
                Join("INNER", "issue", "issue.id = pull_request.issue_id").
-               Find(&prs)
+               Where("head_repo_id = ? AND head_branch = ? AND has_merged = ? AND flow = ?", repoID, branch, false, PullRequestFlowGithub)
+       if !includeClosed {
+               sess.Where("issue.is_closed = ?", false)
+       }
+       return prs, sess.Find(&prs)
 }
 
 // CanMaintainerWriteToBranch check whether user is a maintainer and could write to the branch
@@ -71,7 +74,7 @@ func CanMaintainerWriteToBranch(p access_model.Permission, branch string, user *
                return false
        }
 
-       prs, err := GetUnmergedPullRequestsByHeadInfo(p.Units[0].RepoID, branch)
+       prs, err := GetUnmergedPullRequestsByHeadInfo(p.Units[0].RepoID, branch, false)
        if err != nil {
                return false
        }

diff --git a/models/issues/pull_test.go b/models/issues/pull_test.go
index 8ce8eecc4aa87292b6c922357fd1b09c6ddee848..bcd33329eb9bf26f88657f7dbabb4bbb6df361a5 100644 (file)
--- a/models/issues/pull_test.go
+++ b/models/issues/pull_test.go
@@ -118,7 +118,7 @@ func TestHasUnmergedPullRequestsByHeadInfo(t *testing.T) {
 
 func TestGetUnmergedPullRequestsByHeadInfo(t *testing.T) {
        assert.NoError(t, unittest.PrepareTestDatabase())
-       prs, err := issues_model.GetUnmergedPullRequestsByHeadInfo(1, "branch2")
+       prs, err := issues_model.GetUnmergedPullRequestsByHeadInfo(1, "branch2", false)
        assert.NoError(t, err)
        assert.Len(t, prs, 1)
        for _, pr := range prs {

diff --git a/routers/web/repo/issue.go b/routers/web/repo/issue.go
index 47b499a3ccf0d77da1631f3a40865d573054b824..3715320f10c84f95d898c5773f91d222cc7aa7c8 100644 (file)
--- a/routers/web/repo/issue.go
+++ b/routers/web/repo/issue.go
@@ -1420,11 +1420,12 @@ func ViewIssue(ctx *context.Context) {
        }
 
        var (
-               role         issues_model.RoleDescriptor
-               ok           bool
-               marked       = make(map[int64]issues_model.RoleDescriptor)
-               comment      *issues_model.Comment
-               participants = make([]*user_model.User, 1, 10)
+               role                 issues_model.RoleDescriptor
+               ok                   bool
+               marked               = make(map[int64]issues_model.RoleDescriptor)
+               comment              *issues_model.Comment
+               participants         = make([]*user_model.User, 1, 10)
+               latestCloseCommentID int64
        )
        if ctx.Repo.Repository.IsTimetrackerEnabled(ctx) {
                if ctx.IsSigned {
@@ -1622,9 +1623,15 @@ func ViewIssue(ctx *context.Context) {
                        comment.Type == issues_model.CommentTypeStopTracking {
                        // drop error since times could be pruned from DB..
                        _ = comment.LoadTime()
+               } else if comment.Type == issues_model.CommentTypeClose {
+                       // record ID of latest closed comment.
+                       // if PR is closed, the comments whose type is CommentTypePullRequestPush(29) after latestCloseCommentID won't be rendered.
+                       latestCloseCommentID = comment.ID
                }
        }
 
+       ctx.Data["LatestCloseCommentID"] = latestCloseCommentID
+
        // Combine multiple label assignments into a single comment
        combineLabelComments(issue)
 

diff --git a/routers/web/repo/pull.go b/routers/web/repo/pull.go
index 78c935a8c8b7d165e39dab1d5d47088ea0c2d31d..4f996877382472acbffa8c835bfb9a7e01c95074 100644 (file)
--- a/routers/web/repo/pull.go
+++ b/routers/web/repo/pull.go
@@ -587,7 +587,7 @@ func PrepareViewPullInfo(ctx *context.Context, issue *issues_model.Issue) *git.C
        ctx.Data["HeadBranchCommitID"] = headBranchSha
        ctx.Data["PullHeadCommitID"] = sha
 
-       if pull.HeadRepo == nil || !headBranchExist || headBranchSha != sha {
+       if pull.HeadRepo == nil || !headBranchExist || (!pull.Issue.IsClosed && (headBranchSha != sha)) {
                ctx.Data["IsPullRequestBroken"] = true
                if pull.IsSameRepo() {
                        ctx.Data["HeadTarget"] = pull.HeadBranch

diff --git a/services/pull/pull.go b/services/pull/pull.go
index 0d260c93b1ec3291576595e70cb428bcf506c734..a19e88b33b657843f51fc34690bc745bfe8cfc84 100644 (file)
--- a/services/pull/pull.go
+++ b/services/pull/pull.go
@@ -257,7 +257,7 @@ func AddTestPullRequestTask(doer *user_model.User, repoID int64, branch string,
                // If you don't let it run all the way then you will lose data
                // TODO: graceful: AddTestPullRequestTask needs to become a queue!
 
-               prs, err := issues_model.GetUnmergedPullRequestsByHeadInfo(repoID, branch)
+               prs, err := issues_model.GetUnmergedPullRequestsByHeadInfo(repoID, branch, true)
                if err != nil {
                        log.Error("Find pull requests [head_repo_id: %d, head_branch: %s]: %v", repoID, branch, err)
                        return
@@ -500,7 +500,7 @@ func (errs errlist) Error() string {
 
 // CloseBranchPulls close all the pull requests who's head branch is the branch
 func CloseBranchPulls(doer *user_model.User, repoID int64, branch string) error {
-       prs, err := issues_model.GetUnmergedPullRequestsByHeadInfo(repoID, branch)
+       prs, err := issues_model.GetUnmergedPullRequestsByHeadInfo(repoID, branch, false)
        if err != nil {
                return err
        }
@@ -536,7 +536,7 @@ func CloseRepoBranchesPulls(ctx context.Context, doer *user_model.User, repo *re
 
        var errs errlist
        for _, branch := range branches {
-               prs, err := issues_model.GetUnmergedPullRequestsByHeadInfo(repo.ID, branch.Name)
+               prs, err := issues_model.GetUnmergedPullRequestsByHeadInfo(repo.ID, branch.Name, false)
                if err != nil {
                        return err
                }

diff --git a/templates/repo/issue/view_content/comments.tmpl b/templates/repo/issue/view_content/comments.tmpl
index 6054e7b86b1c66d7219293256a300943b1288861..03f48ace6638c08c32a534ec8f26c1ae88936adf 100644 (file)
--- a/templates/repo/issue/view_content/comments.tmpl
+++ b/templates/repo/issue/view_content/comments.tmpl
@@ -697,7 +697,11 @@
                                </span>
                        </div>
                {{else if and (eq .Type 29) (or (gt .CommitsNum 0) .IsForcePush)}}
-                       <div class="timeline-item event" id="{{.HashTag}}">
+                       <!-- If PR is closed, the comments whose type is CommentTypePullRequestPush(29) after latestCloseCommentID won't be rendered. //-->
+                       {{if and .Issue.IsClosed (gt .ID $.LatestCloseCommentID)}}
+                               {{continue}}
+                       {{end}}`
+                       <div class="timeline-item event" id="{{.HashTag}}">`
                                <span class="badge">{{svg "octicon-repo-push"}}</span>
                                <span class="text grey muted-links">
                                        {{template "shared/user/authorlink" .Poster}}