Create a saphir_cli command line utility for saphir, and add to it the doc-gen function for generating openapi v3 documentation automatically from a saphir project using #[controller] macros.

Description The following simple code snippet fails on compilation when trying to use saphir 2.8.0 alongside with tokio 0.3.4

use saphir::server::Server;
use tokio::runtime::Runtime;

fn main() {
    let server = Server::builder().build();
    tokio::spawn(server.run());
}

[package]
name = "saphir-test"
version = "0.1.0"
edition = "2018"

[dependencies]
tokio = { version = "=0.3.4", features = [ "rt" ]}
saphir = "=2.8"

This code fails due to the following error:

error[E0277]: `(dyn Future<Output = ()> + Unpin + 'static)` cannot be sent between threads safely
   --> src\main.rs:6:5
    |
6   |     tokio::spawn(server.run());
    |     ^^^^^^^^^^^^ `(dyn Future<Output = ()> + Unpin + 'static)` cannot be sent between threads safely
    | 
   ::: C:\Users\pacmancoder\.cargo\registry\src\github.com-1ecc6299db9ec823\tokio-0.3.4\src\task\spawn.rs:128:21
    |
128 |         T: Future + Send + 'static,
    |                     ---- required by this bound in `tokio::spawn`
    |
    = help: the trait `Send` is not implemented for `(dyn Future<Output = ()> + Unpin + 'static)`
    = note: required because of the requirements on the impl of `Send` for `Unique<(dyn Future<Output = ()> + Unpin + 'static)>`
    = note: required because it appears within the type `Box<(dyn Future<Output = ()> + Unpin + 'static)>`
    = note: required because it appears within the type `Pin<Box<(dyn Future<Output = ()> + Unpin + 'static)>>`
    = note: required because it appears within the type `saphir::server::ServerShutdown`
    = note: required because it appears within the type `for<'r, 's, 't0, 't1, 't2, 't3, 't4, 't5, 't6, 't7, 't8, 't9, 't10, 't11, 't12, 't13, 't14, 't15, 't16, 't17, 't18, 't19, 't20, 't21, 't22, 't23, 't24, 't25, 't26, 't27, 't28, 't29, 't30, 't31, 't32, 't33, 't34, 't35, 't36, 't37, 't38, 't39, 't40, 't41, 't42, 't43, 't44, 't45, 't46, 't47, 't48, 't49, 't50, 't51, 't52, 't53, 't54, 't55, 't56, 't57, 't58> {ResumeTy, saphir::server::Server, ListenerConfig, saphir::server::Stack, HeaderValue, Option<usize>, &'r saphir::server::Stack, saphir::hyper::server::conn::Http, &'s String, String, impl Future, (), tokio::net::tcp::listener::TcpListener, SocketAddr, tokio::net::tcp::incoming::Incoming<'t0>, saphir::server::ServerShutdown, Arc<saphir::server::SeverShutdownState>, Option<u64>, u64, futures_util::stream::stream::for_each_concurrent::ForEachConcurrent<tokio::net::tcp::incoming::Incoming<'t1>, impl Future, [closure@saphir::server::Server::run::{closure#0}::{closure#1}]>, saphir::server::ServerFuture<futures_util::stream::stream::for_each_concurrent::ForEachConcurrent<tokio::net::tcp::incoming::Incoming<'t17>, impl Future, [closure@saphir::server::Server::run::{closure#0}::{closure#1}]>, saphir::server::ServerShutdown>, futures_util::stream::stream::for_each_concurrent::ForEachConcurrent<tokio::net::tcp::incoming::Incoming<'t33>, impl Future, [closure@saphir::server::Server::run::{closure#0}::{closure#2}]>, saphir::server::ServerFuture<futures_util::stream::stream::for_each_concurrent::ForEachConcurrent<tokio::net::tcp::incoming::Incoming<'t46>, impl Future, [closure@saphir::server::Server::run::{closure#0}::{closure#2}]>, saphir::server::ServerShutdown>}`
    = note: required because it appears within the type `[static generator@saphir::server::Server::run::{closure#0} for<'r, 's, 't0, 't1, 't2, 't3, 't4, 't5, 't6, 't7, 't8, 't9, 't10, 't11, 't12, 't13, 't14, 't15, 't16, 't17, 't18, 't19, 't20, 't21, 't22, 't23, 't24, 't25, 't26, 't27, 't28, 't29, 't30, 't31, 't32, 't33, 't34, 't35, 't36, 't37, 't38, 't39, 't40, 't41, 't42, 't43, 't44, 't45, 't46, 't47, 't48, 't49, 't50, 't51, 't52, 't53, 't54, 't55, 't56, 't57, 't58> {ResumeTy, saphir::server::Server, ListenerConfig, saphir::server::Stack, HeaderValue, Option<usize>, &'r saphir::server::Stack, saphir::hyper::server::conn::Http, &'s String, String, impl Future, (), tokio::net::tcp::listener::TcpListener, SocketAddr, tokio::net::tcp::incoming::Incoming<'t0>, saphir::server::ServerShutdown, Arc<saphir::server::SeverShutdownState>, Option<u64>, u64, futures_util::stream::stream::for_each_concurrent::ForEachConcurrent<tokio::net::tcp::incoming::Incoming<'t1>, impl Future, [closure@saphir::server::Server::run::{closure#0}::{closure#1}]>, saphir::server::ServerFuture<futures_util::stream::stream::for_each_concurrent::ForEachConcurrent<tokio::net::tcp::incoming::Incoming<'t17>, impl Future, [closure@saphir::server::Server::run::{closure#0}::{closure#1}]>, saphir::server::ServerShutdown>, futures_util::stream::stream::for_each_concurrent::ForEachConcurrent<tokio::net::tcp::incoming::Incoming<'t33>, impl Future, [closure@saphir::server::Server::run::{closure#0}::{closure#2}]>, saphir::server::ServerFuture<futures_util::stream::stream::for_each_concurrent::ForEachConcurrent<tokio::net::tcp::incoming::Incoming<'t46>, impl Future, [closure@saphir::server::Server::run::{closure#0}::{closure#2}]>, saphir::server::ServerShutdown>}]`
    = note: required because it appears within the type `from_generator::GenFuture<[static generator@saphir::server::Server::run::{closure#0} for<'r, 's, 't0, 't1, 't2, 't3, 't4, 't5, 't6, 't7, 't8, 't9, 't10, 't11, 't12, 't13, 't14, 't15, 't16, 't17, 't18, 't19, 't20, 't21, 't22, 't23, 't24, 't25, 't26, 't27, 't28, 't29, 't30, 't31, 't32, 't33, 't34, 't35, 't36, 't37, 't38, 't39, 't40, 't41, 't42, 't43, 't44, 't45, 't46, 't47, 't48, 't49, 't50, 't51, 't52, 't53, 't54, 't55, 't56, 't57, 't58> {ResumeTy, saphir::server::Server, ListenerConfig, saphir::server::Stack, HeaderValue, Option<usize>, &'r saphir::server::Stack, saphir::hyper::server::conn::Http, &'s String, String, impl Future, (), tokio::net::tcp::listener::TcpListener, SocketAddr, tokio::net::tcp::incoming::Incoming<'t0>, saphir::server::ServerShutdown, Arc<saphir::server::SeverShutdownState>, Option<u64>, u64, futures_util::stream::stream::for_each_concurrent::ForEachConcurrent<tokio::net::tcp::incoming::Incoming<'t1>, impl Future, [closure@saphir::server::Server::run::{closure#0}::{closure#1}]>, saphir::server::ServerFuture<futures_util::stream::stream::for_each_concurrent::ForEachConcurrent<tokio::net::tcp::incoming::Incoming<'t17>, impl Future, [closure@saphir::server::Server::run::{closure#0}::{closure#1}]>, saphir::server::ServerShutdown>, futures_util::stream::stream::for_each_concurrent::ForEachConcurrent<tokio::net::tcp::incoming::Incoming<'t33>, impl Future, [closure@saphir::server::Server::run::{closure#0}::{closure#2}]>, saphir::server::ServerFuture<futures_util::stream::stream::for_each_concurrent::ForEachConcurrent<tokio::net::tcp::incoming::Incoming<'t46>, impl Future, [closure@saphir::server::Server::run::{closure#0}::{closure#2}]>, saphir::server::ServerShutdown>}]>`
    = note: required because it appears within the type `impl Future`
    = note: required because it appears within the type `impl Future`

