Refactor regenerate as session signal _requireRegenerate.

koajs · Jun 18, 2017 · 919968a · 919968a
1 parent dcede0c
commit 919968a
Show file tree

Hide file tree

Showing 5 changed files with 93 additions and 13 deletions.
diff --git a/index.js b/index.js
@@ -105,13 +105,6 @@ function extendContext(context, opts) {
         return this[_CONTEXT_SESSION];
       },
     },
-    regenerateSession: {
-      get() {
-        return async() => {
-          await this[_CONTEXT_SESSION].regenerate();
-        };
-      },
-    },
     session: {
       get() {
         return this[CONTEXT_SESSION].get();

diff --git a/lib/context.js b/lib/context.js
@@ -181,12 +181,6 @@ class ContextSession {
     this.session = new Session(this.ctx, val);
   }
 
-  async regenerate() {
-    await this.remove();
-    this.create();
-    this.session.save();
-  }
-
   /**
    * Commit the session changes or removal.
    *
@@ -207,6 +201,11 @@ class ContextSession {
       await this.remove();
       return;
     }
+    if (session._requireRegenerate) {
+      await this.remove();
+      if (this.opts.store) this.externalKey = uid.sync(24);
+      session.save();
+    }
 
     // force save session when `session._requireSave` set
     if (!session._requireSave) {

diff --git a/lib/session.js b/lib/session.js
@@ -110,6 +110,10 @@ class Session {
   save() {
     this._requireSave = true;
   }
+
+  regenerate() {
+    this._requireRegenerate = true;
+  }
 }
 
 module.exports = Session;
diff --git a/test/cookie.test.js b/test/cookie.test.js
@@ -623,6 +623,48 @@ describe('Koa Session Cookie', () => {
     });
   });
 
+  describe('ctx.session.regenerate', () => {
+    it('should change the session key, but not content', done => {
+      const app = new App();
+      const message = 'hi';
+      app.use(async function(ctx, next) {
+        ctx.session = { message: 'hi' };
+        await next();
+      });
+
+      app.use(async function(ctx, next) {
+        const sessionKey = ctx.cookies.get('koa:sess');
+        if (sessionKey) {
+          await ctx.session.regenerate();
+        }
+        await next();
+      });
+
+      app.use(async function(ctx) {
+        ctx.session.message.should.equal(message);
+        ctx.body = '';
+      });
+      let koaSession = null;
+      request(app.callback())
+      .get('/')
+      .expect(200, (err, res) => {
+        should.not.exist(err);
+        koaSession = res.headers['set-cookie'][0];
+        koaSession.should.containEql('koa:sess=');
+        request(app.callback())
+        .get('/')
+        .set('Cookie', koaSession)
+        .expect(200, (err, res) => {
+          should.not.exist(err);
+          const cookies = res.headers['set-cookie'][0];
+          cookies.should.containEql('koa:sess=');
+          cookies.should.not.equal(koaSession);
+          done();
+        });
+      });
+    });
+  });
+
   describe('when get session before enter session middleware', () => {
     it('should work', done => {
       const app = new Koa();

diff --git a/test/store.test.js b/test/store.test.js
@@ -479,6 +479,48 @@ describe('Koa Session External Store', () => {
     });
   });
 
+  describe('ctx.session.regenerate', () => {
+    it('should change the session key, but not content', done => {
+      const app = new App();
+      const message = 'hi';
+      app.use(async function(ctx, next) {
+        ctx.session = { message: 'hi' };
+        await next();
+      });
+
+      app.use(async function(ctx, next) {
+        const sessionKey = ctx.cookies.get('koa:sess');
+        if (sessionKey) {
+          await ctx.session.regenerate();
+        }
+        await next();
+      });
+
+      app.use(async function(ctx) {
+        ctx.session.message.should.equal(message);
+        ctx.body = '';
+      });
+      let koaSession = null;
+      request(app.callback())
+      .get('/')
+      .expect(200, (err, res) => {
+        should.not.exist(err);
+        koaSession = res.headers['set-cookie'][0];
+        koaSession.should.containEql('koa:sess=');
+        request(app.callback())
+        .get('/')
+        .set('Cookie', koaSession)
+        .expect(200, (err, res) => {
+          should.not.exist(err);
+          const cookies = res.headers['set-cookie'][0];
+          cookies.should.containEql('koa:sess=');
+          cookies.should.not.equal(koaSession);
+          done();
+        });
+      });
+    });
+  });
+
   describe('when store return empty', () => {
     it('should create new Session', done => {
       const app = App({ signed: false });