lostisland/faraday

Distinguish TimeoutErrors for open and read timeouts

Open

#718 opened on Aug 9, 2017

View on GitHub
 (33 comments) (1 reaction) (0 assignees)Ruby (5,861 stars) (997 forks)batch import
featurehelp wanted

Description

In faraday/adapter/rack.rb, TimeoutError is raised for both open and read timeouts:

timeout  = env[:request][:timeout] || env[:request][:open_timeout]
response = if timeout
  Timer.timeout(timeout, Faraday::Error::TimeoutError) { execute_request(env, rack_env) }
else ... end

According to https://stackoverflow.com/questions/10322283/what-is-timeout-and-open-timeout-in-faraday, open_timeout is for the tcp connection and timeout is for the response read.

It would be nice to have separate exception types for these timeouts. Then we could determine whether or not to retry the request. Does adding something like Faraday::Error::OpenTimeoutError and Faraday::Error::ResponseTimeoutError and using those here make sense?

Contributor guide

Tech stack
ruby
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
RubyFaraday basicsHTTP timeout concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the existing error hierarchy in Faraday, specifically Faraday::Error::TimeoutError. Consider adding two new exception classes: OpenTimeoutError and ResponseTimeoutError inheriting from TimeoutError. Update faraday/adapter/rack.rb to use the appropriate exception for open timeout and read timeout. Also check other adapters (e.g., net http) for similar patterns. Review comments in the issue for any discussion on naming or implementation details.