sosa_session v1.0.0

sosa_session

connect/express-style session middleware for apps that don't use connect/express

Pluggable storage

sosa_session uses a memory store out of the box. It has limitations:

• not persistent through web server restarts
• if you run multiple web servers, each server will have its own set of sessions (which might be fine if you have "sticky" sessions configured on your load balancer)

However pluggable storage is supported through sosa so you might want to use that for production. See example below for using redis as a store.

Simple example with middler

var middler = require('middler')
  , server = require('http').createServer()

var sosa_session = require('sosa_session')();

// use as middleware
middler(server)
  .add(sosa_session)
  .add(function (req, res, next) {
    // req.session now available
    // also req.sessionID
  })

Options

sess() can be passed these options:

• key (String, default: sosa_session) - cookie name (can also be passed as options.cookie.name)
• cookie (Object, default: {httpOnly: true, path: '/'}) - options to pass to cookie, and additionally supported are: - alwaysSet (Boolean, default: false) - always issue Set-Cookie header
• sessions (sosa collection, default: memory store) - pass a sosa collection to achieve persistence or clustering (see redis example below)

connect/express compatibility

req.session with sess acts pretty much like it does in connect/express. It may even be compatible with some middleware that expects connect.session in the middleware stack. Disclaimer: I haven't tested the compatibility very thoroughly.

Using redis as a store

sosa_session uses a sosa collection to store sessions, which can be passed with options.sessions. Any sosa store, such as sosa_redis can be used to store sessions:

var client = require('redis').createClient()
  , middler = require('middler')
  , server = require('http').createServer()

// create a modeler-redis collection for sessions
var sessions = require('sosa_redis')({
  client: client,
  prefix: 'myapp'
})('sessions');

// pass that to sosa_session
var sosa_session = require('sosa_session')({
  sessions: sessions
});

// use as middleware
middler(server)
  .add(sosa_session)
  .add(function (req, res, next) {
    // req.session now available
    // also req.sessionID
  })

Developed by Terra Eclipse

Terra Eclipse, Inc. is a nationally recognized political technology and strategy firm located in Aptos, CA and Washington, D.C.

License: MIT

• Copyright (C) 2016 Carlos Rodriguez (http://s8f.org/)
• Copyright (C) 2016 Terra Eclipse, Inc. (http://www.terraeclipse.com/)

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.