feat: adds option to increase rover's client timeout #838
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Jesse Rosenberger <git@jro.cc>
Co-authored-by: Jesse Rosenberger <git@jro.cc>
883f679 to
88b41d2
Compare
o0Ignition0o
approved these changes
Sep 23, 2021
cecton
reviewed
Sep 23, 2021
- cleans up request errors by properly assigning codes and suggestions - local import for backoff crate - const the cfg!(test) check
|
Thanks for the reviews all - appreciate the help, this already looks much better 😄 |
6960c69 to
1bdf2f4
Compare
|
|
||
| ## Increase the client timeout | ||
|
|
||
| Sometimes, you may want to make queries for large amounts of data that may take some extra time for the Studio API to process. |
There was a problem hiding this comment.
Recommendation (feel free to adjust anything I've gotten a little wrong or you disagree with):
Increasing request timeouts
By default, Rover times out requests to the Apollo Studio API after 30 seconds. If you're executing a command that might take longer than 30 seconds to process, you can increase this timeout with the --client-timeout option:
rover lengthy command (whatever that would be) --client-timeout=60 # in seconds| @@ -246,3 +246,9 @@ Some build errors are part of normal workflows. For instance, you may need to pu | |||
|
|
|||
| This error occurs when an operation check fails. This means that you proposed a schema that would break operations in use by existing clients. You can configure this behavior in the Checks -> Configuration view in [Apollo Studio](https://studio.apollographql.com/), and you can read more about client checks [here](https://www.apollographql.com/docs/studio/schema-checks/). | |||
|
|
|||
| ### E031 | |||
|
|
|||
| This error occurs when Rover made an HTTP(S) request and it timed out. | |||
There was a problem hiding this comment.
"made an HTTP request that timed out." <- I'm not too stressed about needing to include the (S)
|
|
||
| This error occurs when Rover made an HTTP(S) request and it timed out. | ||
|
|
||
| The client timeout that Rover sets is configurable. You can try increasing the number of seconds Rover will wait to timeout with the `--client-timeout` flag, but it's also possible that you've made a request for too much data from the Studio API, or that the Studio API is experiencing degraded performance. You can check for the latter at our [status page](https://status.apollographql.com). |
There was a problem hiding this comment.
"You can increase Rover's request timeout, but it's also possible..."
"You can check for known performance issues on our status page"
There was a problem hiding this comment.
That link would point to the new section in configuring.md
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #792 by providing an option for configuring Rover's HTTP client timeout in seconds, and adding a new error code
E031for when HTTP(S) operations time out.From the docs attached to this PR (I'm not sure why Netlify didn't make a preview deploy... maybe because I didn't branch off of
main?)Increase the client timeout
Sometimes, you may want to make queries for large amounts of data that may take some extra time for the Studio API to process.
Rover supports increasing the client timeout in cases like this with the
--client-timeoutoption, which takes a number of seconds as a parameter. By default, Rover will time out requests after 30 seconds.