Development (#1)

Allow plugins to be loaded from an absolute or relative path

Author: spezifant

CHANGES.md

@@ -1,3 +1,6 @@
+# 4.1.2 (2019-07-29)
+- [NEW] 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');
@@ -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,21 @@ 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('adds cookie authentication plugin if no other plugins are specified', function() {
       var cloudantClient = new Client();
       assert.equal(cloudantClient._plugins.length, 1);