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
use crate::{Conn, IntoUrl, Pool, USER_AGENT};
use std::{fmt::Debug, sync::Arc};
use trillium_http::{
transport::BoxedTransport, HeaderName, HeaderValues, Headers, KnownHeaderName, Method,
ReceivedBodyState,
};
use trillium_server_common::{
url::{Origin, Url},
Connector, ObjectSafeConnector,
};
/**
A client contains a Config and an optional connection pool and builds
conns.
*/
#[derive(Clone, Debug)]
pub struct Client {
config: Arc<dyn ObjectSafeConnector>,
pool: Option<Pool<Origin, BoxedTransport>>,
base: Option<Arc<Url>>,
default_headers: Arc<Headers>,
}
macro_rules! method {
($fn_name:ident, $method:ident) => {
method!(
$fn_name,
$method,
concat!(
// yep, macro-generated doctests
"Builds a new client conn with the ",
stringify!($fn_name),
" http method and the provided url.
```
# use trillium_testing::prelude::*;
# use trillium_smol::ClientConfig;
# use trillium_client::Client;
let client = Client::new(ClientConfig::default());
let conn = client.",
stringify!($fn_name),
"(\"http://localhost:8080/some/route\"); //<-
assert_eq!(conn.method(), Method::",
stringify!($method),
");
assert_eq!(conn.url().to_string(), \"http://localhost:8080/some/route\");
```
"
)
);
};
($fn_name:ident, $method:ident, $doc_comment:expr) => {
#[doc = $doc_comment]
pub fn $fn_name(&self, url: impl IntoUrl) -> Conn {
self.build_conn(Method::$method, url)
}
};
}
pub(crate) fn default_request_headers() -> Headers {
Headers::new()
.with_inserted_header(KnownHeaderName::UserAgent, USER_AGENT)
.with_inserted_header(KnownHeaderName::Accept, "*/*")
}
impl Client {
/// builds a new client from this `Connector`
pub fn new(config: impl Connector) -> Self {
Self {
config: config.arced(),
pool: None,
base: None,
default_headers: Arc::new(default_request_headers()),
}
}
/// chainable method to remove a header from default request headers
pub fn without_default_header(mut self, name: impl Into<HeaderName<'static>>) -> Self {
self.default_headers_mut().remove(name);
self
}
/// chainable method to insert a new default request header, replacing any existing value
pub fn with_default_header(
mut self,
name: impl Into<HeaderName<'static>>,
value: impl Into<HeaderValues>,
) -> Self {
self.default_headers_mut().insert(name, value);
self
}
/// borrow the default headers
pub fn default_headers(&self) -> &Headers {
&self.default_headers
}
/// borrow the default headers mutably
///
/// calling this will copy-on-write if the default headers are shared with another client clone
pub fn default_headers_mut(&mut self) -> &mut Headers {
Arc::make_mut(&mut self.default_headers)
}
/**
chainable constructor to enable connection pooling. this can be
combined with [`Client::with_config`]
```
use trillium_smol::ClientConfig;
use trillium_client::Client;
let client = Client::new(ClientConfig::default())
.with_default_pool(); //<-
```
*/
pub fn with_default_pool(mut self) -> Self {
self.pool = Some(Pool::default());
self
}
/**
builds a new conn.
if the client has pooling enabled and there is
an available connection to the dns-resolved socket (ip and port),
the new conn will reuse that when it is sent.
```
use trillium_smol::ClientConfig;
use trillium_client::Client;
use trillium_testing::prelude::*;
let client = Client::new(ClientConfig::default());
let conn = client.build_conn("get", "http://trillium.rs"); //<-
assert_eq!(conn.method(), Method::Get);
assert_eq!(conn.url().host_str().unwrap(), "trillium.rs");
```
*/
pub fn build_conn<M>(&self, method: M, url: impl IntoUrl) -> Conn
where
M: TryInto<Method>,
<M as TryInto<Method>>::Error: Debug,
{
Conn {
url: self.build_url(url).unwrap(),
method: method.try_into().unwrap(),
request_headers: Headers::clone(&self.default_headers),
response_headers: Headers::new(),
transport: None,
status: None,
request_body: None,
pool: self.pool.clone(),
buffer: Vec::with_capacity(128).into(),
response_body_state: ReceivedBodyState::Start,
config: Arc::clone(&self.config),
headers_finalized: false,
}
}
/// borrow the connector for this client
pub fn connector(&self) -> &Arc<dyn ObjectSafeConnector> {
&self.config
}
/**
The pool implementation currently accumulates a small memory
footprint for each new host. If your application is reusing a pool
against a large number of unique hosts, call this method
intermittently.
*/
pub fn clean_up_pool(&self) {
if let Some(pool) = &self.pool {
pool.cleanup();
}
}
/// chainable method to set the base for this client
pub fn with_base(mut self, base: impl IntoUrl) -> Self {
self.set_base(base).unwrap();
self
}
/// retrieve the base for this client, if any
pub fn base(&self) -> Option<&Url> {
self.base.as_deref()
}
/// attempt to build a url from this IntoUrl and the [`Client::base`], if set
pub fn build_url(&self, url: impl IntoUrl) -> crate::Result<Url> {
url.into_url(self.base())
}
/// set the base for this client
pub fn set_base(&mut self, base: impl IntoUrl) -> crate::Result<()> {
let mut base = base.into_url(None)?;
if !base.path().ends_with('/') {
log::warn!("appending a trailing / to {base}");
base.set_path(&format!("{}/", base.path()));
}
self.base = Some(Arc::new(base));
Ok(())
}
method!(get, Get);
method!(post, Post);
method!(put, Put);
method!(delete, Delete);
method!(patch, Patch);
}
impl<T: Connector> From<T> for Client {
fn from(connector: T) -> Self {
Self::new(connector)
}
}