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 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
use crate::http::{Headers, QueryParams, Response};
use crate::{js_to_error, Error};
use http::Method;
use js_sys::{ArrayBuffer, Uint8Array};
use std::convert::{From, TryFrom, TryInto};
use std::fmt;
use std::str::FromStr;
use wasm_bindgen::{prelude::wasm_bindgen, JsCast, JsValue};
use wasm_bindgen_futures::JsFuture;
use web_sys::{
AbortSignal, FormData, ObserverCallback, ReadableStream, ReferrerPolicy, RequestCache,
RequestCredentials, RequestMode, RequestRedirect,
};
#[cfg(feature = "json")]
#[cfg_attr(docsrs, doc(cfg(feature = "json")))]
use serde::de::DeserializeOwned;
#[wasm_bindgen]
extern "C" {
// Create a separate binding for `fetch` as a global, rather than using the
// existing Window/WorkerGlobalScope bindings defined by web_sys, for
// greater efficiency.
//
// https://github.com/rustwasm/wasm-bindgen/discussions/3863
#[wasm_bindgen(js_name = "fetch")]
fn fetch_with_request(request: &web_sys::Request) -> js_sys::Promise;
}
/// A wrapper round `web_sys::Request`: an http request to be used with the `fetch` API.
pub struct RequestBuilder {
options: web_sys::RequestInit,
headers: Headers,
query: QueryParams,
url: String,
}
impl RequestBuilder {
/// Creates a new request that will be sent to `url`.
///
/// Uses `GET` by default. `url` can be a `String`, a `&str`, or a `Cow<'a, str>`.
pub fn new(url: &str) -> Self {
Self {
options: web_sys::RequestInit::new(),
headers: Headers::new(),
query: QueryParams::new(),
url: url.into(),
}
}
/// Set the body for this request.
pub fn body(mut self, body: impl Into<JsValue>) -> Result<Request, Error> {
self.options.body(Some(&body.into()));
self.try_into()
}
/// A string indicating how the request will interact with the browser’s HTTP cache.
pub fn cache(mut self, cache: RequestCache) -> Self {
self.options.cache(cache);
self
}
/// Controls what browsers do with credentials (cookies, HTTP authentication entries, and TLS
/// client certificates).
pub fn credentials(mut self, credentials: RequestCredentials) -> Self {
self.options.credentials(credentials);
self
}
/// Replace _all_ the headers.
pub fn headers(mut self, headers: Headers) -> Self {
self.headers = headers;
self
}
/// Sets a header.
pub fn header(self, key: &str, value: &str) -> Self {
self.headers.set(key, value);
self
}
/// Append query parameters to the url, given as `(name, value)` tuples. Values can be of any
/// type that implements [`ToString`].
///
/// It is possible to append the same parameters with the same name multiple times, so
/// `.query([("a", "1"), ("a", "2")])` results in the query string `a=1&a=2`.
///
/// # Examples
///
/// The query parameters can be passed in various different forms:
///
/// ```
/// # fn no_run() {
/// use std::collections::HashMap;
/// use gloo_net::http::Request;
///
/// let slice_params = [("key", "value")];
/// let vec_params = vec![("a", "3"), ("b", "4")];
/// let mut map_params: HashMap<&'static str, &'static str> = HashMap::new();
/// map_params.insert("key", "another_value");
///
/// let r = Request::get("/search")
/// .query(slice_params)
/// .query(vec_params)
/// .query(map_params);
/// // Result URL: /search?key=value&a=3&b=4&key=another_value
/// # }
/// ```
pub fn query<'a, T, V>(self, params: T) -> Self
where
T: IntoIterator<Item = (&'a str, V)>,
V: AsRef<str>,
{
for (name, value) in params {
self.query.append(name, value.as_ref());
}
self
}
/// The subresource integrity value of the request (e.g.,
/// `sha256-BpfBw7ivV8q2jLiT13fxDYAe2tJllusRSZ273h2nFSE=`).
pub fn integrity(mut self, integrity: &str) -> Self {
self.options.integrity(integrity);
self
}
/// A convenience method to set JSON as request body
///
/// # Note
///
/// This method also sets the `Content-Type` header to `application/json`
#[cfg(feature = "json")]
#[cfg_attr(docsrs, doc(cfg(feature = "json")))]
pub fn json<T: serde::Serialize + ?Sized>(self, value: &T) -> Result<Request, Error> {
let json = serde_json::to_string(value)?;
self.header("Content-Type", "application/json").body(json)
}
/// The request method, e.g., GET, POST.
pub fn method(mut self, method: Method) -> Self {
self.options.method(method.as_ref());
self
}
/// The mode you want to use for the request.
pub fn mode(mut self, mode: RequestMode) -> Self {
self.options.mode(mode);
self
}
/// Sets the observer callback.
pub fn observe(mut self, observe: &ObserverCallback) -> Self {
self.options.observe(observe);
self
}
/// How to handle a redirect response:
///
/// - *follow*: Automatically follow redirects. Unless otherwise stated the redirect mode is
/// set to follow
/// - *error*: Abort with an error if a redirect occurs.
/// - *manual*: Caller intends to process the response in another context. See [WHATWG fetch
/// standard](https://fetch.spec.whatwg.org/#requests) for more information.
pub fn redirect(mut self, redirect: RequestRedirect) -> Self {
self.options.redirect(redirect);
self
}
/// The referrer of the request.
///
/// This can be a same-origin URL, `about:client`, or an empty string.
pub fn referrer(mut self, referrer: &str) -> Self {
self.options.referrer(referrer);
self
}
/// Specifies the
/// [referrer policy](https://w3c.github.io/webappsec-referrer-policy/#referrer-policies) to
/// use for the request.
pub fn referrer_policy(mut self, referrer_policy: ReferrerPolicy) -> Self {
self.options.referrer_policy(referrer_policy);
self
}
/// Sets the request abort signal.
pub fn abort_signal(mut self, signal: Option<&AbortSignal>) -> Self {
self.options.signal(signal);
self
}
/// Builds the request and send it to the server, returning the received response.
pub async fn send(self) -> Result<Response, Error> {
let req: Request = self.try_into()?;
req.send().await
}
/// Builds the request.
pub fn build(self) -> Result<Request, crate::error::Error> {
self.try_into()
}
}
impl TryFrom<RequestBuilder> for Request {
type Error = crate::error::Error;
fn try_from(mut value: RequestBuilder) -> Result<Self, Self::Error> {
// To preserve existing query parameters of self.url, it must be parsed and extended with
// self.query's parameters. As web_sys::Url just accepts absolute URLs, retrieve the
// absolute URL through creating a web_sys::Request object.
let request = web_sys::Request::new_with_str(&value.url).map_err(js_to_error)?;
let url = web_sys::Url::new(&request.url()).map_err(js_to_error)?;
let combined_query = match url.search().as_str() {
"" => value.query.to_string(),
_ => format!("{}&{}", url.search(), value.query),
};
url.set_search(&combined_query);
let final_url = String::from(url.to_string());
value.options.headers(&value.headers.into_raw());
let request = web_sys::Request::new_with_str_and_init(&final_url, &value.options)
.map_err(js_to_error)?;
Ok(request.into())
}
}
impl fmt::Debug for RequestBuilder {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Request").field("url", &self.url).finish()
}
}
/// The [`Request`] sent to the server
pub struct Request(web_sys::Request);
impl Request {
/// Creates a new [`GET`][Method::GET] `Request` with url.
pub fn get(url: &str) -> RequestBuilder {
RequestBuilder::new(url).method(Method::GET)
}
/// Creates a new [`POST`][Method::POST] `Request` with url.
pub fn post(url: &str) -> RequestBuilder {
RequestBuilder::new(url).method(Method::POST)
}
/// Creates a new [`PUT`][Method::PUT] `Request` with url.
pub fn put(url: &str) -> RequestBuilder {
RequestBuilder::new(url).method(Method::PUT)
}
/// Creates a new [`DELETE`][Method::DELETE] `Request` with url.
pub fn delete(url: &str) -> RequestBuilder {
RequestBuilder::new(url).method(Method::DELETE)
}
/// Creates a new [`PATCH`][Method::PATCH] `Request` with url.
pub fn patch(url: &str) -> RequestBuilder {
RequestBuilder::new(url).method(Method::PATCH)
}
/// The URL of the request.
pub fn url(&self) -> String {
self.0.url()
}
/// Gets the headers.
pub fn headers(&self) -> Headers {
Headers::from_raw(self.0.headers())
}
/// Has the request body been consumed?
///
/// If true, then any future attempts to consume the body will error.
pub fn body_used(&self) -> bool {
self.0.body_used()
}
/// Gets the body.
pub fn body(&self) -> Option<ReadableStream> {
self.0.body()
}
/// Reads the request to completion, returning it as `FormData`.
pub async fn form_data(&self) -> Result<FormData, Error> {
let promise = self.0.form_data().map_err(js_to_error)?;
let val = JsFuture::from(promise).await.map_err(js_to_error)?;
Ok(FormData::from(val))
}
/// Reads the request to completion, parsing it as JSON.
#[cfg(feature = "json")]
#[cfg_attr(docsrs, doc(cfg(feature = "json")))]
pub async fn json<T: DeserializeOwned>(&self) -> Result<T, Error> {
serde_json::from_str::<T>(&self.text().await?).map_err(Error::from)
}
/// Reads the reqeust as a String.
pub async fn text(&self) -> Result<String, Error> {
let promise = self.0.text().unwrap();
let val = JsFuture::from(promise).await.map_err(js_to_error)?;
let string = js_sys::JsString::from(val);
Ok(String::from(&string))
}
/// Gets the binary request
///
/// This works by obtaining the response as an `ArrayBuffer`, creating a `Uint8Array` from it
/// and then converting it to `Vec<u8>`
pub async fn binary(&self) -> Result<Vec<u8>, Error> {
let promise = self.0.array_buffer().map_err(js_to_error)?;
let array_buffer: ArrayBuffer = JsFuture::from(promise)
.await
.map_err(js_to_error)?
.unchecked_into();
let typed_buff: Uint8Array = Uint8Array::new(&array_buffer);
let mut body = vec![0; typed_buff.length() as usize];
typed_buff.copy_to(&mut body);
Ok(body)
}
/// Return the read only mode for the request
pub fn mode(&self) -> RequestMode {
self.0.mode()
}
/// Return the parsed method for the request
pub fn method(&self) -> Method {
Method::from_str(self.0.method().as_str()).unwrap()
}
/// Executes the request.
pub async fn send(self) -> Result<Response, Error> {
let request = self.0;
let promise = fetch_with_request(&request);
let response = JsFuture::from(promise).await.map_err(js_to_error)?;
response
.dyn_into::<web_sys::Response>()
.map_err(|e| panic!("fetch returned {:?}, not `Response` - this is a bug", e))
.map(Response::from)
}
}
impl From<web_sys::Request> for Request {
fn from(raw: web_sys::Request) -> Self {
Request(raw)
}
}
impl From<Request> for web_sys::Request {
fn from(val: Request) -> Self {
val.0
}
}
impl fmt::Debug for Request {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Request")
.field("url", &self.url())
.field("headers", &self.headers())
.field("body_used", &self.body_used())
.finish()
}
}