This commit is contained in:
Manuel Garcia de la Vega Hoyo 2025-07-02 15:47:49 +01:00 committed by GitHub
commit 6d3f082513
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 293 additions and 124 deletions

View File

@ -2,6 +2,14 @@
## Unreleased ## Unreleased
### Added
- Add conflict path detection and handling to enhance routing performance.
### Changed
- Refactor capture_match_info_fn by splitting it into three distinct functions: capture_match_info(), resolve_path_if_match(), and resolve().
## 0.5.3 ## 0.5.3
- Add `unicode` crate feature (on-by-default) to switch between `regex` and `regex-lite` as a trade-off between full unicode support and binary size. - Add `unicode` crate feature (on-by-default) to switch between `regex` and `regex-lite` as a trade-off between full unicode support and binary size.

View File

@ -179,6 +179,15 @@ fn compare_routers(c: &mut Criterion) {
}); });
}); });
group.bench_function("actix_guard_failures", |b| {
b.iter(|| {
for route in call() {
let mut path = actix_router::Path::new(route);
black_box(actix.recognize_fn(&mut path, |_, _| false));
}
});
});
let regex_set = regex::RegexSet::new(register!(regex)).unwrap(); let regex_set = regex::RegexSet::new(register!(regex)).unwrap();
group.bench_function("regex", |b| { group.bench_function("regex", |b| {
b.iter(|| { b.iter(|| {

View File

@ -662,13 +662,13 @@ mod tests {
let rdef = ResourceDef::new("/{key}"); let rdef = ResourceDef::new("/{key}");
let mut path = Path::new("/%25"); let mut path = Path::new("/%25");
rdef.capture_match_info(&mut path); rdef.resolve_path_if_match(&mut path);
let de = PathDeserializer::new(&path); let de = PathDeserializer::new(&path);
let segment: String = serde::Deserialize::deserialize(de).unwrap(); let segment: String = serde::Deserialize::deserialize(de).unwrap();
assert_eq!(segment, "%"); assert_eq!(segment, "%");
let mut path = Path::new("/%2F"); let mut path = Path::new("/%2F");
rdef.capture_match_info(&mut path); rdef.resolve_path_if_match(&mut path);
let de = PathDeserializer::new(&path); let de = PathDeserializer::new(&path);
let segment: String = serde::Deserialize::deserialize(de).unwrap(); let segment: String = serde::Deserialize::deserialize(de).unwrap();
assert_eq!(segment, "/") assert_eq!(segment, "/")
@ -679,7 +679,7 @@ mod tests {
let rdef = ResourceDef::new("/{key}/{value}"); let rdef = ResourceDef::new("/{key}/{value}");
let mut path = Path::new("/%30%25/%30%2F"); let mut path = Path::new("/%30%25/%30%2F");
rdef.capture_match_info(&mut path); rdef.resolve_path_if_match(&mut path);
let de = PathDeserializer::new(&path); let de = PathDeserializer::new(&path);
let segment: (String, String) = serde::Deserialize::deserialize(de).unwrap(); let segment: (String, String) = serde::Deserialize::deserialize(de).unwrap();
assert_eq!(segment.0, "0%"); assert_eq!(segment.0, "0%");
@ -697,7 +697,7 @@ mod tests {
let rdef = ResourceDef::new("/{key}/{value}"); let rdef = ResourceDef::new("/{key}/{value}");
let mut path = Path::new("/%25/%2F"); let mut path = Path::new("/%25/%2F");
rdef.capture_match_info(&mut path); rdef.resolve_path_if_match(&mut path);
let de = PathDeserializer::new(&path); let de = PathDeserializer::new(&path);
let vals: Vals = serde::Deserialize::deserialize(de).unwrap(); let vals: Vals = serde::Deserialize::deserialize(de).unwrap();
assert_eq!(vals.key, "%"); assert_eq!(vals.key, "%");
@ -714,7 +714,7 @@ mod tests {
let rdef = ResourceDef::new("/{val}"); let rdef = ResourceDef::new("/{val}");
let mut path = Path::new("/X"); let mut path = Path::new("/X");
rdef.capture_match_info(&mut path); rdef.resolve_path_if_match(&mut path);
let de = PathDeserializer::new(&path); let de = PathDeserializer::new(&path);
let params: Params<'_> = serde::Deserialize::deserialize(de).unwrap(); let params: Params<'_> = serde::Deserialize::deserialize(de).unwrap();
assert_eq!(params.val, "X"); assert_eq!(params.val, "X");
@ -723,7 +723,7 @@ mod tests {
assert_eq!(params, "X"); assert_eq!(params, "X");
let mut path = Path::new("/%2F"); let mut path = Path::new("/%2F");
rdef.capture_match_info(&mut path); rdef.resolve_path_if_match(&mut path);
let de = PathDeserializer::new(&path); let de = PathDeserializer::new(&path);
assert!(<Params<'_> as serde::Deserialize>::deserialize(de).is_err()); assert!(<Params<'_> as serde::Deserialize>::deserialize(de).is_err());
let de = PathDeserializer::new(&path); let de = PathDeserializer::new(&path);

View File

@ -1,14 +1,15 @@
use std::{ use std::{
borrow::Cow, borrow::Cow,
mem,
ops::{DerefMut, Index}, ops::{DerefMut, Index},
}; };
use serde::{de, Deserialize}; use serde::{de, Deserialize};
use crate::{de::PathDeserializer, Resource, ResourcePath}; use crate::{de::PathDeserializer, resource::ResourceMatchInfo, Resource, ResourcePath};
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub(crate) enum PathItem { pub enum PathItem {
Static(Cow<'static, str>), Static(Cow<'static, str>),
Segment(u16, u16), Segment(u16, u16),
} }
@ -106,6 +107,27 @@ impl<T: ResourcePath> Path<T> {
self.skip += n; self.skip += n;
} }
/// Post-processes the path to resolve dynamic segments, if any, and determines the character offset to skip.
pub fn resolve(&mut self, match_info: ResourceMatchInfo<'_>) {
match match_info {
ResourceMatchInfo::Static { matched_len } => {
self.resource_path().skip(matched_len);
}
ResourceMatchInfo::Dynamic {
matched_len,
matched_vars,
mut segments,
} => {
for i in 0..matched_vars.len() {
self.resource_path()
.add(matched_vars[i], mem::take(&mut segments[i]));
}
self.resource_path().skip(matched_len);
}
}
}
pub(crate) fn add(&mut self, name: impl Into<Cow<'static, str>>, value: PathItem) { pub(crate) fn add(&mut self, name: impl Into<Cow<'static, str>>, value: PathItem) {
match value { match value {
PathItem::Static(seg) => self.segments.push((name.into(), PathItem::Static(seg))), PathItem::Static(seg) => self.segments.push((name.into(), PathItem::Static(seg))),
@ -260,4 +282,49 @@ mod tests {
let foo = RefCell::new(foo); let foo = RefCell::new(foo);
let _ = foo.borrow_mut().resource_path(); let _ = foo.borrow_mut().resource_path();
} }
#[test]
fn test_dynamic_path_resolve() {
let mut path = Path::new("/foo/{var1}/{var2}");
assert_eq!(0, path.segments.len());
assert_eq!(0, path.skip);
let mut segments = <[PathItem; 16]>::default();
segments[0] = PathItem::Static(Cow::Borrowed("foo"));
segments[1] = PathItem::Segment(2, 5);
let match_info = ResourceMatchInfo::Dynamic {
matched_len: 3,
matched_vars: &["var1", "var2"],
segments,
};
path.resolve(match_info);
assert_eq!(2, path.segments.len());
assert_eq!(3, path.skip);
let (name, value) = path.segments.get(0).unwrap();
assert_eq!(name.as_ref(), "var1");
assert!(matches!(value, PathItem::Static(Cow::Borrowed("foo"))));
let (name, value) = path.segments.get(1).unwrap();
assert_eq!(name.as_ref(), "var2");
assert!(matches!(value, PathItem::Segment(2, 5)));
}
#[test]
fn test_static_path_resolve() {
let mut path = Path::new("/foo");
assert_eq!(0, path.segments.len());
assert_eq!(0, path.skip);
let match_info = ResourceMatchInfo::Static { matched_len: 2 };
path.resolve(match_info);
assert_eq!(0, path.segments.len());
assert_eq!(2, path.skip);
}
} }

View File

@ -2,7 +2,6 @@ use std::{
borrow::{Borrow, Cow}, borrow::{Borrow, Cow},
collections::HashMap, collections::HashMap,
hash::{BuildHasher, Hash, Hasher}, hash::{BuildHasher, Hash, Hasher},
mem,
}; };
use tracing::error; use tracing::error;
@ -10,7 +9,7 @@ use tracing::error;
use crate::{ use crate::{
path::PathItem, path::PathItem,
regex_set::{escape, Regex, RegexSet}, regex_set::{escape, Regex, RegexSet},
IntoPatterns, Patterns, Resource, ResourcePath, IntoPatterns, Patterns, Resource,
}; };
const MAX_DYNAMIC_SEGMENTS: usize = 16; const MAX_DYNAMIC_SEGMENTS: usize = 16;
@ -80,8 +79,7 @@ const REGEX_FLAGS: &str = "(?s-m)";
/// `/rust-is-hard`. /// `/rust-is-hard`.
/// ///
/// For information on capturing segment values from paths or other custom resource types, /// For information on capturing segment values from paths or other custom resource types,
/// see [`capture_match_info`][Self::capture_match_info] /// see [`capture_match_info`][Self::capture_match_info].
/// and [`capture_match_info_fn`][Self::capture_match_info_fn].
/// ///
/// A resource definition can contain at most 16 dynamic segments. /// A resource definition can contain at most 16 dynamic segments.
/// ///
@ -96,7 +94,7 @@ const REGEX_FLAGS: &str = "(?s-m)";
/// assert!(!resource.is_match("/user/")); /// assert!(!resource.is_match("/user/"));
/// ///
/// let mut path = Path::new("/user/123"); /// let mut path = Path::new("/user/123");
/// resource.capture_match_info(&mut path); /// resource.resolve_path_if_match(&mut path);
/// assert_eq!(path.get("id").unwrap(), "123"); /// assert_eq!(path.get("id").unwrap(), "123");
/// ``` /// ```
/// ///
@ -171,7 +169,7 @@ const REGEX_FLAGS: &str = "(?s-m)";
/// assert!(resource.is_match("/blob/HEAD/README.md")); /// assert!(resource.is_match("/blob/HEAD/README.md"));
/// ///
/// let mut path = Path::new("/blob/main/LICENSE"); /// let mut path = Path::new("/blob/main/LICENSE");
/// resource.capture_match_info(&mut path); /// resource.resolve_path_if_match(&mut path);
/// assert_eq!(path.get("tail").unwrap(), "main/LICENSE"); /// assert_eq!(path.get("tail").unwrap(), "main/LICENSE");
/// ``` /// ```
/// ///
@ -249,6 +247,18 @@ enum PatternType {
DynamicSet(RegexSet, Vec<(Regex, Vec<&'static str>)>), DynamicSet(RegexSet, Vec<(Regex, Vec<&'static str>)>),
} }
/// Holds metadata and parameters used during path resolution.
pub enum ResourceMatchInfo<'a> {
Static {
matched_len: u16,
},
Dynamic {
matched_len: u16,
matched_vars: &'a [&'static str],
segments: [PathItem; MAX_DYNAMIC_SEGMENTS],
},
}
impl ResourceDef { impl ResourceDef {
/// Constructs a new resource definition from patterns. /// Constructs a new resource definition from patterns.
/// ///
@ -623,18 +633,24 @@ impl ResourceDef {
/// ///
/// let resource = ResourceDef::prefix("/user/{id}"); /// let resource = ResourceDef::prefix("/user/{id}");
/// let mut path = Path::new("/user/123/stars"); /// let mut path = Path::new("/user/123/stars");
/// assert!(resource.capture_match_info(&mut path)); /// assert!(resource.resolve_path_if_match(&mut path));
/// assert_eq!(path.get("id").unwrap(), "123"); /// assert_eq!(path.get("id").unwrap(), "123");
/// assert_eq!(path.unprocessed(), "/stars"); /// assert_eq!(path.unprocessed(), "/stars");
/// ///
/// let resource = ResourceDef::new("/blob/{path}*"); /// let resource = ResourceDef::new("/blob/{path}*");
/// let mut path = Path::new("/blob/HEAD/Cargo.toml"); /// let mut path = Path::new("/blob/HEAD/Cargo.toml");
/// assert!(resource.capture_match_info(&mut path)); /// assert!(resource.resolve_path_if_match(&mut path));
/// assert_eq!(path.get("path").unwrap(), "HEAD/Cargo.toml"); /// assert_eq!(path.get("path").unwrap(), "HEAD/Cargo.toml");
/// assert_eq!(path.unprocessed(), ""); /// assert_eq!(path.unprocessed(), "");
/// ``` /// ```
pub fn capture_match_info<R: Resource>(&self, resource: &mut R) -> bool { pub fn resolve_path_if_match<R: Resource>(&self, resource: &mut R) -> bool {
self.capture_match_info_fn(resource, |_| true) match self.capture_match_info(resource) {
None => false,
Some(match_info) => {
resource.resource_path().resolve(match_info);
true
}
}
} }
/// Collects dynamic segment values into `resource` after matching paths and executing /// Collects dynamic segment values into `resource` after matching paths and executing
@ -644,21 +660,22 @@ impl ResourceDef {
/// This is useful if you want to conditionally match on some non-path related aspect of the /// This is useful if you want to conditionally match on some non-path related aspect of the
/// resource type. /// resource type.
/// ///
/// Returns `true` if resource path matches this resource definition _and_ satisfies the /// Returns `ResourceMatchInfo` if the given resource path matches this resource definition,
/// given check function. /// containing the information required to perform path resolution.
///
/// # Examples /// # Examples
/// ``` /// ```
/// use actix_router::{Path, ResourceDef}; /// use actix_router::{Path, Resource, ResourceDef};
/// ///
/// fn try_match(resource: &ResourceDef, path: &mut Path<&str>) -> bool { /// fn try_match(resource: &ResourceDef, path: &mut Path<&str>) -> bool {
/// let admin_allowed = std::env::var("ADMIN_ALLOWED").is_ok();
/// ///
/// resource.capture_match_info_fn( /// let match_info = resource.capture_match_info(path);
/// path, /// match match_info{
/// // when env var is not set, reject when path contains "admin" /// None => {false}
/// |path| !(!admin_allowed && path.as_str().contains("admin")), /// Some(match_info) => {
/// ) /// path.resource_path().resolve(match_info);
/// true
/// }
/// }
/// } /// }
/// ///
/// let resource = ResourceDef::prefix("/user/{id}"); /// let resource = ResourceDef::prefix("/user/{id}");
@ -669,85 +686,72 @@ impl ResourceDef {
/// assert_eq!(path.get("id").unwrap(), "james"); /// assert_eq!(path.get("id").unwrap(), "james");
/// assert_eq!(path.unprocessed(), "/stars"); /// assert_eq!(path.unprocessed(), "/stars");
/// ///
/// // path matches but fails check function; no segments are collected
/// let mut path = Path::new("/user/admin/stars");
/// assert!(!try_match(&resource, &mut path));
/// assert_eq!(path.unprocessed(), "/user/admin/stars");
/// ``` /// ```
pub fn capture_match_info_fn<R, F>(&self, resource: &mut R, check_fn: F) -> bool pub fn capture_match_info<R>(&self, resource: &mut R) -> Option<ResourceMatchInfo<'_>>
where where
R: Resource, R: Resource,
F: FnOnce(&R) -> bool,
{ {
let mut segments = <[PathItem; MAX_DYNAMIC_SEGMENTS]>::default();
let path = resource.resource_path(); let path = resource.resource_path();
let path_str = path.unprocessed(); let path_str = path.unprocessed();
match &self.pat_type {
let (matched_len, matched_vars) = match &self.pat_type {
PatternType::Static(pattern) => match self.static_match(pattern, path_str) { PatternType::Static(pattern) => match self.static_match(pattern, path_str) {
Some(len) => (len, None), Some(len) => Some(ResourceMatchInfo::Static {
None => return false, matched_len: len as u16,
}),
None => return None,
}, },
PatternType::Dynamic(re, names) => { PatternType::Dynamic(re, names) => {
let captures = match re.captures(path.unprocessed()) { let captures = match re.captures(path_str) {
Some(captures) => captures, Some(captures) => captures,
_ => return false, _ => return None,
}; };
let mut segments = <[PathItem; MAX_DYNAMIC_SEGMENTS]>::default();
for (no, name) in names.iter().enumerate() { for (no, name) in names.iter().enumerate() {
if let Some(m) = captures.name(name) { if let Some(m) = captures.name(name) {
segments[no] = PathItem::Segment(m.start() as u16, m.end() as u16); segments[no] = PathItem::Segment(m.start() as u16, m.end() as u16);
} else { } else {
error!("Dynamic path match but not all segments found: {}", name); error!("Dynamic path match but not all segments found: {}", name);
return false; return None;
} }
} }
(captures[1].len(), Some(names)) Some(ResourceMatchInfo::Dynamic {
matched_len: captures[1].len() as u16,
matched_vars: names,
segments,
})
} }
PatternType::DynamicSet(re, params) => { PatternType::DynamicSet(re, params) => {
let path = path.unprocessed(); let (pattern, names) = match re.first_match_idx(path_str) {
let (pattern, names) = match re.first_match_idx(path) {
Some(idx) => &params[idx], Some(idx) => &params[idx],
_ => return false, _ => return None,
}; };
let captures = match pattern.captures(path.path()) { let captures = match pattern.captures(path_str) {
Some(captures) => captures, Some(captures) => captures,
_ => return false, _ => return None,
}; };
let mut segments = <[PathItem; MAX_DYNAMIC_SEGMENTS]>::default();
for (no, name) in names.iter().enumerate() { for (no, name) in names.iter().enumerate() {
if let Some(m) = captures.name(name) { if let Some(m) = captures.name(name) {
segments[no] = PathItem::Segment(m.start() as u16, m.end() as u16); segments[no] = PathItem::Segment(m.start() as u16, m.end() as u16);
} else { } else {
error!("Dynamic path match but not all segments found: {}", name); error!("Dynamic path match but not all segments found: {}", name);
return false; return None;
} }
} }
(captures[1].len(), Some(names)) Some(ResourceMatchInfo::Dynamic {
} matched_len: captures[1].len() as u16,
}; matched_vars: names,
segments,
if !check_fn(resource) { })
return false;
}
// Modify `path` to skip matched part and store matched segments
let path = resource.resource_path();
if let Some(vars) = matched_vars {
for i in 0..vars.len() {
path.add(vars[i], mem::take(&mut segments[i]));
} }
} }
path.skip(matched_len as u16);
true
} }
/// Assembles resource path using a closure that maps variable segment names to values. /// Assembles resource path using a closure that maps variable segment names to values.
@ -1171,7 +1175,7 @@ mod tests {
assert!(!re.is_match("/name~")); assert!(!re.is_match("/name~"));
let mut path = Path::new("/name"); let mut path = Path::new("/name");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.unprocessed(), ""); assert_eq!(path.unprocessed(), "");
assert_eq!(re.find_match("/name"), Some(5)); assert_eq!(re.find_match("/name"), Some(5));
@ -1189,7 +1193,7 @@ mod tests {
assert!(!re.is_match("/user/profile/profile")); assert!(!re.is_match("/user/profile/profile"));
let mut path = Path::new("/user/profile"); let mut path = Path::new("/user/profile");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.unprocessed(), ""); assert_eq!(path.unprocessed(), "");
} }
@ -1202,12 +1206,12 @@ mod tests {
assert!(!re.is_match("/user/2345/sdg")); assert!(!re.is_match("/user/2345/sdg"));
let mut path = Path::new("/user/profile"); let mut path = Path::new("/user/profile");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("id").unwrap(), "profile"); assert_eq!(path.get("id").unwrap(), "profile");
assert_eq!(path.unprocessed(), ""); assert_eq!(path.unprocessed(), "");
let mut path = Path::new("/user/1245125"); let mut path = Path::new("/user/1245125");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("id").unwrap(), "1245125"); assert_eq!(path.get("id").unwrap(), "1245125");
assert_eq!(path.unprocessed(), ""); assert_eq!(path.unprocessed(), "");
@ -1217,7 +1221,7 @@ mod tests {
assert!(!re.is_match("/resource")); assert!(!re.is_match("/resource"));
let mut path = Path::new("/v151/resource/adage32"); let mut path = Path::new("/v151/resource/adage32");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("version").unwrap(), "151"); assert_eq!(path.get("version").unwrap(), "151");
assert_eq!(path.get("id").unwrap(), "adage32"); assert_eq!(path.get("id").unwrap(), "adage32");
assert_eq!(path.unprocessed(), ""); assert_eq!(path.unprocessed(), "");
@ -1229,7 +1233,7 @@ mod tests {
assert!(!re.is_match("/XXXXXX")); assert!(!re.is_match("/XXXXXX"));
let mut path = Path::new("/012345"); let mut path = Path::new("/012345");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("id").unwrap(), "012345"); assert_eq!(path.get("id").unwrap(), "012345");
assert_eq!(path.unprocessed(), ""); assert_eq!(path.unprocessed(), "");
} }
@ -1249,12 +1253,12 @@ mod tests {
assert!(!re.is_match("/user/2345/sdg")); assert!(!re.is_match("/user/2345/sdg"));
let mut path = Path::new("/user/profile"); let mut path = Path::new("/user/profile");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("id").unwrap(), "profile"); assert_eq!(path.get("id").unwrap(), "profile");
assert_eq!(path.unprocessed(), ""); assert_eq!(path.unprocessed(), "");
let mut path = Path::new("/user/1245125"); let mut path = Path::new("/user/1245125");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("id").unwrap(), "1245125"); assert_eq!(path.get("id").unwrap(), "1245125");
assert_eq!(path.unprocessed(), ""); assert_eq!(path.unprocessed(), "");
@ -1263,7 +1267,7 @@ mod tests {
assert!(!re.is_match("/resource")); assert!(!re.is_match("/resource"));
let mut path = Path::new("/v151/resource/adage32"); let mut path = Path::new("/v151/resource/adage32");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("version").unwrap(), "151"); assert_eq!(path.get("version").unwrap(), "151");
assert_eq!(path.get("id").unwrap(), "adage32"); assert_eq!(path.get("id").unwrap(), "adage32");
@ -1277,7 +1281,7 @@ mod tests {
assert!(!re.is_match("/static/a")); assert!(!re.is_match("/static/a"));
let mut path = Path::new("/012345"); let mut path = Path::new("/012345");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("id").unwrap(), "012345"); assert_eq!(path.get("id").unwrap(), "012345");
let re = ResourceDef::new([ let re = ResourceDef::new([
@ -1314,7 +1318,7 @@ mod tests {
assert_eq!(re.find_match("/12345"), None); assert_eq!(re.find_match("/12345"), None);
let mut path = Path::new("/151/res"); let mut path = Path::new("/151/res");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("id").unwrap(), "151"); assert_eq!(path.get("id").unwrap(), "151");
assert_eq!(path.unprocessed(), "/res"); assert_eq!(path.unprocessed(), "/res");
} }
@ -1324,19 +1328,19 @@ mod tests {
let re = ResourceDef::new("/user/-{id}*"); let re = ResourceDef::new("/user/-{id}*");
let mut path = Path::new("/user/-profile"); let mut path = Path::new("/user/-profile");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("id").unwrap(), "profile"); assert_eq!(path.get("id").unwrap(), "profile");
let mut path = Path::new("/user/-2345"); let mut path = Path::new("/user/-2345");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("id").unwrap(), "2345"); assert_eq!(path.get("id").unwrap(), "2345");
let mut path = Path::new("/user/-2345/"); let mut path = Path::new("/user/-2345/");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("id").unwrap(), "2345/"); assert_eq!(path.get("id").unwrap(), "2345/");
let mut path = Path::new("/user/-2345/sdg"); let mut path = Path::new("/user/-2345/sdg");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("id").unwrap(), "2345/sdg"); assert_eq!(path.get("id").unwrap(), "2345/sdg");
} }
@ -1364,7 +1368,7 @@ mod tests {
let re = ResourceDef::new("/user/{id}/{tail}*"); let re = ResourceDef::new("/user/{id}/{tail}*");
assert!(!re.is_match("/user/2345")); assert!(!re.is_match("/user/2345"));
let mut path = Path::new("/user/2345/sdg"); let mut path = Path::new("/user/2345/sdg");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("id").unwrap(), "2345"); assert_eq!(path.get("id").unwrap(), "2345");
assert_eq!(path.get("tail").unwrap(), "sdg"); assert_eq!(path.get("tail").unwrap(), "sdg");
assert_eq!(path.unprocessed(), ""); assert_eq!(path.unprocessed(), "");
@ -1379,7 +1383,7 @@ mod tests {
let re = ResourceDef::new("/a{x}b/test/a{y}b"); let re = ResourceDef::new("/a{x}b/test/a{y}b");
let mut path = Path::new("/a\nb/test/a\nb"); let mut path = Path::new("/a\nb/test/a\nb");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("x").unwrap(), "\n"); assert_eq!(path.get("x").unwrap(), "\n");
assert_eq!(path.get("y").unwrap(), "\n"); assert_eq!(path.get("y").unwrap(), "\n");
@ -1388,12 +1392,12 @@ mod tests {
let re = ResourceDef::new("/user/{id}*"); let re = ResourceDef::new("/user/{id}*");
let mut path = Path::new("/user/a\nb/a\nb"); let mut path = Path::new("/user/a\nb/a\nb");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("id").unwrap(), "a\nb/a\nb"); assert_eq!(path.get("id").unwrap(), "a\nb/a\nb");
let re = ResourceDef::new("/user/{id:.*}"); let re = ResourceDef::new("/user/{id:.*}");
let mut path = Path::new("/user/a\nb/a\nb"); let mut path = Path::new("/user/a\nb/a\nb");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("id").unwrap(), "a\nb/a\nb"); assert_eq!(path.get("id").unwrap(), "a\nb/a\nb");
} }
@ -1403,16 +1407,16 @@ mod tests {
let re = ResourceDef::new("/user/{id}/test"); let re = ResourceDef::new("/user/{id}/test");
let mut path = Path::new("/user/2345/test"); let mut path = Path::new("/user/2345/test");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("id").unwrap(), "2345"); assert_eq!(path.get("id").unwrap(), "2345");
let mut path = Path::new("/user/qwe%25/test"); let mut path = Path::new("/user/qwe%25/test");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("id").unwrap(), "qwe%25"); assert_eq!(path.get("id").unwrap(), "qwe%25");
let uri = http::Uri::try_from("/user/qwe%25/test").unwrap(); let uri = http::Uri::try_from("/user/qwe%25/test").unwrap();
let mut path = Path::new(uri); let mut path = Path::new(uri);
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.get("id").unwrap(), "qwe%25"); assert_eq!(path.get("id").unwrap(), "qwe%25");
} }
@ -1429,11 +1433,11 @@ mod tests {
assert!(!re.is_match("/name~")); assert!(!re.is_match("/name~"));
let mut path = Path::new("/name"); let mut path = Path::new("/name");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.unprocessed(), ""); assert_eq!(path.unprocessed(), "");
let mut path = Path::new("/name/test"); let mut path = Path::new("/name/test");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.unprocessed(), "/test"); assert_eq!(path.unprocessed(), "/test");
assert_eq!(re.find_match("/name"), Some(5)); assert_eq!(re.find_match("/name"), Some(5));
@ -1449,10 +1453,10 @@ mod tests {
assert!(!re.is_match("/name")); assert!(!re.is_match("/name"));
let mut path = Path::new("/name/gs"); let mut path = Path::new("/name/gs");
assert!(!re.capture_match_info(&mut path)); assert!(!re.resolve_path_if_match(&mut path));
let mut path = Path::new("/name//gs"); let mut path = Path::new("/name//gs");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(path.unprocessed(), "/gs"); assert_eq!(path.unprocessed(), "/gs");
let re = ResourceDef::root_prefix("name/"); let re = ResourceDef::root_prefix("name/");
@ -1462,7 +1466,7 @@ mod tests {
assert!(!re.is_match("/name")); assert!(!re.is_match("/name"));
let mut path = Path::new("/name/gs"); let mut path = Path::new("/name/gs");
assert!(!re.capture_match_info(&mut path)); assert!(!re.resolve_path_if_match(&mut path));
} }
#[test] #[test]
@ -1481,13 +1485,13 @@ mod tests {
assert_eq!(re.find_match(""), None); assert_eq!(re.find_match(""), None);
let mut path = Path::new("/test2/"); let mut path = Path::new("/test2/");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(&path["name"], "test2"); assert_eq!(&path["name"], "test2");
assert_eq!(&path[0], "test2"); assert_eq!(&path[0], "test2");
assert_eq!(path.unprocessed(), "/"); assert_eq!(path.unprocessed(), "/");
let mut path = Path::new("/test2/subpath1/subpath2/index.html"); let mut path = Path::new("/test2/subpath1/subpath2/index.html");
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
assert_eq!(&path["name"], "test2"); assert_eq!(&path["name"], "test2");
assert_eq!(&path[0], "test2"); assert_eq!(&path[0], "test2");
assert_eq!(path.unprocessed(), "/subpath1/subpath2/index.html"); assert_eq!(path.unprocessed(), "/subpath1/subpath2/index.html");
@ -1543,7 +1547,7 @@ mod tests {
assert!(resource.resource_path_from_iter( assert!(resource.resource_path_from_iter(
&mut s, &mut s,
#[allow(clippy::useless_vec)] #[allow(clippy::useless_vec)]
&mut vec!["item", "item2"].iter() &mut vec!["item", "item2"].iter(),
)); ));
assert_eq!(s, "/user/item/item2/"); assert_eq!(s, "/user/item/item2/");
} }
@ -1561,22 +1565,22 @@ mod tests {
let resource = ResourceDef::new(["/user/{id}", "/profile/{id}"]); let resource = ResourceDef::new(["/user/{id}", "/profile/{id}"]);
let mut path = Path::new("/user/123"); let mut path = Path::new("/user/123");
assert!(resource.capture_match_info(&mut path)); assert!(resource.resolve_path_if_match(&mut path));
assert!(path.get("id").is_some()); assert!(path.get("id").is_some());
let mut path = Path::new("/profile/123"); let mut path = Path::new("/profile/123");
assert!(resource.capture_match_info(&mut path)); assert!(resource.resolve_path_if_match(&mut path));
assert!(path.get("id").is_some()); assert!(path.get("id").is_some());
let resource = ResourceDef::new(["/user/{id}", "/profile/{uid}"]); let resource = ResourceDef::new(["/user/{id}", "/profile/{uid}"]);
let mut path = Path::new("/user/123"); let mut path = Path::new("/user/123");
assert!(resource.capture_match_info(&mut path)); assert!(resource.resolve_path_if_match(&mut path));
assert!(path.get("id").is_some()); assert!(path.get("id").is_some());
assert!(path.get("uid").is_none()); assert!(path.get("uid").is_none());
let mut path = Path::new("/profile/123"); let mut path = Path::new("/profile/123");
assert!(resource.capture_match_info(&mut path)); assert!(resource.resolve_path_if_match(&mut path));
assert!(path.get("id").is_none()); assert!(path.get("id").is_none());
assert!(path.get("uid").is_some()); assert!(path.get("uid").is_some());
} }

