Enable plugins to be required without requirejs and passed to manager…

… as "class" (#59) * WIP Initial test for wrapping modules s.t. they can be used w/o requirejs * WIP Fix plugin manager s.t. it can handle plugin class correctly * MinimalWorkingExample can now be loaded as commonJS
webgme · Mar 8, 2018 · 3703732 · 3703732
1 parent 2485be7
commit 3703732
Show file tree

Hide file tree

Showing 16 changed files with 197 additions and 77 deletions.
diff --git a/src/client/pluginmanager.js b/src/client/pluginmanager.js
@@ -80,7 +80,7 @@ define([
 
         /**
          * Run the plugin in the browser.
-         * @param {string} pluginId - id of plugin.
+         * @param {string|function} pluginIdOrClass - id or class for plugin.
          * @param {object} context
          * @param {object} context.managerConfig - where the plugin should execute.
          * @param {ProjectInterface} context.managerConfig.project - project (e.g. client.getProjectObject()).
@@ -92,7 +92,7 @@ define([
          * @param {object} [context.pluginConfig=%defaultForPlugin%] - specific configuration for the plugin.
          * @param {function(err, PluginResult)} callback
          */
-        this.runBrowserPlugin = function (pluginId, context, callback) {
+        this.runBrowserPlugin = function (pluginIdOrClass, context, callback) {
             var blobClient = new BlobClient({logger: logger.fork('BlobClient')}),
                 pluginManager = new PluginManagerBase(blobClient, null, mainLogger, gmeConfig);
 
@@ -105,12 +105,12 @@ define([
 
             pluginManager.projectAccess = client.getProjectAccess();
 
-            pluginManager.executePlugin(pluginId, context.pluginConfig, context.managerConfig, callback);
+            pluginManager.executePlugin(pluginIdOrClass, context.pluginConfig, context.managerConfig, callback);
         };
 
         /**
          * Run the plugin on the server inside a worker process.
-         * @param {string} pluginId - id of plugin.
+         * @param {string|function} pluginIdOrClass - id or class for plugin.
          * @param {object} context
          * @param {object} context.managerConfig - where the plugin should execute.
          * @param {ProjectInterface|string} context.managerConfig.project - project or id of project.
@@ -122,8 +122,8 @@ define([
          * @param {object} [context.pluginConfig=%defaultForPlugin%] - specific configuration for the plugin.
          * @param {function} callback
          */
-        this.runServerPlugin = function (pluginId, context, callback) {
-
+        this.runServerPlugin = function (pluginIdOrClass, context, callback) {
+            var pluginId = typeof pluginIdOrClass === 'string' ? pluginIdOrClass : pluginIdOrClass.metadata.id;
             if (context.managerConfig.project instanceof Project) {
                 context.managerConfig.project = context.managerConfig.project.projectId;
             }

diff --git a/src/common/Constants.js b/src/common/Constants.js
@@ -4,9 +4,17 @@
 /**
  * STRING CONSTANT DEFINITIONS USED IN BOTH CLIENT AND SERVER JAVASCRIPT
  * @author rkereskenyi / https://github.com/rkereskenyi
+ * @author pmeijer / https://github.com/pmeijer
  */
 
-define(['common/core/constants', 'common/storage/constants'], function (CORE, STORAGE) {
+
+(function (factory) {
+    if (typeof define === 'function' && define.amd) {
+        define(['common/core/constants', 'common/storage/constants'], factory);
+    } else if (typeof module === 'object' && module.exports) {
+        module.exports = factory(require('./core/constants'), require('./storage/constants'));
+    }
+}(function (CORE, STORAGE) {
     'use strict';
     //return string constants
     return {
@@ -110,4 +118,4 @@ define(['common/core/constants', 'common/storage/constants'], function (CORE, ST
         }
 
     };
-});
+}));
diff --git a/src/common/core/constants.js b/src/common/core/constants.js
@@ -3,7 +3,14 @@
 /**
  * @author kecso / https://github.com/kecso
  */
-define([], function () {
+
+(function (factory) {
+    if (typeof define === 'function' && define.amd) {
+        define([], factory);
+    } else if (typeof module === 'object' && module.exports) {
+        module.exports = factory();
+    }
+}(function () {
     'use strict';
     //return string constants
     return {
@@ -78,4 +85,4 @@ define([], function () {
 
         OVERLAY_SHARD_INDICATOR: 'sharded'
     };
-});
+}));
diff --git a/src/common/storage/constants.js b/src/common/storage/constants.js
@@ -64,8 +64,13 @@
  *   patch: [{op: 'add', path: '/atr/new', value: 'value'}]
  * }
  */
-
-define([], function () {
+(function (factory) {
+    if (typeof define === 'function' && define.amd) {
+        define([], factory);
+    } else if (typeof module === 'object' && module.exports) {
+        module.exports = factory();
+    }
+}(function () {
     'use strict';
 
     return {
@@ -140,4 +145,4 @@ define([], function () {
         ADD_ON_NOTIFICATION: 'ADD_ON_NOTIFICATION',
         CLIENT_STATE_NOTIFICATION: 'CLIENT_STATE_NOTIFICATION'
     };
-});
+}));
diff --git a/src/plugin/InterPluginResult.js b/src/plugin/InterPluginResult.js
@@ -6,7 +6,13 @@
  * @author pmeijer / https://github.com/meijer
  */
 
-define(['plugin/PluginResultBase'], function (PluginResultBase) {
+(function (factory) {
+    if (typeof define === 'function' && define.amd) {
+        define(['plugin/PluginResultBase'], factory);
+    } else if (typeof module === 'object' && module.exports) {
+        module.exports = factory(require('./PluginResultBase'));
+    }
+}(function (PluginResultBase) {
     'use strict';
 
     /**
@@ -46,4 +52,4 @@ define(['plugin/PluginResultBase'], function (PluginResultBase) {
     };
 
     return InterPluginResult;
-});
+}));
diff --git a/src/plugin/PluginBase.js b/src/plugin/PluginBase.js
@@ -9,25 +9,41 @@
  * @author pmeijer / https://github.com/pmeijer
  */
 
-define([
-    'q',
-    'plugin/PluginConfig',
-    'plugin/PluginResultBase',
-    'plugin/PluginResult',
-    'plugin/InterPluginResult',
-    'plugin/PluginMessage',
-    'plugin/PluginNodeDescription',
-    'plugin/util',
-    'common/storage/constants'
-], function (Q,
-             PluginConfig,
-             PluginResultBase,
-             PluginResult,
-             InterPluginResult,
-             PluginMessage,
-             PluginNodeDescription,
-             pluginUtil,
-             STORAGE_CONSTANTS) {
+(function (factory) {
+    if (typeof define === 'function' && define.amd) {
+        define([
+            'q',
+            'plugin/PluginConfig',
+            'plugin/PluginResultBase',
+            'plugin/PluginResult',
+            'plugin/InterPluginResult',
+            'plugin/PluginMessage',
+            'plugin/PluginNodeDescription',
+            'plugin/util',
+            'common/storage/constants'
+        ], factory);
+    } else if (typeof module === 'object' && module.exports) {
+        module.exports = factory(
+            require('q'),
+            require('./PluginConfig'),
+            require('./PluginResultBase'),
+            require('./PluginResult'),
+            require('./InterPluginResult'),
+            require('./PluginMessage'),
+            require('./PluginNodeDescription'),
+            require('./util'),
+            require('../common/storage/constants')
+        );
+    }
+}(function (Q,
+            PluginConfig,
+            PluginResultBase,
+            PluginResult,
+            InterPluginResult,
+            PluginMessage,
+            PluginNodeDescription,
+            pluginUtil,
+            STORAGE_CONSTANTS) {
     'use strict';
 
     /**
@@ -890,4 +906,4 @@ define([
     //</editor-fold>
 
     return PluginBase;
-});
+}));
diff --git a/src/plugin/PluginConfig.js b/src/plugin/PluginConfig.js
@@ -5,7 +5,13 @@
  * @author lattmann / https://github.com/lattmann
  */
 
-define([], function () {
+(function (factory) {
+    if (typeof define === 'function' && define.amd) {
+        define([], factory);
+    } else if (typeof module === 'object' && module.exports) {
+        module.exports = factory();
+    }
+}(function () {
     'use strict';
     /**
      * Initializes a new instance of plugin configuration.
@@ -45,4 +51,4 @@ define([], function () {
 
 
     return PluginConfig;
-});
+}));
diff --git a/src/plugin/PluginManagerConfiguration.js b/src/plugin/PluginManagerConfiguration.js
@@ -6,7 +6,13 @@
  */
 
 
-define([], function () {
+(function (factory) {
+    if (typeof define === 'function' && define.amd) {
+        define([], factory);
+    } else if (typeof module === 'object' && module.exports) {
+        module.exports = factory();
+    }
+}(function () {
     'use strict';
     /**
      * Initializes a new instance of plugin manager configuration.
@@ -56,4 +62,4 @@ define([], function () {
     };
 
     return PluginManagerConfiguration;
-});
+}));
diff --git a/src/plugin/PluginMessage.js b/src/plugin/PluginMessage.js
@@ -8,7 +8,13 @@
  */
 
 
-define(['plugin/PluginNodeDescription'], function (PluginNodeDescription) {
+(function (factory) {
+    if (typeof define === 'function' && define.amd) {
+        define(['plugin/PluginNodeDescription'], factory);
+    } else if (typeof module === 'object' && module.exports) {
+        module.exports = factory(require('./PluginNodeDescription'));
+    }
+}(function (PluginNodeDescription) {
     'use strict';
 
     /**
@@ -60,4 +66,4 @@ define(['plugin/PluginNodeDescription'], function (PluginNodeDescription) {
     };
 
     return PluginMessage;
-});
+}));
diff --git a/src/plugin/PluginNodeDescription.js b/src/plugin/PluginNodeDescription.js
@@ -8,7 +8,13 @@
  */
 
 
-define([], function () {
+(function (factory) {
+    if (typeof define === 'function' && define.amd) {
+        define([], factory);
+    } else if (typeof module === 'object' && module.exports) {
+        module.exports = factory();
+    }
+}(function () {
     'use strict';
     /**
      * Initializes a new instance of plugin node description object.
@@ -52,4 +58,4 @@ define([], function () {
     };
 
     return PluginNodeDescription;
-});
+}));
diff --git a/src/plugin/PluginResult.js b/src/plugin/PluginResult.js
@@ -7,7 +7,13 @@
  * @author lattmann / https://github.com/lattmann
  */
 
-define(['plugin/PluginMessage', 'plugin/PluginResultBase'], function (PluginMessage, PluginResultBase) {
+(function (factory) {
+    if (typeof define === 'function' && define.amd) {
+        define(['plugin/PluginMessage', 'plugin/PluginResultBase'], factory);
+    } else if (typeof module === 'object' && module.exports) {
+        module.exports = factory(require('./PluginMessage'), require('./PluginResultBase'));
+    }
+}(function (PluginMessage, PluginResultBase) {
     'use strict';
 
     /**
@@ -188,4 +194,4 @@ define(['plugin/PluginMessage', 'plugin/PluginResultBase'], function (PluginMess
     };
 
     return PluginResult;
-});
+}));
diff --git a/src/plugin/PluginResultBase.js b/src/plugin/PluginResultBase.js
@@ -6,7 +6,13 @@
  * @author pmeijer / https://github.com/meijer
  */
 
-define([], function () {
+(function (factory) {
+    if (typeof define === 'function' && define.amd) {
+        define([], factory);
+    } else if (typeof module === 'object' && module.exports) {
+        module.exports = factory();
+    }
+}(function () {
     'use strict';
 
     /**
@@ -86,4 +92,4 @@ define([], function () {
     };
 
     return PluginResultBase;
-});
+}));
diff --git a/src/plugin/coreplugins/MinimalWorkingExample/MinimalWorkingExample.js b/src/plugin/coreplugins/MinimalWorkingExample/MinimalWorkingExample.js
@@ -7,14 +7,25 @@
  * @module CorePlugins:MinimalWorkingExample
  */
 
-define([
-    'plugin/PluginConfig',
-    'plugin/PluginBase',
-    'text!./metadata.json'
-], function (PluginConfig, PluginBase, pluginMetadata) {
+
+(function (factory) {
+    if (typeof define === 'function' && define.amd) {
+        define([
+            'plugin/PluginConfig',
+            'plugin/PluginBase',
+            'text!./metadata.json'
+        ], factory);
+    } else if (typeof module === 'object' && module.exports) {
+        module.exports = factory(
+            require('../../PluginConfig'),
+            require('../../PluginBase'),
+            require('./metadata.json')
+        );
+    }
+}(function (PluginConfig, PluginBase, pluginMetadata) {
     'use strict';
 
-    pluginMetadata = JSON.parse(pluginMetadata);
+    pluginMetadata = typeof pluginMetadata === 'string' ? JSON.parse(pluginMetadata) : pluginMetadata;
 
     /**
      * Initializes a new instance of MinimalWorkingExample.
@@ -98,4 +109,4 @@ define([
     };
 
     return MinimalWorkingExample;
-});
+}));