Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

provide tracing #72

Merged
merged 1 commit into from
Nov 3, 2023
Merged

provide tracing #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ tower-cookies = "0.9.0"
tower-layer = "0.3.2"
tower-service = "0.3.2"
uuid = { version = "1.4.1", features = ["v4", "serde"] }
tracing = { version = "0.1.40", features = ["log"] }

fred = { optional = true, version = "7.0.0" }
axum-core = { optional = true, version = "0.3.4" }
Expand Down
226 changes: 124 additions & 102 deletions src/service.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use tower_cookies::{cookie::SameSite, Cookie, CookieManager, Cookies};
use tower_layer::Layer;
use tower_service::Service;
use tracing::Instrument;

use crate::{
session::{Deletion, Expiry, Id},
Expand Down Expand Up @@ -108,141 +109,162 @@
}

fn call(&mut self, mut req: Request<ReqBody>) -> Self::Future {
let span = tracing::debug_span!("session_middleware", session.id = tracing::field::Empty);

let session_store = self.session_store.clone();
let session_config = self.session_config.clone();
let loaded_sessions = self.loaded_sessions.clone();

span.in_scope(|| tracing::trace!(loaded_sessions = loaded_sessions.len()));

let clone = self.inner.clone();
let mut inner = std::mem::replace(&mut self.inner, clone);
Box::pin(async move {
let cookies = req
.extensions()
.get::<Cookies>()
.cloned()
.expect("Something has gone wrong with tower-cookies.");

let mut session = if let Some(session_cookie) =
cookies.get(&session_config.name).map(Cookie::into_owned)
{
// We do have a session cookie, so we retrieve it either from memory or the
// backing session store.
let session_id: Id = session_cookie.value().try_into()?;
match loaded_sessions.entry(session_id) {
Entry::Vacant(entry) => {
let session = session_store.load(&session_id).await?;

// N.B.: Our store will *not* have the session if the session is empty.
if let Some(session) = &session {
entry.insert(LoadedSession {
session: session.clone(),
refs: 1,
});
} else {
cookies.remove(session_cookie);
Box::pin(
async move {
let cookies = req
.extensions()
.get::<Cookies>()
.cloned()
.expect("Something has gone wrong with tower-cookies.");

Check warning on line 128 in src/service.rs

View check run for this annotation

Codecov / codecov/patch

src/service.rs#L125-L128 

Added lines #L125 - L128 were not covered by tests

let mut session = if let Some(session_cookie) =
cookies.get(&session_config.name).map(Cookie::into_owned)
{
// We do have a session cookie, so we retrieve it either from memory or the
// backing session store.
tracing::debug!("loading session from cookie");
let session_id = session_cookie.value().try_into()?;

match loaded_sessions.entry(session_id) {
Entry::Vacant(entry) => {
let session = session_store.load(&session_id).await?;
tracing::trace!("loaded from store");

// N.B.: Our store will *not* have the session if the session is empty.
if let Some(session) = &session {
entry.insert(LoadedSession {
session: session.clone(),
refs: 1,

Check warning on line 147 in src/service.rs

View check run for this annotation

Codecov / codecov/patch

src/service.rs#L147 

Added line #L147 was not covered by tests
});
} else {
cookies.remove(session_cookie);
}

session.unwrap_or_else(|| session_config.new_session())
}

session.unwrap_or_else(|| session_config.new_session())
Entry::Occupied(mut entry) => {
tracing::trace!("loaded from cache");
let loaded_session = entry.get_mut();
loaded_session.refs += 1;
loaded_session.session.clone()

Check warning on line 160 in src/service.rs

View check run for this annotation

Codecov / codecov/patch

src/service.rs#L156-L160 

Added lines #L156 - L160 were not covered by tests
}
}
} else {
// We don't have a session cookie, so let's create a new session.
let session = session_config.new_session();
tracing::debug!("created new session");
session
};

Entry::Occupied(mut entry) => {
let loaded_session = entry.get_mut();
loaded_session.refs += 1;
loaded_session.session.clone()
}
}
} else {
// We don't have a session cookie, so let's create a new session.
session_config.new_session()
};
tracing::Span::current().record("session.id", session.id().to_string());

req.extensions_mut().insert(session.clone());
req.extensions_mut().insert(session.clone());

let res = Ok(inner.call(req).await.map_err(Into::into)?);
let res = Ok(inner.call(req).await.map_err(Into::into)?);

let loaded_session = loaded_sessions.entry(*session.id());
let loaded_session = loaded_sessions.entry(*session.id());

// N.B. When a session is empty, it will be deleted. Here the deleted method
// accounts for this check.
if let Some(session_deletion) = session.deleted() {
match session_deletion {
Deletion::Deleted => {
if let Entry::Occupied(entry) = loaded_session {
entry.remove();
};
// N.B. When a session is empty, it will be deleted. Here the deleted method
// accounts for this check.
if let Some(session_deletion) = session.deleted() {
match session_deletion {
Deletion::Deleted => {

Check warning on line 182 in src/service.rs

View check run for this annotation

Codecov / codecov/patch

src/service.rs#L182 

Added line #L182 was not covered by tests
tracing::debug!("deleted");

session_store.delete(session.id()).await?;
cookies.remove(session_config.build_cookie(&session));
if let Entry::Occupied(entry) = loaded_session {
entry.remove();
};

// Since the session has been deleted, there's no need for further
// processing.
return res;
}
session_store.delete(session.id()).await?;
cookies.remove(session_config.build_cookie(&session));

Deletion::Cycled(deleted_id) => {
if let Entry::Occupied(entry) = loaded_session {
entry.remove();
// Since the session has been deleted, there's no need for further
// processing.
return res;
}

session_store.delete(&deleted_id).await?;
cookies.remove(session_config.build_cookie(&session));
session.reset_deleted();
Deletion::Cycled(deleted_id) => {
tracing::debug!("key cycled");

if let Entry::Occupied(entry) = loaded_session {
entry.remove();
}

session_store.delete(&deleted_id).await?;
cookies.remove(session_config.build_cookie(&session));
session.reset_deleted();

if session.is_modified() {
session.reset_modified();
session.id = Id::default();
session_store.save(&session).await?;
cookies.add(session_config.build_cookie(&session));
}

return res;
}
}
};

// For further consideration:
//
// We only persist the session in the store when the `modified` flag is set.
//
// However, we could offer additional configuration of this behavior via an
// extended interface in the future. For instance, we might consider providing
// the `Set-Cookie` header whenever modified or if some "always save" marker is
// set.
match loaded_session {
Entry::Occupied(mut entry) => {
let loaded = entry.get_mut();

if session.is_modified() {
tracing::debug!("modified cached");

Check warning on line 233 in src/service.rs

View check run for this annotation

Codecov / codecov/patch

src/service.rs#L233 

Added line #L233 was not covered by tests
session.reset_modified();
session.id = Id::default();

session_store.save(&session).await?;
cookies.add(session_config.build_cookie(&session));
}

return res;
}
}
};

// For further consideration:
//
// We only persist the session in the store when the `modified` flag is set.
//
// However, we could offer additional configuration of this behavior via an
// extended interface in the future. For instance, we might consider providing
// the `Set-Cookie` header whenever modified or if some "always save" marker is
// set.
match loaded_session {
Entry::Occupied(mut entry) => {
let loaded = entry.get_mut();

if session.is_modified() {
session.reset_modified();

session_store.save(&session).await?;
cookies.add(session_config.build_cookie(&session));
}
if loaded.refs <= 1 {
entry.remove();
return res;
}

if loaded.refs <= 1 {
entry.remove();
return res;
loaded.refs -= 1;

Check warning on line 245 in src/service.rs

View check run for this annotation

Codecov / codecov/patch

src/service.rs#L245 

Added line #L245 was not covered by tests
}

loaded.refs -= 1;
}

Entry::Vacant(entry) => {
if session.is_modified() {
session.reset_modified();
Entry::Vacant(entry) => {
if session.is_modified() {
tracing::debug!("modified uncached");
session.reset_modified();

entry.insert(LoadedSession {
session: session.clone(),
refs: 0,
});
entry.insert(LoadedSession {
session: session.clone(),
refs: 0,

Check warning on line 255 in src/service.rs

View check run for this annotation

Codecov / codecov/patch

src/service.rs#L255 

Added line #L255 was not covered by tests
});

session_store.save(&session).await?;
cookies.add(session_config.build_cookie(&session));
session_store.save(&session).await?;
cookies.add(session_config.build_cookie(&session));
}
}
}
};
};

res
})
res
}
.instrument(span),
)
}
}

Expand Down