stored_session 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e2fdeeb48d5eb6f3038a4e8eaa45fb12a9be202f1900f0af907f2f77b0be9cb
-  data.tar.gz: 3e41d710e4d7409c5be132303729ccc721994b243491c1fb5a54f42140eab556
+  metadata.gz: 0fdc7320b5869cf417a6f35aca5177abe2c45443962df8331dfffbd069a245c0
+  data.tar.gz: 0634dc8376279d46db4c4be0914dcc15e60eaad5d6b5a39d8962ccdff4cbf91d
 SHA512:
-  metadata.gz: bc4bed114bd6254e33aee198440dcbf1fa326194b93d9eb8a9b939ce7d5134a76a27adfbf475e147d797aa90db2b50683ad8043f7a90c4bdbb89ed2e6bb6d694
-  data.tar.gz: 45ba948f5c61992521424cbeaba950f13aaf992a0191d78030b6e3475e648ad26f207d77805720eaf97b8838231f98944be39553cd6e234a5d8ba28390a52bd8
+  metadata.gz: 5c515410928dbca10c0ef9f6392bfa8b808cd5371ffd14eee0ebb04c49ce29cf01b9feaabd125c77c158f82e31e75256689bb26c298900561ee27d8384209877
+  data.tar.gz: eca89926f65686e00f9d6f7de2e968e8aff0dfc1b1d672caf50ea46438b7474a1f5e554fb75fc746d84a700a6167d719b619543b7b1a4c717af6ec00683c8c21

data/CHANGELOG.md

@@ -1,7 +1,17 @@
-# Solid Session Changelog
+# Stored Session Changelog
 
 ## Unreleased
 
