Class: ActionDispatch::Session::CacheStore

Inherits:
AbstractSecureStore show all
Defined in:
actionpack/lib/action_dispatch/middleware/session/cache_store.rb

Overview

# 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.

  • ‘check_collisions` - Check if newly generated session ids aren’t already in use. If for some reason 128 bits of randomness aren’t considered secure enough to avoid collisions, this option can be enabled to ensure newly generated ids aren’t in use. By default, it is set to ‘false` to avoid additional cache write operations.

Instance Method Summary collapse

Methods included from SessionObject

#commit_session, #loaded_session?, #prepare_session

Methods included from StaleSessionCheck

#extract_session_id, #load_session, #stale_session_check!

Constructor Details

#initialize(app, options = {}) ⇒ CacheStore

Returns a new instance of CacheStore.



27
28
29
30
31
32
 
# File 'actionpack/lib/action_dispatch/middleware/session/cache_store.rb', line 27

def initialize(app, options = {})
  @cache = options[:cache] || Rails.cache
  options[:expire_after] ||= @cache.options[:expires_in]
  @check_collisions = options[:check_collisions] || false
  super
end

Instance Method Details

#delete_session(env, sid, options) ⇒ Object

Remove a session from the cache.



54
55
56
57
58
 
# File 'actionpack/lib/action_dispatch/middleware/session/cache_store.rb', line 54

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) ⇒ Object

Get a session from the cache.



35
36
37
38
39
40
 
# File 'actionpack/lib/action_dispatch/middleware/session/cache_store.rb', line 35

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) ⇒ Object

Set a session in the cache.



43
44
45
46
47
48
49
50
51
 
# File 'actionpack/lib/action_dispatch/middleware/session/cache_store.rb', line 43

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