Merge pull request #381 from spezifant/master

Development (#1)

Author: smithsz

CHANGES.md

@@ -1,3 +1,6 @@
+# 4.1.2 (2019-07-29)
+- [FIXED] Plugins can now be loaded from outside of the 'plugins/' directory
+
 # 4.1.1 (2019-06-17)
 - [FIXED] Remove unnecessary `npm-cli-login` dependency.
 

lib/client.js

@@ -17,6 +17,7 @@ const async = require('async');
 const concat = require('concat-stream');
 const debug = require('debug')('cloudant:client');
 const EventRelay = require('./eventrelay.js');
+const path = require('path');
 const PassThroughDuplex = require('./passthroughduplex.js');
 const pkg = require('../package.json');
 const utils = require('./clientutils.js');
@@ -101,7 +102,7 @@ class CloudantClient {
           var pluginName = Object.keys(plugin)[0];
 
           try {
-            Plugin = require('../plugins/' + pluginName);
+            Plugin = require(self._buildPluginPath(pluginName));
           } catch (e) {
             throw new Error(`Failed to load plugin - ${e.message}`);
           }
@@ -119,7 +120,7 @@ class CloudantClient {
           }
 
           try {
-            Plugin = require('../plugins/' + plugin);
+            Plugin = require(self._buildPluginPath(plugin));
           } catch (e) {
             throw new Error(`Failed to load plugin - ${e.message}`);
           }
@@ -147,6 +148,21 @@ class CloudantClient {
     });
   }
 
+  _buildPluginPath(name) {
+    // Only a plugin name was provided: use plugin directory
+    if (path.basename(name) === name) {
+      return '../plugins/' + name;
+    }
+
+    // An absolute path was provided
+    if (path.isAbsolute(name)) {
+      return name;
+    }
+
+    // A relative path was provided
+    return path.join(process.cwd(), name);
+  }
+
   _initClient(client) {
     if (typeof client !== 'undefined') {
       debug('Using custom client.');

test/client.js

@@ -18,6 +18,7 @@
 const assert = require('assert');
 const Client = require('../lib/client.js');
 const nock = require('./nock.js');
+const path = require('path');
 const stream = require('stream');
 const testPlugin = require('./fixtures/testplugins.js');
 const uuidv4 = require('uuid/v4'); // random
@@ -86,6 +87,29 @@ describe('CloudantClient', function() {
   });
 
   describe('plugin support', function() {
+    it('get plugin path by name', function() {
+      var cloudantClient = new Client();
+      assert.equal(cloudantClient._buildPluginPath('dummy-plugin'), '../plugins/dummy-plugin');
+    });
+
+    it('get plugin path by relative path', function() {
+      var cloudantClient = new Client();
+      assert.equal(cloudantClient._buildPluginPath('./dummy-plugin'), path.join(process.cwd(), 'dummy-plugin'));
+    });
+
+    it('get plugin path by absolute path', function() {
+      var cloudantClient = new Client();
+      assert.equal(cloudantClient._buildPluginPath('/plugins/dummy-plugin'), '/plugins/dummy-plugin');
+    });
+
+    it('load plugin from custom path', function() {
+      let ownPlugin = 'test/fixtures/testplugin.js';
+      var cloudantClient = new Client({
+        plugins: [ ownPlugin ]
+      });
+      assert.equal(cloudantClient._plugins.length, 1);
+    });
+
     it('adds cookie authentication plugin if no other plugins are specified', function() {
       var cloudantClient = new Client();
       assert.equal(cloudantClient._plugins.length, 1);

test/fixtures/testplugin.js

@@ -0,0 +1,23 @@
+// Copyright © 2017, 2018 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.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+'use strict';
+
+const BasePlugin = require('../../plugins/base.js');
+
+class TestPlugin extends BasePlugin {
+}
+
+TestPlugin.id = 'test';
+
+module.exports = TestPlugin;