Action Dispatch Session CacheStore

A session store that uses an ActiveSupport::Cache::Store to store the sessions. This store is most useful if you don’t store critical data in your sessions and you don’t need them to live for extended periods of time.

Options

  • cache - The cache to use. If it is not specified, Rails.cache will be used.

  • expire_after - The length of time a session will be stored before automatically expiring. By default, the :expires_in option of the cache is used.

Methods

Class Public methods

new(app, options = {})

📝 Source code 
# File actionpack/lib/action_dispatch/middleware/session/cache_store.rb, line 18
      def initialize(app, options = {})
        @cache = options[:cache] || Rails.cache
        options[:expire_after] ||= @cache.options[:expires_in]
        super
      end
🔎 See on GitHub

Instance Public methods

delete_session(env, sid, options)

Remove a session from the cache.

📝 Source code 
# File actionpack/lib/action_dispatch/middleware/session/cache_store.rb, line 44
      def delete_session(env, sid, options)
        @cache.delete(cache_key(sid.private_id))
        @cache.delete(cache_key(sid.public_id))
        generate_sid
      end
🔎 See on GitHub

find_session(env, sid)

Get a session from the cache.

📝 Source code 
# File actionpack/lib/action_dispatch/middleware/session/cache_store.rb, line 25
      def find_session(env, sid)
        unless sid && (session = get_session_with_fallback(sid))
          sid, session = generate_sid, {}
        end
        [sid, session]
      end
🔎 See on GitHub

write_session(env, sid, session, options)

Set a session in the cache.

📝 Source code 
# File actionpack/lib/action_dispatch/middleware/session/cache_store.rb, line 33
      def write_session(env, sid, session, options)
        key = cache_key(sid.private_id)
        if session
          @cache.write(key, session, expires_in: options[:expire_after])
        else
          @cache.delete(key)
        end
        sid
      end
🔎 See on GitHub