Express/connect sessions in socket.io
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

session.socket.io (SessionSockets) Build Status

This tiny module simplifies the usage of socket.io with http sessions from express or connect middlewares. It has no dependencies and can be initialized using any session store and cookie parser compatible with express or connect.

Compatibility:

  • Express 3
  • Express 4
  • Connect 2
  • Socket.io 0.9

If you're using socket.io 1.0 or newer, this is not required because socket.io 1.0 has built-in support for middlewares.

Quick Start

Import the module and initialize it providing the required parameters

var SessionSockets = require('session.socket.io'),
    sessionSockets = new SessionSockets(io, sessionStore, cookieParser);

Listen to socket connections and get the socket as provided by socket.io with either an error or the session

sessionSockets.on('connection', function (err, socket, session) {
  //your regular socket.io code goes here
  //and you can still use your io object
});

Running the example

$ cd example
$ npm install
$ node server.js

Visit http://localhost:3000

Running the spec

$ npm install
$ make spec

Saving values into the session

sessionSockets.on('connection', function (err, socket, session) {
  session.foo = 'bar';
  //at this point the value is not yet saved into the session
  session.save();
  //now you can read session.foo from your express routes or connect middlewares
});

Namespacing

sessionSockets.of('/chat').on('connection', function (err, socket, session) {
  //the socket here will address messages only to the /chat namespace
});

Get session for a client

io.sockets.clients().forEach(function (socket) {
  // so far we have access only to client sockets
  sessionSockets.getSession(socket, function (err, session) {
    // getSession gives you an error object or the session for a given socket
  });
});

Callback parameters and error handling

Note that now you receive 3 parameters in the connection callback: (err, socket, session).

  • The first parameter will be present if an error has occured, otherwise null. Errors may originate from the cookie parser when trying to parse the cookie, or from the session store when trying to lookup the session by key.
  • The second parameter will be the socket as provided by socket.io.
  • The third parameter will be the corresponding user session for that socket connection if an error has not ocurred, otherwise null.

Troubleshooting

The cookieParser doesn't need to be the same reference, you can create another instance somewhere else, but it should take the same 'secret', otherwise the cookie id won't be decoded, therefore the session data won't be retrieved.

The sessionStore must be the same instance.

You can always debug cookies and session data from any socket.handshake. The socket is the same as provided by socket.io.

Cookie lookup precedence

When looking up for the cookie in a socket.handshake, SessionSockets will take precedence on the following order:

  1. secureCookies
  2. signedCookies
  3. cookies

Custom session store key

You can specify a custom session store key

new SessionSockets(io, sessionStore, cookieParser, 'customSessionStoreKey');

It defaults to 'connect.sid' (which is default for both connect and express).

A step by step example

This is for express 3. If you're using express 4, follow the steps above under "Running the example" but in the example-express4 directory.

var http = require('http'),
    connect = require('connect'),
    express = require('express'),
    app = express();

Below are the two main references you will need to keep

var cookieParser = express.cookieParser('your secret sauce'),
    sessionStore = new connect.middleware.session.MemoryStore();

Both will be used by express and so far everything's familiar. Note that you need to provide sessionStore when using express.session(). Here you could use Redis or any other store as well.

app.configure(function () {
  //hiding other express configuration
  app.use(cookieParser);
  app.use(express.session({ secret: 'your secret sauce', store: sessionStore }));
});

Next, you create the server and bind socket.io to it (nothing new here)

var server = http.createServer(app),
    io = require('socket.io').listen(server);

Inject the original io module with the sessionStore and cookieParser

var SessionSockets = require('session.socket.io'),
    sessionSockets = new SessionSockets(io, sessionStore, cookieParser);

Now instead of io.sockets.on('connection', ...) you will use sessionSockets, giving you the session for that socket

sessionSockets.on('connection', function (err, socket, session) {
  //your regular socket.io code goes here
  //and you can still use your io object
});

License

The MIT License

Copyright (c) 2012 Wagner Camarao <wagner@camarao.io>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.