anvilforge-core 0.3.6

Anvilforge core: routing, middleware, container, request/response, error type, runtime cross-cutting concerns.
Documentation 
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

//! Routing DSL — a thin Laravel-shaped layer over Axum's `Router`.

use std::sync::Arc;

use axum::body::Body;
use axum::http::{Method, Request};
use axum::routing::{any, delete, get, patch, post, put, MethodRouter};
use axum::Router as AxumRouter;

use crate::container::Container;
use crate::middleware::MiddlewareRegistry;

pub struct Router {
    inner: AxumRouter<Container>,
    registry: MiddlewareRegistry,
    middleware_stack: Vec<String>,
    prefix: String,
    routes: Vec<RouteInfo>,
}

/// Description of a single registered route. Captured at registration time so
/// `Application::routes()` (and `anvil routes`) can list them without poking
/// at Axum's internals.
#[derive(Debug, Clone)]
pub struct RouteInfo {
    pub method: Method,
    pub path: String,
    pub middleware: Vec<String>,
}

impl Router {
    pub fn new(registry: MiddlewareRegistry) -> Self {
        Self {
            inner: AxumRouter::new(),
            registry,
            middleware_stack: Vec::new(),
            prefix: String::new(),
            routes: Vec::new(),
        }
    }

    /// Borrow the route registry collected during construction.
    pub fn route_infos(&self) -> &[RouteInfo] {
        &self.routes
    }

    pub fn with_state(self) -> AxumRouter<Container> {
        self.inner
    }

    /// Same as `with_state`, but also returns the captured `RouteInfo` list so
    /// the Application can hold onto it for `anvil routes`.
    pub fn finish(self) -> (AxumRouter<Container>, Vec<RouteInfo>) {
        (self.inner, self.routes)
    }

    fn record(&mut self, method: Method, path: &str) {
        check_path_syntax(method.as_str(), path);
        self.routes.push(RouteInfo {
            method,
            path: self.full_path(path),
            middleware: self.middleware_stack.clone(),
        });
    }

    fn full_path(&self, path: &str) -> String {
        if self.prefix.is_empty() {
            path.to_string()
        } else {
            format!("{}{}", self.prefix.trim_end_matches('/'), path)
        }
    }

    fn wrap_method_router(&self, mr: MethodRouter<Container>) -> MethodRouter<Container> {
        let mut mr = mr;
        for name in self.middleware_stack.iter().rev() {
            if let Some(mw) = self.registry.get(name) {
                let mw = mw.clone();
                let layer = axum::middleware::from_fn(
                    move |req: Request<Body>, next: axum::middleware::Next| {
                        let mw = mw.clone();
                        async move { crate::middleware::invoke(mw, req, next).await }
                    },
                );
                mr = mr.layer(layer);
            } else {
                tracing::warn!(name, "unknown middleware referenced in route; ignoring");
            }
        }
        mr
    }

    pub fn get<H, T>(mut self, path: &str, handler: H) -> Self
    where
        H: axum::handler::Handler<T, Container>,
        T: 'static,
    {
        self.record(Method::GET, path);
        let mr = self.wrap_method_router(get(handler));
        let full = self.full_path(path);
        self.inner = self.inner.route(&full, mr);
        self
    }

    pub fn post<H, T>(mut self, path: &str, handler: H) -> Self
    where
        H: axum::handler::Handler<T, Container>,
        T: 'static,
    {
        self.record(Method::POST, path);
        let mr = self.wrap_method_router(post(handler));
        let full = self.full_path(path);
        self.inner = self.inner.route(&full, mr);
        self
    }

    pub fn put<H, T>(mut self, path: &str, handler: H) -> Self
    where
        H: axum::handler::Handler<T, Container>,
        T: 'static,
    {
        self.record(Method::PUT, path);
        let mr = self.wrap_method_router(put(handler));
        let full = self.full_path(path);
        self.inner = self.inner.route(&full, mr);
        self
    }

    pub fn patch<H, T>(mut self, path: &str, handler: H) -> Self
    where
        H: axum::handler::Handler<T, Container>,
        T: 'static,
    {
        self.record(Method::PATCH, path);
        let mr = self.wrap_method_router(patch(handler));
        let full = self.full_path(path);
        self.inner = self.inner.route(&full, mr);
        self
    }

    pub fn delete<H, T>(mut self, path: &str, handler: H) -> Self
    where
        H: axum::handler::Handler<T, Container>,
        T: 'static,
    {
        self.record(Method::DELETE, path);
        let mr = self.wrap_method_router(delete(handler));
        let full = self.full_path(path);
        self.inner = self.inner.route(&full, mr);
        self
    }

    pub fn any<H, T>(mut self, path: &str, handler: H) -> Self
    where
        H: axum::handler::Handler<T, Container>,
        T: 'static,
    {
        self.record(Method::OPTIONS, path); // sentinel; "any" → display as OPTIONS
        let mr = self.wrap_method_router(any(handler));
        let full = self.full_path(path);
        self.inner = self.inner.route(&full, mr);
        self
    }

    pub fn prefix(mut self, prefix: impl Into<String>) -> Self {
        self.prefix = prefix.into();
        self
    }

    pub fn middleware<I, S>(mut self, names: I) -> Self
    where
        I: IntoIterator<Item = S>,
        S: Into<String>,
    {
        for name in names {
            self.middleware_stack.push(name.into());
        }
        self
    }

    pub fn group<F>(mut self, build: F) -> Self
    where
        F: FnOnce(Router) -> Router,
    {
        let inner_router = Router {
            inner: AxumRouter::new(),
            registry: self.registry.clone(),
            middleware_stack: self.middleware_stack.clone(),
            prefix: self.prefix.clone(),
            routes: Vec::new(),
        };
        let built = build(inner_router);
        self.routes.extend(built.routes);
        self.inner = self.inner.merge(built.inner);
        self
    }

