backport: #2146 support Keep-Alive Header

eggjs · Apr 3, 2019 · 22eef57 · 22eef57
1 parent 328cbf2
commit 22eef57
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 0 deletions.
diff --git a/app/middleware/meta.js b/app/middleware/meta.js
@@ -9,5 +9,12 @@ module.exports = () => {
     yield next;
     // total response time header
     this.set('x-readtime', Date.now() - this.starttime);
+
+    // try to support Keep-Alive Header
+    const server = this.app.server;
+    if (server && server.keepAliveTimeout && server.keepAliveTimeout >= 1000 && this.header.connection !== 'close') {
+      const timeout = parseInt(server.keepAliveTimeout / 1000);
+      this.set('keep-alive', `timeout=${timeout}`);
+    }
   };
 };
diff --git a/lib/application.js b/lib/application.js
@@ -47,6 +47,9 @@ class Application extends EggApplication {
     options.type = 'application';
     super(options);
 
+    // will auto set after 'server' event emit
+    this.server = null;
+
     try {
       this.loader.load();
     } catch (e) {
@@ -85,6 +88,9 @@ class Application extends EggApplication {
   }
 
   onServer(server) {
+    // expose app.server
+    this.server = server;
+
     /* istanbul ignore next */
     graceful({
       server: [ server ],

diff --git a/test/app/middleware/meta.test.js b/test/app/middleware/meta.test.js
@@ -1,6 +1,7 @@
 'use strict';
 
 const mm = require('egg-mock');
+const assert = require('assert');
 const utils = require('../../utils');
 
 describe('test/app/middleware/meta.test.js', () => {
@@ -20,4 +21,30 @@ describe('test/app/middleware/meta.test.js', () => {
       .expect('X-Readtime', /\d+/)
       .expect(200);
   });
+
+  describe('cluster start', () => {
+    let app;
+    before(() => {
+      app = utils.cluster('apps/middlewares');
+      return app.ready();
+    });
+    after(() => app.close());
+
+    it('should ignore keep-alive header when request is not keep-alive', () => {
+      return app.httpRequest()
+        .get('/')
+        .expect('X-Readtime', /\d+/)
+        .expect(res => assert(!res.headers['keep-alive']))
+        .expect(200);
+    });
+
+    it('should return keep-alive header when request is keep-alive', () => {
+      return app.httpRequest()
+        .get('/')
+        .set('connection', 'keep-alive')
+        .expect('X-Readtime', /\d+/)
+        .expect('keep-alive', 'timeout=5')
+        .expect(200);
+    });
+  });
 });