berkus
/
actix-web
mirror of https://github.com/fafhrd91/actix-web
1
0
Fork 0
Code Issues Releases Wiki Activity

Merge branch 'master' into conn-info-new

This commit is contained in:
Rob Ede 2021-06-25 13:33:30 +01:00 committed by GitHub
parent afbf685503 539697292a
commit a24b7c6ff4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
47 changed files with 607 additions and 507 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
.cargo/config.toml
View File

@ -3,6 +3,7 @@ chk = "check --workspace --all-features --tests --examples --bins"
lint = "clippy --workspace --tests --examples" lint = "clippy --workspace --tests --examples"
ci-min = "hack check --workspace --no-default-features" ci-min = "hack check --workspace --no-default-features"
ci-min-test = "hack check --workspace --no-default-features --tests --examples" ci-min-test = "hack check --workspace --no-default-features --tests --examples"
ci-default = "hack check --workspace" ci-default = "check --workspace --bins --tests --examples"
ci-full = "check --workspace --bins --examples --tests" ci-full = "check --workspace --all-features --bins --tests --examples"
ci-test = "test --workspace --all-features --no-fail-fast" ci-test = "test --workspace --all-features --lib --tests --no-fail-fast -- --nocapture"
ci-doctest = "hack test --workspace --all-features --doc --no-fail-fast -- --nocapture"

45
.github/workflows/ci.yml vendored
View File

@ -44,17 +44,11 @@ jobs:
profile: minimal profile: minimal
override: true override: true
- name: Install ${{ matrix.version }}
uses: actions-rs/toolchain@v1
with:
toolchain: ${{ matrix.version }}-${{ matrix.target.triple }}
profile: minimal
override: true
- name: Generate Cargo.lock - name: Generate Cargo.lock
uses: actions-rs/cargo@v1 uses: actions-rs/cargo@v1
with: with:
command: generate-lockfile command: generate-lockfile
- name: Cache Dependencies - name: Cache Dependencies
uses: Swatinem/rust-cache@v1.2.0 uses: Swatinem/rust-cache@v1.2.0
@ -66,43 +60,33 @@ jobs:
- name: check minimal - name: check minimal
uses: actions-rs/cargo@v1 uses: actions-rs/cargo@v1
with: with: { command: ci-min }
command: hack
args: check --workspace --no-default-features
- name: check minimal + tests - name: check minimal + tests
uses: actions-rs/cargo@v1 uses: actions-rs/cargo@v1
with: with: { command: ci-min-test }
command: hack
args: check --workspace --no-default-features --tests --examples
- name: check default
uses: actions-rs/cargo@v1
with: { command: ci-default }
- name: check full - name: check full
uses: actions-rs/cargo@v1 uses: actions-rs/cargo@v1
with: with: { command: ci-full }
command: check
args: --workspace --bins --examples --tests
- name: tests - name: tests
uses: actions-rs/cargo@v1
with:
command: test
args: --workspace --all-features --no-fail-fast -- --nocapture
--skip=test_h2_content_length
--skip=test_reading_deflate_encoding_large_random_rustls
- name: tests (actix-http)
uses: actions-rs/cargo@v1 uses: actions-rs/cargo@v1
timeout-minutes: 40 timeout-minutes: 40
with: with:
command: test command: ci-test
args: --package=actix-http --no-default-features --features=rustls -- --nocapture args: --skip=test_reading_deflate_encoding_large_random_rustls
- name: tests (awc) - name: doc tests
# due to unknown issue with running doc tests on macOS
if: matrix.target.os == 'ubuntu-latest'
uses: actions-rs/cargo@v1 uses: actions-rs/cargo@v1
timeout-minutes: 40 timeout-minutes: 40
with: with: { command: ci-doctest }
command: test
args: --package=awc --no-default-features --features=rustls -- --nocapture
- name: Generate coverage file - name: Generate coverage file
if: > if: >
@ -112,6 +96,7 @@ jobs:
run: | run: |
cargo install cargo-tarpaulin --vers "^0.13" cargo install cargo-tarpaulin --vers "^0.13"
cargo tarpaulin --out Xml --verbose cargo tarpaulin --out Xml --verbose
- name: Upload to Codecov - name: Upload to Codecov
if: > if: >
matrix.target.os == 'ubuntu-latest' matrix.target.os == 'ubuntu-latest'

2
.github/workflows/clippy-fmt.yml vendored
View File

@ -36,4 +36,4 @@ jobs:
uses: actions-rs/clippy-check@v1 uses: actions-rs/clippy-check@v1
with: with:
token: ${{ secrets.GITHUB_TOKEN }} token: ${{ secrets.GITHUB_TOKEN }}
args: --workspace --tests --all-features args: --workspace --all-features --tests

8
CHANGES.md
View File

