Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add catch all routes #197

Merged
merged 7 commits into from
Sep 5, 2023
Merged

feat: add catch all routes #197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4e3789e
feat: add catch all routes
Aug 20, 2023
b6fce94
fix: /sub/[id] is better than /[id]/sub
Aug 27, 2023
4cbceec
fix: pr advices
Aug 28, 2023
6db4a36
test: add routes_sorted_on_creation test
Sep 3, 2023
f05fc9f
chore: Merge v1.5.0
Sep 3, 2023
b0c8218
fix: clean code
Sep 3, 2023
f5ff2d5
chore: implement PartialOrd
ereslibre Sep 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 47 additions & 91 deletions crates/router/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@

mod files;
mod route;

use files::Files;
use route::RouteAffinity;
use std::path::{Path, PathBuf};
use std::time::Instant;
use wws_config::Config;
Expand Down Expand Up @@ -50,6 +48,7 @@ impl Routes {
for route_path in route_paths {
routes.push(Route::new(path, route_path, &prefix, config));
}
routes.sort();
ereslibre marked this conversation as resolved.
Show resolved Hide resolved
println!("✅ Workers loaded in {:?}.", start.elapsed());

Self { routes, prefix }
Expand All @@ -59,23 +58,16 @@ impl Routes {
self.routes.iter()
}

/// Based on a set of routes and a given path, it provides the best
/// match based on the parametrized URL score. See the [`Route::can_manage_path`]
/// method to understand how to calculate the score.
/// Provides the **first** route that can handle the given path.
/// This only works because the routes are already sorted.
/// Because a '/a/b' route may be served by:
/// - /a/b.js
/// - /a/[id].js
/// - /[id]/b.wasm
/// - /[id]/[other].wasm
/// - /[id]/[..all].wasm
pub fn retrieve_best_route<'a>(&'a self, path: &str) -> Option<&'a Route> {
// Keep it to avoid calculating the score twice when iterating
// to look for the best route
let mut best_score = -1;

self.routes
.iter()
.fold(None, |acc, item| match item.affinity(path) {
RouteAffinity::CanManage(score) if best_score == -1 || score < best_score => {
best_score = score;
Some(item)
}
_ => acc,
})
self.iter().find(|r| r.can_manage(path))
}

/// Defines a prefix in the context of the application.
Expand Down Expand Up @@ -113,90 +105,54 @@ impl Routes {
#[cfg(test)]
mod tests {
use super::*;
use std::path::PathBuf;

#[test]
fn route_path_affinity() {
let build_route = |file: &str| -> Route {
let project_config = Config::default();
Route::new(
Path::new("../../tests/data/params"),
PathBuf::from(format!("../../tests/data/params{file}")),
"",
&project_config,
)
};

// Route initializes the Wasm module. We create these
// variables to avoid loading the same Wasm module multiple times
let param_route = build_route("/[id].wasm");
let fixed_route = build_route("/fixed.wasm");
let param_folder_route = build_route("/[id]/fixed.wasm");
let param_sub_route = build_route("/sub/[id].wasm");

let tests = [
(&param_route, "/a", RouteAffinity::CanManage(1)),
(&fixed_route, "/fixed", RouteAffinity::CanManage(0)),
(&fixed_route, "/a", RouteAffinity::CannotManage),
(&param_folder_route, "/a", RouteAffinity::CannotManage),
(&param_folder_route, "/a/fixed", RouteAffinity::CanManage(1)),
(&param_sub_route, "/a/b", RouteAffinity::CannotManage),
(&param_sub_route, "/sub/b", RouteAffinity::CanManage(2)),
];

for t in tests {
assert_eq!(t.0.affinity(t.1), t.2);
}
fn routes_sorted_on_creation() {
let project_config = Config::default();
let router = Routes::new(
Path::new("../../tests/data/params"),
"",
Vec::new(),
&project_config,
);

let mut sorted_router = Routes::new(
Path::new("../../tests/data/params"),
"",
Vec::new(),
&project_config,
);

sorted_router.routes.sort();

assert_eq!(router.routes, sorted_router.routes);
}

#[test]
fn best_route_by_affinity() {
let build_route = |file: &str| -> Route {
let project_config = Config::default();
Route::new(
Path::new("../../tests/data/params"),
PathBuf::from(format!("../../tests/data/params{file}")),
"",
&project_config,
)
};

// Route initializes the Wasm module. We create these
// variables to avoid loading the same Wasm module multiple times
let param_route = build_route("/[id].wasm");
let fixed_route = build_route("/fixed.wasm");
let param_folder_route = build_route("/[id]/fixed.wasm");
let param_sub_route = build_route("/sub/[id].wasm");

// I'm gonna use this values for comparison as `routes` consumes
// the Route elements.
let param_path = param_route.path.clone();
let fixed_path = fixed_route.path.clone();
let param_folder_path = param_folder_route.path.clone();
let param_sub_path = param_sub_route.path.clone();

let routes = Routes {
routes: vec![
param_route,
fixed_route,
param_folder_route,
param_sub_route,
],
prefix: String::from("/"),
};
fn retrieve_best_route() {
let project_config = Config::default();
let router = Routes::new(
Path::new("../../tests/data/params"),
"",
Vec::new(),
&project_config,
);

let tests = [
("/a", Some(param_path)),
("/fixed", Some(fixed_path)),
("/a/fixed", Some(param_folder_path)),
("/sub/b", Some(param_sub_path)),
("/any", Some("/[id]")),
("/fixed", Some("/fixed")),
("/any/fixed", Some("/[id]/fixed")),
("/any/sub", Some("/[id]/sub")),
("/sub/any", Some("/sub/[id]")),
("/sub/any/catch/all/routes", Some("/sub/[...all]")),
("/sub/sub/any/catch/all/routes", Some("/sub/sub/[...all]")),
("/donot/exist", None),
];

for t in tests {
let route = routes.retrieve_best_route(t.0);
for (given_path, expected_path) in tests {
let route = router.retrieve_best_route(given_path);

if let Some(path) = t.1 {
if let Some(path) = expected_path {
assert!(route.is_some());
assert_eq!(route.unwrap().path, path);
} else {
Expand Down
Loading