koa-redis
![license](https://img.shields.io/npm/l/koa-redis.svg?style=flat-square)
Redis storage for koa session middleware/cache.
![NPM](https://nodei.co/npm/koa-redis.svg?downloads=true)
Usage
koa-redis
works with koa-generic-session (a generic session middleware for koa).
Example
var session = require('koa-generic-session');
var redisStore = require('koa-redis');
var koa = require('koa');
var app = koa();
app.keys = ['keys', 'keykeys'];
app.use(session({
store: redisStore({
})
}));
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
.
Options
- all
node_redis
options - Useful things include url
, host
, port
, and path
to the server. Defaults to 127.0.0.1:6379
db
(number) - will run client.select(db)
after connectionclient
(object) - supply your own client, all other options are ignored unless duplicate
is also suppliedduplicate
(boolean) - When true, it will run client.duplicate(options)
on the supplied client
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.serialize
- Used to serialize the data that is saved into the store.unserialize
- Used to unserialize the data that is fetched from the store.- DEPRECATED: old options -
pass
and socket
have been replaced by auth_pass
and path
, but they should be backward compatible (still work).
Events
See the node_redis
docs for more info.
ready
connect
reconnecting
error
end
warning
API
These are some the functions that koa-generic-session
uses that you can use manually. You will need to initialize differently than the example above:
var session = require('koa-generic-session');
var redisStore = require('koa-redis')({
});
var app = require('koa')();
app.keys = ['keys', 'keykeys'];
app.use(session({
store: redisStore
}));
module([options])
Initialize the Redis connection with the optionally provided options (see above). The variable session
below references this.
session.get(sid)
Generator that gets a session by ID. Returns parsed JSON is exists, null
if it does not exist, and nothing upon error.
session.set(sid, sess, ttl)
Generator that sets a JSON session by ID with an optional time-to-live (ttl) in milliseconds. Yields node_redis
's client.set()
or client.setex()
.
session.destroy(sid)
Generator that destroys a session (removes it from Redis) by ID. Tields node_redis
's client.del()
.
session.quit()
Generator that stops a Redis session after everything in the queue has completed. Yields node_redis
's client.quit()
.
session.end()
Alias to session.quit()
. It is not safe to use the real end function, as it cuts off the queue.
session.connected
Boolean giving the connection status updated using client.connected
after any of the events above is fired.
session._redisClient
Direct access to the node_redis
client object.
session.client
Direct access to the co-redis
wrapper around the node_redis
client.
Benchmark
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
Testing
- Start a Redis server on
localhost:6379
. You can use redis-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, run npm run-script test-only
.
Authors
See the contributing tab
Licences
(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.