Skip to content

fix: close issue_write state updates with REST #2637

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

Open
he-yufeng wants to merge 1 commit into
base: main
Choose a base branch
from
+47 −20
Open

fix: close issue_write state updates with REST #2637

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
10 changes: 9 additions & 1 deletion pkg/github/issues.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2390,6 +2390,14 @@ func UpdateIssue(ctx context.Context, client *github.Client, gqlClient *githubv4
issueRequest.Type = github.Ptr(issueType)
}

closeWithREST := state == "closed" && stateReason != "duplicate"
if closeWithREST {
issueRequest.State = github.Ptr(state)
if stateReason != "" {
issueRequest.StateReason = github.Ptr(stateReason)
}
}

if len(issueFieldValues) > 0 || len(fieldIDsToDelete) > 0 {
// The REST update endpoint uses "set" semantics — it overwrites all existing
// field values with whatever is sent. Fetch the current values first, merge in
Expand Down Expand Up @@ -2434,7 +2442,7 @@ func UpdateIssue(ctx context.Context, client *github.Client, gqlClient *githubv4
}

// Use GraphQL API for state updates
if state != "" {
if state != "" && !closeWithREST {
// Mandate specifying duplicateOf when trying to close as duplicate
if state == "closed" && stateReason == "duplicate" && duplicateOf == 0 {
return utils.NewToolResultError("duplicate_of must be provided when state_reason is 'duplicate'"), nil
Expand Down
57 changes: 38 additions & 19 deletions pkg/github/issues_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3108,6 +3108,38 @@ func Test_UpdateIssue(t *testing.T) {
expectError: true,
expectedErrMsg: "failed to update issue",
},
{
name: "close issue with labels and completed reason",
mockedRESTClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
PatchReposIssuesByOwnerByRepoByIssueNumber: expectRequestBody(t, map[string]any{
"labels": []any{"infra", "fixed"},
"state": "closed",
"state_reason": "completed",
}).andThen(
mockResponse(t, http.StatusOK, &github.Issue{
Number: github.Ptr(123),
State: github.Ptr("closed"),
StateReason: github.Ptr("completed"),
HTMLURL: github.Ptr("https://github.com/owner/repo/issues/123"),
Labels: []*github.Label{{Name: github.Ptr("infra")}, {Name: github.Ptr("fixed")}},
}),
),
}),
mockedGQLClient: githubv4mock.NewMockedHTTPClient(),
requestArgs: map[string]any{
"method": "update",
"owner": "owner",
"repo": "repo",
"issue_number": float64(123),
"labels": []any{"infra", "fixed"},
"state": "closed",
"state_reason": "completed",
},
expectError: false,
expectedIssue: &github.Issue{
HTMLURL: github.Ptr("https://github.com/owner/repo/issues/123"),
},
},
{
name: "close issue as duplicate",
mockedRESTClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
Expand Down Expand Up @@ -3217,25 +3249,12 @@ func Test_UpdateIssue(t *testing.T) {
{
name: "main issue not found when trying to close it",
mockedRESTClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
PatchReposIssuesByOwnerByRepoByIssueNumber: mockResponse(t, http.StatusOK, mockBaseIssue),
PatchReposIssuesByOwnerByRepoByIssueNumber: http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusNotFound)
_, _ = w.Write([]byte(`{"message": "Not Found"}`))
}),
}),
mockedGQLClient: githubv4mock.NewMockedHTTPClient(
githubv4mock.NewQueryMatcher(
struct {
Repository struct {
Issue struct {
ID githubv4.ID
} `graphql:"issue(number: $issueNumber)"`
} `graphql:"repository(owner: $owner, name: $repo)"`
}{},
map[string]any{
"owner": githubv4.String("owner"),
"repo": githubv4.String("repo"),
"issueNumber": githubv4.Int(999),
},
githubv4mock.ErrorResponse("Could not resolve to an Issue with the number of 999."),
),
),
mockedGQLClient: githubv4mock.NewMockedHTTPClient(),
requestArgs: map[string]any{
"method": "update",
"owner": "owner",
Expand All @@ -3245,7 +3264,7 @@ func Test_UpdateIssue(t *testing.T) {
"state_reason": "not_planned",
},
expectError: true,
expectedErrMsg: "Failed to find issues",
expectedErrMsg: "failed to update issue",
},
{
name: "duplicate issue not found when closing as duplicate",
Expand Down