faraday 1.8.0 → 2.7.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +197 -3
- data/LICENSE.md +1 -1
- data/README.md +18 -16
- data/examples/client_spec.rb +41 -19
- data/examples/client_test.rb +48 -22
- data/lib/faraday/adapter/test.rb +59 -10
- data/lib/faraday/adapter.rb +5 -9
- data/lib/faraday/connection.rb +47 -129
- data/lib/faraday/encoders/nested_params_encoder.rb +13 -6
- data/lib/faraday/error.rb +3 -8
- data/lib/faraday/logging/formatter.rb +19 -2
- data/lib/faraday/middleware.rb +3 -1
- data/lib/faraday/middleware_registry.rb +17 -63
- data/lib/faraday/options/env.rb +31 -7
- data/lib/faraday/options/ssl_options.rb +11 -1
- data/lib/faraday/options.rb +3 -3
- data/lib/faraday/rack_builder.rb +23 -20
- data/lib/faraday/request/authorization.rb +33 -41
- data/lib/faraday/request/instrumentation.rb +2 -0
- data/lib/faraday/request/json.rb +55 -0
- data/lib/faraday/request/url_encoded.rb +5 -1
- data/lib/faraday/request.rb +12 -32
- data/lib/faraday/response/json.rb +54 -0
- data/lib/faraday/response/logger.rb +8 -4
- data/lib/faraday/response/raise_error.rb +9 -1
- data/lib/faraday/response.rb +10 -20
- data/lib/faraday/utils/headers.rb +7 -2
- data/lib/faraday/utils.rb +10 -5
- data/lib/faraday/version.rb +1 -1
- data/lib/faraday.rb +10 -38
- data/spec/faraday/adapter/test_spec.rb +65 -0
- data/spec/faraday/connection_spec.rb +163 -91
- data/spec/faraday/middleware_registry_spec.rb +31 -0
- data/spec/faraday/middleware_spec.rb +18 -0
- data/spec/faraday/options/env_spec.rb +8 -2
- data/spec/faraday/params_encoders/nested_spec.rb +8 -0
- data/spec/faraday/rack_builder_spec.rb +26 -54
- data/spec/faraday/request/authorization_spec.rb +50 -28
- data/spec/faraday/request/instrumentation_spec.rb +5 -7
- data/spec/faraday/request/json_spec.rb +111 -0
- data/spec/faraday/request/url_encoded_spec.rb +12 -2
- data/spec/faraday/request_spec.rb +5 -15
- data/spec/faraday/response/json_spec.rb +117 -0
- data/spec/faraday/response/logger_spec.rb +28 -0
- data/spec/faraday/response/raise_error_spec.rb +7 -4
- data/spec/faraday/response_spec.rb +3 -1
- data/spec/faraday/utils/headers_spec.rb +22 -4
- data/spec/faraday/utils_spec.rb +63 -1
- data/spec/support/fake_safe_buffer.rb +1 -1
- data/spec/support/helper_methods.rb +0 -37
- data/spec/support/shared_examples/adapter.rb +2 -2
- data/spec/support/shared_examples/request_method.rb +22 -21
- metadata +14 -143
- data/lib/faraday/adapter/typhoeus.rb +0 -15
- data/lib/faraday/autoload.rb +0 -87
- data/lib/faraday/dependency_loader.rb +0 -37
- data/lib/faraday/file_part.rb +0 -128
- data/lib/faraday/param_part.rb +0 -53
- data/lib/faraday/request/basic_authentication.rb +0 -20
- data/lib/faraday/request/multipart.rb +0 -106
- data/lib/faraday/request/retry.rb +0 -239
- data/lib/faraday/request/token_authentication.rb +0 -20
- data/spec/faraday/adapter/em_http_spec.rb +0 -49
- data/spec/faraday/adapter/em_synchrony_spec.rb +0 -18
- data/spec/faraday/adapter/excon_spec.rb +0 -49
- data/spec/faraday/adapter/httpclient_spec.rb +0 -73
- data/spec/faraday/adapter/net_http_spec.rb +0 -64
- data/spec/faraday/adapter/patron_spec.rb +0 -18
- data/spec/faraday/adapter/rack_spec.rb +0 -8
- data/spec/faraday/adapter/typhoeus_spec.rb +0 -7
- data/spec/faraday/composite_read_io_spec.rb +0 -80
- data/spec/faraday/request/multipart_spec.rb +0 -302
- data/spec/faraday/request/retry_spec.rb +0 -242
- data/spec/faraday/response/middleware_spec.rb +0 -68
- data/spec/support/webmock_rack_app.rb +0 -68
@@ -1,242 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
RSpec.describe Faraday::Request::Retry do
|
4
|
-
let(:calls) { [] }
|
5
|
-
let(:times_called) { calls.size }
|
6
|
-
let(:options) { [] }
|
7
|
-
let(:conn) do
|
8
|
-
Faraday.new do |b|
|
9
|
-
b.request :retry, *options
|
10
|
-
|
11
|
-
b.adapter :test do |stub|
|
12
|
-
%w[get post].each do |method|
|
13
|
-
stub.send(method, '/unstable') do |env|
|
14
|
-
calls << env.dup
|
15
|
-
env[:body] = nil # simulate blanking out response body
|
16
|
-
callback.call
|
17
|
-
end
|
18
|
-
end
|
19
|
-
end
|
20
|
-
end
|
21
|
-
end
|
22
|
-
|
23
|
-
context 'when an unexpected error happens' do
|
24
|
-
let(:callback) { -> { raise 'boom!' } }
|
25
|
-
|
26
|
-
before { expect { conn.get('/unstable') }.to raise_error(RuntimeError) }
|
27
|
-
|
28
|
-
it { expect(times_called).to eq(1) }
|
29
|
-
|
30
|
-
context 'and this is passed as a custom exception' do
|
31
|
-
let(:options) { [{ exceptions: StandardError }] }
|
32
|
-
|
33
|
-
it { expect(times_called).to eq(3) }
|
34
|
-
end
|
35
|
-
end
|
36
|
-
|
37
|
-
context 'when an expected error happens' do
|
38
|
-
let(:callback) { -> { raise Errno::ETIMEDOUT } }
|
39
|
-
|
40
|
-
before do
|
41
|
-
@started = Time.now
|
42
|
-
expect { conn.get('/unstable') }.to raise_error(Errno::ETIMEDOUT)
|
43
|
-
end
|
44
|
-
|
45
|
-
it { expect(times_called).to eq(3) }
|
46
|
-
|
47
|
-
context 'and legacy max_retry set to 1' do
|
48
|
-
let(:options) { [1] }
|
49
|
-
|
50
|
-
it { expect(times_called).to eq(2) }
|
51
|
-
end
|
52
|
-
|
53
|
-
context 'and legacy max_retry set to -9' do
|
54
|
-
let(:options) { [-9] }
|
55
|
-
|
56
|
-
it { expect(times_called).to eq(1) }
|
57
|
-
end
|
58
|
-
|
59
|
-
context 'and new max_retry set to 3' do
|
60
|
-
let(:options) { [{ max: 3 }] }
|
61
|
-
|
62
|
-
it { expect(times_called).to eq(4) }
|
63
|
-
end
|
64
|
-
|
65
|
-
context 'and new max_retry set to -9' do
|
66
|
-
let(:options) { [{ max: -9 }] }
|
67
|
-
|
68
|
-
it { expect(times_called).to eq(1) }
|
69
|
-
end
|
70
|
-
|
71
|
-
context 'and both max_retry and interval are set' do
|
72
|
-
let(:options) { [{ max: 2, interval: 0.1 }] }
|
73
|
-
|
74
|
-
it { expect(Time.now - @started).to be_within(0.04).of(0.2) }
|
75
|
-
end
|
76
|
-
end
|
77
|
-
|
78
|
-
context 'when no exception raised' do
|
79
|
-
let(:options) { [{ max: 1, retry_statuses: 429 }] }
|
80
|
-
|
81
|
-
before { conn.get('/unstable') }
|
82
|
-
|
83
|
-
context 'and response code is in retry_statuses' do
|
84
|
-
let(:callback) { -> { [429, {}, ''] } }
|
85
|
-
|
86
|
-
it { expect(times_called).to eq(2) }
|
87
|
-
end
|
88
|
-
|
89
|
-
context 'and response code is not in retry_statuses' do
|
90
|
-
let(:callback) { -> { [503, {}, ''] } }
|
91
|
-
|
92
|
-
it { expect(times_called).to eq(1) }
|
93
|
-
end
|
94
|
-
end
|
95
|
-
|
96
|
-
describe '#calculate_retry_interval' do
|
97
|
-
context 'with exponential backoff' do
|
98
|
-
let(:options) { { max: 5, interval: 0.1, backoff_factor: 2 } }
|
99
|
-
let(:middleware) { Faraday::Request::Retry.new(nil, options) }
|
100
|
-
|
101
|
-
it { expect(middleware.send(:calculate_retry_interval, 5)).to eq(0.1) }
|
102
|
-
it { expect(middleware.send(:calculate_retry_interval, 4)).to eq(0.2) }
|
103
|
-
it { expect(middleware.send(:calculate_retry_interval, 3)).to eq(0.4) }
|
104
|
-
end
|
105
|
-
|
106
|
-
context 'with exponential backoff and max_interval' do
|
107
|
-
let(:options) { { max: 5, interval: 0.1, backoff_factor: 2, max_interval: 0.3 } }
|
108
|
-
let(:middleware) { Faraday::Request::Retry.new(nil, options) }
|
109
|
-
|
110
|
-
it { expect(middleware.send(:calculate_retry_interval, 5)).to eq(0.1) }
|
111
|
-
it { expect(middleware.send(:calculate_retry_interval, 4)).to eq(0.2) }
|
112
|
-
it { expect(middleware.send(:calculate_retry_interval, 3)).to eq(0.3) }
|
113
|
-
it { expect(middleware.send(:calculate_retry_interval, 2)).to eq(0.3) }
|
114
|
-
end
|
115
|
-
|
116
|
-
context 'with exponential backoff and interval_randomness' do
|
117
|
-
let(:options) { { max: 2, interval: 0.1, interval_randomness: 0.05 } }
|
118
|
-
let(:middleware) { Faraday::Request::Retry.new(nil, options) }
|
119
|
-
|
120
|
-
it { expect(middleware.send(:calculate_retry_interval, 2)).to be_between(0.1, 0.105) }
|
121
|
-
end
|
122
|
-
end
|
123
|
-
|
124
|
-
context 'when method is not idempotent' do
|
125
|
-
let(:callback) { -> { raise Errno::ETIMEDOUT } }
|
126
|
-
|
127
|
-
before { expect { conn.post('/unstable') }.to raise_error(Errno::ETIMEDOUT) }
|
128
|
-
|
129
|
-
it { expect(times_called).to eq(1) }
|
130
|
-
end
|
131
|
-
|
132
|
-
describe 'retry_if option' do
|
133
|
-
let(:callback) { -> { raise Errno::ETIMEDOUT } }
|
134
|
-
let(:options) { [{ retry_if: @check }] }
|
135
|
-
|
136
|
-
it 'retries if retry_if block always returns true' do
|
137
|
-
body = { foo: :bar }
|
138
|
-
@check = ->(_, _) { true }
|
139
|
-
expect { conn.post('/unstable', body) }.to raise_error(Errno::ETIMEDOUT)
|
140
|
-
expect(times_called).to eq(3)
|
141
|
-
expect(calls.all? { |env| env[:body] == body }).to be_truthy
|
142
|
-
end
|
143
|
-
|
144
|
-
it 'does not retry if retry_if block returns false checking env' do
|
145
|
-
@check = ->(env, _) { env[:method] != :post }
|
146
|
-
expect { conn.post('/unstable') }.to raise_error(Errno::ETIMEDOUT)
|
147
|
-
expect(times_called).to eq(1)
|
148
|
-
end
|
149
|
-
|
150
|
-
it 'does not retry if retry_if block returns false checking exception' do
|
151
|
-
@check = ->(_, exception) { !exception.is_a?(Errno::ETIMEDOUT) }
|
152
|
-
expect { conn.post('/unstable') }.to raise_error(Errno::ETIMEDOUT)
|
153
|
-
expect(times_called).to eq(1)
|
154
|
-
end
|
155
|
-
|
156
|
-
it 'FilePart: should rewind files on retry' do
|
157
|
-
io = StringIO.new('Test data')
|
158
|
-
filepart = Faraday::FilePart.new(io, 'application/octet/stream')
|
159
|
-
|
160
|
-
rewound = 0
|
161
|
-
rewind = -> { rewound += 1 }
|
162
|
-
|
163
|
-
@check = ->(_, _) { true }
|
164
|
-
allow(filepart).to receive(:rewind, &rewind)
|
165
|
-
expect { conn.post('/unstable', file: filepart) }.to raise_error(Errno::ETIMEDOUT)
|
166
|
-
expect(times_called).to eq(3)
|
167
|
-
expect(rewound).to eq(2)
|
168
|
-
end
|
169
|
-
|
170
|
-
it 'UploadIO: should rewind files on retry' do
|
171
|
-
io = StringIO.new('Test data')
|
172
|
-
upload_io = Faraday::UploadIO.new(io, 'application/octet/stream')
|
173
|
-
|
174
|
-
rewound = 0
|
175
|
-
rewind = -> { rewound += 1 }
|
176
|
-
|
177
|
-
@check = ->(_, _) { true }
|
178
|
-
allow(upload_io).to receive(:rewind, &rewind)
|
179
|
-
expect { conn.post('/unstable', file: upload_io) }.to raise_error(Errno::ETIMEDOUT)
|
180
|
-
expect(times_called).to eq(3)
|
181
|
-
expect(rewound).to eq(2)
|
182
|
-
end
|
183
|
-
|
184
|
-
context 'when explicitly specifying methods to retry' do
|
185
|
-
let(:options) { [{ retry_if: @check, methods: [:post] }] }
|
186
|
-
|
187
|
-
it 'does not call retry_if for specified methods' do
|
188
|
-
@check = ->(_, _) { raise 'this should have never been called' }
|
189
|
-
expect { conn.post('/unstable') }.to raise_error(Errno::ETIMEDOUT)
|
190
|
-
expect(times_called).to eq(3)
|
191
|
-
end
|
192
|
-
end
|
193
|
-
|
194
|
-
context 'with empty list of methods to retry' do
|
195
|
-
let(:options) { [{ retry_if: @check, methods: [] }] }
|
196
|
-
|
197
|
-
it 'calls retry_if for all methods' do
|
198
|
-
@check = ->(_, _) { calls.size < 2 }
|
199
|
-
expect { conn.get('/unstable') }.to raise_error(Errno::ETIMEDOUT)
|
200
|
-
expect(times_called).to eq(2)
|
201
|
-
end
|
202
|
-
end
|
203
|
-
end
|
204
|
-
|
205
|
-
describe 'retry_after header support' do
|
206
|
-
let(:callback) { -> { [504, headers, ''] } }
|
207
|
-
let(:elapsed) { Time.now - @started }
|
208
|
-
|
209
|
-
before do
|
210
|
-
@started = Time.now
|
211
|
-
conn.get('/unstable')
|
212
|
-
end
|
213
|
-
|
214
|
-
context 'when retry_after bigger than interval' do
|
215
|
-
let(:headers) { { 'Retry-After' => '0.5' } }
|
216
|
-
let(:options) { [{ max: 1, interval: 0.1, retry_statuses: 504 }] }
|
217
|
-
|
218
|
-
it { expect(elapsed).to be > 0.5 }
|
219
|
-
end
|
220
|
-
|
221
|
-
context 'when retry_after smaller than interval' do
|
222
|
-
let(:headers) { { 'Retry-After' => '0.1' } }
|
223
|
-
let(:options) { [{ max: 1, interval: 0.2, retry_statuses: 504 }] }
|
224
|
-
|
225
|
-
it { expect(elapsed).to be > 0.2 }
|
226
|
-
end
|
227
|
-
|
228
|
-
context 'when retry_after is a timestamp' do
|
229
|
-
let(:headers) { { 'Retry-After' => (Time.now.utc + 2).strftime('%a, %d %b %Y %H:%M:%S GMT') } }
|
230
|
-
let(:options) { [{ max: 1, interval: 0.1, retry_statuses: 504 }] }
|
231
|
-
|
232
|
-
it { expect(elapsed).to be > 1 }
|
233
|
-
end
|
234
|
-
|
235
|
-
context 'when retry_after is bigger than max_interval' do
|
236
|
-
let(:headers) { { 'Retry-After' => (Time.now.utc + 20).strftime('%a, %d %b %Y %H:%M:%S GMT') } }
|
237
|
-
let(:options) { [{ max: 2, interval: 0.1, max_interval: 5, retry_statuses: 504 }] }
|
238
|
-
|
239
|
-
it { expect(times_called).to eq(1) }
|
240
|
-
end
|
241
|
-
end
|
242
|
-
end
|
@@ -1,68 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
RSpec.describe Faraday::Response::Middleware do
|
4
|
-
let(:conn) do
|
5
|
-
Faraday.new do |b|
|
6
|
-
b.use custom_middleware
|
7
|
-
b.adapter :test do |stub|
|
8
|
-
stub.get('ok') { [200, { 'Content-Type' => 'text/html' }, '<body></body>'] }
|
9
|
-
stub.get('not_modified') { [304, nil, nil] }
|
10
|
-
stub.get('no_content') { [204, nil, nil] }
|
11
|
-
end
|
12
|
-
end
|
13
|
-
end
|
14
|
-
|
15
|
-
context 'with a custom ResponseMiddleware' do
|
16
|
-
let(:custom_middleware) do
|
17
|
-
Class.new(Faraday::Response::Middleware) do
|
18
|
-
def parse(body)
|
19
|
-
body.upcase
|
20
|
-
end
|
21
|
-
end
|
22
|
-
end
|
23
|
-
|
24
|
-
it 'parses the response' do
|
25
|
-
expect(conn.get('ok').body).to eq('<BODY></BODY>')
|
26
|
-
end
|
27
|
-
end
|
28
|
-
|
29
|
-
context 'with a custom ResponseMiddleware and private parse' do
|
30
|
-
let(:custom_middleware) do
|
31
|
-
Class.new(Faraday::Response::Middleware) do
|
32
|
-
private
|
33
|
-
|
34
|
-
def parse(body)
|
35
|
-
body.upcase
|
36
|
-
end
|
37
|
-
end
|
38
|
-
end
|
39
|
-
|
40
|
-
it 'parses the response' do
|
41
|
-
expect(conn.get('ok').body).to eq('<BODY></BODY>')
|
42
|
-
end
|
43
|
-
end
|
44
|
-
|
45
|
-
context 'with a custom ResponseMiddleware but empty response' do
|
46
|
-
let(:custom_middleware) do
|
47
|
-
Class.new(Faraday::Response::Middleware) do
|
48
|
-
def parse(_body)
|
49
|
-
raise 'this should not be called'
|
50
|
-
end
|
51
|
-
end
|
52
|
-
end
|
53
|
-
|
54
|
-
it 'raises exception for 200 responses' do
|
55
|
-
expect { conn.get('ok') }.to raise_error(StandardError)
|
56
|
-
end
|
57
|
-
|
58
|
-
it 'doesn\'t call the middleware for 204 responses' do
|
59
|
-
expect_any_instance_of(custom_middleware).not_to receive(:parse)
|
60
|
-
expect(conn.get('no_content').body).to be_nil
|
61
|
-
end
|
62
|
-
|
63
|
-
it 'doesn\'t call the middleware for 304 responses' do
|
64
|
-
expect_any_instance_of(custom_middleware).not_to receive(:parse)
|
65
|
-
expect(conn.get('not_modified').body).to be_nil
|
66
|
-
end
|
67
|
-
end
|
68
|
-
end
|
@@ -1,68 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
# Rack app used to test the Rack adapter.
|
4
|
-
# Uses Webmock to check if requests are registered, in which case it returns
|
5
|
-
# the registered response.
|
6
|
-
class WebmockRackApp
|
7
|
-
def call(env)
|
8
|
-
req_signature = WebMock::RequestSignature.new(
|
9
|
-
req_method(env),
|
10
|
-
req_uri(env),
|
11
|
-
body: req_body(env),
|
12
|
-
headers: req_headers(env)
|
13
|
-
)
|
14
|
-
|
15
|
-
WebMock::RequestRegistry
|
16
|
-
.instance
|
17
|
-
.requested_signatures
|
18
|
-
.put(req_signature)
|
19
|
-
|
20
|
-
process_response(req_signature)
|
21
|
-
end
|
22
|
-
|
23
|
-
def req_method(env)
|
24
|
-
env['REQUEST_METHOD'].downcase.to_sym
|
25
|
-
end
|
26
|
-
|
27
|
-
def req_uri(env)
|
28
|
-
scheme = env['rack.url_scheme']
|
29
|
-
host = env['SERVER_NAME']
|
30
|
-
port = env['SERVER_PORT']
|
31
|
-
path = env['PATH_INFO']
|
32
|
-
query = env['QUERY_STRING']
|
33
|
-
|
34
|
-
url = +"#{scheme}://#{host}:#{port}#{path}"
|
35
|
-
url += "?#{query}" if query
|
36
|
-
|
37
|
-
uri = WebMock::Util::URI.heuristic_parse(url)
|
38
|
-
uri.path = uri.normalized_path.gsub('[^:]//', '/')
|
39
|
-
uri
|
40
|
-
end
|
41
|
-
|
42
|
-
def req_headers(env)
|
43
|
-
http_headers = env.select { |k, _| k.start_with?('HTTP_') }
|
44
|
-
.map { |k, v| [k[5..-1], v] }
|
45
|
-
.to_h
|
46
|
-
|
47
|
-
special_headers = Faraday::Adapter::Rack::SPECIAL_HEADERS
|
48
|
-
http_headers.merge(env.select { |k, _| special_headers.include?(k) })
|
49
|
-
end
|
50
|
-
|
51
|
-
def req_body(env)
|
52
|
-
env['rack.input'].read
|
53
|
-
end
|
54
|
-
|
55
|
-
def process_response(req_signature)
|
56
|
-
res = WebMock::StubRegistry.instance.response_for_request(req_signature)
|
57
|
-
|
58
|
-
if res.nil? && req_signature.uri.host == 'localhost'
|
59
|
-
raise Faraday::ConnectionFailed, 'Trying to connect to localhost'
|
60
|
-
end
|
61
|
-
|
62
|
-
raise WebMock::NetConnectNotAllowedError, req_signature unless res
|
63
|
-
|
64
|
-
raise Faraday::TimeoutError if res.should_timeout
|
65
|
-
|
66
|
-
[res.status[0], res.headers || {}, [res.body || '']]
|
67
|
-
end
|
68
|
-
end
|