Fix plugin configuration when instantiating a new client using VCAP

Author: smithsz

CHANGES.md

@@ -1,3 +1,6 @@
+# UNRELEASED
+- [FIXED] Don't override `plugins` array when instantiating a new client using VCAP.
+
 # 2.4.0 (2018-09-19)
 - [FIXED] Case where `username` and `password` options were not used if a `url` was supplied.
 - [FIXED] Case where `vcapServices` was supplied with a basic-auth `url`.

lib/client.js

@@ -45,14 +45,19 @@ class CloudantClient {
     self._usePromises = false;
     self.useLegacyPlugin = false;
 
-    // build plugin array
+    // Build plugin array.
     var plugins = [];
-    // If IAM key found in VCAP, add IAM plugin
+
     if (self._cfg.creds && self._cfg.creds.iamApiKey) {
-      plugins.push({ iamauth: { iamApiKey: self._cfg.creds.iamApiKey } });
-    } else if (typeof this._cfg.plugin === 'undefined' && typeof this._cfg.plugins === 'undefined') {
-      plugins = [ 'cookieauth' ]; // default
-    } else {
+      // => Found IAM API key in VCAP - Add 'iamauth' plugin.
+      plugins = [ { iamauth: { iamApiKey: self._cfg.creds.iamApiKey } } ];
+    } else if (typeof this._cfg.plugins === 'undefined') {
+      // => No plugins specified - Add 'cookieauth' plugin.
+      plugins = [ 'cookieauth' ];
+    }
+
+    // Add user specified plugins.
+    if (typeof this._cfg.plugins !== 'undefined') {
       [].concat(self._cfg.plugins).forEach(function(plugin) {
         if (typeof plugin !== 'function' || plugin.pluginVersion >= 2) {
           plugins.push(plugin);

test/plugins/iamauth.js

@@ -17,6 +17,7 @@
 
 const assert = require('assert');
 const Client = require('../../lib/client.js');
+const Cloudant = require('../../cloudant.js');
 const nock = require('../nock.js');
 const uuidv4 = require('uuid/v4'); // random
 
@@ -477,4 +478,39 @@ describe('#db IAMAuth Plugin', function() {
       'did not throw with expected message'
     );
   });
+
+  it('supports using vcap with the promise plugin', function(done) {
+    // NOTE: Use NOCK_OFF=true to test using a real CouchDB instance.
+    var iamMocks = nock(TOKEN_SERVER)
+      .post('/identity/token', {
+        'grant_type': 'urn:ibm:params:oauth:grant-type:apikey',
+        'response_type': 'cloud_iam',
+        'apikey': IAM_API_KEY
+      })
+      .reply(200, MOCK_IAM_TOKEN_RESPONSE);
+
+    var cloudantMocks = nock(SERVER)
+      .post('/_iam_session', {access_token: MOCK_ACCESS_TOKEN})
+      .reply(200, {ok: true}, MOCK_SET_IAM_SESSION_HEADER)
+      .get(DBNAME)
+      .reply(200, {doc_count: 0});
+
+    var cloudant = new Cloudant({
+      vcapServices: {
+        cloudantNoSQLDB: [
+          { credentials: { apikey: IAM_API_KEY, host: `${ME}.cloudant.com` } }
+        ]
+      },
+      plugins: 'promises'
+    });
+
+    cloudant.use(DBNAME.substring(1)).info().then((data) => {
+      assert.equal(data.doc_count, 0);
+      iamMocks.done();
+      cloudantMocks.done();
+      done();
+    }).catch(function(err) {
+      assert.fail(`Unexpected reject: ${err}`);
+    });
+  });
 });