Refactor session handling to use properties for current_session across all store classes for consistency and clarity

Author: eliasjpr

src/cluster.cr

@@ -30,7 +30,9 @@ module Session
     end
   end
 
-  # Local cache with TTL and LRU eviction for session data
+  # Local cache with TTL and LRU eviction
+  # Generic parameter T can be any type - when used for sessions, instantiate as LocalCache(SessionId(T))
+  # where T is your session data type that includes SessionData
   class LocalCache(T)
     struct CacheEntry(T)
       property value : T
@@ -199,6 +201,10 @@ module Session
   end
 
   # Main cluster coordinator for managing pub/sub and local caching
+  #
+  # Generic Constraint:
+  #   T must include SessionData - represents the session data type
+  #   Internally manages LocalCache(SessionId(T)) for caching complete session objects
   class ClusterCoordinator(T)
     getter local_cache : LocalCache(SessionId(T))
     getter node_id : String

src/provider.cr

@@ -1,6 +1,10 @@
 module Session
+  # Provider module for session lifecycle management
+  # Included by Store(T) to provide session operations
+  # The including class must define generic type parameter T where T : SessionData
   module Provider
     abstract def storage : String
+    # Current session - type is determined by the generic parameter T of the including Store(T)
     abstract def current_session
 
     macro included

src/session_id.cr

@@ -1,4 +1,9 @@
 module Session
+  # Container for session data with automatic expiration tracking
+  #
+  # Generic Constraint:
+  #   T must include the SessionData module
+  #   T must provide a parameterless constructor (T.new is called during initialization)
   class SessionId(T)
     include JSON::Serializable
 

src/store.cr

@@ -1,4 +1,9 @@
 module Session
+  # Abstract base class for session storage backends
+  #
+  # Generic Constraint:
+  #   T must include the SessionData module for proper serialization and validation
+  #   T must provide a parameterless constructor (T.new)
   abstract class Store(T)
     include Provider
 
@@ -15,6 +20,10 @@ module Session
   end
 
   # Module for stores that support querying sessions
+  #
+  # Generic Constraint:
+  #   T must include SessionData module
+  #   This module should only be included by Store(T) subclasses
   module QueryableStore(T)
     # Iterate over all sessions matching a predicate
     abstract def each_session(&block : SessionId(T) -> Nil) : Nil

src/stores/clustered_redis_store.cr

@@ -26,10 +26,9 @@ module Session
     getter redis_store : RedisStore(T)
     getter coordinator : ClusterCoordinator(T)
     getter circuit_breaker : CircuitBreaker?
-    @current_session : SessionId(T)?
+    property current_session : SessionId(T) = SessionId(T).new
 
     def initialize(@client : Redis = Redis.new, config : ClusterConfig = ClusterConfig.new)
-      @current_session = SessionId(T).new
       @redis_store = RedisStore(T).new(@client)
       @coordinator = ClusterCoordinator(T).new(@client, config)
       @circuit_breaker = @redis_store.circuit_breaker
@@ -39,14 +38,6 @@ module Session
       end
     end
 
-    def current_session : SessionId(T)
-      @current_session.as(SessionId(T))
-    end
-
-    def current_session=(value : SessionId(T)) : SessionId(T)
-      @current_session = value
-    end
-
     def storage : String
       "#{self.class.name} (backed by #{@redis_store.storage})"
     end

src/stores/cookie_store.cr

@@ -3,20 +3,10 @@ require "../store"
 module Session
   class CookieStore(T) < Store(T)
     include Enumerable(HTTP::Cookie)
-    @current_session : SessionId(T)?
-
+    property current_session : SessionId(T) = SessionId(T).new
     property cookies
 
     def initialize(@cookies : HTTP::Cookies = HTTP::Cookies.new)
-      @current_session = SessionId(T).new
-    end
-
-    def current_session : SessionId(T)
-      @current_session.as(SessionId(T))
-    end
-
-    def current_session=(value : SessionId(T)) : SessionId(T)
-      @current_session = value
     end
 
     def each(&block : HTTP::Cookie -> _)

src/stores/memory_store.cr

@@ -3,18 +3,9 @@ module Session
     include Enumerable(SessionId(T))
     include QueryableStore(T)
     getter sessions : Hash(String, SessionId(T))
-    @current_session : SessionId(T)?
+    property current_session : SessionId(T) = SessionId(T).new
 
     def initialize(@sessions : Hash(String, SessionId(T)) = Hash(String, SessionId(T)).new)
-      @current_session = SessionId(T).new
-    end
-
-    def current_session : SessionId(T)
-      @current_session.as(SessionId(T))
-    end
-
-    def current_session=(value : SessionId(T)) : SessionId(T)
-      @current_session = value
     end
 
     def each(&block : SessionId(T) -> _)

src/stores/redis_store.cr

@@ -4,23 +4,14 @@ module Session
   class RedisStore(T) < Store(T)
     include QueryableStore(T)
     getter circuit_breaker : CircuitBreaker?
-    @current_session : SessionId(T)?
+    property current_session : SessionId(T) = SessionId(T).new
 
     def initialize(@client : Redis = Redis.new)
-      @current_session = SessionId(T).new
       if Session.config.circuit_breaker_enabled
         @circuit_breaker = CircuitBreaker.new(Session.config.circuit_breaker_config)
       end
     end
 
-    def current_session : SessionId(T)
-      @current_session.as(SessionId(T))
-    end
-
-    def current_session=(value : SessionId(T)) : SessionId(T)
-      @current_session = value
-    end
-
     def storage : String
       self.class.name
     end