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
use crate::{RequestWithParams, ReusableBoxFuture};
use futures::FutureExt;
use std::io;
use crate::core::context::Context;
use crate::core::request::Request;
use crate::parser::{middleware_traits::MiddlewareTuple, tree::Node, tree::NodeOutput};
use crate::{
context::basic_context::{generate_context, BasicContext},
core::request::ThrusterRequest,
};
pub trait Middleware<CIn: Send, COut: Send, CErr: Send>:
FnOnce(CIn) -> ReusableBoxFuture<Result<COut, CErr>> + Send
{
fn val(&self) -> Self
where
Self: Sized + Copy,
{
panic!("Never use this.")
}
}
// type ReturnValue<T> = Result<T, ThrusterError<T>>;
pub type ReturnValue<T> = T;
/// App, the main component of Thruster. The App is the entry point for your application
/// and handles all incomming requests. Apps are also composeable, that is, via the `subapp`
/// method, you can use all of the methods and middlewares contained within an app as a subset
/// of your app's routes.
///
/// There are three main parts to creating a thruster app:
/// 1. Use `App.create` to create a new app with a custom context generator
/// 2. Add routes and middleware via `.get`, `.post`, etc.
/// 3. Build the app future with `App.build` and spawn it on the executor
///
/// # Examples
/// Subapp
///
/// ```rust, ignore
/// let mut app1 = App::<Request, BasicContext>::new();
///
/// fn test_fn_1(context: BasicContext, next: impl Fn(BasicContext) -> MiddlewareReturnValue<BasicContext> + Send) -> MiddlewareReturnValue<BasicContext> {
/// Box::new(future::ok(BasicContext {
/// body: context.params.get("id").unwrap().to_owned(),
/// params: context.params,
/// query_params: context.query_params
/// }))
/// };
///
/// app1.get("/:id", middleware![BasicContext => test_fn_1]);
///
/// let mut app2 = App::<Request, BasicContext>::new();
/// app2.use_sub_app("/test", app1);
/// ```
///
/// In the above example, the route `/test/some-id` will return `some-id` in the body of the response.
///
/// The provided start methods are great places to start, but you can also simply use Thruster as a router
/// and create your own version of an HTTP server by directly calling `App.resolve` with a Request object.
/// It will then return a future with the Response object that corresponds to the request. This can be
/// useful if trying to integrate with a different type of load balancing system within the threads of the
/// application.
pub struct App<R: ThrusterRequest, T: 'static + Context + Clone + Send + Sync, S: Send> {
pub delete_root: Node<ReturnValue<T>>,
pub get_root: Node<ReturnValue<T>>,
pub options_root: Node<ReturnValue<T>>,
pub post_root: Node<ReturnValue<T>>,
pub put_root: Node<ReturnValue<T>>,
pub patch_root: Node<ReturnValue<T>>,
/// Generate context is common to all `App`s. It's the function that's called upon receiving a request
/// that translates an acutal `Request` struct to your custom Context type. It should be noted that
/// the context_generator should be as fast as possible as this is called with every request, including
/// 404s.
pub context_generator: fn(R, &S, &str) -> T,
pub state: std::sync::Arc<S>,
/// The connection timeout for the app in milliseconds. Defaults to 3600000ms (1 hour)
pub connection_timeout: u64,
}
impl<R: 'static + ThrusterRequest, T: Context + Clone + Send + Sync, S: 'static + Send>
App<R, T, S>
{
/// Creates a new instance of app with the library supplied `BasicContext`. Useful for trivial
/// examples, likely not a good solution for real code bases. The advantage is that the
/// context_generator is already supplied for the developer.
pub fn new_basic() -> App<Request, BasicContext, ()> {
App::create(generate_context, ())
}
/// Create a new app with the given context generator. The app does not begin listening until start
/// is called.
pub fn create(generate_context: fn(R, &S, &str) -> T, state: S) -> Self {
App {
delete_root: Node::default(),
get_root: Node::default(),
options_root: Node::default(),
post_root: Node::default(),
put_root: Node::default(),
patch_root: Node::default(),
context_generator: generate_context,
state: std::sync::Arc::new(state),
connection_timeout: 3600000,
}
}
/// Add method-agnostic middleware for a route. This is useful for applying headers, logging, and
/// anything else that might not be sensitive to the HTTP method for the endpoint.
pub fn middleware(mut self, path: &str, middlewares: MiddlewareTuple<ReturnValue<T>>) -> Self
where
T: Clone,
{
self.get_root
.add_non_leaf_value_at_path(path, middlewares.clone());
self.options_root
.add_non_leaf_value_at_path(path, middlewares.clone());
self.post_root
.add_non_leaf_value_at_path(path, middlewares.clone());
self.put_root
.add_non_leaf_value_at_path(path, middlewares.clone());
self.delete_root
.add_non_leaf_value_at_path(path, middlewares.clone());
self.patch_root
.add_non_leaf_value_at_path(path, middlewares);
self
}
#[deprecated(
note = "`use_middleware` is deprecated. Please migrate to use `middleware` in the future."
)]
pub fn use_middleware(self, path: &str, middlewares: MiddlewareTuple<ReturnValue<T>>) -> Self
where
T: Clone,
{
self.middleware(path, middlewares)
}
/// Add an app as a predetermined set of routes and middleware. Will prefix whatever string is passed
/// in to all of the routes. This is a main feature of Thruster, as it allows projects to be extermely
/// modular and composeable in nature.
pub fn router(mut self, prefix: &str, app: App<R, T, S>) -> Self {
self.get_root.add_node_at_path(prefix, app.get_root);
self.options_root.add_node_at_path(prefix, app.options_root);
self.post_root.add_node_at_path(prefix, app.post_root);
self.put_root.add_node_at_path(prefix, app.put_root);
self.delete_root.add_node_at_path(prefix, app.delete_root);
self.patch_root.add_node_at_path(prefix, app.patch_root);
self
}
#[deprecated(
note = "`use_sub_app` is deprecated. Please migrate to use `router` in the future."
)]
pub fn use_sub_app(self, prefix: &str, app: App<R, T, S>) -> Self {
self.router(prefix, app)
}
/// Add a route that responds to `GET`s to a given path
pub fn get(mut self, path: &str, middlewares: MiddlewareTuple<ReturnValue<T>>) -> Self {
self.get_root.add_value_at_path(path, middlewares);
self
}
/// Add a route that responds to `OPTION`s to a given path
pub fn options(mut self, path: &str, middlewares: MiddlewareTuple<ReturnValue<T>>) -> Self {
self.options_root.add_value_at_path(path, middlewares);
self
}
/// Add a route that responds to `POST`s to a given path
pub fn post(mut self, path: &str, middlewares: MiddlewareTuple<ReturnValue<T>>) -> Self {
self.post_root.add_value_at_path(path, middlewares);
self
}
/// Add a route that responds to `PUT`s to a given path
pub fn put(mut self, path: &str, middlewares: MiddlewareTuple<ReturnValue<T>>) -> Self {
self.put_root.add_value_at_path(path, middlewares);
self
}
/// Add a route that responds to `DELETE`s to a given path
pub fn delete(mut self, path: &str, middlewares: MiddlewareTuple<ReturnValue<T>>) -> Self {
self.delete_root.add_value_at_path(path, middlewares);
self
}
/// Add a route that responds to `PATCH`s to a given path
pub fn patch(mut self, path: &str, middlewares: MiddlewareTuple<ReturnValue<T>>) -> Self {
self.patch_root.add_value_at_path(path, middlewares);
self
}
/// Sets the middleware if no route is successfully matched. Note, that due to type restrictions,
/// we Context needs to implement Clone in order to call this function, even though _clone will
/// never be called._
pub fn set404(mut self, middlewares: MiddlewareTuple<ReturnValue<T>>) -> Self
where
T: Clone,
{
self.get_root.add_value_at_path("/*", middlewares.clone());
self.options_root
.add_value_at_path("/*", middlewares.clone());
self.post_root.add_value_at_path("/*", middlewares.clone());
self.put_root.add_value_at_path("/*", middlewares.clone());
self.delete_root
.add_value_at_path("/*", middlewares.clone());
self.patch_root.add_value_at_path("/*", middlewares);
self
}
/// Sets whether this app router uses strict mode for route parsing or not. Strict mode considers
/// `/a` to be distinct from `/a/`.
pub fn set_strict_mode(mut self, strict_mode: bool) -> Self
where
T: Clone,
{
self.get_root.strict_mode = strict_mode;
self.options_root.strict_mode = strict_mode;
self.post_root.strict_mode = strict_mode;
self.put_root.strict_mode = strict_mode;
self.delete_root.strict_mode = strict_mode;
self.patch_root.strict_mode = strict_mode;
self
}
/// Commits and locks in the route tree for usage.
pub fn commit(mut self) -> Self {
self.get_root = self.get_root.commit();
self.options_root = self.options_root.commit();
self.post_root = self.post_root.commit();
self.put_root = self.put_root.commit();
self.delete_root = self.delete_root.commit();
self.patch_root = self.patch_root.commit();
self
}
pub fn resolve_from_method_and_path<'m>(
&'m self,
method: &str,
path: String,
) -> NodeOutput<'m, ReturnValue<T>> {
match method {
"OPTIONS" => self.options_root.get_value_at_path(path),
"POST" => self.post_root.get_value_at_path(path),
"PUT" => self.put_root.get_value_at_path(path),
"DELETE" => self.delete_root.get_value_at_path(path),
"PATCH" => self.patch_root.get_value_at_path(path),
// default get
_ => self.get_root.get_value_at_path(path),
}
}
pub fn match_and_resolve<'m>(
&'m self,
mut request: R,
) -> ReusableBoxFuture<Result<T::Response, io::Error>>
where
R: RequestWithParams,
{
let method = request.method();
let path = request.path();
let node = match method {
"OPTIONS" => self.options_root.get_value_at_path(path),
"POST" => self.post_root.get_value_at_path(path),
"PUT" => self.put_root.get_value_at_path(path),
"DELETE" => self.delete_root.get_value_at_path(path),
"PATCH" => self.patch_root.get_value_at_path(path),
// default get
_ => self.get_root.get_value_at_path(path),
};
request.set_params(node.params);
let context = (self.context_generator)(request, &self.state, &node.path);
ReusableBoxFuture::new((node.value)(context).map(|ctx| {
let ctx = match ctx {
Ok(val) => val,
Err(mut e) => {
e.context.set_body(e.message.into_bytes());
e.context
}
};
Ok(ctx.get_response())
}))
// let copy = node.value;
// let ctx = (copy)(context).await;
// let ctx = match ctx {
// Ok(val) => val,
// Err(e) => e.context,
// };
// Ok(ctx.get_response())
// let copy = node.value;
// let ctx = (copy)(context).await;
// let ctx = match ctx {
// Ok(val) => val,
// Err(e) => e.context,
// };
// Ok(ctx.get_response())
}
pub async fn resolve<'m>(
&self,
request: R,
matched_route: NodeOutput<'m, T>,
) -> Result<T::Response, io::Error> {
self._resolve(request, matched_route).await
}
async fn _resolve<'m>(
&self,
request: R,
matched_route: NodeOutput<'m, T>,
) -> Result<T::Response, io::Error> {
let context = (self.context_generator)(request, &self.state, &matched_route.path);
let copy = matched_route.value;
let ctx = (copy)(context).await;
let ctx = match ctx {
Ok(val) => val,
Err(mut e) => {
e.context.set_body(e.message.into_bytes());
e.context
}
};
Ok(ctx.get_response())
}
}