feat: add debug logging messages for session start, resume, authenticate and tunnel initiation

Author: jacobtread

src/routes/server.rs

@@ -120,9 +120,16 @@ pub async fn handle_upgrade(
         }
     };
 
+    let id = Session::acquire_id();
+
+    debug!(
+        "Session started (SID: {}, ASSOC: {:?}, ADDR: {})",
+        id, association_id, addr
+    );
+
     let data = SessionData::new(addr, association_id);
 
-    Session::run(upgraded, data, router).await;
+    Session::run(id, upgraded, data, router).await;
 }
 
 /// GET /api/server/tunnel

src/services/tunnel/http_tunnel.rs

@@ -6,7 +6,7 @@ use self::codec::{TunnelCodec, TunnelMessage};
 use futures_util::{Sink, Stream};
 use hyper::upgrade::Upgraded;
 use hyper_util::rt::TokioIo;
-use log::error;
+use log::{debug, error};
 use std::{
     future::Future,
     pin::Pin,
@@ -103,6 +103,11 @@ impl HttpTunnel {
             }
         };
 
+        debug!(
+            "Session HTTP tunnel connected (ASSOC: {:?}, TUNNEL_ID: {})",
+            association, tunnel_id
+        );
+
         // Spawn the tunnel task
         tokio::spawn(HttpTunnel {
             service,

src/services/tunnel/udp_tunnel.rs

@@ -170,6 +170,11 @@ fn handle_message(
                 }
             };
 
+            debug!(
+                "Session UDP tunnel connected (ASSOC: {:?}, TUNNEL_ID: {})",
+                association, tunnel_id
+            );
+
             let buffer = serialize_message(tunnel_id, &TunnelMessage::Initiated { tunnel_id });
 
             _ = service.udp_tx.send(UdpTunnelMessage {

src/session/mod.rs

@@ -98,10 +98,12 @@ impl SessionNotifyHandle {
 }
 
 impl Session {
-    pub async fn run(io: Upgraded, data: SessionData, router: Arc<BlazeRouter>) {
-        // Obtain a session ID
-        let id = SESSION_IDS.fetch_add(1, Ordering::AcqRel);
+    /// Get an ID for a session
+    pub fn acquire_id() -> u32 {
+        SESSION_IDS.fetch_add(1, Ordering::AcqRel)
+    }
 
+    pub async fn run(id: u32, io: Upgraded, data: SessionData, router: Arc<BlazeRouter>) {
         let (notify_handle, rx) = SessionNotifyHandle::new();
         let session = Arc::new(Self {
             id,

src/session/routes/auth.rs

@@ -68,6 +68,11 @@ pub async fn handle_login(
 
     let session_token: String = sessions.create_token(player.id);
 
+    debug!(
+        "Session authenticated (REASON: LOGIN_PASSWORD, PID: {}, SID: {})",
+        player.id, session.id
+    );
+
     Ok(Blaze(AuthResponse {
         player,
         session_token,
@@ -102,6 +107,11 @@ pub async fn handle_silent_login(
     // Update the session stored player
     let player = session.data.set_auth(player);
 
+    debug!(
+        "Session authenticated (REASON: LOGIN_SILENT, PID: {}, SID: {})",
+        player.id, session.id
+    );
+
     Ok(Blaze(AuthResponse {
         player,
         session_token: token,
@@ -141,6 +151,11 @@ pub async fn handle_origin_login(
 
     let session_token: String = sessions.create_token(player.id);
 
+    debug!(
+        "Session authenticated (REASON: LOGIN_ORIGIN, PID: {}, SID: {})",
+        player.id, session.id
+    );
+
     Ok(Blaze(AuthResponse {
         player,
         session_token,
@@ -367,6 +382,11 @@ pub async fn handle_create_account(
 
     let session_token = sessions.create_token(player.id);
 
+    debug!(
+        "Session authenticated (REASON: CREATED_ACCOUNT, PID: {}, SID: {})",
+        player.id, session.id
+    );
+
     Ok(Blaze(AuthResponse {
         player,
         session_token,

src/session/routes/user_sessions.rs

@@ -14,7 +14,7 @@ use crate::{
     },
 };
 use chrono::Utc;
-use log::error;
+use log::{debug, error};
 use sea_orm::DatabaseConnection;
 use std::sync::Arc;
 
@@ -87,6 +87,8 @@ pub async fn handle_resume_session(
     let player = sessions.add_session(player, Arc::downgrade(&session));
     let player = session.data.set_auth(player);
 
+    debug!("Session resumed (PID: {}, SID: {})", player.id, session.id);
+
     Ok(Blaze(AuthResponse {
         player,
         session_token,