feat: add session.externalKey

Readme.md

@@ -160,6 +160,10 @@ if (this.session.isNew) {
 
   Set cookie's maxAge.
 
+### Session#externalKey
+
+  Get session external key, only exist when external session store present.
+
 ### Session#save()
 
   Save this session no matter whether it is populated.

lib/context.js

@@ -204,7 +204,7 @@ class ContextSession {
   create(val, externalKey) {
     debug('create session with val: %j externalKey: %s', val, externalKey);
     if (this.store) this.externalKey = externalKey || this.opts.genid && this.opts.genid(this.ctx);
-    this.session = new Session(this, val);
+    this.session = new Session(this, val, this.externalKey);
   }
 
   /**

lib/session.js

@@ -4,6 +4,8 @@
  * Session model.
  */
 
+const inspect = Symbol.for('nodejs.util.inspect.custom');
+
 class Session {
   /**
    * Session constructor
@@ -12,9 +14,10 @@ class Session {
    * @api private
    */
 
-  constructor(sessionContext, obj) {
+  constructor(sessionContext, obj, externalKey) {
     this._sessCtx = sessionContext;
     this._ctx = sessionContext.ctx;
+    this._externalKey = externalKey;
     if (!obj) {
       this.isNew = true;
     } else {
@@ -52,7 +55,7 @@ class Session {
    * @api public
    */
 
-  inspect() {
+  [inspect]() {
     return this.toJSON();
   }
 
@@ -103,6 +106,14 @@ class Session {
     this._requireSave = true;
   }
 
+  /**
+   * get session external key
+   * only exist if opts.store present
+   */
+  get externalKey() {
+    return this._externalKey;
+  }
+
   /**
    * save this session no matter whether it is populated
    *

test/contextstore.test.js

@@ -7,6 +7,8 @@ const mm = require('mm');
 const session = require('..');
 const ContextStore = require('./context_store');
 
+const inspect = Symbol.for('nodejs.util.inspect.custom');
+
 describe('Koa Session External Context Store', () => {
   let cookie;
 
@@ -280,7 +282,7 @@ describe('Koa Session External Context Store', () => {
 
         app.use(async function(ctx) {
           ctx.session.foo = 'bar';
-          ctx.body = ctx.session.inspect();
+          ctx.body = ctx.session[inspect]();
         });
 
         request(app.listen())

test/cookie.test.js

@@ -6,6 +6,8 @@ const request = require('supertest');
 const should = require('should');
 const session = require('..');
 
+const inspect = Symbol.for('nodejs.util.inspect.custom');
+
 describe('Koa Session Cookie', () => {
   let cookie;
 
@@ -385,7 +387,7 @@ describe('Koa Session Cookie', () => {
 
         app.use(async function(ctx) {
           ctx.session.foo = 'bar';
-          ctx.body = ctx.session.inspect();
+          ctx.body = ctx.session[inspect]();
         });
 
         request(app.listen())

test/externalkey.test.js

@@ -5,6 +5,7 @@ const assert = require('assert');
 const session = require('..');
 const store = require('./store');
 const TOKEN_KEY = 'User-Token';
+
 describe('Koa Session External Key', () => {
   describe('when the external key set/get is invalid', () => {
     it('should throw a error', () => {
@@ -24,8 +25,10 @@ describe('Koa Session External Key', () => {
         if (ctx.method === 'POST') {
           ctx.session.string = ';';
           ctx.status = 204;
+          assert(ctx.session.externalKey);
         } else {
           ctx.body = ctx.session.string;
+          assert(ctx.session.externalKey === ctx.get(TOKEN_KEY));
         }
       });
       const server = app.listen();

test/store.test.js

@@ -10,6 +10,8 @@ const pedding = require('pedding');
 const assert = require('assert');
 const sleep = require('mz-modules/sleep');
 
+const inspect = Symbol.for('nodejs.util.inspect.custom');
+
 describe('Koa Session External Store', () => {
   let cookie;
 
@@ -262,7 +264,7 @@ describe('Koa Session External Store', () => {
 
         app.use(async function(ctx) {
           ctx.session.foo = 'bar';
-          ctx.body = ctx.session.inspect();
+          ctx.body = ctx.session[inspect]();
         });
 
         request(app.listen())