+## [0.4.0](https://github.com/tbhb/stored_session/releases/tag/v0.4.0)
+
+- Update minimum Rails version to 8.0.0 (<https://github.com/tbhb/stored_session/pull/47>)
+
+## [0.3.0](https://github.com/tbhb/stored_session/releases/tag/v0.3.0)
+
+- Add log subscriber events (<https://github.com/tbhb/stored_session/pull/22>)
+- Extract session model behavior into concern (<https://github.com/tbhb/stored_session/pull/24>)
+- Rename trim to expire and add Rake tasks (<https://github.com/tbhb/stored_session/pull/27>)
+
 ## [0.2.0](https://github.com/tbhb/stored_session/releases/tag/v0.2.0)
 
 - Rename gem to `stored_session` (<https://github.com/tbhb/stored_session/pull/19>)

data/README.md

@@ -1,27 +1,33 @@
 # Stored Session
 
+[![Gem Version](https://badge.fury.io/rb/stored_session.svg)](https://badge.fury.io/rb/stored_session) [![Required Ruby Version](https://img.shields.io/badge/ruby-%3E%3D%203.2-ruby.svg)](https://www.ruby-lang.org/en/downloads/) [![Required Rails Version](https://img.shields.io/badge/rails-%3E%3D%208.0.0-brightgreen.svg)](https://edgeguides.rubyonrails.org/) [![CI](https://github.com/tbhb/stored_session/actions/workflows/ci.yml/badge.svg)](https://github.com/tbhb/stored_session/actions/workflows/ci.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 Encrypted, database-backed [session store](https://guides.rubyonrails.org/security.html#session-storage) for [Rails](https://rubyonrails.org). It is a modernization of the [activerecord-session_store](https://github.com/rails/activerecord-session_store) gem that was previously extracted from Rails. Stored Session is encrypted by default and is tested with MySQL, PostgreSQL, and SQLite against Rails 8+.
 
 > [!WARNING]
-> This gem is currently in active development and should be considered alpha software. The API and functionality are subject to change without notice until a stable 1.0 release.
+> This gem is currently in active development and should be considered alpha software. The API and functionality are subject to change without notice until a stable 1.0 release. See the [roadmap](https://github.com/users/tbhb/projects/6/views/1) for more details.
 
-## Features and roadmap
+## Features
 
 - [x] Compact, encrypted serialization with [MessagePack](https://msgpack.org/) (inspired by [Solid Cache](https://github.com/rails/solid_cache))
-- [x] Built-in [ActiveJob](https://edgeguides.rubyonrails.org/active_job_basics.html) job for trimming inactive sessions
+- [x] Built-in job for expiring inactive sessions
 - [x] Tested with MySQL, PostgreSQL, and SQLite
 - [x] Instrumentation with [ActiveSupport::Notifications](https://guides.rubyonrails.org/active_support_instrumentation.html)
-- [ ] Installation generator
-- [ ] Rake tasks for session maintenance
+- [ ] Privacy-friendly, indexed session metadata (IP, user agent, geocoding)
+- [ ] Callbacks for session operations
+- [ ] Session statistics
 - [ ] Support for dedicated sessions database
-- [ ] Session metadata tracking (IP address, user agent, geocoding)
-- [ ] Integration test helpers for Minitest and RSpec
-- [ ] `mission_control-sessions` gem for monitoring and administration
+- [ ] Testing framework helpers
+- [ ] Installation generator
+- [ ] Full demo application
+- [ ] `stored_session_web` gem for monitoring and maintenance
+
+See [the roadmap](https://github.com/users/tbhb/projects/6/views/1) for the complete list of planned and in-progress features.
 
 ## Prerequisites
 
 - Ruby >= 3.2.0
-- Rails >= 8.0.0.rc2
+- Rails >= 8.0.0
 
 ## Installation
 
@@ -39,12 +45,12 @@ Then, set your session store in `config/initializers/session_store.rb`:
 Rails.application.config.session_store :stored_session_store, key: '_my_app_session`
 ```
 
-When [Solid Queue](https://github.com/rails/solid_queue) is used as your ActiveJob queue adapter, add `StoredSession::TrimSessionsJob` to `config/recurring.yml`:
+When [Solid Queue](https://github.com/rails/solid_queue) is used as your ActiveJob queue adapter, add `StoredSession::ExpireSessionsJob` to `config/recurring.yml`:
 
 ```ruby
 production:
-  trim_sessions:
-    class: "StoredSession::TrimSessionsJob"
+  expire_sessions:
+    class: "StoredSession::ExpireSessionsJob"
     schedule: every day
 ```
 

data/app/jobs/stored_session/expire_sessions_job.rb

@@ -0,0 +1,9 @@
+class StoredSession::ExpireSessionsJob < StoredSession.config.base_job_class
+  queue_as StoredSession.config.expire_sessions_job_queue_as
+
+  def perform(max_created_age: nil, max_updated_age: nil)
+    StoredSession::Session.expire(max_created_age:, max_updated_age:)
+  end
+
+  ActiveSupport.run_load_hooks(:stored_session_expire_sessions_job, self)
+end

data/app/models/stored_session/session.rb

@@ -1,44 +1,9 @@
 require "active_support/core_ext/integer/time"
 
 class StoredSession::Session < StoredSession::Record
-  self.table_name = StoredSession.config.sessions_table_name
-
-  serialize :data, coder: ActiveSupport::MessagePack, type: Hash
-  encrypts :data, message_serializer: ActiveRecord::Encryption::MessagePackMessageSerializer.new
-
-  scope :by_sid, ->(sid) { where(sid: sid) }
-
-  class << self
-    def read(sid)
-      without_query_cache do
-        select(:data).find_by(sid: sid)&.data
-      end
-    end
+  include StoredSession::Model
 
-    def write(sid, data)
-      without_query_cache do
-        upsert({ sid:, data: }, unique_by: upsert_unique_by, on_duplicate: :update, update_only: %i[sid data])
-      end
-      true
-    rescue ActiveRecord::SerializationTypeMismatch
-      false
-    end
-
-    def trim!(max_created_age: nil, max_updated_age: nil)
-      max_created_threshold = (max_created_age || StoredSession.config.max_created_age).ago
-      max_updated_threshold = (max_updated_age || StoredSession.config.max_updated_age).ago
-      where(created_at: ...max_created_threshold).or(where(updated_at: ...max_updated_threshold)).in_batches.delete_all
-    end
-
-    private
-      def upsert_unique_by
-        connection.supports_insert_conflict_target? ? :sid : nil
-      end
-
-      def without_query_cache(&)
-        uncached(dirties: false, &)
-      end
-  end
+  self.table_name = StoredSession.config.sessions_table_name
 
   ActiveSupport.run_load_hooks(:stored_session_session, self)
 end

data/lib/stored_session/configuration.rb

@@ -7,14 +7,13 @@ class StoredSession::Configuration
   attribute :base_record_class_name, :string, default: "::ApplicationRecord"
 
   attribute :connects_to
-  attribute :max_created_age, default: 30.days
-  attribute :max_updated_age, default: 30.days
 
   attribute :sessions_table_name, :string, default: "stored_sessions"
   attribute :session_class_name, :string, default: "::StoredSession::Session"
+  attribute :session_max_created_age, default: 30.days
+  attribute :session_max_updated_age, default: 30.days
 
-  attribute :trim_sessions_job_enabled, :boolean, default: true
-  attribute :trim_sessions_job_queue_as, default: :default
+  attribute :expire_sessions_job_queue_as, default: :default
 
   validates :base_controller_class_name, presence: true
   validates :base_job_class_name, presence: true
@@ -22,11 +21,10 @@ class StoredSession::Configuration
 
   validates :sessions_table_name, presence: true
   validates :session_class_name, presence: true
+  validates :session_max_created_age, numericality: { greater_than: 0 }, presence: true
+  validates :session_max_updated_age, numericality: { greater_than: 0 }, presence: true
 
-  validates :max_created_age, numericality: { greater_than: 0 }, presence: true
-  validates :max_updated_age, numericality: { greater_than: 0 }, presence: true
-
-  validates :trim_sessions_job_queue_as, presence: true
+  validates :expire_sessions_job_queue_as, presence: true
 
   def base_controller_class = base_controller_class_name.constantize
   def base_job_class = base_job_class_name.constantize

data/lib/stored_session/log_subscriber.rb

@@ -1,2 +1,40 @@
 class StoredSession::LogSubscriber < ActiveSupport::LogSubscriber
+  def initialize
+    super
+    @logger = logger || StoredSession.logger
+  end
+
+  attr_writer :logger
+
+  def logger
+    @logger ||= StoredSession.logger
+  end
+
+  def session_read(event)
+    debug formatted_event(event, "Session Read", **event.payload.slice(:sid))
+  end
+  subscribe_log_level :session_read, :debug
+
+  def session_write(event)
+    debug formatted_event(event, "Session Write", **event.payload.slice(:sid))
+  end
+  subscribe_log_level :session_write, :debug
+
+  def session_delete(event)
+    debug formatted_event(event, "Session Delete", **event.payload.slice(:sid))
+  end
+  subscribe_log_level :session_delete, :debug
+
+  private
+    def formatted_event(event, operation, **)
+      "  [StoredSession] #{operation} in #{formatted_duration(event)} (#{formatted_payload(**)})"
+    end
+
+    def formatted_duration(event)
+      "%.1fms" % event.duration
+    end
+
+    def formatted_payload(**attributes)
+      attributes.map { |k, v| "#{k}: #{v.inspect}" }.join(" | ")
+    end
 end

data/lib/stored_session/model.rb

@@ -0,0 +1,48 @@
+module StoredSession::Model
+  extend ActiveSupport::Concern
+
+  included do
+    serialize :data, coder: ActiveSupport::MessagePack, type: Hash
+    encrypts :data, message_serializer: ActiveRecord::Encryption::MessagePackMessageSerializer.new
+
+    scope :by_sid, ->(sid) { where(sid: sid) }
+  end
+
+  module ClassMethods
+    def read(sid)
+      without_query_cache do
+        select(:data).find_by(sid: sid)&.data
+      end
+    end
+
+    def write(sid, data)
+      without_query_cache do
+        upsert({ sid:, data: }, unique_by: upsert_unique_by, on_duplicate: :update, update_only: %i[sid data])
+      end
+      true
+    rescue ActiveRecord::SerializationTypeMismatch
+      false
+    end
+
+    def expire(max_created_age: nil, max_updated_age: nil)
+      max_created_threshold = (max_created_age || StoredSession.config.session_max_created_age).ago
+      max_updated_threshold = (max_updated_age || StoredSession.config.session_max_updated_age).ago
+      where(created_at: ...max_created_threshold).or(where(updated_at: ...max_updated_threshold)).in_batches.delete_all
+    end
+
+    def expire_later(max_created_age: nil, max_updated_age: nil)
+      StoredSession::ExpireSessionsJob.perform_later(max_created_age: max_created_age, max_updated_age: max_updated_age)
+    end
+
+    private
+      def upsert_unique_by
+        connection.supports_insert_conflict_target? ? :sid : nil
+      end
+
+      def without_query_cache(&)
+        uncached(dirties: false, &)
+      end
+  end
+
+  ActiveSupport.run_load_hooks(:stored_session_model, self)
+end

data/lib/stored_session/store/instrumentation.rb

@@ -1,14 +1,21 @@
+require_relative "logging"
+
 module StoredSession
   class Store < ActionDispatch::Session::AbstractSecureStore
     module Instrumentation
       extend ActiveSupport::Concern
 
-      def instrument(operation, sid, **options, &blk)
-        payload = { sid: sid&.private_id, **options }
-        ActiveSupport::Notifications.instrument("session_#{operation}.stored_session", payload) do
-          blk&.call(payload)
+      include StoredSession::Store::Logging
+
+      private
+        def instrument(operation, sid, **options, &blk)
+          silence do
+            payload = { sid: sid&.private_id, **options }
+            ActiveSupport::Notifications.instrument("session_#{operation}.stored_session", payload) do
+              blk&.call(payload)
+            end
+          end
         end
-      end
 
       ActiveSupport.run_load_hooks(:stored_session_store_instrumentation, self)
     end

data/lib/stored_session/store/logging.rb

@@ -0,0 +1,23 @@
+module StoredSession
+  class Store < ActionDispatch::Session::AbstractSecureStore
+    module Logging
+      extend ActiveSupport::Concern
+
+      included do
+        delegate :logger, to: :StoredSession
+      end
+
+      def initialize(app, options = {})
+        super
+        @silence = options.fetch(:silence) { true }
+      end
+
+      private
+        def silence(&blk)
+          @silence ? ActiveRecord::Base.logger.silence(&blk) : yield
+        end
+
+      ActiveSupport.run_load_hooks(:stored_session_store_logging, self)
+    end
+  end
+end

data/lib/stored_session/store.rb

@@ -1,57 +1,41 @@
 require_relative "store/instrumentation"
+require_relative "store/logging"
 
 class StoredSession::Store < ActionDispatch::Session::AbstractSecureStore
-  include ActiveSupport::Configurable
+  include StoredSession::Store::Logging
   include StoredSession::Store::Instrumentation
 
-  delegate :logger, to: :StoredSession
-
-  attr_reader :silence
-  alias :silence? :silence
-
   attr_reader :session_class
 
   def initialize(app, options = {})
     super
-
     @session_class = options.fetch(:session_class) { StoredSession.config.session_class }
-    @silence = true unless options.key?(:silence)
   end
 
   def find_session(env, sid)
-    silence do
-      instrument(:read, sid) do |payload|
-        if sid && (data = session_class.read(sid.private_id))
-          [ sid, data || {} ]
-        else
-          [ generate_sid, {} ]
-        end
+    instrument(:read, sid) do |payload|
+      if sid && (data = session_class.read(sid.private_id))
+        [ sid, data || {} ]
+      else
+        [ generate_sid, {} ]
       end
     end
   end
 
   def write_session(req, sid, session, options)
-    silence do
-      instrument(:write, sid) do |payload|
-        return false unless session_class.write(sid.private_id, session)
+    instrument(:write, sid) do |payload|
+      return false unless session_class.write(sid.private_id, session)
 
-        sid
-      end
+      sid
     end
   end
 
   def delete_session(req, sid, options)
-    silence do
-      instrument(:delete, sid) do |payload|
-        session_class.by_sid(sid.private_id).delete_all
-        generate_sid
-      end
+    instrument(:delete, sid) do |payload|
+      session_class.by_sid(sid.private_id).delete_all
+      generate_sid
     end
   end
 
-  def silence(&)
-    @silence ? logger.silence(&) : yield
-  end
-
   ActiveSupport.run_load_hooks(:stored_session_store, self)
 end

data/lib/stored_session/version.rb

@@ -1,3 +1,22 @@
+# :markup: markdown
+
 module StoredSession
-  VERSION = "0.2.0".freeze
+  module VERSION
+    MAJOR = 0
+    MINOR = 4
+    TINY  = 0
+    PRE   = nil
+
+    STRING = [ MAJOR, MINOR, TINY, PRE ].compact.join(".")
+  end
+
+  # Returns the currently loaded version of Stored Session as a `Gem::Version`.
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  # Returns the currently loaded version of Stored Session as a `String`.
+  def self.version
+    VERSION::STRING
+  end
 end

data/lib/tasks/stored_session_tasks.rake

@@ -0,0 +1,11 @@
+namespace :stored_session do
+  desc "Expire inactive sessions"
+  task expire: :environment do
+    StoredSession::Session.expire
+  end
+
+  desc "Queue a job to expire inactive sessions"
+  task "expire_later" => :environment do
+    StoredSession::Session.expire_later
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stored_session
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tony Burns
@@ -35,7 +35,7 @@ cert_chain:
   Gso2iuR/JK+nlYYHnXZSMQgPTNEv7urC3s3YBLkEeZAyKSzTub/yFiZ0f1rZECNq
   RdwSWsf01XE0bKBtz4/dixrX45mIFrPmGp1gobRN/q4Tq3lU
   -----END CERTIFICATE-----
-date: 2024-11-05 00:00:00.000000000 Z
+date: 2024-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -43,56 +43,56 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.0.0.rc2
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.0.0.rc2
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.0.0.rc2
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.0.0.rc2
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.0.0.rc2
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.0.0.rc2
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.0.0.rc2
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.0.0.rc2
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -131,7 +131,7 @@ files:
 - CHANGELOG.md
 - MIT-LICENSE
 - README.md
-- app/jobs/stored_session/trim_sessions_job.rb
+- app/jobs/stored_session/expire_sessions_job.rb
 - app/models/stored_session/record.rb
 - app/models/stored_session/session.rb
 - config/locales/stored_session.en.yml
@@ -142,10 +142,11 @@ files:
 - lib/stored_session/configuration.rb
 - lib/stored_session/deprecator.rb
 - lib/stored_session/engine.rb
-- lib/stored_session/gem_version.rb
 - lib/stored_session/log_subscriber.rb
+- lib/stored_session/model.rb
 - lib/stored_session/store.rb
 - lib/stored_session/store/instrumentation.rb
+- lib/stored_session/store/logging.rb
 - lib/stored_session/test_helper.rb
 - lib/stored_session/version.rb
 - lib/tasks/stored_session_tasks.rake
@@ -154,10 +155,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/tbhb/stored_session/issues
-  changelog_uri: https://github.com/tbhb/stored_session/blob/v0.2.0/CHANGELOG.md
+  changelog_uri: https://github.com/tbhb/stored_session/blob/v0.4.0/CHANGELOG.md
   documentation_uri: https://github.com/tbhb/stored_session
   mailing_list_uri: https://github.com/tbhb/stored_session/discussions
-  source_code_uri: https://github.com/tbhb/stored_session/tree/v0.2.0
+  source_code_uri: https://github.com/tbhb/stored_session/tree/v0.4.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []

data/app/jobs/stored_session/trim_sessions_job.rb

@@ -1,9 +0,0 @@
-class StoredSession::TrimSessionsJob < StoredSession.config.base_job_class
-  queue_as StoredSession.config.trim_sessions_job_queue_as
-
-  def perform(max_created_age: nil, max_updated_age: nil)
-    StoredSession::Session.trim!(max_created_age:, max_updated_age:)
-  end
-
-  ActiveSupport.run_load_hooks(:stored_session_trim_sessions_job, self)
-end

data/lib/stored_session/gem_version.rb

@@ -1,17 +0,0 @@
-# :markup: markdown
-
-module StoredSession
-  # Returns the currently loaded version of Stored Session as a `Gem::Version`.
-  def self.gem_version
-    Gem::Version.new VERSION::STRING
-  end
-
-  module VERSION
-    MAJOR = 0
-    MINOR = 2
-    TINY  = 0
-    PRE   = "".freeze
-
-    STRING = [ MAJOR, MINOR, TINY, PRE ].compact.join(".")
-  end
-end