mirror of
https://github.com/rwf2/Rocket.git
synced 2024-12-29 05:42:35 +00:00
63a14525d8
So. Many. Changes. This is an insane commit: simultaneously one of the best (because of all the wonderful improvements!) and one of the worst (because it is just massive) in the project's history. Routing: * All UTF-8 characters are accepted everywhere in route paths. (#998) * `path` is now `uri` in `route` attribute: `#[route(GET, path = "..")]` becomes `#[route(GET, uri = "..")]`. Forms Revamp * All form related types now reside in a new `form` module. * Multipart forms are supported. (resolves #106) * Collections are supported in forms and queries. (resolves #205) * Nested structures in forms and queries are supported. (resolves #313) * Form fields can be ad-hoc validated with `#[field(validate = expr)]`. * `FromFormValue` is now `FromFormField`, blanket implements `FromForm`. * Form field values are always percent-decoded apriori. Temporary Files * A new `TempFile` data and form guard allows streaming data directly to a file which can then be persisted. * A new `temp_dir` config parameter specifies where to store `TempFile`. * The limits `file` and `file/$ext`, where `$ext` is the file extension, determines the data limit for a `TempFile`. Capped * A new `Capped` type is used to indicate when data has been truncated due to incoming data limits. It allows checking whether data is complete or truncated. * `DataStream` methods return `Capped` types. * `DataStream` API has been revamped to account for `Capped` types. * Several `Capped<T>` types implement `FromData`, `FromForm`. * HTTP 413 (Payload Too Large) errors are now returned when data limits are exceeded. (resolves #972) Hierarchical Limits * Data limits are now hierarchical, delimited with `/`. A limit of `a/b/c` falls back to `a/b` then `a`. Core * `&RawStr` no longer implements `FromParam`. * `&str` implements `FromParam`, `FromData`, `FromForm`. * `FromTransformedData` was removed. * `FromData` gained a lifetime for use with request-local data. * The default error HTML is more compact. * `&Config` is a request guard. * The `DataStream` interface was entirely revamped. * `State` is only exported via `rocket::State`. * A `request::local_cache!()` macro was added for storing values in request-local cache without consideration for type uniqueness by using a locally generated anonymous type. * `Request::get_param()` is now `Request::param()`. * `Request::get_segments()` is now `Request::segments()`, takes a range. * `Request::get_query_value()` is now `Request::query_value()`, can parse any `FromForm` including sequences. * `std::io::Error` implements `Responder` like `Debug<std::io::Error>`. * `(Status, R)` where `R: Responder` implements `Responder` by overriding the `Status` of `R`. * The name of a route is printed first during route matching. * `FlashMessage` now only has one lifetime generic. HTTP * `RawStr` implements `serde::{Serialize, Deserialize}`. * `RawStr` implements _many_ more methods, in particular, those related to the `Pattern` API. * `RawStr::from_str()` is now `RawStr::new()`. * `RawStr::url_decode()` and `RawStr::url_decode_lossy()` only allocate as necessary, return `Cow`. * `Status` implements `Default` with `Status::Ok`. * `Status` implements `PartialEq`, `Eq`, `Hash`, `PartialOrd`, `Ord`. * Authority and origin part of `Absolute` can be modified with new `Absolute::{with,set}_authority()`, `Absolute::{with,set}_origin()` methods. * `Origin::segments()` was removed in favor of methods split into query and path parts and into raw and decoded versions. * The `Segments` iterator is smarter, returns decoded `&str` items. * `Segments::into_path_buf()` is now `Segments::to_path_buf()`. * A new `QuerySegments` is the analogous query segment iterator. * Once set, `expires` on private cookies is not overwritten. (resolves #1506) * `Origin::path()` and `Origin::query()` return `&RawStr`, not `&str`. Codegen * Preserve more spans in `uri!` macro. * Preserve spans `FromForm` field types. * All dynamic parameters in a query string must typecheck as `FromForm`. * `FromFormValue` derive removed; `FromFormField` added. * The `form` `FromForm` and `FromFormField` field attribute is now named `field`. `#[form(field = ..)]` is now `#[field(name = ..)]`. Contrib * `Json` implements `FromForm`. * `MsgPack` implements `FromForm`. * The `json!` macro is exported as `rocket_contrib::json::json!`. * Added clarifying docs to `StaticFiles`. Examples * `form_validation` and `form_kitchen_sink` removed in favor of `forms`. * The `hello_world` example uses unicode in paths. * The `json` example only allocates as necessary. Internal * Codegen uses new `exports` module with the following conventions: - Locals starts with `__` and are lowercased. - Rocket modules start with `_` and are lowercased. - `std` types start with `_` and are titlecased. - Rocket types are titlecased. * A `header` module was added to `http`, contains header types. * `SAFETY` is used as doc-string keyword for `unsafe` related comments. * The `Uri` parser no longer recognizes Rocket route URIs.
139 lines
4.6 KiB
Rust
139 lines
4.6 KiB
Rust
use std::fmt::Debug;
|
|
|
|
use rocket::form::{Form, FromForm};
|
|
use rocket::form::error::{Error, Errors, ErrorKind};
|
|
|
|
#[derive(Debug, FromForm)]
|
|
struct Cat<'v> {
|
|
#[field(validate = len(5..))]
|
|
name: &'v str,
|
|
#[field(validate = starts_with("kitty"))]
|
|
nick: &'v str,
|
|
}
|
|
|
|
#[derive(Debug, FromForm)]
|
|
struct Dog<'v> {
|
|
#[field(validate = len(5..))]
|
|
name: &'v str,
|
|
}
|
|
|
|
#[derive(Debug, FromForm)]
|
|
struct Person<'v> {
|
|
kitty: Cat<'v>,
|
|
#[field(validate = len(1..))]
|
|
cats: Vec<Cat<'v>>,
|
|
dog: Dog<'v>,
|
|
}
|
|
|
|
fn starts_with<'v, S: AsRef<str>>(string: S, prefix: &str) -> Result<(), Errors<'v>> {
|
|
if !string.as_ref().starts_with(prefix) {
|
|
Err(Error::validation(format!("must start with {:?}", prefix)))?
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[track_caller]
|
|
fn errors<'v, T: FromForm<'v> + Debug + 'v>(string: &'v str) -> Errors<'v> {
|
|
Form::<T>::parse(string).expect_err("expected an error")
|
|
}
|
|
|
|
#[test]
|
|
fn test_form_validation_context() {
|
|
use ErrorKind::*;
|
|
|
|
fn count<'a, K>(c: &Errors<'_>, n: &str, kind: K, fuzz: bool) -> usize
|
|
where K: Into<Option<ErrorKind<'a>>>
|
|
{
|
|
let kind = kind.into();
|
|
c.iter().filter(|e| {
|
|
let matches = (fuzz && e.is_for(n)) || (!fuzz && e.is_for_exactly(n));
|
|
let kinded = kind.as_ref().map(|k| k == &e.kind).unwrap_or(true);
|
|
matches && kinded
|
|
}).count()
|
|
}
|
|
|
|
fn fuzzy<'a, K>(c: &Errors<'_>, n: &str, kind: K) -> usize
|
|
where K: Into<Option<ErrorKind<'a>>>
|
|
{
|
|
count(c, n, kind, true)
|
|
}
|
|
|
|
fn exact<'a, K>(c: &Errors<'_>, n: &str, kind: K) -> usize
|
|
where K: Into<Option<ErrorKind<'a>>>
|
|
{
|
|
count(c, n, kind, false)
|
|
}
|
|
|
|
let c = errors::<Cat>("name=littlebobby");
|
|
assert_eq!(exact(&c, "nick", Missing), 1);
|
|
assert_eq!(fuzzy(&c, "nick", Missing), 1);
|
|
assert_eq!(fuzzy(&c, "nick", None), 1);
|
|
|
|
let c = errors::<Person>("cats[0].name=Bob");
|
|
assert_eq!(exact(&c, "kitty", None), 1);
|
|
assert_eq!(exact(&c, "kitty", Missing), 1);
|
|
assert_eq!(exact(&c, "cats[0].nick", None), 1);
|
|
assert_eq!(exact(&c, "cats[0].nick", Missing), 1);
|
|
assert_eq!(exact(&c, "dog", None), 1);
|
|
assert_eq!(exact(&c, "dog", Missing), 1);
|
|
assert_eq!(exact(&c, "dog.name", None), 0);
|
|
assert_eq!(exact(&c, "kitty.name", None), 0);
|
|
assert_eq!(exact(&c, "kitty.nick", None), 0);
|
|
|
|
assert_eq!(fuzzy(&c, "kitty", None), 1);
|
|
assert_eq!(fuzzy(&c, "kitty.name", Missing), 1);
|
|
assert_eq!(fuzzy(&c, "kitty.nick", Missing), 1);
|
|
assert_eq!(fuzzy(&c, "cats[0].nick", Missing), 1);
|
|
assert_eq!(fuzzy(&c, "dog.name", Missing), 1);
|
|
assert_eq!(fuzzy(&c, "dog", None), 1);
|
|
|
|
let c = errors::<Person>("cats[0].name=Bob&cats[0].nick=kit&kitty.name=Hi");
|
|
assert_eq!(exact(&c, "kitty.nick", Missing), 1);
|
|
assert_eq!(exact(&c, "kitty", None), 0);
|
|
assert_eq!(exact(&c, "dog", Missing), 1);
|
|
assert_eq!(exact(&c, "dog", None), 1);
|
|
assert_eq!(exact(&c, "cats[0].name", None), 1);
|
|
assert_eq!(exact(&c, "cats[0].name", InvalidLength { min: Some(5), max: None }), 1);
|
|
assert_eq!(exact(&c, "cats[0].nick", None), 1);
|
|
assert_eq!(exact(&c, "cats[0].nick", Validation("must start with \"kitty\"".into())), 1);
|
|
|
|
assert_eq!(fuzzy(&c, "kitty.nick", Missing), 1);
|
|
assert_eq!(fuzzy(&c, "kitty.nick", None), 1);
|
|
assert_eq!(fuzzy(&c, "kitty", None), 0);
|
|
assert_eq!(fuzzy(&c, "dog.name", Missing), 1);
|
|
assert_eq!(fuzzy(&c, "dog", Missing), 1);
|
|
assert_eq!(fuzzy(&c, "cats[0].nick", None), 1);
|
|
assert_eq!(exact(&c, "cats[0].name", None), 1);
|
|
|
|
let c = errors::<Person>("kitty.name=Michael");
|
|
assert_eq!(exact(&c, "kitty.nick", Missing), 1);
|
|
assert_eq!(exact(&c, "dog", Missing), 1);
|
|
assert_eq!(exact(&c, "cats[0].name", None), 0);
|
|
assert_eq!(exact(&c, "cats[0].nick", None), 0);
|
|
|
|
assert_eq!(exact(&c, "cats", None), 1);
|
|
assert_eq!(exact(&c, "cats", InvalidLength { min: Some(1), max: None }), 1);
|
|
|
|
assert_eq!(fuzzy(&c, "kitty.nick", Missing), 1);
|
|
assert_eq!(fuzzy(&c, "kitty.nick", None), 1);
|
|
assert_eq!(fuzzy(&c, "dog", None), 1);
|
|
assert_eq!(fuzzy(&c, "dog.name", Missing), 1);
|
|
assert_eq!(exact(&c, "cats[0].name", None), 0);
|
|
assert_eq!(exact(&c, "cats[0].nick", None), 0);
|
|
|
|
let c = errors::<Person>("kitty.name=Michael&kitty.nick=kittykat&dog.name=woofy");
|
|
assert_eq!(c.iter().count(), 1);
|
|
assert_eq!(exact(&c, "cats", None), 1);
|
|
assert_eq!(exact(&c, "cats", InvalidLength { min: Some(1), max: None }), 1);
|
|
assert_eq!(fuzzy(&c, "cats[0].name", None), 1);
|
|
}
|
|
|
|
// #[derive(Debug, FromForm)]
|
|
// struct Person<'v> {
|
|
// kitty: Cat<'v>,
|
|
// #[field(validate = len(1..))]
|
|
// cats: Vec<Cat<'v>>,
|
|
// dog: Dog<'v>,
|
|
// }
|