feat(core): 添加路径处理工具函数

Author: sodekim

Cargo.lock

@@ -44,6 +44,7 @@ async-trait = { version = "0.1" }
 bytes = { version = "1.10" }
 chrono = { version = "0.4" }
 cookie = { version = "0.18" }
+criterion = { version = "0.5" }
 futures = { version = "0.3" }
 futures-util = { version = "0.3" }
 http = { version = "1.0" }

Cargo.toml

@@ -1,5 +1,8 @@
 # Satex
 
+[![Build Status](https://github.com/w-sodalite/satex/actions/workflows/rust.yml/badge.svg?branch=master)](https://github.com/w-sodalite/satex/actions/workflows/rust.yml)
+[![Crates.io](https://img.shields.io/crates/v/satex)](https://crates.io/crates/satex)
+
 一个轻量级、高性能的HTTP网关，使用Rust语言开发，项目灵感来自于`Spring Cloud Gateway`。
 
 > NOTICE(🫡): v0.3版本将以前的代码完全重构，有一些v0.2的功能暂时还未完全实现，目前也在积极开发中。
@@ -30,6 +33,18 @@
 | HTTP协议 | [hyper](https://github.com/hyperium/hyper)                                                |
 | 中间件    | [tower](https://crates.io/crates/tower) [tower-http](https://crates.io/crates/tower-http) |
 
+## 运行
+
+```shell
+# 使用当前目录的satex.yaml文件
+cargo run 
+```
+
+```shell
+# 指定配置文件路径
+cargo run -- -c ./satex.yaml
+```
+
 ## 文档
 
 TODO

README.md

@@ -22,4 +22,11 @@ serde = { workspace = true, features = ["derive"] }
 serde_yaml = { workspace = true }
 sync_wrapper = { workspace = true }
 tokio = { workspace = true, features = ["rt"] }
-tower = { workspace = true, features = ["util"] }
+tower = { workspace = true, features = ["util"] }
+
+[dev-dependencies]
+criterion = { workspace = true }
+
+[[bench]]
+name = "canonicalize"
+harness = false

crates/core/Cargo.toml

@@ -0,0 +1,29 @@
+use criterion::{black_box, criterion_group, criterion_main, Criterion};
+use satex_core::util::canonicalize;
+
+fn _bench_canonicalize(c: &mut Criterion) {
+    c.bench_function("canonicalize", |b| {
+        b.iter(|| {
+            let path = canonicalize("/api/v1/resource");
+            black_box(path)
+        })
+    });
+
+    c.bench_function("canonicalize_dot1", |b| {
+        b.iter(|| {
+            let path = canonicalize("/api/v1/./resource");
+            black_box(path)
+        })
+    });
+
+    c.bench_function("canonicalize_dot2", |b| {
+        b.iter(|| {
+            let path = canonicalize("/api/v1/../resource");
+            black_box(path)
+        })
+    });
+}
+
+criterion_group!(bench_canonicalize, _bench_canonicalize);
+
+criterion_main!(bench_canonicalize);

crates/core/benches/canonicalize.rs

@@ -1,10 +1,12 @@
 mod clone_service;
 mod new_type;
+mod path;
 mod response;
 mod try_downcast;
 mod with;
 
 pub use clone_service::SyncBoxCloneService;
+pub use path::{canonicalize, remove_end_sep, remove_start_sep};
 pub use response::*;
 pub use try_downcast::*;
 pub use with::*;

crates/core/src/util/mod.rs

@@ -0,0 +1,82 @@
+use std::borrow::Cow;
+
+const SEP: &str = "/";
+
+const EMPTY: &str = "";
+
+pub fn canonicalize(path: &str) -> Cow<'_, str> {
+    if path.is_empty() || path == SEP {
+        return Cow::from(SEP);
+    }
+    let mut legal = true;
+    let components = path
+        .split(SEP)
+        .enumerate()
+        .filter(|(index, component)| {
+            if component.is_empty() {
+                // 如果以/开头则会产生一个空字符串
+                legal = *index == 0;
+                false
+            } else if *component == "." {
+                legal = false;
+                false
+            } else if *component == ".." {
+                legal = false;
+                true
+            } else {
+                true
+            }
+        })
+        .map(|(_, component)| component)
+        .collect::<Vec<_>>();
+    match legal {
+        true => Cow::from(path),
+        false => {
+            let mut parts = Vec::with_capacity(components.len());
+            for component in components.into_iter() {
+                if component == ".." {
+                    parts.pop();
+                } else {
+                    parts.push(component);
+                }
+            }
+            if parts.is_empty() {
+                Cow::from(SEP)
+            } else {
+                parts.insert(0, EMPTY);
+                parts.join(SEP).into()
+            }
+        }
+    }
+}
+
+pub fn remove_start_sep(path: &str) -> &str {
+    if path.is_empty() {
+        return path;
+    }
+    let index = path
+        .chars()
+        .enumerate()
+        .find(|(_, c)| *c != '/')
+        .map(|(index, _)| index);
+    match index {
+        Some(index) => &path[index..],
+        None => EMPTY,
+    }
+}
+
+pub fn remove_end_sep(path: &str) -> &str {
+    if path.is_empty() {
+        return path;
+    }
+    let index = path
+        .chars()
+        .rev()
+        .enumerate()
+        .find(|(_, c)| *c != '/')
+        .map(|(index, _)| index);
+    match index {
+        Some(index) => &path[..path.len() - index],
+        None => EMPTY,
+    }
+}

crates/core/src/util/path.rs

@@ -0,0 +1,33 @@
+use satex_core::util::{canonicalize, remove_end_sep, remove_start_sep};
+
+#[test]
+fn test_canonicalize() {
+    assert_eq!("/api/v1/resource", canonicalize("/api/v1/resource"));
+    assert_eq!("/api/resource", canonicalize("/api/v1/../resource"));
+    assert_eq!("/api/v1/resource", canonicalize("/api/v1/./resource"));
+    assert_eq!("/api/resource", canonicalize("/api/v1/./../resource"));
+    assert_eq!("/", canonicalize("/.."));
+    assert_eq!("/", canonicalize("../.."));
+    assert_eq!("/", canonicalize("/."));
+    assert_eq!("/", canonicalize("./."));
+}
+
+#[test]
+fn test_remove_start_sep() {
+    assert_eq!("api/vi/resource", remove_start_sep("api/vi/resource"));
+    assert_eq!("api/vi/resource", remove_start_sep("/api/vi/resource"));
+    assert_eq!("api/vi/resource", remove_start_sep("//api/vi/resource"));
+    assert_eq!("api/vi/resource", remove_start_sep("///api/vi/resource"));
+    assert_eq!("", remove_start_sep("///////////////////"));
+    assert_eq!("a", remove_start_sep("///////////////////a"));
+}
+
+#[test]
+fn test_remove_end_sep() {
+    assert_eq!("/api/vi/resource", remove_end_sep("/api/vi/resource"));
+    assert_eq!("/api/vi/resource", remove_end_sep("/api/vi/resource/"));
+    assert_eq!("/api/vi/resource", remove_end_sep("/api/vi/resource//"));
+    assert_eq!("/api/vi/resource", remove_end_sep("/api/vi/resource///"));
+    assert_eq!("", remove_end_sep("///////////////////"));
+    assert_eq!("a", remove_end_sep("a///////////////////"));
+}