Skip to content

fix: Fix PR review tools (except create_pull_request_review which works already) when authenticated with a GitHub App installation token (S2S) #3353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Copilot wants to merge 1 commit into from
+193 −357
Closed

fix: Fix PR review tools (except create_pull_request_review which works already) when authenticated with a GitHub App installation token (S2S) #3353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 4 additions & 44 deletions pkg/github/granular_tools_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1653,49 +1653,6 @@ func TestGranularUpdatePullRequestDraftState(t *testing.T) {

func TestGranularAddPullRequestReviewComment(t *testing.T) {
mockedClient := githubv4mock.NewMockedHTTPClient(
githubv4mock.NewQueryMatcher(
struct {
Viewer struct {
Login githubv4.String
}
}{},
nil,
githubv4mock.DataResponse(map[string]any{
"viewer": map[string]any{"login": "testuser"},
}),
),
githubv4mock.NewQueryMatcher(
struct {
Repository struct {
PullRequest struct {
Reviews struct {
Nodes []struct {
ID githubv4.ID
State githubv4.PullRequestReviewState
URL githubv4.URI
}
} `graphql:"reviews(first: 1, author: $author)"`
} `graphql:"pullRequest(number: $prNum)"`
} `graphql:"repository(owner: $owner, name: $name)"`
}{},
map[string]any{
"author": githubv4.String("testuser"),
"owner": githubv4.String("owner"),
"name": githubv4.String("repo"),
"prNum": githubv4.Int(1),
},
githubv4mock.DataResponse(map[string]any{
"repository": map[string]any{
"pullRequest": map[string]any{
"reviews": map[string]any{
"nodes": []map[string]any{
{"id": "PRR_123", "state": "PENDING", "url": "https://github.com/owner/repo/pull/1#pullrequestreview-123"},
},
},
},
},
}),
),
githubv4mock.NewMutationMatcher(
struct {
AddPullRequestReviewThread struct {
Expand All @@ -1721,7 +1678,10 @@ func TestGranularAddPullRequestReviewComment(t *testing.T) {
),
)
gqlClient := githubv4.NewClient(mockedClient)
deps := BaseDeps{GQLClient: gqlClient}
deps := BaseDeps{
Client: mockPendingReviewClient(t, "PRR_123"),
GQLClient: gqlClient,
}
serverTool := GranularAddPullRequestReviewComment(translations.NullTranslationHelper)
handler := serverTool.Handler(deps)

Expand Down
232 changes: 66 additions & 166 deletions pkg/github/pullrequests.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1876,31 +1876,38 @@ Available methods:
return utils.NewToolResultError(err.Error()), nil, nil
}

// Given our owner, repo and PR number, lookup the GQL ID of the PR.
client, err := deps.GetGQLClient(ctx)
gqlClient, err := deps.GetGQLClient(ctx)
if err != nil {
return utils.NewToolResultError(fmt.Sprintf("failed to get GitHub GQL client: %v", err)), nil, nil
}

switch params.Method {
case "create":
result, err := CreatePullRequestReview(ctx, client, params)
result, err := CreatePullRequestReview(ctx, gqlClient, params)
return result, nil, err
case "submit_pending":
result, err := SubmitPendingPullRequestReview(ctx, client, params)
restClient, err := deps.GetClient(ctx)
if err != nil {
return utils.NewToolResultError(fmt.Sprintf("failed to get GitHub client: %v", err)), nil, nil
}
result, err := SubmitPendingPullRequestReview(ctx, restClient, gqlClient, params)
return result, nil, err
case "delete_pending":
result, err := DeletePendingPullRequestReview(ctx, client, params)
restClient, err := deps.GetClient(ctx)
if err != nil {
return utils.NewToolResultError(fmt.Sprintf("failed to get GitHub client: %v", err)), nil, nil
}
result, err := DeletePendingPullRequestReview(ctx, restClient, gqlClient, params)
return result, nil, err
case "resolve_thread":
if !withResolutionReason {
result, err := ResolveReviewThread(ctx, client, params.ThreadID, true)
result, err := ResolveReviewThread(ctx, gqlClient, params.ThreadID, true)
return result, nil, err
}
result, err := ResolveReviewThreadWithReason(ctx, client, params.ThreadID, params.ResolutionReason, true)
result, err := ResolveReviewThreadWithReason(ctx, gqlClient, params.ThreadID, params.ResolutionReason, true)
return result, nil, err
case "unresolve_thread":
result, err := ResolveReviewThread(ctx, client, params.ThreadID, false)
result, err := ResolveReviewThread(ctx, gqlClient, params.ThreadID, false)
return result, nil, err
default:
return utils.NewToolResultError(fmt.Sprintf("unknown method: %s", params.Method)), nil, nil
Expand Down Expand Up @@ -1988,58 +1995,43 @@ func CreatePullRequestReview(ctx context.Context, client *githubv4.Client, param
return utils.NewToolResultText("pull request review submitted successfully"), nil
}

func SubmitPendingPullRequestReview(ctx context.Context, client *githubv4.Client, params PullRequestReviewWriteParams) (*mcp.CallToolResult, error) {
// First we'll get the current user
var getViewerQuery struct {
Viewer struct {
Login githubv4.String
// GetPendingPullRequestReviewID returns the node ID of the viewer's pending review,
// or a tool error result otherwise. GitHub only includes pending reviews for their
// author in the REST response, including when the viewer is a GitHub App.
func GetPendingPullRequestReviewID(ctx context.Context, client *github.Client, owner, repo string, pullNumber int32) (githubv4.ID, *mcp.CallToolResult) {
opts := &github.ListOptions{PerPage: 100}
for {
reviews, resp, err := client.PullRequests.ListReviews(ctx, owner, repo, int(pullNumber), opts)
if resp != nil && resp.Body != nil {
_ = resp.Body.Close()
}
Comment thread
Copilot marked this conversation as resolved.
if err != nil {
return nil, ghErrors.NewGitHubAPIErrorResponse(ctx, "failed to list pull request reviews", resp, err)
}
}

if err := client.Query(ctx, &getViewerQuery, nil); err != nil {
return ghErrors.NewGitHubGraphQLErrorResponse(ctx,
"failed to get current user",
err,
), nil
}

var getLatestReviewForViewerQuery struct {
Repository struct {
PullRequest struct {
Reviews struct {
Nodes []struct {
ID githubv4.ID
State githubv4.PullRequestReviewState
URL githubv4.URI
}
} `graphql:"reviews(first: 1, author: $author)"`
} `graphql:"pullRequest(number: $prNum)"`
} `graphql:"repository(owner: $owner, name: $name)"`
}

vars := map[string]any{
"author": githubv4.String(getViewerQuery.Viewer.Login),
"owner": githubv4.String(params.Owner),
"name": githubv4.String(params.Repo),
"prNum": githubv4.Int(params.PullNumber),
}
for _, review := range reviews {
if review.GetState() != "PENDING" {
continue
}
if review.GetNodeID() == "" {
return nil, utils.NewToolResultError("Pending review did not include a node ID")
}
return githubv4.ID(review.GetNodeID()), nil
}

if err := client.Query(ctx, &getLatestReviewForViewerQuery, vars); err != nil {
return ghErrors.NewGitHubGraphQLErrorResponse(ctx,
"failed to get latest review for current user",
err,
), nil
if resp == nil || resp.NextPage == 0 {
break
}
opts.Page = resp.NextPage
}

// Validate there is one review and the state is pending
if len(getLatestReviewForViewerQuery.Repository.PullRequest.Reviews.Nodes) == 0 {
return utils.NewToolResultError("No pending review found for the viewer"), nil
}
return nil, utils.NewToolResultError("No pending review found for the viewer")
}

review := getLatestReviewForViewerQuery.Repository.PullRequest.Reviews.Nodes[0]
if review.State != githubv4.PullRequestReviewStatePending {
errText := fmt.Sprintf("The latest review, found at %s is not pending", review.URL)
return utils.NewToolResultError(errText), nil
func SubmitPendingPullRequestReview(ctx context.Context, restClient *github.Client, gqlClient *githubv4.Client, params PullRequestReviewWriteParams) (*mcp.CallToolResult, error) {
reviewID, errResult := GetPendingPullRequestReviewID(ctx, restClient, params.Owner, params.Repo, params.PullNumber)
if errResult != nil {
return errResult, nil
}

// Prepare the mutation
Expand All @@ -2051,11 +2043,11 @@ func SubmitPendingPullRequestReview(ctx context.Context, client *githubv4.Client
} `graphql:"submitPullRequestReview(input: $input)"`
}

if err := client.Mutate(
if err := gqlClient.Mutate(
ctx,
&submitPullRequestReviewMutation,
githubv4.SubmitPullRequestReviewInput{
PullRequestReviewID: &review.ID,
PullRequestReviewID: &reviewID,
Event: githubv4.PullRequestReviewEvent(params.Event),
Body: newGQLStringlikePtr[githubv4.String](&params.Body),
},
Expand All @@ -2073,58 +2065,10 @@ func SubmitPendingPullRequestReview(ctx context.Context, client *githubv4.Client
return utils.NewToolResultText("pending pull request review successfully submitted"), nil
}

func DeletePendingPullRequestReview(ctx context.Context, client *githubv4.Client, params PullRequestReviewWriteParams) (*mcp.CallToolResult, error) {
// First we'll get the current user
var getViewerQuery struct {
Viewer struct {
Login githubv4.String
}
}

if err := client.Query(ctx, &getViewerQuery, nil); err != nil {
return ghErrors.NewGitHubGraphQLErrorResponse(ctx,
"failed to get current user",
err,
), nil
}

var getLatestReviewForViewerQuery struct {
Repository struct {
PullRequest struct {
Reviews struct {
Nodes []struct {
ID githubv4.ID
State githubv4.PullRequestReviewState
URL githubv4.URI
}
} `graphql:"reviews(first: 1, author: $author)"`
} `graphql:"pullRequest(number: $prNum)"`
} `graphql:"repository(owner: $owner, name: $name)"`
}

vars := map[string]any{
"author": githubv4.String(getViewerQuery.Viewer.Login),
"owner": githubv4.String(params.Owner),
"name": githubv4.String(params.Repo),
"prNum": githubv4.Int(params.PullNumber),
}

if err := client.Query(ctx, &getLatestReviewForViewerQuery, vars); err != nil {
return ghErrors.NewGitHubGraphQLErrorResponse(ctx,
"failed to get latest review for current user",
err,
), nil
}

// Validate there is one review and the state is pending
if len(getLatestReviewForViewerQuery.Repository.PullRequest.Reviews.Nodes) == 0 {
return utils.NewToolResultError("No pending review found for the viewer"), nil
}

review := getLatestReviewForViewerQuery.Repository.PullRequest.Reviews.Nodes[0]
if review.State != githubv4.PullRequestReviewStatePending {
errText := fmt.Sprintf("The latest review, found at %s is not pending", review.URL)
return utils.NewToolResultError(errText), nil
func DeletePendingPullRequestReview(ctx context.Context, restClient *github.Client, gqlClient *githubv4.Client, params PullRequestReviewWriteParams) (*mcp.CallToolResult, error) {
reviewID, errResult := GetPendingPullRequestReviewID(ctx, restClient, params.Owner, params.Repo, params.PullNumber)
if errResult != nil {
return errResult, nil
}

// Prepare the mutation
Expand All @@ -2136,11 +2080,11 @@ func DeletePendingPullRequestReview(ctx context.Context, client *githubv4.Client
} `graphql:"deletePullRequestReview(input: $input)"`
}

if err := client.Mutate(
if err := gqlClient.Mutate(
ctx,
&deletePullRequestReviewMutation,
githubv4.DeletePullRequestReviewInput{
PullRequestReviewID: &review.ID,
PullRequestReviewID: &reviewID,
},
nil,
); err != nil {
Expand Down Expand Up @@ -2234,58 +2178,10 @@ type AddCommentToPendingReviewParams struct {
}

// AddCommentToPendingReviewCall adds a review comment to the viewer's pending pull request review.
func AddCommentToPendingReviewCall(ctx context.Context, client *githubv4.Client, params AddCommentToPendingReviewParams) (*mcp.CallToolResult, error) {
// Get the current user
var getViewerQuery struct {
Viewer struct {
Login githubv4.String
}
}

if err := client.Query(ctx, &getViewerQuery, nil); err != nil {
return ghErrors.NewGitHubGraphQLErrorResponse(ctx,
"failed to get current user",
err,
), nil
}

var getLatestReviewForViewerQuery struct {
Repository struct {
PullRequest struct {
Reviews struct {
Nodes []struct {
ID githubv4.ID
State githubv4.PullRequestReviewState
URL githubv4.URI
}
} `graphql:"reviews(first: 1, author: $author)"`
} `graphql:"pullRequest(number: $prNum)"`
} `graphql:"repository(owner: $owner, name: $name)"`
}

vars := map[string]any{
"author": githubv4.String(getViewerQuery.Viewer.Login),
"owner": githubv4.String(params.Owner),
"name": githubv4.String(params.Repo),
"prNum": githubv4.Int(params.PullNumber),
}

if err := client.Query(ctx, &getLatestReviewForViewerQuery, vars); err != nil {
return ghErrors.NewGitHubGraphQLErrorResponse(ctx,
"failed to get latest review for current user",
err,
), nil
}

// Validate there is one review and the state is pending
if len(getLatestReviewForViewerQuery.Repository.PullRequest.Reviews.Nodes) == 0 {
return utils.NewToolResultError("No pending review found for the viewer"), nil
}

review := getLatestReviewForViewerQuery.Repository.PullRequest.Reviews.Nodes[0]
if review.State != githubv4.PullRequestReviewStatePending {
errText := fmt.Sprintf("The latest review, found at %s is not pending", review.URL)
return utils.NewToolResultError(errText), nil
func AddCommentToPendingReviewCall(ctx context.Context, restClient *github.Client, gqlClient *githubv4.Client, params AddCommentToPendingReviewParams) (*mcp.CallToolResult, error) {
reviewID, errResult := GetPendingPullRequestReviewID(ctx, restClient, params.Owner, params.Repo, params.PullNumber)
if errResult != nil {
return errResult, nil
}

// Create a new review thread comment on the review.
Expand All @@ -2297,7 +2193,7 @@ func AddCommentToPendingReviewCall(ctx context.Context, client *githubv4.Client,
} `graphql:"addPullRequestReviewThread(input: $input)"`
}

if err := client.Mutate(
if err := gqlClient.Mutate(
ctx,
&addPullRequestReviewThreadMutation,
githubv4.AddPullRequestReviewThreadInput{
Expand All @@ -2308,7 +2204,7 @@ func AddCommentToPendingReviewCall(ctx context.Context, client *githubv4.Client,
Side: newGQLStringlikePtr[githubv4.DiffSide](params.Side),
StartLine: newGQLIntPtr(params.StartLine),
StartSide: newGQLStringlikePtr[githubv4.DiffSide](params.StartSide),
PullRequestReviewID: &review.ID,
PullRequestReviewID: &reviewID,
},
nil,
); err != nil {
Expand Down Expand Up @@ -2435,10 +2331,14 @@ func AddCommentToPendingReview(t translations.TranslationHelperFunc) inventory.S
}
startSide, _ := OptionalParam[string](args, "startSide")

client, err := deps.GetGQLClient(ctx)
gqlClient, err := deps.GetGQLClient(ctx)
if err != nil {
return utils.NewToolResultErrorFromErr("failed to get GitHub GQL client", err), nil, nil
}
restClient, err := deps.GetClient(ctx)
if err != nil {
return utils.NewToolResultErrorFromErr("failed to get GitHub client", err), nil, nil
}

var linePtr, startLinePtr *int32
if line != 0 {
Expand All @@ -2457,7 +2357,7 @@ func AddCommentToPendingReview(t translations.TranslationHelperFunc) inventory.S
startSidePtr = &startSide
}

result, err := AddCommentToPendingReviewCall(ctx, client, AddCommentToPendingReviewParams{
result, err := AddCommentToPendingReviewCall(ctx, restClient, gqlClient, AddCommentToPendingReviewParams{
Owner: owner,
Repo: repo,
PullNumber: int32(pullNumber), // #nosec G115 - PR numbers are always small positive integers
Expand Down
Loading
Loading