faraday 1.3.0 → 1.9.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +30 -0
- data/README.md +1 -2
- data/examples/client_spec.rb +34 -2
- data/examples/client_test.rb +41 -2
- data/lib/faraday/adapter/test.rb +59 -43
- data/lib/faraday/adapter.rb +1 -11
- data/lib/faraday/autoload.rb +1 -8
- data/lib/faraday/connection.rb +34 -6
- data/lib/faraday/error.rb +0 -6
- data/lib/faraday/options/proxy_options.rb +4 -0
- data/lib/faraday/request/authorization.rb +14 -7
- data/lib/faraday/request.rb +0 -2
- data/lib/faraday/version.rb +1 -1
- data/lib/faraday.rb +18 -3
- data/spec/faraday/adapter/em_http_spec.rb +39 -37
- data/spec/faraday/adapter/em_synchrony_spec.rb +11 -9
- data/spec/faraday/adapter/test_spec.rb +117 -0
- data/spec/faraday/connection_spec.rb +45 -0
- data/spec/faraday/options/proxy_options_spec.rb +7 -0
- data/spec/faraday/request/authorization_spec.rb +8 -0
- metadata +121 -31
- data/lib/faraday/adapter/em_http.rb +0 -289
- data/lib/faraday/adapter/em_http_ssl_patch.rb +0 -62
- data/lib/faraday/adapter/em_synchrony/parallel_manager.rb +0 -69
- data/lib/faraday/adapter/em_synchrony.rb +0 -153
- data/lib/faraday/adapter/excon.rb +0 -124
- data/lib/faraday/adapter/httpclient.rb +0 -152
- data/lib/faraday/adapter/net_http_persistent.rb +0 -91
- data/lib/faraday/adapter/patron.rb +0 -132
- data/lib/faraday/adapter/rack.rb +0 -75
- data/lib/faraday/file_part.rb +0 -128
- data/lib/faraday/param_part.rb +0 -53
- data/lib/faraday/request/multipart.rb +0 -106
- data/lib/faraday/request/retry.rb +0 -239
- data/spec/faraday/adapter/net_http_persistent_spec.rb +0 -57
- data/spec/faraday/request/multipart_spec.rb +0 -302
- data/spec/faraday/request/retry_spec.rb +0 -242
@@ -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
|