Rocket/core/codegen/tests/uri_display.rs
Sergio Benitez 63a14525d8 UTF-8 routes. Forms revamp. Temp files. Capped.
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.
2021-03-04 01:51:21 -08:00

148 lines
4.2 KiB
Rust

#[macro_use] extern crate rocket;
use rocket::http::uri::{UriDisplay, Query, Path};
macro_rules! assert_uri_display_query {
($v:expr, $s:expr) => (
let uri_string = format!("{}", &$v as &dyn UriDisplay<Query>);
assert_eq!(uri_string, $s);
)
}
#[derive(UriDisplayQuery, Clone)]
enum Foo<'r> {
First(&'r str),
Second {
inner: &'r str,
other: usize,
},
Third {
#[field(name = "type")]
kind: String,
},
}
#[test]
fn uri_display_foo() {
let foo = Foo::First("hello".into());
assert_uri_display_query!(foo, "hello");
let foo = Foo::First("hello there".into());
assert_uri_display_query!(foo, "hello%20there");
let foo = Foo::Second { inner: "hi".into(), other: 123 };
assert_uri_display_query!(foo, "inner=hi&other=123");
let foo = Foo::Second { inner: "hi bo".into(), other: 321 };
assert_uri_display_query!(foo, "inner=hi%20bo&other=321");
let foo = Foo::Third { kind: "hello".into() };
assert_uri_display_query!(foo, "type=hello");
let foo = Foo::Third { kind: "hello there".into() };
assert_uri_display_query!(foo, "type=hello%20there");
}
#[derive(UriDisplayQuery)]
struct Bar<'a> {
foo: Foo<'a>,
baz: String,
}
#[test]
fn uri_display_bar() {
let foo = Foo::First("hello".into());
let bar = Bar { foo, baz: "well, hi!".into() };
assert_uri_display_query!(bar, "foo=hello&baz=well,%20hi!");
let foo = Foo::Second { inner: "hi".into(), other: 123 };
let bar = Bar { foo, baz: "done".into() };
assert_uri_display_query!(bar, "foo.inner=hi&foo.other=123&baz=done");
let foo = Foo::Third { kind: "hello".into() };
let bar = Bar { foo, baz: "turkey day".into() };
assert_uri_display_query!(bar, "foo.type=hello&baz=turkey%20day");
}
#[derive(UriDisplayQuery)]
struct Baz<'a> {
foo: Foo<'a>,
bar: Bar<'a>,
last: String
}
#[test]
fn uri_display_baz() {
let foo1 = Foo::Second { inner: "hi".into(), other: 123 };
let foo2 = Foo::Second { inner: "bye".into(), other: 321 };
let bar = Bar { foo: foo2, baz: "done".into() };
let baz = Baz { foo: foo1, bar, last: "ok".into() };
assert_uri_display_query!(baz, "foo.inner=hi&foo.other=123&\
bar.foo.inner=bye&bar.foo.other=321&bar.baz=done&\
last=ok");
let foo1 = Foo::Third { kind: "hello".into() };
let foo2 = Foo::First("bye".into());
let bar = Bar { foo: foo1, baz: "end".into() };
let baz = Baz { foo: foo2, bar, last: "done".into() };
assert_uri_display_query!(baz, "foo=bye&\
bar.foo.type=hello&bar.baz=end&\
last=done");
}
#[derive(UriDisplayQuery)]
struct Bam<'a> {
foo: &'a str,
bar: Option<usize>,
baz: Result<&'a str, usize>,
}
#[test]
fn uri_display_bam() {
let bam = Bam { foo: "hi hi", bar: Some(1), baz: Err(2) };
assert_uri_display_query!(bam, "foo=hi%20hi&bar=1");
let bam = Bam { foo: "hi hi", bar: None, baz: Err(2) };
assert_uri_display_query!(bam, "foo=hi%20hi");
let bam = Bam { foo: "hi hi", bar: Some(1), baz: Ok("tony".into()) };
assert_uri_display_query!(bam, "foo=hi%20hi&bar=1&baz=tony");
let bam = Bam { foo: "hi hi", bar: None, baz: Ok("tony".into()) };
assert_uri_display_query!(bam, "foo=hi%20hi&baz=tony");
}
macro_rules! assert_uri_display_path {
($v:expr, $s:expr) => (
let uri_string = format!("{}", &$v as &dyn UriDisplay<Path>);
assert_eq!(uri_string, $s);
)
}
#[derive(UriDisplayPath)]
struct FooP(&'static str);
#[derive(UriDisplayPath)]
struct BarP<'a>(&'a str);
#[derive(UriDisplayPath)]
struct BazP<'a, T>(&'a T);
#[derive(UriDisplayPath)]
struct BamP<T>(T);
#[derive(UriDisplayPath)]
struct BopP(FooP);
#[test]
fn uri_display_path() {
assert_uri_display_path!(FooP("hi"), "hi");
assert_uri_display_path!(FooP("hi there"), "hi%20there");
assert_uri_display_path!(BarP("hi there"), "hi%20there");
assert_uri_display_path!(BazP(&FooP("hi")), "hi");
assert_uri_display_path!(BazP(&BarP("hi there")), "hi%20there");
assert_uri_display_path!(BamP(12), "12");
assert_uri_display_path!(BamP(BazP(&100)), "100");
assert_uri_display_path!(BopP(FooP("bop foo")), "bop%20foo");
}