Support for --silent flag in api #1283
Conversation
| } | ||
|
|
||
| if opts.Silent { | ||
| opts.IO.Out = ioutil.Discard |
There was a problem hiding this comment.
This is a neat trick! But, since parsing response JSON will take some processing time and will ultimately be discarded, could you instead skip the body processing logic in "silent" mode and exit from the command early?
There was a problem hiding this comment.
On the other hand, I just realized that the response body needs to be first consumed in order for our response error processing logic to work. So, maybe discard my above comment please, as following my suggestion might lead to too many code changes. I'll leave it to you!
There was a problem hiding this comment.
I think this Discard option is better than some complex logic. I agree with you on the error handling part. Even if I put the custom logic and all, it will become too bloated, and will cause problems down the line also, in case we need to add/change some feature/working.
pkg/cmd/api/api.go
Outdated
|
|
||
| func processResponse(resp *http.Response, opts *ApiOptions) (endCursor string, err error) { | ||
| if opts.ShowResponseHeaders { | ||
| if opts.ShowResponseHeaders && !opts.Silent { |
There was a problem hiding this comment.
I don't think we need to change this conditional. In fact, if someone requested response headers, let's display them even in --silent mode. Maybe there is some use-case for that, and I think it's safe to allow because both -i and --silent flags are explicitly opt-in.
There was a problem hiding this comment.
Right. Makes sense. I will remove that.
pkg/cmd/api/api_test.go
Outdated
| assert.Equal(t, "PAGE1_END", endCursor) | ||
| } | ||
|
|
||
| func Test_apiRun_silent(t *testing.T) { |
There was a problem hiding this comment.
Instead of adding a separate test function, could you add the Silent: true mode as another test case in Test_apiRun please?
There was a problem hiding this comment.
Oh. Right. I will do that!
pkg/cmd/api/api.go
Outdated
| cmd.Flags().BoolVarP(&opts.ShowResponseHeaders, "include", "i", false, "Include HTTP response headers in the output") | ||
| cmd.Flags().BoolVar(&opts.Paginate, "paginate", false, "Make additional HTTP requests to fetch all pages of results") | ||
| cmd.Flags().StringVar(&opts.RequestInputFile, "input", "", "The file to use as body for the HTTP request") | ||
| cmd.Flags().BoolVar(&opts.Silent, "silent", false, "Silence the output") |
There was a problem hiding this comment.
Let's try to be more descriptive here: how does “Do not print response body" sound? The goal would be to describe what "silence" means in this case, since the word could be ambiguous
Show Response Headers (if requested) even with `--silent` flag Shift silent tests to `Test_apiRun` Changed usage string of `--silent` flag
Summary
closes #1188