Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #1224 by searching routes after failed match #2616

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions core/codegen/tests/route-format.rs
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ fn test_formats() {
assert_eq!(response.into_string().unwrap(), "plain");

let response = client.put("/").header(ContentType::HTML).dispatch();
assert_eq!(response.status(), Status::NotFound);
assert_eq!(response.status(), Status::MethodNotAllowed);
}

// Test custom formats.
Expand Down Expand Up @@ -109,9 +109,12 @@ fn test_custom_formats() {
let response = client.get("/").dispatch();
assert_eq!(response.into_string().unwrap(), "get_foo");

let response = client.get("/").header(Accept::JPEG).dispatch();
assert_eq!(response.status(), Status::NotAcceptable); // Route can't produce JPEG

let response = client.put("/").header(ContentType::HTML).dispatch();
assert_eq!(response.status(), Status::NotFound);
assert_eq!(response.status(), Status::UnsupportedMediaType); // Route expects "bar/baz"

let response = client.post("/").header(ContentType::HTML).dispatch();
assert_eq!(response.status(), Status::NotFound);
assert_eq!(response.status(), Status::UnsupportedMediaType); // Route expects "foo"
}
4 changes: 2 additions & 2 deletions core/codegen/tests/route.rs
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ fn test_full_route() {
assert_eq!(response.status(), Status::NotFound);

let response = client.post(format!("/1{}", uri)).body(simple).dispatch();
assert_eq!(response.status(), Status::NotFound);
assert_eq!(response.status(), Status::UnsupportedMediaType);

let response = client
.post(format!("/1{}", uri))
Expand All @@ -117,7 +117,7 @@ fn test_full_route() {
sky, name.percent_decode().unwrap(), "A A", "inside", path, simple, expected_uri));

let response = client.post(format!("/2{}", uri)).body(simple).dispatch();
assert_eq!(response.status(), Status::NotFound);
assert_eq!(response.status(), Status::UnsupportedMediaType);

let response = client
.post(format!("/2{}", uri))
Expand Down
4 changes: 2 additions & 2 deletions core/lib/src/router/matcher.rs
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ impl Catcher {
}
}

