fix(api): allow pending-inline-comment-only reviews (#39433)

Prior to this change, the API rejected reviews without a summary
comment, even if it had pending inline comments. This differs from the
web UI, which accepts such reviews. The affected endpoints are:

1. Submitting via POST /repos/{owner}/{repo}/pulls/{index}/reviews/{id}.
2. Creating via POST /repos/{owner}/{repo}/pulls/{index}/reviews, both
when finishing an existing pending review and when creating a new
pending review.

The endpoints ran their own emptiness check, which ignored comments
already in a pending review. The fix drops it for comment and pending
reviews and relies on the model's check, which counts them, as the web
UI does.

A review with neither a body nor inline comments remains invalid.

---------

Co-authored-by: silverwind <me@silverwind.io>
Co-authored-by: bircni <bircni@icloud.com>
This commit is contained in:
Sergio Benitez
2026-09-26 12:51:55 -04:00
committed by GitHub
parent 3fac5059de
commit dcef88a233
3 changed files with 35 additions and 30 deletions
+21 -1
View File
@@ -160,6 +160,26 @@ func testAPIPullReviewGeneral(t *testing.T) {
AddTokenAuth(token)
MakeRequest(t, req, http.StatusNoContent)
reviewsURL := fmt.Sprintf("/api/v1/repos/%s/%s/pulls/%d/reviews", repo.OwnerName, repo.Name, pullIssue.Index)
pendingComment := []api.CreatePullReviewComment{{Path: "README.md", Body: "pending comment", NewLineNum: 1}}
req = NewRequestWithJSON(t, http.MethodPost, reviewsURL, &api.CreatePullReviewOptions{Body: "draft"}).AddTokenAuth(token)
pendingReviewURL := fmt.Sprintf("%s/%d", reviewsURL, DecodeJSON(t, MakeRequest(t, req, http.StatusOK), &api.PullReview{}).ID)
req = NewRequestWithJSON(t, http.MethodPost, pendingReviewURL, &api.SubmitPullReviewOptions{Event: "COMMENT"}).AddTokenAuth(token)
MakeRequest(t, req, http.StatusUnprocessableEntity)
req = NewRequestWithJSON(t, http.MethodPost, reviewsURL, &api.CreatePullReviewOptions{Comments: pendingComment}).AddTokenAuth(token)
MakeRequest(t, req, http.StatusOK)
req = NewRequestWithJSON(t, http.MethodPost, pendingReviewURL, &api.SubmitPullReviewOptions{Event: "COMMENT"}).AddTokenAuth(token)
review = DecodeJSON(t, MakeRequest(t, req, http.StatusOK), &api.PullReview{})
assert.EqualValues(t, "COMMENT", review.State)
assert.Equal(t, 1, review.CodeCommentsCount)
req = NewRequestWithJSON(t, http.MethodPost, reviewsURL, &api.CreatePullReviewOptions{Comments: pendingComment}).AddTokenAuth(token)
MakeRequest(t, req, http.StatusOK)
req = NewRequestWithJSON(t, http.MethodPost, reviewsURL, &api.CreatePullReviewOptions{Event: "COMMENT"}).AddTokenAuth(token)
review = DecodeJSON(t, MakeRequest(t, req, http.StatusOK), &api.PullReview{})
assert.EqualValues(t, "COMMENT", review.State)
assert.Equal(t, 1, review.CodeCommentsCount)
// test CreatePullReview Comment without body but with comments
req = NewRequestWithJSON(t, http.MethodPost, fmt.Sprintf("/api/v1/repos/%s/%s/pulls/%d/reviews", repo.OwnerName, repo.Name, pullIssue.Index), &api.CreatePullReviewOptions{
// Body: "",
@@ -210,7 +230,7 @@ func testAPIPullReviewGeneral(t *testing.T) {
resp = MakeRequest(t, req, http.StatusUnprocessableEntity)
errMap := make(map[string]any)
json.Unmarshal(resp.Body.Bytes(), &errMap)
assert.Equal(t, "review event COMMENT requires a body or a comment", errMap["message"])
assert.Equal(t, "review requires a body or a comment", errMap["message"])
// test get review requests
// to make it simple, use same api with get review