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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
//! HTTP client support for cynic.
//!
//! These are hidden behind feature flags by default as HTTP clients are quite
//! heavy dependencies, and there's several options to choose from.
#[cfg(feature = "http-surf")]
#[cfg_attr(docsrs, doc(cfg(feature = "surf")))]
pub use self::surf_ext::SurfExt;
#[cfg(feature = "http-reqwest")]
#[cfg_attr(docsrs, doc(cfg(feature = "reqwest")))]
pub use reqwest_ext::ReqwestExt;
#[cfg(feature = "http-reqwest-blocking")]
#[cfg_attr(docsrs, doc(cfg(feature = "reqwest-blocking")))]
pub use reqwest_blocking_ext::ReqwestBlockingExt;
#[cfg(feature = "http-surf")]
mod surf_ext {
use serde_json::json;
use std::{future::Future, pin::Pin};
use crate::{GraphQlResponse, Operation};
type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + Send + 'a>>;
/// An extension trait for surf::RequestBuilder.
///
/// ```rust,no_run
/// # mod schema {
/// # cynic::use_schema!("../schemas/starwars.schema.graphql");
/// # }
/// #
/// # #[derive(cynic::QueryFragment)]
/// # #[cynic(
/// # schema_path = "../schemas/starwars.schema.graphql",
/// # schema_module = "schema",
/// # )]
/// # struct Film {
/// # title: Option<String>,
/// # director: Option<String>
/// # }
/// #
/// # #[derive(cynic::QueryFragment)]
/// # #[cynic(
/// # schema_path = "../schemas/starwars.schema.graphql",
/// # schema_module = "schema",
/// # graphql_type = "Root"
/// # )]
/// # struct FilmDirectorQuery {
/// # #[arguments(id = cynic::Id::new("ZmlsbXM6MQ=="))]
/// # film: Option<Film>,
/// # }
/// use cynic::{http::SurfExt, QueryBuilder};
///
/// # async move {
/// let operation = FilmDirectorQuery::build(());
///
/// let response = surf::post("https://swapi-graphql.netlify.app/.netlify/functions/index")
/// .run_graphql(operation)
/// .await
/// .unwrap();
///
/// println!(
/// "The director is {}",
/// response.data
/// .and_then(|d| d.film)
/// .and_then(|f| f.director)
/// .unwrap()
/// );
/// # };
/// ```
#[cfg_attr(docsrs, doc(cfg(feature = "http-surf")))]
pub trait SurfExt {
/// Runs a GraphQL query with the parameters in RequestBuilder, deserializes
/// the response and returns the result.
fn run_graphql<ResponseData, Vars>(
self,
operation: Operation<ResponseData, Vars>,
) -> BoxFuture<'static, Result<GraphQlResponse<ResponseData>, surf::Error>>
where
Vars: serde::Serialize,
ResponseData: serde::de::DeserializeOwned + 'static;
}
impl SurfExt for surf::RequestBuilder {
fn run_graphql<ResponseData, Vars>(
self,
operation: Operation<ResponseData, Vars>,
) -> BoxFuture<'static, Result<GraphQlResponse<ResponseData>, surf::Error>>
where
Vars: serde::Serialize,
ResponseData: serde::de::DeserializeOwned + 'static,
{
let operation = json!(&operation);
Box::pin(async move {
let mut response = self.body(operation).await?;
if !response.status().is_success() {
let body_string = response.body_string().await?;
match serde_json::from_str::<GraphQlResponse<ResponseData>>(&body_string) {
Ok(response) => return Ok(response),
Err(_) => {
return Err(surf::Error::from_str(
response.status(),
format!("Server returned {}: {}", response.status(), body_string),
))
}
};
}
response.body_json::<GraphQlResponse<ResponseData>>().await
})
}
}
}
/// The error type returned by `ReqwestExt` & `ReqwestBlockingExt`
#[cfg(any(feature = "http-reqwest", feature = "http-reqwest-blocking"))]
#[derive(thiserror::Error, Debug)]
pub enum CynicReqwestError {
/// An error from reqwest when making an HTTP request.
#[error("Error making HTTP request: {0}")]
ReqwestError(#[from] reqwest::Error),
/// An error response from the server with the given status code and body.
#[error("Server returned {0}: {1}")]
ErrorResponse(reqwest::StatusCode, String),
}
#[cfg(feature = "http-reqwest")]
mod reqwest_ext {
use super::CynicReqwestError;
use std::{future::Future, pin::Pin};
use crate::{GraphQlResponse, Operation};
#[cfg(not(target_arch = "wasm32"))]
type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + Send + 'a>>;
#[cfg(target_arch = "wasm32")]
type BoxFuture<'a, T> = Pin<Box<dyn Future<Output = T> + 'a>>;
/// An extension trait for reqwest::RequestBuilder.
///
/// ```rust,no_run
/// # mod schema {
/// # cynic::use_schema!("../schemas/starwars.schema.graphql");
/// # }
/// #
/// # #[derive(cynic::QueryFragment)]
/// # #[cynic(
/// # schema_path = "../schemas/starwars.schema.graphql",
/// # schema_module = "schema",
/// # )]
/// # struct Film {
/// # title: Option<String>,
/// # director: Option<String>
/// # }
/// #
/// # #[derive(cynic::QueryFragment)]
/// # #[cynic(
/// # schema_path = "../schemas/starwars.schema.graphql",
/// # schema_module = "schema",
/// # graphql_type = "Root"
/// # )]
/// # struct FilmDirectorQuery {
/// # #[arguments(id = cynic::Id::new("ZmlsbXM6MQ=="))]
/// # film: Option<Film>,
/// # }
/// use cynic::{http::ReqwestExt, QueryBuilder};
///
/// # async move {
/// let operation = FilmDirectorQuery::build(());
///
/// let client = reqwest::Client::new();
/// let response = client.post("https://swapi-graphql.netlify.app/.netlify/functions/index")
/// .run_graphql(operation)
/// .await
/// .unwrap();
///
/// println!(
/// "The director is {}",
/// response.data
/// .and_then(|d| d.film)
/// .and_then(|f| f.director)
/// .unwrap()
/// );
/// # };
/// ```
#[cfg_attr(docsrs, doc(cfg(feature = "http-reqwest")))]
pub trait ReqwestExt {
/// Runs a GraphQL query with the parameters in RequestBuilder, deserializes
/// the and returns the result.
fn run_graphql<ResponseData, Vars>(
self,
operation: Operation<ResponseData, Vars>,
) -> BoxFuture<'static, Result<GraphQlResponse<ResponseData>, CynicReqwestError>>
where
Vars: serde::Serialize,
ResponseData: serde::de::DeserializeOwned + 'static;
}
impl ReqwestExt for reqwest::RequestBuilder {
fn run_graphql<ResponseData, Vars>(
self,
operation: Operation<ResponseData, Vars>,
) -> BoxFuture<'static, Result<GraphQlResponse<ResponseData>, CynicReqwestError>>
where
Vars: serde::Serialize,
ResponseData: serde::de::DeserializeOwned + 'static,
{
let builder = self.json(&operation);
Box::pin(async move {
match builder.send().await {
Ok(response) => {
let status = response.status();
if !status.is_success() {
let body_string = response.text().await?;
match serde_json::from_str::<GraphQlResponse<ResponseData>>(
&body_string,
) {
Ok(response) => return Ok(response),
Err(_) => {
return Err(CynicReqwestError::ErrorResponse(
status,
body_string,
));
}
};
}
response
.json::<GraphQlResponse<ResponseData>>()
.await
.map_err(CynicReqwestError::ReqwestError)
}
Err(e) => Err(CynicReqwestError::ReqwestError(e)),
}
})
}
}
}
#[cfg(feature = "http-reqwest-blocking")]
mod reqwest_blocking_ext {
use super::CynicReqwestError;
use crate::{GraphQlResponse, Operation};
/// An extension trait for reqwest::blocking::RequestBuilder.
///
/// ```rust,no_run
/// # mod schema {
/// # cynic::use_schema!("../schemas/starwars.schema.graphql");
/// # }
/// #
/// # #[derive(cynic::QueryFragment)]
/// # #[cynic(
/// # schema_path = "../schemas/starwars.schema.graphql",
/// # schema_module = "schema",
/// # )]
/// # struct Film {
/// # title: Option<String>,
/// # director: Option<String>
/// # }
/// #
/// # #[derive(cynic::QueryFragment)]
/// # #[cynic(
/// # schema_path = "../schemas/starwars.schema.graphql",
/// # schema_module = "schema",
/// # graphql_type = "Root"
/// # )]
/// # struct FilmDirectorQuery {
/// # #[arguments(id = cynic::Id::new("ZmlsbXM6MQ=="))]
/// # film: Option<Film>,
/// # }
/// use cynic::{http::ReqwestBlockingExt, QueryBuilder};
///
/// let operation = FilmDirectorQuery::build(());
///
/// let client = reqwest::blocking::Client::new();
/// let response = client.post("https://swapi-graphql.netlify.app/.netlify/functions/index")
/// .run_graphql(operation)
/// .unwrap();
///
/// println!(
/// "The director is {}",
/// response.data
/// .and_then(|d| d.film)
/// .and_then(|f| f.director)
/// .unwrap()
/// );
/// ```
#[cfg_attr(docsrs, doc(cfg(feature = "http-reqwest-blocking")))]
pub trait ReqwestBlockingExt {
/// Runs a GraphQL query with the parameters in RequestBuilder, deserializes
/// the and returns the result.
fn run_graphql<ResponseData, Vars>(
self,
operation: Operation<ResponseData, Vars>,
) -> Result<GraphQlResponse<ResponseData>, CynicReqwestError>
where
Vars: serde::Serialize,
ResponseData: serde::de::DeserializeOwned + 'static;
}
impl ReqwestBlockingExt for reqwest::blocking::RequestBuilder {
fn run_graphql<ResponseData, Vars>(
self,
operation: Operation<ResponseData, Vars>,
) -> Result<GraphQlResponse<ResponseData>, CynicReqwestError>
where
Vars: serde::Serialize,
ResponseData: serde::de::DeserializeOwned + 'static,
{
let response = self.json(&operation).send()?;
let status = response.status();
if !status.is_success() {
let body_string = response.text().map_err(CynicReqwestError::ReqwestError)?;
match serde_json::from_str::<GraphQlResponse<ResponseData>>(&body_string) {
Ok(response) => return Ok(response),
Err(_) => {
return Err(CynicReqwestError::ErrorResponse(status, body_string));
}
};
}
Ok(response.json::<GraphQlResponse<ResponseData>>()?)
}
}
}