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
use crate::{Conn, IntoUrl, Pool};
use std::{convert::TryInto, fmt::Debug, sync::Arc};
use trillium_http::{transport::BoxedTransport, Method};
use trillium_server_common::{Connector, ObjectSafeConnector, Url};
use url::Origin;
/**
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>>,
}
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)
}
};
}
impl Client {
/// builds a new client from this `Connector`
pub fn new(config: impl Connector) -> Self {
Self {
config: config.arced(),
pool: None,
base: None,
}
}
/**
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,
{
let mut conn = Conn::new_with_config(
Arc::clone(&self.config),
method.try_into().unwrap(),
self.build_url(url).unwrap(),
);
if let Some(pool) = &self.pool {
conn.set_pool(pool.clone());
}
conn
}
/**
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)
}
}