feat: support agentkeepalive@4 (#297)

.travis.yml

@@ -9,14 +9,21 @@ node_js:
 env:
   - AGENT_VERSION=2
   - AGENT_VERSION=3
+  - AGENT_VERSION=4
 matrix:
   exclude:
     - node_js: '0.12'
       env: AGENT_VERSION=3
+    - node_js: '0.12'
+      env: AGENT_VERSION=4
     - node_js: '4'
       env: AGENT_VERSION=2
+    - node_js: '4'
+      env: AGENT_VERSION=4
     - node_js: '6'
       env: AGENT_VERSION=2
+    - node_js: '6'
+      env: AGENT_VERSION=4
     - node_js: '8'
       env: AGENT_VERSION=2
     - node_js: '10'

azure-pipelines.template.yml

@@ -10,8 +10,6 @@ jobs:
     vmImage: ${{ parameters.vmImage }}
   strategy:
     matrix:
-      node_6:
-        node_version: 6
       node_8:
         node_version: 8
       node_10:

examples/httpclient2.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var HttpClient = require('../').HttpClient;
-var Agent = require('agentkeepalive');
+var HttpAgent = require('agentkeepalive');
 var HttpsAgent = require('agentkeepalive').HttpsAgent;
 
 tryHttpclient(HttpClient, 'urllib1');
@@ -12,17 +12,17 @@ function tryHttpclient(HttpClient, name) {
     method: 'HEAD',
     timeout: 10000,
   };
-  var agent = new Agent({
+  var httpAgent = new HttpAgent({
     timeout: 60000,
     freeSocketKeepAliveTimeout: 30000,
   });
   var httpsAgent = new HttpsAgent({
     timeout: 60000,
     freeSocketKeepAliveTimeout: 30000,
   });
-  var urllib = new HttpClient({ agent: agent, httpsAgent: httpsAgent });
+  var urllib = new HttpClient({ agent: httpAgent, httpsAgent: httpsAgent });
   urllib.on('response', function(info) {
-    console.log(name, agent, agent.getCurrentStatus());
+    console.log(name, httpAgent, httpAgent.getCurrentStatus());
     console.log(name, httpsAgent, httpsAgent.getCurrentStatus());
     console.log(name, info.res.keepAliveSocket);
   });

lib/urllib.js

@@ -500,17 +500,26 @@ function requestWithCallback(url, args, callback) {
     }
 
     // only support agentkeepalive module for now
-    if (agent && agent.keepAlive && agent.freeSocketKeepAliveTimeout > 0 &&
+    // agentkeepalive@4: agent.options.freeSocketTimeout
+    // agentkeepalive@3: agent.freeSocketKeepAliveTimeout
+    var freeSocketTimeout = agent.options && agent.options.freeSocketTimeout || agent.freeSocketKeepAliveTimeout;
+    if (agent && agent.keepAlive && freeSocketTimeout > 0 &&
         statusCode >= 200 && headers.connection === 'keep-alive' && headers['keep-alive']) {
-      // adjust freeSocketKeepAliveTimeout on the socket
+      // adjust freeSocketTimeout on the socket
       var m = KEEP_ALIVE_RE.exec(headers['keep-alive']);
       if (m) {
         var seconds = parseInt(m[1]);
         if (seconds > 0) {
           // network delay 500ms
-          var serverKeepAliveTimeout = seconds * 1000 - 500;
-          if (serverKeepAliveTimeout < agent.freeSocketKeepAliveTimeout) {
-            res.socket.freeSocketKeepAliveTimeout = serverKeepAliveTimeout;
+          var serverSocketTimeout = seconds * 1000 - 500;
+          if (serverSocketTimeout < freeSocketTimeout) {
+            // https://github.com/node-modules/agentkeepalive/blob/master/lib/agent.js#L127
+            // agentkeepalive@4
+            if (agent.options && agent.options.freeSocketTimeout) {
+              res.socket.freeSocketTimeout = serverSocketTimeout;
+            } else {
+              res.socket.freeSocketKeepAliveTimeout = serverSocketTimeout;
+            }
           }
         }
       }

package.json

@@ -46,7 +46,7 @@
     "utility": "^1.12.0"
   },
   "devDependencies": {
-    "agentkeepalive": "^3.4.0",
+    "agentkeepalive": "^4.0.0",
     "autod": "*",
     "benchmark": "^2.1.4",
     "bluebird": "*",

test/config.js

@@ -4,7 +4,7 @@ module.exports = process.env.CI ? {
   // npmjs.com do not support gzip now
   npmWeb: 'https://cnpmjs.org',
   npmRegistry: 'https://registry.npmjs.com',
-  npmHttpRegistry: 'http://registry.npm.taobao.org',
+  npmHttpRegistry: 'http://registry.npmjs.com',
 } : {
   npmWeb: 'https://npm.taobao.org',
   npmRegistry: 'https://registry.npm.taobao.org',