error: aborting due to previous error; 1 warning emitted

However, on version 2.7.7 of saphir everything works as expected.

Expected behavior The provided snippet can be run with saphir 2.8.0 the same way it works with saphir 2.7.7

Additional info (please complete the following information):

• OS & OS Version: Windows 10 rev.2004
• Saphir Version: 2.8.0
• Rust toolchain & version: stable 1.48

the request tracing is integrated into the handler code instead of as a middleware to be able to wrap the FileMiddleware log span within the request span regardless of middleware order.

This PR also fix controller macro's handler span so that tracing span within the macro output have proper line numbers, instead of pointing to the top #[controller] macro.

Description A clear and concise description of what the bug is. saphir v2.6.7 error[E0277]: the trait bound hyper::body::body::Body: std::convert::From<std::boxed::Box<dyn futures_core::stream::Stream<Item = std::result::Result<bytes::bytes::Bytes, std::boxed::Box<dyn std::error::Error + std::marker::Send + std::marker::Sync>>> + std::marker::Send + std::marker::Sync>> is not satisfied --> /home/guoyibin3/.cargo/registry/src/github.com-1ecc6299db9ec823/saphir-2.6.7/src/response.rs:374:18 | 374 | self.body(Box::new(file.into()) | ^^^^ the trait std::convert::From<std::boxed::Box<dyn futures_core::stream::Stream<Item = std::result::Result<bytes::bytes::Bytes, std::boxed::Box<dyn std::error::Error + std::marker::Send + std::marker::Sync>>> + std::marker::Send + std::marker::Sync>> is not implemented for hyper::body::body::Body | = help: the following implementations were found: <hyper::body::body::Body as std::convert::From<&'static [u8]>> <hyper::body::body::Body as std::convert::From<&'static str>> <hyper::body::body::Body as std::convert::Frombytes::bytes::Bytes> <hyper::body::body::Body as std::convert::From<std::borrow::Cow<'static, [u8]>>> and 4 others = note: required because of the requirements on the impl of std::convert::Into<hyper::body::body::Body> for std::boxed::Box<dyn futures_core::stream::Stream<Item = std::result::Result<bytes::bytes::Bytes, std::boxed::Box<dyn std::error::Error + std::marker::Send + std::marker::Sync>>> + std::marker::Send + std::marker::Sync>

error: aborting due to previous error

For more information about this error, try rustc --explain E0277. error: could not compile saphir. Expected behavior A clear and concise description of what you expected to happen.

Additional info (please complete the following information):

• OS & OS Version: [ubuntu 20]
• Saphir Version [2.0.0]
• Rust toolchain & version [1.43.1 (8d69840ab 2020-05-04) ]

Removed nom and changed the multipart implementation to use multer instead of updating our legacy nom 5.0 parser.

@richerarc multer was used instead of the multipart lib we talked about because multipart is in maintenance mode for old sync hyper versions, but doesn't support newer async APIs. The async variant in the crate multipart-async aimed to support newer Hyper versions is a work-in-progress and is not stable yet.

Meanwhile, the multer crate integration works well (our old example still works well, I took care to maintain the same API surface) and I additionally tested in a separate test project + Insomnia. Also, multer seems to be maintained by the author of rocket.rs

I also added a cargo-deny configuration to lint the dependancies; I updated all our dependancies to pass the advisories check.

Updates the requirements on uuid to permit the latest version.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Added an optional feature flag to automatically validate request Json/Form payloads with the https://github.com/Keats/validator crate.

The macro is not re-exported through saphir because of path resolution issue in the resulting generated code (I had a long discussion with some macro experts on the official rust discord and ended up to the conclusion that it isn't feasible without adding some significant changes inside the validator crate itself, which wouldn't be welcome by them).

So, the usage is to import the crate in the project which is using saphir, implement validators as per the validator crate documentation, and add the saphir feature flag validate-requests to cause saphir's macro generation to generate validation code using the Validator trait. This flag is an optional flag not included in the full flag.

The feature flag by default enable validation on all Json/Form request parameters. This will trigger compile error if any request payload is added without proper validation. A new macro attribute was added, #[validator(...), which for now allow to exclude validation on specific parameter by using the parameter name. For example:

#[post("/")]
#[validator(excude(req))]
async fn my_route(&self, req: Json<RoutePayload>) -> Result<(), MyError> {
   //...
}

The exclude attribute take a comma-separated list of parameter names to be excluded.

@LucFauvel please review this.

Updates the requirements on serde_yaml to permit the latest version.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Updates the requirements on uuid to permit the latest version.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Updates the requirements on uuid to permit the latest version.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Updates the requirements on rustls-pemfile to permit the latest version.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Hello, @richerarc

I would like to know, if I can upgrade the Http request to websocket? Also, I would like to know if the framework could work with pool of threads to handle those connections ? And, I’m new in rust, so if there is any example how to handle the questions above, I would appreciated Thanks you so much

Description of the feature To improve performance, instead of using dynamic dispatch at runtime, in Server::build we could create a fixed list pointers to all registered handlers, which could be iterated through without having to use any dyn_handle.

Is your feature request related to a problem? Not related to a problem, just a performance improvement

route positional paameters name are arbitrarly, so they could be changed to a prefered casing for the api generation. For example, changing them to camelCase so that when you generate a typescript API for it with ng-openapi-gen, you would have parameters name in the same casing as the rest of your codebase.