1
0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-30 18:34:36 +01:00

Migrate to actix-web v2

This commit is contained in:
Yuki Okushi 2020-01-02 03:40:29 +09:00
parent 342c711bad
commit 0eeda4c398
4 changed files with 77 additions and 75 deletions

View File

@ -2,7 +2,7 @@
name = "actix-protobuf" name = "actix-protobuf"
version = "0.4.1" version = "0.4.1"
edition = "2018" edition = "2018"
authors = ["kingxsp <jin.hb.zh@outlook.com>"] authors = ["kingxsp <jin.hb.zh@outlook.com>, Yuki Okushi <huyuumi.dev@gmail.com>"]
description = "Protobuf support for actix-web framework." description = "Protobuf support for actix-web framework."
readme = "README.md" readme = "README.md"
keywords = ["actix"] keywords = ["actix"]
@ -21,16 +21,16 @@ path = "src/lib.rs"
[dependencies] [dependencies]
bytes = "0.4" bytes = "0.4"
futures = "0.1" futures = "0.3.1"
derive_more = "0.14" derive_more = "0.99"
actix = "0.8.1" actix = "0.9"
actix-web = "1.0.0-rc" actix-rt = "1"
actix-web = "2"
prost = "0.5.0" prost = "0.5.0"
[dev-dependencies] [dev-dependencies]
http = "^0.1"
prost-derive = "0.5.0" prost-derive = "0.5.0"
[workspace] [workspace]

View File

@ -1,7 +1,8 @@
[package] [package]
name = "prost-example" name = "prost-example"
version = "0.3.0" version = "0.4.0"
authors = ["kingxsp <jin.hb.zh@outlook.com>"] edition = "2018"
authors = ["kingxsp <jin.hb.zh@outlook.com>, Yuki Okushi <huyuumi.dev@gmail.com>"]
[dependencies] [dependencies]
bytes = "0.4" bytes = "0.4"
@ -10,6 +11,7 @@ env_logger = "*"
prost = "0.5.0" prost = "0.5.0"
prost-derive = "0.5.0" prost-derive = "0.5.0"
actix = "0.8.1" actix = "0.9"
actix-web = "1.0.0-rc" actix-rt = "1"
actix-web = "2"
actix-protobuf = { path="../../" } actix-protobuf = { path="../../" }

View File

@ -1,9 +1,3 @@
extern crate actix;
extern crate actix_protobuf;
extern crate actix_web;
extern crate bytes;
extern crate env_logger;
extern crate prost;
#[macro_use] #[macro_use]
extern crate prost_derive; extern crate prost_derive;
@ -18,25 +12,23 @@ pub struct MyObj {
pub name: String, pub name: String,
} }
fn index(msg: ProtoBuf<MyObj>) -> Result<HttpResponse> { async fn index(msg: ProtoBuf<MyObj>) -> Result<HttpResponse> {
println!("model: {:?}", msg); println!("model: {:?}", msg);
HttpResponse::Ok().protobuf(msg.0) // <- send response HttpResponse::Ok().protobuf(msg.0) // <- send response
} }
fn main() { #[actix_rt::main]
::std::env::set_var("RUST_LOG", "actix_web=info"); async fn main() -> std::io::Result<()> {
std::env::set_var("RUST_LOG", "actix_web=debug,actix_server=info");
env_logger::init(); env_logger::init();
let sys = actix::System::new("prost-example");
HttpServer::new(|| { HttpServer::new(|| {
App::new() App::new()
.wrap(middleware::Logger::default()) .wrap(middleware::Logger::default())
.service(web::resource("/").route(web::post().to(index))) .service(web::resource("/").route(web::post().to(index)))
}).bind("127.0.0.1:8081") })
.unwrap() .bind("127.0.0.1:8081")?
.shutdown_timeout(1) .shutdown_timeout(1)
.start(); .run()
.await
println!("Started http server: 127.0.0.1:8081");
let _ = sys.run();
} }

View File

