Enabling stores to opt into seeing the request

README.md

@@ -278,6 +278,12 @@ all the elements will be considered when verifying the signature in requests.
 
 The session store instance, defaults to a new `MemoryStore` instance.
 
+##### passReqToStore
+
+Pass the request object to required and optional store methods.
+
+By default, the request object is not passed to store methods.
+
 ##### unset
 
 Control the result of unsetting `req.session` (through `delete`, setting to `null`,
@@ -348,6 +354,11 @@ req.session.reload(function(err) {
 })
 ```
 
+#### Session.load(sid, callback)
+
+Loads the the session data for the given `sid` from the store and re-populates the
+`req.session` object. Once complete, the `callback` will be invoked.
+
 #### Session.save(callback)
 
 Save the session back to the store, replacing the contents on the store with the
@@ -420,6 +431,14 @@ To get the ID of the loaded session, access the request property
 `req.sessionID`. This is simply a read-only value set when a session
 is loaded/created.
 
+### req.sessionOptions
+
+To get the options of the session, access the request property
+`req.sessionOptions`.
+
+**NOTE** For performance reasons, this is the original global options object.
+Changes to it would take effect for all requests in an undefined manner.
+
 ## Session Store Implementation
 
 Every session store _must_ be an `EventEmitter` and implement specific
@@ -441,14 +460,18 @@ For an example implementation view the [connect-redis](http://github.com/visionm
 This optional method is used to get all sessions in the store as an array. The
 `callback` should be called as `callback(error, sessions)`.
 
-### store.destroy(sid, callback)
+### store.destroy(sid, [req], callback)
 
 **Required**
 
 This required method is used to destroy/delete a session from the store given
 a session ID (`sid`). The `callback` should be called as `callback(error)` once
 the session is destroyed.
 
+The request is passed into the `req` argument only if the session's options
+have `passReqToStore` set to `true`. A store wishing to operate in either mode
+should check whether the second argument is a function or an object.
+
 ### store.clear(callback)
 
 **Optional**
@@ -463,7 +486,7 @@ This optional method is used to delete all sessions from the store. The
 This optional method is used to get the count of all sessions in the store.
 The `callback` should be called as `callback(error, len)`.
 
-### store.get(sid, callback)
+### store.get(sid, [req], callback)
 
 **Required**
 
@@ -474,15 +497,23 @@ The `session` argument should be a session if found, otherwise `null` or
 `undefined` if the session was not found (and there was no error). A special
 case is made when `error.code === 'ENOENT'` to act like `callback(null, null)`.
 
-### store.set(sid, session, callback)
+The request is passed into the `req` argument only if the session's options
+have `passReqToStore` set to `true`. A store wishing to operate in either mode
+should check whether the second argument is a function or an object.
+
+### store.set(sid, session, [req], callback)
 
 **Required**
 
 This required method is used to upsert a session into the store given a
 session ID (`sid`) and session (`session`) object. The callback should be
 called as `callback(error)` once the session has been set in the store.
 
-### store.touch(sid, session, callback)
+The request is passed into the `req` argument only if the session's options
+have `passReqToStore` set to `true`. A store wishing to operate in either mode
+should check whether the third argument is a function or an object.
+
+### store.touch(sid, session, [req], callback)
 
 **Recommended**
 
@@ -494,6 +525,10 @@ This is primarily used when the store will automatically delete idle sessions
 and this method is used to signal to the store the given session is active,
 potentially resetting the idle timer.
 
+The request is passed into the `req` argument only if the session's options
+have `passReqToStore` set to `true`. A store wishing to operate in either mode
+should check whether the third argument is a function or an object.
+
 ## Compatible Session Stores
 
 The following modules implement a session store that is compatible with this

index.js

@@ -79,6 +79,7 @@ var defer = typeof setImmediate === 'function'
  * @param {Boolean} [options.saveUninitialized] Save uninitialized sessions to the store
  * @param {String|Array} [options.secret] Secret for signing session ID
  * @param {Object} [options.store=MemoryStore] Session store
+ * @param {Boolean} [options.passReqToStore] Pass the request to store methods
  * @param {String} [options.unset]
  * @return {Function} middleware
  * @public
@@ -99,6 +100,8 @@ function session(options) {
   // get the session store
   var store = opts.store || new MemoryStore()
 
+  var passReqToStore = opts.passReqToStore;
+
   // get the trust proxy setting
   var trustProxy = opts.proxy
 
@@ -201,6 +204,27 @@ function session(options) {
       return;
     }
 
+    /**
+     * Load a `Session` instance via the given `sid`
+     * and invoke the callback `fn(err, sess)`.
+     *
+     * @param {String} sid
+     * @param {Function} fn
+     * @api public
+     */
+    store.load = function(sid, fn){
+      var getCallback = function(err, sess){
+        if (err) return fn(err);
+        if (!sess) return fn();
+        fn(null, store.createSession(req, sess))
+      };
+      if (passReqToStore) {
+        store.get(sid, req, getCallback);
+      } else {
+        store.get(sid, getCallback);
+      }
+    };
+
     // backwards compatibility for signed cookies
     // req.secret is passed from the cookie parser middleware
     var secrets = secret || [req.secret];
@@ -212,6 +236,8 @@ function session(options) {
 
     // expose store
     req.sessionStore = store;
+    // expose session options
+    req.sessionOptions = opts;
 
     // get the session ID from the cookie
     var cookieId = req.sessionID = getcookie(req, name, secrets);
@@ -303,14 +329,20 @@ function session(options) {
       if (shouldDestroy(req)) {
         // destroy session
         debug('destroying');
-        store.destroy(req.sessionID, function ondestroy(err) {
+        var ondestroy = function(err) {
           if (err) {
             defer(next, err);
           }
 
           debug('destroyed');
           writeend();
-        });
+        }
+
+        if (passReqToStore) {
+          store.destroy(req.sessionID, req, ondestroy);
+        } else {
+          store.destroy(req.sessionID, ondestroy);
+        }
 
         return writetop();
       }
@@ -340,14 +372,20 @@ function session(options) {
       } else if (storeImplementsTouch && shouldTouch(req)) {
         // store implements touch method
         debug('touching');
-        store.touch(req.sessionID, req.session, function ontouch(err) {
+        var ontouch = function(err) {
           if (err) {
             defer(next, err);
           }
 
           debug('touched');
           writeend();
-        });
+        }
+
+        if (passReqToStore) {
+          store.touch(req.sessionID, req.session, req, ontouch);
+        } else {
+          store.touch(req.sessionID, req.session, ontouch);
+        }
 
         return writetop();
       }
@@ -471,7 +509,7 @@ function session(options) {
 
     // generate the session object
     debug('fetching %s', req.sessionID);
-    store.get(req.sessionID, function(err, sess){
+    var getHandler = function(err, sess){
       // error handling
       if (err && err.code !== 'ENOENT') {
         debug('error %j', err);
@@ -493,7 +531,12 @@ function session(options) {
       }
 
       next()
-    });
+    }
+    if (passReqToStore) {
+      store.get(req.sessionID, req, getHandler);
+    } else {
+      store.get(req.sessionID, getHandler);
+    }
   };
 };
 

session/session.js

@@ -69,7 +69,11 @@ defineMethod(Session.prototype, 'resetMaxAge', function resetMaxAge() {
  */
 
 defineMethod(Session.prototype, 'save', function save(fn) {
-  this.req.sessionStore.set(this.id, this, fn || function(){});
+  if (this.req.sessionOptions.passReqToStore) {
+    this.req.sessionStore.set(this.id, this, this.req, fn || function(){});
+  } else {
+    this.req.sessionStore.set(this.id, this, fn || function(){});
+  }
   return this;
 });
 
@@ -89,12 +93,17 @@ defineMethod(Session.prototype, 'reload', function reload(fn) {
   var req = this.req
   var store = this.req.sessionStore
 
-  store.get(this.id, function(err, sess){
+  var getCallback = function(err, sess){
     if (err) return fn(err);
     if (!sess) return fn(new Error('failed to load session'));
     store.createSession(req, sess);
     fn();
-  });
+  };
+  if (this.req.sessionOptions.passReqToStore) {
+    store.get(this.id, req, getCallback);
+  } else {
+    store.get(this.id, getCallback);
+  }
   return this;
 });
 
@@ -108,7 +117,11 @@ defineMethod(Session.prototype, 'reload', function reload(fn) {
 
 defineMethod(Session.prototype, 'destroy', function destroy(fn) {
   delete this.req.session;
-  this.req.sessionStore.destroy(this.id, fn);
+  if (this.req.sessionOptions.passReqToStore) {
+    this.req.sessionStore.destroy(this.id, this.req, fn);
+  } else {
+    this.req.sessionStore.destroy(this.id, fn);
+  }
   return this;
 });
 

session/store.js

@@ -49,29 +49,15 @@ util.inherits(Store, EventEmitter)
 
 Store.prototype.regenerate = function(req, fn){
   var self = this;
-  this.destroy(req.sessionID, function(err){
+  var destroyCallback = function(err){
     self.generate(req);
     fn(err);
-  });
-};
-
-/**
- * Load a `Session` instance via the given `sid`
- * and invoke the callback `fn(err, sess)`.
- *
- * @param {String} sid
- * @param {Function} fn
- * @api public
- */
-
-Store.prototype.load = function(sid, fn){
-  var self = this;
-  this.get(sid, function(err, sess){
-    if (err) return fn(err);
-    if (!sess) return fn();
-    var req = { sessionID: sid, sessionStore: self };
-    fn(null, self.createSession(req, sess))
-  });
+  };
+  if (req.sessionOptions.passReqToStore) {
+    this.destroy(req.sessionID, req, destroyCallback);
+  } else {
+    this.destroy(req.sessionID, destroyCallback);
+  }
 };
 
 /**

test/cookie.js

@@ -62,11 +62,12 @@ describe('new Cookie()', function () {
       })
 
       it('should set maxAge', function () {
-        var expires = new Date(Date.now() + 60000)
+        var now = Date.now()
+        var expires = new Date(now + 60000)
         var cookie = new Cookie({ expires: expires })
 
-        assert.ok(expires.getTime() - Date.now() - 1000 <= cookie.maxAge)
-        assert.ok(expires.getTime() - Date.now() + 1000 >= cookie.maxAge)
+        assert.ok(expires.getTime() - now - 1000 <= cookie.maxAge)
+        assert.ok(expires.getTime() - now + 1000 >= cookie.maxAge)
       })
     })