Merge pull request #455 from cloudant/454-double-callback

454 double callback

Author: ricellis

.mocharc.json

@@ -0,0 +1,5 @@
+{
+"exclude": "test/typescript/*.js",
+"recursive": true,
+"timeout": 60000
+}

.travis.yml

@@ -6,8 +6,8 @@ branches:
     - rewrite
 node_js:
   - "node"
-  - "10"
-  - "8"
+  - "14"
+  - "12"
 os:
   - linux
 before_install:

CHANGES.md

@@ -1,3 +1,8 @@
+# Unreleased
+- [FIXED] Parsing of max-age from Set-Cookie headers.
+- [FIXED] Double callback if plugin errors when updating state.
+- [NOTE] Updated engines to remove EOL Node.js versions (minimum is now Node.js 12).
+
 # 4.3.1 (2021-03-17)
 - [NEW] Add migration guide to the newly supported cloudant-node-sdk
   (package: @ibm-cloud/cloudant).

Jenkinsfile

@@ -76,13 +76,13 @@ stage('Build') {
 
 stage('QA') {
   parallel([
-    Node8x : {
-      //8.x LTS
-      setupNodeAndTest('lts/carbon')
+    Node12x : {
+      //12.x LTS
+      setupNodeAndTest('lts/erbium')
     },
-    Node10x : {
-      //10.x LTS
-      setupNodeAndTest('lts/dubnium')
+    Node14x : {
+      //14.x LTS
+      setupNodeAndTest('lts/fermium')
     },
     Node : {
       // Current

lib/clientutils.js

@@ -1,4 +1,4 @@
-// Copyright © 2017, 2018 IBM Corp. All rights reserved.
+// Copyright © 2017, 2021 IBM Corp. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -67,7 +67,7 @@ var processState = function(r, callback) {
   if (r.abort) {
     // [1] => Client has called for the request to be aborted.
     abort();
-    callback(new Error('Client issued abort')); // no retry
+    setImmediate(callback, new Error('Client issued abort')); // no retry
     return;
   }
 
@@ -77,15 +77,15 @@ var processState = function(r, callback) {
     sendResponseToClient(r.state.abortWithResponse, r.clientStream, r.clientCallback);
     var err = new Error('Plugin issued abort');
     err.skipClientCallback = true;
-    callback(err); // no retry
+    setImmediate(callback, err); // no retry
     return;
   }
 
   if (r.state.retry && r.state.attempt < r.state.maxAttempt) {
     // [3] => One or more plugins have called for the request to be retried.
     abort();
     debug('Plugin issued a retry.');
-    callback(); // retry
+    setImmediate(callback); // retry
     return;
   }
 
@@ -104,7 +104,7 @@ var processState = function(r, callback) {
 
   if (!r.state.sending) {
     // [4] => Request has not yet been sent. Still processing 'onRequest' hooks.
-    callback(); // continue
+    setImmediate(callback); // continue
     return;
   }
 
@@ -120,7 +120,7 @@ var processState = function(r, callback) {
   }
 
   // [5] => Return response to awaiting client.
-  callback(new Error('No retry requested')); // no retry
+  setImmediate(callback, new Error('No retry requested')); // no retry
 };
 
 // execute a specified hook for all plugins

lib/tokens/TokenManager.js

@@ -1,4 +1,4 @@
-// Copyright © 2019 IBM Corp. All rights reserved.
+// Copyright © 2019, 2021 IBM Corp. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -32,7 +32,9 @@ class TokenManager {
   _autoRenew(defaultMaxAgeSecs) {
     debug('Auto renewing token now...');
     this._renew().then((response) => {
-      let maxAgeSecs = cookie.parse(response.headers['set-cookie'][0])['Max-Age'] || defaultMaxAgeSecs;
+      let setCookieHeader = response.headers['set-cookie'];
+      let headerValue = Array.isArray(setCookieHeader) ? setCookieHeader[0] : setCookieHeader;
+      let maxAgeSecs = cookie.parse(headerValue)['Max-Age'] || defaultMaxAgeSecs;
       let delayMSecs = maxAgeSecs / 2 * 1000;
       debug(`Renewing token in ${delayMSecs} milliseconds.`);
       setTimeout(this._autoRenew.bind(this, defaultMaxAgeSecs), delayMSecs).unref();

package-lock.json

@@ -47,7 +47,7 @@
     "eslint-plugin-standard": "^3.0.1",
     "md5-file": "^3.2.3",
     "mocha": "^7.1.2",
-    "nock": "^9.2.5",
+    "nock": "^13",
     "should": "6.0.3",
     "typescript": "^2.8.3",
     "uuid": "^3.0.1"
@@ -58,11 +58,12 @@
     "test-live": "NOCK_OFF=true mocha",
     "test-live-verbose": "env DEBUG='*,-mocha:*' npm run test-live",
     "tslint": "tslint --project types",
-    "type-check": "tsc --project types/tsconfig.json"
+    "type-check": "tsc --project types/tsconfig.json",
+    "mocha": "mocha"
   },
   "main": "./cloudant.js",
   "types": "types",
   "engines": {
-    "node": ">=6.13.0"
+    "node": ">=12"
   }
 }

package.json

@@ -1,4 +1,4 @@
-// Copyright © 2015, 2019 IBM Corp. All rights reserved.
+// Copyright © 2015, 2021 IBM Corp. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -68,16 +68,13 @@ class CookiePlugin extends BasePlugin {
     delete req.url;
     req.uri = u.format(new u.URL(req.uri), {auth: false});
 
-    self._tokenManager.renewIfRequired().then(() => {
-      callback(state);
-    }).catch((error) => {
+    self._tokenManager.renewIfRequired().catch((error) => {
       if (state.attempt < state.maxAttempt) {
         state.retry = true;
       } else {
         state.abortWithResponse = [ error ]; // return error to client
       }
-      callback(state);
-    });
+    }).finally(() => callback(state));
   }
 
   onResponse(state, response, callback) {

plugins/cookieauth.js

@@ -1,4 +1,4 @@
-// Copyright © 2017, 2019 IBM Corp. All rights reserved.
+// Copyright © 2017, 2021 IBM Corp. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -66,9 +66,7 @@ class IAMPlugin extends BasePlugin {
     delete req.url;
     req.uri = u.format(new u.URL(req.uri), {auth: false});
 
-    self._tokenManager.renewIfRequired().then(() => {
-      callback(state);
-    }).catch((error) => {
+    self._tokenManager.renewIfRequired().catch((error) => {
       debug(error);
       if (state.attempt < state.maxAttempt) {
         state.retry = true;
@@ -85,8 +83,7 @@ class IAMPlugin extends BasePlugin {
       } else {
         state.abortWithResponse = [ error ]; // return error to client
       }
-      callback(state);
-    });
+    }).finally(() => callback(state));
   }
 
   onResponse(state, response, callback) {