Redis storage for koa session middleware/cache using ioredis.
npm i koa-session-ioredis ioredis --save
koa-session-ioredis
works with koa-generic-session (a generic session middleware for koa).
var session = require('koa-generic-session');
var redisStore = require('koa-session-ioredis');
var koa = require('koa');
var app = koa();
app.keys = ['keys', 'keykeys'];
app.use(session({
store: redisStore({
// Options specified here
})
}));
app.use(function *() {
switch (this.path) {
case '/get':
get.call(this);
break;
case '/remove':
remove.call(this);
break;
case '/regenerate':
yield regenerate.call(this);
break;
}
});
function get() {
var session = this.session;
session.count = session.count || 0;
session.count++;
this.body = session.count;
}
function remove() {
this.session = null;
this.body = 0;
}
function *regenerate() {
get.call(this);
yield this.regenerateSession();
get.call(this);
}
app.listen(8080);
For more examples, please see the examples folder of koa-generic-session
.
- all
ioredis
options - Useful things include
host
,port
, andpath
to the server. Defaults to127.0.0.1:6379
client
(object) - supply your own client, all other options are ignored unlessduplicate
is also suppliedduplicate
(boolean) - When true, it will runclient.duplicate(options)
on the suppliedclient
and use all other options supplied. This is useful if you want to select a different DB for sessions but also want to base from the same client object.
See the ioredis
docs for more info.
ready
connect
reconnecting
error
end
close
idle
These are some the funcitons that koa-generic-session
uses that you can use manually. You will need to inintialize differently than the example above:
var session = require('koa-generic-session');
var redisStore = require('koa-session-ioredis')({
// Options specified here
});
var app = require('koa')();
app.keys = ['keys', 'keykeys'];
app.use(session({
store: redisStore
}));
Initialize the Redis connection with the optionally provided options (see above). The variable session
below references this.
Generator that gets a session by ID. Returns parsed JSON is exists, null
if it does not exist, and nothing upon error.
Generator that sets a JSON session by ID with an optional time-to-live (ttl) in milliseconds. Yields ioredis
's client.set()
or client.setex()
.
Generator that destroys a session (removes it from Redis) by ID. Yields ioredis
's client.del()
.
Generator that stops a Redis session after everything in the queue has completed. Yields ioredis
's client.quit()
.
Alias to session.quit()
. It is not safe to use the real end function, as it cuts of the queue.
String giving the connection status updated using client.status
after any of the events above is fired.
connecting
connect
ready
reconnecting
end
monitoring
Direct access to the ioredis
client.
Server | Transaction rate | Response time |
---|---|---|
connect without session | 6763.56 trans/sec | 0.01 secs |
koa without session | 5684.75 trans/sec | 0.01 secs |
connect with session | 2759.70 trans/sec | 0.02 secs |
koa with session | 2355.38 trans/sec | 0.02 secs |
Detailed benchmark report here
- Start a Redis server on
localhost:6379
. You can useredis-windows
if you are on Windows or just want a quick VM-based server. - Clone the repository and run
npm i
in it (Windows should work fine). - If you want to see debug output, turn on the prompt's
DEBUG
flag. - Run
npm test
to run the tests and generate coverage. To run the tests without generating coverage, runnpm run-script test-only
.
See the contributing tab
(The MIT License)
Copyright (c) 2015 dead-horse and other contributors
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.