Added path normalization service with tower-http

geoprox-server/Cargo.toml

@@ -19,7 +19,8 @@ axum = { version = "0.7.5", features = ["macros"] }
 serde = { version = "1.0.199", features = ["derive", "rc"] }
 serde_json = "1.0.116"
 tokio = { version = "1.37.0", features = ["full"] }
-tower-http = { version = "0.5.2", features = ["fs", "trace"] }
+tower = "0.4.13"
+tower-http = { version = "0.5.2", features = ["fs", "trace", "normalize-path"] }
 tracing = "0.1.40"
 tracing-subscriber = { version = "0.3.18", features = ["env-filter"] }
 utoipa = { version = "4.2.3", features = ["axum_extras"] }

geoprox-server/src/api.rs

@@ -13,24 +13,24 @@ pub fn routes(app_state: AppState) -> Router {
 
     Router::new()
         .nest(
-            "/geohash/",
+            "/geohash",
             Router::new()
                 .route("/", get(geohash_api::encode_latlng))
-                .route("/:ghash/", get(geohash_api::decode_geohash))
-                .route("/:ghash/neighbors/", get(geohash_api::get_neighbors))
+                .route("/:ghash", get(geohash_api::decode_geohash))
+                .route("/:ghash/neighbors", get(geohash_api::get_neighbors))
                 .layer(axum::middleware::from_fn(set_cache_control)),
         )
         .route(
-            "/shard/:index/",
+            "/shard/:index",
             post(geoshard_api::create_index)
                 .delete(geoshard_api::drop_index)
                 .put(geoshard_api::insert_key)
                 .patch(geoshard_api::remove_key)
                 .get(geoshard_api::query_range),
         )
-        .route("/shard/", get(geoshard_api::query_range_many))
+        .route("/shard", get(geoshard_api::query_range_many))
         .route(
-            "/shard/:index/batch/",
+            "/shard/:index/batch",
             put(geoshard_api::insert_key_batch).patch(geoshard_api::remove_key_batch),
         )
         .layer(axum::middleware::from_fn(json_content))
@@ -123,16 +123,16 @@ mod test {
     use serde_json::json;
 
     fn setup() -> TestServer {
-        let app = Router::new().nest("/api/v1/", routes(AppState::default()));
+        let router = Router::new().nest("/api/v1/", routes(AppState::default()));
         let config = TestServerConfig::builder().build();
-        TestServer::new_with_config(app, config).unwrap()
+        TestServer::new_with_config(router, config).unwrap()
     }
 
     #[tokio::test]
     async fn can_geohash_api() {
         let server = setup();
         let req = server
-            .get("/api/v1/geohash/")
+            .get("/api/v1/geohash")
             .add_query_params(dto::EncodeLatLng {
                 lat: 45.0,
                 lng: 45.0,
@@ -151,17 +151,17 @@ mod test {
     #[tokio::test]
     async fn can_range_query_api() {
         let server = setup();
-        server.post("/api/v1/shard/drivers/").await;
+        server.post("/api/v1/shard/drivers").await;
         server
-            .put("/api/v1/shard/drivers/")
+            .put("/api/v1/shard/drivers")
             .json(&json!({ "key": "Alice", "lat": 1.0, "lng": 0.0 }))
             .await;
         server
-            .put("/api/v1/geoshard/drivers/")
+            .put("/api/v1/geoshard/drivers")
             .json(&json!({ "key": "Bob", "lat": 0.0, "lng": 1.0 }))
             .await;
         let res = server
-            .get("/api/v1/shard/drivers/")
+            .get("/api/v1/shard/drivers")
             .add_query_params(json!({
                 "lat": 0.0, "lng": 0.0, "range": 1000
             }))

geoprox-server/src/handlers.rs

@@ -11,7 +11,7 @@ pub mod geohash_api {
     /// Decode geohash by path param, returns coordinates with precision estimates.
     #[utoipa::path(
         get,
-        path = "/api/v1/geohash/{ghash}/",
+        path = "/api/v1/geohash/{ghash}",
         params(
             ("ghash" = String, Path, description = "Geohash encoded region"),
         ),
@@ -43,7 +43,7 @@ pub mod geohash_api {
     /// Encode coordinates by query params, returns geohash.
     #[utoipa::path(
         get,
-        path = "/api/v1/geohash/",
+        path = "/api/v1/geohash",
         params(EncodeLatLng),
         responses(
             (
@@ -68,7 +68,7 @@ pub mod geohash_api {
     /// Returns geohash neighbors in all cardinal directions.
     #[utoipa::path(
         get,
-        path = "/api/v1/geohash/{ghash}/neighbors/",
+        path = "/api/v1/geohash/{ghash}/neighbors",
         params(
             ("ghash" = String, Path, description = "Geohash encoded region"),
         ),
@@ -107,7 +107,7 @@ pub mod geoshard_api {
     /// Creates an in-memory index within this geoshard
     #[utoipa::path(
         post,
-        path = "/api/v1/shard/{index}/",
+        path = "/api/v1/shard/{index}",
         params(
             ("index" = String, Path, description = "Geospatial index name"),
         ),
@@ -148,7 +148,7 @@ pub mod geoshard_api {
     /// Drop index. All keys will be lost
     #[utoipa::path(
         delete,
-        path = "/api/v1/shard/{index}/",
+        path = "/api/v1/shard/{index}",
         params(
             ("index" = String, Path, description = "Geospatial index name"),
         ),
@@ -176,7 +176,7 @@ pub mod geoshard_api {
     /// Inserts key into geospatial index
     #[utoipa::path(
         put,
-        path = "/api/v1/shard/{index}/",
+        path = "/api/v1/shard/{index}",
         params(
             ("index" = String, Path, description = "Geospatial index name"),
         ),
@@ -212,7 +212,7 @@ pub mod geoshard_api {
     /// Inserts multiple keys into geospatial index
     #[utoipa::path(
         put,
-        path = "/api/v1/shard/{index}/batch/",
+        path = "/api/v1/shard/{index}/batch",
         params(
             ("index" = String, Path, description = "Geospatial index name"),
         ),
@@ -252,7 +252,7 @@ pub mod geoshard_api {
     /// Removes key from geospatial index
     #[utoipa::path(
         patch,
-        path = "/api/v1/shard/{index}/",
+        path = "/api/v1/shard/{index}",
         params(
             ("index" = String, Path, description = "Geospatial index name"),
         ),
@@ -285,7 +285,7 @@ pub mod geoshard_api {
     /// Removes multiple keys from geospatial index
     #[utoipa::path(
         patch,
-        path = "/api/v1/shard/{index}/batch/",
+        path = "/api/v1/shard/{index}/batch",
         params(
             ("index" = String, Path, description = "Geospatial index name"),
         ),
@@ -323,7 +323,7 @@ pub mod geoshard_api {
     /// Search geospatial index for all keys within some distance
     #[utoipa::path(
         get,
-        path = "/api/v1/shard/{index}/",
+        path = "/api/v1/shard/{index}",
         params(
             ("index" = String, Path, description = "Geospatial index name"),
             QueryRange
@@ -360,7 +360,7 @@ pub mod geoshard_api {
     /// Search geospatial many indices for all keys within some distance
     #[utoipa::path(
         get,
-        path = "/api/v1/shard/",
+        path = "/api/v1/shard",
         params(QueryRangeMany),
         responses(
             (

geoprox-server/src/lib.rs

@@ -9,8 +9,10 @@ use app::AppState;
 use config::ServerConfig;
 use geoprox_core::models::GeoShardConfig;
 
+use axum::extract::Request;
 use axum::routing::Router;
-use tower_http::trace::TraceLayer;
+use tower::Layer;
+use tower_http::normalize_path::NormalizePathLayer;
 use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt};
 
 /// Start http server
@@ -24,17 +26,22 @@ pub async fn run(server_config: ServerConfig, shard_config: GeoShardConfig) {
         .with(tracing_subscriber::fmt::layer())
         .init();
 
-    let socket: std::net::SocketAddr = server_config.clone().into();
-    let listener = tokio::net::TcpListener::bind(socket).await.unwrap();
-
-    let app = AppState::new(server_config, shard_config);
+    let state = AppState::new(server_config.clone(), shard_config);
     let router = Router::new()
-        .nest(
-            "/api/v1/",
-            api::routes(app).layer(TraceLayer::new_for_http()),
-        )
+        .nest("/api/v1/", api::routes(state))
         .merge(api::docs::router());
 
+    // normalize paths on all routes
+    let router = NormalizePathLayer::trim_trailing_slash().layer(router);
+
+    let socket: std::net::SocketAddr = server_config.into();
+    let listener = tokio::net::TcpListener::bind(socket).await.unwrap();
     println!("listening on {}", listener.local_addr().unwrap());
-    axum::serve(listener, router).await.unwrap();
+
+    axum::serve(
+        listener,
+        axum::ServiceExt::<Request>::into_make_service(router),
+    )
+    .await
+    .unwrap();
 }

geoprox-server/src/middleware.rs

@@ -1,4 +1,5 @@
-use axum::{extract::Request, http::header, middleware::Next, response::IntoResponse};
+use axum::extract::Request;
+use axum::{http::header, middleware::Next, response::IntoResponse};
 
 /// tells client to cache this response for some time
 pub async fn set_cache_control(req: Request, next: Next) -> impl IntoResponse {