123456789_123456789_123456789_123456789_123456789_

Class: ActionDispatch::Session::CacheStore

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, AbstractSecureStore, Rack::Session::Abstract::PersistedSecure
Instance Chain:
self, AbstractSecureStore, SessionObject, StaleSessionCheck, Compatibility, Rack::Session::Abstract::PersistedSecure
Inherits: ActionDispatch::Session::AbstractSecureStore
Defined in: actionpack/lib/action_dispatch/middleware/session/cache_store.rb

Overview

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.

Class Method Summary

Instance Method Summary

AbstractSecureStore - Inherited

#generate_sid, #set_cookie

SessionObject - Included

#commit_session, #loaded_session?, #prepare_session

StaleSessionCheck - Included

#extract_session_id, #load_session, #stale_session_check!

Compatibility - Included

#generate_sid, #initialize, #initialize_sid, #make_request

Constructor Details

.new(app, options = {}) ⇒ CacheStore

[ GitHub ] 

  


# 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



  

    #cache_key(id)   (private)
  



  

    

Turn the session id into a cache key.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/session/cache_store.rb', line 62



def cache_key(id)
  "_session_id:#{id}"
end


  








  

    #delete_session(env, sid, options)  
  



  

    

Remove a session from the cache.


  



  [ GitHub ]


  

  


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



  

    

Get a session from the cache.


  



  [ GitHub ]


  

  


# 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


  








  

    #generate_sid   (private)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/session/cache_store.rb', line 70



def generate_sid
  if @check_collisions
    loop do
      sid = super
      key = cache_key(sid.private_id)
      break sid if @cache.write(key, {}, unless_exist: true, expires_in: default_options[:expire_after])
    end
  else
    super
  end
end


  








  

    #get_session_with_fallback(sid)   (private)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/session/cache_store.rb', line 66



def get_session_with_fallback(sid)
  @cache.read(cache_key(sid.private_id)) || @cache.read(cache_key(sid.public_id))
end


  








  

    #write_session(env, sid, session, options)  
  



  

    

Set a session in the cache.


  



  [ GitHub ]


  

  


# 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