    pub fn merge(mut self, other: Router) -> Self {
        self.routes.extend(other.routes);
        self.inner = self.inner.merge(other.inner);
        self
    }

    pub fn nest(mut self, prefix: &str, other: Router) -> Self {
        for mut r in other.routes {
            r.path = format!("{}{}", prefix.trim_end_matches('/'), r.path);
            self.routes.push(r);
        }
        self.inner = self.inner.nest(prefix, other.inner);
        self
    }

    /// Replace the captured `RouteInfo` list. Used by `Router::adopt` when
    /// pulling in routes whose metadata is tracked elsewhere.
    pub fn with_route_infos(mut self, infos: Vec<RouteInfo>) -> Self {
        self.routes.extend(infos);
        self
    }

    /// Apply a tower layer to every route on this router. Used by extension
    /// crates (e.g. Spark's `spark.scope` per-request middleware) to wrap all
    /// user routes without each one having to opt in by name.
    pub fn layer<L>(mut self, layer: L) -> Self
    where
        L: tower::Layer<axum::routing::Route> + Clone + Send + Sync + 'static,
        L::Service: tower::Service<
                axum::http::Request<axum::body::Body>,
                Response = axum::http::Response<axum::body::Body>,
                Error = std::convert::Infallible,
            > + Clone
            + Send
            + 'static,
        <L::Service as tower::Service<axum::http::Request<axum::body::Body>>>::Future:
            Send + 'static,
    {
        self.inner = self.inner.layer(layer);
        self
    }

    /// Adopt a raw `axum::Router<Container>` — useful when a crate has already
    /// built its routes with its own layered stack and just wants to merge them in.
    pub fn adopt(self, other: AxumRouter<Container>) -> Self {
        Router {
            inner: self.inner.merge(other),
            registry: self.registry,
            middleware_stack: self.middleware_stack,
            prefix: self.prefix,
            routes: self.routes,
        }
    }
}

/// A single named route declaration — mostly for `route!()` macros and named-route URL generation.
#[derive(Debug, Clone)]
pub struct Route {
    pub name: Option<String>,
    pub method: Method,
    pub path: String,
}

/// Named-route registry for URL generation: `route::url("posts.show", [42])`.
#[derive(Default, Clone)]
pub struct NamedRoutes {
    routes: Arc<parking_lot::RwLock<indexmap::IndexMap<String, Route>>>,
}

impl NamedRoutes {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn add(&self, route: Route) {
        if let Some(name) = route.name.clone() {
            self.routes.write().insert(name, route);
        }
    }

    pub fn url(&self, name: &str, params: &[&str]) -> Option<String> {
        let routes = self.routes.read();
        let route = routes.get(name)?;
        let mut path = route.path.clone();
        for p in params {
            if let Some(start) = path.find('{') {
                if let Some(end) = path[start..].find('}') {
                    path.replace_range(start..=start + end, p);
                }
            }
        }
        Some(path)
    }
}

/// Reject axum-0.8-style `{name}` path placeholders at route registration.
/// Anvilforge currently pins axum 0.7, which uses the `:name` syntax — writing
/// `{handle}` against this version silently becomes a literal path segment,
/// and every request to `/foo/abc` 404s with no log hint.
///
/// Panics with a copy-paste-able rewrite hint. Caught immediately on `cargo
/// run` / `cargo test`, never reaches a live request.
fn check_path_syntax(method: &str, path: &str) {
    for (i, b) in path.bytes().enumerate() {
        if b != b'{' {
            continue;
        }
        let rest = &path[i + 1..];
        let Some(end_offset) = rest.find('}') else {
            continue;
        };
        let name = &rest[..end_offset];
        // Skip empty `{}` and segments containing path-y characters (likely
        // not a placeholder we want to flag).
        if name.is_empty() || name.contains('/') {
            continue;
        }
        // Skip Handlebars-style escapes — apps building template strings won't
        // hit registration with one, but be defensive.
        if name.starts_with('{') || name.starts_with('#') {
            continue;
        }
        let suggested = path.replacen(&format!("{{{name}}}"), &format!(":{name}"), 1);
        panic!(
            "{method} route `{path}` uses axum-0.8 syntax `{{{name}}}` but Anvilforge \
             runs on axum 0.7. Use `:{name}` instead:\n\n  \"{suggested}\"\n\n\
             Without this rewrite, requests to that path segment 404 silently."
        );
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn accepts_axum_07_colon_syntax() {
        check_path_syntax("GET", "/handles/:handle");
        check_path_syntax("GET", "/users/:id/posts/:post_id");
        check_path_syntax("GET", "/.well-known/sidevers/resolve/:handle");
    }

    #[test]
    fn accepts_literal_paths() {
        check_path_syntax("GET", "/health");
        check_path_syntax("GET", "/");
        check_path_syntax("POST", "/handles/claim");
    }

    #[test]
    #[should_panic(expected = "uses axum-0.8 syntax `{handle}`")]
    fn rejects_axum_08_brace_syntax() {
        check_path_syntax("GET", "/handles/{handle}");
    }

    #[test]
    #[should_panic(expected = "Use `:id` instead")]
    fn suggests_concrete_rewrite() {
        check_path_syntax("GET", "/users/{id}/posts");
    }

    #[test]
    fn ignores_empty_braces() {
        // `{}` shouldn't trigger a false positive.
        check_path_syntax("GET", "/foo{}/bar");
    }
}