fn paths_match(route: &Route, req: &Request<'_>) -> bool {
pub(crate) fn paths_match(route: &Route, req: &Request<'_>) -> bool {
trace!("checking path match: route {} vs. request {}", route, req);
let route_segments = &route.uri.metadata.uri_segments;
let req_segments = req.uri().path().segments();
Expand Down Expand Up @@ -170,7 +170,7 @@ fn paths_match(route: &Route, req: &Request<'_>) -> bool {
true
}

fn queries_match(route: &Route, req: &Request<'_>) -> bool {
pub(crate) fn queries_match(route: &Route, req: &Request<'_>) -> bool {
trace!("checking query match: route {} vs. request {}", route, req);
if matches!(route.uri.metadata.query_color, None | Some(Color::Wild)) {
return true;
Expand Down
45 changes: 45 additions & 0 deletions core/lib/src/router/router.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ use crate::http::{Method, Status};
use crate::{Route, Catcher};
use crate::router::Collide;

use super::matcher::{paths_match, queries_match};

#[derive(Debug, Default)]
pub(crate) struct Router {
routes: HashMap<Method, Vec<Route>>,
Expand Down Expand Up @@ -55,6 +57,33 @@ impl Router {
.flat_map(move |routes| routes.iter().filter(move |r| r.matches(req)))
}

pub(crate) fn matches_except_formats<'r, 'a: 'r>(
&'a self,
req: &'r Request<'r>
) -> bool {
self.routes.get(&req.method())
.into_iter()
.flatten()
.any(|route| paths_match(route, req) && queries_match(route, req))
}

const ALL_METHODS: &'static [Method] = &[
Method::Get, Method::Put, Method::Post, Method::Delete, Method::Options,
Method::Head, Method::Trace, Method::Connect, Method::Patch,
];

pub(crate) fn matches_except_method<'r, 'a: 'r>(
&'a self,
req: &'r Request<'r>
) -> bool {
Self::ALL_METHODS
.iter()
.filter(|method| *method != &req.method())
.filter_map(|method| self.routes.get(method))
.flatten()
.any(|route| paths_match(route, req))
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be possible to simplify this using the Router::routes method:

self.routes()
    .any(|route| route.method != req.method() && paths_match(route, req))

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I'll check how that works out.

}

// For many catchers, using aho-corasick or similar should be much faster.
pub fn catch<'r>(&self, status: Status, req: &'r Request<'r>) -> Option<&Catcher> {
// Note that catchers are presorted by descending base length.
Expand Down Expand Up @@ -368,6 +397,22 @@ mod test {
assert!(route(&router, Get, "/prefi/").is_none());
}

fn has_mismatched_method<'a>(router: &'a Router, method: Method, uri: &'a str) -> bool {
let client = Client::debug_with(vec![]).expect("client");
let request = client.req(method, Origin::parse(uri).unwrap());
router.matches_except_method(&request)
}

#[test]
fn test_bad_method_routing() {
let router = router_with_routes(&["/hello"]);
assert!(route(&router, Put, "/hello").is_none());
assert!(has_mismatched_method(&router, Put, "/hello"));
assert!(has_mismatched_method(&router, Post, "/hello"));

assert!(! has_mismatched_method(&router, Get, "/hello"));
}

/// Asserts that `$to` routes to `$want` given `$routes` are present.
macro_rules! assert_ranked_match {
($routes:expr, $to:expr => $want:expr) => ({
Expand Down
14 changes: 14 additions & 0 deletions core/lib/src/server.rs
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,20 @@ impl Rocket<Orbit> {
}

error_!("No matching routes for {}.", request);
if request.route().is_none() {
// We failed to find a route which matches on path, query AND formats.
if self.router.matches_except_formats(request) {
// Tailor the error code to the interpretation of the request in question.
if request.method().supports_payload() {
status = Status::UnsupportedMediaType;
} else {
status = Status::NotAcceptable;
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don’t think that returning NotAcceptable is correct here. This status code is about content negotiation via the request’s Accept header – e.g. the client wants application/json but the server can only deliver text/html. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/406

IMHO this branch should always return UnsupportedMediaType regardless of whether payload is supported.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't quite follow your reasoning here. Rocket's route "format" specifier switches on exactly whether or not the method expects payload or not ( https://rocket.rs/v0.5/guide/requests/#format )
The logic here merely mirrors that same logic, and returns 406 if the route can only produce payload which the client doesn't want.
It would be wrong to return 415 for a GET route which can't return the desired content.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My bad, I didn’t realize that this restriction had different meanings depending on the method. Your implementation is correct.

} else if self.router.matches_except_method(request) {
// Found a more suitable error code for paths implemented on different methods.
status = Status::MethodNotAllowed;
}
}
Outcome::Forward((data, status))
}

Expand Down
2 changes: 1 addition & 1 deletion core/lib/tests/form_method-issue-45.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,6 @@ mod tests {
.body("_method=patch&form_data=Form+data")
.dispatch();

assert_eq!(response.status(), Status::NotFound);
assert_eq!(response.status(), Status::MethodNotAllowed);
}
}
2 changes: 1 addition & 1 deletion core/lib/tests/precise-content-type-matching.rs
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ mod tests {
let body: Option<&'static str> = $body;
match body {
Some(string) => assert_eq!(body_str, Some(string.to_string())),
None => assert_eq!(status, Status::NotFound)
None => assert_eq!(status, Status::UnsupportedMediaType)
}
)
}
Expand Down
9 changes: 9 additions & 0 deletions examples/error-handling/src/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,15 @@ fn test_hello_invalid_age() {
}
}

#[test]
fn test_method_not_allowed() {
let client = Client::tracked(super::rocket()).unwrap();
let (name, age) = ("Pat", 86);
let request = client.post(format!("/hello/{}/{}", name, age)).body("body");
let response = request.dispatch();
assert_eq!(response.status(), Status::MethodNotAllowed);
}

#[test]
fn test_hello_sergio() {
let client = Client::tracked(super::rocket()).unwrap();
Expand Down
3 changes: 1 addition & 2 deletions examples/responders/src/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,7 @@ fn test_xml() {
assert_eq!(r.into_string().unwrap(), r#"{ "payload": "I'm here" }"#);

let r = client.get(uri!(super::xml)).header(Accept::CSV).dispatch();
assert_eq!(r.status(), Status::NotFound);
assert!(r.into_string().unwrap().contains("not supported"));
assert_eq!(r.status(), Status::NotAcceptable);

let r = client.get("/content/i/dont/exist").header(Accept::HTML).dispatch();
assert_eq!(r.content_type().unwrap(), ContentType::HTML);
Expand Down
3 changes: 1 addition & 2 deletions examples/templating/src/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ fn test_root(kind: &str) {
let expected = Template::show(client.rocket(), format!("{}/error/404", kind), &context);

let response = client.req(*method, format!("/{}", kind)).dispatch();
assert_eq!(response.status(), Status::NotFound);
assert_eq!(response.into_string(), expected);
assert_eq!(response.status(), Status::MethodNotAllowed);
}
}

Expand Down
7 changes: 7 additions & 0 deletions site/guide/4-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2020,6 +2020,13 @@ fn main() {
}
```

Besides `404 Not Found` for unknown URIs, Rocket may also produce
`405 Method Not Allowed` if a request matches a URI but not a declared method
for that URI. For routes declaring formats, Rocket will produce
`406 Not Acceptable` status for a client request _accepting_ a format which
isn't declared by the matching routes, or `415 Unsupported Media Type` in case
the _payload_ of a `PUT` or `POST` is not allowed by the route.

### Scoping

The first argument to `register()` is a path to scope the catcher under called
Expand Down