STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Avoid using error values to pass information about the search cap

Browse source
This commit is contained in:
Mislav Marohnić 2021-09-06 16:00:31 +02:00
parent e8b015b80d
commit 619333adb6
10 changed files with 27 additions and 67 deletions
Download patch file Download diff file Expand all files Collapse all files

5
api/client.go
View file

@ -3,7 +3,6 @@ package api
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
@ -17,10 +16,6 @@ import (
"github.com/shurcooL/graphql"
)
// The Search API returns a max of 1000 results for each search.
// (https://docs.github.com/en/rest/reference/search#about-the-search-api)
var ErrSearchAPIMaxLimit = errors.New("limit was set to >1000 but Github search API returns max 1000 results")
// ClientOption represents an argument to NewClient
type ClientOption = func(http.RoundTripper) http.RoundTripper

5
api/queries_issue.go
View file

@ -16,8 +16,9 @@ type IssuesPayload struct {
}
type IssuesAndTotalCount struct {
Issues []Issue
TotalCount int
Issues []Issue
TotalCount int
SearchCapped bool
}
type Issue struct {

1
api/queries_pr.go
View file

@ -26,6 +26,7 @@ type PullRequestsPayload struct {
type PullRequestAndTotalCount struct {
TotalCount int
PullRequests []PullRequest
SearchCapped bool
}
type PullRequest struct {

7
pkg/cmd/issue/list/http.go
View file

@ -126,11 +126,6 @@ loop:
}
res := api.IssuesAndTotalCount{Issues: issues, TotalCount: totalCount}
if limit > 1000 {
return &res, api.ErrSearchAPIMaxLimit
}
return &res, nil
}
@ -176,7 +171,7 @@ func searchIssues(client *api.Client, repo ghrepo.Interface, filters prShared.Fi
"query": searchQuery,
}
ic := api.IssuesAndTotalCount{}
ic := api.IssuesAndTotalCount{SearchCapped: limit > 1000}
loop:
for {

18
pkg/cmd/issue/list/list.go
View file

@ -151,9 +151,9 @@ func listRun(opts *ListOptions) error {
filterOptions.Fields = opts.Exporter.Fields()
}
listResult, listErr := issueList(httpClient, baseRepo, filterOptions, opts.LimitResults)
if listErr != nil && listErr != api.ErrSearchAPIMaxLimit {
return listErr
listResult, err := issueList(httpClient, baseRepo, filterOptions, opts.LimitResults)
if err != nil {
return err
}
err = opts.IO.StartPager()
@ -166,16 +166,12 @@ func listRun(opts *ListOptions) error {
return opts.Exporter.Write(opts.IO, listResult.Issues)
}
if listResult.SearchCapped {
fmt.Fprintln(opts.IO.ErrOut, "warning: this query uses the Search API which is capped at 1000 results maximum")
}
if isTerminal {
title := prShared.ListHeader(ghrepo.FullName(baseRepo), "issue", len(listResult.Issues), listResult.TotalCount, !filterOptions.IsDefault())
out := fmt.Sprintf("\n%s\n", title)
if listErr == api.ErrSearchAPIMaxLimit {
icon := opts.IO.ColorScheme().WarningIcon()
out = fmt.Sprintf("%s%s warning: %s\n", out, icon, listErr.Error())
}
fmt.Fprintf(opts.IO.Out, "%s\n", out)
fmt.Fprintf(opts.IO.Out, "\n%s\n\n", title)
}
issueShared.PrintIssues(opts.IO, "", len(listResult.Issues), listResult.Issues)

7
pkg/cmd/pr/list/http.go
View file

@ -182,8 +182,7 @@ func searchPullRequests(httpClient *http.Client, repo ghrepo.Interface, filters
"q": q.String(),
}
res := api.PullRequestAndTotalCount{}
res := api.PullRequestAndTotalCount{SearchCapped: limit > 1000}
var check = make(map[int]struct{})
client := api.NewClientFromHTTP(httpClient)
@ -218,10 +217,6 @@ loop:
}
}
if limit > 1000 {
return &res, api.ErrSearchAPIMaxLimit
}
return &res, nil
}

