[WIP] Added RequestContextStore, RequestContext and SignedPrivateCookieJar

Cargo.toml

@@ -83,7 +83,7 @@ toml = "0.8"
 async-trait = { workspace = true }
 
 axum = { workspace = true }
-axum-extra = { version = "0.9", features = ["cookie"] }
+axum-extra = { version = "0.9", features = ["cookie", "cookie-private"] }
 regex = { workspace = true }
 fs-err = "2.11.0"
 # mailer
@@ -133,6 +133,9 @@ object_store = { version = "0.11.0", default-features = false }
 # cache
 moka = { version = "0.12.7", features = ["sync"], optional = true }
 
+# sessions
+tower-sessions = "0.12"
+
 # Scheduler
 tokio-cron-scheduler = { version = "0.11.0", features = ["signal"] }
 english-to-cron = { version = "0.1.2" }

examples/demo/config/development.yaml

@@ -27,7 +27,7 @@ logger:
 # <snip id="configuration-server">
 server:
   # Port on which the server will listen. the server binding is 0.0.0.0:{PORT}
-  port: {{ get_env(name="NODE_PORT", default=5150) }}
+  port: {{get_env(name="NODE_PORT", default=5150)}}
   # The UI hostname or IP address that mailers will point to.
   host: http://localhost
 # </snip>

examples/demo/config/test.yaml

@@ -51,6 +51,21 @@ server:
       enable: true
     cors:
       enable: true
+    request_context:
+      enable: true
+      session_config:
+        name: session
+        http_only: true
+        same_site:
+          type: Lax
+        expiry: 3600
+        secure: false
+        path: /
+      # domain: ""
+      session_store:
+        type: Cookie
+        value:
+          private_key: [ 219, 25, 129, 200, 66, 52, 72, 66, 249, 60, 206, 40, 77, 150, 2, 8, 30, 192, 221, 5, 243, 74, 17, 172, 109, 96, 218, 46, 235, 118, 131, 150, 224, 205, 55, 147, 45, 151, 245, 23, 250, 48, 133, 115, 105, 252, 193, 15, 162, 167, 77, 189, 169, 91, 205, 172, 120, 254, 136, 111, 167, 161, 255, 107 ]
       # Set the value of the [`Access-Control-Allow-Origin`][mdn] header
       # allow_origins:
       #   - https://loco.rs

examples/demo/config/teste2e.yaml

@@ -40,7 +40,21 @@ server:
       enable: true
       # Duration time in milliseconds.
       timeout: 5000
-
+    request_context:
+      enable: true
+      session_config:
+        name: session
+        http_only: true
+        same_site:
+          type: Lax
+        expiry: 3600
+        secure: false
+        path: /
+      # domain: ""
+      session_store:
+        type: Cookie
+        value:
+          private_key: [ 219, 25, 129, 200, 66, 52, 72, 66, 249, 60, 206, 40, 77, 150, 2, 8, 30, 192, 221, 5, 243, 74, 17, 172, 109, 96, 218, 46, 235, 118, 131, 150, 224, 205, 55, 147, 45, 151, 245, 23, 250, 48, 133, 115, 105, 252, 193, 15, 162, 167, 77, 189, 169, 91, 205, 172, 120, 254, 136, 111, 167, 161, 255, 107 ]
 # Worker Configuration
 workers:
   # specifies the worker mode. Options:
@@ -77,7 +91,7 @@ mailer:
 # Database Configuration
 database:
   # Database connection URI
-  uri: {{get_env(name="DATABASE_URL", default="postgres://localhost:5432/loco_app")}}
+  uri: {{get_env(name="DATABASE_URL", default="postgres://loco:loco@localhost:5432/loco_app_test")}}
   # When enabled, the sql query will be logged.
   enable_logging: false
   # Set the timeout duration when acquiring a connection.

examples/demo/src/controllers/mysession.rs

@@ -1,6 +1,10 @@
 #![allow(clippy::unused_async)]
+
+use axum::{debug_handler, Extension};
 use axum_session::{Session, SessionNullPool};
-use loco_rs::prelude::*;
+use loco_rs::{prelude::*, request_context::RequestContext};
+
+const REQUEST_CONTEXT_DATA_KEY: &str = "alan";
 
 /// Get a session
 ///
@@ -11,6 +15,46 @@ pub async fn get_session(_session: Session<SessionNullPool>) -> Result<Response>
     format::empty()
 }
 
+/// Set a request context
+///
+/// # Errors
+///
+/// This function will return an error if result fails
+#[debug_handler]
+pub async fn create_request_context(mut req: RequestContext) -> Result<Response> {
+    let data = "turing".to_string();
+    req.insert(REQUEST_CONTEXT_DATA_KEY, data.clone()).await?;
+    tracing::info!(
+        "Request Context data set - Key: {:?}, Value: {:?}",
+        REQUEST_CONTEXT_DATA_KEY,
+        data
+    );
+    Ok(data.into_response())
+}
+
+/// Get a request context
+///
+/// # Errors
+///
+/// This function will return an error if result fails
+#[debug_handler]
+pub async fn get_request_context(mut req: Extension<RequestContext>) -> Result<Response> {
+    let data = req
+        .get::<String>(REQUEST_CONTEXT_DATA_KEY)
+        .await?
+        .unwrap_or_default();
+    tracing::info!(
+        "Request Context data retrieved - Key: {:?}, Value: {:?}",
+        REQUEST_CONTEXT_DATA_KEY,
+        data
+    );
+    Ok(data.into_response())
+}
+
 pub fn routes() -> Routes {
-    Routes::new().prefix("mysession").add("/", get(get_session))
+    Routes::new()
+        .prefix("mysession")
+        .add("/", get(get_session))
+        .add("/request_context", post(create_request_context))
+        .add("/request_context", get(get_request_context))
 }

