@@ -152,26 +157,28 @@ where
});
}
Poll::Ready(None) => return Poll::Ready(Ok(())),
+
Poll::Pending => match this.ping_pong.as_mut() {
Some(ping_pong) => loop {
- if ping_pong.on_flight {
- // When have on flight ping pong. poll pong and and keep alive timer.
- // on success pong received update keep alive timer to determine the next timing of
- // ping pong.
+ if ping_pong.in_flight {
+ // When there is an in-flight ping-pong, poll pong and and keep-alive
+ // timer. On successful pong received, update keep-alive timer to
+ // determine the next timing of ping pong.
match ping_pong.ping_pong.poll_pong(cx)? {
Poll::Ready(_) => {
- ping_pong.on_flight = false;
+ ping_pong.in_flight = false;
let dead_line = this.config.keep_alive_deadline().unwrap();
ping_pong.timer.as_mut().reset(dead_line.into());
}
Poll::Pending => {
- return ping_pong.timer.as_mut().poll(cx).map(|_| Ok(()))
+ return ping_pong.timer.as_mut().poll(cx).map(|_| Ok(()));
}
}
} else {
- // When there is no on flight ping pong. keep alive timer is used to wait for next
- // timing of ping pong. Therefore at this point it serves as an interval instead.
+ // When there is no in-flight ping-pong, keep-alive timer is used to
+ // wait for next timing of ping-pong. Therefore, at this point it serves
+ // as an interval instead.
ready!(ping_pong.timer.as_mut().poll(cx));
ping_pong.ping_pong.send_ping(Ping::opaque())?;
@@ -179,7 +186,7 @@ where
let dead_line = this.config.keep_alive_deadline().unwrap();
ping_pong.timer.as_mut().reset(dead_line.into());
- ping_pong.on_flight = true;
+ ping_pong.in_flight = true;
}
},
None => return Poll::Pending,
@@ -287,13 +294,13 @@ fn prepare_response(
_ => {}
}
- let _ = match size {
- BodySize::None | BodySize::Stream => None,
+ match size {
+ BodySize::None | BodySize::Stream => {}
BodySize::Sized(0) => {
#[allow(clippy::declare_interior_mutable_const)]
const HV_ZERO: HeaderValue = HeaderValue::from_static("0");
- res.headers_mut().insert(CONTENT_LENGTH, HV_ZERO)
+ res.headers_mut().insert(CONTENT_LENGTH, HV_ZERO);
}
BodySize::Sized(len) => {
@@ -302,7 +309,7 @@ fn prepare_response(
res.headers_mut().insert(
CONTENT_LENGTH,
HeaderValue::from_str(buf.format(*len)).unwrap(),
- )
+ );
}
};
diff --git a/actix-http/src/h2/mod.rs b/actix-http/src/h2/mod.rs
index c8aaaaa5f..39198e0fe 100644
--- a/actix-http/src/h2/mod.rs
+++ b/actix-http/src/h2/mod.rs
@@ -103,11 +103,9 @@ where
#[cfg(test)]
mod tests {
- use std::panic::{RefUnwindSafe, UnwindSafe};
-
use static_assertions::assert_impl_all;
use super::*;
- assert_impl_all!(Payload: Unpin, Send, Sync, UnwindSafe, RefUnwindSafe);
+ assert_impl_all!(Payload: Unpin, Send, Sync);
}
diff --git a/actix-http/src/h2/service.rs b/actix-http/src/h2/service.rs
index e526918c7..2a45fc1dc 100644
--- a/actix-http/src/h2/service.rs
+++ b/actix-http/src/h2/service.rs
@@ -117,6 +117,7 @@ mod openssl {
B: MessageBody + 'static,
{
/// Create OpenSSL based service.
+ #[cfg_attr(docsrs, doc(cfg(feature = "openssl")))]
pub fn openssl(
self,
acceptor: SslAcceptor,
@@ -164,6 +165,7 @@ mod rustls {
B: MessageBody + 'static,
{
/// Create Rustls based service.
+ #[cfg_attr(docsrs, doc(cfg(feature = "rustls")))]
pub fn rustls(
self,
mut config: ServerConfig,
diff --git a/actix-http/src/header/map.rs b/actix-http/src/header/map.rs
index 8f6d1cead..28906e835 100644
--- a/actix-http/src/header/map.rs
+++ b/actix-http/src/header/map.rs
@@ -309,7 +309,7 @@ impl HeaderMap {
pub fn get_all(&self, key: impl AsHeaderName) -> std::slice::Iter<'_, HeaderValue> {
match self.get_value(key) {
Some(value) => value.iter(),
- None => (&[]).iter(),
+ None => [].iter(),
}
}
diff --git a/actix-http/src/header/shared/extended.rs b/actix-http/src/header/shared/extended.rs
index 1af9ca20e..cd8adb2bd 100644
--- a/actix-http/src/header/shared/extended.rs
+++ b/actix-http/src/header/shared/extended.rs
@@ -12,7 +12,7 @@ use crate::header::{Charset, HTTP_VALUE};
/// - A character sequence representing the actual value (`value`), separated by single quotes.
///
/// It is defined in [RFC 5987 §3.2](https://datatracker.ietf.org/doc/html/rfc5987#section-3.2).
-#[derive(Clone, Debug, PartialEq)]
+#[derive(Clone, Debug, PartialEq, Eq)]
pub struct ExtendedValue {
/// The character set that is used to encode the `value` to a string.
pub charset: Charset,
diff --git a/actix-http/src/header/shared/quality_item.rs b/actix-http/src/header/shared/quality_item.rs
index 71a3bdd53..0b35b5401 100644
--- a/actix-http/src/header/shared/quality_item.rs
+++ b/actix-http/src/header/shared/quality_item.rs
@@ -147,7 +147,7 @@ mod tests {
// copy of encoding from actix-web headers
#[allow(clippy::enum_variant_names)] // allow Encoding prefix on EncodingExt
- #[derive(Clone, PartialEq, Debug)]
+ #[derive(Debug, Clone, PartialEq, Eq)]
pub enum Encoding {
Chunked,
Brotli,
diff --git a/actix-http/src/lib.rs b/actix-http/src/lib.rs
index 360cb86fc..864db4986 100644
--- a/actix-http/src/lib.rs
+++ b/actix-http/src/lib.rs
@@ -25,6 +25,7 @@
)]
#![doc(html_logo_url = "https://actix.rs/img/logo.png")]
#![doc(html_favicon_url = "https://actix.rs/favicon.ico")]
+#![cfg_attr(docsrs, feature(doc_cfg))]
pub use ::http::{uri, uri::Uri};
pub use ::http::{Method, StatusCode, Version};
@@ -39,6 +40,7 @@ pub mod error;
mod extensions;
pub mod h1;
#[cfg(feature = "http2")]
+#[cfg_attr(docsrs, doc(cfg(feature = "http2")))]
pub mod h2;
pub mod header;
mod helpers;
@@ -53,6 +55,7 @@ mod responses;
mod service;
pub mod test;
#[cfg(feature = "ws")]
+#[cfg_attr(docsrs, doc(cfg(feature = "ws")))]
pub mod ws;
pub use self::builder::HttpServiceBuilder;
@@ -69,6 +72,9 @@ pub use self::payload::{BoxedPayloadStream, Payload, PayloadStream};
pub use self::requests::{Request, RequestHead, RequestHeadType};
pub use self::responses::{Response, ResponseBuilder, ResponseHead};
pub use self::service::HttpService;
+#[cfg(any(feature = "openssl", feature = "rustls"))]
+#[cfg_attr(docsrs, doc(cfg(any(feature = "openssl", feature = "rustls"))))]
+pub use self::service::TlsAcceptorConfig;
/// A major HTTP protocol version.
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
diff --git a/actix-http/src/message.rs b/actix-http/src/message.rs
index 5616a4762..7469d74ee 100644
--- a/actix-http/src/message.rs
+++ b/actix-http/src/message.rs
@@ -3,7 +3,7 @@ use std::{cell::RefCell, ops, rc::Rc};
use bitflags::bitflags;
/// Represents various types of connection
-#[derive(Copy, Clone, PartialEq, Debug)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ConnectionType {
/// Close connection after response.
Close,
diff --git a/actix-http/src/payload.rs b/actix-http/src/payload.rs
index ee0128af4..7d476c55f 100644
--- a/actix-http/src/payload.rs
+++ b/actix-http/src/payload.rs
@@ -97,12 +97,10 @@ where
#[cfg(test)]
mod tests {
- use std::panic::{RefUnwindSafe, UnwindSafe};
-
use static_assertions::{assert_impl_all, assert_not_impl_any};
use super::*;
assert_impl_all!(Payload: Unpin);
- assert_not_impl_any!(Payload: Send, Sync, UnwindSafe, RefUnwindSafe);
+ assert_not_impl_any!(Payload: Send, Sync);
}
diff --git a/actix-http/src/requests/request.rs b/actix-http/src/requests/request.rs
index 0f8e78d46..ac358e8df 100644
--- a/actix-http/src/requests/request.rs
+++ b/actix-http/src/requests/request.rs
@@ -113,14 +113,14 @@ impl Request
{
#[inline]
/// Http message part of the request
pub fn head(&self) -> &RequestHead {
- &*self.head
+ &self.head
}
#[inline]
#[doc(hidden)]
/// Mutable reference to a HTTP message part of the request
pub fn head_mut(&mut self) -> &mut RequestHead {
- &mut *self.head
+ &mut self.head
}
/// Mutable reference to the message's headers.
diff --git a/actix-http/src/responses/head.rs b/actix-http/src/responses/head.rs
index cb47c4b7a..01bca6c5b 100644
--- a/actix-http/src/responses/head.rs
+++ b/actix-http/src/responses/head.rs
@@ -237,7 +237,7 @@ mod tests {
.await;
let mut stream = net::TcpStream::connect(srv.addr()).unwrap();
- let _ = stream
+ stream
.write_all(b"GET /camel HTTP/1.1\r\nConnection: Close\r\n\r\n")
.unwrap();
let mut data = vec![];
@@ -251,7 +251,7 @@ mod tests {
assert!(memmem::find(&data, b"content-length").is_none());
let mut stream = net::TcpStream::connect(srv.addr()).unwrap();
- let _ = stream
+ stream
.write_all(b"GET /lower HTTP/1.1\r\nConnection: Close\r\n\r\n")
.unwrap();
let mut data = vec![];
diff --git a/actix-http/src/responses/response.rs b/actix-http/src/responses/response.rs
index ceb158f65..03908d9ce 100644
--- a/actix-http/src/responses/response.rs
+++ b/actix-http/src/responses/response.rs
@@ -83,13 +83,13 @@ impl Response {
/// Returns a reference to the head of this response.
#[inline]
pub fn head(&self) -> &ResponseHead {
- &*self.head
+ &self.head
}
/// Returns a mutable reference to the head of this response.
#[inline]
pub fn head_mut(&mut self) -> &mut ResponseHead {
- &mut *self.head
+ &mut self.head
}
/// Returns the status code of this response.
diff --git a/actix-http/src/service.rs b/actix-http/src/service.rs
index f4fe625a3..bcca5b188 100644
--- a/actix-http/src/service.rs
+++ b/actix-http/src/service.rs
@@ -181,6 +181,25 @@ where
}
}
+/// Configuration options used when accepting TLS connection.
+#[cfg(any(feature = "openssl", feature = "rustls"))]
+#[cfg_attr(docsrs, doc(cfg(any(feature = "openssl", feature = "rustls"))))]
+#[derive(Debug, Default)]
+pub struct TlsAcceptorConfig {
+ pub(crate) handshake_timeout: Option,
+}
+
+#[cfg(any(feature = "openssl", feature = "rustls"))]
+impl TlsAcceptorConfig {
+ /// Set TLS handshake timeout duration.
+ pub fn handshake_timeout(self, dur: std::time::Duration) -> Self {
+ Self {
+ handshake_timeout: Some(dur),
+ // ..self
+ }
+ }
+}
+
#[cfg(feature = "openssl")]
mod openssl {
use actix_service::ServiceFactoryExt as _;
@@ -220,6 +239,7 @@ mod openssl {
U::InitError: fmt::Debug,
{
/// Create OpenSSL based service.
+ #[cfg_attr(docsrs, doc(cfg(feature = "openssl")))]
pub fn openssl(
self,
acceptor: SslAcceptor,
@@ -230,7 +250,29 @@ mod openssl {
Error = TlsError,
InitError = (),
> {
- Acceptor::new(acceptor)
+ self.openssl_with_config(acceptor, TlsAcceptorConfig::default())
+ }
+
+ /// Create OpenSSL based service with custom TLS acceptor configuration.
+ #[cfg_attr(docsrs, doc(cfg(feature = "openssl")))]
+ pub fn openssl_with_config(
+ self,
+ acceptor: SslAcceptor,
+ tls_acceptor_config: TlsAcceptorConfig,
+ ) -> impl ServiceFactory<
+ TcpStream,
+ Config = (),
+ Response = (),
+ Error = TlsError,
+ InitError = (),
+ > {
+ let mut acceptor = Acceptor::new(acceptor);
+
+ if let Some(handshake_timeout) = tls_acceptor_config.handshake_timeout {
+ acceptor.set_handshake_timeout(handshake_timeout);
+ }
+
+ acceptor
.map_init_err(|_| {
unreachable!("TLS acceptor service factory does not error on init")
})
@@ -292,9 +334,26 @@ mod rustls {
U::InitError: fmt::Debug,
{
/// Create Rustls based service.
+ #[cfg_attr(docsrs, doc(cfg(feature = "rustls")))]
pub fn rustls(
+ self,
+ config: ServerConfig,
+ ) -> impl ServiceFactory<
+ TcpStream,
+ Config = (),
+ Response = (),
+ Error = TlsError,
+ InitError = (),
+ > {
+ self.rustls_with_config(config, TlsAcceptorConfig::default())
+ }
+
+ /// Create Rustls based service with custom TLS acceptor configuration.
+ #[cfg_attr(docsrs, doc(cfg(feature = "rustls")))]
+ pub fn rustls_with_config(
self,
mut config: ServerConfig,
+ tls_acceptor_config: TlsAcceptorConfig,
) -> impl ServiceFactory<
TcpStream,
Config = (),
@@ -306,7 +365,13 @@ mod rustls {
protos.extend_from_slice(&config.alpn_protocols);
config.alpn_protocols = protos;
- Acceptor::new(config)
+ let mut acceptor = Acceptor::new(config);
+
+ if let Some(handshake_timeout) = tls_acceptor_config.handshake_timeout {
+ acceptor.set_handshake_timeout(handshake_timeout);
+ }
+
+ acceptor
.map_init_err(|_| {
unreachable!("TLS acceptor service factory does not error on init")
})
diff --git a/actix-http/src/test.rs b/actix-http/src/test.rs
index 6212c19d1..3815e64c6 100644
--- a/actix-http/src/test.rs
+++ b/actix-http/src/test.rs
@@ -19,29 +19,7 @@ use crate::{
Request,
};
-/// Test `Request` builder
-///
-/// ```ignore
-/// # use http::{header, StatusCode};
-/// # use actix_web::*;
-/// use actix_web::test::TestRequest;
-///
-/// fn index(req: &HttpRequest) -> Response {
-/// if let Some(hdr) = req.headers().get(header::CONTENT_TYPE) {
-/// Response::Ok().into()
-/// } else {
-/// Response::BadRequest().into()
-/// }
-/// }
-///
-/// let resp = TestRequest::default().insert_header("content-type", "text/plain")
-/// .run(&index)
-/// .unwrap();
-/// assert_eq!(resp.status(), StatusCode::OK);
-///
-/// let resp = TestRequest::default().run(&index).unwrap();
-/// assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
-/// ```
+/// Test `Request` builder.
pub struct TestRequest(Option);
struct Inner {
diff --git a/actix-http/src/ws/codec.rs b/actix-http/src/ws/codec.rs
index 3aa325d6a..4a2e741b6 100644
--- a/actix-http/src/ws/codec.rs
+++ b/actix-http/src/ws/codec.rs
@@ -11,7 +11,7 @@ use super::{
};
/// A WebSocket message.
-#[derive(Debug, PartialEq)]
+#[derive(Debug, PartialEq, Eq)]
pub enum Message {
/// Text message.
Text(ByteString),
@@ -36,7 +36,7 @@ pub enum Message {
}
/// A WebSocket frame.
-#[derive(Debug, PartialEq)]
+#[derive(Debug, PartialEq, Eq)]
pub enum Frame {
/// Text frame. Note that the codec does not validate UTF-8 encoding.
Text(Bytes),
@@ -58,7 +58,7 @@ pub enum Frame {
}
/// A WebSocket continuation item.
-#[derive(Debug, PartialEq)]
+#[derive(Debug, PartialEq, Eq)]
pub enum Item {
FirstText(Bytes),
FirstBinary(Bytes),
diff --git a/actix-http/src/ws/frame.rs b/actix-http/src/ws/frame.rs
index 17e34e2ba..c7e0427ea 100644
--- a/actix-http/src/ws/frame.rs
+++ b/actix-http/src/ws/frame.rs
@@ -17,7 +17,6 @@ impl Parser {
fn parse_metadata(
src: &[u8],
server: bool,
- max_size: usize,
) -> Result)>, ProtocolError> {
let chunk_len = src.len();
@@ -60,20 +59,12 @@ impl Parser {
return Ok(None);
}
let len = u64::from_be_bytes(TryFrom::try_from(&src[idx..idx + 8]).unwrap());
- if len > max_size as u64 {
- return Err(ProtocolError::Overflow);
- }
idx += 8;
len as usize
} else {
len as usize
};
- // check for max allowed size
- if length > max_size {
- return Err(ProtocolError::Overflow);
- }
-
let mask = if server {
if chunk_len < idx + 4 {
return Ok(None);
@@ -98,11 +89,10 @@ impl Parser {
max_size: usize,
) -> Result)>, ProtocolError> {
// try to parse ws frame metadata
- let (idx, finished, opcode, length, mask) =
- match Parser::parse_metadata(src, server, max_size)? {
- None => return Ok(None),
- Some(res) => res,
- };
+ let (idx, finished, opcode, length, mask) = match Parser::parse_metadata(src, server)? {
+ None => return Ok(None),
+ Some(res) => res,
+ };
// not enough data
if src.len() < idx + length {
@@ -112,6 +102,13 @@ impl Parser {
// remove prefix
src.advance(idx);
+ // check for max allowed size
+ if length > max_size {
+ // drop the payload
+ src.advance(length);
+ return Err(ProtocolError::Overflow);
+ }
+
// no need for body
if length == 0 {
return Ok(Some((finished, opcode, None)));
@@ -316,7 +313,7 @@ mod tests {
#[test]
fn test_parse_frame_no_mask() {
let mut buf = BytesMut::from(&[0b0000_0001u8, 0b0000_0001u8][..]);
- buf.extend(&[1u8]);
+ buf.extend([1u8]);
assert!(Parser::parse(&mut buf, true, 1024).is_err());
@@ -329,7 +326,7 @@ mod tests {
#[test]
fn test_parse_frame_max_size() {
let mut buf = BytesMut::from(&[0b0000_0001u8, 0b0000_0010u8][..]);
- buf.extend(&[1u8, 1u8]);
+ buf.extend([1u8, 1u8]);
assert!(Parser::parse(&mut buf, true, 1).is_err());
@@ -339,6 +336,30 @@ mod tests {
}
}
+ #[test]
+ fn test_parse_frame_max_size_recoverability() {
+ let mut buf = BytesMut::new();
+ // The first text frame with length == 2, payload doesn't matter.
+ buf.extend([0b0000_0001u8, 0b0000_0010u8, 0b0000_0000u8, 0b0000_0000u8]);
+ // Next binary frame with length == 2 and payload == `[0x1111_1111u8, 0x1111_1111u8]`.
+ buf.extend([0b0000_0010u8, 0b0000_0010u8, 0b1111_1111u8, 0b1111_1111u8]);
+
+ assert_eq!(buf.len(), 8);
+ assert!(matches!(
+ Parser::parse(&mut buf, false, 1),
+ Err(ProtocolError::Overflow)
+ ));
+ assert_eq!(buf.len(), 4);
+ let frame = extract(Parser::parse(&mut buf, false, 2));
+ assert!(!frame.finished);
+ assert_eq!(frame.opcode, OpCode::Binary);
+ assert_eq!(
+ frame.payload,
+ Bytes::from(vec![0b1111_1111u8, 0b1111_1111u8])
+ );
+ assert_eq!(buf.len(), 0);
+ }
+
#[test]
fn test_ping_frame() {
let mut buf = BytesMut::new();
diff --git a/actix-http/src/ws/mod.rs b/actix-http/src/ws/mod.rs
index 568d801a2..75d4ca628 100644
--- a/actix-http/src/ws/mod.rs
+++ b/actix-http/src/ws/mod.rs
@@ -67,7 +67,7 @@ pub enum ProtocolError {
}
/// WebSocket handshake errors
-#[derive(Debug, Clone, Copy, PartialEq, Display, Error)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Display, Error)]
pub enum HandshakeError {
/// Only get method is allowed.
#[display(fmt = "Method not allowed.")]
diff --git a/actix-http/src/ws/proto.rs b/actix-http/src/ws/proto.rs
index 01fe9dd3c..7222168b7 100644
--- a/actix-http/src/ws/proto.rs
+++ b/actix-http/src/ws/proto.rs
@@ -244,7 +244,7 @@ pub fn hash_key(key: &[u8]) -> [u8; 28] {
};
let mut hash_b64 = [0; 28];
- let n = base64::encode_config_slice(&hash, base64::STANDARD, &mut hash_b64);
+ let n = base64::encode_config_slice(hash, base64::STANDARD, &mut hash_b64);
assert_eq!(n, 28);
hash_b64
diff --git a/actix-http/tests/test_openssl.rs b/actix-http/tests/test_openssl.rs
index 35321ac98..b97b2e45b 100644
--- a/actix-http/tests/test_openssl.rs
+++ b/actix-http/tests/test_openssl.rs
@@ -2,13 +2,13 @@
extern crate tls_openssl as openssl;
-use std::{convert::Infallible, io};
+use std::{convert::Infallible, io, time::Duration};
use actix_http::{
body::{BodyStream, BoxBody, SizedStream},
error::PayloadError,
header::{self, HeaderValue},
- Error, HttpService, Method, Request, Response, StatusCode, Version,
+ Error, HttpService, Method, Request, Response, StatusCode, TlsAcceptorConfig, Version,
};
use actix_http_test::test_server;
use actix_service::{fn_service, ServiceFactoryExt};
@@ -89,7 +89,10 @@ async fn h2_1() -> io::Result<()> {
assert_eq!(req.version(), Version::HTTP_2);
ok::<_, Error>(Response::ok())
})
- .openssl(tls_config())
+ .openssl_with_config(
+ tls_config(),
+ TlsAcceptorConfig::default().handshake_timeout(Duration::from_secs(5)),
+ )
.map_err(|_| ())
})
.await;
diff --git a/actix-http/tests/test_rustls.rs b/actix-http/tests/test_rustls.rs
index 550375296..d9ff42b7d 100644
--- a/actix-http/tests/test_rustls.rs
+++ b/actix-http/tests/test_rustls.rs
@@ -8,13 +8,14 @@ use std::{
net::{SocketAddr, TcpStream as StdTcpStream},
sync::Arc,
task::Poll,
+ time::Duration,
};
use actix_http::{
body::{BodyStream, BoxBody, SizedStream},
error::PayloadError,
header::{self, HeaderName, HeaderValue},
- Error, HttpService, Method, Request, Response, StatusCode, Version,
+ Error, HttpService, Method, Request, Response, StatusCode, TlsAcceptorConfig, Version,
};
use actix_http_test::test_server;
use actix_rt::pin;
@@ -40,7 +41,7 @@ where
let body = stream.as_mut();
match ready!(body.poll_next(cx)) {
- Some(Ok(bytes)) => buf.extend_from_slice(&*bytes),
+ Some(Ok(bytes)) => buf.extend_from_slice(&bytes),
None => return Poll::Ready(Ok(())),
Some(Err(err)) => return Poll::Ready(Err(err)),
}
@@ -160,7 +161,10 @@ async fn h2_1() -> io::Result<()> {
assert_eq!(req.version(), Version::HTTP_2);
ok::<_, Error>(Response::ok())
})
- .rustls(tls_config())
+ .rustls_with_config(
+ tls_config(),
+ TlsAcceptorConfig::default().handshake_timeout(Duration::from_secs(5)),
+ )
})
.await;
diff --git a/actix-multipart/CHANGES.md b/actix-multipart/CHANGES.md
index 11ec8a64f..655487e54 100644
--- a/actix-multipart/CHANGES.md
+++ b/actix-multipart/CHANGES.md
@@ -1,6 +1,10 @@
# Changes
-## Unreleased - 2021-xx-xx
+## Unreleased - 2022-xx-xx
+- Minimum supported Rust version (MSRV) is now 1.59 due to transitive `time` dependency.
+- `Field::content_type()` now returns `Option<&mime::Mime>` [#2880]
+
+[#2880]: https://github.com/actix/actix-web/pull/2880
## 0.4.0 - 2022-02-25
diff --git a/actix-multipart/Cargo.toml b/actix-multipart/Cargo.toml
index e93e22941..32ea49a24 100644
--- a/actix-multipart/Cargo.toml
+++ b/actix-multipart/Cargo.toml
@@ -15,7 +15,7 @@ path = "src/lib.rs"
[dependencies]
actix-utils = "3"
-actix-web = { version = "4.0.0", default-features = false }
+actix-web = { version = "4", default-features = false }
bytes = "1"
derive_more = "0.99.5"
@@ -28,7 +28,7 @@ twoway = "0.2"
[dev-dependencies]
actix-rt = "2.2"
-actix-http = "3.0.0"
+actix-http = "3"
futures-util = { version = "0.3.7", default-features = false, features = ["alloc"] }
tokio = { version = "1.8.4", features = ["sync"] }
tokio-stream = "0.1"
diff --git a/actix-multipart/README.md b/actix-multipart/README.md
index 59b9651f1..21999716c 100644
--- a/actix-multipart/README.md
+++ b/actix-multipart/README.md
@@ -4,7 +4,7 @@
[](https://crates.io/crates/actix-multipart)
[](https://docs.rs/actix-multipart/0.4.0)
-[](https://blog.rust-lang.org/2021/05/06/Rust-1.54.0.html)
+
[](https://deps.rs/crate/actix-multipart/0.4.0)
diff --git a/actix-multipart/src/server.rs b/actix-multipart/src/server.rs
index 239f7f905..c3757177f 100644
--- a/actix-multipart/src/server.rs
+++ b/actix-multipart/src/server.rs
@@ -289,10 +289,8 @@ impl InnerMultipart {
match self.state {
// read until first boundary
InnerState::FirstBoundary => {
- match InnerMultipart::skip_until_boundary(
- &mut *payload,
- &self.boundary,
- )? {
+ match InnerMultipart::skip_until_boundary(&mut payload, &self.boundary)?
+ {
Some(eof) => {
if eof {
self.state = InnerState::Eof;
@@ -306,7 +304,7 @@ impl InnerMultipart {
}
// read boundary
InnerState::Boundary => {
- match InnerMultipart::read_boundary(&mut *payload, &self.boundary)? {
+ match InnerMultipart::read_boundary(&mut payload, &self.boundary)? {
None => return Poll::Pending,
Some(eof) => {
if eof {
@@ -323,7 +321,7 @@ impl InnerMultipart {
// read field headers for next field
if self.state == InnerState::Headers {
- if let Some(headers) = InnerMultipart::read_headers(&mut *payload)? {
+ if let Some(headers) = InnerMultipart::read_headers(&mut payload)? {
self.state = InnerState::Boundary;
headers
} else {
@@ -361,17 +359,18 @@ impl InnerMultipart {
return Poll::Ready(Some(Err(MultipartError::NoContentDisposition)));
};
- let ct: mime::Mime = headers
+ let ct: Option = headers
.get(&header::CONTENT_TYPE)
.and_then(|ct| ct.to_str().ok())
- .and_then(|ct| ct.parse().ok())
- .unwrap_or(mime::APPLICATION_OCTET_STREAM);
+ .and_then(|ct| ct.parse().ok());
self.state = InnerState::Boundary;
// nested multipart stream is not supported
- if ct.type_() == mime::MULTIPART {
- return Poll::Ready(Some(Err(MultipartError::Nested)));
+ if let Some(mime) = &ct {
+ if mime.type_() == mime::MULTIPART {
+ return Poll::Ready(Some(Err(MultipartError::Nested)));
+ }
}
let field =
@@ -399,7 +398,7 @@ impl Drop for InnerMultipart {
/// A single field in a multipart stream
pub struct Field {
- ct: mime::Mime,
+ ct: Option,
cd: ContentDisposition,
headers: HeaderMap,
inner: Rc>,
@@ -410,7 +409,7 @@ impl Field {
fn new(
safety: Safety,
headers: HeaderMap,
- ct: mime::Mime,
+ ct: Option,
cd: ContentDisposition,
inner: Rc>,
) -> Self {
@@ -428,9 +427,13 @@ impl Field {
&self.headers
}
- /// Returns a reference to the field's content (mime) type.
- pub fn content_type(&self) -> &mime::Mime {
- &self.ct
+ /// Returns a reference to the field's content (mime) type, if it is supplied by the client.
+ ///
+ /// According to [RFC 7578](https://www.rfc-editor.org/rfc/rfc7578#section-4.4), if it is not
+ /// present, it should default to "text/plain". Note it is the responsibility of the client to
+ /// provide the appropriate content type, there is no attempt to validate this by the server.
+ pub fn content_type(&self) -> Option<&mime::Mime> {
+ self.ct.as_ref()
}
/// Returns the field's Content-Disposition.
@@ -482,7 +485,11 @@ impl Stream for Field {
impl fmt::Debug for Field {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
- writeln!(f, "\nField: {}", self.ct)?;
+ if let Some(ct) = &self.ct {
+ writeln!(f, "\nField: {}", ct)?;
+ } else {
+ writeln!(f, "\nField:")?;
+ }
writeln!(f, " boundary: {}", self.inner.borrow().boundary)?;
writeln!(f, " headers:")?;
for (key, val) in self.headers.iter() {
@@ -643,9 +650,9 @@ impl InnerField {
let result = if let Some(mut payload) = self.payload.as_ref().unwrap().get_mut(s) {
if !self.eof {
let res = if let Some(ref mut len) = self.length {
- InnerField::read_len(&mut *payload, len)
+ InnerField::read_len(&mut payload, len)
} else {
- InnerField::read_stream(&mut *payload, &self.boundary)
+ InnerField::read_stream(&mut payload, &self.boundary)
};
match res {
@@ -1024,8 +1031,8 @@ mod tests {
assert_eq!(cd.disposition, DispositionType::FormData);
assert_eq!(cd.parameters[0], DispositionParam::Name("file".into()));
- assert_eq!(field.content_type().type_(), mime::TEXT);
- assert_eq!(field.content_type().subtype(), mime::PLAIN);
+ assert_eq!(field.content_type().unwrap().type_(), mime::TEXT);
+ assert_eq!(field.content_type().unwrap().subtype(), mime::PLAIN);
match field.next().await.unwrap() {
Ok(chunk) => assert_eq!(chunk, "test"),
@@ -1041,8 +1048,8 @@ mod tests {
match multipart.next().await.unwrap() {
Ok(mut field) => {
- assert_eq!(field.content_type().type_(), mime::TEXT);
- assert_eq!(field.content_type().subtype(), mime::PLAIN);
+ assert_eq!(field.content_type().unwrap().type_(), mime::TEXT);
+ assert_eq!(field.content_type().unwrap().subtype(), mime::PLAIN);
match field.next().await {
Some(Ok(chunk)) => assert_eq!(chunk, "data"),
@@ -1086,8 +1093,8 @@ mod tests {
assert_eq!(cd.disposition, DispositionType::FormData);
assert_eq!(cd.parameters[0], DispositionParam::Name("file".into()));
- assert_eq!(field.content_type().type_(), mime::TEXT);
- assert_eq!(field.content_type().subtype(), mime::PLAIN);
+ assert_eq!(field.content_type().unwrap().type_(), mime::TEXT);
+ assert_eq!(field.content_type().unwrap().subtype(), mime::PLAIN);
assert_eq!(get_whole_field(&mut field).await, "test");
}
@@ -1096,8 +1103,8 @@ mod tests {
match multipart.next().await {
Some(Ok(mut field)) => {
- assert_eq!(field.content_type().type_(), mime::TEXT);
- assert_eq!(field.content_type().subtype(), mime::PLAIN);
+ assert_eq!(field.content_type().unwrap().type_(), mime::TEXT);
+ assert_eq!(field.content_type().unwrap().subtype(), mime::PLAIN);
assert_eq!(get_whole_field(&mut field).await, "data");
}
diff --git a/actix-router/CHANGES.md b/actix-router/CHANGES.md
index 8e0e4f41e..51e7cbc10 100644
--- a/actix-router/CHANGES.md
+++ b/actix-router/CHANGES.md
@@ -1,6 +1,13 @@
# Changes
-## Unreleased - 2021-xx-xx
+## Unreleased - 2022-xx-xx
+
+
+## 0.5.1 - 2022-09-19
+- Correct typo in error string for `i32` deserialization. [#2876]
+- Minimum supported Rust version (MSRV) is now 1.59 due to transitive `time` dependency.
+
+[#2876]: https://github.com/actix/actix-web/pull/2876
## 0.5.0 - 2022-02-22
diff --git a/actix-router/Cargo.toml b/actix-router/Cargo.toml
index 6fcef125d..19d6abc62 100644
--- a/actix-router/Cargo.toml
+++ b/actix-router/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "actix-router"
-version = "0.5.0"
+version = "0.5.1"
authors = [
"Nikolay Kim ",
"Ali MJ Al-Nasrawy ",
@@ -21,18 +21,21 @@ default = ["http"]
[dependencies]
bytestring = ">=0.1.5, <2"
-firestorm = "0.5"
-http = { version = "0.2.3", optional = true }
+http = { version = "0.2.5", optional = true }
regex = "1.5"
serde = "1"
tracing = { version = "0.1.30", default-features = false, features = ["log"] }
[dev-dependencies]
criterion = { version = "0.3", features = ["html_reports"] }
-firestorm = { version = "0.5", features = ["enable_system_time"] }
http = "0.2.5"
serde = { version = "1", features = ["derive"] }
+percent-encoding = "2.1"
[[bench]]
name = "router"
harness = false
+
+[[bench]]
+name = "quoter"
+harness = false
diff --git a/actix-router/benches/quoter.rs b/actix-router/benches/quoter.rs
new file mode 100644
index 000000000..c18f1620e
--- /dev/null
+++ b/actix-router/benches/quoter.rs
@@ -0,0 +1,52 @@
+use criterion::{black_box, criterion_group, criterion_main, Criterion};
+
+use std::borrow::Cow;
+
+fn compare_quoters(c: &mut Criterion) {
+ let mut group = c.benchmark_group("Compare Quoters");
+
+ let quoter = actix_router::Quoter::new(b"", b"");
+ let path_quoted = (0..=0x7f)
+ .map(|c| format!("%{:02X}", c))
+ .collect::();
+ let path_unquoted = ('\u{00}'..='\u{7f}').collect::();
+
+ group.bench_function("quoter_unquoted", |b| {
+ b.iter(|| {
+ for _ in 0..10 {
+ black_box(quoter.requote(path_unquoted.as_bytes()));
+ }
+ });
+ });
+
+ group.bench_function("percent_encode_unquoted", |b| {
+ b.iter(|| {
+ for _ in 0..10 {
+ let decode = percent_encoding::percent_decode(path_unquoted.as_bytes());
+ black_box(Into::>::into(decode));
+ }
+ });
+ });
+
+ group.bench_function("quoter_quoted", |b| {
+ b.iter(|| {
+ for _ in 0..10 {
+ black_box(quoter.requote(path_quoted.as_bytes()));
+ }
+ });
+ });
+
+ group.bench_function("percent_encode_quoted", |b| {
+ b.iter(|| {
+ for _ in 0..10 {
+ let decode = percent_encoding::percent_decode(path_quoted.as_bytes());
+ black_box(Into::>::into(decode));
+ }
+ });
+ });
+
+ group.finish();
+}
+
+criterion_group!(benches, compare_quoters);
+criterion_main!(benches);
diff --git a/actix-router/examples/flamegraph.rs b/actix-router/examples/flamegraph.rs
deleted file mode 100644
index 798cc22d9..000000000
--- a/actix-router/examples/flamegraph.rs
+++ /dev/null
@@ -1,169 +0,0 @@
-macro_rules! register {
- (brackets) => {{
- register!(finish => "{p1}", "{p2}", "{p3}", "{p4}")
- }};
- (finish => $p1:literal, $p2:literal, $p3:literal, $p4:literal) => {{
- let arr = [
- concat!("/authorizations"),
- concat!("/authorizations/", $p1),
- concat!("/applications/", $p1, "/tokens/", $p2),
- concat!("/events"),
- concat!("/repos/", $p1, "/", $p2, "/events"),
- concat!("/networks/", $p1, "/", $p2, "/events"),
- concat!("/orgs/", $p1, "/events"),
- concat!("/users/", $p1, "/received_events"),
- concat!("/users/", $p1, "/received_events/public"),
- concat!("/users/", $p1, "/events"),
- concat!("/users/", $p1, "/events/public"),
- concat!("/users/", $p1, "/events/orgs/", $p2),
- concat!("/feeds"),
- concat!("/notifications"),
- concat!("/repos/", $p1, "/", $p2, "/notifications"),
- concat!("/notifications/threads/", $p1),
- concat!("/notifications/threads/", $p1, "/subscription"),
- concat!("/repos/", $p1, "/", $p2, "/stargazers"),
- concat!("/users/", $p1, "/starred"),
- concat!("/user/starred"),
- concat!("/user/starred/", $p1, "/", $p2),
- concat!("/repos/", $p1, "/", $p2, "/subscribers"),
- concat!("/users/", $p1, "/subscriptions"),
- concat!("/user/subscriptions"),
- concat!("/repos/", $p1, "/", $p2, "/subscription"),
- concat!("/user/subscriptions/", $p1, "/", $p2),
- concat!("/users/", $p1, "/gists"),
- concat!("/gists"),
- concat!("/gists/", $p1),
- concat!("/gists/", $p1, "/star"),
- concat!("/repos/", $p1, "/", $p2, "/git/blobs/", $p3),
- concat!("/repos/", $p1, "/", $p2, "/git/commits/", $p3),
- concat!("/repos/", $p1, "/", $p2, "/git/refs"),
- concat!("/repos/", $p1, "/", $p2, "/git/tags/", $p3),
- concat!("/repos/", $p1, "/", $p2, "/git/trees/", $p3),
- concat!("/issues"),
- concat!("/user/issues"),
- concat!("/orgs/", $p1, "/issues"),
- concat!("/repos/", $p1, "/", $p2, "/issues"),
- concat!("/repos/", $p1, "/", $p2, "/issues/", $p3),
- concat!("/repos/", $p1, "/", $p2, "/assignees"),
- concat!("/repos/", $p1, "/", $p2, "/assignees/", $p3),
- concat!("/repos/", $p1, "/", $p2, "/issues/", $p3, "/comments"),
- concat!("/repos/", $p1, "/", $p2, "/issues/", $p3, "/events"),
- concat!("/repos/", $p1, "/", $p2, "/labels"),
- concat!("/repos/", $p1, "/", $p2, "/labels/", $p3),
- concat!("/repos/", $p1, "/", $p2, "/issues/", $p3, "/labels"),
- concat!("/repos/", $p1, "/", $p2, "/milestones/", $p3, "/labels"),
- concat!("/repos/", $p1, "/", $p2, "/milestones/"),
- concat!("/repos/", $p1, "/", $p2, "/milestones/", $p3),
- concat!("/emojis"),
- concat!("/gitignore/templates"),
- concat!("/gitignore/templates/", $p1),
- concat!("/meta"),
- concat!("/rate_limit"),
- concat!("/users/", $p1, "/orgs"),
- concat!("/user/orgs"),
- concat!("/orgs/", $p1),
- concat!("/orgs/", $p1, "/members"),
- concat!("/orgs/", $p1, "/members", $p2),
- concat!("/orgs/", $p1, "/public_members"),
- concat!("/orgs/", $p1, "/public_members/", $p2),
- concat!("/orgs/", $p1, "/teams"),
- concat!("/teams/", $p1),
- concat!("/teams/", $p1, "/members"),
- concat!("/teams/", $p1, "/members", $p2),
- concat!("/teams/", $p1, "/repos"),
- concat!("/teams/", $p1, "/repos/", $p2, "/", $p3),
- concat!("/user/teams"),
- concat!("/repos/", $p1, "/", $p2, "/pulls"),
- concat!("/repos/", $p1, "/", $p2, "/pulls/", $p3),
- concat!("/repos/", $p1, "/", $p2, "/pulls/", $p3, "/commits"),
- concat!("/repos/", $p1, "/", $p2, "/pulls/", $p3, "/files"),
- concat!("/repos/", $p1, "/", $p2, "/pulls/", $p3, "/merge"),
- concat!("/repos/", $p1, "/", $p2, "/pulls/", $p3, "/comments"),
- concat!("/user/repos"),
- concat!("/users/", $p1, "/repos"),
- concat!("/orgs/", $p1, "/repos"),
- concat!("/repositories"),
- concat!("/repos/", $p1, "/", $p2),
- concat!("/repos/", $p1, "/", $p2, "/contributors"),
- concat!("/repos/", $p1, "/", $p2, "/languages"),
- concat!("/repos/", $p1, "/", $p2, "/teams"),
- concat!("/repos/", $p1, "/", $p2, "/tags"),
- concat!("/repos/", $p1, "/", $p2, "/branches"),
- concat!("/repos/", $p1, "/", $p2, "/branches/", $p3),
- concat!("/repos/", $p1, "/", $p2, "/collaborators"),
- concat!("/repos/", $p1, "/", $p2, "/collaborators/", $p3),
- concat!("/repos/", $p1, "/", $p2, "/comments"),
- concat!("/repos/", $p1, "/", $p2, "/commits/", $p3, "/comments"),
- concat!("/repos/", $p1, "/", $p2, "/commits"),
- concat!("/repos/", $p1, "/", $p2, "/commits/", $p3),
- concat!("/repos/", $p1, "/", $p2, "/readme"),
- concat!("/repos/", $p1, "/", $p2, "/keys"),
- concat!("/repos/", $p1, "/", $p2, "/keys", $p3),
- concat!("/repos/", $p1, "/", $p2, "/downloads"),
- concat!("/repos/", $p1, "/", $p2, "/downloads", $p3),
- concat!("/repos/", $p1, "/", $p2, "/forks"),
- concat!("/repos/", $p1, "/", $p2, "/hooks"),
- concat!("/repos/", $p1, "/", $p2, "/hooks", $p3),
- concat!("/repos/", $p1, "/", $p2, "/releases"),
- concat!("/repos/", $p1, "/", $p2, "/releases/", $p3),
- concat!("/repos/", $p1, "/", $p2, "/releases/", $p3, "/assets"),
- concat!("/repos/", $p1, "/", $p2, "/stats/contributors"),
- concat!("/repos/", $p1, "/", $p2, "/stats/commit_activity"),
- concat!("/repos/", $p1, "/", $p2, "/stats/code_frequency"),
- concat!("/repos/", $p1, "/", $p2, "/stats/participation"),
- concat!("/repos/", $p1, "/", $p2, "/stats/punch_card"),
- concat!("/repos/", $p1, "/", $p2, "/statuses/", $p3),
- concat!("/search/repositories"),
- concat!("/search/code"),
- concat!("/search/issues"),
- concat!("/search/users"),
- concat!("/legacy/issues/search/", $p1, "/", $p2, "/", $p3, "/", $p4),
- concat!("/legacy/repos/search/", $p1),
- concat!("/legacy/user/search/", $p1),
- concat!("/legacy/user/email/", $p1),
- concat!("/users/", $p1),
- concat!("/user"),
- concat!("/users"),
- concat!("/user/emails"),
- concat!("/users/", $p1, "/followers"),
- concat!("/user/followers"),
- concat!("/users/", $p1, "/following"),
- concat!("/user/following"),
- concat!("/user/following/", $p1),
- concat!("/users/", $p1, "/following", $p2),
- concat!("/users/", $p1, "/keys"),
- concat!("/user/keys"),
- concat!("/user/keys/", $p1),
- ];
-
- arr.to_vec()
- }};
-}
-
-static PATHS: [&str; 5] = [
- "/authorizations",
- "/user/repos",
- "/repos/rust-lang/rust/stargazers",
- "/orgs/rust-lang/public_members/nikomatsakis",
- "/repos/rust-lang/rust/releases/1.51.0",
-];
-
-fn main() {
- let mut router = actix_router::Router::::build();
-
- for route in register!(brackets) {
- router.path(route, true);
- }
-
- let actix = router.finish();
-
- if firestorm::enabled() {
- firestorm::bench("target", || {
- for &route in &PATHS {
- let mut path = actix_router::Path::new(route);
- actix.recognize(&mut path).unwrap();
- }
- })
- .unwrap();
- }
-}
diff --git a/actix-router/src/de.rs b/actix-router/src/de.rs
index efafd08db..458e08930 100644
--- a/actix-router/src/de.rs
+++ b/actix-router/src/de.rs
@@ -7,7 +7,7 @@ use crate::path::{Path, PathIter};
use crate::{Quoter, ResourcePath};
thread_local! {
- static FULL_QUOTER: Quoter = Quoter::new(b"+/%", b"");
+ static FULL_QUOTER: Quoter = Quoter::new(b"", b"");
}
macro_rules! unsupported_type {
@@ -293,7 +293,7 @@ impl<'de> Deserializer<'de> for Value<'de> {
parse_value!(deserialize_bool, visit_bool, "bool");
parse_value!(deserialize_i8, visit_i8, "i8");
parse_value!(deserialize_i16, visit_i16, "i16");
- parse_value!(deserialize_i32, visit_i32, "i16");
+ parse_value!(deserialize_i32, visit_i32, "i32");
parse_value!(deserialize_i64, visit_i64, "i64");
parse_value!(deserialize_u8, visit_u8, "u8");
parse_value!(deserialize_u16, visit_u16, "u16");
diff --git a/actix-router/src/path.rs b/actix-router/src/path.rs
index dfb645d72..34dabcfbe 100644
--- a/actix-router/src/path.rs
+++ b/actix-router/src/path.rs
@@ -1,7 +1,6 @@
use std::borrow::Cow;
use std::ops::{DerefMut, Index};
-use firestorm::profile_method;
use serde::de;
use crate::{de::PathDeserializer, Resource, ResourcePath};
@@ -52,7 +51,6 @@ impl Path {
/// Returns full path as a string.
#[inline]
pub fn as_str(&self) -> &str {
- profile_method!(as_str);
self.path.path()
}
@@ -61,7 +59,6 @@ impl Path {
/// Returns empty string if no more is to be processed.
#[inline]
pub fn unprocessed(&self) -> &str {
- profile_method!(unprocessed);
// clamp skip to path length
let skip = (self.skip as usize).min(self.as_str().len());
&self.path.path()[skip..]
@@ -72,8 +69,6 @@ impl Path {
#[deprecated(since = "0.6.0", note = "Use `.as_str()` or `.unprocessed()`.")]
#[inline]
pub fn path(&self) -> &str {
- profile_method!(path);
-
let skip = self.skip as usize;
let path = self.path.path();
if skip <= path.len() {
@@ -86,8 +81,6 @@ impl Path {
/// Set new path.
#[inline]
pub fn set(&mut self, path: T) {
- profile_method!(set);
-
self.skip = 0;
self.path = path;
self.segments.clear();
@@ -96,8 +89,6 @@ impl Path {
/// Reset state.
#[inline]
pub fn reset(&mut self) {
- profile_method!(reset);
-
self.skip = 0;
self.segments.clear();
}
@@ -105,13 +96,10 @@ impl Path {
/// Skip first `n` chars in path.
#[inline]
pub fn skip(&mut self, n: u16) {
- profile_method!(skip);
self.skip += n;
}
pub(crate) fn add(&mut self, name: impl Into>, value: PathItem) {
- profile_method!(add);
-
match value {
PathItem::Static(s) => self.segments.push((name.into(), PathItem::Static(s))),
PathItem::Segment(begin, end) => self.segments.push((
@@ -127,8 +115,6 @@ impl Path {
name: impl Into>,
value: impl Into>,
) {
- profile_method!(add_static);
-
self.segments
.push((name.into(), PathItem::Static(value.into())));
}
@@ -147,8 +133,6 @@ impl Path {
/// Get matched parameter by name without type conversion
pub fn get(&self, name: &str) -> Option<&str> {
- profile_method!(get);
-
for (seg_name, val) in self.segments.iter() {
if name == seg_name {
return match val {
@@ -167,8 +151,6 @@ impl Path {
///
/// If keyed parameter is not available empty string is used as default value.
pub fn query(&self, key: &str) -> &str {
- profile_method!(query);
-
if let Some(s) = self.get(key) {
s
} else {
@@ -186,7 +168,6 @@ impl Path {
/// Try to deserialize matching parameters to a specified type `U`
pub fn load<'de, U: serde::Deserialize<'de>>(&'de self) -> Result {
- profile_method!(load);
de::Deserialize::deserialize(PathDeserializer::new(self))
}
}
@@ -261,6 +242,7 @@ mod tests {
use super::*;
+ #[allow(clippy::needless_borrow)]
#[test]
fn deref_impls() {
let mut foo = Path::new("/foo");
diff --git a/actix-router/src/quoter.rs b/actix-router/src/quoter.rs
index 8a1e99e1d..6c929d3ac 100644
--- a/actix-router/src/quoter.rs
+++ b/actix-router/src/quoter.rs
@@ -1,132 +1,89 @@
-#[allow(dead_code)]
-const GEN_DELIMS: &[u8] = b":/?#[]@";
-
-#[allow(dead_code)]
-const SUB_DELIMS_WITHOUT_QS: &[u8] = b"!$'()*,";
-
-#[allow(dead_code)]
-const SUB_DELIMS: &[u8] = b"!$'()*,+?=;";
-
-#[allow(dead_code)]
-const RESERVED: &[u8] = b":/?#[]@!$'()*,+?=;";
-
-#[allow(dead_code)]
-const UNRESERVED: &[u8] = b"abcdefghijklmnopqrstuvwxyz
- ABCDEFGHIJKLMNOPQRSTUVWXYZ
- 1234567890
- -._~";
-
-const ALLOWED: &[u8] = b"abcdefghijklmnopqrstuvwxyz
- ABCDEFGHIJKLMNOPQRSTUVWXYZ
- 1234567890
- -._~
- !$'()*,";
-
-const QS: &[u8] = b"+&=;b";
-
-/// A quoter
+/// Partial percent-decoding.
+///
+/// Performs percent-decoding on a slice but can selectively skip decoding certain sequences.
+///
+/// # Examples
+/// ```
+/// # use actix_router::Quoter;
+/// // + is set as a protected character and will not be decoded...
+/// let q = Quoter::new(&[], b"+");
+///
+/// // ...but the other encoded characters (like the hyphen below) will.
+/// assert_eq!(q.requote(b"/a%2Db%2Bc").unwrap(), b"/a-b%2Bc");
+/// ```
pub struct Quoter {
- /// Simple bit-map of safe values in the 0-127 ASCII range.
- safe_table: [u8; 16],
-
/// Simple bit-map of protected values in the 0-127 ASCII range.
- protected_table: [u8; 16],
+ protected_table: AsciiBitmap,
}
impl Quoter {
- pub fn new(safe: &[u8], protected: &[u8]) -> Quoter {
- let mut quoter = Quoter {
- safe_table: [0; 16],
- protected_table: [0; 16],
- };
-
- // prepare safe table
- for ch in 0..128 {
- if ALLOWED.contains(&ch) {
- set_bit(&mut quoter.safe_table, ch);
- }
-
- if QS.contains(&ch) {
- set_bit(&mut quoter.safe_table, ch);
- }
- }
-
- for &ch in safe {
- set_bit(&mut quoter.safe_table, ch)
- }
+ /// Constructs a new `Quoter` instance given a set of protected ASCII bytes.
+ ///
+ /// The first argument is ignored but is kept for backward compatibility.
+ ///
+ /// # Panics
+ /// Panics if any of the `protected` bytes are not in the 0-127 ASCII range.
+ pub fn new(_: &[u8], protected: &[u8]) -> Quoter {
+ let mut protected_table = AsciiBitmap::default();
// prepare protected table
for &ch in protected {
- set_bit(&mut quoter.safe_table, ch);
- set_bit(&mut quoter.protected_table, ch);
+ protected_table.set_bit(ch);
}
- quoter
+ Quoter { protected_table }
}
- /// Decodes safe percent-encoded sequences from `val`.
- ///
- /// Returns `None` when no modification to the original byte string was required.
- ///
- /// Non-ASCII bytes are accepted as valid input.
- ///
- /// Behavior for invalid/incomplete percent-encoding sequences is unspecified and may include
- /// removing the invalid sequence from the output or passing it as-is.
- pub fn requote(&self, val: &[u8]) -> Option> {
- let mut has_pct = 0;
- let mut pct = [b'%', 0, 0];
- let mut idx = 0;
- let mut cloned: Option> = None;
-
- let len = val.len();
-
- while idx < len {
- let ch = val[idx];
-
- if has_pct != 0 {
- pct[has_pct] = val[idx];
- has_pct += 1;
-
- if has_pct == 3 {
- has_pct = 0;
- let buf = cloned.as_mut().unwrap();
-
- if let Some(ch) = hex_pair_to_char(pct[1], pct[2]) {
- if ch < 128 {
- if bit_at(&self.protected_table, ch) {
- buf.extend_from_slice(&pct);
- idx += 1;
- continue;
- }
-
- if bit_at(&self.safe_table, ch) {
- buf.push(ch);
- idx += 1;
- continue;
- }
- }
-
- buf.push(ch);
- } else {
- buf.extend_from_slice(&pct[..]);
- }
+ /// Decodes the next escape sequence, if any, and advances `val`.
+ #[inline(always)]
+ fn decode_next<'a>(&self, val: &mut &'a [u8]) -> Option<(&'a [u8], u8)> {
+ for i in 0..val.len() {
+ if let (prev, [b'%', p1, p2, rem @ ..]) = val.split_at(i) {
+ if let Some(ch) = hex_pair_to_char(*p1, *p2)
+ // ignore protected ascii bytes
+ .filter(|&ch| !(ch < 128 && self.protected_table.bit_at(ch)))
+ {
+ *val = rem;
+ return Some((prev, ch));
}
- } else if ch == b'%' {
- has_pct = 1;
-
- if cloned.is_none() {
- let mut c = Vec::with_capacity(len);
- c.extend_from_slice(&val[..idx]);
- cloned = Some(c);
- }
- } else if let Some(ref mut cloned) = cloned {
- cloned.push(ch)
}
-
- idx += 1;
}
- cloned
+ None
+ }
+
+ /// Partially percent-decodes the given bytes.
+ ///
+ /// Escape sequences of the protected set are *not* decoded.
+ ///
+ /// Returns `None` when no modification to the original bytes was required.
+ ///
+ /// Invalid/incomplete percent-encoding sequences are passed unmodified.
+ pub fn requote(&self, val: &[u8]) -> Option> {
+ let mut remaining = val;
+
+ // early return indicates that no percent-encoded sequences exist and we can skip allocation
+ let (pre, decoded_char) = self.decode_next(&mut remaining)?;
+
+ // decoded output will always be shorter than the input
+ let mut decoded = Vec::::with_capacity(val.len());
+
+ // push first segment and decoded char
+ decoded.extend_from_slice(pre);
+ decoded.push(decoded_char);
+
+ // decode and push rest of segments and decoded chars
+ while let Some((prev, ch)) = self.decode_next(&mut remaining) {
+ // this ugly conditional achieves +50% perf in cases where this is a tight loop.
+ if !prev.is_empty() {
+ decoded.extend_from_slice(prev);
+ }
+ decoded.push(ch);
+ }
+
+ decoded.extend_from_slice(remaining);
+
+ Some(decoded)
}
pub(crate) fn requote_str_lossy(&self, val: &str) -> Option {
@@ -135,24 +92,6 @@ impl Quoter {
}
}
-/// Converts an ASCII character in the hex-encoded set (`0-9`, `A-F`, `a-f`) to its integer
-/// representation from `0x0`–`0xF`.
-///
-/// - `0x30 ('0') => 0x0`
-/// - `0x39 ('9') => 0x9`
-/// - `0x41 ('a') => 0xA`
-/// - `0x61 ('A') => 0xA`
-/// - `0x46 ('f') => 0xF`
-/// - `0x66 ('F') => 0xF`
-fn from_ascii_hex(v: u8) -> Option {
- match v {
- b'0'..=b'9' => Some(v - 0x30), // ord('0') == 0x30
- b'A'..=b'F' => Some(v - 0x41 + 10), // ord('A') == 0x41
- b'a'..=b'f' => Some(v - 0x61 + 10), // ord('a') == 0x61
- _ => None,
- }
-}
-
/// Decode a ASCII hex-encoded pair to an integer.
///
/// Returns `None` if either portion of the decoded pair does not evaluate to a valid hex value.
@@ -160,64 +99,52 @@ fn from_ascii_hex(v: u8) -> Option {
/// - `0x33 ('3'), 0x30 ('0') => 0x30 ('0')`
/// - `0x34 ('4'), 0x31 ('1') => 0x41 ('A')`
/// - `0x36 ('6'), 0x31 ('1') => 0x61 ('a')`
+#[inline(always)]
fn hex_pair_to_char(d1: u8, d2: u8) -> Option {
- let (d_high, d_low) = (from_ascii_hex(d1)?, from_ascii_hex(d2)?);
+ let d_high = char::from(d1).to_digit(16)?;
+ let d_low = char::from(d2).to_digit(16)?;
// left shift high nibble by 4 bits
- Some(d_high << 4 | d_low)
+ Some((d_high as u8) << 4 | (d_low as u8))
}
-/// Sets bit in given bit-map to 1=true.
-///
-/// # Panics
-/// Panics if `ch` index is out of bounds.
-fn set_bit(array: &mut [u8], ch: u8) {
- array[(ch >> 3) as usize] |= 0b1 << (ch & 0b111)
+#[derive(Debug, Default, Clone)]
+struct AsciiBitmap {
+ array: [u8; 16],
}
-/// Returns true if bit to true in given bit-map.
-///
-/// # Panics
-/// Panics if `ch` index is out of bounds.
-fn bit_at(array: &[u8], ch: u8) -> bool {
- array[(ch >> 3) as usize] & (0b1 << (ch & 0b111)) != 0
+impl AsciiBitmap {
+ /// Sets bit in given bit-map to 1=true.
+ ///
+ /// # Panics
+ /// Panics if `ch` index is out of bounds.
+ fn set_bit(&mut self, ch: u8) {
+ self.array[(ch >> 3) as usize] |= 0b1 << (ch & 0b111)
+ }
+
+ /// Returns true if bit to true in given bit-map.
+ ///
+ /// # Panics
+ /// Panics if `ch` index is out of bounds.
+ fn bit_at(&self, ch: u8) -> bool {
+ self.array[(ch >> 3) as usize] & (0b1 << (ch & 0b111)) != 0
+ }
}
#[cfg(test)]
mod tests {
use super::*;
- #[test]
- fn hex_encoding() {
- let hex = b"0123456789abcdefABCDEF";
-
- for i in 0..256 {
- let c = i as u8;
- if hex.contains(&c) {
- assert!(from_ascii_hex(c).is_some())
- } else {
- assert!(from_ascii_hex(c).is_none())
- }
- }
-
- let expected = [
- 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 10, 11, 12, 13, 14, 15,
- ];
- for i in 0..hex.len() {
- assert_eq!(from_ascii_hex(hex[i]).unwrap(), expected[i]);
- }
- }
-
#[test]
fn custom_quoter() {
let q = Quoter::new(b"", b"+");
assert_eq!(q.requote(b"/a%25c").unwrap(), b"/a%c");
- assert_eq!(q.requote(b"/a%2Bc").unwrap(), b"/a%2Bc");
+ assert_eq!(q.requote(b"/a%2Bc"), None);
let q = Quoter::new(b"%+", b"/");
assert_eq!(q.requote(b"/a%25b%2Bc").unwrap(), b"/a%b+c");
- assert_eq!(q.requote(b"/a%2fb").unwrap(), b"/a%2fb");
- assert_eq!(q.requote(b"/a%2Fb").unwrap(), b"/a%2Fb");
+ assert_eq!(q.requote(b"/a%2fb"), None);
+ assert_eq!(q.requote(b"/a%2Fb"), None);
assert_eq!(q.requote(b"/a%0Ab").unwrap(), b"/a\nb");
assert_eq!(q.requote(b"/a%FE\xffb").unwrap(), b"/a\xfe\xffb");
assert_eq!(q.requote(b"/a\xfe\xffb"), None);
@@ -233,7 +160,8 @@ mod tests {
#[test]
fn invalid_sequences() {
let q = Quoter::new(b"%+", b"/");
- assert_eq!(q.requote(b"/a%2x%2X%%").unwrap(), b"/a%2x%2X");
+ assert_eq!(q.requote(b"/a%2x%2X%%"), None);
+ assert_eq!(q.requote(b"/a%20%2X%%").unwrap(), b"/a %2X%%");
}
#[test]
diff --git a/actix-router/src/resource.rs b/actix-router/src/resource.rs
index 3d121f369..f198115ad 100644
--- a/actix-router/src/resource.rs
+++ b/actix-router/src/resource.rs
@@ -5,7 +5,6 @@ use std::{
mem,
};
-use firestorm::{profile_fn, profile_method, profile_section};
use regex::{escape, Regex, RegexSet};
use tracing::error;
@@ -272,7 +271,6 @@ impl ResourceDef {
/// assert!(!resource.is_match("/foo"));
/// ```
pub fn new(paths: T) -> Self {
- profile_method!(new);
Self::construct(paths, false)
}
@@ -300,7 +298,6 @@ impl ResourceDef {
/// assert!(!resource.is_match("/foo"));
/// ```
pub fn prefix(paths: T) -> Self {
- profile_method!(prefix);
ResourceDef::construct(paths, true)
}
@@ -325,7 +322,6 @@ impl ResourceDef {
/// assert!(!resource.is_match("user/123"));
/// ```
pub fn root_prefix(path: &str) -> Self {
- profile_method!(root_prefix);
ResourceDef::prefix(insert_slash(path).into_owned())
}
@@ -549,8 +545,6 @@ impl ResourceDef {
/// ```
#[inline]
pub fn is_match(&self, path: &str) -> bool {
- profile_method!(is_match);
-
// this function could be expressed as:
// `self.find_match(path).is_some()`
// but this skips some checks and uses potentially faster regex methods
@@ -598,8 +592,6 @@ impl ResourceDef {
/// assert_eq!(resource.find_match("/profile/1234"), Some(13));
/// ```
pub fn find_match(&self, path: &str) -> Option {
- profile_method!(find_match);
-
match &self.pat_type {
PatternType::Static(pattern) => self.static_match(pattern, path),
@@ -634,7 +626,6 @@ impl ResourceDef {
/// assert_eq!(path.unprocessed(), "");
/// ```
pub fn capture_match_info(&self, resource: &mut R) -> bool {
- profile_method!(capture_match_info);
self.capture_match_info_fn(resource, |_| true)
}
@@ -658,7 +649,7 @@ impl ResourceDef {
/// resource.capture_match_info_fn(
/// path,
/// // when env var is not set, reject when path contains "admin"
- /// |res| !(!admin_allowed && res.path().contains("admin")),
+ /// |path| !(!admin_allowed && path.as_str().contains("admin")),
/// )
/// }
///
@@ -680,53 +671,35 @@ impl ResourceDef {
R: Resource,
F: FnOnce(&R) -> bool,
{
- profile_method!(capture_match_info_fn);
-
let mut segments = <[PathItem; MAX_DYNAMIC_SEGMENTS]>::default();
let path = resource.resource_path();
let path_str = path.unprocessed();
let (matched_len, matched_vars) = match &self.pat_type {
- PatternType::Static(pattern) => {
- profile_section!(pattern_static_or_prefix);
-
- match self.static_match(pattern, path_str) {
- Some(len) => (len, None),
- None => return false,
- }
- }
+ PatternType::Static(pattern) => match self.static_match(pattern, path_str) {
+ Some(len) => (len, None),
+ None => return false,
+ },
PatternType::Dynamic(re, names) => {
- profile_section!(pattern_dynamic);
-
- let captures = {
- profile_section!(pattern_dynamic_regex_exec);
-
- match re.captures(path.unprocessed()) {
- Some(captures) => captures,
- _ => return false,
- }
+ let captures = match re.captures(path.unprocessed()) {
+ Some(captures) => captures,
+ _ => return false,
};
- {
- profile_section!(pattern_dynamic_extract_captures);
-
- for (no, name) in names.iter().enumerate() {
- if let Some(m) = captures.name(name) {
- segments[no] = PathItem::Segment(m.start() as u16, m.end() as u16);
- } else {
- error!("Dynamic path match but not all segments found: {}", name);
- return false;
- }
+ for (no, name) in names.iter().enumerate() {
+ if let Some(m) = captures.name(name) {
+ segments[no] = PathItem::Segment(m.start() as u16, m.end() as u16);
+ } else {
+ error!("Dynamic path match but not all segments found: {}", name);
+ return false;
}
- };
+ }
(captures[1].len(), Some(names))
}
PatternType::DynamicSet(re, params) => {
- profile_section!(pattern_dynamic_set);
-
let path = path.unprocessed();
let (pattern, names) = match re.matches(path).into_iter().next() {
Some(idx) => ¶ms[idx],
@@ -809,7 +782,6 @@ impl ResourceDef {
I: IntoIterator,
I::Item: AsRef,
{
- profile_method!(resource_path_from_iter);
let mut iter = values.into_iter();
self.build_resource_path(path, |_| iter.next())
}
@@ -845,7 +817,6 @@ impl ResourceDef {
V: AsRef,
S: BuildHasher,
{
- profile_method!(resource_path_from_map);
self.build_resource_path(path, |name| values.get(name))
}
@@ -866,8 +837,6 @@ impl ResourceDef {
}
fn construct(paths: T, is_prefix: bool) -> Self {
- profile_method!(construct);
-
let patterns = paths.patterns();
let (pat_type, segments) = match &patterns {
Patterns::Single(pattern) => ResourceDef::parse(pattern, is_prefix, false),
@@ -926,8 +895,6 @@ impl ResourceDef {
/// # Panics
/// Panics if given patterns does not contain a dynamic segment.
fn parse_param(pattern: &str) -> (PatternSegment, String, &str, bool) {
- profile_method!(parse_param);
-
const DEFAULT_PATTERN: &str = "[^/]+";
const DEFAULT_PATTERN_TAIL: &str = ".*";
@@ -997,8 +964,6 @@ impl ResourceDef {
is_prefix: bool,
force_dynamic: bool,
) -> (PatternType, Vec) {
- profile_method!(parse);
-
if !force_dynamic && pattern.find('{').is_none() && !pattern.ends_with('*') {
// pattern is static
return (
@@ -1131,8 +1096,6 @@ impl From for ResourceDef {
}
pub(crate) fn insert_slash(path: &str) -> Cow<'_, str> {
- profile_fn!(insert_slash);
-
if !path.is_empty() && !path.starts_with('/') {
let mut new_path = String::with_capacity(path.len() + 1);
new_path.push('/');
@@ -1540,31 +1503,31 @@ mod tests {
fn build_path_list() {
let mut s = String::new();
let resource = ResourceDef::new("/user/{item1}/test");
- assert!(resource.resource_path_from_iter(&mut s, &mut (&["user1"]).iter()));
+ assert!(resource.resource_path_from_iter(&mut s, &mut ["user1"].iter()));
assert_eq!(s, "/user/user1/test");
let mut s = String::new();
let resource = ResourceDef::new("/user/{item1}/{item2}/test");
- assert!(resource.resource_path_from_iter(&mut s, &mut (&["item", "item2"]).iter()));
+ assert!(resource.resource_path_from_iter(&mut s, &mut ["item", "item2"].iter()));
assert_eq!(s, "/user/item/item2/test");
let mut s = String::new();
let resource = ResourceDef::new("/user/{item1}/{item2}");
- assert!(resource.resource_path_from_iter(&mut s, &mut (&["item", "item2"]).iter()));
+ assert!(resource.resource_path_from_iter(&mut s, &mut ["item", "item2"].iter()));
assert_eq!(s, "/user/item/item2");
let mut s = String::new();
let resource = ResourceDef::new("/user/{item1}/{item2}/");
- assert!(resource.resource_path_from_iter(&mut s, &mut (&["item", "item2"]).iter()));
+ assert!(resource.resource_path_from_iter(&mut s, &mut ["item", "item2"].iter()));
assert_eq!(s, "/user/item/item2/");
let mut s = String::new();
- assert!(!resource.resource_path_from_iter(&mut s, &mut (&["item"]).iter()));
+ assert!(!resource.resource_path_from_iter(&mut s, &mut ["item"].iter()));
let mut s = String::new();
- assert!(resource.resource_path_from_iter(&mut s, &mut (&["item", "item2"]).iter()));
+ assert!(resource.resource_path_from_iter(&mut s, &mut ["item", "item2"].iter()));
assert_eq!(s, "/user/item/item2/");
- assert!(!resource.resource_path_from_iter(&mut s, &mut (&["item"]).iter()));
+ assert!(!resource.resource_path_from_iter(&mut s, &mut ["item"].iter()));
let mut s = String::new();
assert!(resource.resource_path_from_iter(&mut s, &mut vec!["item", "item2"].iter()));
@@ -1641,10 +1604,10 @@ mod tests {
let resource = ResourceDef::new("/user/{item1}*");
let mut s = String::new();
- assert!(!resource.resource_path_from_iter(&mut s, &mut (&[""; 0]).iter()));
+ assert!(!resource.resource_path_from_iter(&mut s, &mut [""; 0].iter()));
let mut s = String::new();
- assert!(resource.resource_path_from_iter(&mut s, &mut (&["user1"]).iter()));
+ assert!(resource.resource_path_from_iter(&mut s, &mut ["user1"].iter()));
assert_eq!(s, "/user/user1");
let mut s = String::new();
diff --git a/actix-router/src/resource_path.rs b/actix-router/src/resource_path.rs
index 00eb0927c..45948aa2a 100644
--- a/actix-router/src/resource_path.rs
+++ b/actix-router/src/resource_path.rs
@@ -27,7 +27,7 @@ impl<'a> ResourcePath for &'a str {
impl ResourcePath for bytestring::ByteString {
fn path(&self) -> &str {
- &*self
+ self
}
}
diff --git a/actix-router/src/router.rs b/actix-router/src/router.rs
index f0e598683..064c5e904 100644
--- a/actix-router/src/router.rs
+++ b/actix-router/src/router.rs
@@ -1,8 +1,6 @@
-use firestorm::profile_method;
-
use crate::{IntoPatterns, Resource, ResourceDef};
-#[derive(Debug, Copy, Clone, PartialEq)]
+#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct ResourceId(pub u16);
/// Resource router.
@@ -30,7 +28,6 @@ impl Router {
where
R: Resource,
{
- profile_method!(recognize);
self.recognize_fn(resource, |_, _| true)
}
@@ -39,7 +36,6 @@ impl Router {
where
R: Resource,
{
- profile_method!(recognize_mut);
self.recognize_mut_fn(resource, |_, _| true)
}
@@ -55,8 +51,6 @@ impl Router {
R: Resource,
F: FnMut(&R, &U) -> bool,
{
- profile_method!(recognize_checked);
-
for (rdef, val, ctx) in self.routes.iter() {
if rdef.capture_match_info_fn(resource, |res| check(res, ctx)) {
return Some((val, ResourceId(rdef.id())));
@@ -77,8 +71,6 @@ impl Router {
R: Resource,
F: FnMut(&R, &U) -> bool,
{
- profile_method!(recognize_mut_checked);
-
for (rdef, val, ctx) in self.routes.iter_mut() {
if rdef.capture_match_info_fn(resource, |res| check(res, ctx)) {
return Some((val, ResourceId(rdef.id())));
@@ -104,7 +96,6 @@ impl RouterBuilder {
val: T,
ctx: U,
) -> (&mut ResourceDef, &mut T, &mut U) {
- profile_method!(push);
self.routes.push((rdef, val, ctx));
self.routes
.last_mut()
@@ -131,7 +122,6 @@ where
path: impl IntoPatterns,
val: T,
) -> (&mut ResourceDef, &mut T, &mut U) {
- profile_method!(path);
self.push(ResourceDef::new(path), val, U::default())
}
@@ -141,13 +131,11 @@ where
prefix: impl IntoPatterns,
val: T,
) -> (&mut ResourceDef, &mut T, &mut U) {
- profile_method!(prefix);
self.push(ResourceDef::prefix(prefix), val, U::default())
}
/// Registers resource for [`ResourceDef`].
pub fn rdef(&mut self, rdef: ResourceDef, val: T) -> (&mut ResourceDef, &mut T, &mut U) {
- profile_method!(rdef);
self.push(rdef, val, U::default())
}
}
diff --git a/actix-router/src/url.rs b/actix-router/src/url.rs
index e7dda3fca..8ac033861 100644
--- a/actix-router/src/url.rs
+++ b/actix-router/src/url.rs
@@ -3,7 +3,7 @@ use crate::ResourcePath;
use crate::Quoter;
thread_local! {
- static DEFAULT_QUOTER: Quoter = Quoter::new(b"@:", b"%/+");
+ static DEFAULT_QUOTER: Quoter = Quoter::new(b"", b"%/+");
}
#[derive(Debug, Clone, Default)]
diff --git a/actix-test/CHANGES.md b/actix-test/CHANGES.md
index 13e75c01a..c8fe54203 100644
--- a/actix-test/CHANGES.md
+++ b/actix-test/CHANGES.md
@@ -1,6 +1,11 @@
# Changes
-## Unreleased - 2021-xx-xx
+## Unreleased - 2022-xx-xx
+- Minimum supported Rust version (MSRV) is now 1.59 due to transitive `time` dependency.
+
+
+## 0.1.0 - 2022-07-24
+- Minimum supported Rust version (MSRV) is now 1.57 due to transitive `time` dependency.
## 0.1.0-beta.13 - 2022-02-16
diff --git a/actix-test/Cargo.toml b/actix-test/Cargo.toml
index 9938be67d..eaea15d47 100644
--- a/actix-test/Cargo.toml
+++ b/actix-test/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "actix-test"
-version = "0.1.0-beta.13"
+version = "0.1.0"
authors = [
"Nikolay Kim ",
"Rob Ede ",
@@ -30,7 +30,7 @@ openssl = ["tls-openssl", "actix-http/openssl", "awc/openssl"]
[dependencies]
actix-codec = "0.5"
actix-http = "3"
-actix-http-test = "3.0.0-beta.13"
+actix-http-test = "3"
actix-rt = "2.1"
actix-service = "2"
actix-utils = "3"
diff --git a/actix-web-actors/CHANGES.md b/actix-web-actors/CHANGES.md
index b4844bfa6..33d4712f8 100644
--- a/actix-web-actors/CHANGES.md
+++ b/actix-web-actors/CHANGES.md
@@ -1,6 +1,7 @@
# Changes
-## Unreleased - 2021-xx-xx
+## Unreleased - 2022-xx-xx
+- Minimum supported Rust version (MSRV) is now 1.57 due to transitive `time` dependency.
## 4.1.0 - 2022-03-02
diff --git a/actix-web-actors/Cargo.toml b/actix-web-actors/Cargo.toml
index c939f6ab5..8222fc864 100644
--- a/actix-web-actors/Cargo.toml
+++ b/actix-web-actors/Cargo.toml
@@ -27,8 +27,11 @@ tokio = { version = "1.13.1", features = ["sync"] }
[dev-dependencies]
actix-rt = "2.2"
-actix-test = "0.1.0-beta.13"
+actix-test = "0.1"
awc = { version = "3", default-features = false }
+actix-web = { version = "4", features = ["macros"] }
+
+mime = "0.3"
env_logger = "0.9"
futures-util = { version = "0.3.7", default-features = false }
diff --git a/actix-web-actors/README.md b/actix-web-actors/README.md
index 357154a86..a0578994c 100644
--- a/actix-web-actors/README.md
+++ b/actix-web-actors/README.md
@@ -4,7 +4,7 @@
[](https://crates.io/crates/actix-web-actors)
[](https://docs.rs/actix-web-actors/4.1.0)
-[](https://blog.rust-lang.org/2021/05/06/Rust-1.54.0.html)
+
[](https://deps.rs/crate/actix-web-actors/4.1.0)
diff --git a/actix-web-actors/src/context.rs b/actix-web-actors/src/context.rs
index d83969ff7..f7b11c780 100644
--- a/actix-web-actors/src/context.rs
+++ b/actix-web-actors/src/context.rs
@@ -14,6 +14,58 @@ use futures_core::Stream;
use tokio::sync::oneshot::Sender;
/// Execution context for HTTP actors
+///
+/// # Example
+///
+/// A demonstration of [server-sent events](https://developer.mozilla.org/docs/Web/API/Server-sent_events) using actors:
+///
+/// ```no_run
+/// use std::time::Duration;
+///
+/// use actix::{Actor, AsyncContext};
+/// use actix_web::{get, http::header, App, HttpResponse, HttpServer};
+/// use actix_web_actors::HttpContext;
+/// use bytes::Bytes;
+///
+/// struct MyActor {
+/// count: usize,
+/// }
+///
+/// impl Actor for MyActor {
+/// type Context = HttpContext;
+///
+/// fn started(&mut self, ctx: &mut Self::Context) {
+/// ctx.run_later(Duration::from_millis(100), Self::write);
+/// }
+/// }
+///
+/// impl MyActor {
+/// fn write(&mut self, ctx: &mut HttpContext) {
+/// self.count += 1;
+/// if self.count > 3 {
+/// ctx.write_eof()
+/// } else {
+/// ctx.write(Bytes::from(format!("event: count\ndata: {}\n\n", self.count)));
+/// ctx.run_later(Duration::from_millis(100), Self::write);
+/// }
+/// }
+/// }
+///
+/// #[get("/")]
+/// async fn index() -> HttpResponse {
+/// HttpResponse::Ok()
+/// .insert_header(header::ContentType(mime::TEXT_EVENT_STREAM))
+/// .streaming(HttpContext::create(MyActor { count: 0 }))
+/// }
+///
+/// #[actix_web::main]
+/// async fn main() -> std::io::Result<()> {
+/// HttpServer::new(|| App::new().service(index))
+/// .bind(("127.0.0.1", 8080))?
+/// .run()
+/// .await
+/// }
+/// ```
pub struct HttpContext
where
A: Actor>,
@@ -210,7 +262,7 @@ mod tests {
type Context = HttpContext;
fn started(&mut self, ctx: &mut Self::Context) {
- ctx.run_later(Duration::from_millis(100), |slf, ctx| slf.write(ctx));
+ ctx.run_later(Duration::from_millis(100), Self::write);
}
}
@@ -221,7 +273,7 @@ mod tests {
ctx.write_eof()
} else {
ctx.write(Bytes::from(format!("LINE-{}", self.count)));
- ctx.run_later(Duration::from_millis(100), |slf, ctx| slf.write(ctx));
+ ctx.run_later(Duration::from_millis(100), Self::write);
}
}
}
diff --git a/actix-web-actors/src/lib.rs b/actix-web-actors/src/lib.rs
index 70c957020..106bc5202 100644
--- a/actix-web-actors/src/lib.rs
+++ b/actix-web-actors/src/lib.rs
@@ -1,4 +1,59 @@
//! Actix actors support for Actix Web.
+//!
+//! # Examples
+//!
+//! ```no_run
+//! use actix::{Actor, StreamHandler};
+//! use actix_web::{get, web, App, Error, HttpRequest, HttpResponse, HttpServer};
+//! use actix_web_actors::ws;
+//!
+//! /// Define Websocket actor
+//! struct MyWs;
+//!
+//! impl Actor for MyWs {
+//! type Context = ws::WebsocketContext;
+//! }
+//!
+//! /// Handler for ws::Message message
+//! impl StreamHandler> for MyWs {
+//! fn handle(&mut self, msg: Result, ctx: &mut Self::Context) {
+//! match msg {
+//! Ok(ws::Message::Ping(msg)) => ctx.pong(&msg),
+//! Ok(ws::Message::Text(text)) => ctx.text(text),
+//! Ok(ws::Message::Binary(bin)) => ctx.binary(bin),
+//! _ => (),
+//! }
+//! }
+//! }
+//!
+//! #[get("/ws")]
+//! async fn index(req: HttpRequest, stream: web::Payload) -> Result {
+//! ws::start(MyWs, &req, stream)
+//! }
+//!
+//! #[actix_web::main]
+//! async fn main() -> std::io::Result<()> {
+//! HttpServer::new(|| App::new().service(index))
+//! .bind(("127.0.0.1", 8080))?
+//! .run()
+//! .await
+//! }
+//! ```
+//!
+//! # Documentation & Community Resources
+//! In addition to this API documentation, several other resources are available:
+//!
+//! * [Website & User Guide](https://actix.rs/)
+//! * [Documentation for `actix_web`](actix_web)
+//! * [Examples Repository](https://github.com/actix/examples)
+//! * [Community Chat on Discord](https://discord.gg/NWpN5mmg3x)
+//!
+//! To get started navigating the API docs, you may consider looking at the following pages first:
+//!
+//! * [`ws`]: This module provides actor support for WebSockets.
+//!
+//! * [`HttpContext`]: This struct provides actor support for streaming HTTP responses.
+//!
#![deny(rust_2018_idioms, nonstandard_style)]
#![warn(future_incompatible)]
diff --git a/actix-web-actors/src/ws.rs b/actix-web-actors/src/ws.rs
index 6fde10192..9a4880159 100644
--- a/actix-web-actors/src/ws.rs
+++ b/actix-web-actors/src/ws.rs
@@ -1,4 +1,60 @@
//! Websocket integration.
+//!
+//! # Examples
+//!
+//! ```no_run
+//! use actix::{Actor, StreamHandler};
+//! use actix_web::{get, web, App, Error, HttpRequest, HttpResponse, HttpServer};
+//! use actix_web_actors::ws;
+//!
+//! /// Define Websocket actor
+//! struct MyWs;
+//!
+//! impl Actor for MyWs {
+//! type Context = ws::WebsocketContext;
+//! }
+//!
+//! /// Handler for ws::Message message
+//! impl StreamHandler> for MyWs {
+//! fn handle(&mut self, msg: Result, ctx: &mut Self::Context) {
+//! match msg {
+//! Ok(ws::Message::Ping(msg)) => ctx.pong(&msg),
+//! Ok(ws::Message::Text(text)) => ctx.text(text),
+//! Ok(ws::Message::Binary(bin)) => ctx.binary(bin),
+//! _ => (),
+//! }
+//! }
+//! }
+//!
+//! #[get("/ws")]
+//! async fn websocket(req: HttpRequest, stream: web::Payload) -> Result {
+//! ws::start(MyWs, &req, stream)
+//! }
+//!
+//! const MAX_FRAME_SIZE: usize = 16_384; // 16KiB
+//!
+//! #[get("/custom-ws")]
+//! async fn custom_websocket(req: HttpRequest, stream: web::Payload) -> Result {
+//! // Create a Websocket session with a specific max frame size, and protocols.
+//! ws::WsResponseBuilder::new(MyWs, &req, stream)
+//! .frame_size(MAX_FRAME_SIZE)
+//! .protocols(&["A", "B"])
+//! .start()
+//! }
+//!
+//! #[actix_web::main]
+//! async fn main() -> std::io::Result<()> {
+//! HttpServer::new(|| {
+//! App::new()
+//! .service(websocket)
+//! .service(custom_websocket)
+//! })
+//! .bind(("127.0.0.1", 8080))?
+//! .run()
+//! .await
+//! }
+//! ```
+//!
use std::{
collections::VecDeque,
@@ -41,20 +97,51 @@ use tokio::sync::oneshot;
///
/// # Examples
///
-/// Create a Websocket session response with default configuration.
-/// ```ignore
-/// WsResponseBuilder::new(WsActor, &req, stream).start()
-/// ```
+/// ```no_run
+/// # use actix::{Actor, StreamHandler};
+/// # use actix_web::{get, web, App, Error, HttpRequest, HttpResponse, HttpServer};
+/// # use actix_web_actors::ws;
+/// #
+/// # struct MyWs;
+/// #
+/// # impl Actor for MyWs {
+/// # type Context = ws::WebsocketContext;
+/// # }
+/// #
+/// # /// Handler for ws::Message message
+/// # impl StreamHandler> for MyWs {
+/// # fn handle(&mut self, msg: Result, ctx: &mut Self::Context) {}
+/// # }
+/// #
+/// #[get("/ws")]
+/// async fn websocket(req: HttpRequest, stream: web::Payload) -> Result {
+/// ws::WsResponseBuilder::new(MyWs, &req, stream).start()
+/// }
///
-/// Create a Websocket session with a specific max frame size, [`Codec`], and protocols.
-/// ```ignore
/// const MAX_FRAME_SIZE: usize = 16_384; // 16KiB
///
-/// ws::WsResponseBuilder::new(WsActor, &req, stream)
-/// .codec(Codec::new())
-/// .protocols(&["A", "B"])
-/// .frame_size(MAX_FRAME_SIZE)
-/// .start()
+/// #[get("/custom-ws")]
+/// async fn custom_websocket(req: HttpRequest, stream: web::Payload) -> Result {
+/// // Create a Websocket session with a specific max frame size, codec, and protocols.
+/// ws::WsResponseBuilder::new(MyWs, &req, stream)
+/// .codec(actix_http::ws::Codec::new())
+/// // This will overwrite the codec's max frame-size
+/// .frame_size(MAX_FRAME_SIZE)
+/// .protocols(&["A", "B"])
+/// .start()
+/// }
+/// #
+/// # #[actix_web::main]
+/// # async fn main() -> std::io::Result<()> {
+/// # HttpServer::new(|| {
+/// # App::new()
+/// # .service(websocket)
+/// # .service(custom_websocket)
+/// # })
+/// # .bind(("127.0.0.1", 8080))?
+/// # .run()
+/// # .await
+/// # }
/// ```
pub struct WsResponseBuilder<'a, A, T>
where
diff --git a/actix-web-codegen/CHANGES.md b/actix-web-codegen/CHANGES.md
index 8ee787c0a..cb37bfdb0 100644
--- a/actix-web-codegen/CHANGES.md
+++ b/actix-web-codegen/CHANGES.md
@@ -1,6 +1,20 @@
# Changes
-## Unreleased - 2021-xx-xx
+## Unreleased - 2022-xx-xx
+
+
+## 4.1.0 - 2022-09-11
+- Add `#[routes]` macro to support multiple paths for one handler. [#2718]
+- Minimum supported Rust version (MSRV) is now 1.59 due to transitive `time` dependency.
+
+[#2718]: https://github.com/actix/actix-web/pull/2718
+
+
+## 4.0.1 - 2022-06-11
+- Fix support for guard paths in route handler macros. [#2771]
+- Minimum supported Rust version (MSRV) is now 1.56 due to transitive `hashbrown` dependency.
+
+[#2771]: https://github.com/actix/actix-web/pull/2771
## 4.0.0 - 2022-02-24
diff --git a/actix-web-codegen/Cargo.toml b/actix-web-codegen/Cargo.toml
index 0d8b86459..2477364a6 100644
--- a/actix-web-codegen/Cargo.toml
+++ b/actix-web-codegen/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "actix-web-codegen"
-version = "4.0.0"
+version = "4.1.0"
description = "Routing and runtime macros for Actix Web"
homepage = "https://actix.rs"
repository = "https://github.com/actix/actix-web.git"
@@ -15,17 +15,17 @@ edition = "2018"
proc-macro = true
[dependencies]
-actix-router = "0.5.0"
+actix-router = "0.5"
proc-macro2 = "1"
quote = "1"
-syn = { version = "1", features = ["full", "parsing"] }
+syn = { version = "1", features = ["full", "extra-traits"] }
[dev-dependencies]
actix-macros = "0.2.3"
actix-rt = "2.2"
-actix-test = "0.1.0-beta.13"
-actix-utils = "3.0.0"
-actix-web = "4.0.0"
+actix-test = "0.1"
+actix-utils = "3"
+actix-web = "4"
futures-core = { version = "0.3.7", default-features = false, features = ["alloc"] }
trybuild = "1"
diff --git a/actix-web-codegen/README.md b/actix-web-codegen/README.md
index 439beadb4..821236e47 100644
--- a/actix-web-codegen/README.md
+++ b/actix-web-codegen/README.md
@@ -3,11 +3,11 @@
> Routing and runtime macros for Actix Web.
[](https://crates.io/crates/actix-web-codegen)
-[](https://docs.rs/actix-web-codegen/4.0.0)
-[](https://blog.rust-lang.org/2021/05/06/Rust-1.54.0.html)
+[](https://docs.rs/actix-web-codegen/4.1.0)
+
-[](https://deps.rs/crate/actix-web-codegen/4.0.0)
+[](https://deps.rs/crate/actix-web-codegen/4.1.0)
[](https://crates.io/crates/actix-web-codegen)
[](https://discord.gg/NWpN5mmg3x)
diff --git a/actix-web-codegen/src/lib.rs b/actix-web-codegen/src/lib.rs
index 5ca5616b6..4b6dc43c5 100644
--- a/actix-web-codegen/src/lib.rs
+++ b/actix-web-codegen/src/lib.rs
@@ -46,9 +46,20 @@
//! ```
//!
//! # Multiple Path Handlers
-//! There are no macros to generate multi-path handlers. Let us know in [this issue].
+//! Acts as a wrapper for multiple single method handler macros. It takes no arguments and
+//! delegates those to the macros for the individual methods. See [macro@routes] macro docs.
//!
-//! [this issue]: https://github.com/actix/actix-web/issues/1709
+//! ```
+//! # use actix_web::HttpResponse;
+//! # use actix_web_codegen::routes;
+//! #[routes]
+//! #[get("/test")]
+//! #[get("/test2")]
+//! #[delete("/test")]
+//! async fn example() -> HttpResponse {
+//! HttpResponse::Ok().finish()
+//! }
+//! ```
//!
//! [actix-web attributes docs]: https://docs.rs/actix-web/latest/actix_web/#attributes
//! [GET]: macro@get
@@ -104,6 +115,39 @@ pub fn route(args: TokenStream, input: TokenStream) -> TokenStream {
route::with_method(None, args, input)
}
+/// Creates resource handler, allowing multiple HTTP methods and paths.
+///
+/// # Syntax
+/// ```plain
+/// #[routes]
+/// #[("path", ...)]
+/// #[("path", ...)]
+/// ...
+/// ```
+///
+/// # Attributes
+/// The `routes` macro itself has no parameters, but allows specifying the attribute macros for
+/// the multiple paths and/or methods, e.g. [`GET`](macro@get) and [`POST`](macro@post).
+///
+/// These helper attributes take the same parameters as the [single method handlers](crate#single-method-handler).
+///
+/// # Examples
+/// ```
+/// # use actix_web::HttpResponse;
+/// # use actix_web_codegen::routes;
+/// #[routes]
+/// #[get("/test")]
+/// #[get("/test2")]
+/// #[delete("/test")]
+/// async fn example() -> HttpResponse {
+/// HttpResponse::Ok().finish()
+/// }
+/// ```
+#[proc_macro_attribute]
+pub fn routes(_: TokenStream, input: TokenStream) -> TokenStream {
+ route::with_methods(input)
+}
+
macro_rules! method_macro {
($variant:ident, $method:ident) => {
#[doc = concat!("Creates route handler with `actix_web::guard::", stringify!($variant), "`.")]
diff --git a/actix-web-codegen/src/route.rs b/actix-web-codegen/src/route.rs
index cb1ba1ef6..7a0658468 100644
--- a/actix-web-codegen/src/route.rs
+++ b/actix-web-codegen/src/route.rs
@@ -3,24 +3,12 @@ use std::{collections::HashSet, convert::TryFrom};
use actix_router::ResourceDef;
use proc_macro::TokenStream;
use proc_macro2::{Span, TokenStream as TokenStream2};
-use quote::{format_ident, quote, ToTokens, TokenStreamExt};
-use syn::{parse_macro_input, AttributeArgs, Ident, LitStr, NestedMeta};
-
-enum ResourceType {
- Async,
- Sync,
-}
-
-impl ToTokens for ResourceType {
- fn to_tokens(&self, stream: &mut TokenStream2) {
- let ident = format_ident!("to");
- stream.append(ident);
- }
-}
+use quote::{quote, ToTokens, TokenStreamExt};
+use syn::{parse_macro_input, AttributeArgs, Ident, LitStr, Meta, NestedMeta, Path};
macro_rules! method_type {
(
- $($variant:ident, $upper:ident,)+
+ $($variant:ident, $upper:ident, $lower:ident,)+
) => {
#[derive(Debug, PartialEq, Eq, Hash)]
pub enum MethodType {
@@ -42,20 +30,27 @@ macro_rules! method_type {
_ => Err(format!("Unexpected HTTP method: `{}`", method)),
}
}
+
+ fn from_path(method: &Path) -> Result {
+ match () {
+ $(_ if method.is_ident(stringify!($lower)) => Ok(Self::$variant),)+
+ _ => Err(()),
+ }
+ }
}
};
}
method_type! {
- Get, GET,
- Post, POST,
- Put, PUT,
- Delete, DELETE,
- Head, HEAD,
- Connect, CONNECT,
- Options, OPTIONS,
- Trace, TRACE,
- Patch, PATCH,
+ Get, GET, get,
+ Post, POST, post,
+ Put, PUT, put,
+ Delete, DELETE, delete,
+ Head, HEAD, head,
+ Connect, CONNECT, connect,
+ Options, OPTIONS, options,
+ Trace, TRACE, trace,
+ Patch, PATCH, patch,
}
impl ToTokens for MethodType {
@@ -77,7 +72,7 @@ impl TryFrom<&syn::LitStr> for MethodType {
struct Args {
path: syn::LitStr,
resource_name: Option,
- guards: Vec,
+ guards: Vec,
wrappers: Vec,
methods: HashSet,
}
@@ -90,6 +85,18 @@ impl Args {
let mut wrappers = Vec::new();
let mut methods = HashSet::new();
+ if args.is_empty() {
+ return Err(syn::Error::new(
+ Span::call_site(),
+ format!(
+ r#"invalid service definition, expected #[{}("")]"#,
+ method
+ .map_or("route", |it| it.as_str())
+ .to_ascii_lowercase()
+ ),
+ ));
+ }
+
let is_route_macro = method.is_none();
if let Some(method) = method {
methods.insert(method);
@@ -121,7 +128,7 @@ impl Args {
}
} else if nv.path.is_ident("guard") {
if let syn::Lit::Str(lit) = nv.lit {
- guards.push(Ident::new(&lit.value(), Span::call_site()));
+ guards.push(lit.parse::()?);
} else {
return Err(syn::Error::new_spanned(
nv.lit,
@@ -183,55 +190,27 @@ impl Args {
}
pub struct Route {
+ /// Name of the handler function being annotated.
name: syn::Ident,
- args: Args,
+
+ /// Args passed to routing macro.
+ ///
+ /// When using `#[routes]`, this will contain args for each specific routing macro.
+ args: Vec,
+
+ /// AST of the handler function being annotated.
ast: syn::ItemFn,
- resource_type: ResourceType,
/// The doc comment attributes to copy to generated struct, if any.
doc_attributes: Vec,
}
-fn guess_resource_type(typ: &syn::Type) -> ResourceType {
- let mut guess = ResourceType::Sync;
-
- if let syn::Type::ImplTrait(typ) = typ {
- for bound in typ.bounds.iter() {
- if let syn::TypeParamBound::Trait(bound) = bound {
- for bound in bound.path.segments.iter() {
- if bound.ident == "Future" {
- guess = ResourceType::Async;
- break;
- } else if bound.ident == "Responder" {
- guess = ResourceType::Sync;
- break;
- }
- }
- }
- }
- }
-
- guess
-}
-
impl Route {
pub fn new(
args: AttributeArgs,
ast: syn::ItemFn,
method: Option,
) -> syn::Result {
- if args.is_empty() {
- return Err(syn::Error::new(
- Span::call_site(),
- format!(
- r#"invalid service definition, expected #[{}("")]"#,
- method
- .map_or("route", |it| it.as_str())
- .to_ascii_lowercase()
- ),
- ));
- }
-
let name = ast.sig.ident.clone();
// Try and pull out the doc comments so that we can reapply them to the generated struct.
@@ -244,6 +223,7 @@ impl Route {
.collect();
let args = Args::new(args, method)?;
+
if args.methods.is_empty() {
return Err(syn::Error::new(
Span::call_site(),
@@ -251,25 +231,44 @@ impl Route {
));
}
- let resource_type = if ast.sig.asyncness.is_some() {
- ResourceType::Async
- } else {
- match ast.sig.output {
- syn::ReturnType::Default => {
- return Err(syn::Error::new_spanned(
- ast,
- "Function has no return type. Cannot be used as handler",
- ));
- }
- syn::ReturnType::Type(_, ref typ) => guess_resource_type(typ.as_ref()),
- }
- };
+ if matches!(ast.sig.output, syn::ReturnType::Default) {
+ return Err(syn::Error::new_spanned(
+ ast,
+ "Function has no return type. Cannot be used as handler",
+ ));
+ }
+
+ Ok(Self {
+ name,
+ args: vec![args],
+ ast,
+ doc_attributes,
+ })
+ }
+
+ fn multiple(args: Vec, ast: syn::ItemFn) -> syn::Result {
+ let name = ast.sig.ident.clone();
+
+ // Try and pull out the doc comments so that we can reapply them to the generated struct.
+ // Note that multi line doc comments are converted to multiple doc attributes.
+ let doc_attributes = ast
+ .attrs
+ .iter()
+ .filter(|attr| attr.path.is_ident("doc"))
+ .cloned()
+ .collect();
+
+ if matches!(ast.sig.output, syn::ReturnType::Default) {
+ return Err(syn::Error::new_spanned(
+ ast,
+ "Function has no return type. Cannot be used as handler",
+ ));
+ }
Ok(Self {
name,
args,
ast,
- resource_type,
doc_attributes,
})
}
@@ -280,38 +279,57 @@ impl ToTokens for Route {
let Self {
name,
ast,
- args:
- Args {
+ args,
+ doc_attributes,
+ } = self;
+
+ let registrations: TokenStream2 = args
+ .iter()
+ .map(|args| {
+ let Args {
path,
resource_name,
guards,
wrappers,
methods,
- },
- resource_type,
- doc_attributes,
- } = self;
- let resource_name = resource_name
- .as_ref()
- .map_or_else(|| name.to_string(), LitStr::value);
- let method_guards = {
- let mut others = methods.iter();
- // unwrapping since length is checked to be at least one
- let first = others.next().unwrap();
+ } = args;
+
+ let resource_name = resource_name
+ .as_ref()
+ .map_or_else(|| name.to_string(), LitStr::value);
+
+ let method_guards = {
+ let mut others = methods.iter();
+
+ // unwrapping since length is checked to be at least one
+ let first = others.next().unwrap();
+
+ if methods.len() > 1 {
+ quote! {
+ .guard(
+ ::actix_web::guard::Any(::actix_web::guard::#first())
+ #(.or(::actix_web::guard::#others()))*
+ )
+ }
+ } else {
+ quote! {
+ .guard(::actix_web::guard::#first())
+ }
+ }
+ };
- if methods.len() > 1 {
quote! {
- .guard(
- ::actix_web::guard::Any(::actix_web::guard::#first())
- #(.or(::actix_web::guard::#others()))*
- )
+ let __resource = ::actix_web::Resource::new(#path)
+ .name(#resource_name)
+ #method_guards
+ #(.guard(::actix_web::guard::fn_guard(#guards)))*
+ #(.wrap(#wrappers))*
+ .to(#name);
+
+ ::actix_web::dev::HttpServiceFactory::register(__resource, __config);
}
- } else {
- quote! {
- .guard(::actix_web::guard::#first())
- }
- }
- };
+ })
+ .collect();
let stream = quote! {
#(#doc_attributes)*
@@ -321,14 +339,7 @@ impl ToTokens for Route {
impl ::actix_web::dev::HttpServiceFactory for #name {
fn register(self, __config: &mut actix_web::dev::AppService) {
#ast
- let __resource = ::actix_web::Resource::new(#path)
- .name(#resource_name)
- #method_guards
- #(.guard(::actix_web::guard::fn_guard(#guards)))*
- #(.wrap(#wrappers))*
- .#resource_type(#name);
-
- ::actix_web::dev::HttpServiceFactory::register(__resource, __config)
+ #registrations
}
}
};
@@ -357,6 +368,57 @@ pub(crate) fn with_method(
}
}
+pub(crate) fn with_methods(input: TokenStream) -> TokenStream {
+ let mut ast = match syn::parse::(input.clone()) {
+ Ok(ast) => ast,
+ // on parse error, make IDEs happy; see fn docs
+ Err(err) => return input_and_compile_error(input, err),
+ };
+
+ let (methods, others) = ast
+ .attrs
+ .into_iter()
+ .map(|attr| match MethodType::from_path(&attr.path) {
+ Ok(method) => Ok((method, attr)),
+ Err(_) => Err(attr),
+ })
+ .partition::, _>(Result::is_ok);
+
+ ast.attrs = others.into_iter().map(Result::unwrap_err).collect();
+
+ let methods =
+ match methods
+ .into_iter()
+ .map(Result::unwrap)
+ .map(|(method, attr)| {
+ attr.parse_meta().and_then(|args| {
+ if let Meta::List(args) = args {
+ Args::new(args.nested.into_iter().collect(), Some(method))
+ } else {
+ Err(syn::Error::new_spanned(attr, "Invalid input for macro"))
+ }
+ })
+ })
+ .collect::, _>>()
+ {
+ Ok(methods) if methods.is_empty() => return input_and_compile_error(
+ input,
+ syn::Error::new(
+ Span::call_site(),
+ "The #[routes] macro requires at least one `#[(..)]` attribute.",
+ ),
+ ),
+ Ok(methods) => methods,
+ Err(err) => return input_and_compile_error(input, err),
+ };
+
+ match Route::multiple(methods, ast) {
+ Ok(route) => route.into_token_stream().into(),
+ // on macro related error, make IDEs happy; see fn docs
+ Err(err) => input_and_compile_error(input, err),
+ }
+}
+
/// Converts the error to a token stream and appends it to the original input.
///
/// Returning the original input in addition to the error is good for IDEs which can gracefully
diff --git a/actix-web-codegen/tests/test_macro.rs b/actix-web-codegen/tests/test_macro.rs
index 769cf2bc3..10e906967 100644
--- a/actix-web-codegen/tests/test_macro.rs
+++ b/actix-web-codegen/tests/test_macro.rs
@@ -8,9 +8,11 @@ use actix_web::{
header::{HeaderName, HeaderValue},
StatusCode,
},
- web, App, Error, HttpResponse, Responder,
+ web, App, Error, HttpRequest, HttpResponse, Responder,
+};
+use actix_web_codegen::{
+ connect, delete, get, head, options, patch, post, put, route, routes, trace,
};
-use actix_web_codegen::{connect, delete, get, head, options, patch, post, put, route, trace};
use futures_core::future::LocalBoxFuture;
// Make sure that we can name function as 'config'
@@ -89,13 +91,61 @@ async fn route_test() -> impl Responder {
HttpResponse::Ok()
}
+#[routes]
+#[get("/routes/test")]
+#[get("/routes/test2")]
+#[post("/routes/test")]
+async fn routes_test() -> impl Responder {
+ HttpResponse::Ok()
+}
+
+// routes overlap with the more specific route first, therefore accessible
+#[routes]
+#[get("/routes/overlap/test")]
+#[get("/routes/overlap/{foo}")]
+async fn routes_overlapping_test(req: HttpRequest) -> impl Responder {
+ // foo is only populated when route is not /routes/overlap/test
+ match req.match_info().get("foo") {
+ None => assert!(req.uri() == "/routes/overlap/test"),
+ Some(_) => assert!(req.uri() != "/routes/overlap/test"),
+ }
+
+ HttpResponse::Ok()
+}
+
+// routes overlap with the more specific route last, therefore inaccessible
+#[routes]
+#[get("/routes/overlap2/{foo}")]
+#[get("/routes/overlap2/test")]
+async fn routes_overlapping_inaccessible_test(req: HttpRequest) -> impl Responder {
+ // foo is always populated even when path is /routes/overlap2/test
+ assert!(req.match_info().get("foo").is_some());
+
+ HttpResponse::Ok()
+}
+
#[get("/custom_resource_name", name = "custom")]
-async fn custom_resource_name_test<'a>(req: actix_web::HttpRequest) -> impl Responder {
+async fn custom_resource_name_test<'a>(req: HttpRequest) -> impl Responder {
assert!(req.url_for_static("custom").is_ok());
assert!(req.url_for_static("custom_resource_name_test").is_err());
HttpResponse::Ok()
}
+mod guard_module {
+ use actix_web::{guard::GuardContext, http::header};
+
+ pub fn guard(ctx: &GuardContext) -> bool {
+ ctx.header::()
+ .map(|h| h.preference() == "image/*")
+ .unwrap_or(false)
+ }
+}
+
+#[get("/test/guard", guard = "guard_module::guard")]
+async fn guard_test() -> impl Responder {
+ HttpResponse::Ok()
+}
+
pub struct ChangeStatusCode;
impl Transform for ChangeStatusCode
@@ -186,7 +236,11 @@ async fn test_body() {
.service(patch_test)
.service(test_handler)
.service(route_test)
+ .service(routes_overlapping_test)
+ .service(routes_overlapping_inaccessible_test)
+ .service(routes_test)
.service(custom_resource_name_test)
+ .service(guard_test)
});
let request = srv.request(http::Method::GET, srv.url("/test"));
let response = request.send().await.unwrap();
@@ -242,9 +296,47 @@ async fn test_body() {
let response = request.send().await.unwrap();
assert!(!response.status().is_success());
+ let request = srv.request(http::Method::GET, srv.url("/routes/test"));
+ let response = request.send().await.unwrap();
+ assert!(response.status().is_success());
+
+ let request = srv.request(http::Method::GET, srv.url("/routes/test2"));
+ let response = request.send().await.unwrap();
+ assert!(response.status().is_success());
+
+ let request = srv.request(http::Method::POST, srv.url("/routes/test"));
+ let response = request.send().await.unwrap();
+ assert!(response.status().is_success());
+
+ let request = srv.request(http::Method::GET, srv.url("/routes/not-set"));
+ let response = request.send().await.unwrap();
+ assert!(response.status().is_client_error());
+
+ let request = srv.request(http::Method::GET, srv.url("/routes/overlap/test"));
+ let response = request.send().await.unwrap();
+ assert!(response.status().is_success());
+
+ let request = srv.request(http::Method::GET, srv.url("/routes/overlap/bar"));
+ let response = request.send().await.unwrap();
+ assert!(response.status().is_success());
+
+ let request = srv.request(http::Method::GET, srv.url("/routes/overlap2/test"));
+ let response = request.send().await.unwrap();
+ assert!(response.status().is_success());
+
+ let request = srv.request(http::Method::GET, srv.url("/routes/overlap2/bar"));
+ let response = request.send().await.unwrap();
+ assert!(response.status().is_success());
+
let request = srv.request(http::Method::GET, srv.url("/custom_resource_name"));
let response = request.send().await.unwrap();
assert!(response.status().is_success());
+
+ let request = srv
+ .request(http::Method::GET, srv.url("/test/guard"))
+ .insert_header(("Accept", "image/*"));
+ let response = request.send().await.unwrap();
+ assert!(response.status().is_success());
}
#[actix_rt::test]
diff --git a/actix-web-codegen/tests/trybuild.rs b/actix-web-codegen/tests/trybuild.rs
index b2d9ce186..26aec7d28 100644
--- a/actix-web-codegen/tests/trybuild.rs
+++ b/actix-web-codegen/tests/trybuild.rs
@@ -1,4 +1,4 @@
-#[rustversion::stable(1.54)] // MSRV
+#[rustversion::stable(1.59)] // MSRV
#[test]
fn compile_macros() {
let t = trybuild::TestCases::new();
@@ -12,6 +12,10 @@ fn compile_macros() {
t.compile_fail("tests/trybuild/route-unexpected-method-fail.rs");
t.compile_fail("tests/trybuild/route-malformed-path-fail.rs");
+ t.pass("tests/trybuild/routes-ok.rs");
+ t.compile_fail("tests/trybuild/routes-missing-method-fail.rs");
+ t.compile_fail("tests/trybuild/routes-missing-args-fail.rs");
+
t.pass("tests/trybuild/docstring-ok.rs");
t.pass("tests/trybuild/test-runtime.rs");
diff --git a/actix-web-codegen/tests/trybuild/route-duplicate-method-fail.stderr b/actix-web-codegen/tests/trybuild/route-duplicate-method-fail.stderr
index 90cff1b1c..7eac84f3e 100644
--- a/actix-web-codegen/tests/trybuild/route-duplicate-method-fail.stderr
+++ b/actix-web-codegen/tests/trybuild/route-duplicate-method-fail.stderr
@@ -1,11 +1,19 @@
error: HTTP method defined more than once: `GET`
- --> $DIR/route-duplicate-method-fail.rs:3:35
+ --> tests/trybuild/route-duplicate-method-fail.rs:3:35
|
3 | #[route("/", method="GET", method="GET")]
| ^^^^^
-error[E0277]: the trait bound `fn() -> impl std::future::Future {index}: HttpServiceFactory` is not satisfied
- --> $DIR/route-duplicate-method-fail.rs:12:55
- |
-12 | let srv = actix_test::start(|| App::new().service(index));
- | ^^^^^ the trait `HttpServiceFactory` is not implemented for `fn() -> impl std::future::Future {index}`
+error[E0277]: the trait bound `fn() -> impl std::future::Future