Skip to content

Commit

Permalink
Replace --paginate-all with --merge-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@heaths
heaths committed Feb 2, 2024
1 parent 9e5c20b commit ea5b2d3
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 35 deletions.
56 changes: 24 additions & 32 deletions pkg/cmd/api/api.go
View file
Expand Up @@ -37,7 +37,7 @@ type ApiOptions struct {
Config func() (config.Config, error)
HttpClient func() (*http.Client, error)
IO *iostreams.IOStreams
Merger jsonmerge.Merger
merger jsonmerge.Merger

Hostname string
RequestMethod string
Expand All @@ -50,7 +50,7 @@ type ApiOptions struct {
Previews []string
ShowResponseHeaders bool
Paginate bool
PaginateAll bool
MergePages bool
Silent bool
Template string
CacheTTL time.Duration
Expand Down Expand Up @@ -117,9 +117,8 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command
In %[1]s--paginate%[1]s mode, all pages of results will sequentially be requested until
there are no more pages of results. For GraphQL requests, this requires that the
original query accepts an %[1]s$endCursor: String%[1]s variable and that it fetches the
%[1]spageInfo{ hasNextPage, endCursor }%[1]s set of fields from a collection.
Pass %[1]s--paginate-all%[1]s (experimental) instead to merge REST arrays and GraphQL objects
into valid JSON output.
%[1]spageInfo{ hasNextPage, endCursor }%[1]s set of fields from a collection. Each page is a separate
JSON array or object. Pass %[1]s--merge-pages%[1]s to merge all pages into a single JSON array or object.
`, "`"),
Example: heredoc.Doc(`
# list releases in the current repository
Expand Down Expand Up @@ -159,7 +158,7 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command
'
# list all repositories for a user
$ gh api graphql --paginate -f query='
$ gh api graphql --paginate --merge-pages -f query='
query($endCursor: String) {
viewer {
repositories(first: 100, after: $endCursor) {
Expand Down Expand Up @@ -202,24 +201,20 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command
}
}

if opts.shouldPaginate() && !strings.EqualFold(opts.RequestMethod, "GET") && opts.RequestPath != "graphql" {
return cmdutil.FlagErrorf("the `--paginate` and `--paginate-all` options are not supported for non-GET requests")
if opts.Paginate && !strings.EqualFold(opts.RequestMethod, "GET") && opts.RequestPath != "graphql" {
return cmdutil.FlagErrorf("the `--paginate` option is not supported for non-GET requests")
}

if err := cmdutil.MutuallyExclusive(
"the `--paginate` and `--paginate-all` options are not supported with `--input`",
opts.shouldPaginate(),
"the `--paginate` option is not supported with `--input`",
opts.Paginate,
opts.RequestInputFile != "",
); err != nil {
return err
}

if err := cmdutil.MutuallyExclusive(
"specify only one of `--paginate` or `--paginate-all`",
opts.Paginate,
opts.PaginateAll,
); err != nil {
return err
if opts.MergePages && !opts.Paginate {
return cmdutil.FlagErrorf("`--paginate` required when passing `--merge-pages`")
}

if err := cmdutil.MutuallyExclusive(
Expand All @@ -246,8 +241,8 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command
cmd.Flags().StringArrayVarP(&opts.RequestHeaders, "header", "H", nil, "Add a HTTP request header in `key:value` format")
cmd.Flags().StringSliceVarP(&opts.Previews, "preview", "p", nil, "GitHub API preview `names` to request (without the \"-preview\" suffix)")
cmd.Flags().BoolVarP(&opts.ShowResponseHeaders, "include", "i", false, "Include HTTP response status line and headers in the output")
cmd.Flags().BoolVar(&opts.MergePages, "merge-pages", false, "Use with \"--paginate\" to merge all pages of JSON arrays or objects")
cmd.Flags().BoolVar(&opts.Paginate, "paginate", false, "Make additional HTTP requests to fetch all pages of results")
cmd.Flags().BoolVar(&opts.PaginateAll, "paginate-all", false, "[Experimental] Make additional HTTP requests to fetch all pages and merge results")
cmd.Flags().StringVar(&opts.RequestInputFile, "input", "", "The `file` to use as body for the HTTP request (use \"-\" to read from standard input)")
cmd.Flags().BoolVar(&opts.Silent, "silent", false, "Do not print the response body")
cmd.Flags().StringVarP(&opts.Template, "template", "t", "", "Format JSON output using a Go template; see \"gh help formatting\"")
Expand All @@ -257,10 +252,6 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command
return cmd
}

func (opts *ApiOptions) shouldPaginate() bool {
return opts.Paginate || opts.PaginateAll
}

func apiRun(opts *ApiOptions) error {
params, err := parseFields(opts)
if err != nil {
Expand Down Expand Up @@ -294,16 +285,17 @@ func apiRun(opts *ApiOptions) error {
headersWriter = io.Discard
}

if opts.shouldPaginate() && !isGraphQL {
if opts.Paginate && !isGraphQL {
requestPath = addPerPage(requestPath, 100, params)
}

// Merge JSON arrays and objects if paginating without filtering or templating (experimental).
if opts.PaginateAll && opts.FilterOutput == "" && opts.Template == "" {
// Merge JSON arrays and objects if paginating without filtering or templating.
// MergePages retains compatibility with older versions but may be the default behavior with future major releases.
if opts.Paginate && opts.MergePages && opts.FilterOutput == "" && opts.Template == "" {
if isGraphQL {
opts.Merger = jsonmerge.NewObjectMerger(bodyWriter)
opts.merger = jsonmerge.NewObjectMerger(bodyWriter)
} else {
opts.Merger = jsonmerge.NewArrayMerger()
opts.merger = jsonmerge.NewArrayMerger()
}
}

Expand Down Expand Up @@ -391,7 +383,7 @@ func apiRun(opts *ApiOptions) error {
}
isFirstPage = false

if !opts.shouldPaginate() {
if !opts.Paginate {
break
}

Expand All @@ -407,8 +399,8 @@ func apiRun(opts *ApiOptions) error {
}
}

if opts.Merger != nil {
return opts.Merger.Close()
if opts.merger != nil {
return opts.merger.Close()
}

return tmpl.Flush()
Expand Down Expand Up @@ -438,7 +430,7 @@ func processResponse(resp *http.Response, opts *ApiOptions, bodyWriter, headersW
}

var bodyCopy *bytes.Buffer
isGraphQLPaginate := isJSON && resp.StatusCode == 200 && opts.shouldPaginate() && opts.RequestPath == "graphql"
isGraphQLPaginate := isJSON && resp.StatusCode == 200 && opts.Paginate && opts.RequestPath == "graphql"
if isGraphQLPaginate {
bodyCopy = &bytes.Buffer{}
responseBody = io.TeeReader(responseBody, bodyCopy)
Expand All @@ -462,8 +454,8 @@ func processResponse(resp *http.Response, opts *ApiOptions, bodyWriter, headersW
} else if isJSON && opts.IO.ColorEnabled() {
err = jsoncolor.Write(bodyWriter, responseBody, " ")
} else {
if isJSON && opts.Merger != nil && !opts.ShowResponseHeaders {
responseBody = opts.Merger.NewPage(responseBody, isLastPage)
if isJSON && opts.merger != nil && !opts.ShowResponseHeaders {
responseBody = opts.merger.NewPage(responseBody, isLastPage)
}

_, err = io.Copy(bodyWriter, responseBody)
Expand Down
14 changes: 11 additions & 3 deletions pkg/cmd/api/api_test.go
View file
Expand Up @@ -328,6 +328,11 @@ func Test_NewCmdApi(t *testing.T) {
cli: "user --jq .foo -t '{{.foo}}'",
wantsErr: true,
},
{
name: "--merge-pages without --paginate",
cli: "user --merge-pages",
wantsErr: true,
},
{
name: "with verbose",
cli: "user --verbose",
Expand Down Expand Up @@ -801,7 +806,8 @@ func Test_apiRun_paginationREST_merge(t *testing.T) {
RequestMethod: "GET",
RequestMethodPassed: true,
RequestPath: "issues",
PaginateAll: true,
Paginate: true,
MergePages: true,
RawFields: []string{"per_page=50", "page=1"},
}

Expand Down Expand Up @@ -1018,7 +1024,8 @@ func Test_apiRun_arrayPaginationREST_merge(t *testing.T) {
RequestMethod: "GET",
RequestMethodPassed: true,
RequestPath: "issues",
PaginateAll: true,
Paginate: true,
MergePages: true,
RawFields: []string{"per_page=50", "page=1"},
}

Expand Down Expand Up @@ -1185,7 +1192,8 @@ func Test_apiRun_paginationGraphQL_merge(t *testing.T) {
RawFields: []string{"foo=bar"},
RequestMethod: "POST",
RequestPath: "graphql",
PaginateAll: true,
Paginate: true,
MergePages: true,
}

err := apiRun(&options)
Expand Down

0 comments on commit ea5b2d3

Please sign in to comment.