1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
use crate::config::typestate::RequestExtScope;
use crate::config::{Config, ConfigBuilder, RequestLevelConfig};
use crate::{http, Agent, AsSendBody, Body, Error};
use std::ops::Deref;
use ureq_proto::http::{Request, Response};
/// Extension trait for [`http::Request<impl AsSendBody>`].
///
/// Adds additional convenience methods to the `Request` that are not available
/// in the plain http API.
pub trait RequestExt<S>
where
S: AsSendBody,
{
/// Allows configuring the request behaviour, starting with the default [`Agent`].
///
/// This method allows configuring the request by using the default Agent, and performing
/// additional configurations on top.
/// This method returns a `WithAgent` struct that it is possible to call `configure()` and `run()`
/// on to configure the request behaviour, or run the request.
///
/// # Example
///
/// ```
/// use ureq::{http, RequestExt, Error};
///
/// let request: Result<http::Response<_>, Error> = http::Request::builder()
/// .method(http::Method::GET)
/// .uri("http://foo.bar")
/// .body(())
/// .unwrap()
/// .with_default_agent()
/// .configure()
/// .http_status_as_error(false)
/// .run();
/// ```
fn with_default_agent(self) -> WithAgent<'static, S>
where
Self: Sized,
{
let agent = Agent::new_with_defaults();
Self::with_agent(self, agent)
}
/// Allows configuring this request behaviour, using a specific [`Agent`].
///
/// This method allows configuring the request by using a user-provided `Agent` and performing
/// additional configurations on top.
/// This method returns a `WithAgent` struct that it is possible to call `configure()` and `run()`
/// on to configure the request behaviour, or run the request.
///
/// # Example
///
/// ```
/// use ureq::{http, Agent, RequestExt, Error};
/// use std::time::Duration;
/// let agent = Agent::config_builder()
/// .timeout_global(Some(Duration::from_secs(30)))
/// .build()
/// .new_agent();
///
/// let request: Result<http::Response<_>, Error> = http::Request::builder()
/// .method(http::Method::GET)
/// .uri("http://foo.bar")
/// .body(())
/// .unwrap()
/// .with_agent(&agent)
/// .run();
/// ```
/// # Example with further customizations
///
/// In this example we use a specific agent, but apply a request-specific configuration on top.
///
/// ```
/// use ureq::{http, Agent, RequestExt, Error};
/// use std::time::Duration;
/// let mut agent = Agent::config_builder()
/// .timeout_global(Some(Duration::from_secs(30)))
/// .build()
/// .new_agent();
///
/// let request: Result<http::Response<_>, Error> = http::Request::builder()
/// .method(http::Method::GET)
/// .uri("http://foo.bar")
/// .body(())
/// .unwrap()
/// .with_agent(&agent)
/// .configure()
/// .http_status_as_error(false)
/// .run();
/// ```
fn with_agent<'a>(self, agent: impl Into<AgentRef<'a>>) -> WithAgent<'a, S>;
}
/// Wrapper struct that holds a [`Request`] associated with an [`Agent`].
pub struct WithAgent<'a, S: AsSendBody> {
pub(crate) agent: AgentRef<'a>,
pub(crate) request: Request<S>,
}
impl<'a, S: AsSendBody> WithAgent<'a, S> {
/// Returns a [`ConfigBuilder`] for configuring the request.
///
/// This allows setting additional request-specific options before sending the request.
pub fn configure(self) -> ConfigBuilder<RequestExtScope<'a, S>> {
ConfigBuilder(RequestExtScope(self))
}
/// Executes the request using the associated [`Agent`].
pub fn run(self) -> Result<Response<Body>, Error> {
self.agent.run(self.request)
}
}
impl<'a, S: AsSendBody> WithAgent<'a, S> {
pub(crate) fn request_level_config(&mut self) -> &mut Config {
let request_level_config = self
.request
.extensions_mut()
.get_mut::<RequestLevelConfig>();
if request_level_config.is_none() {
self.request
.extensions_mut()
.insert(self.agent.new_request_level_config());
}
// Unwrap is safe because of the above check
let req_level: &mut RequestLevelConfig = self
.request
.extensions_mut()
.get_mut::<RequestLevelConfig>()
.unwrap();
&mut req_level.0
}
}
/// Reference type to hold an owned or borrowed [`Agent`].
pub enum AgentRef<'a> {
Owned(Agent),
Borrowed(&'a Agent),
}
impl<S: AsSendBody> RequestExt<S> for http::Request<S> {
fn with_agent<'a>(self, agent: impl Into<AgentRef<'a>>) -> WithAgent<'a, S> {
WithAgent {
agent: agent.into(),
request: self,
}
}
}
impl From<Agent> for AgentRef<'static> {
fn from(value: Agent) -> Self {
AgentRef::Owned(value)
}
}
impl<'a> From<&'a Agent> for AgentRef<'a> {
fn from(value: &'a Agent) -> Self {
AgentRef::Borrowed(value)
}
}
impl Deref for AgentRef<'_> {
type Target = Agent;
fn deref(&self) -> &Self::Target {
match self {
AgentRef::Owned(agent) => agent,
AgentRef::Borrowed(agent) => agent,
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::config::RequestLevelConfig;
use std::time::Duration;
#[test]
fn configure_request_with_default_agent() {
// Create `http` crate request and configure with trait
let request = http::Request::builder()
.method(http::Method::GET)
.uri("http://foo.bar")
.body(())
.unwrap()
.with_default_agent()
.configure()
.https_only(true)
.build();
// Assert that the request-level configuration has been set
let request_config = request
.request
.extensions()
.get::<RequestLevelConfig>()
.cloned()
.unwrap();
assert!(request_config.0.https_only());
}
#[test]
fn configure_request_default_agent_2() {
// Create `http` crate request and configure with trait
let request = http::Request::builder()
.method(http::Method::GET)
.uri("http://foo.bar")
.body(())
.unwrap()
.with_default_agent()
.configure()
.https_only(false)
.build();
// Assert that the request-level configuration has been set
let request_config = request
.request
.extensions()
.get::<RequestLevelConfig>()
.cloned()
.unwrap();
assert!(!request_config.0.https_only());
}
#[test]
fn configure_request_default_agent_3() {
// Create `http` crate request
let request = http::Request::builder()
.method(http::Method::POST)
.uri("http://foo.bar")
.body("Some body")
.unwrap();
// Configure with the trait
let request = request
.with_default_agent()
.configure()
.http_status_as_error(true)
.build();
let request_config = request
.request
.extensions()
.get::<RequestLevelConfig>()
.cloned()
.unwrap();
assert!(request_config.0.http_status_as_error());
}
#[test]
fn configure_request_default_agent_4() {
// Create `http` crate request
let request = http::Request::builder()
.method(http::Method::POST)
.uri("http://foo.bar")
.body("Some body")
.unwrap();
// Configure with the trait
let request = request
.with_default_agent()
.configure()
.http_status_as_error(false)
.build();
let request_config = request
.request
.extensions()
.get::<RequestLevelConfig>()
.cloned()
.unwrap();
assert!(!request_config.0.http_status_as_error());
}
#[test]
fn configure_request_specified_agent() {
// Create `http` crate request
let request = http::Request::builder()
.method(http::Method::POST)
.uri("http://foo.bar")
.body("Some body")
.unwrap();
// Configure with the trait
let agent = Agent::config_builder()
.timeout_per_call(Some(Duration::from_secs(60)))
.build()
.new_agent();
let request = request
.with_agent(&agent)
.configure()
.http_status_as_error(false)
.build();
let request_config = request
.request
.extensions()
.get::<RequestLevelConfig>()
.cloned()
.unwrap();
// The request-level config is the agent defaults + the explicitly configured stuff
assert!(!request_config.0.http_status_as_error());
assert_eq!(
request_config.0.timeouts().per_call,
Some(Duration::from_secs(60))
);
}
}