Skip to content

fix(issue list): reject pull request-only search qualifiers #12623

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
LouisLau-art wants to merge 1 commit into
base: trunk
Choose a base branch
from
+26 −0
Open

fix(issue list): reject pull request-only search qualifiers #12623

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
7 changes: 7 additions & 0 deletions pkg/cmd/issue/list/http.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,16 @@ package list

import (
"fmt"
"regexp"

"github.com/cli/cli/v2/api"
fd "github.com/cli/cli/v2/internal/featuredetection"
"github.com/cli/cli/v2/internal/ghrepo"
prShared "github.com/cli/cli/v2/pkg/cmd/pr/shared"
)

var pullRequestSearchQualifierRE = regexp.MustCompile(`(?i)\b(?:is|type):(?:pr|pull-?request)\b`)

func listIssues(client *api.Client, repo ghrepo.Interface, filters prShared.FilterOptions, limit int) (*api.IssuesAndTotalCount, error) {
var states []string
switch filters.State {
Expand Down Expand Up @@ -114,6 +117,10 @@ loop:
}

func searchIssues(client *api.Client, detector fd.Detector, repo ghrepo.Interface, filters prShared.FilterOptions, limit int) (*api.IssuesAndTotalCount, error) {
if pullRequestSearchQualifierRE.MatchString(filters.Search) {
return nil, fmt.Errorf("cannot use pull request search qualifiers with `gh issue list`; use `gh pr list` instead")
}

// TODO advancedIssueSearchCleanup
// We won't need feature detection when GHES 3.17 support ends, since
// the advanced issue search is the only available search backend for
Expand Down
19 changes: 19 additions & 0 deletions pkg/cmd/issue/list/http_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,3 +214,22 @@ func TestSearchIssuesAndAdvancedSearch(t *testing.T) {
})
}
}

func TestSearchIssues_rejectsPullRequestQualifiers(t *testing.T) {
reg := &httpmock.Registry{}
defer reg.Verify(t)

httpClient := &http.Client{Transport: reg}
client := api.NewClientFromHTTP(httpClient)

_, err := searchIssues(
client,
fd.AdvancedIssueSearchSupportedAsOnlyBackend(),
ghrepo.New("OWNER", "REPO"),
prShared.FilterOptions{Search: "is:pr"},
30,
)

assert.EqualError(t, err, "cannot use pull request search qualifiers with `gh issue list`; use `gh pr list` instead")
assert.Len(t, reg.Requests, 0)
}