Feature/session key

[miketwenty1]

PR Type

Feature

PR Checklist

• Tests for the changes have been added / updated.
• Documentation comments have been added / updated.
• A changelog entry has been made for the appropriate packages.
• Format code with the nightly rustfmt (cargo +nightly fmt).

Overview

The goal is add this feature to be utilized by the redis session middleware without breaking any other session middleware.

Notes from discussion:
#306

Dev Notes:
This is not a working PR, changes will come after feedback.

[LukeMathWalker]

This must be an Option, since the key will only exist if the user has an active session.

[LukeMathWalker]

It should be populated by

actix-extras/actix-session/src/middleware.rs

Line 221 in 1774b8a

Session::set_session(&mut req, session_state);

using the value from

actix-extras/actix-session/src/middleware.rs

Line 218 in 1774b8a

let (session_key, session_state) =

[miketwenty1]

and this logic needs to be replicated in session.rs? This is tricky for me to understand. This is populated within get_session_key fn I'm proposing?

[LukeMathWalker]

You can add a Session::set_session_key method which is then invoked by middleware.rs, next to the passage I highlighted.

[LukeMathWalker]

You don't want to expose the inner field here.
We can change SessionKey to be SessionKey(secrecy::Secret<String>) and expose into_inner/inner methods to access the inner value.

[miketwenty1]

In the code we are impl a AsRef

actix-extras/actix-session/src/storage/session_key.rs

Line 38 in d2b7229

impl AsRef<str> for SessionKey {

method `as_ref` has an incompatible type for trait
expected fn pointer `fn(&storage::session_key::SessionKey) -> &str`
   found fn pointer `fn(&storage::session_key::SessionKey) -> &secrecy::Secret<std::string::String>`

However it's not clear to me how to do with with secrecy data
https://docs.rs/secrecy/0.8.0/secrecy/struct.Secret.html#trait-implementations

Should I be looking for a trait AsRef here?

If I update to

impl AsRef<secrecy::Secret<String>> for SessionKey {
    fn as_ref(&self) -> &secrecy::Secret<String> {
        &self.0
    }
}

Does this mean I need to update redis_rs.rs / redis_actor.rs / cookie.rs

[miketwenty1]

follow to @LukeMathWalker on his feedback for session key exposure. Jan 3, 2023.

[miketwenty1]

and this logic needs to be replicated in session.rs? This is tricky for me to understand. This is populated within get_session_key fn I'm proposing?

[miketwenty1]

In the code we are impl a AsRef

actix-extras/actix-session/src/storage/session_key.rs

Line 38 in d2b7229

impl AsRef<str> for SessionKey {

method `as_ref` has an incompatible type for trait
expected fn pointer `fn(&storage::session_key::SessionKey) -> &str`
   found fn pointer `fn(&storage::session_key::SessionKey) -> &secrecy::Secret<std::string::String>`

However it's not clear to me how to do with with secrecy data
https://docs.rs/secrecy/0.8.0/secrecy/struct.Secret.html#trait-implementations

Should I be looking for a trait AsRef here?

If I update to

impl AsRef<secrecy::Secret<String>> for SessionKey {
    fn as_ref(&self) -> &secrecy::Secret<String> {
        &self.0
    }
}

Does this mean I need to update redis_rs.rs / redis_actor.rs / cookie.rs

[miketwenty1]

@LukeMathWalker did you need me to do more work on this before getting next bits of feedback? I have some outstanding questions.