@ -1,6 +1,10 @@
use derive_more::Display; use derive_more::Display;
use std::fmt; use std::fmt;
use std::ops::{Deref, DerefMut}; use std::ops::{Deref, DerefMut};
use std::pin::Pin;
use std::future::Future;
use std::task;
use std::task::Poll;
use bytes::{BytesMut, IntoBuf}; use bytes::{BytesMut, IntoBuf};
use prost::DecodeError as ProtoBufDecodeError; use prost::DecodeError as ProtoBufDecodeError;
@ -11,7 +15,8 @@ use actix_web::dev::{HttpResponseBuilder, Payload};
use actix_web::error::{Error, PayloadError, ResponseError}; use actix_web::error::{Error, PayloadError, ResponseError};
use actix_web::http::header::{CONTENT_LENGTH, CONTENT_TYPE}; use actix_web::http::header::{CONTENT_LENGTH, CONTENT_TYPE};
use actix_web::{FromRequest, HttpMessage, HttpRequest, HttpResponse, Responder}; use actix_web::{FromRequest, HttpMessage, HttpRequest, HttpResponse, Responder};
use futures::{Future, Poll, Stream}; use futures::future::{ready, LocalBoxFuture, FutureExt, Ready};
use futures::StreamExt;
#[derive(Debug, Display)] #[derive(Debug, Display)]
pub enum ProtoBufPayloadError { pub enum ProtoBufPayloadError {
@ -111,7 +116,7 @@ where
{ {
type Config = ProtoBufConfig; type Config = ProtoBufConfig;
type Error = Error; type Error = Error;
type Future = Box<dyn Future<Item = Self, Error = Error>>; type Future = LocalBoxFuture<'static, Result<Self, Error>>;
#[inline] #[inline]
fn from_request(req: &HttpRequest, payload: &mut Payload) -> Self::Future { fn from_request(req: &HttpRequest, payload: &mut Payload) -> Self::Future {
@ -119,29 +124,30 @@ where
.app_data::<ProtoBufConfig>() .app_data::<ProtoBufConfig>()
.map(|c| c.limit) .map(|c| c.limit)
.unwrap_or(262_144); .unwrap_or(262_144);
Box::new( ProtoBufMessage::new(req, payload)
ProtoBufMessage::new(req, payload) .limit(limit)
.limit(limit) .map(move |res| match res {
.map_err(move |e| e.into()) Err(e) => Err(e.into()),
.map(ProtoBuf), Ok(item) => Ok(ProtoBuf(item)),
) })
.boxed_local()
} }
} }
impl<T: Message + Default> Responder for ProtoBuf<T> { impl<T: Message + Default> Responder for ProtoBuf<T> {
type Error = Error; type Error = Error;
type Future = Result<HttpResponse, Error>; type Future = Ready<Result<HttpResponse, Error>>;
fn respond_to(self, _: &HttpRequest) -> Self::Future { fn respond_to(self, _: &HttpRequest) -> Self::Future {
let mut buf = Vec::new(); let mut buf = Vec::new();
self.0 ready(self.0
.encode(&mut buf) .encode(&mut buf)
.map_err(|e| Error::from(ProtoBufPayloadError::Serialize(e))) .map_err(|e| Error::from(ProtoBufPayloadError::Serialize(e)))
.and_then(|()| { .and_then(|()| {
Ok(HttpResponse::Ok() Ok(HttpResponse::Ok()
.content_type("application/protobuf") .content_type("application/protobuf")
.body(buf)) .body(buf))
}) }))
} }
} }
@ -150,7 +156,7 @@ pub struct ProtoBufMessage<T: Message + Default> {
length: Option<usize>, length: Option<usize>,
stream: Option<Payload>, stream: Option<Payload>,
err: Option<ProtoBufPayloadError>, err: Option<ProtoBufPayloadError>,
fut: Option<Box<dyn Future<Item = T, Error = ProtoBufPayloadError>>>, fut: Option<LocalBoxFuture<'static, Result<T, ProtoBufPayloadError>>>,
} }
impl<T: Message + Default> ProtoBufMessage<T> { impl<T: Message + Default> ProtoBufMessage<T> {
@ -192,40 +198,44 @@ impl<T: Message + Default> ProtoBufMessage<T> {
} }
impl<T: Message + Default + 'static> Future for ProtoBufMessage<T> { impl<T: Message + Default + 'static> Future for ProtoBufMessage<T> {
type Item = T; type Output = Result<T, ProtoBufPayloadError>;
type Error = ProtoBufPayloadError;
fn poll(&mut self) -> Poll<T, ProtoBufPayloadError> { fn poll(mut self: Pin<&mut Self>, task: &mut task::Context<'_>) -> Poll<Self::Output> {
if let Some(ref mut fut) = self.fut { if let Some(ref mut fut) = self.fut {
return fut.poll(); return Pin::new(fut).poll(task);
} }
if let Some(err) = self.err.take() { if let Some(err) = self.err.take() {
return Err(err); return Poll::Ready(Err(err));
} }
let limit = self.limit; let limit = self.limit;
if let Some(len) = self.length.take() { if let Some(len) = self.length.take() {
if len > limit { if len > limit {
return Err(ProtoBufPayloadError::Overflow); return Poll::Ready(Err(ProtoBufPayloadError::Overflow));
} }
} }
let fut = self let mut stream = self.stream.take().expect("ProtoBufMessage could not be used second time");
.stream
.take() self.fut = Some(
.expect("ProtoBufMessage could not be used second time") async move {
.from_err() let mut body = BytesMut::with_capacity(8192);
.fold(BytesMut::with_capacity(8192), move |mut body, chunk| {
if (body.len() + chunk.len()) > limit { while let Some(item) = stream.next().await {
Err(ProtoBufPayloadError::Overflow) let chunk = item?;
} else { if (body.len() + chunk.len()) > limit {
body.extend_from_slice(&chunk); return Err(ProtoBufPayloadError::Overflow);
Ok(body) } else {
body.extend_from_slice(&chunk);
}
} }
}).and_then(|body| Ok(<T>::decode(&mut body.into_buf())?));
self.fut = Some(Box::new(fut)); return Ok(<T>::decode(&mut body.into_buf())?);
self.poll() }
.boxed_local(),
);
self.poll(task)
} }
} }
@ -248,8 +258,8 @@ impl ProtoBufResponseBuilder for HttpResponseBuilder {
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;
use actix_web::test::{block_on, TestRequest}; use actix_web::test::TestRequest;
use http::header; use actix_web::http::header;
impl PartialEq for ProtoBufPayloadError { impl PartialEq for ProtoBufPayloadError {
fn eq(&self, other: &ProtoBufPayloadError) -> bool { fn eq(&self, other: &ProtoBufPayloadError) -> bool {
@ -275,44 +285,42 @@ mod tests {
pub name: String, pub name: String,
} }
#[test] #[actix_rt::test]
fn test_protobuf() { async fn test_protobuf() {
let protobuf = ProtoBuf(MyObject { let protobuf = ProtoBuf(MyObject {
number: 9, number: 9,
name: "test".to_owned(), name: "test".to_owned(),
}); });
let req = TestRequest::default().to_http_request(); let req = TestRequest::default().to_http_request();
let resp = protobuf.respond_to(&req).unwrap(); let resp = protobuf.respond_to(&req).await.unwrap();
assert_eq!( assert_eq!(
resp.headers().get(header::CONTENT_TYPE).unwrap(), resp.headers().get(header::CONTENT_TYPE).unwrap(),
"application/protobuf" "application/protobuf"
); );
} }
#[test] #[actix_rt::test]
fn test_protobuf_message() { async fn test_protobuf_message() {
let (req, mut pl) = TestRequest::default().to_http_parts(); let (req, mut pl) = TestRequest::default().to_http_parts();
let protobuf = block_on(ProtoBufMessage::<MyObject>::new(&req, &mut pl)); let protobuf = ProtoBufMessage::<MyObject>::new(&req, &mut pl).await;
assert_eq!(protobuf.err().unwrap(), ProtoBufPayloadError::ContentType); assert_eq!(protobuf.err().unwrap(), ProtoBufPayloadError::ContentType);
let (req, mut pl) = TestRequest::default() let (req, mut pl) = TestRequest::with_header(
.header(
header::CONTENT_TYPE, header::CONTENT_TYPE,
header::HeaderValue::from_static("application/text"), "application/text",
).to_http_parts(); ).to_http_parts();
let protobuf = block_on(ProtoBufMessage::<MyObject>::new(&req, &mut pl)); let protobuf = ProtoBufMessage::<MyObject>::new(&req, &mut pl).await;
assert_eq!(protobuf.err().unwrap(), ProtoBufPayloadError::ContentType); assert_eq!(protobuf.err().unwrap(), ProtoBufPayloadError::ContentType);
let (req, mut pl) = TestRequest::default() let (req, mut pl) = TestRequest::with_header(
.header(
header::CONTENT_TYPE, header::CONTENT_TYPE,
header::HeaderValue::from_static("application/protobuf"), "application/protobuf",
).header( ).header(
header::CONTENT_LENGTH, header::CONTENT_LENGTH,
header::HeaderValue::from_static("10000"), "10000",
).to_http_parts(); ).to_http_parts();
let protobuf = let protobuf =
block_on(ProtoBufMessage::<MyObject>::new(&req, &mut pl).limit(100)); ProtoBufMessage::<MyObject>::new(&req, &mut pl).limit(100).await;
assert_eq!(protobuf.err().unwrap(), ProtoBufPayloadError::Overflow); assert_eq!(protobuf.err().unwrap(), ProtoBufPayloadError::Overflow);
} }
} }