Merge pull request #390 from cloudant/389-fix-for-webpack

Include all built-in plugin modules in webpack bundle.

Author: smithsz

CHANGES.md

@@ -1,3 +1,6 @@
+# UNRELEASED
+- [FIXED] Include all built-in plugin modules in webpack bundle.
+
 # 4.2.0 (2019-08-27)
 - [NEW] Added option to set new IAM API key.
 - [FIXED] Allow plugins to be loaded from outside the 'plugins/' directory.

lib/client.js

@@ -100,12 +100,7 @@ class CloudantClient {
           }
 
           var pluginName = Object.keys(plugin)[0];
-
-          try {
-            Plugin = require(self._buildPluginPath(pluginName));
-          } catch (e) {
-            throw new Error(`Failed to load plugin - ${e.message}`);
-          }
+          Plugin = self._importPlugin(pluginName);
 
           cfg = plugin[pluginName];
           if (typeof cfg !== 'object' || Array.isArray(cfg)) {
@@ -119,12 +114,7 @@ class CloudantClient {
             return; // noop
           }
 
-          try {
-            Plugin = require(self._buildPluginPath(plugin));
-          } catch (e) {
-            throw new Error(`Failed to load plugin - ${e.message}`);
-          }
-
+          Plugin = self._importPlugin(plugin);
           cfg = {};
           break;
 
@@ -163,6 +153,30 @@ class CloudantClient {
     return path.join(process.cwd(), name);
   }
 
+  _importPlugin(pluginName) {
+    switch (pluginName) {
+      // Note: All built-in plugins are individually listed here to ensure they
+      //       are included in a webpack bundle.
+      case 'cookieauth':
+        return require('../plugins/cookieauth');
+      case 'iamauth':
+        return require('../plugins/iamauth');
+      case 'retry':
+        return require('../plugins/retry');
+      default:
+        // Warning: Custom plugins will not be included in a webpack bundle
+        //          by default because the exact module is not known on compile
+        //          time.
+        try {
+          // Use template literal to suppress 'dependency is an expression'
+          // webpack compilation warning.
+          return require(`${this._buildPluginPath(pluginName)}`);
+        } catch (e) {
+          throw new Error(`Failed to load plugin - ${e.message}`);
+        }
+    }
+  }
+
   _initClient(client) {
     if (typeof client !== 'undefined') {
       debug('Using custom client.');