examples/demo/src/models/roles.rs

@@ -65,7 +65,7 @@ impl super::_entities::roles::Model {
     pub async fn find_by_user(db: &DatabaseConnection, user: &users::Model) -> ModelResult<Self> {
         let role = roles::Entity::find()
             .inner_join(users_roles::Entity)
-            .filter(users_roles::Column::UsersId.eq(user.id.clone()))
+            .filter(users_roles::Column::UsersId.eq(user.id))
             .one(db)
             .await?;
         role.ok_or_else(|| ModelError::EntityNotFound)

examples/demo/tests/cmd/cli.trycmd

@@ -100,6 +100,8 @@ $ demo_app-cli routes --environment test
 [GET] /mylayer/echo
 [GET] /mylayer/user
 [GET] /mysession
+[POST] /mysession/request_context
+[GET] /mysession/request_context
 [GET] /notes
 [POST] /notes
 [GET] /notes/:id

examples/demo/tests/requests/mod.rs

@@ -1,6 +1,7 @@
 mod auth;
 mod cache;
 mod mylayer;
+mod mysession;
 mod notes;
 mod ping;
 mod prepare_data;

examples/demo/tests/requests/mysession.rs

@@ -0,0 +1,70 @@
+use axum::http::HeaderName;
+use demo_app::app::App;
+use serial_test::serial;
+use loco_rs::testing::prelude::*;
+
+macro_rules! configure_insta {
+    ($($expr:expr),*) => {
+        let mut settings = insta::Settings::clone_current();
+        settings.set_prepend_module_to_snapshot(false);
+        settings.set_snapshot_suffix("cache");
+        let _guard = settings.bind_to_scope();
+    };
+}
+
+#[tokio::test]
+#[serial]
+async fn set_request_context_data() {
+    configure_insta!();
+    request::<App, _, _>(|request, _ctx| async move {
+        let response = request.post("/mysession/request_context").await;
+
+        // Get Cookie from response header
+        let headers = response.headers();
+        let cookie = headers.get("set-cookie");
+        assert_eq!(response.status_code(), 200);
+        assert_eq!(response.text(), "turing");
+        assert!(cookie.is_some());
+    })
+    .await;
+}
+#[tokio::test]
+#[serial]
+async fn get_request_context_without_setting_data() {
+    configure_insta!();
+    request::<App, _, _>(|request, _ctx| async move {
+        let response = request.get("/mysession/request_context").await;
+        // Get response body
+        assert_eq!(response.status_code(), 200);
+        assert_eq!(response.text(), "")
+    })
+    .await;
+}
+
+#[tokio::test]
+#[serial]
+async fn get_request_context_with_setting_data() {
+    configure_insta!();
+    request::<App, _, _>(|request, _ctx| async move {
+        let response = request.post("/mysession/request_context").await;
+        // Get Cookie from response header
+        let headers = response.headers();
+        let cookie_value = headers.get("set-cookie");
+        assert_eq!(response.status_code(), 200);
+        assert_eq!(response.text(), "turing");
+        assert!(cookie_value.is_some());
+        let data = response.text();
+
+        let response = request
+            .get("/mysession/request_context")
+            .add_header(
+                "cookie".parse::<HeaderName>().unwrap(),
+                cookie_value.unwrap().clone(),
+            )
+            .await;
+        // Get response body
+        assert_eq!(response.status_code(), 200);
+        assert_eq!(response.text(), data);
+    })
+    .await;
+}

src/app.rs

@@ -23,6 +23,7 @@ use crate::{
     },
     environment::Environment,
     mailer::EmailSender,
+    request_context::TowerSessionStore,
     storage::Storage,
     task::Tasks,
     Result,
@@ -52,6 +53,8 @@ pub struct AppContext {
     pub storage: Arc<Storage>,
     // Cache instance for the application
     pub cache: Arc<cache::Cache>,
+    /// Request context session store
+    pub session_store: Option<TowerSessionStore>,
 }
 
 /// A trait that defines hooks for customizing and extending the behavior of a
@@ -187,6 +190,7 @@ pub trait Hooks: Send {
 
     // Provides the options to change Loco [`AppContext`] after initialization.
     async fn after_context(ctx: AppContext) -> Result<AppContext> {
+        // ctx.session_store = Some(CustomSessionStore::new(MemoryStore::default()));
         Ok(ctx)
     }
 

src/boot.rs

@@ -4,6 +4,7 @@
 use std::path::PathBuf;
 
 use axum::Router;
+use colored::Colorize;
 #[cfg(feature = "with-db")]
 use sea_orm_migration::MigratorTrait;
 use tokio::{select, signal, task::JoinHandle};
@@ -342,6 +343,7 @@ pub async fn create_context<H: Hooks>(environment: &Environment) -> Result<AppCo
         cache: cache::Cache::new(cache::drivers::null::new()).into(),
         config,
         mailer,
+        session_store: None,
     };
 
     H::after_context(ctx).await

src/config.rs

@@ -245,6 +245,15 @@ pub struct RedisQueueConfig {
     pub num_workers: u32,
 }
 
+/// Redis Configuration
+///
+/// Example (development):
+/// ```yaml
+/// # config/development.yaml
+/// redis:
+///   uri: redis://127.0.0.1/
+///   dangerously_flush: false
+/// ```
 #[derive(Debug, Clone, Deserialize, Serialize)]
 pub struct PostgresQueueConfig {
     pub uri: String,