tomjs-koa-session2

forked from Secbone/koa-session2

Middleware for Koa2 to get/set session use with custom stores such as Redis or mongodb

Use native ES6(async/await) by Nodejs v7.6.0 +

Or you can use the old versions:

• babel
• node6

Require

node v7.6 +

Install

npm install koa-session2

Usage

1const Koa = require("koa");
2const session = require("koa-session2");
3
4const app = new Koa();
5
6app.use(session({
7    key: "SESSIONID",   //default "koa:sess"
8}));

Custom Stores

Store.js

1const Redis = require("ioredis");
2const { Store } = require("koa-session2");
3
4class RedisStore extends Store {
5    constructor() {
6        super();
7        this.redis = new Redis();
8    }
9
10    async get(sid, ctx) {
11        let data = await this.redis.get(`SESSION:${sid}`);
12        return JSON.parse(data);
13    }
14
15    async set(session, { sid =  this.getID(24), maxAge = 1000000 } = {}, ctx) {
16        try {
17            // Use redis set EX to automatically drop expired sessions
18            await this.redis.set(`SESSION:${sid}`, JSON.stringify(session), 'EX', maxAge / 1000);
19        } catch (e) {}
20        return sid;
21    }
22
23    async destroy(sid, ctx) {
24        return await this.redis.del(`SESSION:${sid}`);
25    }
26}
27
28module.exports = RedisStore;

main.js

1const Koa = require("koa");
2const session = require("koa-session2");
3const Store = require("./Store.js");
4
5const app = new Koa();
6
7app.use(session({
8    store: new Store()
9}));
10
11app.use(ctx => {
12    let user = ctx.session.user;
13
14    ctx.session.view = "index";
15});
16
17app.use(ctx => {
18    // refresh session if set maxAge
19    ctx.session.refresh()
20})

Options

Most options based on cookies

• key: a string for store session id in cookie
• store: a class for custom store (extend {Store}, func: #get(sid), #set(session, opts), #destory(sid))
• maxAge: a number representing the milliseconds from Date.now() for expiry
• expires: a Date object indicating the cookie's expiration date (expires at the end of session by default).
• path: a string indicating the path of the cookie (/ by default).
• domain: a string indicating the domain of the cookie (no default).
• secure: a boolean indicating whether the cookie is only to be sent over HTTPS (false by default for HTTP, true by default for HTTPS).
• httpOnly: a boolean indicating whether the cookie is only to be sent over HTTP(S), and not made available to client JavaScript (true by default).
• sameSite: a boolean or string indicating whether the cookie is a "same site" cookie (false by default). This can be set to 'strict', 'lax', or true (which maps to 'strict').
• signed: a boolean indicating whether the cookie is to be signed (false by default). If this is true, another cookie of the same name with the .sig suffix appended will also be sent, with a 27-byte url-safe base64 SHA1 value representing the hash of cookie-name=cookie-value against the first Keygrip key. This signature key is used to detect tampering the next time a cookie is received.
• overwrite: a boolean indicating whether to overwrite previously set cookies of the same name (false by default). If this is true, all cookies set during the same request with the same name (regardless of path or domain) are filtered out of the Set-Cookie header when setting this cookie.

Methods

• refresh(): if you set maxAge in options, you can call ctx.session.refresh() to refresh session to your store

License

MIT