Configurable http_timeout on API requests
#70
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
jylamont
force-pushed
the
feature/rest_client_timeout
branch
2 times, most recently
from
a315a22 to
5724560
Compare
jylamont
changed the base branch from
master
to
04-17-improve_added_github_action_ci
jylamont
force-pushed
the
feature/rest_client_timeout
branch
from
5724560 to
3b7c4ca
Compare
This stack of pull requests is managed by Graphite. Learn more about stacking. |
This was referenced Apr 17, 2024
Merged
Merged
jylamont
force-pushed
the
feature/rest_client_timeout
branch
2 times, most recently
from
91166c4 to
a3dd975
Compare
jylamont
force-pushed
the
04-17-improve_added_github_action_ci
branch
from
ea3dfee to
e4579a9
Compare
jylamont
force-pushed
the
feature/rest_client_timeout
branch
from
a3dd975 to
046d486
Compare
jylamont
force-pushed
the
04-17-improve_added_github_action_ci
branch
from
e4579a9 to
a3c498e
Compare
jylamont
force-pushed
the
feature/rest_client_timeout
branch
from
046d486 to
8c632a0
Compare
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
Comment on lines
+73
to
94
| def do_request(method, a_url, params) | ||
| raise ArgumentError, ":method must be one of the follow: #{ALLOWED_HTTP_METHODS.join(', ')}" unless ALLOWED_HTTP_METHODS.include?(method) | ||
|
|
||
| rest_client_args = { | ||
| method: method, | ||
| url: a_url, | ||
| timeout: http_timeout | ||
| } | ||
|
|
||
| if method == :get | ||
| rest_client_args.merge!(headers: { params: params }) | ||
| else | ||
| rest_client_args.merge!(payload: JSON.dump(params), headers: { content_type: :json, accept: :json }) | ||
| end | ||
|
|
||
| def request_content_type | ||
| { content_type: :json, accept: :json } | ||
| RestClient::Request.execute( | ||
| method: method, | ||
| url: a_url, | ||
| headers: { params: params }, | ||
| timeout: http_timeout | ||
| ) | ||
| end |
There was a problem hiding this comment.
The do_request method builds a rest_client_args hash with the correct configuration, but then ignores it in favor of a hardcoded RestClient::Request.execute call. The method should use the prepared arguments by passing them directly:
RestClient::Request.execute(rest_client_args)This would properly apply all the configured options including the correct headers and payload formatting.
Spotted by Graphite Reviewer
Is this helpful? React 👍 or 👎 to let us know.
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.
This PR adds support for setting a timeout for executing API requests. By default, it will use 60 seconds (which is also the default RestClient uses) but this can be changed by setting
config.http_timeout = xxxto the desired number of seconds. To support this feature, the code calling RestClient had to be fully refactored.Fixes #63