11
pkg/cmd/pr/list/http_test.go
View file

@ -144,17 +144,6 @@ func Test_listPullRequests(t *testing.T) {
}))
},
},
{
name: "with labels and limit above 1000",
args: args{
repo: ghrepo.New("OWNER", "REPO"),
limit: 2000,
filters: prShared.FilterOptions{
Labels: []string{"hello", "one world"},
},
},
wantErr: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {

18
pkg/cmd/pr/list/list.go
View file

@ -151,9 +151,9 @@ func listRun(opts *ListOptions) error {
return opts.Browser.Browse(openURL)
}
listResult, listErr := listPullRequests(httpClient, baseRepo, filters, opts.LimitResults)
if listErr != nil && listErr != api.ErrSearchAPIMaxLimit {
return listErr
listResult, err := listPullRequests(httpClient, baseRepo, filters, opts.LimitResults)
if err != nil {
return err
}
err = opts.IO.StartPager()
@ -166,16 +166,12 @@ func listRun(opts *ListOptions) error {
return opts.Exporter.Write(opts.IO, listResult.PullRequests)
}
if listResult.SearchCapped {
fmt.Fprintln(opts.IO.ErrOut, "warning: this query uses the Search API which is capped at 1000 results maximum")
}
if opts.IO.IsStdoutTTY() {
title := shared.ListHeader(ghrepo.FullName(baseRepo), "pull request", len(listResult.PullRequests), listResult.TotalCount, !filters.IsDefault())
out := fmt.Sprintf("\n%s\n", title)
if listErr == api.ErrSearchAPIMaxLimit {
icon := opts.IO.ColorScheme().WarningIcon()
out = fmt.Sprintf("%s%s warning: %s\n", out, icon, listErr.Error())
}
fmt.Fprintln(opts.IO.Out, out)
fmt.Fprintf(opts.IO.Out, "\n%s\n\n", title)
}
cs := opts.IO.ColorScheme()

4
pkg/cmd/repo/list/http.go
View file

@ -175,10 +175,6 @@ pagination:
variables["endCursor"] = githubv4.String(result.Search.PageInfo.EndCursor)
}
if limit > 1000 {
return &listResult, api.ErrSearchAPIMaxLimit
}
return &listResult, nil
}

18
pkg/cmd/repo/list/list.go
View file

@ -130,9 +130,9 @@ func listRun(opts *ListOptions) error {
return err
}
listResult, listErr := listRepos(httpClient, host, opts.Limit, opts.Owner, filter)
if listErr != nil {
return listErr
listResult, err := listRepos(httpClient, host, opts.Limit, opts.Owner, filter)
if err != nil {
return err
}
if err := opts.IO.StartPager(); err != nil {
@ -171,17 +171,13 @@ func listRun(opts *ListOptions) error {
tp.EndRow()
}
if listResult.FromSearch && opts.Limit > 1000 {
fmt.Fprintln(opts.IO.ErrOut, "warning: this query uses the Search API which is capped at 1000 results maximum")
}
if opts.IO.IsStdoutTTY() {
hasFilters := filter.Visibility != "" || filter.Fork || filter.Source || filter.Language != "" || filter.Topic != ""
title := listHeader(listResult.Owner, len(listResult.Repositories), listResult.TotalCount, hasFilters)
out := fmt.Sprintf("\n%s\n", title)
if listErr == api.ErrSearchAPIMaxLimit {
icon := opts.IO.ColorScheme().WarningIcon()
out = fmt.Sprintf("%s%s warning: %s\n", out, icon, listErr.Error())
}
fmt.Fprintln(opts.IO.Out, out)
fmt.Fprintf(opts.IO.Out, "\n%s\n\n", title)
}
return tp.Render()