/
mod.rs
448 lines (390 loc) · 14.4 KB
/
mod.rs
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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
//! Defines a builder API for constructing a `Router`.
mod draw;
mod single;
mod replace;
use std::marker::PhantomData;
use hyper::StatusCode;
use router::Router;
use router::tree::TreeBuilder;
use router::response::extender::ResponseExtender;
use router::response::finalizer::ResponseFinalizerBuilder;
use router::route::Delegation;
use router::route::matcher::RouteMatcher;
use router::route::dispatch::{PipelineHandleChain, PipelineSet};
use router::request::path::PathExtractor;
use router::request::query_string::QueryStringExtractor;
use router::tree::node::NodeBuilder;
pub use self::single::DefineSingleRoute;
pub use self::draw::{DrawRoutes, DefaultSingleRouteBuilder};
/// Builds a `Router` using the provided closure. Routes are defined using the `RouterBuilder`
/// value passed to the closure, and the `Router` is constructed before returning.
///
/// ```rust
/// # extern crate gotham;
/// # extern crate hyper;
/// # use hyper::Response;
/// # use gotham::state::State;
/// # use gotham::router::Router;
/// # use gotham::router::builder::*;
/// # use gotham::middleware::pipeline::new_pipeline;
/// # use gotham::middleware::session::NewSessionMiddleware;
/// # use gotham::router::route::dispatch::{new_pipeline_set, finalize_pipeline_set};
/// # fn my_handler(_: State) -> (State, Response) {
/// # unreachable!()
/// # }
/// #
/// fn router() -> Router {
/// let pipelines = new_pipeline_set();
/// let (pipelines, default) =
/// pipelines.add(new_pipeline().add(NewSessionMiddleware::default()).build());
///
/// let pipelines = finalize_pipeline_set(pipelines);
///
/// let default_pipeline_chain = (default, ());
///
/// build_router(default_pipeline_chain, pipelines, |route| {
/// route.get("/request/path").to(my_handler);
/// })
/// }
/// # fn main() { router(); }
/// ```
pub fn build_router<C, P, F>(pipeline_chain: C, pipelines: PipelineSet<P>, f: F) -> Router
where
C: PipelineHandleChain<P> + Copy + Send + Sync + 'static,
P: Send + Sync + 'static,
F: FnOnce(&mut RouterBuilder<C, P>),
{
let mut tree_builder = TreeBuilder::new();
let response_finalizer = {
let mut builder = RouterBuilder {
node_builder: tree_builder.borrow_root_mut(),
pipeline_chain,
pipelines,
response_finalizer_builder: ResponseFinalizerBuilder::new(),
};
f(&mut builder);
builder.response_finalizer_builder.finalize()
};
Router::new(tree_builder.finalize(), response_finalizer)
}
/// The top-level builder which is created by `build_router` and passed to the provided closure.
/// See the `build_router` function and the `DrawRoutes` trait for usage.
pub struct RouterBuilder<'a, C, P>
where
C: PipelineHandleChain<P> + Copy + Send + Sync + 'static,
P: Send + Sync + 'static,
{
node_builder: &'a mut NodeBuilder,
pipeline_chain: C,
pipelines: PipelineSet<P>,
response_finalizer_builder: ResponseFinalizerBuilder,
}
impl<'a, C, P> RouterBuilder<'a, C, P>
where
C: PipelineHandleChain<P> + Copy + Send + Sync + 'static,
P: Send + Sync + 'static,
{
/// Adds a `ResponseExtender` to the `ResponseFinalizer` in the `Router`.
///
/// ```rust
/// # extern crate gotham;
/// # extern crate hyper;
/// # use hyper::{Response, StatusCode};
/// # use gotham::state::State;
/// # use gotham::router::Router;
/// # use gotham::router::response::extender::ResponseExtender;
/// # use gotham::router::builder::*;
/// # use gotham::middleware::pipeline::new_pipeline;
/// # use gotham::middleware::session::NewSessionMiddleware;
/// # use gotham::router::route::dispatch::{new_pipeline_set, finalize_pipeline_set};
/// #
/// struct MyExtender;
///
/// impl ResponseExtender for MyExtender {
/// fn extend(&self, state: &mut State, res: &mut Response) {
/// // Extender implementation omitted.
/// # let _ = (state, res);
/// }
/// }
///
/// fn router() -> Router {
/// let pipelines = new_pipeline_set();
/// let (pipelines, default) =
/// pipelines.add(new_pipeline().add(NewSessionMiddleware::default()).build());
///
/// let pipelines = finalize_pipeline_set(pipelines);
///
/// let default_pipeline_chain = (default, ());
///
/// build_router(default_pipeline_chain, pipelines, |route| {
/// route.add_response_extender(StatusCode::InternalServerError, MyExtender);
/// })
/// }
/// # fn main() { router(); }
/// ```
pub fn add_response_extender<E>(&mut self, status_code: StatusCode, extender: E)
where
E: ResponseExtender + Send + Sync + 'static,
{
self.response_finalizer_builder.add(
status_code,
Box::new(extender),
)
}
}
/// A scoped builder, which is created by `DrawRoutes::scope` and passed to the provided closure.
/// See the `DrawRoutes` trait for usage.
pub struct ScopeBuilder<'a, C, P>
where
C: PipelineHandleChain<P> + Copy + Send + Sync + 'static,
P: Send + Sync + 'static,
{
node_builder: &'a mut NodeBuilder,
pipeline_chain: C,
pipelines: PipelineSet<P>,
}
/// Implements the traits required to define a single route, after determining which request paths
/// will be dispatched here. The `DefineSingleRoute` trait has documentation for using this type.
pub struct SingleRouteBuilder<'a, M, C, P, PE, QSE>
where
M: RouteMatcher + Send + Sync + 'static,
C: PipelineHandleChain<P> + Send + Sync + 'static,
P: Send + Sync + 'static,
PE: PathExtractor + Send + Sync + 'static,
QSE: QueryStringExtractor + Send + Sync + 'static,
{
node_builder: &'a mut NodeBuilder,
matcher: M,
pipeline_chain: C,
pipelines: PipelineSet<P>,
delegation: Delegation,
phantom: PhantomData<(PE, QSE)>,
}
// Trait impls live with the traits.
impl<'a, M, C, P, PE, QSE> SingleRouteBuilder<'a, M, C, P, PE, QSE>
where
M: RouteMatcher
+ Send
+ Sync
+ 'static,
C: PipelineHandleChain<P>
+ Send
+ Sync
+ 'static,
P: Send + Sync + 'static,
PE: PathExtractor
+ Send
+ Sync
+ 'static,
QSE: QueryStringExtractor
+ Send
+ Sync
+ 'static,
{
/// Coerces the type of the internal `PhantomData`, to replace an extractor by changing the
/// type parameter without changing anything else.
fn coerce<NPE, NQSE>(self) -> SingleRouteBuilder<'a, M, C, P, NPE, NQSE>
where
NPE: PathExtractor + Send + Sync + 'static,
NQSE: QueryStringExtractor + Send + Sync + 'static,
{
SingleRouteBuilder {
node_builder: self.node_builder,
matcher: self.matcher,
pipeline_chain: self.pipeline_chain,
pipelines: self.pipelines,
delegation: self.delegation,
phantom: PhantomData,
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::str::FromStr;
use hyper::{Request, Response, StatusCode, Method, Uri};
use hyper::server::{NewService, Service};
use futures::{Future, Stream};
use middleware::pipeline::new_pipeline;
use middleware::session::NewSessionMiddleware;
use state::{State, StateData, FromState};
use handler::NewHandlerService;
use router::route::dispatch::{new_pipeline_set, finalize_pipeline_set};
use router::response::extender::StaticResponseExtender;
use router::tree::SegmentMapping;
use http::FormUrlDecoded;
use http::request::query_string;
struct SalutationParams {
name: String,
}
impl StateData for SalutationParams {}
impl StaticResponseExtender for SalutationParams {
fn extend(_: &mut State, _: &mut Response) {}
}
impl PathExtractor for SalutationParams {
fn extract(state: &mut State, segment_mapping: SegmentMapping) -> Result<(), String> {
let name = segment_mapping
.get("name")
.unwrap()
.first()
.unwrap()
.val()
.to_owned();
let params = SalutationParams { name };
state.put(params);
Ok(())
}
}
struct AddParams {
x: u64,
y: u64,
}
impl StateData for AddParams {}
impl StaticResponseExtender for AddParams {
fn extend(_: &mut State, _: &mut Response) {}
}
impl QueryStringExtractor for AddParams {
fn extract(state: &mut State) -> Result<(), String> {
let mapping = {
let uri = Uri::borrow_from(state);
let query = uri.query();
query_string::split(query)
};
let parse = |vals: Option<&Vec<FormUrlDecoded>>| {
let s = vals.unwrap().first().unwrap().val();
println!("{}", s);
u64::from_str(s).unwrap()
};
let params = AddParams {
x: parse(mapping.get("x")),
y: parse(mapping.get("y")),
};
state.put(params);
Ok(())
}
}
mod welcome {
use super::*;
pub fn index(state: State) -> (State, Response) {
(state, Response::new().with_status(StatusCode::Ok))
}
pub fn literal(state: State) -> (State, Response) {
(state, Response::new().with_status(StatusCode::Created))
}
pub fn hello(mut state: State) -> (State, Response) {
let params = state.take::<SalutationParams>();
let response = Response::new().with_status(StatusCode::Ok).with_body(
format!(
"Hello, {}!",
params.name
),
);
(state, response)
}
pub fn globbed(state: State) -> (State, Response) {
let response = Response::new().with_status(StatusCode::Ok).with_body(
"Globbed",
);
(state, response)
}
pub fn goodbye(mut state: State) -> (State, Response) {
let params = state.take::<SalutationParams>();
let response = Response::new().with_status(StatusCode::Ok).with_body(
format!(
"Goodbye, {}!",
params.name
),
);
(state, response)
}
pub fn add(mut state: State) -> (State, Response) {
let params = state.take::<AddParams>();
let response = Response::new().with_status(StatusCode::Ok).with_body(
format!(
"{} + {} = {}",
params.x,
params.y,
params.x + params.y,
),
);
(state, response)
}
}
mod api {
use super::*;
pub fn submit(state: State) -> (State, Response) {
(state, Response::new().with_status(StatusCode::Accepted))
}
}
#[test]
fn build_router_test() {
let pipelines = new_pipeline_set();
let (pipelines, default) =
pipelines.add(new_pipeline().add(NewSessionMiddleware::default()).build());
let pipelines = finalize_pipeline_set(pipelines);
let default_pipeline_chain = (default, ());
let router = build_router(default_pipeline_chain, pipelines, |route| {
route.get("/").to(welcome::index);
route
.get("/hello/:name")
.with_path_extractor::<SalutationParams>()
.to(welcome::hello);
route
.get("/hello/:name/*")
.with_path_extractor::<SalutationParams>()
.to(welcome::globbed);
route
.get("/goodbye/:name:[a-zA-Z]+")
.with_path_extractor::<SalutationParams>()
.to(welcome::goodbye);
route
.get("/add")
.with_query_string_extractor::<AddParams>()
.to(welcome::add);
route.get(r"/literal/\:param/\*").to(welcome::literal);
route.scope("/api", |route| { route.post("/submit").to(api::submit); });
});
let new_service = NewHandlerService::new(router);
let call = move |req| {
let service = new_service.new_service().unwrap();
service.call(req).wait().unwrap()
};
let response = call(Request::new(Method::Get, "/".parse().unwrap()));
assert_eq!(response.status(), StatusCode::Ok);
let response = call(Request::new(Method::Post, "/api/submit".parse().unwrap()));
assert_eq!(response.status(), StatusCode::Accepted);
let response = call(Request::new(Method::Get, "/hello/world".parse().unwrap()));
assert_eq!(response.status(), StatusCode::Ok);
let response_bytes = response.body().concat2().wait().unwrap().to_vec();
assert_eq!(&String::from_utf8(response_bytes).unwrap(), "Hello, world!");
let response = call(Request::new(
Method::Get,
"/hello/world/more/path/here/handled/by/glob"
.parse()
.unwrap(),
));
assert_eq!(response.status(), StatusCode::Ok);
let response_bytes = response.body().concat2().wait().unwrap().to_vec();
assert_eq!(&String::from_utf8(response_bytes).unwrap(), "Globbed");
let response = call(Request::new(Method::Get, "/goodbye/world".parse().unwrap()));
assert_eq!(response.status(), StatusCode::Ok);
let response_bytes = response.body().concat2().wait().unwrap().to_vec();
assert_eq!(
&String::from_utf8(response_bytes).unwrap(),
"Goodbye, world!"
);
let response = call(Request::new(Method::Get, "/goodbye/9875".parse().unwrap()));
assert_eq!(response.status(), StatusCode::NotFound);
let response = call(Request::new(
Method::Get,
"/literal/:param/*".parse().unwrap(),
));
assert_eq!(response.status(), StatusCode::Created);
let response = call(Request::new(Method::Get, "/literal/a/b".parse().unwrap()));
assert_eq!(response.status(), StatusCode::NotFound);
let response = call(Request::new(Method::Get, "/add?x=16&y=71".parse().unwrap()));
assert_eq!(response.status(), StatusCode::Ok);
let response_bytes = response.body().concat2().wait().unwrap().to_vec();
assert_eq!(&String::from_utf8(response_bytes).unwrap(), "16 + 71 = 87");
}
}