LG-643 Add timeout to Twilio API calls#2491
Merged
Conversation
03dbd71 to
95db7d7
Compare
Contributor
|
This looks good but you've upset code climate. Since the classes that it is angry about are mocking Twilio's API we should be good to ignore those. |
Contributor
Author
|
Yeah, I thought it was Reek, but I think it's the top-level Code Climate |
**Why**: It is a best practice — some might say a requirement — to add a timeout to all network requests. Without a timeout, some requests could tie up an app server for literally more than 15 minutes, as reported by New Relic. **How**: - Define an `http_client` with a configurable timeout option and modify the Twilio REST client to use this `http_client` - Rescue the `Faraday::TimeoutError` in the Twilio service class, and raise a custom Twilio error that the 2FA controller can process to display a helpful message to the user and make it easier for them to try again. **How to test locally*: - Run `bundle open twilio-ruby` to open the gem in your text editor - In `lib/twilio-ruby/rest/api.rb` change the value of `@base_url` to `'https://httpstat.us'`, and `@host` to `'httpstat.us'` - In `lib/twilio-ruby/rest/api/v2010.rb`, change the value of `@version` to an empty string - In `lib/twilio-ruby/rest/api/v2010/account/message.rb`, on line 27, change the value of `@uri` to `"/200"`. On line 120, replace the `payload` with this: ```ruby payload = @version.create( 'GET', @uri, data: data, params: { sleep: '10000' } ) ``` - Run `bundle list twilio-ruby` to get the path to the gem - Copy the path of the gem and update the Gemfile to point to your local gem: `gem 'twilio-ruby', path: [path_to_gem]` - Run `bundle update twilio-ruby` - In your local `application.yml`, set `telephony_disabled` to `'false'` - Run `make run` - Create an account and use your real phone number for 2FA (to minimize the chances of spamming someone else's phone). You should see a flash message saying the server took too long after you enter your phone number.
95db7d7 to
778aed3
Compare
Contributor
|
Ah lame. Oh well, if not we can do an admin merge to push past it. |
jmhooper
approved these changes
Sep 6, 2018
12 tasks
This file contains hidden or 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
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.
Why: It is a best practice — some might say a requirement — to add a
timeout to all network requests. Without a timeout, some requests could
tie up an app server for literally more than 15 minutes, as reported by
New Relic.
How:
http_clientwith a configurable timeout option and modifythe Twilio REST client to use this
http_clientFaraday::TimeoutErrorin the Twilio service class, andraise a custom Twilio error that the 2FA controller can process to
display a helpful message to the user and make it easier for them to try
again.
*How to test locally:
bundle open twilio-rubyto open the gem in your text editorlib/twilio-ruby/rest/api.rbchange the value of@base_urlto'https://httpstat.us', and@hostto'httpstat.us'lib/twilio-ruby/rest/api/v2010.rb, change the value of@versionto an empty string
lib/twilio-ruby/rest/api/v2010/account/message.rb, on line 27,change the value of
@urito"/200". On line 120, replace thepayloadwith this:bundle list twilio-rubyto get the path to the gemgem:
gem 'twilio-ruby', path: [path_to_gem]bundle update twilio-rubyapplication.yml, settelephony_disabledto'false'make runthe chances of spamming someone else's phone). You should see a flash
message saying the server took too long after you enter your phone
number.
Hi! Before submitting your PR for review, and/or before merging it, please
go through the checklists below. These represent the more critical elements
of our code quality guidelines. The rest of the list can be found in
CONTRIBUTING.md
When adding a new controller that requires the user to be fully
authenticated, make sure to add
before_action :confirm_two_factor_authenticatedas the first callback.
Unsafe migrations are implemented over several PRs and over several
deploys to avoid production errors. The strong_migrations gem
will warn you about unsafe migrations and has great step-by-step instructions
for various scenarios.
Indexes were added if necessary. This article provides a good overview
of indexes in Rails.
Verified that the changes don't affect other apps (such as the dashboard)
When relevant, a rake task is created to populate the necessary DB columns
in the various environments right before deploying, taking into account the users
who might not have interacted with this column yet (such as users who have not
set a password yet)
Migrations against existing tables have been tested against a copy of the
production database. See LG-228 Make migrations safer and more resilient #2127 for an example when a migration caused deployment
issues. In that case, all the migration did was add a new column and an index to
the Users table, which might seem innocuous.
The changes are compatible with data that was encrypted with the old code.
GET requests are not vulnerable to CSRF attacks (i.e. they don't change
state or result in destructive behavior).
When adding user data to the session, use the
user_sessionhelperinstead of the
sessionhelper so the data does not persist beyond the user'ssession.
Tests added for this feature/bug
Prefer feature/integration specs over controller specs
When adding code that reads data, write tests for nil values, empty strings,
and invalid inputs.