mirror of
https://github.com/actix/actix-extras.git
synced 2024-11-24 16:02:59 +01:00
320 lines
9.5 KiB
Rust
320 lines
9.5 KiB
Rust
use std::fmt;
|
|
use std::ops::{Deref, DerefMut};
|
|
use bytes::{Bytes, BytesMut};
|
|
use futures::{Poll, Future, Stream};
|
|
use http::header::CONTENT_LENGTH;
|
|
|
|
use mime;
|
|
use serde_json;
|
|
use serde::Serialize;
|
|
use serde::de::DeserializeOwned;
|
|
|
|
use error::{Error, JsonPayloadError, PayloadError};
|
|
use handler::Responder;
|
|
use httpmessage::HttpMessage;
|
|
use httprequest::HttpRequest;
|
|
use httpresponse::HttpResponse;
|
|
use extractor::HttpRequestExtractor;
|
|
|
|
/// Json helper
|
|
///
|
|
/// Json can be used for two different purpose. First is for json response generation
|
|
/// and second is for extracting typed information from request's payload.
|
|
///
|
|
/// The `Json` type allows you to respond with well-formed JSON data: simply
|
|
/// return a value of type Json<T> where T is the type of a structure
|
|
/// to serialize into *JSON*. The type `T` must implement the `Serialize`
|
|
/// trait from *serde*.
|
|
///
|
|
/// ```rust
|
|
/// # extern crate actix_web;
|
|
/// # #[macro_use] extern crate serde_derive;
|
|
/// # use actix_web::*;
|
|
/// #
|
|
/// #[derive(Serialize)]
|
|
/// struct MyObj {
|
|
/// name: String,
|
|
/// }
|
|
///
|
|
/// fn index(req: HttpRequest) -> Result<Json<MyObj>> {
|
|
/// Ok(Json(MyObj{name: req.match_info().query("name")?}))
|
|
/// }
|
|
/// # fn main() {}
|
|
/// ```
|
|
///
|
|
/// To extract typed information from request's body, the type `T` must implement the
|
|
/// `Deserialize` trait from *serde*.
|
|
///
|
|
/// ## Example
|
|
///
|
|
/// ```rust
|
|
/// # extern crate bytes;
|
|
/// # extern crate actix_web;
|
|
/// # extern crate futures;
|
|
/// #[macro_use] extern crate serde_derive;
|
|
/// # use actix_web::*;
|
|
/// use actix_web::Json;
|
|
///
|
|
/// #[derive(Deserialize)]
|
|
/// struct Info {
|
|
/// username: String,
|
|
/// }
|
|
///
|
|
/// /// extract `Info` using serde
|
|
/// fn index(info: Json<Info>) -> Result<String> {
|
|
/// Ok(format!("Welcome {}!", info.username))
|
|
/// }
|
|
///
|
|
/// fn main() {
|
|
/// let app = Application::new().resource(
|
|
/// "/index.html",
|
|
/// |r| r.method(Method::POST).with(index)); // <- use `with` extractor
|
|
/// }
|
|
/// ```
|
|
pub struct Json<T>(pub T);
|
|
|
|
impl<T> Deref for Json<T> {
|
|
type Target = T;
|
|
|
|
fn deref(&self) -> &T {
|
|
&self.0
|
|
}
|
|
}
|
|
|
|
impl<T> DerefMut for Json<T> {
|
|
fn deref_mut(&mut self) -> &mut T {
|
|
&mut self.0
|
|
}
|
|
}
|
|
|
|
impl<T> fmt::Debug for Json<T> where T: fmt::Debug {
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
write!(f, "Json: {:?}", self.0)
|
|
}
|
|
}
|
|
|
|
impl<T> fmt::Display for Json<T> where T: fmt::Display {
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
fmt::Display::fmt(&self.0, f)
|
|
}
|
|
}
|
|
|
|
impl<T: Serialize> Responder for Json<T> {
|
|
type Item = HttpResponse;
|
|
type Error = Error;
|
|
|
|
fn respond_to(self, _: HttpRequest) -> Result<HttpResponse, Error> {
|
|
let body = serde_json::to_string(&self.0)?;
|
|
|
|
Ok(HttpResponse::Ok()
|
|
.content_type("application/json")
|
|
.body(body)?)
|
|
}
|
|
}
|
|
|
|
impl<T, S> HttpRequestExtractor<S> for Json<T>
|
|
where T: DeserializeOwned + 'static, S: 'static
|
|
{
|
|
type Result = Box<Future<Item=Self, Error=Error>>;
|
|
|
|
#[inline]
|
|
fn extract(req: &HttpRequest<S>) -> Self::Result {
|
|
Box::new(
|
|
JsonBody::new(req.clone())
|
|
.from_err()
|
|
.map(Json))
|
|
}
|
|
}
|
|
|
|
/// Request payload json parser that resolves to a deserialized `T` value.
|
|
///
|
|
/// Returns error:
|
|
///
|
|
/// * content type is not `application/json`
|
|
/// * content length is greater than 256k
|
|
///
|
|
///
|
|
/// # Server example
|
|
///
|
|
/// ```rust
|
|
/// # extern crate actix_web;
|
|
/// # extern crate futures;
|
|
/// # #[macro_use] extern crate serde_derive;
|
|
/// use actix_web::*;
|
|
/// use futures::future::Future;
|
|
///
|
|
/// #[derive(Deserialize, Debug)]
|
|
/// struct MyObj {
|
|
/// name: String,
|
|
/// }
|
|
///
|
|
/// fn index(mut req: HttpRequest) -> Box<Future<Item=HttpResponse, Error=Error>> {
|
|
/// req.json() // <- get JsonBody future
|
|
/// .from_err()
|
|
/// .and_then(|val: MyObj| { // <- deserialized value
|
|
/// println!("==== BODY ==== {:?}", val);
|
|
/// Ok(httpcodes::HttpOk.into())
|
|
/// }).responder()
|
|
/// }
|
|
/// # fn main() {}
|
|
/// ```
|
|
pub struct JsonBody<T, U: DeserializeOwned>{
|
|
limit: usize,
|
|
req: Option<T>,
|
|
fut: Option<Box<Future<Item=U, Error=JsonPayloadError>>>,
|
|
}
|
|
|
|
impl<T, U: DeserializeOwned> JsonBody<T, U> {
|
|
|
|
/// Create `JsonBody` for request.
|
|
pub fn new(req: T) -> Self {
|
|
JsonBody{
|
|
limit: 262_144,
|
|
req: Some(req),
|
|
fut: None,
|
|
}
|
|
}
|
|
|
|
/// Change max size of payload. By default max size is 256Kb
|
|
pub fn limit(mut self, limit: usize) -> Self {
|
|
self.limit = limit;
|
|
self
|
|
}
|
|
}
|
|
|
|
impl<T, U: DeserializeOwned + 'static> Future for JsonBody<T, U>
|
|
where T: HttpMessage + Stream<Item=Bytes, Error=PayloadError> + 'static
|
|
{
|
|
type Item = U;
|
|
type Error = JsonPayloadError;
|
|
|
|
fn poll(&mut self) -> Poll<U, JsonPayloadError> {
|
|
if let Some(req) = self.req.take() {
|
|
if let Some(len) = req.headers().get(CONTENT_LENGTH) {
|
|
if let Ok(s) = len.to_str() {
|
|
if let Ok(len) = s.parse::<usize>() {
|
|
if len > self.limit {
|
|
return Err(JsonPayloadError::Overflow);
|
|
}
|
|
} else {
|
|
return Err(JsonPayloadError::Overflow);
|
|
}
|
|
}
|
|
}
|
|
// check content-type
|
|
|
|
let json = if let Ok(Some(mime)) = req.mime_type() {
|
|
mime.subtype() == mime::JSON || mime.suffix() == Some(mime::JSON)
|
|
} else {
|
|
false
|
|
};
|
|
if !json {
|
|
return Err(JsonPayloadError::ContentType)
|
|
}
|
|
|
|
let limit = self.limit;
|
|
let fut = req.from_err()
|
|
.fold(BytesMut::new(), move |mut body, chunk| {
|
|
if (body.len() + chunk.len()) > limit {
|
|
Err(JsonPayloadError::Overflow)
|
|
} else {
|
|
body.extend_from_slice(&chunk);
|
|
Ok(body)
|
|
}
|
|
})
|
|
.and_then(|body| Ok(serde_json::from_slice::<U>(&body)?));
|
|
self.fut = Some(Box::new(fut));
|
|
}
|
|
|
|
self.fut.as_mut().expect("JsonBody could not be used second time").poll()
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
use bytes::Bytes;
|
|
use http::header;
|
|
use futures::Async;
|
|
|
|
use with::with;
|
|
use handler::Handler;
|
|
|
|
impl PartialEq for JsonPayloadError {
|
|
fn eq(&self, other: &JsonPayloadError) -> bool {
|
|
match *self {
|
|
JsonPayloadError::Overflow => match *other {
|
|
JsonPayloadError::Overflow => true,
|
|
_ => false,
|
|
},
|
|
JsonPayloadError::ContentType => match *other {
|
|
JsonPayloadError::ContentType => true,
|
|
_ => false,
|
|
},
|
|
_ => false,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Serialize, Deserialize, PartialEq, Debug)]
|
|
struct MyObject {
|
|
name: String,
|
|
}
|
|
|
|
#[test]
|
|
fn test_json() {
|
|
let json = Json(MyObject{name: "test".to_owned()});
|
|
let resp = json.respond_to(HttpRequest::default()).unwrap();
|
|
assert_eq!(resp.headers().get(header::CONTENT_TYPE).unwrap(), "application/json");
|
|
}
|
|
|
|
#[test]
|
|
fn test_json_body() {
|
|
let req = HttpRequest::default();
|
|
let mut json = req.json::<MyObject>();
|
|
assert_eq!(json.poll().err().unwrap(), JsonPayloadError::ContentType);
|
|
|
|
let mut req = HttpRequest::default();
|
|
req.headers_mut().insert(header::CONTENT_TYPE,
|
|
header::HeaderValue::from_static("application/text"));
|
|
let mut json = req.json::<MyObject>();
|
|
assert_eq!(json.poll().err().unwrap(), JsonPayloadError::ContentType);
|
|
|
|
let mut req = HttpRequest::default();
|
|
req.headers_mut().insert(header::CONTENT_TYPE,
|
|
header::HeaderValue::from_static("application/json"));
|
|
req.headers_mut().insert(header::CONTENT_LENGTH,
|
|
header::HeaderValue::from_static("10000"));
|
|
let mut json = req.json::<MyObject>().limit(100);
|
|
assert_eq!(json.poll().err().unwrap(), JsonPayloadError::Overflow);
|
|
|
|
let mut req = HttpRequest::default();
|
|
req.headers_mut().insert(header::CONTENT_TYPE,
|
|
header::HeaderValue::from_static("application/json"));
|
|
req.headers_mut().insert(header::CONTENT_LENGTH,
|
|
header::HeaderValue::from_static("16"));
|
|
req.payload_mut().unread_data(Bytes::from_static(b"{\"name\": \"test\"}"));
|
|
let mut json = req.json::<MyObject>();
|
|
assert_eq!(json.poll().ok().unwrap(),
|
|
Async::Ready(MyObject{name: "test".to_owned()}));
|
|
}
|
|
|
|
#[test]
|
|
fn test_with_json() {
|
|
let mut handler = with(|data: Json<MyObject>| data);
|
|
|
|
let req = HttpRequest::default();
|
|
let err = handler.handle(req).as_response().unwrap().error().is_some();
|
|
assert!(err);
|
|
|
|
let mut req = HttpRequest::default();
|
|
req.headers_mut().insert(header::CONTENT_TYPE,
|
|
header::HeaderValue::from_static("application/json"));
|
|
req.headers_mut().insert(header::CONTENT_LENGTH,
|
|
header::HeaderValue::from_static("16"));
|
|
req.payload_mut().unread_data(Bytes::from_static(b"{\"name\": \"test\"}"));
|
|
let ok = handler.handle(req).as_response().unwrap().error().is_none();
|
|
assert!(ok)
|
|
}
|
|
}
|