View File

@ -13,12 +13,16 @@ pub struct ResourceId(pub u16);
/// not required. /// not required.
pub struct Router<T, U = ()> { pub struct Router<T, U = ()> {
routes: Vec<(ResourceDef, T, U)>, routes: Vec<(ResourceDef, T, U)>,
max_path_conflicts: u16,
} }
impl<T, U> Router<T, U> { impl<T, U> Router<T, U> {
/// Constructs new `RouterBuilder` with empty route list. /// Constructs new `RouterBuilder` with empty route list.
pub fn build() -> RouterBuilder<T, U> { pub fn build() -> RouterBuilder<T, U> {
RouterBuilder { routes: Vec::new() } RouterBuilder {
routes: Vec::new(),
path_conflicts: vec![],
}
} }
/// Finds the value in the router that matches a given [routing resource](Resource). /// Finds the value in the router that matches a given [routing resource](Resource).
@ -46,14 +50,24 @@ impl<T, U> Router<T, U> {
/// the `check` closure is executed, passing the resource and each route's context data. If the /// the `check` closure is executed, passing the resource and each route's context data. If the
/// closure returns true then the match result is stored into `resource` and a reference to /// closure returns true then the match result is stored into `resource` and a reference to
/// the matched _value_ is returned. /// the matched _value_ is returned.
pub fn recognize_fn<R, F>(&self, resource: &mut R, mut check: F) -> Option<(&T, ResourceId)> pub fn recognize_fn<R, F>(&self, resource: &mut R, mut check_fn: F) -> Option<(&T, ResourceId)>
where where
R: Resource, R: Resource,
F: FnMut(&R, &U) -> bool, F: FnMut(&R, &U) -> bool,
{ {
let mut next_resource_match_count = 1;
for (rdef, val, ctx) in self.routes.iter() { for (rdef, val, ctx) in self.routes.iter() {
if rdef.capture_match_info_fn(resource, |res| check(res, ctx)) { match rdef.capture_match_info(resource) {
return Some((val, ResourceId(rdef.id()))); None => {}
Some(match_info) => {
if check_fn(resource, ctx) {
resource.resource_path().resolve(match_info);
return Some((val, ResourceId(rdef.id())));
} else if next_resource_match_count == self.max_path_conflicts {
return None;
}
next_resource_match_count += 1;
}
} }
} }
@ -65,15 +79,25 @@ impl<T, U> Router<T, U> {
pub fn recognize_mut_fn<R, F>( pub fn recognize_mut_fn<R, F>(
&mut self, &mut self,
resource: &mut R, resource: &mut R,
mut check: F, mut check_fn: F,
) -> Option<(&mut T, ResourceId)> ) -> Option<(&mut T, ResourceId)>
where where
R: Resource, R: Resource,
F: FnMut(&R, &U) -> bool, F: FnMut(&R, &U) -> bool,
{ {
let mut matches = 0;
for (rdef, val, ctx) in self.routes.iter_mut() { for (rdef, val, ctx) in self.routes.iter_mut() {
if rdef.capture_match_info_fn(resource, |res| check(res, ctx)) { match rdef.capture_match_info(resource) {
return Some((val, ResourceId(rdef.id()))); None => {}
Some(match_info) => {
matches += 1;
if check_fn(resource, ctx) {
resource.resource_path().resolve(match_info);
return Some((val, ResourceId(rdef.id())));
} else if matches == self.max_path_conflicts {
return None;
}
}
} }
} }
@ -84,6 +108,7 @@ impl<T, U> Router<T, U> {
/// Builder for an ordered [routing](Router) list. /// Builder for an ordered [routing](Router) list.
pub struct RouterBuilder<T, U = ()> { pub struct RouterBuilder<T, U = ()> {
routes: Vec<(ResourceDef, T, U)>, routes: Vec<(ResourceDef, T, U)>,
path_conflicts: Vec<(usize, u16)>,
} }
impl<T, U> RouterBuilder<T, U> { impl<T, U> RouterBuilder<T, U> {
@ -96,7 +121,18 @@ impl<T, U> RouterBuilder<T, U> {
val: T, val: T,
ctx: U, ctx: U,
) -> (&mut ResourceDef, &mut T, &mut U) { ) -> (&mut ResourceDef, &mut T, &mut U) {
if let Some((_, path_conflicts)) = self
.path_conflicts
.iter_mut()
.find(|(route_idx, _)| rdef.eq(&self.routes.get(*route_idx).unwrap().0))
{
*path_conflicts += 1;
} else {
self.path_conflicts.push((self.routes.len(), 1));
}
self.routes.push((rdef, val, ctx)); self.routes.push((rdef, val, ctx));
#[allow(clippy::map_identity)] // map is used to distribute &mut-ness to tuple elements #[allow(clippy::map_identity)] // map is used to distribute &mut-ness to tuple elements
self.routes self.routes
.last_mut() .last_mut()
@ -106,8 +142,15 @@ impl<T, U> RouterBuilder<T, U> {
/// Finish configuration and create router instance. /// Finish configuration and create router instance.
pub fn finish(self) -> Router<T, U> { pub fn finish(self) -> Router<T, U> {
let max_path_conflicts = self
.path_conflicts
.iter()
.map(|(_, path_conflicts)| *path_conflicts)
.max()
.unwrap_or(1);
Router { Router {
routes: self.routes, routes: self.routes,
max_path_conflicts,
} }
} }
} }
@ -280,4 +323,42 @@ mod tests {
assert_eq!(*h, 11); assert_eq!(*h, 11);
assert_eq!(&path["val"], "ttt"); assert_eq!(&path["val"], "ttt");
} }
#[test]
fn test_max_path_conflicts() {
let mut router = Router::<usize>::build();
router.path("/test", 10).0.set_id(0);
router.path("/test/{val}", 11).0.set_id(1);
let router = router.finish();
assert_eq!(1, router.max_path_conflicts);
let mut router = Router::<usize>::build();
router.path("/test", 10).0.set_id(0);
router.path("/test", 11).0.set_id(1);
router.path("/test2", 11).0.set_id(1);
router.path("/test2", 11).0.set_id(1);
router.path("/test2", 11).0.set_id(1);
let router = router.finish();
assert_eq!(3, router.max_path_conflicts);
let failures_until_fn_builder = |mut num_failures: u16| {
move |_: &Path<&str>, _: &()| {
if num_failures == 0 {
return true;
}
num_failures -= 1;
false
}
};
assert!(router
.recognize_fn(&mut Path::new("/test2"), failures_until_fn_builder(3))
.is_none());
assert!(router
.recognize_fn(&mut Path::new("/test2"), failures_until_fn_builder(2))
.is_some());
}
} }

View File

@ -75,7 +75,7 @@ mod tests {
let re = ResourceDef::new(pattern); let re = ResourceDef::new(pattern);
let uri = Uri::try_from(url.as_ref()).unwrap(); let uri = Uri::try_from(url.as_ref()).unwrap();
let mut path = Path::new(Url::new(uri)); let mut path = Path::new(Url::new(uri));
assert!(re.capture_match_info(&mut path)); assert!(re.resolve_path_if_match(&mut path));
path path
} }

View File

@ -306,16 +306,16 @@ impl Service<ServiceRequest> for AppRouting {
actix_service::always_ready!(); actix_service::always_ready!();
fn call(&self, mut req: ServiceRequest) -> Self::Future { fn call(&self, mut req: ServiceRequest) -> Self::Future {
let res = self.router.recognize_fn(&mut req, |req, guards| { let guards_check_fn = |req: &ServiceRequest, guards: &Vec<Box<dyn Guard>>| {
let guard_ctx = req.guard_ctx(); let guard_ctx = req.guard_ctx();
guards.iter().all(|guard| guard.check(&guard_ctx)) guards.iter().all(|guard| guard.check(&guard_ctx))
}); };
let res = self.router.recognize_fn(&mut req, guards_check_fn);
if let Some((srv, _info)) = res { if let Some((srv, _info)) = res {
srv.call(req) return srv.call(req);
} else {
self.default.call(req)
} }
self.default.call(req)
} }
} }

View File

@ -510,16 +510,16 @@ impl Service<ServiceRequest> for ScopeService {
actix_service::always_ready!(); actix_service::always_ready!();
fn call(&self, mut req: ServiceRequest) -> Self::Future { fn call(&self, mut req: ServiceRequest) -> Self::Future {
let res = self.router.recognize_fn(&mut req, |req, guards| { let guards_check_fn = |req: &ServiceRequest, guards: &Vec<Box<dyn Guard>>| {
let guard_ctx = req.guard_ctx(); let guard_ctx = req.guard_ctx();
guards.iter().all(|guard| guard.check(&guard_ctx)) guards.iter().all(|guard| guard.check(&guard_ctx))
}); };
let res = self.router.recognize_fn(&mut req, guards_check_fn);
if let Some((srv, _info)) = res { if let Some((srv, _info)) = res {
srv.call(req) return srv.call(req);
} else {
self.default.call(req)
} }
self.default.call(req)
} }
} }

View File

@ -176,7 +176,7 @@ mod tests {
let resource = ResourceDef::new("/{value}/"); let resource = ResourceDef::new("/{value}/");
let mut req = TestRequest::with_uri("/32/").to_srv_request(); let mut req = TestRequest::with_uri("/32/").to_srv_request();
resource.capture_match_info(req.match_info_mut()); resource.resolve_path_if_match(req.match_info_mut());
let (req, mut pl) = req.into_parts(); let (req, mut pl) = req.into_parts();
assert_eq!(*Path::<i8>::from_request(&req, &mut pl).await.unwrap(), 32); assert_eq!(*Path::<i8>::from_request(&req, &mut pl).await.unwrap(), 32);
@ -189,7 +189,7 @@ mod tests {
let resource = ResourceDef::new("/{key}/{value}/"); let resource = ResourceDef::new("/{key}/{value}/");
let mut req = TestRequest::with_uri("/name/user1/?id=test").to_srv_request(); let mut req = TestRequest::with_uri("/name/user1/?id=test").to_srv_request();
resource.capture_match_info(req.match_info_mut()); resource.resolve_path_if_match(req.match_info_mut());
let (req, mut pl) = req.into_parts(); let (req, mut pl) = req.into_parts();
let (Path(res),) = <(Path<(String, String)>,)>::from_request(&req, &mut pl) let (Path(res),) = <(Path<(String, String)>,)>::from_request(&req, &mut pl)
@ -215,7 +215,7 @@ mod tests {
let mut req = TestRequest::with_uri("/name/user1/?id=test").to_srv_request(); let mut req = TestRequest::with_uri("/name/user1/?id=test").to_srv_request();
let resource = ResourceDef::new("/{key}/{value}/"); let resource = ResourceDef::new("/{key}/{value}/");
resource.capture_match_info(req.match_info_mut()); resource.resolve_path_if_match(req.match_info_mut());
let (req, mut pl) = req.into_parts(); let (req, mut pl) = req.into_parts();
let mut s = Path::<MyStruct>::from_request(&req, &mut pl).await.unwrap(); let mut s = Path::<MyStruct>::from_request(&req, &mut pl).await.unwrap();
@ -238,7 +238,7 @@ mod tests {
let mut req = TestRequest::with_uri("/name/32/").to_srv_request(); let mut req = TestRequest::with_uri("/name/32/").to_srv_request();
let resource = ResourceDef::new("/{key}/{value}/"); let resource = ResourceDef::new("/{key}/{value}/");
resource.capture_match_info(req.match_info_mut()); resource.resolve_path_if_match(req.match_info_mut());
let (req, mut pl) = req.into_parts(); let (req, mut pl) = req.into_parts();
let s = Path::<Test2>::from_request(&req, &mut pl).await.unwrap(); let s = Path::<Test2>::from_request(&req, &mut pl).await.unwrap();
@ -262,7 +262,7 @@ mod tests {
async fn paths_decoded() { async fn paths_decoded() {
let resource = ResourceDef::new("/{key}/{value}"); let resource = ResourceDef::new("/{key}/{value}");
let mut req = TestRequest::with_uri("/na%2Bme/us%2Fer%254%32").to_srv_request(); let mut req = TestRequest::with_uri("/na%2Bme/us%2Fer%254%32").to_srv_request();
resource.capture_match_info(req.match_info_mut()); resource.resolve_path_if_match(req.match_info_mut());
let (req, mut pl) = req.into_parts(); let (req, mut pl) = req.into_parts();
let path_items = Path::<MyStruct>::from_request(&req, &mut pl).await.unwrap(); let path_items = Path::<MyStruct>::from_request(&req, &mut pl).await.unwrap();