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 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
use std::{collections::HashMap, future::Future, pin::Pin};
use dyn_clone::{clone_trait_object, DynClone};
use matchit::{Match, Router as MatchRouter};
use crate::{
http::{HttpRequest, HttpResponse},
method::Method,
};
/// A container for a handler and a flag indicating whether the handler supports HTTP upgrades.
#[derive(Clone)]
pub(crate) struct HandlerContainer {
pub(crate) upgrade: bool,
pub(crate) handler: Box<dyn Handler>,
}
/// A router for HTTP requests.
/// The router is used to register handlers for different HTTP methods and paths.
#[derive(Clone)]
pub struct Router {
prefix: String,
trees: HashMap<Method, MatchRouter<HandlerContainer>>,
pub(crate) handle_options: bool,
pub(crate) global_options: Option<HandlerContainer>,
}
impl Router {
/// Create a new router.
/// The router is used to register handlers for different HTTP methods and paths.
/// The router can be used as a handler for a server.
/// # Examples
///
/// ``` rust
/// use pluto::router::Router;
///
/// let mut router = Router::new();
/// ```
pub fn new() -> Self {
Self {
prefix: String::from(""),
trees: HashMap::new(),
handle_options: true,
global_options: None,
}
}
/// Set a prefix for all paths registered on the router.
/// # Examples
///
/// ``` rust
/// use pluto::router::Router;
///
/// let mut router = Router::new();
/// router.set_global_prefix("/api".to_string());
/// ```
pub fn set_global_prefix(&mut self, p: String) -> &mut Self {
self.prefix = p;
self
}
/// Register a handler for a path and method.
/// The handler is called for requests with a matching path and method.
/// # Examples
///
/// ``` rust
/// use pluto::router::Router;
/// use pluto::http::{HttpRequest, HttpResponse};
/// use pluto::method::Method;
/// use serde_json::json;
/// use std::collections::HashMap;
///
/// let mut router = Router::new();
/// router.handle("/hello", false, Method::GET, |req: HttpRequest| async move {
/// Ok(HttpResponse {
/// status_code: 200,
/// headers: HashMap::new(),
/// body: json!({
/// "statusCode": 200,
/// "message": "Hello World from GET",
/// })
/// .into(),
/// })
/// });
/// ```
pub fn handle(
&mut self,
path: &str,
upgrade: bool,
method: Method,
handler: impl Handler + 'static,
) -> &mut Self {
if !path.starts_with('/') {
panic!("expect path beginning with '/', found: '{}'", path);
}
let mut global_path = self.prefix.to_owned() + path;
if global_path.ends_with("/") {
global_path.pop();
}
match self.trees.entry(method).or_default().insert(
global_path,
HandlerContainer {
handler: Box::new(handler),
upgrade: upgrade,
},
) {
Err(err) => panic!("\nERROR: {}\n", err),
Ok(_) => {}
}
self
}
/// Lookup a handler for a path and method.
/// The handler is called for requests with a matching path and method.
pub(crate) fn lookup<'a>(
&'a self,
method: Method,
path: &'a str,
) -> Result<Match<&HandlerContainer>, String> {
if let Some(tree_at_path) = self.trees.get(&method) {
if let Ok(match_result) = tree_at_path.at(path) {
return Ok(match_result);
}
}
if path == "" {
return Err(format!("Cannot {} {}", method, "/"));
}
return Err(format!("Cannot {} {}", method, path));
}
/// Register a handler for GET requests at a path.
/// The handler is called for requests with the GET method and a matching path.
/// # Examples
///
/// ``` rust
/// use pluto::router::Router;
/// use pluto::http::{HttpRequest, HttpResponse};
/// use pluto::method::Method;
/// use serde_json::json;
/// use std::collections::HashMap;
///
/// let mut router = Router::new();
/// router.get("/hello", false, |req: HttpRequest| async move {
/// Ok(HttpResponse {
/// status_code: 200,
/// headers: HashMap::new(),
/// body: json!({
/// "statusCode": 200,
/// "message": "Hello World from GET",
/// })
/// .into(),
/// })
/// });
/// ```
pub fn get(&mut self, path: &str, upgrade: bool, handler: impl Handler + 'static) -> &mut Self {
self.handle(path, upgrade, Method::GET, handler)
}
/// Register a handler for HEAD requests at a path.
/// The handler is called for requests with the HEAD method and a matching path.
/// # Examples
///
/// ``` rust
/// use pluto::router::Router;
/// use pluto::http::{HttpRequest, HttpResponse};
/// use pluto::method::Method;
/// use serde_json::json;
/// use std::collections::HashMap;
///
/// let mut router = Router::new();
/// router.head("/hello", false, |req: HttpRequest| async move {
/// Ok(HttpResponse {
/// status_code: 200,
/// headers: HashMap::new(),
/// body: json!({
/// "statusCode": 200,
/// "message": "Hello World from HEAD",
/// })
/// .into(),
/// })
/// });
/// ```
pub fn head(
&mut self,
path: &str,
upgrade: bool,
handler: impl Handler + 'static,
) -> &mut Self {
self.handle(path, upgrade, Method::HEAD, handler)
}
/// Register a handler for OPTIONS requests at a path.
/// The handler is called for requests with the OPTIONS method and a matching path.
/// # Examples
///
/// ``` rust
/// use pluto::router::Router;
/// use pluto::http::{HttpRequest, HttpResponse};
/// use pluto::method::Method;
/// use serde_json::json;
/// use std::collections::HashMap;
///
/// let mut router = Router::new();
/// router.options("/hello", false, |req: HttpRequest| async move {
/// Ok(HttpResponse {
/// status_code: 200,
/// headers: HashMap::new(),
/// body: json!({
/// "statusCode": 200,
/// "message": "Hello World from OPTIONS",
/// })
/// .into(),
/// })
/// });
/// ```
pub fn options(
&mut self,
path: &str,
upgrade: bool,
handler: impl Handler + 'static,
) -> &mut Self {
self.handle(path, upgrade, Method::OPTIONS, handler)
}
/// Register a handler for POST requests at a path.
/// The handler is called for requests with the POST method and a matching path.
/// # Examples
///
/// ``` rust
/// use pluto::router::Router;
/// use pluto::http::{HttpRequest, HttpResponse};
/// use pluto::method::Method;
/// use serde_json::json;
/// use std::collections::HashMap;
///
/// let mut router = Router::new();
/// router.post("/hello", false, |req: HttpRequest| async move {
/// Ok(HttpResponse {
/// status_code: 200,
/// headers: HashMap::new(),
/// body: json!({
/// "statusCode": 200,
/// "message": "Hello World from POST",
/// })
/// .into(),
/// })
/// });
/// ```
pub fn post(
&mut self,
path: &str,
upgrade: bool,
handler: impl Handler + 'static,
) -> &mut Self {
self.handle(path, upgrade, Method::POST, handler)
}
/// Register a handler for PUT requests at a path.
/// The handler is called for requests with the PUT method and a matching path.
/// # Examples
///
/// ``` rust
/// use pluto::router::Router;
/// use pluto::http::{HttpRequest, HttpResponse};
/// use pluto::method::Method;
/// use serde_json::json;
/// use std::collections::HashMap;
///
/// let mut router = Router::new();
/// router.put("/hello", false, |req: HttpRequest| async move {
/// Ok(HttpResponse {
/// status_code: 200,
/// headers: HashMap::new(),
/// body: json!({
/// "statusCode": 200,
/// "message": "Hello World from PUT",
/// })
/// .into(),
/// })
/// });
/// ```
pub fn put(&mut self, path: &str, upgrade: bool, handler: impl Handler + 'static) -> &mut Self {
self.handle(path, upgrade, Method::PUT, handler)
}
/// Register a handler for PATCH requests at a path.
/// The handler is called for requests with the PATCH method and a matching path.
/// # Examples
///
/// ``` rust
/// use pluto::router::Router;
/// use pluto::http::{HttpRequest, HttpResponse};
/// use pluto::method::Method;
/// use serde_json::json;
/// use std::collections::HashMap;
///
/// let mut router = Router::new();
/// router.patch("/hello", false, |req: HttpRequest| async move {
/// Ok(HttpResponse {
/// status_code: 200,
/// headers: HashMap::new(),
/// body: json!({
/// "statusCode": 200,
/// "message": "Hello World from PATCH",
/// })
/// .into(),
/// })
/// });
/// ```
pub fn patch(
&mut self,
path: &str,
upgrade: bool,
handler: impl Handler + 'static,
) -> &mut Self {
self.handle(path, upgrade, Method::PATCH, handler)
}
/// Register a handler for DELETE requests at a path.
/// The handler is called for requests with the DELETE method and a matching path.
/// # Examples
///
/// ``` rust
/// use pluto::router::Router;
/// use pluto::http::{HttpRequest, HttpResponse};
/// use pluto::method::Method;
/// use serde_json::json;
/// use std::collections::HashMap;
///
/// let mut router = Router::new();
/// router.delete("/hello", false, |req: HttpRequest| async move {
/// Ok(HttpResponse {
/// status_code: 200,
/// headers: HashMap::new(),
/// body: json!({
/// "statusCode": 200,
/// "message": "Hello World from DELETE",
/// })
/// .into(),
/// })
/// });
/// ```
pub fn delete(
&mut self,
path: &str,
upgrade: bool,
handler: impl Handler + 'static,
) -> &mut Self {
self.handle(path, upgrade, Method::DELETE, handler)
}
/// Allow the router to handle OPTIONS requests.
/// If enabled, the router will automatically respond to OPTIONS requests with the allowed methods for a path.
/// If disabled, the router will respond to OPTIONS requests with a 404.
/// # Examples
///
/// ``` rust
/// use pluto::router::Router;
///
/// let mut router = Router::new();
/// router.handle_options(true);
/// ```
pub fn handle_options(&mut self, handle: bool) {
self.handle_options = handle;
}
/// Register a default handler for not registered requests.
/// The handler is called for requests when router can't matching path or method to any handler.
/// # Examples
///
/// ``` rust
/// use pluto::router::Router;
/// use pluto::http::{HttpRequest, HttpResponse};
/// use serde_json::json;
/// use std::collections::HashMap;
///
/// let mut router = Router::new();
/// router.global_options(false, |req: HttpRequest| async move {
/// Ok(HttpResponse {
/// status_code: 404,
/// headers: HashMap::new(),
/// body: json!({
/// "statusCode": 404,
/// "message": "Not Found",
/// })
/// .into(),
/// })
/// });
/// ```
pub fn global_options(mut self, upgrade: bool, handler: impl Handler + 'static) -> Self {
self.global_options = Some(HandlerContainer {
handler: Box::new(handler),
upgrade: upgrade,
});
self
}
/// Get the allowed methods for a path.
/// # Examples
///
/// ``` rust
/// use pluto::router::Router;
/// use pluto::http::{HttpRequest, HttpResponse};
/// use serde_json::json;
/// use std::collections::HashMap;
///
/// let mut router = Router::new();
/// router.get("/hello", false, |req: HttpRequest| async move {
/// Ok(HttpResponse {
/// status_code: 200,
/// headers: HashMap::new(),
/// body: json!({
/// "statusCode": 200,
/// "message": "Hello World from GET",
/// })
/// .into(),
/// })
/// });
/// router.post("/hello", false, |req: HttpRequest| async move {
/// Ok(HttpResponse {
/// status_code: 200,
/// headers: HashMap::new(),
/// body: json!({
/// "statusCode": 200,
/// "message": "Hello World from POST",
/// })
/// .into(),
/// })
/// });
/// let mut allowed = router.allowed("/hello");
/// allowed.sort();
/// assert_eq!(allowed, vec!["GET", "OPTIONS", "POST"]);
pub fn allowed(&self, path: &str) -> Vec<&str> {
let mut allowed = match path {
"*" => {
let mut allowed = Vec::with_capacity(self.trees.len());
for method in self
.trees
.keys()
.filter(|&method| method != Method::OPTIONS)
{
allowed.push(method.as_ref());
}
allowed
}
_ => self
.trees
.keys()
.filter(|&method| method != Method::OPTIONS)
.filter(|&method| {
self.trees
.get(method)
.map(|node| node.at(path).is_ok())
.unwrap_or(false)
})
.map(AsRef::as_ref)
.collect::<Vec<_>>(),
};
if !allowed.is_empty() {
allowed.push(Method::OPTIONS.as_ref())
}
allowed
}
}
clone_trait_object!(Handler);
pub trait Handler: Send + Sync + DynClone {
/// Handle a request.
/// The handler is called for requests with a matching path and method.
fn handle(
&self,
req: HttpRequest,
) -> Pin<Box<dyn Future<Output = Result<HttpResponse, HttpResponse>> + Send + Sync>>;
}
impl<F, R> Handler for F
where
F: Fn(HttpRequest) -> R + Send + Sync + DynClone,
R: Future<Output = Result<HttpResponse, HttpResponse>> + Send + Sync + 'static,
{
/// Handle a request.
/// The handler is called for requests with a matching path and method.
fn handle(
&self,
req: HttpRequest,
) -> Pin<Box<dyn Future<Output = Result<HttpResponse, HttpResponse>> + Send + Sync>> {
Box::pin(self(req))
}
}
#[cfg(test)]
mod test {
use serde_json::json;
use super::*;
use crate::http::{HttpRequest, HttpResponse};
use crate::method::Method;
#[test]
fn test_router() {
let mut router = Router::new();
router.get("/hello", false, |_req: HttpRequest| async move {
Ok(HttpResponse {
status_code: 200,
headers: HashMap::new(),
body: json!({
"statusCode": 200,
"message": "Hello World from GET",
})
.into(),
})
});
router.post("/hello", false, |_req: HttpRequest| async move {
Ok(HttpResponse {
status_code: 200,
headers: HashMap::new(),
body: json!({
"statusCode": 200,
"message": "Hello World from POST",
})
.into(),
})
});
router.put("/hello", false, |_req: HttpRequest| async move {
Ok(HttpResponse {
status_code: 200,
headers: HashMap::new(),
body: json!({
"statusCode": 200,
"message": "Hello World from PUT",
})
.into(),
})
});
router.patch("/hello", false, |_req: HttpRequest| async move {
Ok(HttpResponse {
status_code: 200,
headers: HashMap::new(),
body: json!({
"statusCode": 200,
"message": "Hello World from PATCH",
})
.into(),
})
});
router.delete("/hello", false, |_req: HttpRequest| async move {
Ok(HttpResponse {
status_code: 200,
headers: HashMap::new(),
body: json!({
"statusCode": 200,
"message": "Hello World from DELETE",
})
.into(),
})
});
router.head("/hello", false, |_req: HttpRequest| async move {
Ok(HttpResponse {
status_code: 200,
headers: HashMap::new(),
body: json!({
"statusCode": 200,
"message": "Hello World from HEAD",
})
.into(),
})
});
router.options("/hello", false, |_req: HttpRequest| async move {
Ok(HttpResponse {
status_code: 200,
headers: HashMap::new(),
body: json!({
"statusCode": 200,
"message": "Hello World from OPTIONS",
})
.into(),
})
});
let mut allowed = router.allowed("/hello");
allowed.sort();
assert_eq!(
allowed,
vec![
Method::DELETE.as_ref(),
Method::GET.as_ref(),
Method::HEAD.as_ref(),
Method::OPTIONS.as_ref(),
Method::PATCH.as_ref(),
Method::POST.as_ref(),
Method::PUT.as_ref(),
]
);
}
#[test]
fn test_router_prefix() {
let mut router = Router::new();
router.set_global_prefix("/api".to_string());
router.get("/hello", false, |_req: HttpRequest| async move {
Ok(HttpResponse {
status_code: 200,
headers: HashMap::new(),
body: json!({
"statusCode": 200,
"message": "Hello World from GET",
})
.into(),
})
});
router.post("/hello", false, |_req: HttpRequest| async move {
Ok(HttpResponse {
status_code: 200,
headers: HashMap::new(),
body: json!({
"statusCode": 200,
"message": "Hello World from POST",
})
.into(),
})
});
router.put("/hello", false, |_req: HttpRequest| async move {
Ok(HttpResponse {
status_code: 200,
headers: HashMap::new(),
body: json!({
"statusCode": 200,
"message": "Hello World from PUT",
})
.into(),
})
});
router.patch("/hello", false, |_req: HttpRequest| async move {
Ok(HttpResponse {
status_code: 200,
headers: HashMap::new(),
body: json!({
"statusCode": 200,
"message": "Hello World from PATCH",
})
.into(),
})
});
router.delete("/hello", false, |_req: HttpRequest| async move {
Ok(HttpResponse {
status_code: 200,
headers: HashMap::new(),
body: json!({
"statusCode": 200,
"message": "Hello World from DELETE",
})
.into(),
})
});
router.head("/hello", false, |_req: HttpRequest| async move {
Ok(HttpResponse {
status_code: 200,
headers: HashMap::new(),
body: json!({
"statusCode": 200,
"message": "Hello World from HEAD",
})
.into(),
})
});
router.options("/hello", false, |_req: HttpRequest| async move {
Ok(HttpResponse {
status_code: 200,
headers: HashMap::new(),
body: json!({
"statusCode": 200,
"message": "Hello World from OPTIONS",
})
.into(),
})
});
let mut allowed = router.allowed("/api/hello");
allowed.sort();
assert_eq!(
allowed,
vec![
Method::DELETE.as_ref(),
Method::GET.as_ref(),
Method::HEAD.as_ref(),
Method::OPTIONS.as_ref(),
Method::PATCH.as_ref(),
Method::POST.as_ref(),
Method::PUT.as_ref(),
]
);
}
#[tokio::test]
async fn test_lookup_works() {
let mut router = Router::new();
let response = HttpResponse {
status_code: 200,
headers: HashMap::new(),
body: json!({
"message": "Hello World from GET",
})
.into(),
};
router.get("/hello", false, |_req: HttpRequest| async move {
Ok(HttpResponse {
status_code: 200,
headers: HashMap::new(),
body: json!({
"message": "Hello World from GET",
})
.into(),
})
});
let allowed = router.lookup(Method::GET, "/hello").unwrap();
let result = allowed
.value
.handler
.handle(
crate::http::RawHttpRequest {
method: "GET".to_string(),
url: "http:://localhost:8080/hello".to_string(),
headers: Vec::new(),
body: Vec::new(),
}
.into(),
)
.await
.unwrap();
assert_eq!(
result,
HttpResponse {
status_code: 200,
headers: HashMap::new(),
body: json!({
"message": "Hello World from GET",
})
.into(),
}
);
}
}