mirror of
https://github.com/actix/actix-extras.git
synced 2025-04-22 01:46:50 +02:00
Compare commits
No commits in common. "master" and "protobuf-v0.11.0" have entirely different histories.
master
...
protobuf-v
17
.github/workflows/ci-post-merge.yml
vendored
17
.github/workflows/ci-post-merge.yml
vendored
@ -31,12 +31,12 @@ jobs:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Install Rust (nightly)
|
||||
uses: actions-rust-lang/setup-rust-toolchain@v1.11.0
|
||||
uses: actions-rust-lang/setup-rust-toolchain@v1.9.0
|
||||
with:
|
||||
toolchain: nightly
|
||||
|
||||
- name: Install cargo-hack, cargo-ci-cache-clean
|
||||
uses: taiki-e/install-action@v2.49.42
|
||||
uses: taiki-e/install-action@v2.41.7
|
||||
with:
|
||||
tool: cargo-hack,cargo-ci-cache-clean
|
||||
|
||||
@ -71,22 +71,13 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Install OpenSSL
|
||||
if: matrix.target.os == 'windows-latest'
|
||||
shell: bash
|
||||
run: |
|
||||
set -e
|
||||
choco install openssl --version=1.1.1.2100 -y --no-progress
|
||||
echo 'OPENSSL_DIR=C:\Program Files\OpenSSL' >> $GITHUB_ENV
|
||||
echo "RUSTFLAGS=-C target-feature=+crt-static" >> $GITHUB_ENV
|
||||
|
||||
- name: Install Rust (nightly)
|
||||
uses: actions-rust-lang/setup-rust-toolchain@v1.11.0
|
||||
uses: actions-rust-lang/setup-rust-toolchain@v1.9.0
|
||||
with:
|
||||
toolchain: nightly
|
||||
|
||||
- name: Install cargo-hack and cargo-ci-cache-clean
|
||||
uses: taiki-e/install-action@v2.49.42
|
||||
uses: taiki-e/install-action@v2.41.7
|
||||
with:
|
||||
tool: cargo-hack,cargo-ci-cache-clean
|
||||
|
||||
|
||||
43
.github/workflows/ci.yml
vendored
43
.github/workflows/ci.yml
vendored
@ -44,18 +44,19 @@ jobs:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Install Rust (${{ matrix.version.name }})
|
||||
uses: actions-rust-lang/setup-rust-toolchain@v1.11.0
|
||||
uses: actions-rust-lang/setup-rust-toolchain@v1.9.0
|
||||
with:
|
||||
toolchain: ${{ matrix.version.version }}
|
||||
|
||||
- name: Install cargo-hack and cargo-ci-cache-clean, just
|
||||
uses: taiki-e/install-action@v2.49.42
|
||||
- name: Install cargo-hack and cargo-ci-cache-clean
|
||||
uses: taiki-e/install-action@v2.41.7
|
||||
with:
|
||||
tool: cargo-hack,cargo-ci-cache-clean,just
|
||||
tool: cargo-hack,cargo-ci-cache-clean
|
||||
|
||||
- name: workaround MSRV issues
|
||||
if: matrix.version.name == 'msrv'
|
||||
run: just downgrade-for-msrv
|
||||
# - name: workaround MSRV issues
|
||||
# if: matrix.version.name == 'msrv'
|
||||
# run: |
|
||||
# cargo update -p=time:0.3.20 --precise=0.3.16
|
||||
|
||||
- name: check minimal
|
||||
run: cargo ci-min
|
||||
@ -91,28 +92,20 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Install OpenSSL
|
||||
if: matrix.target.os == 'windows-latest'
|
||||
shell: bash
|
||||
run: |
|
||||
set -e
|
||||
choco install openssl --version=1.1.1.2100 -y --no-progress
|
||||
echo 'OPENSSL_DIR=C:\Program Files\OpenSSL' >> $GITHUB_ENV
|
||||
echo "RUSTFLAGS=-C target-feature=+crt-static" >> $GITHUB_ENV
|
||||
|
||||
- name: Install Rust (${{ matrix.version.name }})
|
||||
uses: actions-rust-lang/setup-rust-toolchain@v1.11.0
|
||||
uses: actions-rust-lang/setup-rust-toolchain@v1.9.0
|
||||
with:
|
||||
toolchain: ${{ matrix.version.version }}
|
||||
|
||||
- name: Install cargo-hack, cargo-ci-cache-clean, just
|
||||
uses: taiki-e/install-action@v2.49.42
|
||||
- name: Install cargo-hack, cargo-ci-cache-clean
|
||||
uses: taiki-e/install-action@v2.41.7
|
||||
with:
|
||||
tool: cargo-hack,cargo-ci-cache-clean,just
|
||||
tool: cargo-hack,cargo-ci-cache-clean
|
||||
|
||||
- name: workaround MSRV issues
|
||||
if: matrix.version.name == 'msrv'
|
||||
run: just downgrade-for-msrv
|
||||
# - name: workaround MSRV issues
|
||||
# if: matrix.version.name == 'msrv'
|
||||
# run: |
|
||||
# cargo update -p=time:0.3.20 --precise=0.3.16
|
||||
|
||||
- name: check minimal
|
||||
run: cargo ci-min
|
||||
@ -137,12 +130,12 @@ jobs:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Install Rust (nightly)
|
||||
uses: actions-rust-lang/setup-rust-toolchain@v1.11.0
|
||||
uses: actions-rust-lang/setup-rust-toolchain@v1.9.0
|
||||
with:
|
||||
toolchain: nightly
|
||||
|
||||
- name: Install just
|
||||
uses: taiki-e/install-action@v2.49.42
|
||||
uses: taiki-e/install-action@v2.41.7
|
||||
with:
|
||||
tool: just
|
||||
|
||||
|
||||
6
.github/workflows/coverage.yml
vendored
6
.github/workflows/coverage.yml
vendored
@ -25,13 +25,13 @@ jobs:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Install Rust
|
||||
uses: actions-rust-lang/setup-rust-toolchain@v1.11.0
|
||||
uses: actions-rust-lang/setup-rust-toolchain@v1.9.0
|
||||
with:
|
||||
toolchain: nightly
|
||||
components: llvm-tools-preview
|
||||
|
||||
- name: Install just, cargo-llvm-cov, cargo-nextest
|
||||
uses: taiki-e/install-action@v2.49.42
|
||||
uses: taiki-e/install-action@v2.41.7
|
||||
with:
|
||||
tool: just,cargo-llvm-cov,cargo-nextest
|
||||
|
||||
@ -39,7 +39,7 @@ jobs:
|
||||
run: just test-coverage-codecov
|
||||
|
||||
- name: Upload to Codecov
|
||||
uses: codecov/codecov-action@v5.4.0
|
||||
uses: codecov/codecov-action@v4.5.0
|
||||
with:
|
||||
files: codecov.json
|
||||
fail_ci_if_error: true
|
||||
|
||||
33
.github/workflows/lint.yml
vendored
33
.github/workflows/lint.yml
vendored
@ -16,7 +16,7 @@ jobs:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Install Rust (nightly)
|
||||
uses: actions-rust-lang/setup-rust-toolchain@v1.11.0
|
||||
uses: actions-rust-lang/setup-rust-toolchain@v1.9.0
|
||||
with:
|
||||
toolchain: nightly
|
||||
components: rustfmt
|
||||
@ -34,7 +34,7 @@ jobs:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Install Rust
|
||||
uses: actions-rust-lang/setup-rust-toolchain@v1.11.0
|
||||
uses: actions-rust-lang/setup-rust-toolchain@v1.9.0
|
||||
with:
|
||||
components: clippy
|
||||
|
||||
@ -46,3 +46,32 @@ jobs:
|
||||
clippy_flags: >-
|
||||
--workspace --all-features --tests --examples --bins --
|
||||
-A unknown_lints -D clippy::todo -D clippy::dbg_macro
|
||||
|
||||
public-api-diff:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: checkout ${{ github.base_ref }}
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.base_ref }}
|
||||
|
||||
- name: checkout ${{ github.head_ref }}
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Install Rust (nightly)
|
||||
uses: actions-rust-lang/setup-rust-toolchain@v1.9.0
|
||||
with:
|
||||
toolchain: nightly
|
||||
|
||||
- name: Install cargo-public-api
|
||||
uses: taiki-e/cache-cargo-install-action@v2.0.1
|
||||
with:
|
||||
tool: cargo-public-api
|
||||
|
||||
- name: generate API diff
|
||||
run: |
|
||||
for f in $(find -mindepth 2 -maxdepth 2 -name Cargo.toml); do
|
||||
|
||||
cargo public-api --manifest-path "$f" --all-features diff ${{ github.event.pull_request.base.sha }}..${{ github.sha }} >> /tmp/diff.txt
|
||||
done
|
||||
cat /tmp/diff.txt
|
||||
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@ -1,5 +1,6 @@
|
||||
/target
|
||||
**/*.rs.bk
|
||||
Cargo.lock
|
||||
|
||||
guide/build/
|
||||
/gh-pages
|
||||
|
||||
3292
Cargo.lock
generated
3292
Cargo.lock
generated
File diff suppressed because it is too large
Load Diff
20
README.md
20
README.md
@ -33,7 +33,8 @@ These crates are provided by the community.
|
||||
| Crate | | |
|
||||
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| [actix-web-lab] | [][actix-web-lab] [](https://deps.rs/crate/actix-web-lab) | Experimental extractors, middleware, and other extras for possible inclusion in Actix Web. |
|
||||
| [actix-form-data] | [][actix-form-data] [](https://deps.rs/crate/actix-form-data) | Multipart form data from actix multipart streams. |
|
||||
| [actix-multipart-extract] | [][actix-multipart-extract] [](https://deps.rs/crate/actix-multipart-extract) | Better multipart form support for Actix Web. |
|
||||
| [actix-form-data] | [][actix-form-data] [](https://deps.rs/crate/actix-form-data) | Multipart form data from actix multipart streams |
|
||||
| [actix-governor] | [][actix-governor] [](https://deps.rs/crate/actix-governor) | Rate-limiting backed by governor. |
|
||||
| [actix-casbin] | [][actix-casbin] [](https://deps.rs/crate/actix-casbin) | Authorization library that supports access control models like ACL, RBAC & ABAC. |
|
||||
| [actix-ip-filter] | [][actix-ip-filter] [](https://deps.rs/crate/actix-ip-filter) | IP address filter. Supports glob patterns. |
|
||||
@ -44,13 +45,10 @@ These crates are provided by the community.
|
||||
| [awmp] | [][awmp] [](https://deps.rs/crate/awmp) | An easy to use wrapper around multipart fields for Actix Web. |
|
||||
| [tracing-actix-web] | [][tracing-actix-web] [](https://deps.rs/crate/tracing-actix-web) | A middleware to collect telemetry data from applications built on top of the Actix Web framework. |
|
||||
| [actix-hash] | [][actix-hash] [](https://deps.rs/crate/actix-hash) | Hashing utilities for Actix Web. |
|
||||
| [actix-bincode] |  [](https://deps.rs/crate/actix-bincode) | Bincode payload extractor for Actix Web. |
|
||||
| [sentinel-actix] |  [](https://deps.rs/crate/sentinel-actix) | General and flexible protection for Actix Web. |
|
||||
| [actix-bincode] |  [](https://deps.rs/crate/actix-bincode) | Bincode payload extractor for Actix Web |
|
||||
| [sentinel-actix] |  [](https://deps.rs/crate/sentinel-actix) | General and flexible protection for Actix Web |
|
||||
| [actix-telepathy] |  [](https://deps.rs/crate/actix-telepathy) | Build distributed applications with `RemoteActors` and `RemoteMessages`. |
|
||||
| [apistos] |  [](https://deps.rs/crate/apistos) | Automatic OpenAPI v3 documentation for Actix Web. |
|
||||
| [actix-web-validation] |  [](https://deps.rs/crate/actix-web-validation) | Request validation for Actix Web. |
|
||||
| [actix-jwt-cookies] |  [](https://deps.rs/repo/github/Necoo33/actix-jwt-cookies?path=%2F) | Store your data in encrypted cookies and get it elegantly. |
|
||||
| [actix-ws-broadcaster] |  [](https://deps.rs/repo/github/Necoo33/actix-ws-broadcaster?path=%2F) | A broadcaster library for actix-ws that includes grouping and conditional broadcasting. |
|
||||
| [apistos] |  [](https://deps.rs/crate/apistos) | Automatic OpenAPI v3 documentation for Actix Web |
|
||||
|
||||
To add a crate to this list, submit a pull request.
|
||||
|
||||
@ -82,9 +80,5 @@ To add a crate to this list, submit a pull request.
|
||||
[actix-hash]: https://crates.io/crates/actix-hash
|
||||
[actix-bincode]: https://crates.io/crates/actix-bincode
|
||||
[sentinel-actix]: https://crates.io/crates/sentinel-actix
|
||||
[actix-telepathy]: https://crates.io/crates/actix-telepathy
|
||||
[actix-web-validation]: https://crates.io/crates/actix-web-validation
|
||||
[actix-telepathy]: https://crates.io/crates/actix-telepathy
|
||||
[apistos]: https://crates.io/crates/apistos
|
||||
[actix-jwt-cookies]: https://crates.io/crates/actix-jwt-cookies
|
||||
[actix-ws-broadcaster]: https://crates.io/crates/actix-ws-broadcaster
|
||||
[actix-telepathy]: https://github.com/wenig/actix-telepathy
|
||||
[apistos]: https://github.com/netwo-io/apistos
|
||||
|
||||
@ -2,10 +2,6 @@
|
||||
|
||||
## Unreleased
|
||||
|
||||
## 0.7.1
|
||||
|
||||
- Implement `PartialEq` for `Cors` allowing for better testing.
|
||||
|
||||
## 0.7.0
|
||||
|
||||
- `Cors` is now marked `#[must_use]`.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "actix-cors"
|
||||
version = "0.7.1"
|
||||
version = "0.7.0"
|
||||
authors = [
|
||||
"Nikolay Kim <fafhrd91@gmail.com>",
|
||||
"Rob Ede <robjtede@icloud.com>",
|
||||
@ -24,7 +24,7 @@ draft-private-network-access = []
|
||||
actix-utils = "3"
|
||||
actix-web = { version = "4", default-features = false }
|
||||
|
||||
derive_more = { version = "2", features = ["display", "error"] }
|
||||
derive_more = "0.99.7"
|
||||
futures-util = { version = "0.3.17", default-features = false, features = ["std"] }
|
||||
log = "0.4"
|
||||
once_cell = "1"
|
||||
|
||||
@ -3,11 +3,11 @@
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
[](https://crates.io/crates/actix-cors)
|
||||
[](https://docs.rs/actix-cors/0.7.1)
|
||||
[](https://docs.rs/actix-cors/0.7.0)
|
||||
|
||||
|
||||
<br />
|
||||
[](https://deps.rs/crate/actix-cors/0.7.1)
|
||||
[](https://deps.rs/crate/actix-cors/0.7.0)
|
||||
[](https://crates.io/crates/actix-cors)
|
||||
[](https://discord.gg/NWpN5mmg3x)
|
||||
|
||||
|
||||
@ -608,19 +608,6 @@ where
|
||||
.unwrap()
|
||||
}
|
||||
|
||||
impl PartialEq for Cors {
|
||||
fn eq(&self, other: &Self) -> bool {
|
||||
self.inner == other.inner
|
||||
// Because of the cors-function, checking if the content is equal implies that the errors are equal
|
||||
//
|
||||
// Proof by contradiction:
|
||||
// Lets assume that the inner values are equal, but the error values are not.
|
||||
// This means there had been an error, which has been fixed.
|
||||
// This cannot happen as the first call to set the invalid value means that further usages of the cors-function will reject other input.
|
||||
// => inner has to be in a different state
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod test {
|
||||
use std::convert::Infallible;
|
||||
@ -692,11 +679,4 @@ mod test {
|
||||
|
||||
Cors::default().new_transform(srv).await.unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn impl_eq() {
|
||||
assert_eq!(Cors::default(), Cors::default());
|
||||
assert_ne!(Cors::default().send_wildcard(), Cors::default());
|
||||
assert_ne!(Cors::default(), Cors::permissive());
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,40 +1,40 @@
|
||||
use actix_web::{http::StatusCode, HttpResponse, ResponseError};
|
||||
use derive_more::derive::{Display, Error};
|
||||
use derive_more::{Display, Error};
|
||||
|
||||
/// Errors that can occur when processing CORS guarded requests.
|
||||
#[derive(Debug, Clone, Display, Error)]
|
||||
#[non_exhaustive]
|
||||
pub enum CorsError {
|
||||
/// Allowed origin argument must not be wildcard (`*`).
|
||||
#[display("`allowed_origin` argument must not be wildcard (`*`)")]
|
||||
#[display(fmt = "`allowed_origin` argument must not be wildcard (`*`)")]
|
||||
WildcardOrigin,
|
||||
|
||||
/// Request header `Origin` is required but was not provided.
|
||||
#[display("Request header `Origin` is required but was not provided")]
|
||||
#[display(fmt = "Request header `Origin` is required but was not provided")]
|
||||
MissingOrigin,
|
||||
|
||||
/// Request header `Access-Control-Request-Method` is required but is missing.
|
||||
#[display("Request header `Access-Control-Request-Method` is required but is missing")]
|
||||
#[display(fmt = "Request header `Access-Control-Request-Method` is required but is missing")]
|
||||
MissingRequestMethod,
|
||||
|
||||
/// Request header `Access-Control-Request-Method` has an invalid value.
|
||||
#[display("Request header `Access-Control-Request-Method` has an invalid value")]
|
||||
#[display(fmt = "Request header `Access-Control-Request-Method` has an invalid value")]
|
||||
BadRequestMethod,
|
||||
|
||||
/// Request header `Access-Control-Request-Headers` has an invalid value.
|
||||
#[display("Request header `Access-Control-Request-Headers` has an invalid value")]
|
||||
#[display(fmt = "Request header `Access-Control-Request-Headers` has an invalid value")]
|
||||
BadRequestHeaders,
|
||||
|
||||
/// Origin is not allowed to make this request.
|
||||
#[display("Origin is not allowed to make this request")]
|
||||
#[display(fmt = "Origin is not allowed to make this request")]
|
||||
OriginNotAllowed,
|
||||
|
||||
/// Request method is not allowed.
|
||||
#[display("Requested method is not allowed")]
|
||||
#[display(fmt = "Requested method is not allowed")]
|
||||
MethodNotAllowed,
|
||||
|
||||
/// One or more request headers are not allowed.
|
||||
#[display("One or more request headers are not allowed")]
|
||||
#[display(fmt = "One or more request headers are not allowed")]
|
||||
HeadersNotAllowed,
|
||||
}
|
||||
|
||||
|
||||
@ -27,12 +27,6 @@ impl Default for OriginFn {
|
||||
}
|
||||
}
|
||||
|
||||
impl PartialEq for OriginFn {
|
||||
fn eq(&self, other: &Self) -> bool {
|
||||
Rc::ptr_eq(&self.boxed_fn, &other.boxed_fn)
|
||||
}
|
||||
}
|
||||
|
||||
impl fmt::Debug for OriginFn {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
f.write_str("origin_fn")
|
||||
@ -46,7 +40,7 @@ pub(crate) fn header_value_try_into_method(hdr: &HeaderValue) -> Option<Method>
|
||||
.and_then(|meth| Method::try_from(meth).ok())
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq)]
|
||||
#[derive(Debug, Clone)]
|
||||
pub(crate) struct Inner {
|
||||
pub(crate) allowed_origins: AllOrSome<HashSet<HeaderValue>>,
|
||||
pub(crate) allowed_origins_fns: SmallVec<[OriginFn; 4]>,
|
||||
|
||||
@ -2,10 +2,6 @@
|
||||
|
||||
## Unreleased
|
||||
|
||||
## 0.8.0
|
||||
|
||||
- Update `actix-session` dependency to `0.10`.
|
||||
|
||||
## 0.7.1
|
||||
|
||||
- Add `IdentityMiddlewareBuilder::{id_key, last_visit_unix_timestamp_key, login_unix_timestamp_key}()` methods for customizing keys used in session. Defaults remain the same as before.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "actix-identity"
|
||||
version = "0.8.0"
|
||||
version = "0.7.1"
|
||||
authors = [
|
||||
"Nikolay Kim <fafhrd91@gmail.com>",
|
||||
"Luca Palmieri <rust@lpalmieri.com>",
|
||||
@ -19,11 +19,11 @@ all-features = true
|
||||
|
||||
[dependencies]
|
||||
actix-service = "2"
|
||||
actix-session = "0.10"
|
||||
actix-session = "0.9"
|
||||
actix-utils = "3"
|
||||
actix-web = { version = "4", default-features = false, features = ["cookies", "secure-cookies"] }
|
||||
|
||||
derive_more = { version = "2", features = ["display", "error", "from"] }
|
||||
derive_more = "0.99.7"
|
||||
futures-core = "0.3.17"
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
tracing = { version = "0.1.30", default-features = false, features = ["log"] }
|
||||
@ -31,10 +31,10 @@ tracing = { version = "0.1.30", default-features = false, features = ["log"] }
|
||||
[dev-dependencies]
|
||||
actix-http = "3"
|
||||
actix-web = { version = "4", default-features = false, features = ["macros", "cookies", "secure-cookies"] }
|
||||
actix-session = { version = "0.10", features = ["redis-session", "cookie-session"] }
|
||||
actix-session = { version = "0.9", features = ["redis-session", "cookie-session"] }
|
||||
|
||||
env_logger = "0.11"
|
||||
reqwest = { version = "0.12", default-features = false, features = ["cookies", "json"] }
|
||||
reqwest = { version = "0.11", default-features = false, features = ["cookies", "json"] }
|
||||
uuid = { version = "1", features = ["v4"] }
|
||||
|
||||
[lints]
|
||||
|
||||
@ -5,9 +5,9 @@
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
[](https://crates.io/crates/actix-identity)
|
||||
[](https://docs.rs/actix-identity/0.8.0)
|
||||
[](https://docs.rs/actix-identity/0.7.1)
|
||||
|
||||
[](https://deps.rs/crate/actix-identity/0.8.0)
|
||||
[](https://deps.rs/crate/actix-identity/0.7.1)
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
@ -83,10 +83,8 @@ async fn login(request: HttpRequest) -> impl Responder {
|
||||
}
|
||||
|
||||
#[post("/logout")]
|
||||
async fn logout(user: Option<Identity>) -> impl Responder {
|
||||
if let Some(user) = user {
|
||||
async fn logout(user: Identity) -> impl Responder {
|
||||
user.logout();
|
||||
}
|
||||
HttpResponse::Ok()
|
||||
}
|
||||
```
|
||||
|
||||
@ -13,10 +13,10 @@
|
||||
//! http -v --session=identity GET localhost:8080/
|
||||
//! ```
|
||||
|
||||
use std::{io, time::Duration};
|
||||
use std::io;
|
||||
|
||||
use actix_identity::{Identity, IdentityMiddleware};
|
||||
use actix_session::{config::PersistentSession, storage::CookieSessionStore, SessionMiddleware};
|
||||
use actix_session::{storage::CookieSessionStore, SessionMiddleware};
|
||||
use actix_web::{
|
||||
cookie::Key, get, middleware::Logger, post, App, HttpMessage, HttpRequest, HttpResponse,
|
||||
HttpServer, Responder,
|
||||
@ -28,25 +28,16 @@ async fn main() -> io::Result<()> {
|
||||
|
||||
let secret_key = Key::generate();
|
||||
|
||||
let expiration = Duration::from_secs(24 * 60 * 60);
|
||||
|
||||
HttpServer::new(move || {
|
||||
let session_mw =
|
||||
SessionMiddleware::builder(CookieSessionStore::default(), secret_key.clone())
|
||||
// disable secure cookie for local testing
|
||||
.cookie_secure(false)
|
||||
// Set a ttl for the cookie if the identity should live longer than the user session
|
||||
.session_lifecycle(
|
||||
PersistentSession::default().session_ttl(expiration.try_into().unwrap()),
|
||||
)
|
||||
.build();
|
||||
let identity_mw = IdentityMiddleware::builder()
|
||||
.visit_deadline(Some(expiration))
|
||||
.build();
|
||||
|
||||
App::new()
|
||||
// Install the identity framework first.
|
||||
.wrap(identity_mw)
|
||||
.wrap(IdentityMiddleware::default())
|
||||
// The identity system is built on top of sessions. You must install the session
|
||||
// middleware to leverage `actix-identity`. The session middleware must be mounted
|
||||
// AFTER the identity middleware: `actix-web` invokes middleware in the OPPOSITE
|
||||
|
||||
@ -2,11 +2,11 @@
|
||||
|
||||
use actix_session::{SessionGetError, SessionInsertError};
|
||||
use actix_web::{cookie::time::error::ComponentRange, http::StatusCode, ResponseError};
|
||||
use derive_more::derive::{Display, Error, From};
|
||||
use derive_more::{Display, Error, From};
|
||||
|
||||
/// Error that can occur during login attempts.
|
||||
#[derive(Debug, Display, Error, From)]
|
||||
#[display("{_0}")]
|
||||
#[display(fmt = "{_0}")]
|
||||
pub struct LoginError(SessionInsertError);
|
||||
|
||||
impl ResponseError for LoginError {
|
||||
@ -17,7 +17,7 @@ impl ResponseError for LoginError {
|
||||
|
||||
/// Error encountered when working with a session that has expired.
|
||||
#[derive(Debug, Display, Error)]
|
||||
#[display("The given session has expired and is no longer valid")]
|
||||
#[display(fmt = "The given session has expired and is no longer valid")]
|
||||
pub struct SessionExpiryError(#[error(not(source))] pub(crate) ComponentRange);
|
||||
|
||||
/// The identity information has been lost.
|
||||
@ -25,7 +25,7 @@ pub struct SessionExpiryError(#[error(not(source))] pub(crate) ComponentRange);
|
||||
/// Seeing this error in user code indicates a bug in actix-identity.
|
||||
#[derive(Debug, Display, Error)]
|
||||
#[display(
|
||||
"The identity information in the current session has disappeared after having been \
|
||||
fmt = "The identity information in the current session has disappeared after having been \
|
||||
successfully validated. This is likely to be a bug."
|
||||
)]
|
||||
#[non_exhaustive]
|
||||
@ -33,7 +33,7 @@ pub struct LostIdentityError;
|
||||
|
||||
/// There is no identity information attached to the current session.
|
||||
#[derive(Debug, Display, Error)]
|
||||
#[display("There is no identity information attached to the current session")]
|
||||
#[display(fmt = "There is no identity information attached to the current session")]
|
||||
#[non_exhaustive]
|
||||
pub struct MissingIdentityError;
|
||||
|
||||
@ -42,21 +42,21 @@ pub struct MissingIdentityError;
|
||||
#[non_exhaustive]
|
||||
pub enum GetIdentityError {
|
||||
/// The session has expired.
|
||||
#[display("{_0}")]
|
||||
#[display(fmt = "{_0}")]
|
||||
SessionExpiryError(SessionExpiryError),
|
||||
|
||||
/// No identity is found in a session.
|
||||
#[display("{_0}")]
|
||||
#[display(fmt = "{_0}")]
|
||||
MissingIdentityError(MissingIdentityError),
|
||||
|
||||
/// Failed to accessing the session store.
|
||||
#[display("{_0}")]
|
||||
#[display(fmt = "{_0}")]
|
||||
SessionGetError(SessionGetError),
|
||||
|
||||
/// Identity info was lost after being validated.
|
||||
///
|
||||
/// Seeing this error indicates a bug in actix-identity.
|
||||
#[display("{_0}")]
|
||||
#[display(fmt = "{_0}")]
|
||||
LostIdentityError(LostIdentityError),
|
||||
}
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ impl IdentityExt for ServiceRequest {
|
||||
}
|
||||
}
|
||||
|
||||
impl IdentityExt for GuardContext<'_> {
|
||||
impl<'a> IdentityExt for GuardContext<'a> {
|
||||
fn get_identity(&self) -> Result<Identity, GetIdentityError> {
|
||||
Identity::extract(&self.req_data())
|
||||
}
|
||||
|
||||
@ -74,10 +74,8 @@ async fn login(request: HttpRequest) -> impl Responder {
|
||||
}
|
||||
|
||||
#[post("/logout")]
|
||||
async fn logout(user: Option<Identity>) -> impl Responder {
|
||||
if let Some(user) = user {
|
||||
async fn logout(user: Identity) -> impl Responder {
|
||||
user.logout();
|
||||
}
|
||||
HttpResponse::Ok()
|
||||
}
|
||||
```
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
use std::time::Duration;
|
||||
|
||||
use actix_identity::{config::LogoutBehaviour, IdentityMiddleware};
|
||||
use reqwest::StatusCode;
|
||||
use actix_web::http::StatusCode;
|
||||
|
||||
use crate::{fixtures::user_id, test_app::TestApp};
|
||||
|
||||
|
||||
@ -2,9 +2,6 @@
|
||||
|
||||
## Unreleased
|
||||
|
||||
- Update `redis` dependency to `0.29`.
|
||||
- Update `actix-session` dependency to `0.9`.
|
||||
|
||||
## 0.5.1
|
||||
|
||||
- No significant changes since `0.5.0`.
|
||||
|
||||
@ -26,13 +26,13 @@ actix-utils = "3"
|
||||
actix-web = { version = "4", default-features = false, features = ["cookies"] }
|
||||
|
||||
chrono = "0.4"
|
||||
derive_more = { version = "2", features = ["display", "error", "from"] }
|
||||
derive_more = "0.99.7"
|
||||
log = "0.4"
|
||||
redis = { version = "0.29", default-features = false, features = ["tokio-comp"] }
|
||||
redis = { version = "0.25", default-features = false, features = ["tokio-comp"] }
|
||||
time = "0.3"
|
||||
|
||||
# session
|
||||
actix-session = { version = "0.10", optional = true }
|
||||
actix-session = { version = "0.9", optional = true }
|
||||
|
||||
[dev-dependencies]
|
||||
actix-web = "4"
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
use derive_more::derive::{Display, Error, From};
|
||||
use derive_more::{Display, Error, From};
|
||||
|
||||
use crate::status::Status;
|
||||
|
||||
@ -6,20 +6,20 @@ use crate::status::Status;
|
||||
#[derive(Debug, Display, Error, From)]
|
||||
pub enum Error {
|
||||
/// Redis client failed to connect or run a query.
|
||||
#[display("Redis client failed to connect or run a query")]
|
||||
#[display(fmt = "Redis client failed to connect or run a query")]
|
||||
Client(redis::RedisError),
|
||||
|
||||
/// Limit is exceeded for a key.
|
||||
#[display("Limit is exceeded for a key")]
|
||||
#[display(fmt = "Limit is exceeded for a key")]
|
||||
#[from(ignore)]
|
||||
LimitExceeded(#[error(not(source))] Status),
|
||||
|
||||
/// Time conversion failed.
|
||||
#[display("Time conversion failed")]
|
||||
#[display(fmt = "Time conversion failed")]
|
||||
Time(time::error::ComponentRange),
|
||||
|
||||
/// Generic error.
|
||||
#[display("Generic error")]
|
||||
#[display(fmt = "Generic error")]
|
||||
#[from(ignore)]
|
||||
Other(#[error(not(source))] String),
|
||||
}
|
||||
|
||||
@ -16,7 +16,7 @@ impl Status {
|
||||
/// Constructs status limit status from parts.
|
||||
#[must_use]
|
||||
pub(crate) fn new(count: usize, limit: usize, reset_epoch_utc: usize) -> Self {
|
||||
let remaining = limit.saturating_sub(count);
|
||||
let remaining = if count >= limit { 0 } else { limit - count };
|
||||
|
||||
Status {
|
||||
limit,
|
||||
|
||||
@ -19,7 +19,7 @@ all-features = true
|
||||
|
||||
[dependencies]
|
||||
actix-web = { version = "4", default-features = false }
|
||||
derive_more = { version = "2", features = ["display"] }
|
||||
derive_more = "0.99.7"
|
||||
futures-util = { version = "0.3.17", default-features = false, features = ["std"] }
|
||||
prost = { version = "0.13", default-features = false }
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ use actix_web::{
|
||||
Error, FromRequest, HttpMessage, HttpRequest, HttpResponse, HttpResponseBuilder, Responder,
|
||||
ResponseError,
|
||||
};
|
||||
use derive_more::derive::Display;
|
||||
use derive_more::Display;
|
||||
use futures_util::{
|
||||
future::{FutureExt as _, LocalBoxFuture},
|
||||
stream::StreamExt as _,
|
||||
@ -32,28 +32,26 @@ use prost::{DecodeError as ProtoBufDecodeError, EncodeError as ProtoBufEncodeErr
|
||||
#[derive(Debug, Display)]
|
||||
pub enum ProtoBufPayloadError {
|
||||
/// Payload size is bigger than 256k
|
||||
#[display("Payload size is bigger than 256k")]
|
||||
#[display(fmt = "Payload size is bigger than 256k")]
|
||||
Overflow,
|
||||
|
||||
/// Content type error
|
||||
#[display("Content type error")]
|
||||
#[display(fmt = "Content type error")]
|
||||
ContentType,
|
||||
|
||||
/// Serialize error
|
||||
#[display("ProtoBuf serialize error: {_0}")]
|
||||
#[display(fmt = "ProtoBuf serialize error: {_0}")]
|
||||
Serialize(ProtoBufEncodeError),
|
||||
|
||||
/// Deserialize error
|
||||
#[display("ProtoBuf deserialize error: {_0}")]
|
||||
#[display(fmt = "ProtoBuf deserialize error: {_0}")]
|
||||
Deserialize(ProtoBufDecodeError),
|
||||
|
||||
/// Payload error
|
||||
#[display("Error that occur during reading payload: {_0}")]
|
||||
#[display(fmt = "Error that occur during reading payload: {_0}")]
|
||||
Payload(PayloadError),
|
||||
}
|
||||
|
||||
// TODO: impl error for ProtoBufPayloadError
|
||||
|
||||
impl ResponseError for ProtoBufPayloadError {
|
||||
fn error_response(&self) -> HttpResponse {
|
||||
match *self {
|
||||
|
||||
@ -2,23 +2,10 @@
|
||||
|
||||
## Unreleased
|
||||
|
||||
- Add `Session::contains_key` method.
|
||||
- Add `Session::update[_or]()` methods.
|
||||
- Update `redis` dependency to `0.29`.
|
||||
|
||||
## 0.10.1
|
||||
|
||||
- Expose `storage::generate_session_key()` without needing to enable a crate feature.
|
||||
|
||||
## 0.10.0
|
||||
|
||||
- Add `redis-session-rustls` crate feature that enables `rustls`-secured Redis sessions.
|
||||
- Add `redis-pool` crate feature (off-by-default) which enables `RedisSessionStore::{new, builder}_pooled()` constructors.
|
||||
- Rename `redis-rs-session` crate feature to `redis-session`.
|
||||
- Rename `redis-rs-tls-session` crate feature to `redis-session-native-tls`.
|
||||
- Remove `redis-actor-session` crate feature (and, therefore, the `actix-redis` based storage backend).
|
||||
- Expose `storage::generate_session_key()`.
|
||||
- Update `redis` dependency to `0.26`.
|
||||
|
||||
## 0.9.0
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "actix-session"
|
||||
version = "0.10.1"
|
||||
version = "0.9.0"
|
||||
authors = [
|
||||
"Nikolay Kim <fafhrd91@gmail.com>",
|
||||
"Luca Palmieri <rust@lpalmieri.com>",
|
||||
@ -20,10 +20,9 @@ all-features = true
|
||||
[features]
|
||||
default = []
|
||||
cookie-session = []
|
||||
redis-session = ["dep:redis"]
|
||||
redis-session = ["dep:redis", "dep:rand"]
|
||||
redis-session-native-tls = ["redis-session", "redis/tokio-native-tls-comp"]
|
||||
redis-session-rustls = ["redis-session", "redis/tokio-rustls-comp"]
|
||||
redis-pool = ["dep:deadpool-redis"]
|
||||
|
||||
[dependencies]
|
||||
actix-service = "2"
|
||||
@ -31,19 +30,18 @@ actix-utils = "3"
|
||||
actix-web = { version = "4", default-features = false, features = ["cookies", "secure-cookies"] }
|
||||
|
||||
anyhow = "1"
|
||||
derive_more = { version = "2", features = ["display", "error", "from"] }
|
||||
rand = "0.9"
|
||||
derive_more = "0.99.7"
|
||||
rand = { version = "0.8", optional = true }
|
||||
serde = { version = "1" }
|
||||
serde_json = { version = "1" }
|
||||
tracing = { version = "0.1.30", default-features = false, features = ["log"] }
|
||||
|
||||
# redis-session
|
||||
redis = { version = "0.29", default-features = false, features = ["tokio-comp", "connection-manager"], optional = true }
|
||||
deadpool-redis = { version = "0.20", optional = true }
|
||||
redis = { version = "0.25", default-features = false, features = ["tokio-comp", "connection-manager"], optional = true }
|
||||
|
||||
[dev-dependencies]
|
||||
actix-session = { path = ".", features = ["cookie-session", "redis-session"] }
|
||||
actix-test = "0.1"
|
||||
actix-test = "0.1.0-beta.10"
|
||||
actix-web = { version = "4", default-features = false, features = ["cookies", "secure-cookies", "macros"] }
|
||||
tracing-subscriber = { version = "0.3", features = ["env-filter"] }
|
||||
tracing = "0.1.30"
|
||||
|
||||
@ -5,9 +5,9 @@
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
[](https://crates.io/crates/actix-session)
|
||||
[](https://docs.rs/actix-session/0.10.1)
|
||||
[](https://docs.rs/actix-session/0.9.0)
|
||||
|
||||
[](https://deps.rs/crate/actix-session/0.10.1)
|
||||
[](https://deps.rs/crate/actix-session/0.9.0)
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
@ -94,26 +94,34 @@ By default, `actix-session` does not provide any storage backend to retrieve and
|
||||
|
||||
- a purely cookie-based "backend", [`CookieSessionStore`], using the `cookie-session` feature flag.
|
||||
|
||||
```console
|
||||
cargo add actix-session --features=cookie-session
|
||||
```toml
|
||||
[dependencies]
|
||||
# ...
|
||||
actix-session = { version = "...", features = ["cookie-session"] }
|
||||
```
|
||||
|
||||
- a Redis-based backend via the [`redis`] crate, [`RedisSessionStore`], using the `redis-session` feature flag.
|
||||
- a Redis-based backend via [`redis-rs`](https://docs.rs/redis-rs), [`RedisSessionStore`], using the `redis-session` feature flag.
|
||||
|
||||
```console
|
||||
cargo add actix-session --features=redis-session
|
||||
```toml
|
||||
[dependencies]
|
||||
# ...
|
||||
actix-session = { version = "...", features = ["redis-session"] }
|
||||
```
|
||||
|
||||
Add the `redis-session-native-tls` feature flag if you want to connect to Redis using a secure connection (via the `native-tls` crate):
|
||||
|
||||
```console
|
||||
cargo add actix-session --features=redis-session-native-tls
|
||||
```toml
|
||||
[dependencies]
|
||||
# ...
|
||||
actix-session = { version = "...", features = ["redis-session-native-tls"] }
|
||||
```
|
||||
|
||||
If you, instead, prefer depending on `rustls`, use the `redis-session-rustls` feature flag:
|
||||
|
||||
```console
|
||||
cargo add actix-session --features=redis-session-rustls
|
||||
```toml
|
||||
[dependencies]
|
||||
# ...
|
||||
actix-session = { version = "...", features = ["redis-session-rustls"] }
|
||||
```
|
||||
|
||||
You can implement your own session storage backend using the [`SessionStore`] trait.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
//! Configuration options to tune the behaviour of [`SessionMiddleware`].
|
||||
|
||||
use actix_web::cookie::{time::Duration, Key, SameSite};
|
||||
use derive_more::derive::From;
|
||||
use derive_more::From;
|
||||
|
||||
use crate::{storage::SessionStore, SessionMiddleware};
|
||||
|
||||
|
||||
@ -99,28 +99,36 @@
|
||||
//! - a purely cookie-based "backend", [`CookieSessionStore`], using the `cookie-session` feature
|
||||
//! flag.
|
||||
//!
|
||||
//! ```console
|
||||
//! cargo add actix-session --features=cookie-session
|
||||
//! ```toml
|
||||
//! [dependencies]
|
||||
//! # ...
|
||||
//! actix-session = { version = "...", features = ["cookie-session"] }
|
||||
//! ```
|
||||
//!
|
||||
//! - a Redis-based backend via the [`redis`] crate, [`RedisSessionStore`], using the
|
||||
//! `redis-session` feature flag.
|
||||
//! - a Redis-based backend via [`redis-rs`](https://docs.rs/redis-rs), [`RedisSessionStore`], using
|
||||
//! the `redis-session` feature flag.
|
||||
//!
|
||||
//! ```console
|
||||
//! cargo add actix-session --features=redis-session
|
||||
//! ```toml
|
||||
//! [dependencies]
|
||||
//! # ...
|
||||
//! actix-session = { version = "...", features = ["redis-session"] }
|
||||
//! ```
|
||||
//!
|
||||
//! Add the `redis-session-native-tls` feature flag if you want to connect to Redis using a secure
|
||||
//! connection (via the `native-tls` crate):
|
||||
//!
|
||||
//! ```console
|
||||
//! cargo add actix-session --features=redis-session-native-tls
|
||||
//! ```toml
|
||||
//! [dependencies]
|
||||
//! # ...
|
||||
//! actix-session = { version = "...", features = ["redis-session-native-tls"] }
|
||||
//! ```
|
||||
//!
|
||||
//! If you, instead, prefer depending on `rustls`, use the `redis-session-rustls` feature flag:
|
||||
//!
|
||||
//! ```console
|
||||
//! cargo add actix-session --features=redis-session-rustls
|
||||
//! ```toml
|
||||
//! [dependencies]
|
||||
//! # ...
|
||||
//! actix-session = { version = "...", features = ["redis-session-rustls"] }
|
||||
//! ```
|
||||
//!
|
||||
//! You can implement your own session storage backend using the [`SessionStore`] trait.
|
||||
@ -148,7 +156,6 @@ pub use self::{
|
||||
};
|
||||
|
||||
#[cfg(test)]
|
||||
#[allow(missing_docs)]
|
||||
pub mod test_helpers {
|
||||
use actix_web::cookie::Key;
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ use actix_web::{
|
||||
FromRequest, HttpMessage, HttpRequest, HttpResponse, ResponseError,
|
||||
};
|
||||
use anyhow::Context;
|
||||
use derive_more::derive::{Display, From};
|
||||
use derive_more::{Display, From};
|
||||
use serde::{de::DeserializeOwned, Serialize};
|
||||
|
||||
/// The primary interface to access and modify session state.
|
||||
@ -33,9 +33,6 @@ use serde::{de::DeserializeOwned, Serialize};
|
||||
/// session.insert("counter", 1)?;
|
||||
/// }
|
||||
///
|
||||
/// // or use the shorthand
|
||||
/// session.update_or("counter", 1, |count: i32| count + 1);
|
||||
///
|
||||
/// Ok("Welcome!")
|
||||
/// }
|
||||
/// # actix_web::web::to(index);
|
||||
@ -100,11 +97,6 @@ impl Session {
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns `true` if the session contains a value for the specified `key`.
|
||||
pub fn contains_key(&self, key: &str) -> bool {
|
||||
self.0.borrow().state.contains_key(key)
|
||||
}
|
||||
|
||||
/// Get all raw key-value data from the session.
|
||||
///
|
||||
/// Note that values are JSON encoded.
|
||||
@ -122,9 +114,7 @@ impl Session {
|
||||
/// Any serializable value can be used and will be encoded as JSON in session data, hence why
|
||||
/// only a reference to the value is taken.
|
||||
///
|
||||
/// # Errors
|
||||
///
|
||||
/// Returns an error if JSON serialization of `value` fails.
|
||||
/// It returns an error if it fails to serialize `value` to JSON.
|
||||
pub fn insert<T: Serialize>(
|
||||
&self,
|
||||
key: impl Into<String>,
|
||||
@ -142,8 +132,9 @@ impl Session {
|
||||
.with_context(|| {
|
||||
format!(
|
||||
"Failed to serialize the provided `{}` type instance as JSON in order to \
|
||||
attach as session data to the `{key}` key",
|
||||
attach as session data to the `{}` key",
|
||||
std::any::type_name::<T>(),
|
||||
&key
|
||||
)
|
||||
})
|
||||
.map_err(SessionInsertError)?;
|
||||
@ -154,83 +145,6 @@ impl Session {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Updates a key-value pair into the session.
|
||||
///
|
||||
/// If the key exists then update it to the new value and place it back in. If the key does not
|
||||
/// exist it will not be updated.
|
||||
///
|
||||
/// Any serializable value can be used and will be encoded as JSON in the session data, hence
|
||||
/// why only a reference to the value is taken.
|
||||
///
|
||||
/// # Errors
|
||||
///
|
||||
/// Returns an error if JSON serialization of the value fails.
|
||||
pub fn update<T: Serialize + DeserializeOwned, F>(
|
||||
&self,
|
||||
key: impl Into<String>,
|
||||
updater: F,
|
||||
) -> Result<(), SessionUpdateError>
|
||||
where
|
||||
F: FnOnce(T) -> T,
|
||||
{
|
||||
let mut inner = self.0.borrow_mut();
|
||||
let key_str = key.into();
|
||||
|
||||
if let Some(val_str) = inner.state.get(&key_str) {
|
||||
let value = serde_json::from_str(val_str)
|
||||
.with_context(|| {
|
||||
format!(
|
||||
"Failed to deserialize the JSON-encoded session data attached to key \
|
||||
`{key_str}` as a `{}` type",
|
||||
std::any::type_name::<T>()
|
||||
)
|
||||
})
|
||||
.map_err(SessionUpdateError)?;
|
||||
|
||||
let val = serde_json::to_string(&updater(value))
|
||||
.with_context(|| {
|
||||
format!(
|
||||
"Failed to serialize the provided `{}` type instance as JSON in order to \
|
||||
attach as session data to the `{key_str}` key",
|
||||
std::any::type_name::<T>(),
|
||||
)
|
||||
})
|
||||
.map_err(SessionUpdateError)?;
|
||||
|
||||
inner.state.insert(key_str, val);
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Updates a key-value pair into the session, or inserts a default value.
|
||||
///
|
||||
/// If the key exists then update it to the new value and place it back in. If the key does not
|
||||
/// exist the default value will be inserted instead.
|
||||
///
|
||||
/// Any serializable value can be used and will be encoded as JSON in session data, hence why
|
||||
/// only a reference to the value is taken.
|
||||
///
|
||||
/// # Errors
|
||||
///
|
||||
/// Returns error if JSON serialization of a value fails.
|
||||
pub fn update_or<T: Serialize + DeserializeOwned, F>(
|
||||
&self,
|
||||
key: &str,
|
||||
default_value: T,
|
||||
updater: F,
|
||||
) -> Result<(), SessionUpdateError>
|
||||
where
|
||||
F: FnOnce(T) -> T,
|
||||
{
|
||||
if self.contains_key(key) {
|
||||
self.update(key, updater)
|
||||
} else {
|
||||
self.insert(key, default_value)
|
||||
.map_err(|err| SessionUpdateError(err.into()))
|
||||
}
|
||||
}
|
||||
|
||||
/// Remove value from the session.
|
||||
///
|
||||
/// If present, the JSON encoded value is returned.
|
||||
@ -374,7 +288,7 @@ impl FromRequest for Session {
|
||||
|
||||
/// Error returned by [`Session::get`].
|
||||
#[derive(Debug, Display, From)]
|
||||
#[display("{_0}")]
|
||||
#[display(fmt = "{_0}")]
|
||||
pub struct SessionGetError(anyhow::Error);
|
||||
|
||||
impl StdError for SessionGetError {
|
||||
@ -391,7 +305,7 @@ impl ResponseError for SessionGetError {
|
||||
|
||||
/// Error returned by [`Session::insert`].
|
||||
#[derive(Debug, Display, From)]
|
||||
#[display("{_0}")]
|
||||
#[display(fmt = "{_0}")]
|
||||
pub struct SessionInsertError(anyhow::Error);
|
||||
|
||||
impl StdError for SessionInsertError {
|
||||
@ -405,20 +319,3 @@ impl ResponseError for SessionInsertError {
|
||||
HttpResponse::new(self.status_code())
|
||||
}
|
||||
}
|
||||
|
||||
/// Error returned by [`Session::update`].
|
||||
#[derive(Debug, Display, From)]
|
||||
#[display("{_0}")]
|
||||
pub struct SessionUpdateError(anyhow::Error);
|
||||
|
||||
impl StdError for SessionUpdateError {
|
||||
fn source(&self) -> Option<&(dyn StdError + 'static)> {
|
||||
Some(self.0.as_ref())
|
||||
}
|
||||
}
|
||||
|
||||
impl ResponseError for SessionUpdateError {
|
||||
fn error_response(&self) -> HttpResponse<BoxBody> {
|
||||
HttpResponse::new(self.status_code())
|
||||
}
|
||||
}
|
||||
|
||||
@ -31,7 +31,7 @@ impl SessionExt for ServiceResponse {
|
||||
}
|
||||
}
|
||||
|
||||
impl SessionExt for GuardContext<'_> {
|
||||
impl<'a> SessionExt for GuardContext<'a> {
|
||||
fn get_session(&self) -> Session {
|
||||
Session::get_session(&mut self.req_data_mut())
|
||||
}
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
use std::{collections::HashMap, future::Future};
|
||||
|
||||
use actix_web::cookie::time::Duration;
|
||||
use derive_more::derive::Display;
|
||||
use derive_more::Display;
|
||||
|
||||
use super::SessionKey;
|
||||
|
||||
@ -53,11 +53,11 @@ pub trait SessionStore {
|
||||
#[derive(Debug, Display)]
|
||||
pub enum LoadError {
|
||||
/// Failed to deserialize session state.
|
||||
#[display("Failed to deserialize session state")]
|
||||
#[display(fmt = "Failed to deserialize session state")]
|
||||
Deserialization(anyhow::Error),
|
||||
|
||||
/// Something went wrong when retrieving the session state.
|
||||
#[display("Something went wrong when retrieving the session state")]
|
||||
#[display(fmt = "Something went wrong when retrieving the session state")]
|
||||
Other(anyhow::Error),
|
||||
}
|
||||
|
||||
@ -74,11 +74,11 @@ impl std::error::Error for LoadError {
|
||||
#[derive(Debug, Display)]
|
||||
pub enum SaveError {
|
||||
/// Failed to serialize session state.
|
||||
#[display("Failed to serialize session state")]
|
||||
#[display(fmt = "Failed to serialize session state")]
|
||||
Serialization(anyhow::Error),
|
||||
|
||||
/// Something went wrong when persisting the session state.
|
||||
#[display("Something went wrong when persisting the session state")]
|
||||
#[display(fmt = "Something went wrong when persisting the session state")]
|
||||
Other(anyhow::Error),
|
||||
}
|
||||
|
||||
@ -95,11 +95,11 @@ impl std::error::Error for SaveError {
|
||||
/// Possible failures modes for [`SessionStore::update`].
|
||||
pub enum UpdateError {
|
||||
/// Failed to serialize session state.
|
||||
#[display("Failed to serialize session state")]
|
||||
#[display(fmt = "Failed to serialize session state")]
|
||||
Serialization(anyhow::Error),
|
||||
|
||||
/// Something went wrong when updating the session state.
|
||||
#[display("Something went wrong when updating the session state.")]
|
||||
#[display(fmt = "Something went wrong when updating the session state.")]
|
||||
Other(anyhow::Error),
|
||||
}
|
||||
|
||||
|
||||
@ -1,19 +1,23 @@
|
||||
//! Pluggable storage backends for session state.
|
||||
|
||||
#[cfg(feature = "cookie-session")]
|
||||
mod cookie;
|
||||
mod interface;
|
||||
#[cfg(feature = "redis-session")]
|
||||
mod redis_rs;
|
||||
mod session_key;
|
||||
mod utils;
|
||||
|
||||
#[cfg(feature = "cookie-session")]
|
||||
pub use self::cookie::CookieSessionStore;
|
||||
#[cfg(feature = "redis-session")]
|
||||
pub use self::redis_rs::{RedisSessionStore, RedisSessionStoreBuilder};
|
||||
pub use self::{
|
||||
interface::{LoadError, SaveError, SessionStore, UpdateError},
|
||||
session_key::SessionKey,
|
||||
utils::generate_session_key,
|
||||
};
|
||||
|
||||
#[cfg(feature = "cookie-session")]
|
||||
mod cookie;
|
||||
|
||||
#[cfg(feature = "redis-session")]
|
||||
mod redis_rs;
|
||||
|
||||
#[cfg(feature = "redis-session")]
|
||||
mod utils;
|
||||
|
||||
#[cfg(feature = "cookie-session")]
|
||||
pub use cookie::CookieSessionStore;
|
||||
#[cfg(feature = "redis-session")]
|
||||
pub use redis_rs::{RedisSessionStore, RedisSessionStoreBuilder};
|
||||
|
||||
@ -2,7 +2,7 @@ use std::sync::Arc;
|
||||
|
||||
use actix_web::cookie::time::Duration;
|
||||
use anyhow::Error;
|
||||
use redis::{aio::ConnectionManager, AsyncCommands, Client, Cmd, FromRedisValue, Value};
|
||||
use redis::{aio::ConnectionManager, AsyncCommands, Cmd, FromRedisValue, RedisResult, Value};
|
||||
|
||||
use super::SessionKey;
|
||||
use crate::storage::{
|
||||
@ -44,7 +44,7 @@ use crate::storage::{
|
||||
/// ```
|
||||
///
|
||||
/// # TLS support
|
||||
/// Add the `redis-session-native-tls` or `redis-session-rustls` feature flag to enable TLS support. You can then establish a TLS
|
||||
/// Add the `redis-rs-tls-session` or `redis-rs-tls-session-rustls` feature flag to enable TLS support. You can then establish a TLS
|
||||
/// connection to Redis using the `rediss://` URL scheme:
|
||||
///
|
||||
/// ```no_run
|
||||
@ -56,38 +56,14 @@ use crate::storage::{
|
||||
/// # })
|
||||
/// ```
|
||||
///
|
||||
/// # Pooled Redis Connections
|
||||
///
|
||||
/// When the `redis-pool` crate feature is enabled, a pre-existing pool from [`deadpool_redis`] can
|
||||
/// be provided.
|
||||
///
|
||||
/// ```no_run
|
||||
/// use actix_session::storage::RedisSessionStore;
|
||||
/// use deadpool_redis::{Config, Runtime};
|
||||
///
|
||||
/// let redis_cfg = Config::from_url("redis://127.0.0.1:6379");
|
||||
/// let redis_pool = redis_cfg.create_pool(Some(Runtime::Tokio1)).unwrap();
|
||||
///
|
||||
/// let store = RedisSessionStore::new_pooled(redis_pool);
|
||||
/// ```
|
||||
///
|
||||
/// # Implementation notes
|
||||
/// `RedisSessionStore` leverages [`redis-rs`] as Redis client.
|
||||
///
|
||||
/// `RedisSessionStore` leverages the [`redis`] crate as the underlying Redis client.
|
||||
/// [`redis-rs`]: https://github.com/mitsuhiko/redis-rs
|
||||
#[derive(Clone)]
|
||||
pub struct RedisSessionStore {
|
||||
configuration: CacheConfiguration,
|
||||
client: RedisSessionConn,
|
||||
}
|
||||
|
||||
#[derive(Clone)]
|
||||
enum RedisSessionConn {
|
||||
/// Single connection.
|
||||
Single(ConnectionManager),
|
||||
|
||||
/// Connection pool.
|
||||
#[cfg(feature = "redis-pool")]
|
||||
Pool(deadpool_redis::Pool),
|
||||
client: ConnectionManager,
|
||||
}
|
||||
|
||||
#[derive(Clone)]
|
||||
@ -104,77 +80,34 @@ impl Default for CacheConfiguration {
|
||||
}
|
||||
|
||||
impl RedisSessionStore {
|
||||
/// Returns a fluent API builder to configure [`RedisSessionStore`].
|
||||
///
|
||||
/// It takes as input the only required input to create a new instance of [`RedisSessionStore`]
|
||||
/// - a connection string for Redis.
|
||||
pub fn builder(connection_string: impl Into<String>) -> RedisSessionStoreBuilder {
|
||||
/// A fluent API to configure [`RedisSessionStore`].
|
||||
/// It takes as input the only required input to create a new instance of [`RedisSessionStore`] - a
|
||||
/// connection string for Redis.
|
||||
pub fn builder<S: Into<String>>(connection_string: S) -> RedisSessionStoreBuilder {
|
||||
RedisSessionStoreBuilder {
|
||||
configuration: CacheConfiguration::default(),
|
||||
conn_builder: RedisSessionConnBuilder::Single(connection_string.into()),
|
||||
connection_string: connection_string.into(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns a fluent API builder to configure [`RedisSessionStore`].
|
||||
///
|
||||
/// It takes as input the only required input to create a new instance of [`RedisSessionStore`]
|
||||
/// - a pool object for Redis.
|
||||
#[cfg(feature = "redis-pool")]
|
||||
pub fn builder_pooled(pool: impl Into<deadpool_redis::Pool>) -> RedisSessionStoreBuilder {
|
||||
RedisSessionStoreBuilder {
|
||||
configuration: CacheConfiguration::default(),
|
||||
conn_builder: RedisSessionConnBuilder::Pool(pool.into()),
|
||||
}
|
||||
}
|
||||
|
||||
/// Creates a new instance of [`RedisSessionStore`] using the default configuration.
|
||||
///
|
||||
/// It takes as input the only required input to create a new instance of [`RedisSessionStore`]
|
||||
/// - a connection string for Redis.
|
||||
pub async fn new(connection_string: impl Into<String>) -> Result<RedisSessionStore, Error> {
|
||||
/// Create a new instance of [`RedisSessionStore`] using the default configuration.
|
||||
/// It takes as input the only required input to create a new instance of [`RedisSessionStore`] - a
|
||||
/// connection string for Redis.
|
||||
pub async fn new<S: Into<String>>(
|
||||
connection_string: S,
|
||||
) -> Result<RedisSessionStore, anyhow::Error> {
|
||||
Self::builder(connection_string).build().await
|
||||
}
|
||||
|
||||
/// Creates a new instance of [`RedisSessionStore`] using the default configuration.
|
||||
///
|
||||
/// It takes as input the only required input to create a new instance of [`RedisSessionStore`]
|
||||
/// - a pool object for Redis.
|
||||
#[cfg(feature = "redis-pool")]
|
||||
pub async fn new_pooled(
|
||||
pool: impl Into<deadpool_redis::Pool>,
|
||||
) -> anyhow::Result<RedisSessionStore> {
|
||||
Self::builder_pooled(pool).build().await
|
||||
}
|
||||
}
|
||||
|
||||
/// A fluent builder to construct a [`RedisSessionStore`] instance with custom configuration
|
||||
/// parameters.
|
||||
///
|
||||
/// [`RedisSessionStore`]: crate::storage::RedisSessionStore
|
||||
#[must_use]
|
||||
pub struct RedisSessionStoreBuilder {
|
||||
connection_string: String,
|
||||
configuration: CacheConfiguration,
|
||||
conn_builder: RedisSessionConnBuilder,
|
||||
}
|
||||
|
||||
enum RedisSessionConnBuilder {
|
||||
/// Single connection string.
|
||||
Single(String),
|
||||
|
||||
/// Pre-built connection pool.
|
||||
#[cfg(feature = "redis-pool")]
|
||||
Pool(deadpool_redis::Pool),
|
||||
}
|
||||
|
||||
impl RedisSessionConnBuilder {
|
||||
async fn into_client(self) -> anyhow::Result<RedisSessionConn> {
|
||||
Ok(match self {
|
||||
RedisSessionConnBuilder::Single(conn_string) => {
|
||||
RedisSessionConn::Single(ConnectionManager::new(Client::open(conn_string)?).await?)
|
||||
}
|
||||
|
||||
#[cfg(feature = "redis-pool")]
|
||||
RedisSessionConnBuilder::Pool(pool) => RedisSessionConn::Pool(pool),
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
impl RedisSessionStoreBuilder {
|
||||
@ -187,10 +120,9 @@ impl RedisSessionStoreBuilder {
|
||||
self
|
||||
}
|
||||
|
||||
/// Finalises builder and returns a [`RedisSessionStore`] instance.
|
||||
pub async fn build(self) -> anyhow::Result<RedisSessionStore> {
|
||||
let client = self.conn_builder.into_client().await?;
|
||||
|
||||
/// Finalise the builder and return a [`RedisSessionStore`] instance.
|
||||
pub async fn build(self) -> Result<RedisSessionStore, anyhow::Error> {
|
||||
let client = ConnectionManager::new(redis::Client::open(self.connection_string)?).await?;
|
||||
Ok(RedisSessionStore {
|
||||
configuration: self.configuration,
|
||||
client,
|
||||
@ -205,6 +137,7 @@ impl SessionStore for RedisSessionStore {
|
||||
let value: Option<String> = self
|
||||
.execute_command(redis::cmd("GET").arg(&[&cache_key]))
|
||||
.await
|
||||
.map_err(Into::into)
|
||||
.map_err(LoadError::Other)?;
|
||||
|
||||
match value {
|
||||
@ -239,6 +172,7 @@ impl SessionStore for RedisSessionStore {
|
||||
),
|
||||
)
|
||||
.await
|
||||
.map_err(Into::into)
|
||||
.map_err(SaveError::Other)?;
|
||||
|
||||
Ok(session_key)
|
||||
@ -256,7 +190,7 @@ impl SessionStore for RedisSessionStore {
|
||||
|
||||
let cache_key = (self.configuration.cache_keygen)(session_key.as_ref());
|
||||
|
||||
let v: Value = self
|
||||
let v: redis::Value = self
|
||||
.execute_command(redis::cmd("SET").arg(&[
|
||||
&cache_key,
|
||||
&body,
|
||||
@ -265,6 +199,7 @@ impl SessionStore for RedisSessionStore {
|
||||
&format!("{}", ttl.whole_seconds()),
|
||||
]))
|
||||
.await
|
||||
.map_err(Into::into)
|
||||
.map_err(UpdateError::Other)?;
|
||||
|
||||
match v {
|
||||
@ -280,7 +215,7 @@ impl SessionStore for RedisSessionStore {
|
||||
SaveError::Other(err) => UpdateError::Other(err),
|
||||
})
|
||||
}
|
||||
Value::Int(_) | Value::Okay | Value::SimpleString(_) => Ok(session_key),
|
||||
Value::Int(_) | Value::Okay | Value::Status(_) => Ok(session_key),
|
||||
val => Err(UpdateError::Other(anyhow::anyhow!(
|
||||
"Failed to update session state. {:?}",
|
||||
val
|
||||
@ -288,33 +223,23 @@ impl SessionStore for RedisSessionStore {
|
||||
}
|
||||
}
|
||||
|
||||
async fn update_ttl(&self, session_key: &SessionKey, ttl: &Duration) -> anyhow::Result<()> {
|
||||
async fn update_ttl(&self, session_key: &SessionKey, ttl: &Duration) -> Result<(), Error> {
|
||||
let cache_key = (self.configuration.cache_keygen)(session_key.as_ref());
|
||||
|
||||
match self.client {
|
||||
RedisSessionConn::Single(ref conn) => {
|
||||
conn.clone()
|
||||
self.client
|
||||
.clone()
|
||||
.expire::<_, ()>(&cache_key, ttl.whole_seconds())
|
||||
.await?;
|
||||
}
|
||||
|
||||
#[cfg(feature = "redis-pool")]
|
||||
RedisSessionConn::Pool(ref pool) => {
|
||||
pool.get()
|
||||
.await?
|
||||
.expire::<_, ()>(&cache_key, ttl.whole_seconds())
|
||||
.await?;
|
||||
}
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn delete(&self, session_key: &SessionKey) -> Result<(), Error> {
|
||||
async fn delete(&self, session_key: &SessionKey) -> Result<(), anyhow::Error> {
|
||||
let cache_key = (self.configuration.cache_keygen)(session_key.as_ref());
|
||||
|
||||
self.execute_command::<()>(redis::cmd("DEL").arg(&[&cache_key]))
|
||||
.await
|
||||
.map_err(Into::into)
|
||||
.map_err(UpdateError::Other)?;
|
||||
|
||||
Ok(())
|
||||
@ -336,15 +261,11 @@ impl RedisSessionStore {
|
||||
/// retry will be executed on a fresh connection, therefore it is likely to succeed (or fail for
|
||||
/// a different more meaningful reason).
|
||||
#[allow(clippy::needless_pass_by_ref_mut)]
|
||||
async fn execute_command<T: FromRedisValue>(&self, cmd: &mut Cmd) -> anyhow::Result<T> {
|
||||
async fn execute_command<T: FromRedisValue>(&self, cmd: &mut Cmd) -> RedisResult<T> {
|
||||
let mut can_retry = true;
|
||||
|
||||
match self.client {
|
||||
RedisSessionConn::Single(ref conn) => {
|
||||
let mut conn = conn.clone();
|
||||
|
||||
loop {
|
||||
match cmd.query_async(&mut conn).await {
|
||||
match cmd.query_async(&mut self.client.clone()).await {
|
||||
Ok(value) => return Ok(value),
|
||||
Err(err) => {
|
||||
if can_retry && err.is_connection_dropped() {
|
||||
@ -357,34 +278,7 @@ impl RedisSessionStore {
|
||||
|
||||
continue;
|
||||
} else {
|
||||
return Err(err.into());
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(feature = "redis-pool")]
|
||||
RedisSessionConn::Pool(ref pool) => {
|
||||
let mut conn = pool.get().await?;
|
||||
|
||||
loop {
|
||||
match cmd.query_async(&mut conn).await {
|
||||
Ok(value) => return Ok(value),
|
||||
Err(err) => {
|
||||
if can_retry && err.is_connection_dropped() {
|
||||
tracing::debug!(
|
||||
"Connection dropped while trying to talk to Redis. Retrying."
|
||||
);
|
||||
|
||||
// Retry at most once
|
||||
can_retry = false;
|
||||
|
||||
continue;
|
||||
} else {
|
||||
return Err(err.into());
|
||||
}
|
||||
}
|
||||
return Err(err);
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -397,29 +291,16 @@ mod tests {
|
||||
use std::collections::HashMap;
|
||||
|
||||
use actix_web::cookie::time;
|
||||
#[cfg(not(feature = "redis-session"))]
|
||||
use deadpool_redis::{Config, Runtime};
|
||||
|
||||
use super::*;
|
||||
use crate::test_helpers::acceptance_test_suite;
|
||||
|
||||
async fn redis_store() -> RedisSessionStore {
|
||||
#[cfg(feature = "redis-session")]
|
||||
{
|
||||
RedisSessionStore::new("redis://127.0.0.1:6379")
|
||||
.await
|
||||
.unwrap()
|
||||
}
|
||||
|
||||
#[cfg(not(feature = "redis-session"))]
|
||||
{
|
||||
let redis_pool = Config::from_url("redis://127.0.0.1:6379")
|
||||
.create_pool(Some(Runtime::Tokio1))
|
||||
.unwrap();
|
||||
RedisSessionStore::new(redis_pool.clone())
|
||||
}
|
||||
}
|
||||
|
||||
#[actix_web::test]
|
||||
async fn test_session_workflow() {
|
||||
let redis_store = redis_store().await;
|
||||
@ -437,25 +318,12 @@ mod tests {
|
||||
async fn loading_an_invalid_session_state_returns_deserialization_error() {
|
||||
let store = redis_store().await;
|
||||
let session_key = generate_session_key();
|
||||
|
||||
match store.client {
|
||||
RedisSessionConn::Single(ref conn) => conn
|
||||
store
|
||||
.client
|
||||
.clone()
|
||||
.set::<_, _, ()>(session_key.as_ref(), "random-thing-which-is-not-json")
|
||||
.await
|
||||
.unwrap(),
|
||||
|
||||
#[cfg(feature = "redis-pool")]
|
||||
RedisSessionConn::Pool(ref pool) => {
|
||||
pool.get()
|
||||
.await
|
||||
.unwrap()
|
||||
.set::<_, _, ()>(session_key.as_ref(), "random-thing-which-is-not-json")
|
||||
.await
|
||||
.unwrap();
|
||||
}
|
||||
}
|
||||
|
||||
assert!(matches!(
|
||||
store.load(&session_key).await.unwrap_err(),
|
||||
LoadError::Deserialization(_),
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
use derive_more::derive::{Display, From};
|
||||
use derive_more::{Display, From};
|
||||
|
||||
/// A session key, the string stored in a client-side cookie to associate a user with its session
|
||||
/// state on the backend.
|
||||
@ -45,7 +45,7 @@ impl From<SessionKey> for String {
|
||||
}
|
||||
|
||||
#[derive(Debug, Display, From)]
|
||||
#[display("The provided string is not a valid session key")]
|
||||
#[display(fmt = "The provided string is not a valid session key")]
|
||||
pub struct InvalidSessionKeyError(anyhow::Error);
|
||||
|
||||
impl std::error::Error for InvalidSessionKeyError {
|
||||
|
||||
@ -1,13 +1,17 @@
|
||||
use rand::distr::{Alphanumeric, SampleString as _};
|
||||
use rand::{distributions::Alphanumeric, rngs::OsRng, Rng as _};
|
||||
|
||||
use crate::storage::SessionKey;
|
||||
|
||||
/// Session key generation routine that follows [OWASP recommendations].
|
||||
///
|
||||
/// [OWASP recommendations]: https://cheatsheetseries.owasp.org/cheatsheets/Session_Management_Cheat_Sheet.html#session-id-entropy
|
||||
pub fn generate_session_key() -> SessionKey {
|
||||
Alphanumeric
|
||||
.sample_string(&mut rand::rng(), 64)
|
||||
.try_into()
|
||||
.expect("generated string should be within size range for a session key")
|
||||
pub(crate) fn generate_session_key() -> SessionKey {
|
||||
let value = std::iter::repeat(())
|
||||
.map(|()| OsRng.sample(Alphanumeric))
|
||||
.take(64)
|
||||
.collect::<Vec<_>>();
|
||||
|
||||
// These unwraps will never panic because pre-conditions are always verified
|
||||
// (i.e. length and character set)
|
||||
String::from_utf8(value).unwrap().try_into().unwrap()
|
||||
}
|
||||
|
||||
@ -69,16 +69,6 @@ async fn session_entries() {
|
||||
map.contains_key("test_num");
|
||||
}
|
||||
|
||||
#[actix_web::test]
|
||||
async fn session_contains_key() {
|
||||
let req = test::TestRequest::default().to_srv_request();
|
||||
let session = req.get_session();
|
||||
session.insert("test_str", "val").unwrap();
|
||||
session.insert("test_str", 1).unwrap();
|
||||
assert!(session.contains_key("test_str"));
|
||||
assert!(!session.contains_key("test_num"));
|
||||
}
|
||||
|
||||
#[actix_web::test]
|
||||
async fn insert_session_after_renew() {
|
||||
let session = test::TestRequest::default().to_srv_request().get_session();
|
||||
@ -93,35 +83,6 @@ async fn insert_session_after_renew() {
|
||||
assert_eq!(session.status(), SessionStatus::Renewed);
|
||||
}
|
||||
|
||||
#[actix_web::test]
|
||||
async fn update_session() {
|
||||
let session = test::TestRequest::default().to_srv_request().get_session();
|
||||
|
||||
session.update("test_val", |c: u32| c + 1).unwrap();
|
||||
assert_eq!(session.status(), SessionStatus::Unchanged);
|
||||
|
||||
session.insert("test_val", 0).unwrap();
|
||||
assert_eq!(session.status(), SessionStatus::Changed);
|
||||
|
||||
session.update("test_val", |c: u32| c + 1).unwrap();
|
||||
assert_eq!(session.get("test_val").unwrap(), Some(1));
|
||||
|
||||
session.update("test_val", |c: u32| c + 1).unwrap();
|
||||
assert_eq!(session.get("test_val").unwrap(), Some(2));
|
||||
}
|
||||
|
||||
#[actix_web::test]
|
||||
async fn update_or_session() {
|
||||
let session = test::TestRequest::default().to_srv_request().get_session();
|
||||
|
||||
session.update_or("test_val", 1, |c: u32| c + 1).unwrap();
|
||||
assert_eq!(session.status(), SessionStatus::Changed);
|
||||
assert_eq!(session.get("test_val").unwrap(), Some(1));
|
||||
|
||||
session.update_or("test_val", 1, |c: u32| c + 1).unwrap();
|
||||
assert_eq!(session.get("test_val").unwrap(), Some(2));
|
||||
}
|
||||
|
||||
#[actix_web::test]
|
||||
async fn remove_session_after_renew() {
|
||||
let session = test::TestRequest::default().to_srv_request().get_session();
|
||||
|
||||
@ -2,13 +2,6 @@
|
||||
|
||||
## Unreleased
|
||||
|
||||
## 0.8.0
|
||||
|
||||
- Add `openssl` crate feature for TLS settings using OpenSSL.
|
||||
- Add `ApplySettings::try_apply_settings()`.
|
||||
- Implement TLS logic for `ApplySettings::try_apply_settings()`.
|
||||
- Add `Tls::get_ssl_acceptor_builder()` function to build `openssl::ssl::SslAcceptorBuilder`.
|
||||
- Deprecate `ApplySettings::apply_settings()`.
|
||||
- Minimum supported Rust version (MSRV) is now 1.75.
|
||||
|
||||
## 0.7.1
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "actix-settings"
|
||||
version = "0.8.0"
|
||||
version = "0.7.1"
|
||||
authors = [
|
||||
"Joey Ezechiels <joey.ezechiels@gmail.com>",
|
||||
"Rob Ede <robjtede@icloud.com>",
|
||||
@ -14,17 +14,14 @@ rust-version.workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["--cfg", "docsrs"]
|
||||
|
||||
[features]
|
||||
openssl = ["dep:openssl", "actix-web/openssl"]
|
||||
all-features = true
|
||||
|
||||
[dependencies]
|
||||
actix-http = "3"
|
||||
actix-service = "2"
|
||||
actix-web = { version = "4", default-features = false }
|
||||
derive_more = { version = "2", features = ["display", "error"] }
|
||||
once_cell = "1.21"
|
||||
openssl = { version = "0.10", features = ["v110"], optional = true }
|
||||
derive_more = "0.99.7"
|
||||
once_cell = "1.13"
|
||||
regex = "1.5"
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
toml = "0.8"
|
||||
|
||||
@ -5,9 +5,9 @@
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
[](https://crates.io/crates/actix-settings)
|
||||
[](https://docs.rs/actix-settings/0.8.0)
|
||||
[](https://docs.rs/actix-settings/0.7.1)
|
||||
|
||||
[](https://deps.rs/crate/actix-settings/0.8.0)
|
||||
[](https://deps.rs/crate/actix-settings/0.7.1)
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
@ -23,6 +23,10 @@ There is a way to extend the available settings. This can be used to combine the
|
||||
|
||||
Have a look at [the usage example][usage] to see how.
|
||||
|
||||
## WIP
|
||||
|
||||
Configuration options for TLS set up are not yet implemented.
|
||||
|
||||
## Special Thanks
|
||||
|
||||
This crate was made possible by support from Accept B.V and [@jjpe].
|
||||
|
||||
@ -57,7 +57,7 @@ async fn main() -> std::io::Result<()> {
|
||||
}
|
||||
})
|
||||
// apply the `Settings` to Actix Web's `HttpServer`
|
||||
.try_apply_settings(&settings)?
|
||||
.apply_settings(&settings)
|
||||
.run()
|
||||
.await
|
||||
}
|
||||
|
||||
@ -1,24 +1,22 @@
|
||||
use std::{env::VarError, io, num::ParseIntError, path::PathBuf, str::ParseBoolError};
|
||||
|
||||
use derive_more::derive::{Display, Error};
|
||||
#[cfg(feature = "openssl")]
|
||||
use openssl::error::ErrorStack as OpenSSLError;
|
||||
use derive_more::{Display, Error};
|
||||
use toml::de::Error as TomlError;
|
||||
|
||||
/// Errors that can be returned from methods in this crate.
|
||||
#[derive(Debug, Display, Error)]
|
||||
pub enum Error {
|
||||
/// Environment variable does not exists or is invalid.
|
||||
#[display("Env var error: {_0}")]
|
||||
#[display(fmt = "Env var error: {_0}")]
|
||||
EnvVarError(VarError),
|
||||
|
||||
/// File already exists on disk.
|
||||
#[display("File exists: {}", _0.display())]
|
||||
#[display(fmt = "File exists: {}", "_0.display()")]
|
||||
FileExists(#[error(not(source))] PathBuf),
|
||||
|
||||
/// Invalid value.
|
||||
#[allow(missing_docs)]
|
||||
#[display("Expected {expected}, got {got} (@ {file}:{line}:{column})")]
|
||||
#[display(fmt = "Expected {expected}, got {got} (@ {file}:{line}:{column})")]
|
||||
InvalidValue {
|
||||
expected: &'static str,
|
||||
got: String,
|
||||
@ -28,28 +26,23 @@ pub enum Error {
|
||||
},
|
||||
|
||||
/// I/O error.
|
||||
#[display("I/O error: {_0}")]
|
||||
#[display(fmt = "")]
|
||||
IoError(io::Error),
|
||||
|
||||
/// OpenSSL Error.
|
||||
#[cfg(feature = "openssl")]
|
||||
#[display("OpenSSL error: {_0}")]
|
||||
OpenSSLError(OpenSSLError),
|
||||
|
||||
/// Value is not a boolean.
|
||||
#[display("Failed to parse boolean: {_0}")]
|
||||
#[display(fmt = "Failed to parse boolean: {_0}")]
|
||||
ParseBoolError(ParseBoolError),
|
||||
|
||||
/// Value is not an integer.
|
||||
#[display("Failed to parse integer: {_0}")]
|
||||
#[display(fmt = "Failed to parse integer: {_0}")]
|
||||
ParseIntError(ParseIntError),
|
||||
|
||||
/// Value is not an address.
|
||||
#[display("Failed to parse address: {_0}")]
|
||||
#[display(fmt = "Failed to parse address: {_0}")]
|
||||
ParseAddressError(#[error(not(source))] String),
|
||||
|
||||
/// Error deserializing as TOML.
|
||||
#[display("TOML error: {_0}")]
|
||||
#[display(fmt = "TOML error: {_0}")]
|
||||
TomlError(TomlError),
|
||||
}
|
||||
|
||||
@ -71,13 +64,6 @@ impl From<io::Error> for Error {
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(feature = "openssl")]
|
||||
impl From<OpenSSLError> for Error {
|
||||
fn from(err: OpenSSLError) -> Self {
|
||||
Self::OpenSSLError(err)
|
||||
}
|
||||
}
|
||||
|
||||
impl From<ParseBoolError> for Error {
|
||||
fn from(err: ParseBoolError) -> Self {
|
||||
Self::ParseBoolError(err)
|
||||
@ -115,9 +101,6 @@ impl From<Error> for io::Error {
|
||||
|
||||
Error::IoError(io_error) => io_error,
|
||||
|
||||
#[cfg(feature = "openssl")]
|
||||
Error::OpenSSLError(ossl_error) => io::Error::new(io::ErrorKind::Other, ossl_error),
|
||||
|
||||
Error::ParseBoolError(_) => {
|
||||
io::Error::new(io::ErrorKind::InvalidInput, err.to_string())
|
||||
}
|
||||
|
||||
@ -54,7 +54,7 @@
|
||||
//! }
|
||||
//! })
|
||||
//! // apply the `Settings` to Actix Web's `HttpServer`
|
||||
//! .try_apply_settings(&settings)?
|
||||
//! .apply_settings(&settings)
|
||||
//! .run()
|
||||
//! .await
|
||||
//! }
|
||||
@ -89,14 +89,12 @@ mod error;
|
||||
mod parse;
|
||||
mod settings;
|
||||
|
||||
#[cfg(feature = "openssl")]
|
||||
pub use self::settings::Tls;
|
||||
pub use self::{
|
||||
error::Error,
|
||||
parse::Parse,
|
||||
settings::{
|
||||
ActixSettings, Address, Backlog, KeepAlive, MaxConnectionRate, MaxConnections, Mode,
|
||||
NumWorkers, Timeout,
|
||||
NumWorkers, Timeout, Tls,
|
||||
},
|
||||
};
|
||||
|
||||
@ -241,28 +239,10 @@ where
|
||||
}
|
||||
|
||||
/// Extension trait for applying parsed settings to the server object.
|
||||
pub trait ApplySettings<S>: Sized {
|
||||
/// Applies some settings object value to `self`.
|
||||
///
|
||||
/// The default implementation calls [`try_apply_settings()`].
|
||||
///
|
||||
/// # Panics
|
||||
///
|
||||
/// May panic if settings are invalid or cannot be applied.
|
||||
///
|
||||
/// [`try_apply_settings()`]: ApplySettings::try_apply_settings().
|
||||
#[deprecated = "Prefer `try_apply_settings()`."]
|
||||
fn apply_settings(self, settings: &S) -> Self {
|
||||
self.try_apply_settings(settings)
|
||||
.expect("Could not apply settings")
|
||||
}
|
||||
|
||||
/// Applies some settings object value to `self`.
|
||||
///
|
||||
/// # Errors
|
||||
///
|
||||
/// May return error if settings are invalid or cannot be applied.
|
||||
fn try_apply_settings(self, settings: &S) -> AsResult<Self>;
|
||||
pub trait ApplySettings<S> {
|
||||
/// Apply some settings object value to `self`.
|
||||
#[must_use]
|
||||
fn apply_settings(self, settings: &S) -> Self;
|
||||
}
|
||||
|
||||
impl<F, I, S, B> ApplySettings<ActixSettings> for HttpServer<F, I, S, B>
|
||||
@ -276,27 +256,17 @@ where
|
||||
S::Future: 'static,
|
||||
B: MessageBody + 'static,
|
||||
{
|
||||
fn apply_settings(self, settings: &ActixSettings) -> Self {
|
||||
self.try_apply_settings(settings).unwrap()
|
||||
}
|
||||
|
||||
fn try_apply_settings(mut self, settings: &ActixSettings) -> AsResult<Self> {
|
||||
for Address { host, port } in &settings.hosts {
|
||||
#[cfg(feature = "openssl")]
|
||||
{
|
||||
fn apply_settings(mut self, settings: &ActixSettings) -> Self {
|
||||
if settings.tls.enabled {
|
||||
self = self.bind_openssl(
|
||||
format!("{}:{}", host, port),
|
||||
settings.tls.get_ssl_acceptor_builder()?,
|
||||
)?;
|
||||
// for Address { host, port } in &settings.actix.hosts {
|
||||
// self = self.bind(format!("{}:{}", host, port))
|
||||
// .unwrap(/*TODO*/);
|
||||
// }
|
||||
unimplemented!("[ApplySettings] TLS support has not been implemented yet.");
|
||||
} else {
|
||||
self = self.bind(format!("{host}:{port}"))?;
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(not(feature = "openssl"))]
|
||||
{
|
||||
self = self.bind(format!("{host}:{port}"))?;
|
||||
for Address { host, port } in &settings.hosts {
|
||||
self = self.bind(format!("{host}:{port}"))
|
||||
.unwrap(/*TODO*/);
|
||||
}
|
||||
}
|
||||
|
||||
@ -349,7 +319,7 @@ where
|
||||
Timeout::Seconds(n) => self.shutdown_timeout(n as u64),
|
||||
};
|
||||
|
||||
Ok(self)
|
||||
self
|
||||
}
|
||||
}
|
||||
|
||||
@ -366,11 +336,7 @@ where
|
||||
A: de::DeserializeOwned,
|
||||
{
|
||||
fn apply_settings(self, settings: &BasicSettings<A>) -> Self {
|
||||
self.try_apply_settings(&settings.actix).unwrap()
|
||||
}
|
||||
|
||||
fn try_apply_settings(self, settings: &BasicSettings<A>) -> AsResult<Self> {
|
||||
self.try_apply_settings(&settings.actix)
|
||||
self.apply_settings(&settings.actix)
|
||||
}
|
||||
}
|
||||
|
||||
@ -383,8 +349,7 @@ mod tests {
|
||||
#[test]
|
||||
fn apply_settings() {
|
||||
let settings = Settings::parse_toml("Server.toml").unwrap();
|
||||
let server = HttpServer::new(App::new).try_apply_settings(&settings);
|
||||
assert!(server.is_ok());
|
||||
let _ = HttpServer::new(App::new).apply_settings(&settings);
|
||||
}
|
||||
|
||||
#[test]
|
||||
@ -697,7 +662,6 @@ mod tests {
|
||||
assert_eq!(settings.actix.shutdown_timeout, Timeout::Seconds(42));
|
||||
}
|
||||
|
||||
#[cfg(feature = "openssl")]
|
||||
#[test]
|
||||
fn override_field_tls_enabled() {
|
||||
let mut settings = Settings::from_default_template();
|
||||
@ -706,7 +670,6 @@ mod tests {
|
||||
assert!(settings.actix.tls.enabled);
|
||||
}
|
||||
|
||||
#[cfg(feature = "openssl")]
|
||||
#[test]
|
||||
fn override_field_with_env_var_tls_enabled() {
|
||||
let mut settings = Settings::from_default_template();
|
||||
@ -720,7 +683,6 @@ mod tests {
|
||||
assert!(settings.actix.tls.enabled);
|
||||
}
|
||||
|
||||
#[cfg(feature = "openssl")]
|
||||
#[test]
|
||||
fn override_field_tls_certificate() {
|
||||
let mut settings = Settings::from_default_template();
|
||||
@ -739,7 +701,6 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
#[cfg(feature = "openssl")]
|
||||
#[test]
|
||||
fn override_field_with_env_var_tls_certificate() {
|
||||
let mut settings = Settings::from_default_template();
|
||||
@ -762,7 +723,6 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
#[cfg(feature = "openssl")]
|
||||
#[test]
|
||||
fn override_field_tls_private_key() {
|
||||
let mut settings = Settings::from_default_template();
|
||||
@ -781,7 +741,6 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
#[cfg(feature = "openssl")]
|
||||
#[test]
|
||||
fn override_field_with_env_var_tls_private_key() {
|
||||
let mut settings = Settings::from_default_template();
|
||||
|
||||
@ -43,7 +43,7 @@ impl<'de> de::Deserialize<'de> for Backlog {
|
||||
{
|
||||
struct BacklogVisitor;
|
||||
|
||||
impl de::Visitor<'_> for BacklogVisitor {
|
||||
impl<'de> de::Visitor<'de> for BacklogVisitor {
|
||||
type Value = Backlog;
|
||||
|
||||
fn expecting(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
|
||||
@ -68,7 +68,7 @@ impl<'de> de::Deserialize<'de> for KeepAlive {
|
||||
{
|
||||
struct KeepAliveVisitor;
|
||||
|
||||
impl de::Visitor<'_> for KeepAliveVisitor {
|
||||
impl<'de> de::Visitor<'de> for KeepAliveVisitor {
|
||||
type Value = KeepAlive;
|
||||
|
||||
fn expecting(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
|
||||
@ -40,7 +40,7 @@ impl<'de> de::Deserialize<'de> for MaxConnectionRate {
|
||||
{
|
||||
struct MaxConnectionRateVisitor;
|
||||
|
||||
impl de::Visitor<'_> for MaxConnectionRateVisitor {
|
||||
impl<'de> de::Visitor<'de> for MaxConnectionRateVisitor {
|
||||
type Value = MaxConnectionRate;
|
||||
|
||||
fn expecting(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
|
||||
@ -40,7 +40,7 @@ impl<'de> de::Deserialize<'de> for MaxConnections {
|
||||
{
|
||||
struct MaxConnectionsVisitor;
|
||||
|
||||
impl de::Visitor<'_> for MaxConnectionsVisitor {
|
||||
impl<'de> de::Visitor<'de> for MaxConnectionsVisitor {
|
||||
type Value = MaxConnections;
|
||||
|
||||
fn expecting(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
|
||||
@ -8,15 +8,12 @@ mod max_connections;
|
||||
mod mode;
|
||||
mod num_workers;
|
||||
mod timeout;
|
||||
#[cfg(feature = "openssl")]
|
||||
mod tls;
|
||||
|
||||
#[cfg(feature = "openssl")]
|
||||
pub use self::tls::Tls;
|
||||
pub use self::{
|
||||
address::Address, backlog::Backlog, keep_alive::KeepAlive,
|
||||
max_connection_rate::MaxConnectionRate, max_connections::MaxConnections, mode::Mode,
|
||||
num_workers::NumWorkers, timeout::Timeout,
|
||||
num_workers::NumWorkers, timeout::Timeout, tls::Tls,
|
||||
};
|
||||
|
||||
/// Settings types for Actix Web.
|
||||
@ -60,6 +57,5 @@ pub struct ActixSettings {
|
||||
pub shutdown_timeout: Timeout,
|
||||
|
||||
/// TLS (HTTPS) configuration.
|
||||
#[cfg(feature = "openssl")]
|
||||
pub tls: Tls,
|
||||
}
|
||||
|
||||
@ -39,7 +39,7 @@ impl<'de> de::Deserialize<'de> for NumWorkers {
|
||||
{
|
||||
struct NumWorkersVisitor;
|
||||
|
||||
impl de::Visitor<'_> for NumWorkersVisitor {
|
||||
impl<'de> de::Visitor<'de> for NumWorkersVisitor {
|
||||
type Value = NumWorkers;
|
||||
|
||||
fn expecting(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
|
||||
@ -71,7 +71,7 @@ impl<'de> de::Deserialize<'de> for Timeout {
|
||||
{
|
||||
struct TimeoutVisitor;
|
||||
|
||||
impl de::Visitor<'_> for TimeoutVisitor {
|
||||
impl<'de> de::Visitor<'de> for TimeoutVisitor {
|
||||
type Value = Timeout;
|
||||
|
||||
fn expecting(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
|
||||
@ -1,16 +1,13 @@
|
||||
use std::path::PathBuf;
|
||||
|
||||
use openssl::ssl::{SslAcceptor, SslAcceptorBuilder, SslFiletype, SslMethod};
|
||||
use serde::Deserialize;
|
||||
|
||||
use crate::AsResult;
|
||||
|
||||
/// TLS (HTTPS) configuration.
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
#[doc(alias = "ssl", alias = "https")]
|
||||
pub struct Tls {
|
||||
/// True if accepting TLS connections should be enabled.
|
||||
/// Tru if accepting TLS connections should be enabled.
|
||||
pub enabled: bool,
|
||||
|
||||
/// Path to certificate `.pem` file.
|
||||
@ -19,39 +16,3 @@ pub struct Tls {
|
||||
/// Path to private key `.pem` file.
|
||||
pub private_key: PathBuf,
|
||||
}
|
||||
|
||||
impl Tls {
|
||||
/// Returns an [`SslAcceptorBuilder`] with the configured settings.
|
||||
///
|
||||
/// The result is often used with [`actix_web::HttpServer::bind_openssl()`].
|
||||
///
|
||||
/// # Example
|
||||
///
|
||||
/// ```no_run
|
||||
/// use std::io;
|
||||
/// use actix_settings::{ApplySettings as _, Settings};
|
||||
/// use actix_web::{get, web, App, HttpServer, Responder};
|
||||
///
|
||||
/// #[actix_web::main]
|
||||
/// async fn main() -> io::Result<()> {
|
||||
/// let settings = Settings::from_default_template();
|
||||
///
|
||||
/// HttpServer::new(|| {
|
||||
/// App::new().route("/", web::to(|| async { "Hello, World!" }))
|
||||
/// })
|
||||
/// .try_apply_settings(&settings)?
|
||||
/// .bind(("127.0.0.1", 8080))?
|
||||
/// .bind_openssl(("127.0.0.1", 8443), settings.actix.tls.get_ssl_acceptor_builder()?)?
|
||||
/// .run()
|
||||
/// .await
|
||||
/// }
|
||||
/// ```
|
||||
pub fn get_ssl_acceptor_builder(&self) -> AsResult<SslAcceptorBuilder> {
|
||||
let mut builder = SslAcceptor::mozilla_intermediate(SslMethod::tls())?;
|
||||
builder.set_certificate_chain_file(&self.certificate)?;
|
||||
builder.set_private_key_file(&self.private_key, SslFiletype::PEM)?;
|
||||
builder.check_private_key()?;
|
||||
|
||||
Ok(builder)
|
||||
}
|
||||
}
|
||||
|
||||
@ -12,8 +12,8 @@ struct Quoted<'a> {
|
||||
state: State,
|
||||
}
|
||||
|
||||
impl Quoted<'_> {
|
||||
pub fn new(s: &str) -> Quoted<'_> {
|
||||
impl<'a> Quoted<'a> {
|
||||
pub fn new(s: &'a str) -> Quoted<'_> {
|
||||
Quoted {
|
||||
inner: s.split('"').peekable(),
|
||||
state: State::YieldStr,
|
||||
|
||||
@ -2,16 +2,10 @@
|
||||
|
||||
## Unreleased
|
||||
|
||||
- Ensure TCP connection is properly shut down when session is dropped.
|
||||
|
||||
## 0.3.0
|
||||
|
||||
- Add `AggregatedMessage[Stream]` types.
|
||||
- Add `MessageStream::max_frame_size()` setter method.
|
||||
- Add `Session::continuation()` method.
|
||||
- The `Session::text()` method now receives an `impl Into<ByteString>`, making broadcasting text messages more efficient.
|
||||
- Take the encoded buffer when yielding bytes in the response stream rather than splitting the buffer, reducing memory use
|
||||
- Remove type parameters from `Session::{text, binary}()` methods, replacing with equivalent `impl Trait` parameters.
|
||||
- Reduce memory usage by `take`-ing (rather than `split`-ing) the encoded buffer when yielding bytes in the response stream.
|
||||
- `Session::text()` now receives an `impl Into<ByteString>`, making broadcasting text messages more efficient.
|
||||
- Allow sending continuations via `Session::continuation()`
|
||||
|
||||
## 0.2.5
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
[package]
|
||||
name = "actix-ws"
|
||||
version = "0.3.0"
|
||||
version = "0.2.0"
|
||||
description = "WebSockets for Actix Web, without actors"
|
||||
categories = ["web-programming::websocket"]
|
||||
keywords = ["actix", "web", "websocket", "websockets", "streaming"]
|
||||
keywords = ["actix", "web", "websocket", "websockets", "http"]
|
||||
authors = [
|
||||
"asonix <asonix@asonix.dog>",
|
||||
"Rob Ede <robjtede@icloud.com>",
|
||||
@ -20,12 +20,13 @@ actix-http = { version = "3", default-features = false, features = ["ws"] }
|
||||
actix-web = { version = "4", default-features = false }
|
||||
bytestring = "1"
|
||||
futures-core = "0.3.17"
|
||||
tokio = { version = "1.24", features = ["sync"] }
|
||||
tokio = { version = "1", features = ["sync"] }
|
||||
|
||||
[dev-dependencies]
|
||||
actix-web = "4.8"
|
||||
futures-util = { version = "0.3.17", default-features = false, features = ["std"] }
|
||||
tokio = { version = "1.24", features = ["sync", "rt", "macros"] }
|
||||
pretty_env_logger = "0.5"
|
||||
tokio = { version = "1", features = ["sync", "rt", "macros"] }
|
||||
tracing = "0.1.30"
|
||||
tracing-subscriber = { version = "0.3", features = ["env-filter"] }
|
||||
|
||||
|
||||
@ -1,21 +1,23 @@
|
||||
# `actix-ws`
|
||||
# Actix WS (Next Gen)
|
||||
|
||||
> WebSockets for Actix Web, without actors.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
[](https://crates.io/crates/actix-ws)
|
||||
[](https://docs.rs/actix-ws/0.3.0)
|
||||
|
||||
|
||||
<br />
|
||||
[](https://deps.rs/crate/actix-ws/0.3.0)
|
||||
[](https://crates.io/crates/actix-ws)
|
||||
[](https://discord.gg/NWpN5mmg3x)
|
||||
[](https://docs.rs/actix-ws/0.2.0)
|
||||
|
||||
[](https://deps.rs/crate/actix-ws/0.2.0)
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
## Example
|
||||
## Documentation & Resources
|
||||
|
||||
- [API Documentation](https://docs.rs/actix-ws)
|
||||
- [Example Chat Project](https://github.com/actix/examples/tree/master/websockets/chat-actorless)
|
||||
- Minimum Supported Rust Version (MSRV): 1.75
|
||||
|
||||
## Usage
|
||||
|
||||
```rust
|
||||
use actix_web::{middleware::Logger, web, App, HttpRequest, HttpServer, Responder};
|
||||
@ -25,7 +27,7 @@ async fn ws(req: HttpRequest, body: web::Payload) -> actix_web::Result<impl Resp
|
||||
let (response, mut session, mut msg_stream) = actix_ws::handle(&req, body)?;
|
||||
|
||||
actix_web::rt::spawn(async move {
|
||||
while let Some(Ok(msg)) = msg_stream.recv().await {
|
||||
while let Some(Ok(msg)) = msg_stream.next().await {
|
||||
match msg {
|
||||
Message::Ping(bytes) => {
|
||||
if session.pong(&bytes).await.is_err() {
|
||||
@ -58,12 +60,6 @@ async fn main() -> std::io::Result<()> {
|
||||
}
|
||||
```
|
||||
|
||||
## Resources
|
||||
|
||||
- [API Documentation](https://docs.rs/actix-ws)
|
||||
- [Example Chat Project](https://github.com/actix/examples/tree/master/websockets/chat-actorless)
|
||||
- Minimum Supported Rust Version (MSRV): 1.75
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under either of
|
||||
|
||||
@ -7,7 +7,7 @@ use std::{
|
||||
use actix_web::{
|
||||
middleware::Logger, web, web::Html, App, HttpRequest, HttpResponse, HttpServer, Responder,
|
||||
};
|
||||
use actix_ws::{AggregatedMessage, Session};
|
||||
use actix_ws::{Message, Session};
|
||||
use bytestring::ByteString;
|
||||
use futures_util::{stream::FuturesUnordered, StreamExt as _};
|
||||
use tokio::sync::Mutex;
|
||||
@ -65,10 +65,7 @@ async fn ws(
|
||||
body: web::Payload,
|
||||
chat: web::Data<Chat>,
|
||||
) -> Result<HttpResponse, actix_web::Error> {
|
||||
let (response, mut session, stream) = actix_ws::handle(&req, body)?;
|
||||
|
||||
// increase the maximum allowed frame size to 128KiB and aggregate continuation frames
|
||||
let mut stream = stream.max_frame_size(128 * 1024).aggregate_continuations();
|
||||
let (response, mut session, mut stream) = actix_ws::handle(&req, body)?;
|
||||
|
||||
chat.insert(session.clone()).await;
|
||||
tracing::info!("Inserted session");
|
||||
@ -94,29 +91,30 @@ async fn ws(
|
||||
});
|
||||
|
||||
actix_web::rt::spawn(async move {
|
||||
while let Some(Ok(msg)) = stream.recv().await {
|
||||
while let Some(Ok(msg)) = stream.next().await {
|
||||
match msg {
|
||||
AggregatedMessage::Ping(bytes) => {
|
||||
Message::Ping(bytes) => {
|
||||
if session.pong(&bytes).await.is_err() {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
AggregatedMessage::Text(string) => {
|
||||
tracing::info!("Relaying text, {string}");
|
||||
chat.send(string).await;
|
||||
Message::Text(msg) => {
|
||||
tracing::info!("Relaying msg: {msg}");
|
||||
chat.send(msg).await;
|
||||
}
|
||||
|
||||
AggregatedMessage::Close(reason) => {
|
||||
Message::Close(reason) => {
|
||||
let _ = session.close(reason).await;
|
||||
tracing::info!("Got close, bailing");
|
||||
return;
|
||||
}
|
||||
|
||||
AggregatedMessage::Pong(_) => {
|
||||
Message::Continuation(_) => {
|
||||
let _ = session.close(None).await;
|
||||
tracing::info!("Got continuation, bailing");
|
||||
return;
|
||||
}
|
||||
Message::Pong(_) => {
|
||||
*alive.lock().await = Instant::now();
|
||||
}
|
||||
|
||||
_ => (),
|
||||
};
|
||||
}
|
||||
|
||||
@ -1,216 +0,0 @@
|
||||
//! WebSocket stream for aggregating continuation frames.
|
||||
|
||||
use std::{
|
||||
future::poll_fn,
|
||||
io, mem,
|
||||
pin::Pin,
|
||||
task::{ready, Context, Poll},
|
||||
};
|
||||
|
||||
use actix_http::ws::{CloseReason, Item, Message, ProtocolError};
|
||||
use actix_web::web::{Bytes, BytesMut};
|
||||
use bytestring::ByteString;
|
||||
use futures_core::Stream;
|
||||
|
||||
use crate::MessageStream;
|
||||
|
||||
pub(crate) enum ContinuationKind {
|
||||
Text,
|
||||
Binary,
|
||||
}
|
||||
|
||||
/// WebSocket message with any continuations aggregated together.
|
||||
#[derive(Debug, PartialEq, Eq)]
|
||||
pub enum AggregatedMessage {
|
||||
/// Text message.
|
||||
Text(ByteString),
|
||||
|
||||
/// Binary message.
|
||||
Binary(Bytes),
|
||||
|
||||
/// Ping message.
|
||||
Ping(Bytes),
|
||||
|
||||
/// Pong message.
|
||||
Pong(Bytes),
|
||||
|
||||
/// Close message with optional reason.
|
||||
Close(Option<CloseReason>),
|
||||
}
|
||||
|
||||
/// Stream of messages from a WebSocket client, with continuations aggregated.
|
||||
pub struct AggregatedMessageStream {
|
||||
stream: MessageStream,
|
||||
current_size: usize,
|
||||
max_size: usize,
|
||||
continuations: Vec<Bytes>,
|
||||
continuation_kind: ContinuationKind,
|
||||
}
|
||||
|
||||
impl AggregatedMessageStream {
|
||||
#[must_use]
|
||||
pub(crate) fn new(stream: MessageStream) -> Self {
|
||||
AggregatedMessageStream {
|
||||
stream,
|
||||
current_size: 0,
|
||||
max_size: 1024 * 1024,
|
||||
continuations: Vec::new(),
|
||||
continuation_kind: ContinuationKind::Binary,
|
||||
}
|
||||
}
|
||||
|
||||
/// Sets the maximum allowed size for aggregated continuations, in bytes.
|
||||
///
|
||||
/// By default, up to 1 MiB is allowed.
|
||||
///
|
||||
/// ```no_run
|
||||
/// # use actix_ws::AggregatedMessageStream;
|
||||
/// # async fn test(stream: AggregatedMessageStream) {
|
||||
/// // increase the allowed size from 1MB to 8MB
|
||||
/// let mut stream = stream.max_continuation_size(8 * 1024 * 1024);
|
||||
///
|
||||
/// while let Some(Ok(msg)) = stream.recv().await {
|
||||
/// // handle message
|
||||
/// }
|
||||
/// # }
|
||||
/// ```
|
||||
#[must_use]
|
||||
pub fn max_continuation_size(mut self, max_size: usize) -> Self {
|
||||
self.max_size = max_size;
|
||||
self
|
||||
}
|
||||
|
||||
/// Waits for the next item from the aggregated message stream.
|
||||
///
|
||||
/// This is a convenience for calling the [`Stream`](Stream::poll_next()) implementation.
|
||||
///
|
||||
/// ```no_run
|
||||
/// # use actix_ws::AggregatedMessageStream;
|
||||
/// # async fn test(mut stream: AggregatedMessageStream) {
|
||||
/// while let Some(Ok(msg)) = stream.recv().await {
|
||||
/// // handle message
|
||||
/// }
|
||||
/// # }
|
||||
/// ```
|
||||
#[must_use]
|
||||
pub async fn recv(&mut self) -> Option<<Self as Stream>::Item> {
|
||||
poll_fn(|cx| Pin::new(&mut *self).poll_next(cx)).await
|
||||
}
|
||||
}
|
||||
|
||||
fn size_error() -> Poll<Option<Result<AggregatedMessage, ProtocolError>>> {
|
||||
Poll::Ready(Some(Err(ProtocolError::Io(io::Error::other(
|
||||
"Exceeded maximum continuation size",
|
||||
)))))
|
||||
}
|
||||
|
||||
impl Stream for AggregatedMessageStream {
|
||||
type Item = Result<AggregatedMessage, ProtocolError>;
|
||||
|
||||
fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
|
||||
let this = self.get_mut();
|
||||
|
||||
let Some(msg) = ready!(Pin::new(&mut this.stream).poll_next(cx)?) else {
|
||||
return Poll::Ready(None);
|
||||
};
|
||||
|
||||
match msg {
|
||||
Message::Continuation(item) => match item {
|
||||
Item::FirstText(bytes) => {
|
||||
this.continuation_kind = ContinuationKind::Text;
|
||||
this.current_size += bytes.len();
|
||||
|
||||
if this.current_size > this.max_size {
|
||||
this.continuations.clear();
|
||||
return size_error();
|
||||
}
|
||||
|
||||
this.continuations.push(bytes);
|
||||
|
||||
Poll::Pending
|
||||
}
|
||||
|
||||
Item::FirstBinary(bytes) => {
|
||||
this.continuation_kind = ContinuationKind::Binary;
|
||||
this.current_size += bytes.len();
|
||||
|
||||
if this.current_size > this.max_size {
|
||||
this.continuations.clear();
|
||||
return size_error();
|
||||
}
|
||||
|
||||
this.continuations.push(bytes);
|
||||
|
||||
Poll::Pending
|
||||
}
|
||||
|
||||
Item::Continue(bytes) => {
|
||||
this.current_size += bytes.len();
|
||||
|
||||
if this.current_size > this.max_size {
|
||||
this.continuations.clear();
|
||||
return size_error();
|
||||
}
|
||||
|
||||
this.continuations.push(bytes);
|
||||
|
||||
Poll::Pending
|
||||
}
|
||||
|
||||
Item::Last(bytes) => {
|
||||
this.current_size += bytes.len();
|
||||
|
||||
if this.current_size > this.max_size {
|
||||
// reset current_size, as this is the last message for
|
||||
// the current continuation
|
||||
this.current_size = 0;
|
||||
this.continuations.clear();
|
||||
|
||||
return size_error();
|
||||
}
|
||||
|
||||
this.continuations.push(bytes);
|
||||
let bytes = collect(&mut this.continuations);
|
||||
|
||||
this.current_size = 0;
|
||||
|
||||
match this.continuation_kind {
|
||||
ContinuationKind::Text => {
|
||||
Poll::Ready(Some(match ByteString::try_from(bytes) {
|
||||
Ok(bytestring) => Ok(AggregatedMessage::Text(bytestring)),
|
||||
Err(err) => Err(ProtocolError::Io(io::Error::new(
|
||||
io::ErrorKind::InvalidData,
|
||||
err.to_string(),
|
||||
))),
|
||||
}))
|
||||
}
|
||||
ContinuationKind::Binary => {
|
||||
Poll::Ready(Some(Ok(AggregatedMessage::Binary(bytes))))
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
Message::Text(text) => Poll::Ready(Some(Ok(AggregatedMessage::Text(text)))),
|
||||
Message::Binary(binary) => Poll::Ready(Some(Ok(AggregatedMessage::Binary(binary)))),
|
||||
Message::Ping(ping) => Poll::Ready(Some(Ok(AggregatedMessage::Ping(ping)))),
|
||||
Message::Pong(pong) => Poll::Ready(Some(Ok(AggregatedMessage::Pong(pong)))),
|
||||
Message::Close(close) => Poll::Ready(Some(Ok(AggregatedMessage::Close(close)))),
|
||||
|
||||
Message::Nop => unreachable!("MessageStream should not produce no-ops"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn collect(continuations: &mut Vec<Bytes>) -> Bytes {
|
||||
let continuations = mem::take(continuations);
|
||||
let total_len = continuations.iter().map(|b| b.len()).sum();
|
||||
|
||||
let mut buf = BytesMut::with_capacity(total_len);
|
||||
|
||||
for chunk in continuations {
|
||||
buf.extend(chunk);
|
||||
}
|
||||
|
||||
buf.freeze()
|
||||
}
|
||||
@ -15,15 +15,25 @@ use actix_web::{
|
||||
web::{Bytes, BytesMut},
|
||||
Error,
|
||||
};
|
||||
use bytestring::ByteString;
|
||||
use futures_core::stream::Stream;
|
||||
use tokio::sync::mpsc::Receiver;
|
||||
|
||||
use crate::AggregatedMessageStream;
|
||||
|
||||
/// Response body for a WebSocket.
|
||||
/// A response body for Websocket HTTP Requests
|
||||
pub struct StreamingBody {
|
||||
session_rx: Receiver<Message>,
|
||||
|
||||
messages: VecDeque<Message>,
|
||||
buf: BytesMut,
|
||||
codec: Codec,
|
||||
closing: bool,
|
||||
}
|
||||
|
||||
/// A stream of Messages from a websocket client
|
||||
///
|
||||
/// Messages can be accessed via the stream's `.next()` method
|
||||
pub struct MessageStream {
|
||||
payload: Payload,
|
||||
|
||||
messages: VecDeque<Message>,
|
||||
buf: BytesMut,
|
||||
codec: Codec,
|
||||
@ -42,16 +52,6 @@ impl StreamingBody {
|
||||
}
|
||||
}
|
||||
|
||||
/// Stream of messages from a WebSocket client.
|
||||
pub struct MessageStream {
|
||||
payload: Payload,
|
||||
|
||||
messages: VecDeque<Message>,
|
||||
buf: BytesMut,
|
||||
codec: Codec,
|
||||
closing: bool,
|
||||
}
|
||||
|
||||
impl MessageStream {
|
||||
pub(super) fn new(payload: Payload) -> Self {
|
||||
MessageStream {
|
||||
@ -63,40 +63,7 @@ impl MessageStream {
|
||||
}
|
||||
}
|
||||
|
||||
/// Sets the maximum permitted size for received WebSocket frames, in bytes.
|
||||
///
|
||||
/// By default, up to 64KiB is allowed.
|
||||
///
|
||||
/// Any received frames larger than the permitted value will return
|
||||
/// `Err(ProtocolError::Overflow)` instead.
|
||||
///
|
||||
/// ```no_run
|
||||
/// # use actix_ws::MessageStream;
|
||||
/// # fn test(stream: MessageStream) {
|
||||
/// // increase permitted frame size from 64KB to 1MB
|
||||
/// let stream = stream.max_frame_size(1024 * 1024);
|
||||
/// # }
|
||||
/// ```
|
||||
#[must_use]
|
||||
pub fn max_frame_size(mut self, max_size: usize) -> Self {
|
||||
self.codec = self.codec.max_size(max_size);
|
||||
self
|
||||
}
|
||||
|
||||
/// Returns a stream wrapper that collects continuation frames into their equivalent aggregated
|
||||
/// forms, i.e., binary or text.
|
||||
///
|
||||
/// By default, continuations will be aggregated up to 1MiB in size (customizable with
|
||||
/// [`AggregatedMessageStream::max_continuation_size()`]). The stream implementation returns an
|
||||
/// error if this size is exceeded.
|
||||
#[must_use]
|
||||
pub fn aggregate_continuations(self) -> AggregatedMessageStream {
|
||||
AggregatedMessageStream::new(self)
|
||||
}
|
||||
|
||||
/// Waits for the next item from the message stream
|
||||
///
|
||||
/// This is a convenience for calling the [`Stream`](Stream::poll_next()) implementation.
|
||||
/// Wait for the next item from the message stream
|
||||
///
|
||||
/// ```no_run
|
||||
/// # use actix_ws::MessageStream;
|
||||
@ -106,7 +73,6 @@ impl MessageStream {
|
||||
/// }
|
||||
/// # }
|
||||
/// ```
|
||||
#[must_use]
|
||||
pub async fn recv(&mut self) -> Option<Result<Message, ProtocolError>> {
|
||||
poll_fn(|cx| Pin::new(&mut *self).poll_next(cx)).await
|
||||
}
|
||||
@ -145,10 +111,6 @@ impl Stream for StreamingBody {
|
||||
return Poll::Ready(Some(Ok(mem::take(&mut this.buf).freeze())));
|
||||
}
|
||||
|
||||
if this.closing {
|
||||
return Poll::Ready(None);
|
||||
}
|
||||
|
||||
Poll::Pending
|
||||
}
|
||||
}
|
||||
@ -173,8 +135,11 @@ impl Stream for MessageStream {
|
||||
Poll::Ready(Some(Ok(bytes))) => {
|
||||
this.buf.extend_from_slice(&bytes);
|
||||
}
|
||||
Poll::Ready(Some(Err(err))) => {
|
||||
return Poll::Ready(Some(Err(ProtocolError::Io(io::Error::other(err)))));
|
||||
Poll::Ready(Some(Err(e))) => {
|
||||
return Poll::Ready(Some(Err(ProtocolError::Io(io::Error::new(
|
||||
io::ErrorKind::Other,
|
||||
e.to_string(),
|
||||
)))));
|
||||
}
|
||||
Poll::Ready(None) => {
|
||||
this.closing = true;
|
||||
@ -189,11 +154,12 @@ impl Stream for MessageStream {
|
||||
while let Some(frame) = this.codec.decode(&mut this.buf)? {
|
||||
let message = match frame {
|
||||
Frame::Text(bytes) => {
|
||||
ByteString::try_from(bytes)
|
||||
.map(Message::Text)
|
||||
.map_err(|err| {
|
||||
ProtocolError::Io(io::Error::new(io::ErrorKind::InvalidData, err))
|
||||
let s = std::str::from_utf8(&bytes)
|
||||
.map_err(|e| {
|
||||
ProtocolError::Io(io::Error::new(io::ErrorKind::Other, e.to_string()))
|
||||
})?
|
||||
.to_string();
|
||||
Message::Text(s.into())
|
||||
}
|
||||
Frame::Binary(bytes) => Message::Binary(bytes),
|
||||
Frame::Ping(bytes) => Message::Ping(bytes),
|
||||
@ -15,20 +15,17 @@ use actix_http::{
|
||||
use actix_web::{web, HttpRequest, HttpResponse};
|
||||
use tokio::sync::mpsc::channel;
|
||||
|
||||
mod aggregated;
|
||||
mod fut;
|
||||
mod session;
|
||||
mod stream;
|
||||
|
||||
pub use self::{
|
||||
aggregated::{AggregatedMessage, AggregatedMessageStream},
|
||||
fut::{MessageStream, StreamingBody},
|
||||
session::{Closed, Session},
|
||||
stream::{MessageStream, StreamingBody},
|
||||
};
|
||||
|
||||
/// Begin handling websocket traffic
|
||||
///
|
||||
/// ```no_run
|
||||
/// use std::io;
|
||||
/// use actix_web::{middleware::Logger, web, App, HttpRequest, HttpServer, Responder};
|
||||
/// use actix_ws::Message;
|
||||
/// use futures_util::StreamExt as _;
|
||||
@ -44,7 +41,6 @@ pub use self::{
|
||||
/// return;
|
||||
/// }
|
||||
/// }
|
||||
///
|
||||
/// Message::Text(msg) => println!("Got text: {msg}"),
|
||||
/// _ => break,
|
||||
/// }
|
||||
@ -57,15 +53,17 @@ pub use self::{
|
||||
/// }
|
||||
///
|
||||
/// #[tokio::main(flavor = "current_thread")]
|
||||
/// async fn main() -> io::Result<()> {
|
||||
/// async fn main() -> std::io::Result<()> {
|
||||
/// HttpServer::new(move || {
|
||||
/// App::new()
|
||||
/// .route("/ws", web::get().to(ws))
|
||||
/// .wrap(Logger::default())
|
||||
/// .route("/ws", web::get().to(ws))
|
||||
/// })
|
||||
/// .bind(("127.0.0.1", 8080))?
|
||||
/// .bind("127.0.0.1:8080")?
|
||||
/// .run()
|
||||
/// .await
|
||||
/// .await?;
|
||||
///
|
||||
/// Ok(())
|
||||
/// }
|
||||
/// ```
|
||||
pub fn handle(
|
||||
|
||||
36
justfile
36
justfile
@ -19,44 +19,24 @@ msrv_rustup := "+" + msrv
|
||||
clippy:
|
||||
cargo {{ toolchain }} clippy --workspace --all-targets --all-features
|
||||
|
||||
# Format project.
|
||||
# Format workspace.
|
||||
[group("lint")]
|
||||
fmt: update-readmes
|
||||
cargo +nightly fmt
|
||||
fd --type=file --hidden --extension=yml --extension=md --exec-batch npx -y prettier --write
|
||||
|
||||
# Check project.
|
||||
[group("lint")]
|
||||
check:
|
||||
cargo +nightly fmt -- --check
|
||||
fd --type=file --hidden --extension=yml --extension=md --exec-batch npx -y prettier --check
|
||||
fd --hidden --extension=yml --extension=md --exec-batch npx -y prettier --write
|
||||
|
||||
# Update READMEs from crate root documentation.
|
||||
[group("lint")]
|
||||
update-readmes:
|
||||
cd ./actix-cors && cargo rdme --force
|
||||
cd ./actix-identity && cargo rdme --force
|
||||
cd ./actix-session && cargo rdme --force
|
||||
fd README.md --exec-batch npx -y prettier --write
|
||||
cd ./actix-identity && cargo rdme --force
|
||||
fd README.md --exec-batch -- npx -y prettier --write
|
||||
|
||||
# Test workspace code.
|
||||
[group("test")]
|
||||
test:
|
||||
cargo {{ toolchain }} nextest run --workspace --all-features
|
||||
cargo {{ toolchain }} test --doc --workspace --all-features
|
||||
|
||||
# Downgrade dev-dependencies necessary to run MSRV checks/tests.
|
||||
[private]
|
||||
downgrade-for-msrv:
|
||||
cargo update -p=native-tls --precise=0.2.13
|
||||
cargo update -p=litemap --precise=0.7.4
|
||||
cargo update -p=zerofrom --precise=0.1.5
|
||||
|
||||
# Test workspace using MSRV.
|
||||
[group("test")]
|
||||
test-msrv:
|
||||
@just downgrade-for-msrv
|
||||
@just toolchain={{ msrv_rustup }} test
|
||||
|
||||
# Test workspace code and docs.
|
||||
[group("test")]
|
||||
@ -85,17 +65,15 @@ test-docs:
|
||||
# Document crates in workspace.
|
||||
[group("docs")]
|
||||
doc *args: && doc-set-workspace-crates
|
||||
rm -f "$(cargo metadata --format-version=1 | jq -r '.target_directory')/doc/crates.js"
|
||||
RUSTDOCFLAGS="--cfg=docsrs -Dwarnings" cargo +nightly doc --workspace --all-features {{ args }}
|
||||
|
||||
[group("docs")]
|
||||
[private]
|
||||
[group("docs")]
|
||||
doc-set-workspace-crates:
|
||||
#!/usr/bin/env bash
|
||||
(
|
||||
echo "window.ALL_CRATES = "
|
||||
cargo metadata --format-version=1 \
|
||||
| jq '[.packages[] | select(.source == null) | .targets | map(select(.doc) | .name)] | flatten'
|
||||
echo "window.ALL_CRATES ="
|
||||
cargo metadata --format-version=1 | jq '[.packages[] | select(.source == null) | .name]'
|
||||
echo ";"
|
||||
) > "$(cargo metadata --format-version=1 | jq -r '.target_directory')/doc/crates.js"
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user