mirror of
https://github.com/tauri-apps/plugins-workspace.git
synced 2026-05-25 13:17:47 +02:00
feat(http): refactor and improvements (#428)
Co-authored-by: Lucas Nogueira <lucas@tauri.studio>
This commit is contained in:
@@ -1 +1 @@
|
||||
if("__TAURI__"in window){var __TAURI_HTTP__=function(e){"use strict";var t;e.ResponseType=void 0,(t=e.ResponseType||(e.ResponseType={}))[t.JSON=1]="JSON",t[t.Text=2]="Text",t[t.Binary=3]="Binary";class r{constructor(e,t){this.type=e,this.payload=t}static form(e){const t={},s=(e,r)=>{if(null!==r){let s;s="string"==typeof r?r:r instanceof Uint8Array||Array.isArray(r)?Array.from(r):r instanceof File?{file:r.name,mime:r.type,fileName:r.name}:"string"==typeof r.file?{file:r.file,mime:r.mime,fileName:r.fileName}:{file:Array.from(r.file),mime:r.mime,fileName:r.fileName},t[String(e)]=s}};if(e instanceof FormData)for(const[t,r]of e)s(t,r);else for(const[t,r]of Object.entries(e))s(t,r);return new r("Form",t)}static json(e){return new r("Json",e)}static text(e){return new r("Text",e)}static bytes(e){return new r("Bytes",Array.from(e instanceof ArrayBuffer?new Uint8Array(e):e))}}class s{constructor(e){this.url=e.url,this.status=e.status,this.ok=this.status>=200&&this.status<300,this.headers=e.headers,this.rawHeaders=e.rawHeaders,this.data=e.data}}class n{constructor(e){this.id=e}async drop(){return window.__TAURI_INVOKE__("plugin:http|drop_client",{client:this.id})}async request(t){const r=!t.responseType||t.responseType===e.ResponseType.JSON;return r&&(t.responseType=e.ResponseType.Text),window.__TAURI_INVOKE__("plugin:http|request",{clientId:this.id,options:t}).then((e=>{const t=new s(e);if(r){try{t.data=JSON.parse(t.data)}catch(e){if(t.ok&&""===t.data)t.data={};else if(t.ok)throw Error(`Failed to parse response \`${t.data}\` as JSON: ${e};\n try setting the \`responseType\` option to \`ResponseType.Text\` or \`ResponseType.Binary\` if the API does not return a JSON response.`)}return t}return t}))}async get(e,t){return this.request({method:"GET",url:e,...t})}async post(e,t,r){return this.request({method:"POST",url:e,body:t,...r})}async put(e,t,r){return this.request({method:"PUT",url:e,body:t,...r})}async patch(e,t){return this.request({method:"PATCH",url:e,...t})}async delete(e,t){return this.request({method:"DELETE",url:e,...t})}}async function i(e){return window.__TAURI_INVOKE__("plugin:http|create_client",{options:e}).then((e=>new n(e)))}let o=null;return e.Body=r,e.Client=n,e.Response=s,e.fetch=async function(e,t){var r;return null===o&&(o=await i()),o.request({url:e,method:null!==(r=null==t?void 0:t.method)&&void 0!==r?r:"GET",...t})},e.getClient=i,e}({});Object.defineProperty(window.__TAURI__,"http",{value:__TAURI_HTTP__})}
|
||||
if("__TAURI__"in window){var __TAURI_HTTP__=function(e){"use strict";return e.fetch=async function(e,t){const n=null==t?void 0:t.maxRedirections,r=null==t?void 0:t.maxRedirections;t&&(delete t.maxRedirections,delete t.connectTimeout);const _=new Request(e,t),i=await _.arrayBuffer(),a=i.byteLength?Array.from(new Uint8Array(i)):null,d=await window.__TAURI_INVOKE__("plugin:http|fetch",{cmd:"fetch",method:_.method,url:_.url,headers:Array.from(_.headers.entries()),data:a,maxRedirections:n,connectTimeout:r});_.signal.addEventListener("abort",(()=>{window.__TAURI_INVOKE__("plugin:http|fetch_cancel",{rid:d})}));const{status:o,statusText:s,url:c,headers:u}=await window.__TAURI_INVOKE__("plugin:http|fetch_send",{rid:d}),l=await window.__TAURI_INVOKE__("plugin:http|fetch_read_body",{rid:d}),w=new Response(Uint8Array.from(l),{headers:u,status:o,statusText:s});return Object.defineProperty(w,"url",{value:c}),w},e}({});Object.defineProperty(window.__TAURI__,"http",{value:__TAURI_HTTP__})}
|
||||
|
||||
@@ -0,0 +1,178 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
use std::{collections::HashMap, time::Duration};
|
||||
|
||||
use http::{header, HeaderName, HeaderValue, Method, StatusCode};
|
||||
use reqwest::redirect::Policy;
|
||||
use serde::Serialize;
|
||||
use tauri::{command, AppHandle, Runtime};
|
||||
|
||||
use crate::{Error, FetchRequest, HttpExt, RequestId};
|
||||
|
||||
#[derive(Serialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct FetchResponse {
|
||||
status: u16,
|
||||
status_text: String,
|
||||
headers: Vec<(String, String)>,
|
||||
url: String,
|
||||
}
|
||||
|
||||
#[command]
|
||||
pub async fn fetch<R: Runtime>(
|
||||
app: AppHandle<R>,
|
||||
method: String,
|
||||
url: url::Url,
|
||||
headers: Vec<(String, String)>,
|
||||
data: Option<Vec<u8>>,
|
||||
connect_timeout: Option<u64>,
|
||||
max_redirections: Option<usize>,
|
||||
) -> crate::Result<RequestId> {
|
||||
let scheme = url.scheme();
|
||||
let method = Method::from_bytes(method.as_bytes())?;
|
||||
let headers: HashMap<String, String> = HashMap::from_iter(headers);
|
||||
|
||||
match scheme {
|
||||
"http" | "https" => {
|
||||
if app.http().scope.is_allowed(&url) {
|
||||
let mut builder = reqwest::ClientBuilder::new();
|
||||
|
||||
if let Some(timeout) = connect_timeout {
|
||||
builder = builder.connect_timeout(Duration::from_millis(timeout));
|
||||
}
|
||||
|
||||
if let Some(max_redirections) = max_redirections {
|
||||
builder = builder.redirect(if max_redirections == 0 {
|
||||
Policy::none()
|
||||
} else {
|
||||
Policy::limited(max_redirections)
|
||||
});
|
||||
}
|
||||
|
||||
let mut request = builder.build()?.request(method.clone(), url);
|
||||
|
||||
for (key, value) in &headers {
|
||||
let name = HeaderName::from_bytes(key.as_bytes())?;
|
||||
let v = HeaderValue::from_bytes(value.as_bytes())?;
|
||||
if !matches!(name, header::HOST | header::CONTENT_LENGTH) {
|
||||
request = request.header(name, v);
|
||||
}
|
||||
}
|
||||
|
||||
// POST and PUT requests should always have a 0 length content-length,
|
||||
// if there is no body. https://fetch.spec.whatwg.org/#http-network-or-cache-fetch
|
||||
if data.is_none() && matches!(method, Method::POST | Method::PUT) {
|
||||
request = request.header(header::CONTENT_LENGTH, HeaderValue::from(0));
|
||||
}
|
||||
|
||||
if headers.contains_key(header::RANGE.as_str()) {
|
||||
// https://fetch.spec.whatwg.org/#http-network-or-cache-fetch step 18
|
||||
// If httpRequest’s header list contains `Range`, then append (`Accept-Encoding`, `identity`)
|
||||
request = request.header(
|
||||
header::ACCEPT_ENCODING,
|
||||
HeaderValue::from_static("identity"),
|
||||
);
|
||||
}
|
||||
|
||||
if !headers.contains_key(header::USER_AGENT.as_str()) {
|
||||
request = request.header(header::USER_AGENT, HeaderValue::from_static("tauri"));
|
||||
}
|
||||
|
||||
if let Some(data) = data {
|
||||
request = request.body(data);
|
||||
}
|
||||
|
||||
let http_state = app.http();
|
||||
let rid = http_state.next_id();
|
||||
let fut = async move { Ok(request.send().await.map_err(Into::into)) };
|
||||
let mut request_table = http_state.requests.lock().await;
|
||||
request_table.insert(rid, FetchRequest::new(Box::pin(fut)));
|
||||
|
||||
Ok(rid)
|
||||
} else {
|
||||
Err(Error::UrlNotAllowed(url))
|
||||
}
|
||||
}
|
||||
"data" => {
|
||||
let data_url =
|
||||
data_url::DataUrl::process(url.as_str()).map_err(|_| Error::DataUrlError)?;
|
||||
let (body, _) = data_url
|
||||
.decode_to_vec()
|
||||
.map_err(|_| Error::DataUrlDecodeError)?;
|
||||
|
||||
let response = http::Response::builder()
|
||||
.status(StatusCode::OK)
|
||||
.header(header::CONTENT_TYPE, data_url.mime_type().to_string())
|
||||
.body(reqwest::Body::from(body))?;
|
||||
|
||||
let http_state = app.http();
|
||||
let rid = http_state.next_id();
|
||||
let fut = async move { Ok(Ok(reqwest::Response::from(response))) };
|
||||
let mut request_table = http_state.requests.lock().await;
|
||||
request_table.insert(rid, FetchRequest::new(Box::pin(fut)));
|
||||
Ok(rid)
|
||||
}
|
||||
_ => Err(Error::SchemeNotSupport(scheme.to_string())),
|
||||
}
|
||||
}
|
||||
|
||||
#[command]
|
||||
pub async fn fetch_cancel<R: Runtime>(app: AppHandle<R>, rid: RequestId) -> crate::Result<()> {
|
||||
let mut request_table = app.http().requests.lock().await;
|
||||
let req = request_table
|
||||
.get_mut(&rid)
|
||||
.ok_or(Error::InvalidRequestId(rid))?;
|
||||
*req = FetchRequest::new(Box::pin(async { Err(Error::RequestCanceled) }));
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[command]
|
||||
pub async fn fetch_send<R: Runtime>(
|
||||
app: AppHandle<R>,
|
||||
rid: RequestId,
|
||||
) -> crate::Result<FetchResponse> {
|
||||
let mut request_table = app.http().requests.lock().await;
|
||||
let req = request_table
|
||||
.remove(&rid)
|
||||
.ok_or(Error::InvalidRequestId(rid))?;
|
||||
|
||||
let res = match req.0.lock().await.as_mut().await {
|
||||
Ok(Ok(res)) => res,
|
||||
Ok(Err(e)) | Err(e) => return Err(e),
|
||||
};
|
||||
|
||||
let status = res.status();
|
||||
let url = res.url().to_string();
|
||||
let mut headers = Vec::new();
|
||||
for (key, val) in res.headers().iter() {
|
||||
headers.push((
|
||||
key.as_str().into(),
|
||||
String::from_utf8(val.as_bytes().to_vec())?,
|
||||
));
|
||||
}
|
||||
|
||||
app.http().responses.lock().await.insert(rid, res);
|
||||
|
||||
Ok(FetchResponse {
|
||||
status: status.as_u16(),
|
||||
status_text: status.canonical_reason().unwrap_or_default().to_string(),
|
||||
headers,
|
||||
url,
|
||||
})
|
||||
}
|
||||
|
||||
// TODO: change return value to tauri::ipc::Response on next alpha
|
||||
#[command]
|
||||
pub(crate) async fn fetch_read_body<R: Runtime>(
|
||||
app: AppHandle<R>,
|
||||
rid: RequestId,
|
||||
) -> crate::Result<Vec<u8>> {
|
||||
let mut response_table = app.http().responses.lock().await;
|
||||
let res = response_table
|
||||
.remove(&rid)
|
||||
.ok_or(Error::InvalidRequestId(rid))?;
|
||||
|
||||
Ok(res.bytes().await?.to_vec())
|
||||
}
|
||||
@@ -1,341 +0,0 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
use std::{collections::HashMap, path::PathBuf, time::Duration};
|
||||
|
||||
use reqwest::{header, Method, Url};
|
||||
use serde::{Deserialize, Deserializer, Serialize};
|
||||
use serde_json::Value;
|
||||
use serde_repr::{Deserialize_repr, Serialize_repr};
|
||||
|
||||
#[derive(Deserialize)]
|
||||
#[serde(untagged)]
|
||||
enum SerdeDuration {
|
||||
Seconds(u64),
|
||||
Duration(Duration),
|
||||
}
|
||||
|
||||
fn deserialize_duration<'de, D: Deserializer<'de>>(
|
||||
deserializer: D,
|
||||
) -> std::result::Result<Option<Duration>, D::Error> {
|
||||
if let Some(duration) = Option::<SerdeDuration>::deserialize(deserializer)? {
|
||||
Ok(Some(match duration {
|
||||
SerdeDuration::Seconds(s) => Duration::from_secs(s),
|
||||
SerdeDuration::Duration(d) => d,
|
||||
}))
|
||||
} else {
|
||||
Ok(None)
|
||||
}
|
||||
}
|
||||
|
||||
/// The builder of [`Client`].
|
||||
#[derive(Debug, Clone, Default, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct ClientBuilder {
|
||||
/// Max number of redirections to follow.
|
||||
pub max_redirections: Option<usize>,
|
||||
/// Connect timeout for the request.
|
||||
#[serde(deserialize_with = "deserialize_duration", default)]
|
||||
pub connect_timeout: Option<Duration>,
|
||||
}
|
||||
|
||||
impl ClientBuilder {
|
||||
/// Builds the Client.
|
||||
pub fn build(self) -> crate::Result<Client> {
|
||||
let mut client_builder = reqwest::Client::builder();
|
||||
|
||||
if let Some(max_redirections) = self.max_redirections {
|
||||
client_builder = client_builder.redirect(if max_redirections == 0 {
|
||||
reqwest::redirect::Policy::none()
|
||||
} else {
|
||||
reqwest::redirect::Policy::limited(max_redirections)
|
||||
});
|
||||
}
|
||||
|
||||
if let Some(connect_timeout) = self.connect_timeout {
|
||||
client_builder = client_builder.connect_timeout(connect_timeout);
|
||||
}
|
||||
|
||||
let client = client_builder.build()?;
|
||||
Ok(Client(client))
|
||||
}
|
||||
}
|
||||
|
||||
/// The HTTP client based on [`reqwest`].
|
||||
#[derive(Debug, Clone)]
|
||||
pub struct Client(reqwest::Client);
|
||||
|
||||
impl Client {
|
||||
/// Executes an HTTP request
|
||||
///
|
||||
/// # Examples
|
||||
pub async fn send(&self, mut request: HttpRequestBuilder) -> crate::Result<Response> {
|
||||
let method = Method::from_bytes(request.method.to_uppercase().as_bytes())?;
|
||||
|
||||
let mut request_builder = self.0.request(method, request.url.as_str());
|
||||
|
||||
if let Some(query) = request.query {
|
||||
request_builder = request_builder.query(&query);
|
||||
}
|
||||
|
||||
if let Some(timeout) = request.timeout {
|
||||
request_builder = request_builder.timeout(timeout);
|
||||
}
|
||||
|
||||
if let Some(body) = request.body {
|
||||
request_builder = match body {
|
||||
Body::Bytes(data) => request_builder.body(bytes::Bytes::from(data)),
|
||||
Body::Text(text) => request_builder.body(bytes::Bytes::from(text)),
|
||||
Body::Json(json) => request_builder.json(&json),
|
||||
Body::Form(form_body) => {
|
||||
#[allow(unused_variables)]
|
||||
fn send_form(
|
||||
request_builder: reqwest::RequestBuilder,
|
||||
headers: &mut Option<HeaderMap>,
|
||||
form_body: FormBody,
|
||||
) -> crate::Result<reqwest::RequestBuilder> {
|
||||
#[cfg(feature = "multipart")]
|
||||
if matches!(
|
||||
headers
|
||||
.as_ref()
|
||||
.and_then(|h| h.0.get("content-type"))
|
||||
.map(|v| v.as_bytes()),
|
||||
Some(b"multipart/form-data")
|
||||
) {
|
||||
// the Content-Type header will be set by reqwest in the `.multipart` call
|
||||
headers.as_mut().map(|h| h.0.remove("content-type"));
|
||||
let mut multipart = reqwest::multipart::Form::new();
|
||||
|
||||
for (name, part) in form_body.0 {
|
||||
let part = match part {
|
||||
FormPart::File {
|
||||
file,
|
||||
mime,
|
||||
file_name,
|
||||
} => {
|
||||
let bytes: Vec<u8> = file.try_into()?;
|
||||
let mut part = reqwest::multipart::Part::bytes(bytes);
|
||||
if let Some(mime) = mime {
|
||||
part = part.mime_str(&mime)?;
|
||||
}
|
||||
if let Some(file_name) = file_name {
|
||||
part = part.file_name(file_name);
|
||||
}
|
||||
part
|
||||
}
|
||||
FormPart::Text(value) => reqwest::multipart::Part::text(value),
|
||||
};
|
||||
|
||||
multipart = multipart.part(name, part);
|
||||
}
|
||||
|
||||
return Ok(request_builder.multipart(multipart));
|
||||
}
|
||||
|
||||
let mut form = Vec::new();
|
||||
for (name, part) in form_body.0 {
|
||||
match part {
|
||||
FormPart::File { file, .. } => {
|
||||
let bytes: Vec<u8> = file.try_into()?;
|
||||
form.push((name, serde_json::to_string(&bytes)?))
|
||||
}
|
||||
FormPart::Text(value) => form.push((name, value)),
|
||||
}
|
||||
}
|
||||
Ok(request_builder.form(&form))
|
||||
}
|
||||
send_form(request_builder, &mut request.headers, form_body)?
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
if let Some(headers) = request.headers {
|
||||
request_builder = request_builder.headers(headers.0);
|
||||
}
|
||||
|
||||
let http_request = request_builder.build()?;
|
||||
|
||||
let response = self.0.execute(http_request).await?;
|
||||
|
||||
Ok(Response(
|
||||
request.response_type.unwrap_or(ResponseType::Json),
|
||||
response,
|
||||
))
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Serialize_repr, Deserialize_repr, Clone, Debug)]
|
||||
#[repr(u16)]
|
||||
#[non_exhaustive]
|
||||
/// The HTTP response type.
|
||||
pub enum ResponseType {
|
||||
/// Read the response as JSON
|
||||
Json = 1,
|
||||
/// Read the response as text
|
||||
Text,
|
||||
/// Read the response as binary
|
||||
Binary,
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct Response(ResponseType, reqwest::Response);
|
||||
|
||||
impl Response {
|
||||
/// Reads the response.
|
||||
///
|
||||
/// Note that the body is serialized to a [`Value`].
|
||||
pub async fn read(self) -> crate::Result<ResponseData> {
|
||||
let url = self.1.url().clone();
|
||||
|
||||
let mut headers = HashMap::new();
|
||||
let mut raw_headers = HashMap::new();
|
||||
for (name, value) in self.1.headers() {
|
||||
headers.insert(
|
||||
name.as_str().to_string(),
|
||||
String::from_utf8(value.as_bytes().to_vec())?,
|
||||
);
|
||||
raw_headers.insert(
|
||||
name.as_str().to_string(),
|
||||
self.1
|
||||
.headers()
|
||||
.get_all(name)
|
||||
.into_iter()
|
||||
.map(|v| String::from_utf8(v.as_bytes().to_vec()).map_err(Into::into))
|
||||
.collect::<crate::Result<Vec<String>>>()?,
|
||||
);
|
||||
}
|
||||
let status = self.1.status().as_u16();
|
||||
|
||||
let data = match self.0 {
|
||||
ResponseType::Json => self.1.json().await?,
|
||||
ResponseType::Text => Value::String(self.1.text().await?),
|
||||
ResponseType::Binary => serde_json::to_value(&self.1.bytes().await?)?,
|
||||
};
|
||||
|
||||
Ok(ResponseData {
|
||||
url,
|
||||
status,
|
||||
headers,
|
||||
raw_headers,
|
||||
data,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[non_exhaustive]
|
||||
pub struct ResponseData {
|
||||
/// Response URL. Useful if it followed redirects.
|
||||
pub url: Url,
|
||||
/// Response status code.
|
||||
pub status: u16,
|
||||
/// Response headers.
|
||||
pub headers: HashMap<String, String>,
|
||||
/// Response raw headers.
|
||||
pub raw_headers: HashMap<String, Vec<String>>,
|
||||
/// Response data.
|
||||
pub data: Value,
|
||||
}
|
||||
|
||||
/// A file path or contents.
|
||||
#[derive(Debug, Clone, Deserialize)]
|
||||
#[serde(untagged)]
|
||||
#[non_exhaustive]
|
||||
pub enum FilePart {
|
||||
/// File path.
|
||||
Path(PathBuf),
|
||||
/// File contents.
|
||||
Contents(Vec<u8>),
|
||||
}
|
||||
|
||||
impl TryFrom<FilePart> for Vec<u8> {
|
||||
type Error = crate::Error;
|
||||
fn try_from(file: FilePart) -> crate::Result<Self> {
|
||||
let bytes = match file {
|
||||
FilePart::Path(path) => std::fs::read(path)?,
|
||||
FilePart::Contents(bytes) => bytes,
|
||||
};
|
||||
Ok(bytes)
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Deserialize)]
|
||||
#[serde(untagged)]
|
||||
#[non_exhaustive]
|
||||
pub enum FormPart {
|
||||
/// A string value.
|
||||
Text(String),
|
||||
/// A file value.
|
||||
#[serde(rename_all = "camelCase")]
|
||||
File {
|
||||
/// File path or content.
|
||||
file: FilePart,
|
||||
/// Mime type of this part.
|
||||
/// Only used when the `Content-Type` header is set to `multipart/form-data`.
|
||||
mime: Option<String>,
|
||||
/// File name.
|
||||
/// Only used when the `Content-Type` header is set to `multipart/form-data`.
|
||||
file_name: Option<String>,
|
||||
},
|
||||
}
|
||||
|
||||
#[derive(Debug, Deserialize)]
|
||||
pub struct FormBody(pub(crate) HashMap<String, FormPart>);
|
||||
|
||||
#[derive(Debug, Deserialize)]
|
||||
#[serde(tag = "type", content = "payload")]
|
||||
#[non_exhaustive]
|
||||
pub enum Body {
|
||||
Form(FormBody),
|
||||
Json(Value),
|
||||
Text(String),
|
||||
Bytes(Vec<u8>),
|
||||
}
|
||||
|
||||
#[derive(Debug, Default)]
|
||||
pub struct HeaderMap(header::HeaderMap);
|
||||
|
||||
impl<'de> Deserialize<'de> for HeaderMap {
|
||||
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
|
||||
where
|
||||
D: Deserializer<'de>,
|
||||
{
|
||||
let map = HashMap::<String, String>::deserialize(deserializer)?;
|
||||
let mut headers = header::HeaderMap::default();
|
||||
for (key, value) in map {
|
||||
if let (Ok(key), Ok(value)) = (
|
||||
header::HeaderName::from_bytes(key.as_bytes()),
|
||||
header::HeaderValue::from_str(&value),
|
||||
) {
|
||||
headers.insert(key, value);
|
||||
} else {
|
||||
return Err(serde::de::Error::custom(format!(
|
||||
"invalid header `{key}` `{value}`"
|
||||
)));
|
||||
}
|
||||
}
|
||||
Ok(Self(headers))
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct HttpRequestBuilder {
|
||||
/// The request method (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, CONNECT or TRACE)
|
||||
pub method: String,
|
||||
/// The request URL
|
||||
pub url: Url,
|
||||
/// The request query params
|
||||
pub query: Option<HashMap<String, String>>,
|
||||
/// The request headers
|
||||
pub headers: Option<HeaderMap>,
|
||||
/// The request body
|
||||
pub body: Option<Body>,
|
||||
/// Timeout for the whole request
|
||||
#[serde(deserialize_with = "deserialize_duration", default)]
|
||||
pub timeout: Option<Duration>,
|
||||
/// The response type (defaults to Json)
|
||||
pub response_type: Option<ResponseType>,
|
||||
}
|
||||
@@ -1,78 +0,0 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
use tauri::{path::SafePathBuf, AppHandle, Runtime, State};
|
||||
use tauri_plugin_fs::FsExt;
|
||||
|
||||
use crate::{ClientId, Http};
|
||||
|
||||
mod client;
|
||||
use client::{Body, ClientBuilder, FilePart, FormPart, HttpRequestBuilder, ResponseData};
|
||||
|
||||
pub use client::Client;
|
||||
|
||||
#[tauri::command]
|
||||
pub async fn create_client<R: Runtime>(
|
||||
_app: AppHandle<R>,
|
||||
http: State<'_, Http<R>>,
|
||||
options: Option<ClientBuilder>,
|
||||
) -> super::Result<ClientId> {
|
||||
let client = options.unwrap_or_default().build()?;
|
||||
let mut store = http.clients.lock().unwrap();
|
||||
let id = rand::random::<ClientId>();
|
||||
store.insert(id, client);
|
||||
Ok(id)
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
pub async fn drop_client<R: Runtime>(
|
||||
_app: AppHandle<R>,
|
||||
http: State<'_, Http<R>>,
|
||||
client: ClientId,
|
||||
) -> super::Result<()> {
|
||||
let mut store = http.clients.lock().unwrap();
|
||||
store.remove(&client);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
pub async fn request<R: Runtime>(
|
||||
app: AppHandle<R>,
|
||||
http: State<'_, Http<R>>,
|
||||
client_id: ClientId,
|
||||
options: Box<HttpRequestBuilder>,
|
||||
) -> super::Result<ResponseData> {
|
||||
if http.scope.is_allowed(&options.url) {
|
||||
let client = http
|
||||
.clients
|
||||
.lock()
|
||||
.unwrap()
|
||||
.get(&client_id)
|
||||
.ok_or_else(|| crate::Error::HttpClientNotInitialized)?
|
||||
.clone();
|
||||
let options = *options;
|
||||
if let Some(Body::Form(form)) = &options.body {
|
||||
for value in form.0.values() {
|
||||
if let FormPart::File {
|
||||
file: FilePart::Path(path),
|
||||
..
|
||||
} = value
|
||||
{
|
||||
if SafePathBuf::new(path.clone()).is_err()
|
||||
|| !app
|
||||
.try_fs_scope()
|
||||
.map(|s| s.is_allowed(path))
|
||||
.unwrap_or_default()
|
||||
{
|
||||
return Err(crate::Error::PathNotAllowed(path.clone()));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
let response = client.send(options).await?;
|
||||
Ok(response.read().await?)
|
||||
} else {
|
||||
Err(crate::Error::UrlNotAllowed(options.url))
|
||||
}
|
||||
}
|
||||
@@ -2,7 +2,6 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
use reqwest::Url;
|
||||
use serde::Deserialize;
|
||||
|
||||
#[derive(Deserialize)]
|
||||
@@ -15,9 +14,9 @@ pub struct Config {
|
||||
/// The scoped URL is matched against the request URL using a glob pattern.
|
||||
///
|
||||
/// Examples:
|
||||
/// - "https://**": allows all HTTPS urls
|
||||
/// - "https://*" or "https://**" : allows all HTTPS urls
|
||||
/// - "https://*.github.com/tauri-apps/tauri": allows any subdomain of "github.com" with the "tauri-apps/api" path
|
||||
/// - "https://myapi.service.com/users/*": allows access to any URLs that begins with "https://myapi.service.com/users/"
|
||||
#[allow(rustdoc::bare_urls)]
|
||||
#[derive(Debug, Default, PartialEq, Eq, Clone, Deserialize)]
|
||||
pub struct HttpAllowlistScope(pub Vec<Url>);
|
||||
pub struct HttpAllowlistScope(pub Vec<String>);
|
||||
|
||||
+25
-10
@@ -2,10 +2,10 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
use std::path::PathBuf;
|
||||
|
||||
use reqwest::Url;
|
||||
use serde::{Serialize, Serializer};
|
||||
use url::Url;
|
||||
|
||||
use crate::RequestId;
|
||||
|
||||
#[derive(Debug, thiserror::Error)]
|
||||
pub enum Error {
|
||||
@@ -15,19 +15,32 @@ pub enum Error {
|
||||
Io(#[from] std::io::Error),
|
||||
#[error(transparent)]
|
||||
Network(#[from] reqwest::Error),
|
||||
#[error(transparent)]
|
||||
Http(#[from] http::Error),
|
||||
#[error(transparent)]
|
||||
HttpInvalidHeaderName(#[from] http::header::InvalidHeaderName),
|
||||
#[error(transparent)]
|
||||
HttpInvalidHeaderValue(#[from] http::header::InvalidHeaderValue),
|
||||
/// URL not allowed by the scope.
|
||||
#[error("url not allowed on the configured scope: {0}")]
|
||||
UrlNotAllowed(Url),
|
||||
/// Path not allowed by the scope.
|
||||
#[error("path not allowed on the configured scope: {0}")]
|
||||
PathNotAllowed(PathBuf),
|
||||
/// Client with specified ID not found.
|
||||
#[error("http client dropped or not initialized")]
|
||||
HttpClientNotInitialized,
|
||||
#[error(transparent)]
|
||||
UrlParseError(#[from] url::ParseError),
|
||||
/// HTTP method error.
|
||||
#[error(transparent)]
|
||||
HttpMethod(#[from] http::method::InvalidMethod),
|
||||
/// Failed to serialize header value as string.
|
||||
#[error("scheme {0} not supported")]
|
||||
SchemeNotSupport(String),
|
||||
#[error("Request canceled")]
|
||||
RequestCanceled,
|
||||
#[error(transparent)]
|
||||
FsError(#[from] tauri_plugin_fs::Error),
|
||||
#[error("failed to process data url")]
|
||||
DataUrlError,
|
||||
#[error("failed to decode data url into bytes")]
|
||||
DataUrlDecodeError,
|
||||
#[error("invalid request id: {0}")]
|
||||
InvalidRequestId(RequestId),
|
||||
#[error(transparent)]
|
||||
Utf8(#[from] std::string::FromUtf8Error),
|
||||
}
|
||||
@@ -40,3 +53,5 @@ impl Serialize for Error {
|
||||
serializer.serialize_str(self.to_string().as_ref())
|
||||
}
|
||||
}
|
||||
|
||||
pub type Result<T> = std::result::Result<T, Error>;
|
||||
|
||||
+41
-21
@@ -6,39 +6,56 @@
|
||||
//!
|
||||
//! Access the HTTP client written in Rust.
|
||||
|
||||
#![doc(
|
||||
html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png",
|
||||
html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png"
|
||||
)]
|
||||
use std::sync::atomic::AtomicU32;
|
||||
use std::{collections::HashMap, future::Future, pin::Pin};
|
||||
|
||||
use config::{Config, HttpAllowlistScope};
|
||||
pub use reqwest as client;
|
||||
pub use reqwest;
|
||||
use reqwest::Response;
|
||||
use tauri::async_runtime::Mutex;
|
||||
use tauri::{
|
||||
plugin::{Builder, TauriPlugin},
|
||||
AppHandle, Manager, Runtime,
|
||||
};
|
||||
|
||||
use std::{collections::HashMap, sync::Mutex};
|
||||
use crate::config::{Config, HttpAllowlistScope};
|
||||
pub use error::{Error, Result};
|
||||
|
||||
mod commands;
|
||||
mod config;
|
||||
mod error;
|
||||
mod scope;
|
||||
|
||||
pub use error::Error;
|
||||
type Result<T> = std::result::Result<T, Error>;
|
||||
type ClientId = u32;
|
||||
type RequestId = u32;
|
||||
type CancelableResponseResult = Result<Result<reqwest::Response>>;
|
||||
type CancelableResponseFuture =
|
||||
Pin<Box<dyn Future<Output = CancelableResponseResult> + Send + Sync>>;
|
||||
type RequestTable = HashMap<RequestId, FetchRequest>;
|
||||
type ResponseTable = HashMap<RequestId, Response>;
|
||||
|
||||
pub struct Http<R: Runtime> {
|
||||
#[allow(dead_code)]
|
||||
app: AppHandle<R>,
|
||||
pub(crate) clients: Mutex<HashMap<ClientId, commands::Client>>,
|
||||
pub(crate) scope: scope::Scope,
|
||||
struct FetchRequest(Mutex<CancelableResponseFuture>);
|
||||
impl FetchRequest {
|
||||
fn new(f: CancelableResponseFuture) -> Self {
|
||||
Self(Mutex::new(f))
|
||||
}
|
||||
}
|
||||
|
||||
impl<R: Runtime> Http<R> {}
|
||||
struct Http<R: Runtime> {
|
||||
#[allow(dead_code)]
|
||||
app: AppHandle<R>,
|
||||
scope: scope::Scope,
|
||||
current_id: AtomicU32,
|
||||
requests: Mutex<RequestTable>,
|
||||
responses: Mutex<ResponseTable>,
|
||||
}
|
||||
|
||||
pub trait HttpExt<R: Runtime> {
|
||||
impl<R: Runtime> Http<R> {
|
||||
fn next_id(&self) -> RequestId {
|
||||
self.current_id
|
||||
.fetch_add(1, std::sync::atomic::Ordering::Relaxed)
|
||||
}
|
||||
}
|
||||
|
||||
trait HttpExt<R: Runtime> {
|
||||
fn http(&self) -> &Http<R>;
|
||||
}
|
||||
|
||||
@@ -52,15 +69,18 @@ pub fn init<R: Runtime>() -> TauriPlugin<R, Option<Config>> {
|
||||
Builder::<R, Option<Config>>::new("http")
|
||||
.js_init_script(include_str!("api-iife.js").to_string())
|
||||
.invoke_handler(tauri::generate_handler![
|
||||
commands::create_client,
|
||||
commands::drop_client,
|
||||
commands::request
|
||||
commands::fetch,
|
||||
commands::fetch_cancel,
|
||||
commands::fetch_send,
|
||||
commands::fetch_read_body,
|
||||
])
|
||||
.setup(|app, api| {
|
||||
let default_scope = HttpAllowlistScope::default();
|
||||
app.manage(Http {
|
||||
app: app.clone(),
|
||||
clients: Default::default(),
|
||||
current_id: 0.into(),
|
||||
requests: Default::default(),
|
||||
responses: Default::default(),
|
||||
scope: scope::Scope::new(
|
||||
api.config()
|
||||
.as_ref()
|
||||
|
||||
@@ -2,10 +2,11 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
use crate::config::HttpAllowlistScope;
|
||||
use glob::Pattern;
|
||||
use reqwest::Url;
|
||||
|
||||
use crate::config::HttpAllowlistScope;
|
||||
|
||||
/// Scope for filesystem access.
|
||||
#[derive(Debug, Clone)]
|
||||
pub struct Scope {
|
||||
@@ -20,7 +21,7 @@ impl Scope {
|
||||
.0
|
||||
.iter()
|
||||
.map(|url| {
|
||||
glob::Pattern::new(url.as_str()).unwrap_or_else(|_| {
|
||||
glob::Pattern::new(url).unwrap_or_else(|_| {
|
||||
panic!("scoped URL is not a valid glob pattern: `{url}`")
|
||||
})
|
||||
})
|
||||
@@ -30,9 +31,10 @@ impl Scope {
|
||||
|
||||
/// Determines if the given URL is allowed on this scope.
|
||||
pub fn is_allowed(&self, url: &Url) -> bool {
|
||||
self.allowed_urls
|
||||
.iter()
|
||||
.any(|allowed| allowed.matches(url.as_str()))
|
||||
self.allowed_urls.iter().any(|allowed| {
|
||||
allowed.matches(url.as_str())
|
||||
|| allowed.matches(url.as_str().strip_suffix('/').unwrap_or_default())
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
@@ -79,7 +81,7 @@ mod tests {
|
||||
let scope = super::Scope::new(&HttpAllowlistScope(vec!["http://*".parse().unwrap()]));
|
||||
|
||||
assert!(scope.is_allowed(&"http://something.else".parse().unwrap()));
|
||||
assert!(!scope.is_allowed(&"http://something.else/path/to/file".parse().unwrap()));
|
||||
assert!(scope.is_allowed(&"http://something.else/path/to/file".parse().unwrap()));
|
||||
assert!(!scope.is_allowed(&"https://something.else".parse().unwrap()));
|
||||
|
||||
let scope = super::Scope::new(&HttpAllowlistScope(vec!["http://**".parse().unwrap()]));
|
||||
|
||||
Reference in New Issue
Block a user