@ -4,16 +4,22 @@
### Added ### Added
* Add `ServiceRequest::parts_mut`. [#2177] * Add `ServiceRequest::parts_mut`. [#2177]
* Add extractors for `Uri` and `Method`. [#2263] * Add extractors for `Uri` and `Method`. [#2263]
* Add extractor for `ConnectionInfo` and `PeerAddr`. [#2263] * Add extractors for `ConnectionInfo` and `PeerAddr`. [#2263]
* Add `Route::service` for using hand-written services as handlers. [#2262]
### Changed ### Changed
* Change compression algorithm features flags. [#2250] * Change compression algorithm features flags. [#2250]
* Deprecate `App::data` and `App::data_factory`. [#2271] * Deprecate `App::data` and `App::data_factory`. [#2271]
### Fixed
* Scope and Resource middleware can access data items set on their own layer. [#2288]
[#2177]: https://github.com/actix/actix-web/pull/2177 [#2177]: https://github.com/actix/actix-web/pull/2177
[#2250]: https://github.com/actix/actix-web/pull/2250 [#2250]: https://github.com/actix/actix-web/pull/2250
[#2271]: https://github.com/actix/actix-web/pull/2271 [#2271]: https://github.com/actix/actix-web/pull/2271
[#2262]: https://github.com/actix/actix-web/pull/2262
[#2263]: https://github.com/actix/actix-web/pull/2263 [#2263]: https://github.com/actix/actix-web/pull/2263
[#2288]: https://github.com/actix/actix-web/pull/2288
## 4.0.0-beta.7 - 2021-06-17 ## 4.0.0-beta.7 - 2021-06-17

1
Cargo.toml
View File

@ -113,7 +113,6 @@ flate2 = "1.0.13"
zstd = "0.7" zstd = "0.7"
rand = "0.8" rand = "0.8"
rcgen = "0.8" rcgen = "0.8"
serde_derive = "1.0"
tls-openssl = { package = "openssl", version = "0.10.9" } tls-openssl = { package = "openssl", version = "0.10.9" }
tls-rustls = { package = "rustls", version = "0.19.0" } tls-rustls = { package = "rustls", version = "0.19.0" }

4
actix-http/CHANGES.md
View File

@ -4,6 +4,10 @@
### Changed ### Changed
* Change compression algorithm features flags. [#2250] * Change compression algorithm features flags. [#2250]
### Removed
* `downcast` and `downcast_get_type_id` macros. [#2291]
[#2291]: https://github.com/actix/actix-web/pull/2291
[#2250]: https://github.com/actix/actix-web/pull/2250 [#2250]: https://github.com/actix/actix-web/pull/2250

3
actix-http/src/lib.rs
View File

@ -27,9 +27,6 @@
#[macro_use] #[macro_use]
extern crate log; extern crate log;
#[macro_use]
mod macros;
pub mod body; pub mod body;
mod builder; mod builder;
pub mod client; pub mod client;

110
actix-http/src/macros.rs
View File

@ -1,110 +0,0 @@
#[macro_export]
#[doc(hidden)]
macro_rules! downcast_get_type_id {
() => {
/// A helper method to get the type ID of the type
/// this trait is implemented on.
/// This method is unsafe to *implement*, since `downcast_ref` relies
/// on the returned `TypeId` to perform a cast.
///
/// Unfortunately, Rust has no notion of a trait method that is
/// unsafe to implement (marking it as `unsafe` makes it unsafe
/// to *call*). As a workaround, we require this method
/// to return a private type along with the `TypeId`. This
/// private type (`PrivateHelper`) has a private constructor,
/// making it impossible for safe code to construct outside of
/// this module. This ensures that safe code cannot violate
/// type-safety by implementing this method.
///
/// We also take `PrivateHelper` as a parameter, to ensure that
/// safe code cannot obtain a `PrivateHelper` instance by
/// delegating to an existing implementation of `__private_get_type_id__`
#[doc(hidden)]
fn __private_get_type_id__(
&self,
_: PrivateHelper,
) -> (std::any::TypeId, PrivateHelper)
where
Self: 'static,
{
(std::any::TypeId::of::<Self>(), PrivateHelper(()))
}
};
}
//Generate implementation for dyn $name
#[doc(hidden)]
#[macro_export]
macro_rules! downcast {
($name:ident) => {
/// A struct with a private constructor, for use with
/// `__private_get_type_id__`. Its single field is private,
/// ensuring that it can only be constructed from this module
#[doc(hidden)]
pub struct PrivateHelper(());
impl dyn $name + 'static {
/// Downcasts generic body to a specific type.
pub fn downcast_ref<T: $name + 'static>(&self) -> Option<&T> {
if self.__private_get_type_id__(PrivateHelper(())).0
== std::any::TypeId::of::<T>()
{
// SAFETY: external crates cannot override the default
// implementation of `__private_get_type_id__`, since
// it requires returning a private type. We can therefore
// rely on the returned `TypeId`, which ensures that this
// case is correct.
unsafe { Some(&*(self as *const dyn $name as *const T)) }
} else {
None
}
}
/// Downcasts a generic body to a mutable specific type.
pub fn downcast_mut<T: $name + 'static>(&mut self) -> Option<&mut T> {
if self.__private_get_type_id__(PrivateHelper(())).0
== std::any::TypeId::of::<T>()
{
// SAFETY: external crates cannot override the default
// implementation of `__private_get_type_id__`, since
// it requires returning a private type. We can therefore
// rely on the returned `TypeId`, which ensures that this
// case is correct.
unsafe {
Some(&mut *(self as *const dyn $name as *const T as *mut T))
}
} else {
None
}
}
}
};
}
#[cfg(test)]
mod tests {
#![allow(clippy::upper_case_acronyms)]
trait MB {
downcast_get_type_id!();
}
downcast!(MB);
impl MB for String {}
impl MB for () {}
#[actix_rt::test]
async fn test_any_casting() {
let mut body = String::from("hello cast");
let resp_body: &mut dyn MB = &mut body;
let body = resp_body.downcast_ref::<String>().unwrap();
assert_eq!(body, "hello cast");
let body = &mut resp_body.downcast_mut::<String>().unwrap();
body.push('!');
let body = resp_body.downcast_ref::<String>().unwrap();
assert_eq!(body, "hello cast!");
let not_body = resp_body.downcast_ref::<()>();
assert!(not_body.is_none());
}
}

7
awc/src/request.rs
View File

@ -480,6 +480,7 @@ impl ClientRequest {
// supported, so we cannot guess Accept-Encoding HTTP header. // supported, so we cannot guess Accept-Encoding HTTP header.
if slf.response_decompress { if slf.response_decompress {
// Set Accept-Encoding with compression algorithm awc is built with. // Set Accept-Encoding with compression algorithm awc is built with.
#[allow(clippy::vec_init_then_push)]
#[cfg(feature = "__compress")] #[cfg(feature = "__compress")]
let accept_encoding = { let accept_encoding = {
let mut encoding = vec![]; let mut encoding = vec![];
@ -496,7 +497,11 @@ impl ClientRequest {
#[cfg(feature = "compress-zstd")] #[cfg(feature = "compress-zstd")]
encoding.push("zstd"); encoding.push("zstd");
assert!(!encoding.is_empty(), "encoding cannot be empty unless __compress feature has been explictily enabled."); assert!(
!encoding.is_empty(),
"encoding can not be empty unless __compress feature has been explicitly enabled"
);
encoding.join(", ") encoding.join(", ")
}; };

92
src/app.rs
View File

@ -43,13 +43,14 @@ impl App<AppEntry, Body> {
/// Create application builder. Application can be configured with a builder-like pattern. /// Create application builder. Application can be configured with a builder-like pattern.
#[allow(clippy::new_without_default)] #[allow(clippy::new_without_default)]
pub fn new() -> Self { pub fn new() -> Self {
let fref = Rc::new(RefCell::new(None)); let factory_ref = Rc::new(RefCell::new(None));
App { App {
endpoint: AppEntry::new(fref.clone()), endpoint: AppEntry::new(factory_ref.clone()),
data_factories: Vec::new(), data_factories: Vec::new(),
services: Vec::new(), services: Vec::new(),
default: None, default: None,
factory_ref: fref, factory_ref,
external: Vec::new(), external: Vec::new(),
extensions: Extensions::new(), extensions: Extensions::new(),
_phantom: PhantomData, _phantom: PhantomData,
@ -68,36 +69,71 @@ where
InitError = (), InitError = (),
>, >,
{ {
/// Set application data. Application data could be accessed /// Set application (root level) data.
/// by using `Data<T>` extractor where `T` is data type.
/// ///
/// **Note**: HTTP server accepts an application factory rather than /// Application data stored with `App::app_data()` method is available through the
/// an application instance. Http server constructs an application /// [`HttpRequest::app_data`](crate::HttpRequest::app_data) method at runtime.
/// instance for each thread, thus application data must be constructed ///
/// multiple times. If you want to share data between different /// # [`Data<T>`]
/// threads, a shared object should be used, e.g. `Arc`. Internally `Data` type /// Any [`Data<T>`] type added here can utilize it's extractor implementation in handlers.
/// uses `Arc` so data could be created outside of app factory and clones could /// Types not wrapped in `Data<T>` cannot use this extractor. See [its docs](Data<T>) for more
/// be stored via `App::app_data()` method. /// about its usage and patterns.
/// ///
/// ``` /// ```
/// use std::cell::Cell; /// use std::cell::Cell;
/// use actix_web::{web, App, HttpResponse, Responder}; /// use actix_web::{web, App, HttpRequest, HttpResponse, Responder};
/// ///
/// struct MyData { /// struct MyData {
/// counter: Cell<usize>, /// count: std::cell::Cell<usize>,
/// } /// }
/// ///
/// async fn index(data: web::Data<MyData>) -> impl Responder { /// async fn handler(req: HttpRequest, counter: web::Data<MyData>) -> impl Responder {
/// data.counter.set(data.counter.get() + 1); /// // note this cannot use the Data<T> extractor because it was not added with it
/// HttpResponse::Ok() /// let incr = *req.app_data::<usize>().unwrap();
/// assert_eq!(incr, 3);
///
/// // update counter using other value from app data
/// counter.count.set(counter.count.get() + incr);
///
/// HttpResponse::Ok().body(counter.count.get().to_string())
/// } /// }
/// ///
/// let app = App::new() /// let app = App::new().service(
/// .data(MyData{ counter: Cell::new(0) }) /// web::resource("/")
/// .service( /// .app_data(3usize)
/// web::resource("/index.html").route( /// .app_data(web::Data::new(MyData { count: Default::default() }))
/// web::get().to(index))); /// .route(web::get().to(handler))
/// );
/// ``` /// ```
///
/// # Shared Mutable State
/// [`HttpServer::new`](crate::HttpServer::new) accepts an application factory rather than an
/// application instance; the factory closure is called on each worker thread independently.
/// Therefore, if you want to share a data object between different workers, a shareable object
/// needs to be created first, outside the `HttpServer::new` closure and cloned into it.
/// [`Data<T>`] is an example of such a sharable object.
///
/// ```ignore
/// let counter = web::Data::new(AppStateWithCounter {
/// counter: Mutex::new(0),
/// });
///
/// HttpServer::new(move || {
/// // move counter object into the closure and clone for each worker
///
/// App::new()
/// .app_data(counter.clone())
/// .route("/", web::get().to(handler))
/// })
/// ```
pub fn app_data<U: 'static>(mut self, ext: U) -> Self {
self.extensions.insert(ext);
self
}
/// Add application (root) data after wrapping in `Data<T>`.
///
/// Deprecated in favor of [`app_data`](Self::app_data).
#[deprecated(since = "4.0.0", note = "Use `.app_data(Data::new(val))` instead.")] #[deprecated(since = "4.0.0", note = "Use `.app_data(Data::new(val))` instead.")]
pub fn data<U: 'static>(self, data: U) -> Self { pub fn data<U: 'static>(self, data: U) -> Self {
self.app_data(Data::new(data)) self.app_data(Data::new(data))
@ -138,18 +174,6 @@ where
self self
} }
/// Set application level arbitrary data item.
///
/// Application data stored with `App::app_data()` method is available
/// via `HttpRequest::app_data()` method at runtime.
///
/// This method could be used for storing `Data<T>` as well, in that case
/// data could be accessed by using `Data<T>` extractor.
pub fn app_data<U: 'static>(mut self, ext: U) -> Self {
self.extensions.insert(ext);
self
}
/// Run external configuration as part of the application building /// Run external configuration as part of the application building
/// process /// process
/// ///

31
src/app_service.rs
View File

@ -1,22 +1,22 @@
use std::cell::RefCell; use std::{cell::RefCell, mem, rc::Rc};
use std::rc::Rc;
use actix_http::{Extensions, Request}; use actix_http::{Extensions, Request};
use actix_router::{Path, ResourceDef, Router, Url}; use actix_router::{Path, ResourceDef, Router, Url};
use actix_service::boxed::{self, BoxService, BoxServiceFactory}; use actix_service::{
use actix_service::{fn_service, Service, ServiceFactory}; boxed::{self, BoxService, BoxServiceFactory},
fn_service, Service, ServiceFactory,
};
use futures_core::future::LocalBoxFuture; use futures_core::future::LocalBoxFuture;
use futures_util::future::join_all; use futures_util::future::join_all;
use crate::data::FnDataFactory;
use crate::error::Error;
use crate::guard::Guard;
use crate::request::{HttpRequest, HttpRequestPool};
use crate::rmap::ResourceMap;
use crate::service::{AppServiceFactory, ServiceRequest, ServiceResponse};
use crate::{ use crate::{
config::{AppConfig, AppService}, config::{AppConfig, AppService},
HttpResponse, data::FnDataFactory,
guard::Guard,
request::{HttpRequest, HttpRequestPool},
rmap::ResourceMap,
service::{AppServiceFactory, ServiceRequest, ServiceResponse},
Error, HttpResponse,
}; };
type Guards = Vec<Box<dyn Guard>>; type Guards = Vec<Box<dyn Guard>>;
@ -75,7 +75,7 @@ where
let mut config = AppService::new(config, default.clone()); let mut config = AppService::new(config, default.clone());
// register services // register services
std::mem::take(&mut *self.services.borrow_mut()) mem::take(&mut *self.services.borrow_mut())
.into_iter() .into_iter()
.for_each(|mut srv| srv.register(&mut config)); .for_each(|mut srv| srv.register(&mut config));
@ -98,7 +98,7 @@ where
}); });
// external resources // external resources
for mut rdef in std::mem::take(&mut *self.external.borrow_mut()) { for mut rdef in mem::take(&mut *self.external.borrow_mut()) {
rmap.add(&mut rdef, None); rmap.add(&mut rdef, None);
} }
@ -144,7 +144,9 @@ where
} }
} }
/// Service that takes a [`Request`] and delegates to a service that take a [`ServiceRequest`]. /// The [`Service`] that is passed to `actix-http`'s server builder.
///
/// Wraps a service receiving a [`ServiceRequest`] into one receiving a [`Request`].
pub struct AppInitService<T, B> pub struct AppInitService<T, B>
where where
T: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>, T: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
@ -275,6 +277,7 @@ impl ServiceFactory<ServiceRequest> for AppRoutingFactory {
} }
} }
/// The Actix Web router default entry point.
pub struct AppRouting { pub struct AppRouting {
router: Router<HttpService, Guards>, router: Router<HttpService, Guards>,
default: HttpService, default: HttpService,

13
src/config.rs
View File

@ -62,6 +62,8 @@ impl AppService {
(self.config, self.services) (self.config, self.services)
} }
/// Clones inner config and default service, returning new `AppService` with empty service list
/// marked as non-root.
pub(crate) fn clone_config(&self) -> Self { pub(crate) fn clone_config(&self) -> Self {
AppService { AppService {
config: self.config.clone(), config: self.config.clone(),
@ -71,12 +73,12 @@ impl AppService {
} }
} }
/// Service configuration /// Returns reference to configuration.
pub fn config(&self) -> &AppConfig { pub fn config(&self) -> &AppConfig {
&self.config &self.config
} }
/// Default resource /// Returns default handler factory.
pub fn default_service(&self) -> Rc<HttpNewService> { pub fn default_service(&self) -> Rc<HttpNewService> {
self.default.clone() self.default.clone()
} }
@ -92,9 +94,9 @@ impl AppService {
F: IntoServiceFactory<S, ServiceRequest>, F: IntoServiceFactory<S, ServiceRequest>,
S: ServiceFactory< S: ServiceFactory<
ServiceRequest, ServiceRequest,
Config = (),
Response = ServiceResponse, Response = ServiceResponse,
Error = Error, Error = Error,
Config = (),
InitError = (), InitError = (),
> + 'static, > + 'static,
{ {
@ -116,7 +118,7 @@ impl AppConfig {
AppConfig { secure, host, addr } AppConfig { secure, host, addr }
} }
/// Needed in actix-test crate. /// Needed in actix-test crate. Semver exempt.
#[doc(hidden)] #[doc(hidden)]
pub fn __priv_test_new(secure: bool, host: String, addr: SocketAddr) -> Self { pub fn __priv_test_new(secure: bool, host: String, addr: SocketAddr) -> Self {
AppConfig::new(secure, host, addr) AppConfig::new(secure, host, addr)
@ -192,6 +194,7 @@ impl ServiceConfig {
/// Add shared app data item. /// Add shared app data item.
/// ///
/// Counterpart to [`App::data()`](crate::App::data). /// Counterpart to [`App::data()`](crate::App::data).
#[deprecated(since = "4.0.0", note = "Use `.app_data(Data::new(val))` instead.")]
pub fn data<U: 'static>(&mut self, data: U) -> &mut Self { pub fn data<U: 'static>(&mut self, data: U) -> &mut Self {
self.app_data(Data::new(data)); self.app_data(Data::new(data));
self self
@ -257,6 +260,8 @@ mod tests {
use crate::test::{call_service, init_service, read_body, TestRequest}; use crate::test::{call_service, init_service, read_body, TestRequest};
use crate::{web, App, HttpRequest, HttpResponse}; use crate::{web, App, HttpRequest, HttpResponse};
// allow deprecated `ServiceConfig::data`
#[allow(deprecated)]
#[actix_rt::test] #[actix_rt::test]
async fn test_data() { async fn test_data() {
let cfg = |cfg: &mut ServiceConfig| { let cfg = |cfg: &mut ServiceConfig| {

5
src/data.rs
View File

@ -36,6 +36,11 @@ pub(crate) type FnDataFactory =
/// If route data is not set for a handler, using `Data<T>` extractor would cause *Internal /// If route data is not set for a handler, using `Data<T>` extractor would cause *Internal
/// Server Error* response. /// Server Error* response.
/// ///
// TODO: document `dyn T` functionality through converting an Arc
// TODO: note equivalence of req.app_data<Data<T>> and Data<T> extractor
// TODO: note that data must be inserted using Data<T> in order to extract it
///
/// # Examples
/// ``` /// ```
/// use std::sync::Mutex; /// use std::sync::Mutex;
/// use actix_web::{web, App, HttpResponse, Responder}; /// use actix_web::{web, App, HttpResponse, Responder};

16
src/error/macros.rs
View File

@ -1,6 +1,4 @@
#[macro_export] macro_rules! downcast_get_type_id {
#[doc(hidden)]
macro_rules! __downcast_get_type_id {
() => { () => {
/// A helper method to get the type ID of the type /// A helper method to get the type ID of the type
/// this trait is implemented on. /// this trait is implemented on.
@ -30,10 +28,8 @@ macro_rules! __downcast_get_type_id {
}; };
} }
//Generate implementation for dyn $name // Generate implementation for dyn $name
#[doc(hidden)] macro_rules! downcast_dyn {
#[macro_export]
macro_rules! __downcast_dyn {
($name:ident) => { ($name:ident) => {
/// A struct with a private constructor, for use with /// A struct with a private constructor, for use with
/// `__private_get_type_id__`. Its single field is private, /// `__private_get_type_id__`. Its single field is private,
@ -80,15 +76,17 @@ macro_rules! __downcast_dyn {
}; };
} }
pub(crate) use {downcast_dyn, downcast_get_type_id};
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
#![allow(clippy::upper_case_acronyms)] #![allow(clippy::upper_case_acronyms)]
trait MB { trait MB {
__downcast_get_type_id!(); downcast_get_type_id!();
} }
__downcast_dyn!(MB); downcast_dyn!(MB);
impl MB for String {} impl MB for String {}
impl MB for () {} impl MB for () {}

1
src/error/mod.rs
View File

@ -18,6 +18,7 @@ mod response_error;
pub use self::error::Error; pub use self::error::Error;
pub use self::internal::*; pub use self::internal::*;
pub use self::response_error::ResponseError; pub use self::response_error::ResponseError;
pub(crate) use macros::{downcast_dyn, downcast_get_type_id};
/// A convenience [`Result`](std::result::Result) for Actix Web operations. /// A convenience [`Result`](std::result::Result) for Actix Web operations.
/// ///

10
src/error/response_error.rs
View File

@ -9,7 +9,7 @@ use std::{
use actix_http::{body::AnyBody, header, Response, StatusCode}; use actix_http::{body::AnyBody, header, Response, StatusCode};
use bytes::BytesMut; use bytes::BytesMut;
use crate::{__downcast_dyn, __downcast_get_type_id}; use crate::error::{downcast_dyn, downcast_get_type_id};
use crate::{helpers, HttpResponse}; use crate::{helpers, HttpResponse};
/// Errors that can generate responses. /// Errors that can generate responses.
@ -41,10 +41,10 @@ pub trait ResponseError: fmt::Debug + fmt::Display {
res.set_body(AnyBody::from(buf)) res.set_body(AnyBody::from(buf))
} }
__downcast_get_type_id!(); downcast_get_type_id!();
} }
__downcast_dyn!(ResponseError); downcast_dyn!(ResponseError);
impl ResponseError for Box<dyn StdError + 'static> {} impl ResponseError for Box<dyn StdError + 'static> {}
@ -57,6 +57,10 @@ impl ResponseError for serde::de::value::Error {
} }
} }
impl ResponseError for serde_json::Error {}
impl ResponseError for serde_urlencoded::ser::Error {}
impl ResponseError for std::str::Utf8Error { impl ResponseError for std::str::Utf8Error {
fn status_code(&self) -> StatusCode { fn status_code(&self) -> StatusCode {
StatusCode::BAD_REQUEST StatusCode::BAD_REQUEST

8
src/extract.rs
View File

@ -54,7 +54,7 @@ pub trait FromRequest: Sized {
/// use actix_web::{web, dev, App, Error, HttpRequest, FromRequest}; /// use actix_web::{web, dev, App, Error, HttpRequest, FromRequest};
/// use actix_web::error::ErrorBadRequest; /// use actix_web::error::ErrorBadRequest;
/// use futures_util::future::{ok, err, Ready}; /// use futures_util::future::{ok, err, Ready};
/// use serde_derive::Deserialize; /// use serde::Deserialize;
/// use rand; /// use rand;
/// ///
/// #[derive(Debug, Deserialize)] /// #[derive(Debug, Deserialize)]
@ -145,7 +145,7 @@ where
/// use actix_web::{web, dev, App, Result, Error, HttpRequest, FromRequest}; /// use actix_web::{web, dev, App, Result, Error, HttpRequest, FromRequest};
/// use actix_web::error::ErrorBadRequest; /// use actix_web::error::ErrorBadRequest;
/// use futures_util::future::{ok, err, Ready}; /// use futures_util::future::{ok, err, Ready};
/// use serde_derive::Deserialize; /// use serde::Deserialize;
/// use rand; /// use rand;
/// ///
/// #[derive(Debug, Deserialize)] /// #[derive(Debug, Deserialize)]
@ -265,7 +265,7 @@ impl FromRequest for Method {
#[doc(hidden)] #[doc(hidden)]
impl FromRequest for () { impl FromRequest for () {
type Error = Infallible; type Error = Infallible;
type Future = Ready<Result<(), Infallible>>; type Future = Ready<Result<Self, Self::Error>>;
type Config = (); type Config = ();
fn from_request(_: &HttpRequest, _: &mut Payload) -> Self::Future { fn from_request(_: &HttpRequest, _: &mut Payload) -> Self::Future {
@ -376,7 +376,7 @@ mod m {
mod tests { mod tests {
use actix_http::http::header; use actix_http::http::header;
use bytes::Bytes; use bytes::Bytes;
use serde_derive::Deserialize; use serde::Deserialize;
use super::*; use super::*;
use crate::test::TestRequest; use crate::test::TestRequest;

10
src/http/header/accept.rs
View File

@ -5,7 +5,7 @@ use mime::Mime;
use super::{qitem, QualityItem}; use super::{qitem, QualityItem};
use crate::http::header; use crate::http::header;
crate::__define_common_header! { crate::http::header::common_header! {
/// `Accept` header, defined in [RFC7231](http://tools.ietf.org/html/rfc7231#section-5.3.2) /// `Accept` header, defined in [RFC7231](http://tools.ietf.org/html/rfc7231#section-5.3.2)
/// ///
/// The `Accept` header field can be used by user agents to specify /// The `Accept` header field can be used by user agents to specify
@ -81,14 +81,14 @@ crate::__define_common_header! {
test_accept { test_accept {
// Tests from the RFC // Tests from the RFC
crate::__common_header_test!( crate::http::header::common_header_test!(
test1, test1,
vec![b"audio/*; q=0.2, audio/basic"], vec![b"audio/*; q=0.2, audio/basic"],
Some(Accept(vec![ Some(Accept(vec![
QualityItem::new("audio/*".parse().unwrap(), q(200)), QualityItem::new("audio/*".parse().unwrap(), q(200)),
qitem("audio/basic".parse().unwrap()), qitem("audio/basic".parse().unwrap()),
]))); ])));
crate::__common_header_test!( crate::http::header::common_header_test!(
test2, test2,
vec![b"text/plain; q=0.5, text/html, text/x-dvi; q=0.8, text/x-c"], vec![b"text/plain; q=0.5, text/html, text/x-dvi; q=0.8, text/x-c"],
Some(Accept(vec![ Some(Accept(vec![
@ -100,13 +100,13 @@ crate::__define_common_header! {
qitem("text/x-c".parse().unwrap()), qitem("text/x-c".parse().unwrap()),
]))); ])));
// Custom tests // Custom tests
crate::__common_header_test!( crate::http::header::common_header_test!(
test3, test3,
vec![b"text/plain; charset=utf-8"], vec![b"text/plain; charset=utf-8"],
Some(Accept(vec![ Some(Accept(vec![
qitem(mime::TEXT_PLAIN_UTF_8), qitem(mime::TEXT_PLAIN_UTF_8),
]))); ])));
crate::__common_header_test!( crate::http::header::common_header_test!(
test4, test4,
vec![b"text/plain; charset=utf-8; q=0.5"], vec![b"text/plain; charset=utf-8; q=0.5"],
Some(Accept(vec![ Some(Accept(vec![

4
src/http/header/accept_charset.rs
View File

@ -1,6 +1,6 @@
use super::{Charset, QualityItem, ACCEPT_CHARSET}; use super::{Charset, QualityItem, ACCEPT_CHARSET};
crate::__define_common_header! { crate::http::header::common_header! {
/// `Accept-Charset` header, defined in /// `Accept-Charset` header, defined in
/// [RFC7231](http://tools.ietf.org/html/rfc7231#section-5.3.3) /// [RFC7231](http://tools.ietf.org/html/rfc7231#section-5.3.3)
/// ///
@ -57,6 +57,6 @@ crate::__define_common_header! {
test_accept_charset { test_accept_charset {
// Test case from RFC // Test case from RFC
crate::__common_header_test!(test1, vec![b"iso-8859-5, unicode-1-1;q=0.8"]); crate::http::header::common_header_test!(test1, vec![b"iso-8859-5, unicode-1-1;q=0.8"]);
} }
} }

10
src/http/header/accept_encoding.rs
View File

@ -64,12 +64,12 @@ header! {
test_accept_encoding { test_accept_encoding {
// From the RFC // From the RFC
crate::__common_header_test!(test1, vec![b"compress, gzip"]); crate::http::header::common_header_test!(test1, vec![b"compress, gzip"]);
crate::__common_header_test!(test2, vec![b""], Some(AcceptEncoding(vec![]))); crate::http::header::common_header_test!(test2, vec![b""], Some(AcceptEncoding(vec![])));
crate::__common_header_test!(test3, vec![b"*"]); crate::http::header::common_header_test!(test3, vec![b"*"]);
// Note: Removed quality 1 from gzip // Note: Removed quality 1 from gzip
crate::__common_header_test!(test4, vec![b"compress;q=0.5, gzip"]); crate::http::header::common_header_test!(test4, vec![b"compress;q=0.5, gzip"]);
// Note: Removed quality 1 from gzip // Note: Removed quality 1 from gzip
crate::__common_header_test!(test5, vec![b"gzip, identity; q=0.5, *;q=0"]); crate::http::header::common_header_test!(test5, vec![b"gzip, identity; q=0.5, *;q=0"]);
} }
} }

6
src/http/header/accept_language.rs
View File

@ -2,7 +2,7 @@ use language_tags::LanguageTag;
use super::{QualityItem, ACCEPT_LANGUAGE}; use super::{QualityItem, ACCEPT_LANGUAGE};
crate::__define_common_header! { crate::http::header::common_header! {
/// `Accept-Language` header, defined in /// `Accept-Language` header, defined in
/// [RFC7231](http://tools.ietf.org/html/rfc7231#section-5.3.5) /// [RFC7231](http://tools.ietf.org/html/rfc7231#section-5.3.5)
/// ///
@ -53,9 +53,9 @@ crate::__define_common_header! {
test_accept_language { test_accept_language {
// From the RFC // From the RFC
crate::__common_header_test!(test1, vec![b"da, en-gb;q=0.8, en;q=0.7"]); crate::http::header::common_header_test!(test1, vec![b"da, en-gb;q=0.8, en;q=0.7"]);
// Own test // Own test
crate::__common_header_test!( crate::http::header::common_header_test!(
test2, vec![b"en-US, en; q=0.5, fr"], test2, vec![b"en-US, en; q=0.5, fr"],
Some(AcceptLanguage(vec![ Some(AcceptLanguage(vec![
qitem("en-US".parse().unwrap()), qitem("en-US".parse().unwrap()),

8
src/http/header/allow.rs
View File

@ -1,7 +1,7 @@
use crate::http::header; use crate::http::header;
use actix_http::http::Method; use actix_http::http::Method;
crate::__define_common_header! { crate::http::header::common_header! {
/// `Allow` header, defined in [RFC7231](http://tools.ietf.org/html/rfc7231#section-7.4.1) /// `Allow` header, defined in [RFC7231](http://tools.ietf.org/html/rfc7231#section-7.4.1)
/// ///
/// The `Allow` header field lists the set of methods advertised as /// The `Allow` header field lists the set of methods advertised as
@ -49,12 +49,12 @@ crate::__define_common_header! {
test_allow { test_allow {
// From the RFC // From the RFC
crate::__common_header_test!( crate::http::header::common_header_test!(
test1, test1,
vec![b"GET, HEAD, PUT"], vec![b"GET, HEAD, PUT"],
Some(HeaderField(vec![Method::GET, Method::HEAD, Method::PUT]))); Some(HeaderField(vec![Method::GET, Method::HEAD, Method::PUT])));
// Own tests // Own tests
crate::__common_header_test!( crate::http::header::common_header_test!(
test2, test2,
vec![b"OPTIONS, GET, PUT, POST, DELETE, HEAD, TRACE, CONNECT, PATCH"], vec![b"OPTIONS, GET, PUT, POST, DELETE, HEAD, TRACE, CONNECT, PATCH"],
Some(HeaderField(vec![ Some(HeaderField(vec![
@ -67,7 +67,7 @@ crate::__define_common_header! {
Method::TRACE, Method::TRACE,
Method::CONNECT, Method::CONNECT,
Method::PATCH]))); Method::PATCH])));
crate::__common_header_test!( crate::http::header::common_header_test!(
test3, test3,
vec![b""], vec![b""],
Some(HeaderField(Vec::<Method>::new()))); Some(HeaderField(Vec::<Method>::new())));

4
src/http/header/cache_control.rs
View File

@ -49,9 +49,9 @@ use crate::http::header;
#[derive(PartialEq, Clone, Debug)] #[derive(PartialEq, Clone, Debug)]
pub struct CacheControl(pub Vec<CacheDirective>); pub struct CacheControl(pub Vec<CacheDirective>);
crate::__common_header_deref!(CacheControl => Vec<CacheDirective>); crate::http::header::common_header_deref!(CacheControl => Vec<CacheDirective>);
// TODO: this could just be the __define_common_header! macro // TODO: this could just be the crate::http::header::common_header! macro
impl Header for CacheControl { impl Header for CacheControl {
fn name() -> header::HeaderName { fn name() -> header::HeaderName {
header::CACHE_CONTROL header::CACHE_CONTROL

6
src/http/header/content_language.rs
View File

@ -1,7 +1,7 @@
use super::{QualityItem, CONTENT_LANGUAGE}; use super::{QualityItem, CONTENT_LANGUAGE};
use language_tags::LanguageTag; use language_tags::LanguageTag;
crate::__define_common_header! { crate::http::header::common_header! {
/// `Content-Language` header, defined in /// `Content-Language` header, defined in
/// [RFC7231](https://tools.ietf.org/html/rfc7231#section-3.1.3.2) /// [RFC7231](https://tools.ietf.org/html/rfc7231#section-3.1.3.2)
/// ///
@ -50,7 +50,7 @@ crate::__define_common_header! {
(ContentLanguage, CONTENT_LANGUAGE) => (QualityItem<LanguageTag>)+ (ContentLanguage, CONTENT_LANGUAGE) => (QualityItem<LanguageTag>)+
test_content_language { test_content_language {
crate::__common_header_test!(test1, vec![b"da"]); crate::http::header::common_header_test!(test1, vec![b"da"]);
crate::__common_header_test!(test2, vec![b"mi, en"]); crate::http::header::common_header_test!(test2, vec![b"mi, en"]);
} }
} }

24
src/http/header/content_range.rs
View File

@ -4,65 +4,65 @@ use std::str::FromStr;
use super::{HeaderValue, IntoHeaderValue, InvalidHeaderValue, Writer, CONTENT_RANGE}; use super::{HeaderValue, IntoHeaderValue, InvalidHeaderValue, Writer, CONTENT_RANGE};
use crate::error::ParseError; use crate::error::ParseError;
crate::__define_common_header! { crate::http::header::common_header! {
/// `Content-Range` header, defined in /// `Content-Range` header, defined in
/// [RFC7233](http://tools.ietf.org/html/rfc7233#section-4.2) /// [RFC7233](http://tools.ietf.org/html/rfc7233#section-4.2)
(ContentRange, CONTENT_RANGE) => [ContentRangeSpec] (ContentRange, CONTENT_RANGE) => [ContentRangeSpec]
test_content_range { test_content_range {
crate::__common_header_test!(test_bytes, crate::http::header::common_header_test!(test_bytes,
vec![b"bytes 0-499/500"], vec![b"bytes 0-499/500"],
Some(ContentRange(ContentRangeSpec::Bytes { Some(ContentRange(ContentRangeSpec::Bytes {
range: Some((0, 499)), range: Some((0, 499)),
instance_length: Some(500) instance_length: Some(500)
}))); })));
crate::__common_header_test!(test_bytes_unknown_len, crate::http::header::common_header_test!(test_bytes_unknown_len,
vec![b"bytes 0-499/*"], vec![b"bytes 0-499/*"],
Some(ContentRange(ContentRangeSpec::Bytes { Some(ContentRange(ContentRangeSpec::Bytes {
range: Some((0, 499)), range: Some((0, 499)),
instance_length: None instance_length: None
}))); })));
crate::__common_header_test!(test_bytes_unknown_range, crate::http::header::common_header_test!(test_bytes_unknown_range,
vec![b"bytes */500"], vec![b"bytes */500"],
Some(ContentRange(ContentRangeSpec::Bytes { Some(ContentRange(ContentRangeSpec::Bytes {
range: None, range: None,
instance_length: Some(500) instance_length: Some(500)
}))); })));
crate::__common_header_test!(test_unregistered, crate::http::header::common_header_test!(test_unregistered,
vec![b"seconds 1-2"], vec![b"seconds 1-2"],
Some(ContentRange(ContentRangeSpec::Unregistered { Some(ContentRange(ContentRangeSpec::Unregistered {
unit: "seconds".to_owned(), unit: "seconds".to_owned(),
resp: "1-2".to_owned() resp: "1-2".to_owned()
}))); })));
crate::__common_header_test!(test_no_len, crate::http::header::common_header_test!(test_no_len,
vec![b"bytes 0-499"], vec![b"bytes 0-499"],
None::<ContentRange>); None::<ContentRange>);
crate::__common_header_test!(test_only_unit, crate::http::header::common_header_test!(test_only_unit,
vec![b"bytes"], vec![b"bytes"],
None::<ContentRange>); None::<ContentRange>);
crate::__common_header_test!(test_end_less_than_start, crate::http::header::common_header_test!(test_end_less_than_start,
vec![b"bytes 499-0/500"], vec![b"bytes 499-0/500"],
None::<ContentRange>); None::<ContentRange>);
crate::__common_header_test!(test_blank, crate::http::header::common_header_test!(test_blank,
vec![b""], vec![b""],
None::<ContentRange>); None::<ContentRange>);
crate::__common_header_test!(test_bytes_many_spaces, crate::http::header::common_header_test!(test_bytes_many_spaces,
vec![b"bytes 1-2/500 3"], vec![b"bytes 1-2/500 3"],
None::<ContentRange>); None::<ContentRange>);
crate::__common_header_test!(test_bytes_many_slashes, crate::http::header::common_header_test!(test_bytes_many_slashes,
vec![b"bytes 1-2/500/600"], vec![b"bytes 1-2/500/600"],
None::<ContentRange>); None::<ContentRange>);
crate::__common_header_test!(test_bytes_many_dashes, crate::http::header::common_header_test!(test_bytes_many_dashes,
vec![b"bytes 1-2-3/500"], vec![b"bytes 1-2-3/500"],
None::<ContentRange>); None::<ContentRange>);

4
src/http/header/content_type.rs
View File

@ -1,7 +1,7 @@
use super::CONTENT_TYPE; use super::CONTENT_TYPE;
use mime::Mime; use mime::Mime;
crate::__define_common_header! { crate::http::header::common_header! {
/// `Content-Type` header, defined in /// `Content-Type` header, defined in
/// [RFC7231](http://tools.ietf.org/html/rfc7231#section-3.1.1.5) /// [RFC7231](http://tools.ietf.org/html/rfc7231#section-3.1.1.5)
/// ///
@ -52,7 +52,7 @@ crate::__define_common_header! {
(ContentType, CONTENT_TYPE) => [Mime] (ContentType, CONTENT_TYPE) => [Mime]
test_content_type { test_content_type {
crate::__common_header_test!( crate::http::header::common_header_test!(
test1, test1,
vec![b"text/html"], vec![b"text/html"],
Some(HeaderField(mime::TEXT_HTML))); Some(HeaderField(mime::TEXT_HTML)));

4
src/http/header/date.rs
View File

@ -1,7 +1,7 @@
use super::{HttpDate, DATE}; use super::{HttpDate, DATE};
use std::time::SystemTime; use std::time::SystemTime;
crate::__define_common_header! { crate::http::header::common_header! {
/// `Date` header, defined in [RFC7231](http://tools.ietf.org/html/rfc7231#section-7.1.1.2) /// `Date` header, defined in [RFC7231](http://tools.ietf.org/html/rfc7231#section-7.1.1.2)
/// ///
/// The `Date` header field represents the date and time at which the /// The `Date` header field represents the date and time at which the
@ -32,7 +32,7 @@ crate::__define_common_header! {
(Date, DATE) => [HttpDate] (Date, DATE) => [HttpDate]
test_date { test_date {
crate::__common_header_test!(test1, vec![b"Tue, 15 Nov 1994 08:12:31 GMT"]); crate::http::header::common_header_test!(test1, vec![b"Tue, 15 Nov 1994 08:12:31 GMT"]);
} }
} }

32
src/http/header/etag.rs
View File

@ -1,6 +1,6 @@
use super::{EntityTag, ETAG}; use super::{EntityTag, ETAG};
crate::__define_common_header! { crate::http::header::common_header! {
/// `ETag` header, defined in [RFC7232](http://tools.ietf.org/html/rfc7232#section-2.3) /// `ETag` header, defined in [RFC7232](http://tools.ietf.org/html/rfc7232#section-2.3)
/// ///
/// The `ETag` header field in a response provides the current entity-tag /// The `ETag` header field in a response provides the current entity-tag
@ -50,50 +50,50 @@ crate::__define_common_header! {
test_etag { test_etag {
// From the RFC // From the RFC
crate::__common_header_test!(test1, crate::http::header::common_header_test!(test1,
vec![b"\"xyzzy\""], vec![b"\"xyzzy\""],
Some(ETag(EntityTag::new(false, "xyzzy".to_owned())))); Some(ETag(EntityTag::new(false, "xyzzy".to_owned()))));
crate::__common_header_test!(test2, crate::http::header::common_header_test!(test2,
vec![b"W/\"xyzzy\""], vec![b"W/\"xyzzy\""],
Some(ETag(EntityTag::new(true, "xyzzy".to_owned())))); Some(ETag(EntityTag::new(true, "xyzzy".to_owned()))));
crate::__common_header_test!(test3, crate::http::header::common_header_test!(test3,
vec![b"\"\""], vec![b"\"\""],
Some(ETag(EntityTag::new(false, "".to_owned())))); Some(ETag(EntityTag::new(false, "".to_owned()))));
// Own tests // Own tests
crate::__common_header_test!(test4, crate::http::header::common_header_test!(test4,
vec![b"\"foobar\""], vec![b"\"foobar\""],
Some(ETag(EntityTag::new(false, "foobar".to_owned())))); Some(ETag(EntityTag::new(false, "foobar".to_owned()))));
crate::__common_header_test!(test5, crate::http::header::common_header_test!(test5,
vec![b"\"\""], vec![b"\"\""],
Some(ETag(EntityTag::new(false, "".to_owned())))); Some(ETag(EntityTag::new(false, "".to_owned()))));
crate::__common_header_test!(test6, crate::http::header::common_header_test!(test6,
vec![b"W/\"weak-etag\""], vec![b"W/\"weak-etag\""],
Some(ETag(EntityTag::new(true, "weak-etag".to_owned())))); Some(ETag(EntityTag::new(true, "weak-etag".to_owned()))));
crate::__common_header_test!(test7, crate::http::header::common_header_test!(test7,
vec![b"W/\"\x65\x62\""], vec![b"W/\"\x65\x62\""],
Some(ETag(EntityTag::new(true, "\u{0065}\u{0062}".to_owned())))); Some(ETag(EntityTag::new(true, "\u{0065}\u{0062}".to_owned()))));
crate::__common_header_test!(test8, crate::http::header::common_header_test!(test8,
vec![b"W/\"\""], vec![b"W/\"\""],
Some(ETag(EntityTag::new(true, "".to_owned())))); Some(ETag(EntityTag::new(true, "".to_owned()))));
crate::__common_header_test!(test9, crate::http::header::common_header_test!(test9,
vec![b"no-dquotes"], vec![b"no-dquotes"],
None::<ETag>); None::<ETag>);
crate::__common_header_test!(test10, crate::http::header::common_header_test!(test10,
vec![b"w/\"the-first-w-is-case-sensitive\""], vec![b"w/\"the-first-w-is-case-sensitive\""],
None::<ETag>); None::<ETag>);
crate::__common_header_test!(test11, crate::http::header::common_header_test!(test11,
vec![b""], vec![b""],
None::<ETag>); None::<ETag>);
crate::__common_header_test!(test12, crate::http::header::common_header_test!(test12,
vec![b"\"unmatched-dquotes1"], vec![b"\"unmatched-dquotes1"],
None::<ETag>); None::<ETag>);
crate::__common_header_test!(test13, crate::http::header::common_header_test!(test13,
vec![b"unmatched-dquotes2\""], vec![b"unmatched-dquotes2\""],
None::<ETag>); None::<ETag>);
crate::__common_header_test!(test14, crate::http::header::common_header_test!(test14,
vec![b"matched-\"dquotes\""], vec![b"matched-\"dquotes\""],
None::<ETag>); None::<ETag>);
crate::__common_header_test!(test15, crate::http::header::common_header_test!(test15,
vec![b"\""], vec![b"\""],
None::<ETag>); None::<ETag>);
} }

4
src/http/header/expires.rs
View File

@ -1,6 +1,6 @@
use super::{HttpDate, EXPIRES}; use super::{HttpDate, EXPIRES};
crate::__define_common_header! { crate::http::header::common_header! {
/// `Expires` header, defined in [RFC7234](http://tools.ietf.org/html/rfc7234#section-5.3) /// `Expires` header, defined in [RFC7234](http://tools.ietf.org/html/rfc7234#section-5.3)
/// ///
/// The `Expires` header field gives the date/time after which the /// The `Expires` header field gives the date/time after which the
@ -36,6 +36,6 @@ crate::__define_common_header! {
test_expires { test_expires {
// Test case from RFC // Test case from RFC
crate::__common_header_test!(test1, vec![b"Thu, 01 Dec 1994 16:00:00 GMT"]); crate::http::header::common_header_test!(test1, vec![b"Thu, 01 Dec 1994 16:00:00 GMT"]);
} }
} }

8
src/http/header/if_match.rs
View File

@ -1,6 +1,6 @@
use super::{EntityTag, IF_MATCH}; use super::{EntityTag, IF_MATCH};
crate::__define_common_header! { crate::http::header::common_header! {
/// `If-Match` header, defined in /// `If-Match` header, defined in
/// [RFC7232](https://tools.ietf.org/html/rfc7232#section-3.1) /// [RFC7232](https://tools.ietf.org/html/rfc7232#section-3.1)
/// ///
@ -53,18 +53,18 @@ crate::__define_common_header! {
(IfMatch, IF_MATCH) => {Any / (EntityTag)+} (IfMatch, IF_MATCH) => {Any / (EntityTag)+}
test_if_match { test_if_match {
crate::__common_header_test!( crate::http::header::common_header_test!(
test1, test1,
vec![b"\"xyzzy\""], vec![b"\"xyzzy\""],
Some(HeaderField::Items( Some(HeaderField::Items(
vec![EntityTag::new(false, "xyzzy".to_owned())]))); vec![EntityTag::new(false, "xyzzy".to_owned())])));
crate::__common_header_test!( crate::http::header::common_header_test!(
test2, test2,
vec![b"\"xyzzy\", \"r2d2xxxx\", \"c3piozzzz\""], vec![b"\"xyzzy\", \"r2d2xxxx\", \"c3piozzzz\""],
Some(HeaderField::Items( Some(HeaderField::Items(
vec![EntityTag::new(false, "xyzzy".to_owned()), vec![EntityTag::new(false, "xyzzy".to_owned()),
EntityTag::new(false, "r2d2xxxx".to_owned()), EntityTag::new(false, "r2d2xxxx".to_owned()),
EntityTag::new(false, "c3piozzzz".to_owned())]))); EntityTag::new(false, "c3piozzzz".to_owned())])));
crate::__common_header_test!(test3, vec![b"*"], Some(IfMatch::Any)); crate::http::header::common_header_test!(test3, vec![b"*"], Some(IfMatch::Any));
} }
} }

4
src/http/header/if_modified_since.rs
View File

@ -1,6 +1,6 @@
use super::{HttpDate, IF_MODIFIED_SINCE}; use super::{HttpDate, IF_MODIFIED_SINCE};
crate::__define_common_header! { crate::http::header::common_header! {
/// `If-Modified-Since` header, defined in /// `If-Modified-Since` header, defined in
/// [RFC7232](http://tools.ietf.org/html/rfc7232#section-3.3) /// [RFC7232](http://tools.ietf.org/html/rfc7232#section-3.3)
/// ///
@ -36,6 +36,6 @@ crate::__define_common_header! {
test_if_modified_since { test_if_modified_since {
// Test case from RFC // Test case from RFC
crate::__common_header_test!(test1, vec![b"Sat, 29 Oct 1994 19:43:31 GMT"]); crate::http::header::common_header_test!(test1, vec![b"Sat, 29 Oct 1994 19:43:31 GMT"]);
} }
} }

12
src/http/header/if_none_match.rs
View File

@ -1,6 +1,6 @@
use super::{EntityTag, IF_NONE_MATCH}; use super::{EntityTag, IF_NONE_MATCH};
crate::__define_common_header! { crate::http::header::common_header! {
/// `If-None-Match` header, defined in /// `If-None-Match` header, defined in
/// [RFC7232](https://tools.ietf.org/html/rfc7232#section-3.2) /// [RFC7232](https://tools.ietf.org/html/rfc7232#section-3.2)
/// ///
@ -55,11 +55,11 @@ crate::__define_common_header! {
(IfNoneMatch, IF_NONE_MATCH) => {Any / (EntityTag)+} (IfNoneMatch, IF_NONE_MATCH) => {Any / (EntityTag)+}
test_if_none_match { test_if_none_match {
crate::__common_header_test!(test1, vec![b"\"xyzzy\""]); crate::http::header::common_header_test!(test1, vec![b"\"xyzzy\""]);
crate::__common_header_test!(test2, vec![b"W/\"xyzzy\""]); crate::http::header::common_header_test!(test2, vec![b"W/\"xyzzy\""]);
crate::__common_header_test!(test3, vec![b"\"xyzzy\", \"r2d2xxxx\", \"c3piozzzz\""]); crate::http::header::common_header_test!(test3, vec![b"\"xyzzy\", \"r2d2xxxx\", \"c3piozzzz\""]);
crate::__common_header_test!(test4, vec![b"W/\"xyzzy\", W/\"r2d2xxxx\", W/\"c3piozzzz\""]); crate::http::header::common_header_test!(test4, vec![b"W/\"xyzzy\", W/\"r2d2xxxx\", W/\"c3piozzzz\""]);
crate::__common_header_test!(test5, vec![b"*"]); crate::http::header::common_header_test!(test5, vec![b"*"]);
} }
} }

6
src/http/header/if_range.rs
View File

@ -113,7 +113,7 @@ mod test_if_range {
use crate::http::header::*; use crate::http::header::*;
use std::str; use std::str;
crate::__common_header_test!(test1, vec![b"Sat, 29 Oct 1994 19:43:31 GMT"]); crate::http::header::common_header_test!(test1, vec![b"Sat, 29 Oct 1994 19:43:31 GMT"]);
crate::__common_header_test!(test2, vec![b"\"abc\""]); crate::http::header::common_header_test!(test2, vec![b"\"abc\""]);
crate::__common_header_test!(test3, vec![b"this-is-invalid"], None::<IfRange>); crate::http::header::common_header_test!(test3, vec![b"this-is-invalid"], None::<IfRange>);
} }

4
src/http/header/if_unmodified_since.rs
View File

@ -1,6 +1,6 @@
use super::{HttpDate, IF_UNMODIFIED_SINCE}; use super::{HttpDate, IF_UNMODIFIED_SINCE};
crate::__define_common_header! { crate::http::header::common_header! {
/// `If-Unmodified-Since` header, defined in /// `If-Unmodified-Since` header, defined in
/// [RFC7232](http://tools.ietf.org/html/rfc7232#section-3.4) /// [RFC7232](http://tools.ietf.org/html/rfc7232#section-3.4)
/// ///
@ -37,6 +37,6 @@ crate::__define_common_header! {
test_if_unmodified_since { test_if_unmodified_since {
// Test case from RFC // Test case from RFC
crate::__common_header_test!(test1, vec![b"Sat, 29 Oct 1994 19:43:31 GMT"]); crate::http::header::common_header_test!(test1, vec![b"Sat, 29 Oct 1994 19:43:31 GMT"]);
} }
} }

4
src/http/header/last_modified.rs
View File

@ -1,6 +1,6 @@
use super::{HttpDate, LAST_MODIFIED}; use super::{HttpDate, LAST_MODIFIED};
crate::__define_common_header! { crate::http::header::common_header! {
/// `Last-Modified` header, defined in /// `Last-Modified` header, defined in
/// [RFC7232](http://tools.ietf.org/html/rfc7232#section-2.2) /// [RFC7232](http://tools.ietf.org/html/rfc7232#section-2.2)
/// ///
@ -36,6 +36,6 @@ crate::__define_common_header! {
test_last_modified { test_last_modified {
// Test case from RFC // Test case from RFC
crate::__common_header_test!(test1, vec![b"Sat, 29 Oct 1994 19:43:31 GMT"]); crate::http::header::common_header_test!(test1, vec![b"Sat, 29 Oct 1994 19:43:31 GMT"]);
} }
} }

44
src/http/header/macros.rs
View File

@ -1,6 +1,4 @@
#[doc(hidden)] macro_rules! common_header_deref {
#[macro_export]
macro_rules! __common_header_deref {
($from:ty => $to:ty) => { ($from:ty => $to:ty) => {
impl ::std::ops::Deref for $from { impl ::std::ops::Deref for $from {
type Target = $to; type Target = $to;
@ -20,9 +18,7 @@ macro_rules! __common_header_deref {
}; };
} }
#[doc(hidden)] macro_rules! common_header_test_module {
#[macro_export]
macro_rules! __common_header_test_module {
($id:ident, $tm:ident{$($tf:item)*}) => { ($id:ident, $tm:ident{$($tf:item)*}) => {
#[allow(unused_imports)] #[allow(unused_imports)]
#[cfg(test)] #[cfg(test)]
@ -37,9 +33,8 @@ macro_rules! __common_header_test_module {
} }
} }
#[doc(hidden)] #[cfg(test)]
#[macro_export] macro_rules! common_header_test {
macro_rules! __common_header_test {
($id:ident, $raw:expr) => { ($id:ident, $raw:expr) => {
#[test] #[test]
fn $id() { fn $id() {
@ -99,9 +94,7 @@ macro_rules! __common_header_test {
}; };
} }
#[doc(hidden)] macro_rules! common_header {
#[macro_export]
macro_rules! __define_common_header {
// $a:meta: Attributes associated with the header item (usually docs) // $a:meta: Attributes associated with the header item (usually docs)
// $id:ident: Identifier of the header // $id:ident: Identifier of the header
// $n:expr: Lowercase name of the header // $n:expr: Lowercase name of the header
@ -112,7 +105,7 @@ macro_rules! __define_common_header {
$(#[$a])* $(#[$a])*
#[derive(Clone, Debug, PartialEq)] #[derive(Clone, Debug, PartialEq)]
pub struct $id(pub Vec<$item>); pub struct $id(pub Vec<$item>);
crate::__common_header_deref!($id => Vec<$item>); crate::http::header::common_header_deref!($id => Vec<$item>);
impl $crate::http::header::Header for $id { impl $crate::http::header::Header for $id {
#[inline] #[inline]
fn name() -> $crate::http::header::HeaderName { fn name() -> $crate::http::header::HeaderName {
@ -148,7 +141,7 @@ macro_rules! __define_common_header {
$(#[$a])* $(#[$a])*
#[derive(Clone, Debug, PartialEq)] #[derive(Clone, Debug, PartialEq)]
pub struct $id(pub Vec<$item>); pub struct $id(pub Vec<$item>);
crate::__common_header_deref!($id => Vec<$item>); crate::http::header::common_header_deref!($id => Vec<$item>);
impl $crate::http::header::Header for $id { impl $crate::http::header::Header for $id {
#[inline] #[inline]
fn name() -> $crate::http::header::HeaderName { fn name() -> $crate::http::header::HeaderName {
@ -184,7 +177,7 @@ macro_rules! __define_common_header {
$(#[$a])* $(#[$a])*
#[derive(Clone, Debug, PartialEq)] #[derive(Clone, Debug, PartialEq)]
pub struct $id(pub $value); pub struct $id(pub $value);
crate::__common_header_deref!($id => $value); crate::http::header::common_header_deref!($id => $value);
impl $crate::http::header::Header for $id { impl $crate::http::header::Header for $id {
#[inline] #[inline]
fn name() -> $crate::http::header::HeaderName { fn name() -> $crate::http::header::HeaderName {
@ -267,34 +260,39 @@ macro_rules! __define_common_header {
// optional test module // optional test module
($(#[$a:meta])*($id:ident, $name:expr) => ($item:ty)* $tm:ident{$($tf:item)*}) => { ($(#[$a:meta])*($id:ident, $name:expr) => ($item:ty)* $tm:ident{$($tf:item)*}) => {
crate::__define_common_header! { crate::http::header::common_header! {
$(#[$a])* $(#[$a])*
($id, $name) => ($item)* ($id, $name) => ($item)*
} }
crate::__common_header_test_module! { $id, $tm { $($tf)* }} crate::http::header::common_header_test_module! { $id, $tm { $($tf)* }}
}; };
($(#[$a:meta])*($id:ident, $n:expr) => ($item:ty)+ $tm:ident{$($tf:item)*}) => { ($(#[$a:meta])*($id:ident, $n:expr) => ($item:ty)+ $tm:ident{$($tf:item)*}) => {
crate::__define_common_header! { crate::http::header::common_header! {
$(#[$a])* $(#[$a])*
($id, $n) => ($item)+ ($id, $n) => ($item)+
} }
crate::__common_header_test_module! { $id, $tm { $($tf)* }} crate::http::header::common_header_test_module! { $id, $tm { $($tf)* }}
}; };
($(#[$a:meta])*($id:ident, $name:expr) => [$item:ty] $tm:ident{$($tf:item)*}) => { ($(#[$a:meta])*($id:ident, $name:expr) => [$item:ty] $tm:ident{$($tf:item)*}) => {
crate::__define_common_header! { crate::http::header::common_header! {
$(#[$a])* ($id, $name) => [$item] $(#[$a])* ($id, $name) => [$item]
} }
crate::__common_header_test_module! { $id, $tm { $($tf)* }} crate::http::header::common_header_test_module! { $id, $tm { $($tf)* }}
}; };
($(#[$a:meta])*($id:ident, $name:expr) => {Any / ($item:ty)+} $tm:ident{$($tf:item)*}) => { ($(#[$a:meta])*($id:ident, $name:expr) => {Any / ($item:ty)+} $tm:ident{$($tf:item)*}) => {
crate::__define_common_header! { crate::http::header::common_header! {
$(#[$a])* $(#[$a])*
($id, $name) => {Any / ($item)+} ($id, $name) => {Any / ($item)+}
} }
crate::__common_header_test_module! { $id, $tm { $($tf)* }} crate::http::header::common_header_test_module! { $id, $tm { $($tf)* }}
}; };
} }
pub(crate) use {common_header, common_header_deref, common_header_test_module};
#[cfg(test)]
pub(crate) use common_header_test;

4
src/http/header/mod.rs
View File

@ -84,4 +84,8 @@ mod if_none_match;
mod if_range; mod if_range;
mod if_unmodified_since; mod if_unmodified_since;
mod last_modified; mod last_modified;
mod macros; mod macros;
#[cfg(test)]
pub(crate) use macros::common_header_test;
pub(crate) use macros::{common_header, common_header_deref, common_header_test_module};

4
src/lib.rs
View File

@ -149,7 +149,9 @@ pub mod dev {
pub use actix_http::{Extensions, Payload, PayloadStream, RequestHead, ResponseHead}; pub use actix_http::{Extensions, Payload, PayloadStream, RequestHead, ResponseHead};
pub use actix_router::{Path, ResourceDef, ResourcePath, Url}; pub use actix_router::{Path, ResourceDef, ResourcePath, Url};
pub use actix_server::Server; pub use actix_server::Server;
pub use actix_service::{always_ready, forward_ready, Service, Transform}; pub use actix_service::{
always_ready, fn_factory, fn_service, forward_ready, Service, Transform,
};
pub(crate) fn insert_slash(mut patterns: Vec<String>) -> Vec<String> { pub(crate) fn insert_slash(mut patterns: Vec<String>) -> Vec<String> {
for path in &mut patterns { for path in &mut patterns {

2
src/request.rs
View File

@ -347,7 +347,7 @@ impl Drop for HttpRequest {
/// # Examples /// # Examples
/// ``` /// ```
/// use actix_web::{web, App, HttpRequest}; /// use actix_web::{web, App, HttpRequest};
/// use serde_derive::Deserialize; /// use serde::Deserialize;
/// ///
/// /// extract `Thing` from request /// /// extract `Thing` from request
/// async fn index(req: HttpRequest) -> String { /// async fn index(req: HttpRequest) -> String {

171
src/resource.rs
View File

@ -169,41 +169,38 @@ where
self self
} }
/// Provide resource specific data. This method allows to add extractor
/// configuration or specific state available via `Data<T>` extractor.
/// Provided data is available for all routes registered for the current resource.
/// Resource data overrides data registered by `App::data()` method.
///
/// ```
/// use actix_web::{web, App, FromRequest};
///
/// /// extract text data from request
/// async fn index(body: String) -> String {
/// format!("Body {}!", body)
/// }
///
/// fn main() {
/// let app = App::new().service(
/// web::resource("/index.html")
/// // limit size of the payload
/// .data(String::configure(|cfg| {
/// cfg.limit(4096)
/// }))
/// .route(
/// web::get()
/// // register handler
/// .to(index)
/// ));
/// }
/// ```
#[deprecated(since = "4.0.0", note = "Use `.app_data(Data::new(val))` instead.")]
pub fn data<U: 'static>(self, data: U) -> Self {
self.app_data(Data::new(data))
}
/// Add resource data. /// Add resource data.
/// ///
/// Data of different types from parent contexts will still be accessible. /// Data of different types from parent contexts will still be accessible. Any `Data<T>` types
/// set here can be extracted in handlers using the `Data<T>` extractor.
///
/// # Examples
/// ```
/// use std::cell::Cell;
/// use actix_web::{web, App, HttpRequest, HttpResponse, Responder};
///
/// struct MyData {
/// count: std::cell::Cell<usize>,
/// }
///
/// async fn handler(req: HttpRequest, counter: web::Data<MyData>) -> impl Responder {
/// // note this cannot use the Data<T> extractor because it was not added with it
/// let incr = *req.app_data::<usize>().unwrap();
/// assert_eq!(incr, 3);
///
/// // update counter using other value from app data
/// counter.count.set(counter.count.get() + incr);
///
/// HttpResponse::Ok().body(counter.count.get().to_string())
/// }
///
/// let app = App::new().service(
/// web::resource("/")
/// .app_data(3usize)
/// .app_data(web::Data::new(MyData { count: Default::default() }))
/// .route(web::get().to(handler))
/// );
/// ```
pub fn app_data<U: 'static>(mut self, data: U) -> Self { pub fn app_data<U: 'static>(mut self, data: U) -> Self {
self.app_data self.app_data
.get_or_insert_with(Extensions::new) .get_or_insert_with(Extensions::new)
@ -212,6 +209,14 @@ where
self self
} }
/// Add resource data after wrapping in `Data<T>`.
///
/// Deprecated in favor of [`app_data`](Self::app_data).
#[deprecated(since = "4.0.0", note = "Use `.app_data(Data::new(val))` instead.")]
pub fn data<U: 'static>(self, data: U) -> Self {
self.app_data(Data::new(data))
}
/// Register a new route and add handler. This route matches all requests. /// Register a new route and add handler. This route matches all requests.
/// ///
/// ``` /// ```
@ -227,7 +232,6 @@ where
/// This is shortcut for: /// This is shortcut for:
/// ///
/// ``` /// ```
/// # extern crate actix_web;
/// # use actix_web::*; /// # use actix_web::*;
/// # fn index(req: HttpRequest) -> HttpResponse { unimplemented!() } /// # fn index(req: HttpRequest) -> HttpResponse { unimplemented!() }
/// App::new().service(web::resource("/").route(web::route().to(index))); /// App::new().service(web::resource("/").route(web::route().to(index)));
@ -396,34 +400,28 @@ where
*rdef.name_mut() = name.clone(); *rdef.name_mut() = name.clone();
} }
config.register_service(rdef, guards, self, None)
}
}
impl<T> IntoServiceFactory<T, ServiceRequest> for Resource<T>
where
T: ServiceFactory<
ServiceRequest,
Config = (),
Response = ServiceResponse,
Error = Error,
InitError = (),
>,
{
fn into_factory(self) -> T {
*self.factory_ref.borrow_mut() = Some(ResourceFactory { *self.factory_ref.borrow_mut() = Some(ResourceFactory {
routes: self.routes, routes: self.routes,
app_data: self.app_data.map(Rc::new),
default: self.default, default: self.default,
}); });
self.endpoint let resource_data = self.app_data.map(Rc::new);
// wraps endpoint service (including middleware) call and injects app data for this scope
let endpoint = apply_fn_factory(self.endpoint, move |mut req: ServiceRequest, srv| {
if let Some(ref data) = resource_data {
req.add_data_container(Rc::clone(data));
}
srv.call(req)
});
config.register_service(rdef, guards, endpoint, None)
} }
} }
pub struct ResourceFactory { pub struct ResourceFactory {
routes: Vec<Route>, routes: Vec<Route>,
app_data: Option<Rc<Extensions>>,
default: HttpNewService, default: HttpNewService,
} }
@ -442,8 +440,6 @@ impl ServiceFactory<ServiceRequest> for ResourceFactory {
// construct route service factory futures // construct route service factory futures
let factory_fut = join_all(self.routes.iter().map(|route| route.new_service(()))); let factory_fut = join_all(self.routes.iter().map(|route| route.new_service(())));
let app_data = self.app_data.clone();
Box::pin(async move { Box::pin(async move {
let default = default_fut.await?; let default = default_fut.await?;
let routes = factory_fut let routes = factory_fut
@ -451,18 +447,13 @@ impl ServiceFactory<ServiceRequest> for ResourceFactory {
.into_iter() .into_iter()
.collect::<Result<Vec<_>, _>>()?; .collect::<Result<Vec<_>, _>>()?;
Ok(ResourceService { Ok(ResourceService { routes, default })
routes,
app_data,
default,
})
}) })
} }
} }
pub struct ResourceService { pub struct ResourceService {
routes: Vec<RouteService>, routes: Vec<RouteService>,
app_data: Option<Rc<Extensions>>,
default: HttpService, default: HttpService,
} }
@ -476,18 +467,10 @@ impl Service<ServiceRequest> for ResourceService {
fn call(&self, mut req: ServiceRequest) -> Self::Future { fn call(&self, mut req: ServiceRequest) -> Self::Future {
for route in self.routes.iter() { for route in self.routes.iter() {
if route.check(&mut req) { if route.check(&mut req) {
if let Some(ref app_data) = self.app_data {
req.add_data_container(app_data.clone());
}
return route.call(req); return route.call(req);
} }
} }
if let Some(ref app_data) = self.app_data {
req.add_data_container(app_data.clone());
}
self.default.call(req) self.default.call(req)
} }
} }
@ -524,11 +507,14 @@ mod tests {
use actix_service::Service; use actix_service::Service;
use actix_utils::future::ok; use actix_utils::future::ok;
use crate::http::{header, HeaderValue, Method, StatusCode}; use crate::{
use crate::middleware::DefaultHeaders; guard,
use crate::service::ServiceRequest; http::{header, HeaderValue, Method, StatusCode},
use crate::test::{call_service, init_service, TestRequest}; middleware::DefaultHeaders,
use crate::{guard, web, App, Error, HttpResponse}; service::{ServiceRequest, ServiceResponse},
test::{call_service, init_service, TestRequest},
web, App, Error, HttpMessage, HttpResponse,
};
#[actix_rt::test] #[actix_rt::test]
async fn test_middleware() { async fn test_middleware() {
@ -695,7 +681,7 @@ mod tests {
assert_eq!(resp.status(), StatusCode::NO_CONTENT); assert_eq!(resp.status(), StatusCode::NO_CONTENT);
} }
// allow deprecated App::data // allow deprecated `{App, Resource}::data`
#[allow(deprecated)] #[allow(deprecated)]
#[actix_rt::test] #[actix_rt::test]
async fn test_data() { async fn test_data() {
@ -729,7 +715,7 @@ mod tests {
assert_eq!(resp.status(), StatusCode::OK); assert_eq!(resp.status(), StatusCode::OK);
} }
// allow deprecated App::data // allow deprecated `{App, Resource}::data`
#[allow(deprecated)] #[allow(deprecated)]
#[actix_rt::test] #[actix_rt::test]
async fn test_data_default_service() { async fn test_data_default_service() {
@ -749,4 +735,39 @@ mod tests {
let resp = call_service(&srv, req).await; let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::OK); assert_eq!(resp.status(), StatusCode::OK);
} }
#[actix_rt::test]
async fn test_middleware_app_data() {
let srv = init_service(
App::new().service(
web::resource("test")
.app_data(1usize)
.wrap_fn(|req, srv| {
assert_eq!(req.app_data::<usize>(), Some(&1usize));
req.extensions_mut().insert(1usize);
srv.call(req)
})
.route(web::get().to(HttpResponse::Ok))
.default_service(|req: ServiceRequest| async move {
let (req, _) = req.into_parts();
assert_eq!(req.extensions().get::<usize>(), Some(&1));
Ok(ServiceResponse::new(
req,
HttpResponse::BadRequest().finish(),
))
}),
),
)
.await;
let req = TestRequest::get().uri("/test").to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::OK);
let req = TestRequest::post().uri("/test").to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
}
} }

122
src/route.rs
View File

@ -5,7 +5,7 @@ use std::{future::Future, rc::Rc};
use actix_http::http::Method; use actix_http::http::Method;
use actix_service::{ use actix_service::{
boxed::{self, BoxService, BoxServiceFactory}, boxed::{self, BoxService, BoxServiceFactory},
Service, ServiceFactory, Service, ServiceFactory, ServiceFactoryExt,
}; };
use futures_core::future::LocalBoxFuture; use futures_core::future::LocalBoxFuture;
@ -128,9 +128,10 @@ impl Route {
/// Set handler function, use request extractors for parameters. /// Set handler function, use request extractors for parameters.
/// ///
/// # Examples
/// ``` /// ```
/// use actix_web::{web, http, App}; /// use actix_web::{web, http, App};
/// use serde_derive::Deserialize; /// use serde::Deserialize;
/// ///
/// #[derive(Deserialize)] /// #[derive(Deserialize)]
/// struct Info { /// struct Info {
@ -154,7 +155,7 @@ impl Route {
/// ///
/// ``` /// ```
/// # use std::collections::HashMap; /// # use std::collections::HashMap;
/// # use serde_derive::Deserialize; /// # use serde::Deserialize;
/// use actix_web::{web, App}; /// use actix_web::{web, App};
/// ///
/// #[derive(Deserialize)] /// #[derive(Deserialize)]
@ -184,6 +185,53 @@ impl Route {
self.service = boxed::factory(HandlerService::new(handler)); self.service = boxed::factory(HandlerService::new(handler));
self self
} }
/// Set raw service to be constructed and called as the request handler.
///
/// # Examples
/// ```
/// # use std::convert::Infallible;
/// # use futures_util::future::LocalBoxFuture;
/// # use actix_web::{*, dev::*, http::header};
/// struct HelloWorld;
///
/// impl Service<ServiceRequest> for HelloWorld {
/// type Response = ServiceResponse;
/// type Error = Infallible;
/// type Future = LocalBoxFuture<'static, Result<Self::Response, Self::Error>>;
///
/// always_ready!();
///
/// fn call(&self, req: ServiceRequest) -> Self::Future {
/// let (req, _) = req.into_parts();
///
/// let res = HttpResponse::Ok()
/// .insert_header(header::ContentType::plaintext())
/// .body("Hello world!");
///
/// Box::pin(async move { Ok(ServiceResponse::new(req, res)) })
/// }
/// }
///
/// App::new().route(
/// "/",
/// web::get().service(fn_factory(|| async { Ok(HelloWorld) })),
/// );
/// ```
pub fn service<S, E>(mut self, service_factory: S) -> Self
where
S: ServiceFactory<
ServiceRequest,
Response = ServiceResponse,
Error = E,
InitError = (),
Config = (),
> + 'static,
E: Into<Error> + 'static,
{
self.service = boxed::factory(service_factory.map_err(Into::into));
self
}
} }
#[cfg(test)] #[cfg(test)]
@ -192,9 +240,12 @@ mod tests {
use actix_rt::time::sleep; use actix_rt::time::sleep;
use bytes::Bytes; use bytes::Bytes;
use serde_derive::Serialize; use futures_core::future::LocalBoxFuture;
use serde::Serialize;
use crate::http::{Method, StatusCode}; use crate::dev::{always_ready, fn_factory, fn_service, Service};
use crate::http::{header, Method, StatusCode};
use crate::service::{ServiceRequest, ServiceResponse};
use crate::test::{call_service, init_service, read_body, TestRequest}; use crate::test::{call_service, init_service, read_body, TestRequest};
use crate::{error, web, App, HttpResponse}; use crate::{error, web, App, HttpResponse};
@ -268,4 +319,65 @@ mod tests {
let body = read_body(resp).await; let body = read_body(resp).await;
assert_eq!(body, Bytes::from_static(b"{\"name\":\"test\"}")); assert_eq!(body, Bytes::from_static(b"{\"name\":\"test\"}"));
} }
#[actix_rt::test]
async fn test_service_handler() {
struct HelloWorld;
impl Service<ServiceRequest> for HelloWorld {
type Response = ServiceResponse;
type Error = crate::Error;
type Future = LocalBoxFuture<'static, Result<Self::Response, Self::Error>>;
always_ready!();
fn call(&self, req: ServiceRequest) -> Self::Future {
let (req, _) = req.into_parts();
let res = HttpResponse::Ok()
.insert_header(header::ContentType::plaintext())
.body("Hello world!");
Box::pin(async move { Ok(ServiceResponse::new(req, res)) })
}
}
let srv = init_service(
App::new()
.route(
"/hello",
web::get().service(fn_factory(|| async { Ok(HelloWorld) })),
)
.route(
"/bye",
web::get().service(fn_factory(|| async {
Ok::<_, ()>(fn_service(|req: ServiceRequest| async {
let (req, _) = req.into_parts();
let res = HttpResponse::Ok()
.insert_header(header::ContentType::plaintext())
.body("Goodbye, and thanks for all the fish!");
Ok::<_, Infallible>(ServiceResponse::new(req, res))
}))
})),
),
)
.await;
let req = TestRequest::get().uri("/hello").to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::OK);
let body = read_body(resp).await;
assert_eq!(body, Bytes::from_static(b"Hello world!"));
let req = TestRequest::get().uri("/bye").to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::OK);
let body = read_body(resp).await;
assert_eq!(
body,
Bytes::from_static(b"Goodbye, and thanks for all the fish!")
);
}
} }

211
src/scope.rs
View File

@ -1,28 +1,23 @@
use std::cell::RefCell; use std::{cell::RefCell, fmt, future::Future, mem, rc::Rc};
use std::fmt;
use std::future::Future;
use std::rc::Rc;
use actix_http::Extensions; use actix_http::Extensions;
use actix_router::{ResourceDef, Router}; use actix_router::{ResourceDef, Router};
use actix_service::boxed::{self, BoxService, BoxServiceFactory};
use actix_service::{ use actix_service::{
apply, apply_fn_factory, IntoServiceFactory, Service, ServiceFactory, ServiceFactoryExt, apply, apply_fn_factory,
Transform, boxed::{self, BoxService, BoxServiceFactory},
IntoServiceFactory, Service, ServiceFactory, ServiceFactoryExt, Transform,
}; };
use futures_core::future::LocalBoxFuture; use futures_core::future::LocalBoxFuture;
use futures_util::future::join_all; use futures_util::future::join_all;
use crate::config::ServiceConfig; use crate::{
use crate::data::Data; config::ServiceConfig,
use crate::dev::{AppService, HttpServiceFactory}; data::Data,
use crate::error::Error; dev::{AppService, HttpServiceFactory},
use crate::guard::Guard; guard::Guard,
use crate::resource::Resource; rmap::ResourceMap,
use crate::rmap::ResourceMap; service::{AppServiceFactory, ServiceFactoryWrapper, ServiceRequest, ServiceResponse},
use crate::route::Route; Error, Resource, Route,
use crate::service::{
AppServiceFactory, ServiceFactoryWrapper, ServiceRequest, ServiceResponse,
}; };
type Guards = Vec<Box<dyn Guard>>; type Guards = Vec<Box<dyn Guard>>;
@ -71,16 +66,17 @@ pub struct Scope<T = ScopeEndpoint> {
impl Scope { impl Scope {
/// Create a new scope /// Create a new scope
pub fn new(path: &str) -> Scope { pub fn new(path: &str) -> Scope {
let fref = Rc::new(RefCell::new(None)); let factory_ref = Rc::new(RefCell::new(None));
Scope { Scope {
endpoint: ScopeEndpoint::new(fref.clone()), endpoint: ScopeEndpoint::new(Rc::clone(&factory_ref)),
rdef: path.to_string(), rdef: path.to_string(),
app_data: None, app_data: None,
guards: Vec::new(), guards: Vec::new(),
services: Vec::new(), services: Vec::new(),
default: None, default: None,
external: Vec::new(), external: Vec::new(),
factory_ref: fref, factory_ref,
} }
} }
} }
@ -120,40 +116,38 @@ where
self self
} }
/// Set or override application data. Application data could be accessed
/// by using `Data<T>` extractor where `T` is data type.
///
/// ```
/// use std::cell::Cell;
/// use actix_web::{web, App, HttpResponse, Responder};
///
/// struct MyData {
/// counter: Cell<usize>,
/// }
///
/// async fn index(data: web::Data<MyData>) -> impl Responder {
/// data.counter.set(data.counter.get() + 1);
/// HttpResponse::Ok()
/// }
///
/// fn main() {
/// let app = App::new().service(
/// web::scope("/app")
/// .data(MyData{ counter: Cell::new(0) })
/// .service(
/// web::resource("/index.html").route(
/// web::get().to(index)))
/// );
/// }
/// ```
#[deprecated(since = "4.0.0", note = "Use `.app_data(Data::new(val))` instead.")]
pub fn data<U: 'static>(self, data: U) -> Self {
self.app_data(Data::new(data))
}
/// Add scope data. /// Add scope data.
/// ///
/// Data of different types from parent contexts will still be accessible. /// Data of different types from parent contexts will still be accessible. Any `Data<T>` types
/// set here can be extracted in handlers using the `Data<T>` extractor.
///
/// # Examples
/// ```
/// use std::cell::Cell;
/// use actix_web::{web, App, HttpRequest, HttpResponse, Responder};
///
/// struct MyData {
/// count: std::cell::Cell<usize>,
/// }
///
/// async fn handler(req: HttpRequest, counter: web::Data<MyData>) -> impl Responder {
/// // note this cannot use the Data<T> extractor because it was not added with it
/// let incr = *req.app_data::<usize>().unwrap();
/// assert_eq!(incr, 3);
///
/// // update counter using other value from app data
/// counter.count.set(counter.count.get() + incr);
///
/// HttpResponse::Ok().body(counter.count.get().to_string())
/// }
///
/// let app = App::new().service(
/// web::scope("/app")
/// .app_data(3usize)
/// .app_data(web::Data::new(MyData { count: Default::default() }))
/// .route("/", web::get().to(handler))
/// );
/// ```
pub fn app_data<U: 'static>(mut self, data: U) -> Self { pub fn app_data<U: 'static>(mut self, data: U) -> Self {
self.app_data self.app_data
.get_or_insert_with(Extensions::new) .get_or_insert_with(Extensions::new)
@ -162,15 +156,20 @@ where
self self
} }
/// Run external configuration as part of the scope building /// Add scope data after wrapping in `Data<T>`.
/// process
/// ///
/// This function is useful for moving parts of configuration to a /// Deprecated in favor of [`app_data`](Self::app_data).
/// different module or even library. For example, #[deprecated(since = "4.0.0", note = "Use `.app_data(Data::new(val))` instead.")]
/// some of the resource's configuration could be moved to different module. pub fn data<U: 'static>(self, data: U) -> Self {
self.app_data(Data::new(data))
}
/// Run external configuration as part of the scope building process.
///
/// This function is useful for moving parts of configuration to a different module or library.
/// For example, some of the resource's configuration could be moved to different module.
/// ///
/// ``` /// ```
/// # extern crate actix_web;
/// use actix_web::{web, middleware, App, HttpResponse}; /// use actix_web::{web, middleware, App, HttpResponse};
/// ///
/// // this function could be located in different module /// // this function could be located in different module
@ -191,18 +190,21 @@ where
/// .route("/index.html", web::get().to(|| HttpResponse::Ok())); /// .route("/index.html", web::get().to(|| HttpResponse::Ok()));
/// } /// }
/// ``` /// ```
pub fn configure<F>(mut self, f: F) -> Self pub fn configure<F>(mut self, cfg_fn: F) -> Self
where where
F: FnOnce(&mut ServiceConfig), F: FnOnce(&mut ServiceConfig),
{ {
let mut cfg = ServiceConfig::new(); let mut cfg = ServiceConfig::new();
f(&mut cfg); cfg_fn(&mut cfg);
self.services.extend(cfg.services); self.services.extend(cfg.services);
self.external.extend(cfg.external); self.external.extend(cfg.external);
// TODO: add Extensions::is_empty check and conditionally insert data
self.app_data self.app_data
.get_or_insert_with(Extensions::new) .get_or_insert_with(Extensions::new)
.extend(cfg.app_data); .extend(cfg.app_data);
self self
} }
@ -419,13 +421,12 @@ where
let mut rmap = ResourceMap::new(ResourceDef::root_prefix(&self.rdef)); let mut rmap = ResourceMap::new(ResourceDef::root_prefix(&self.rdef));
// external resources // external resources
for mut rdef in std::mem::take(&mut self.external) { for mut rdef in mem::take(&mut self.external) {
rmap.add(&mut rdef, None); rmap.add(&mut rdef, None);
} }
// complete scope pipeline creation // complete scope pipeline creation
*self.factory_ref.borrow_mut() = Some(ScopeFactory { *self.factory_ref.borrow_mut() = Some(ScopeFactory {
app_data: self.app_data.take().map(Rc::new),
default, default,
services: cfg services: cfg
.into_services() .into_services()
@ -447,18 +448,28 @@ where
Some(self.guards) Some(self.guards)
}; };
let scope_data = self.app_data.map(Rc::new);
// wraps endpoint service (including middleware) call and injects app data for this scope
let endpoint = apply_fn_factory(self.endpoint, move |mut req: ServiceRequest, srv| {
if let Some(ref data) = scope_data {
req.add_data_container(Rc::clone(data));
}
srv.call(req)
});
// register final service // register final service
config.register_service( config.register_service(
ResourceDef::root_prefix(&self.rdef), ResourceDef::root_prefix(&self.rdef),
guards, guards,
self.endpoint, endpoint,
Some(Rc::new(rmap)), Some(Rc::new(rmap)),
) )
} }
} }
pub struct ScopeFactory { pub struct ScopeFactory {
app_data: Option<Rc<Extensions>>,
services: Rc<[(ResourceDef, HttpNewService, RefCell<Option<Guards>>)]>, services: Rc<[(ResourceDef, HttpNewService, RefCell<Option<Guards>>)]>,
default: Rc<HttpNewService>, default: Rc<HttpNewService>,
} }
@ -486,8 +497,6 @@ impl ServiceFactory<ServiceRequest> for ScopeFactory {
} }
})); }));
let app_data = self.app_data.clone();
Box::pin(async move { Box::pin(async move {
let default = default_fut.await?; let default = default_fut.await?;
@ -503,17 +512,12 @@ impl ServiceFactory<ServiceRequest> for ScopeFactory {
}) })
.finish(); .finish();
Ok(ScopeService { Ok(ScopeService { router, default })
app_data,
router,
default,
})
}) })
} }
} }
pub struct ScopeService { pub struct ScopeService {
app_data: Option<Rc<Extensions>>,
router: Router<HttpService, Vec<Box<dyn Guard>>>, router: Router<HttpService, Vec<Box<dyn Guard>>>,
default: HttpService, default: HttpService,
} }
@ -537,10 +541,6 @@ impl Service<ServiceRequest> for ScopeService {
true true
}); });
if let Some(ref app_data) = self.app_data {
req.add_data_container(app_data.clone());
}
if let Some((srv, _info)) = res { if let Some((srv, _info)) = res {
srv.call(req) srv.call(req)
} else { } else {
@ -579,12 +579,15 @@ mod tests {
use actix_utils::future::ok; use actix_utils::future::ok;
use bytes::Bytes; use bytes::Bytes;
use crate::dev::Body; use crate::{
use crate::http::{header, HeaderValue, Method, StatusCode}; dev::Body,
use crate::middleware::DefaultHeaders; guard,
use crate::service::ServiceRequest; http::{header, HeaderValue, Method, StatusCode},
use crate::test::{call_service, init_service, read_body, TestRequest}; middleware::DefaultHeaders,
use crate::{guard, web, App, HttpRequest, HttpResponse}; service::{ServiceRequest, ServiceResponse},
test::{call_service, init_service, read_body, TestRequest},
web, App, HttpMessage, HttpRequest, HttpResponse,
};
#[actix_rt::test] #[actix_rt::test]
async fn test_scope() { async fn test_scope() {
@ -916,10 +919,7 @@ mod tests {
async fn test_default_resource_propagation() { async fn test_default_resource_propagation() {
let srv = init_service( let srv = init_service(
App::new() App::new()
.service( .service(web::scope("/app1").default_service(web::to(HttpResponse::BadRequest)))
web::scope("/app1")
.default_service(web::resource("").to(HttpResponse::BadRequest)),
)
.service(web::scope("/app2")) .service(web::scope("/app2"))
.default_service(|r: ServiceRequest| { .default_service(|r: ServiceRequest| {
ok(r.into_response(HttpResponse::MethodNotAllowed())) ok(r.into_response(HttpResponse::MethodNotAllowed()))
@ -991,7 +991,42 @@ mod tests {
); );
} }
// allow deprecated App::data #[actix_rt::test]
async fn test_middleware_app_data() {
let srv = init_service(
App::new().service(
web::scope("app")
.app_data(1usize)
.wrap_fn(|req, srv| {
assert_eq!(req.app_data::<usize>(), Some(&1usize));
req.extensions_mut().insert(1usize);
srv.call(req)
})
.route("/test", web::get().to(HttpResponse::Ok))
.default_service(|req: ServiceRequest| async move {
let (req, _) = req.into_parts();
assert_eq!(req.extensions().get::<usize>(), Some(&1));
Ok(ServiceResponse::new(
req,
HttpResponse::BadRequest().finish(),
))
}),
),
)
.await;
let req = TestRequest::with_uri("/app/test").to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::OK);
let req = TestRequest::with_uri("/app/default").to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
}
// allow deprecated {App, Scope}::data
#[allow(deprecated)] #[allow(deprecated)]
#[actix_rt::test] #[actix_rt::test]
async fn test_override_data() { async fn test_override_data() {
@ -1011,7 +1046,7 @@ mod tests {
assert_eq!(resp.status(), StatusCode::OK); assert_eq!(resp.status(), StatusCode::OK);
} }
// allow deprecated App::data // allow deprecated `{App, Scope}::data`
#[allow(deprecated)] #[allow(deprecated)]
#[actix_rt::test] #[actix_rt::test]
async fn test_override_data_default_service() { async fn test_override_data_default_service() {

3
src/service.rs
View File

@ -17,9 +17,8 @@ use crate::{
dev::insert_slash, dev::insert_slash,
guard::Guard, guard::Guard,
info::ConnectionInfo, info::ConnectionInfo,
request::HttpRequest,
rmap::ResourceMap, rmap::ResourceMap,
Error, HttpResponse, Error, HttpRequest, HttpResponse,
}; };
pub trait HttpServiceFactory { pub trait HttpServiceFactory {

4
src/types/form.rs
View File

@ -80,6 +80,10 @@ use crate::{
/// }) /// })
/// } /// }
/// ``` /// ```
///
/// # Panics
/// URL encoded forms consist of unordered `key=value` pairs, therefore they cannot be decoded into
/// any type which depends upon data ordering (eg. tuples). Trying to do so will result in a panic.
#[derive(PartialEq, Eq, PartialOrd, Ord, Debug)] #[derive(PartialEq, Eq, PartialOrd, Ord, Debug)]
pub struct Form<T>(pub T); pub struct Form<T>(pub T);

1
src/web.rs
View File

@ -43,7 +43,6 @@ pub use crate::types::*;
/// the exposed `Params` object: /// the exposed `Params` object:
/// ///
/// ``` /// ```
/// # extern crate actix_web;
/// use actix_web::{web, App, HttpResponse}; /// use actix_web::{web, App, HttpResponse};
/// ///
/// let app = App::new().service( /// let app = App::new().service(

29
tests/test_error_propagation.rs
View File

@ -1,12 +1,14 @@
use actix_utils::future::{ok, Ready};
use actix_web::dev::{Service, ServiceRequest, ServiceResponse, Transform};
use actix_web::test::{call_service, init_service, TestRequest};
use actix_web::{HttpResponse, ResponseError};
use futures_util::lock::Mutex;
use std::future::Future;
use std::pin::Pin;
use std::sync::Arc; use std::sync::Arc;
use std::task::{Context, Poll};
use actix_utils::future::{ok, Ready};
use actix_web::{
dev::{forward_ready, Service, ServiceRequest, ServiceResponse, Transform},
get,
test::{call_service, init_service, TestRequest},
ResponseError,
};
use futures_core::future::LocalBoxFuture;
use futures_util::lock::Mutex;
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct MyError; pub struct MyError;
@ -19,10 +21,9 @@ impl std::fmt::Display for MyError {
} }
} }
#[actix_web::get("/test")] #[get("/test")]
async fn test() -> Result<actix_web::HttpResponse, actix_web::error::Error> { async fn test() -> Result<actix_web::HttpResponse, actix_web::error::Error> {
Err(MyError)?; return Err(MyError.into());
Ok(HttpResponse::NoContent().finish())
} }
#[derive(Clone)] #[derive(Clone)]
@ -62,11 +63,9 @@ where
{ {
type Response = ServiceResponse<B>; type Response = ServiceResponse<B>;
type Error = actix_web::Error; type Error = actix_web::Error;
type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>>>>; type Future = LocalBoxFuture<'static, Result<Self::Response, Self::Error>>;
fn poll_ready(&self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> { forward_ready!(service);
self.service.poll_ready(cx)
}
fn call(&self, req: ServiceRequest) -> Self::Future { fn call(&self, req: ServiceRequest) -> Self::Future {
let lock = self.was_error.clone(); let lock = self.was_error.clone();

2
tests/test_server.rs
View File

@ -879,7 +879,7 @@ async fn test_brotli_encoding_large_openssl() {
assert_eq!(bytes, Bytes::from(data)); assert_eq!(bytes, Bytes::from(data));
} }
#[cfg(all(feature = "rustls", feature = "openssl"))] #[cfg(feature = "rustls")]
mod plus_rustls { mod plus_rustls {
use std::io::BufReader; use std::io::BufReader;