@kumologica/sdk 3.5.4 → 3.6.0-alpha7

package/src/server/DesignerServer.js

@@ -1,10 +1,11 @@
 const {
-    AbstractServerfulServer,
-    ConfigBuilder,
-    PLATFORMS
-} = require('@kumologica/runtime');
-const tcpPortUsed = require('tcp-port-used');
+  AbstractServerfulServer,
+  ConfigBuilder,
+  PLATFORMS,
+} = require("@kumologica/runtime");
+const tcpPortUsed = require("tcp-port-used");
 
+const os = require("os");
 /**
  * This class will encapsulate the adminApp and FlowApp into two servers.
  * It will be the one running on the development box of the user (either local or remote),
@@ -12,155 +13,153 @@ const tcpPortUsed = require('tcp-port-used');
  */
 
 class DesignerServer {
-    
-    /**
-    * @param {Object} options - Configuration options.
-    * @param {string} options.flowPath - The path of the flow.
-    * @param {boolean} options.safe - A boolean indicating safety.
-    * @param {Object} options.cliParams - Command line parameters as an object.
-    * @param {Object} options.editorApi - API object for the editor.
-    * @param {Object} options.startupEmitter - EventEmitter object for handling events.
-    * @param {string} options.platform - The platform to run on. Default LOCAL.
-    */
-    constructor(options) {
-
-        if (!options.flowPath) {
-            console.log(
-                '[ERROR] Flow is not defined. Make sure you pass the flow file to the constructor of FlowBuilder'
-            );
-            os.exit(1);
-        }
-
-        this.editorApi = options.editorApi;
-        this.startupEmitter = options.startupEmitter;
-
-        this.config = ConfigBuilder.getInstance().buildConfig(
-            options.flowPath,
-            options.platform || PLATFORMS.LOCAL,
-            options.cliParams
-        );
-    }
-
-    async start() {
-        // Check if port passed by parameter is available otherwise allocate a new one
-        this.config.port = await this.allocatePort(this.config.port);
-        this.flowServer = new AbstractServerfulServer(this.config, this.editorApi, this.startupEmitter);
-
-        await this.flowServer.start();
-        this.flowServer.log.debug(`Runtime Configuration:${JSON.stringify(this.config, null, 2)}`);
-    }
-
-    async allocatePort(port) {
-        let inUse = await tcpPortUsed.check(port);
-        if (inUse){
-            let newPort = port + 1;
-            console.log(`> Port: ${port} in use. Trying with port: ${newPort}...`);
-            return await this.allocatePort(newPort);
-        } else{
-            return port;
-        }
-    }
-
-    getFlowServer() {
-        return this.flowServer;
-    }
-
-    getListeningPort() {
-        return this.flowServer.serverSettings.port;
-    }
-
-    async stop() {
-        await this.flowServer.stop();
-    }
-
-    /**
-     * The express application for HTTP Nodes
-     */
-     get httpNode() {
-        return this.flowServer.httpNode.expressApp;
-    }
-
-
-
-    /**
-     * Pointer to the internal HTTP Server upon which all the express applications (Nodes and Admin) are deployed upon
-     *
-     * @readonly
-     */
-    get server() {
-        return this.flowServer.server;
-    }
-
-    /**
-     * Access to internal runtime api
-     */
-    get runtime() {
-        return this.flowServer.runtime;
-    }
-
-
-
-    /**
-     *
-     * Returns the version of the runtime lib used internally
-     * @readonly
-     * @static
-     */
-    static get version() {
-        return AbstractServerfulServer.version;
-    }
-
-    /**
-     * This provides access to the internal settings module of the
-     * runtime.
-     * This is the object derived from the server settings.
-     */
-    get settings() {
-        return this.flowServer._.settings;
-    }
-
-    /**
-     * EventEmitter use to publish and subscribe to internal runtime events
-     * For example:
-     *  runtime.events.on(
-     *     'runtime-event',
-     *     (flowStarted = async data => {
-     *       if (data.id === 'flow-started') {
-     *         runtime.events.removeListener('runtime-event', flowStarted);
-     *
-     * @readonly
-     */
-    get events() {
-        return this.flowServer.events;
-    }
-
-    get eventTypes() {
-        return this.flowServer.runtimeEventTypes;
-    }
-
-    /**
-     * This provides access to the internal nodes module of the
-     * runtime. The details of this API remain undocumented as they should not
-     * be used directly.
-     *
-     * Most administrative actions should be performed use the runtime api
-     * under [node.runtime]
-     */
-    get nodes() {
-        return this.flowServer._.nodes;
-    }
-
-    get log() {
-        return this.flowServer.log;
-    }
-
-    get util() {
-        return this.flowServer.util;
-    }
-
-
+  /**
+   * @param {Object} options - Configuration options.
+   * @param {string} options.flowPath - The path of the flow.
+   * @param {boolean} options.safe - A boolean indicating safety.
+   * @param {Object} options.cliParams - Command line parameters as an object.
+   * @param {Object} options.editorApi - API object for the editor.
+   * @param {Object} options.startupEmitter - EventEmitter object for handling events.
+   * @param {string} options.platform - The platform to run on. Default LOCAL.
+   */
+  constructor(options) {
+    if (!options.flowPath) {
+      console.log(
+        "[ERROR] Flow is not defined. Make sure you pass the flow file to the constructor of FlowBuilder"
+      );
+      os.exit(1);
+    }
+
+    this.editorApi = options.editorApi;
+    this.startupEmitter = options.startupEmitter;
+
+    this.config = ConfigBuilder.getInstance().buildConfig(
+      options.flowPath,
+      options.platform || PLATFORMS.LOCAL,
+      options.cliParams
+    );
+  }
+
+  async start() {
+    // Check if port passed by parameter is available otherwise allocate a new one
+    this.config.port = await this.allocatePort(this.config.port);
+    this.flowServer = new AbstractServerfulServer(
+      this.config,
+      this.editorApi,
+      this.startupEmitter
+    );
+
+    await this.flowServer.start();
+    this.flowServer.log.debug(
+      `Runtime Configuration:${JSON.stringify(this.config, null, 2)}`
+    );
+  }
+
+  async allocatePort(port) {
+    let inUse = await tcpPortUsed.check(port);
+    if (inUse) {
+      let newPort = port + 1;
+      console.log(`> Port: ${port} in use. Trying with port: ${newPort}...`);
+      return await this.allocatePort(newPort);
+    } else {
+      return port;
+    }
+  }
+
+  getFlowServer() {
+    return this.flowServer;
+  }
+
+  getListeningPort() {
+    return this.flowServer.serverSettings.port;
+  }
+
+  async stop() {
+    await this.flowServer.stop();
+  }
+
+  /**
+   * The express application for HTTP Nodes
+   */
+  get httpNode() {
+    return this.flowServer.httpNode.expressApp;
+  }
+
+  /**
+   * Pointer to the internal HTTP Server upon which all the express applications (Nodes and Admin) are deployed upon
+   *
+   * @readonly
+   */
+  get server() {
+    return this.flowServer.server;
+  }
+
+  /**
+   * Access to internal runtime api
+   */
+  get runtime() {
+    return this.flowServer.runtime;
+  }
+
+  /**
+   *
+   * Returns the version of the runtime lib used internally
+   * @readonly
+   * @static
+   */
+  static get version() {
+    return AbstractServerfulServer.version;
+  }
+
+  /**
+   * This provides access to the internal settings module of the
+   * runtime.
+   * This is the object derived from the server settings.
+   */
+  get settings() {
+    return this.flowServer._.settings;
+  }
+
+  /**
+   * EventEmitter use to publish and subscribe to internal runtime events
+   * For example:
+   *  runtime.events.on(
+   *     'runtime-event',
+   *     (flowStarted = async data => {
+   *       if (data.id === 'flow-started') {
+   *         runtime.events.removeListener('runtime-event', flowStarted);
+   *
+   * @readonly
+   */
+  get events() {
+    return this.flowServer.events;
+  }
+
+  get eventTypes() {
+    return this.flowServer.runtimeEventTypes;
+  }
+
+  /**
+   * This provides access to the internal nodes module of the
+   * runtime. The details of this API remain undocumented as they should not
+   * be used directly.
+   *
+   * Most administrative actions should be performed use the runtime api
+   * under [node.runtime]
+   */
+  get nodes() {
+    return this.flowServer._.nodes;
+  }
+
+  get log() {
+    return this.flowServer.log;
+  }
+
+  get util() {
+    return this.flowServer.util;
+  }
 }
 
 module.exports = {
-    DesignerServer,
+  DesignerServer,
 };