JSPM

  • Created
  • Published
  • Downloads 19813
  • Score
    100M100P100Q143527F

MongoDB session store for connect built by MongoDB

Package Exports

  • connect-mongodb-session

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (connect-mongodb-session) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

connect-mongodb-session

MongoDB-backed session storage for connect and Express. Meant to be a well-maintained and fully-featured replacement for modules like connect-mongo

MongoDBStore

This module exports a single function which takes an instance of connect (or Express) and returns a MongoDBStore class that can be used to store sessions in MongoDB.

It can store sessions for Express 4

If you pass in an instance of the express-session module the MongoDBStore class will enable you to store your Express sessions in MongoDB.

    
    var express = require('express');

    var MongoDBStore = connectMongoDB(require('express-session'));

    var app = express();
    var store = new MongoDBStore(
      { 
        uri: 'mongodb://localhost:27017/connect_mongodb_session_test',
        collection: 'mySessions'
      },
      function(error) {
        assert.ifError(error);

        app.use(require('express-session')({
          secret: 'This is a secret',
          cookie: {
            maxAge: 1000 * 60 * 60 * 24 * 7 // 1 week
          },
          store: store
        }));

        app.get('/', function(req, res) {
          res.send('Hello ' + JSON.stringify(req.session));
        });

        var server = app.listen(3000);

        underlyingDb.collection('mySessions').count({}, function(error, count) {
          assert.ifError(error);
          assert.equal(0, count);

          request('http://localhost:3000', function(error, response, body) {
            assert.ifError(error);
            assert.equal(1, response.headers['set-cookie'].length);
            var cookie = require('cookie').parse(response.headers['set-cookie'][0]);
            assert.ok(cookie['connect.sid']);
            underlyingDb.collection('mySessions').count({}, function(error, count) {
              assert.ifError(error);
              assert.equal(1, count);
              server.close();
              done();
            });
          });
        });
      });
  
It can store sessions for latest Express 3.x

If you're using Express 3.x, you need to pass the Express module itself rather than the express-session module. Session storage is part of the Express core in 3.x but not in 4.x.

    
    var express = require('../vendor/express-3.18.1');

    var MongoDBStore = connectMongoDB(express);

    var app = express();
    var store = new MongoDBStore(
      {
        uri: 'mongodb://localhost:27017/connect_mongodb_session_test',
        collection: 'mySessions'
      });

    app.use(express.session({
      secret: 'This is a secret',
      cookie: {
        maxAge: 1000 * 60 * 60 * 24 * 7 // 1 week
      },
      store: store
    }));

    app.get('/', function(req, res) {
      res.send('Hello ' + JSON.stringify(req.session));
    });

    var server = app.listen(3000);

    underlyingDb.collection('mySessions').count({}, function(error, count) {
      assert.ifError(error);
      assert.equal(0, count);

      request('http://localhost:3000', function(error, response, body) {
        assert.ifError(error);
        assert.equal(1, response.headers['set-cookie'].length);
        var cookie = require('cookie').parse(response.headers['set-cookie'][0]);
        assert.ok(cookie['connect.sid']);
        underlyingDb.collection('mySessions').count({}, function(error, count) {
          assert.ifError(error);
          assert.equal(1, count);
          server.close();
          done();
        });
      });
    });