class ActionDispatch::Session::CacheStore

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

Public Class Methods

new(app, options = {}) click to toggle source
# File lib/action_dispatch/middleware/session/cache_store.rb, line 23
def initialize(app, options = {})
  @cache = options[:cache] || Rails.cache
  options[:expire_after] ||= @cache.options[:expires_in]
  super
end

Public Instance Methods

delete_session(env, sid, options) click to toggle source

Remove a session from the cache.

# File lib/action_dispatch/middleware/session/cache_store.rb, line 49
def delete_session(env, sid, options)
  @cache.delete(cache_key(sid.private_id))
  @cache.delete(cache_key(sid.public_id))
  generate_sid
end
find_session(env, sid) click to toggle source

Get a session from the cache.

# File lib/action_dispatch/middleware/session/cache_store.rb, line 30
def find_session(env, sid)
  unless sid && (session = get_session_with_fallback(sid))
    sid, session = generate_sid, {}
  end
  [sid, session]
end
write_session(env, sid, session, options) click to toggle source

Set a session in the cache.

# File lib/action_dispatch/middleware/session/cache_store.rb, line 38
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

Private Instance Methods

cache_key(id) click to toggle source

Turn the session id into a cache key.

# File lib/action_dispatch/middleware/session/cache_store.rb, line 57
def cache_key(id)
  "_session_id:#{id}"
end
get_session_with_fallback(sid) click to toggle source
# File lib/action_dispatch/middleware/session/cache_store.rb, line 61
def get_session_with_fallback(sid)
  @cache.read(cache_key(sid.private_id)) || @cache.read(cache_key(sid.public_id))
end