node package manager

connect-mongodb-session

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

Build Status Coverage Status

API

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.

The MongoDBStore class has 2 required options:

  1. uri: a MongoDB connection string
  2. collection: the MongoDB collection to store sessions in

Note: You can pass a callback to the MongoDBStore constructor, but this is entirely optional. The Express 3.x example demonstrates that you can use the MongoDBStore class in a synchronous-like style: the module will manage the internal connection state for you.

    
    var express = require('express');
    var session = require('express-session');
    var MongoDBStore = require('connect-mongodb-session')(session);
 
    var app = express();
    var store = new MongoDBStore(
      {
        uri: 'mongodb://localhost:27017/connect_mongodb_session_test',
        collection: 'mySessions'
      });
 
    // Catch errors 
    store.on('error', function(error) {
      assert.ifError(error);
      assert.ok(false);
    });
 
    app.use(require('express-session')({
      secret: 'This is a secret',
      cookie: {
        maxAge: 1000 * 60 * 60 * 24 * 7 // 1 week 
      },
      store: store,
      // Boilerplate options, see: 
      // * https://www.npmjs.com/package/express-session#resave 
      // * https://www.npmjs.com/package/express-session#saveuninitialized 
      resave: true,
      saveUninitialized: true
    }));
 
    app.get('/', function(req, res) {
      res.send('Hello ' + JSON.stringify(req.session));
    });
 
    server = app.listen(3000);
  

Optional: To clear all sessions from the store, use store.clear(callback);. The callback should be called as callback(error).

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.

Note: This example doesn't pass a callback to the MongoDBStore constructor. This module can queue up requests to execute once the database is connected. However, the MongoDBStore constructor will throw an exception if it can't connect and no callback is passed.

    
    var express = require('../vendor/express-3.18.1');
 
    var MongoDBStore = require('connect-mongodb-session')(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,
      // Boilerplate options, see: 
      // * https://www.npmjs.com/package/express-session#resave 
      // * https://www.npmjs.com/package/express-session#saveuninitialized 
      resave: true,
      saveUninitialized: true
    }));
 
    app.get('/', function(req, res) {
      res.send('Hello ' + JSON.stringify(req.session));
    });
 
    server = app.listen(3000);
  

It throws an error when it can't connect to MongoDB

You should pass a callback to the MongoDBStore constructor to catch errors. If you don't pass a callback to the MongoDBStore constructor, MongoDBStore will throw if it can't connect.

    
    var express = require('../vendor/express-3.18.1');
 
    var MongoDBStore = require('connect-mongodb-session')(express);
 
    var app = express();
    var numExpectedSources = 2;
    var store = new MongoDBStore(
      {
        uri: 'mongodb://bad.host:27000/connect_mongodb_session_test?connectTimeoutMS=10',
        collection: 'mySessions'
      },
      function(error) {
        // Should have gotten an error 
      });
 
    store.on('error', function(error) {
      // Also get an error here 
    });
 
    app.use(express.session({
      secret: 'This is a secret',
      cookie: {
        maxAge: 1000 * 60 * 60 * 24 * 7 // 1 week 
      },
      store: store,
      // Boilerplate options, see: 
      // * https://www.npmjs.com/package/express-session#resave 
      // * https://www.npmjs.com/package/express-session#saveuninitialized 
      resave: true,
      saveUninitialized: true
    }));
 
    app.get('/', function(req, res) {
      res.send('Hello ' + JSON.stringify(req.session));
    });
 
    server = app.listen(3000);