@kumologica/sdk 3.0.11 → 3.0.12

package/cli/commands/build-commands/kumohub.js

@@ -1,7 +1,49 @@
-exports.command = 'kumohub '
-exports.desc = 'Build kumohub artefacrs remote named <name> for repo at url <url>'
-exports.builder = {}
+exports.command = 'kumohub';
+exports.desc = `Builds kumohub binaries: 
+* generates kumohub artefacts
+* runs npm install
+* creates zip file
+
+Documentation: 
+  https://docs.kumologica.com/docs/references/cli/BuildKumohub.html`;
+
+exports.builder = {
+	"flow-file-name": {
+		describe: "The name of kumologica flow file.\n Auto search if not provided.\n ",
+		type: 'string',
+		alias: 'f',
+		nargs: 1
+	},
+	"project-directory": {
+		describe: "The root directory of project.\n Current working directory if not provided.\n",
+		type: 'string',
+		alias: 'd',
+		nargs: 1
+	},
+	"zip-file-name": {
+		describe: "The name of zip file to be created",
+		type: 'string',
+		default: 'lambda.zip',
+		alias: 'z',
+		nargs: 1
+	}
+}
+		
+function display(argv) {
+	console.log(`\nBuilding kumohub artefacts with following parameters: \n`);
+	console.log('project-directory: %s', argv["project-directory"]||'');
+	console.log('flow-file-name:    %s', argv["flow-file-name"]||'');
+  console.log('zip-file-name:     %s', argv["zip-file-name"]||'');
+}
 
 exports.handler = function (argv) {
-  console.log('adding remote %s at url %s', argv.name, argv.url)
+	display(argv);
+
+	try {
+		const { build } = require('@kumologica/builder');
+		build('kumohub', argv);
+	} catch (e) {
+		console.log(`${e.message}`);
+		process.exit(1);
+	}
 }

package/package.json

@@ -3,7 +3,7 @@
   "productName": "Kumologica Designer",
   "copyright": "Copyright 2020 Kumologica Pty Ltd, All Rights Reserved.",
   "author": "Kumologica Pty Ltd <contact@kumologica.com>",
-  "version": "3.0.11",
+  "version": "3.0.12",
   "description": "Kumologica Designer, harnessing Serverless for your cloud integration needs",
   "main": "src/app/main.js",
   "files": [
@@ -64,9 +64,10 @@
   },
   "license": "Proprietary",
   "dependencies": {
-    "@kumologica/builder": "3.0.11",
-    "@kumologica/runtime": "3.0.11",
-    "@kumologica/devkit": "3.0.11",
+    "@electron/remote": "^2.0.8",
+    "@kumologica/builder": "3.0.12",
+    "@kumologica/devkit": "3.0.12",
+    "@kumologica/runtime": "3.0.12",
     "adm-zip": "0.4.13",
     "ajv": "8.10.0",
     "aws-sdk": "2.513.0",
@@ -112,6 +113,7 @@
     "simplemde": "1.11.2",
     "smoketail": "0.2.2",
     "socket.io": "2.3.0",
+    "tcp-port-used": "1.0.2",
     "util": "0.12.1",
     "when": "3.7.8",
     "ws": "7.1.1",

package/src/app/lib/stores/settings-cloud-store.js

@@ -1,30 +1,33 @@
 // properties: ~/.kumologica/credentials
 
-const defaultContent = `// This file contains all your sensitive credential information
-// about your cloud connections used by Kumologica Designer.
-// For more information visit  https://docs.kumologica.com/settings
-//
-// Azure with terraform:
-// using a Service Principal with a Client Secret follow:
-// https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/guides/service_principal_client_secret
-
-// Examples:
-//
-// [kumohub.default]
-// username = your-username
-// password = your-password
-// subscription = kumohub-subscription-id
-
-// [aws.development]
-// profile = your-defined-aws-profile
-
-// 
-// [azure.default]
-// subscription_id = 00000000-0000-0000-0000-000000000000
-// client_id = 00000000-0000-0000-0000-000000000000
-// client_secret = 0000000000000000000000000000000
-// tenant_id = 00000000-0000-0000-0000-000000000000
-//
+const defaultContent = `; This file contains all your sensitive credential information
+; about your cloud connections used by Kumologica Designer.
+; For more information visit  https://docs.kumologica.com/settings
+;
+; Examples:
+
+; =============== Kumohub Details =======================
+; Follow the format for this section as: "kumohub.<alias>"
+; =======================================================
+; [kumohub.default]
+; username = your-username
+; password = your-password
+; subscription = kumohub-subscription-id
+
+; ============= AWS Cloud Details =======================
+; Follow the format for this section as: "aws.<alias>"
+; =======================================================
+; [aws.development]
+; profile = your-defined-aws-profile
+
+; ============= Azure Cloud Details =====================
+; Follow the format for this section as: "azure.<alias>"
+; =======================================================
+; [azure.default]
+; subscription_id = 00000000-0000-0000-0000-000000000000
+; client_id = 00000000-0000-0000-0000-000000000000
+; client_secret = 0000000000000000000000000000000
+; tenant_id = 00000000-0000-0000-0000-000000000000
 `
 
 const os = require('os');

package/src/app/lib/stores/settings-network-store.js

@@ -94,7 +94,6 @@ class NetworkConfigStore {
 
     getProxyDetails() {
         let config = this.parseConfigFile();
-        console.log('[settings-network-store] config=', config);
 
         // Make sure the section is present
         if (!config.proxy){

package/src/app/lib/stores/test-config-store.js

@@ -1,26 +1,159 @@
-// properties
-const defaultKeys = {
-    test: {}
-  };
+const {
+  getVariablesByConfigAndSection,
+  getSectionsByText
+} = require('./util/iniParser');
+
+const NO_ENVIRONMENT = "__no_environment__";
+
+const KEYS = {
+  ROOT_KEY: "test",
+  ENVIRONMENTS: "environments",
+  TESTCASE_OLD: "test",
+  PROPERTIES_OLD: "properties",
+  TESTCASE: "testcase",
+  ENVIRONMENT: "environment"
+}
+
+const DEFAULT_ENVIRONMENTS = [
+  "; ===========================================================",
+  "; Environment variables must be defined under one section",
+  "; You can define as many sections as you need.",
+  "; (Remove the semicolons to uncomment the lines)",
+  "; ===========================================================",
+  "",
+  "; Example:",
+  "",
+  "; [development] ",
+  "; KUMOLOGICA_LOGLEVEL=DEBUG",
+  "; VAR_1=VALUE_1",
+  "",
+  "; [test]",
+  "; KUMOLOGICA_LOGLEVEL=ERROR",
+  "; VAR_1=VALUE_1",
+]
   
-  const Store = require('./store');
-  
-  class TestConfigStore extends Store {
-  
-    constructor(defaults) {
-      super({ ...defaults, configName: '.kumologica/test-config', defaults: {}});
+const Store = require('./store');
+
+class TestConfigStore extends Store {
+
+  constructor(defaults) {
+    super({ ...defaults, configName: '.kumologica/test-config', defaults: {}});
+  }
+
+  getConfigFileFullPath() {
+    return this.path;
+  }
+
+  getTestConfig() {
+    let config = super.get(KEYS.ROOT_KEY);
+
+    // Decorate with default environments if not persisted
+    config = this.convertToLatestVersion(config);
+   
+    // check whether is first time, i.e. config is empty
+    if (!config) {
+      config = {};
+      config[KEYS.TESTCASE] = "__runAll";
+      config[KEYS.ENVIRONMENT] = NO_ENVIRONMENT;
+      config[KEYS.ENVIRONMENTS] = DEFAULT_ENVIRONMENTS;
+      super.set(KEYS.ROOT_KEY, config);
     }
-  
-    getTestConfig() {
-      return super.get('test');
+
+    return config;
+  }
+
+  convertToLatestVersion(config) {
+    let newConfig = config;
+    if (newConfig){
+      if (newConfig.hasOwnProperty(KEYS.TESTCASE_OLD)){
+        // replace: "config.test" -> "config.testcase"
+        newConfig[KEYS.TESTCASE] = newConfig[KEYS.TESTCASE_OLD]; 
+        delete newConfig[KEYS.TESTCASE_OLD];
+        // select "config.environment" = no_environment
+        newConfig[KEYS.ENVIRONMENT] = NO_ENVIRONMENT;
+        // append the old properties to the new environment
+        newConfig[KEYS.ENVIRONMENTS] = DEFAULT_ENVIRONMENTS;
+        if (newConfig.hasOwnProperty(KEYS.PROPERTIES_OLD)){
+          let props = newConfig[KEYS.PROPERTIES_OLD];
+          newConfig[KEYS.ENVIRONMENTS].push('[old-properties]');
+          for (const [key, value] of Object.entries(props)) {
+            newConfig[KEYS.ENVIRONMENTS].push(`${key}=${value}`);
+          }
+          delete newConfig[KEYS.PROPERTIES_OLD];
+          // persist the new model
+          super.set(KEYS.ROOT_KEY, newConfig);
+        }
+      }
     }
-  
-    setTestConfig(value) {
-      super.set('test', value);
+    return newConfig;
+  }
+
+  saveTestValuesIntoConfig(value) {
+    let config = this.getTestConfig();
+    config[KEYS.ENVIRONMENT] = this.listEnvironments().includes(value[KEYS.ENVIRONMENT])?value[KEYS.ENVIRONMENT]: NO_ENVIRONMENT;
+    config[KEYS.TESTCASE] = value[KEYS.TESTCASE];
+    super.set(KEYS.ROOT_KEY, config);
+  }
+
+  saveEnvironmentSectionIntoConfig(text) {
+    let config = this.getTestConfig();
+    config[KEYS.ENVIRONMENTS] = this.convertTextIntoArray(text);
+    super.set(KEYS.ROOT_KEY, config);
+    // If selected environment is not longer available, lets default it to no_environment
+    if (!this.listEnvironments().includes(config[KEYS.ENVIRONMENT])) {
+      config[KEYS.ENVIRONMENTS] = this.convertTextIntoArray(text);
+      config[KEYS.ENVIRONMENT] = NO_ENVIRONMENT;
+      super.set(KEYS.ROOT_KEY, config);
     }
   }
   
-  module.exports = {
-    TestConfigStore
-  };
+  getEnvironmentSectionFromConfig() {
+    return this.convertArrayIntoText(this.getTestConfig()[KEYS.ENVIRONMENTS]);
+  }
+
+  getLatestSelectedEnvironment() {
+    let config = this.getTestConfig();
+    return (config.hasOwnProperty(KEYS.ENVIRONMENT))? config[KEYS.ENVIRONMENT]: NO_ENVIRONMENT;
+  }
+
+  getLatestSelectedTestCase() {
+    let config = this.getTestConfig();
+    if (config){
+      if (config.hasOwnProperty(KEYS.TESTCASE)) {
+        return config[KEYS.TESTCASE];
+      } else if (config.hasOwnProperty(KEYS.TESTCASE_OLD)) {
+        return config[KEYS.TESTCASE_OLD];
+      } else {
+        return null;
+      }
+    }
+   
+  }
+
+  listEnvironments() {
+    let enviromentAsText = this.convertArrayIntoText(this.getTestConfig()[KEYS.ENVIRONMENTS])
+    return getSectionsByText(enviromentAsText);
+  }
+
+  listVariablesByEnvironment(section) {
+    let environmentSelected = section;
+    if (!environmentSelected) {
+      environmentSelected = this.getLatestSelectedEnvironment();
+    }
+    let aEnvironments = this.getTestConfig()[KEYS.ENVIRONMENTS];
+    return getVariablesByConfigAndSection(this.convertArrayIntoText(aEnvironments), environmentSelected);
+  }
+
+  convertTextIntoArray(text){
+    let lines = text.split(/\r\n|\n/);
+    return lines.map(l => l.trim());
+  }
+  convertArrayIntoText(lines) {
+    return lines.join('\r\n');
+  }
+}
+
+module.exports = {
+  TestConfigStore
+};
   

package/src/app/lib/stores/util/iniParser.js

@@ -0,0 +1,46 @@
+const ini = require('ini');
+
+function parseStringToConfig(text) {
+    let config = ini.parse(text);
+    return config;
+}
+
+function getSectionsByText(text) {
+    let config = parseStringToConfig(text);
+    let keys = [];
+    if (config) {
+        keys = Object.keys(config);
+        keys= keys.filter(section => isValidSection(section, config))
+    }
+    return keys;
+}
+function getVariablesByConfigAndSection(environmentsAsText, section){
+    let oEnvironments = parseStringToConfig(environmentsAsText);
+    let variables = [];
+
+    if (oEnvironments){
+        if (oEnvironments[section]){
+            for (const [key, value] of Object.entries(oEnvironments[section])) {
+                variables.push({ key, value })
+            }
+        }
+    }
+    
+   
+    return variables;
+}
+
+function isValidSection(section, config) {
+    return (
+            section !== '__no_environment__' && 
+            !section.trim().startsWith('//') &&
+            !section.trim().startsWith('#') && 
+            typeof config[section] == 'object' && Object.entries(config[section]).length > 0
+    ); 
+}
+
+module.exports = {
+    parseStringToConfig,
+    getSectionsByText,
+    getVariablesByConfigAndSection
+}

package/src/app/lib/stores/util/iniParser.spec.js

@@ -0,0 +1,72 @@
+
+const chai = require('chai');
+const { 
+    parseStringToConfig,
+    getSectionsByText,
+    getVariablesByConfigAndSection } = require('./iniParser');
+
+let assert = chai.assert;
+
+const ENVIRONMENTS_WITH_COMMENTS = `
+// comment
+; hola amigos
+; this is comments
+[dev]
+url=http://dev.good.url.com
+private=false
+[test]
+url=http://test.good.url.com
+private=true
+`;
+const ENVIRONMENTS_WITHOUT_SECTIONS = ``; 
+
+const ENVIRONMENTS_WRONG_FORMAT = `
+// comment
+; hola amigos
+; this is comments
+[dev]
+url
+private = false
+USER == test123
+password=asdfa salutation=hello
+`;
+
+const ENVIRONMENTS_MISSING_SECTION = `
+// comment
+; hola amigos
+; this is comments
+;;[dev]
+url = true
+
+[test]
+url = hola
+
+`;
+
+describe('parse correctly a environment section', () => {
+    it('happy path', () => {
+        let config = parseStringToConfig(ENVIRONMENTS_WITH_COMMENTS)
+        let sections = getSectionsByText(ENVIRONMENTS_WITH_COMMENTS);
+        assert.equal(sections.length, 2);
+
+        let vars = getVariablesByConfigAndSection(config, sections[0]);
+        assert.equal(vars.length, 2);        
+    });
+    it('No sections available', () => {
+        let sections = getSectionsByText(ENVIRONMENTS_WITHOUT_SECTIONS);
+        assert.equal(sections.length, 0);
+    });
+    it('Variables not correct', () => {
+        let config = parseStringToConfig(ENVIRONMENTS_WRONG_FORMAT)
+        let sections = getSectionsByText(ENVIRONMENTS_WRONG_FORMAT);
+        let vars = getVariablesByConfigAndSection(config, sections[0]);
+        assert.equal(vars.length, 4); 
+    })
+    it('Detecting missing sections', () => {
+        let sections = getSectionsByText(ENVIRONMENTS_MISSING_SECTION);
+        console.log(sections);
+        //let vars = getVariablesByConfigAndSection(config, sections[0]);
+        //assert.equal(vars.length, 4); 
+    })
+    
+  });

package/src/app/main-process/{runtime-manager.js → editor-manager.js}

@@ -1,17 +1,39 @@
 const path = require('path');
 const fs = require('fs-extra');
-const { dialog } = require('electron')
+const { dialog } = require('electron');
+const tcpPortUsed = require('tcp-port-used');
 const { findAllFlowFiles } = require('../lib/utils/editor');
 
 const editorApi = require('../ui/editor-api/lib');
 const { AppServer } = require('../lib/runtime-loader');
 
 
-class RuntimeManager {
+async function allocatePort(port) {
+    let inUse = await tcpPortUsed.check(port);
+    if (inUse){
+      let newPort = ++port;
+      console.log(`> Port: ${port} in use. Trying with port: ${newPort}...`);
+      return await allocatePort(newPort);
+    } else{
+      return port;
+    }
+    
+}
+
+class EditorManagerClass {
   currentUserProjectDir = null;
   previousUserProjectDir = null;
   appServer = null;
+  port = 1880;
+
+  constructor() {
+    this.start = this.start.bind(this);
+    this.readEnv = this.readEnv.bind(this);
+    this.getPort = this.getPort.bind(this);
+    this.setPort = this.setPort.bind(this);
+    this.stop = this.stop.bind(this);
 
+  }
   async start(userProjectDir, startupEmitter) {
     // *** Hack:
     // Do not start a new appServer if the project is the current one already running
@@ -34,6 +56,10 @@ class RuntimeManager {
       if (this.appServer !== null) {
         await this.appServer.stop();
       }
+      // Check ports availability
+      let portAllocated = await allocatePort(this.getPort());
+      this.setPort(portAllocated);
+      console.log(`> Starting editor on port: ${this.getPort()}...`);
 
       // Backwards compatibility check
       const constParams = AppServer.length;
@@ -41,7 +67,7 @@ class RuntimeManager {
         // Runtime <= 2.0.11
         this.appServer = new AppServer(
           flowFilePath, // full path of the flow.json file
-          undefined, // port
+          this.getPort(), // port
           AppServer.mode.HEADFUL_DEFAULT_EXPRESS,
           undefined, //loglevel
           editorApi,
@@ -50,7 +76,7 @@ class RuntimeManager {
         this.appServer = new AppServer({
             projectDir: this.currentUserProjectDir,
             flowFilePath: flowFilePath,
-            port: undefined,
+            port: this.getPort(),
             serverMode: AppServer.mode.HEADFUL_DEFAULT_EXPRESS,
             logLevel: undefined,
             editorApi: editorApi,
@@ -59,11 +85,13 @@ class RuntimeManager {
       } else {
         throw new Error('Runtime version is incompatible with this designer');
       }
-      
+
+      // Persist the server settings in the window global scope for the ui to access.
       await this.appServer.start();
       return flowFilePath;
     } catch (err) {
-      throw err;
+        console.log('Editor Manager cannot be started. Reason:', err.code);
+        throw err;
     }
   }
 
@@ -82,6 +110,14 @@ class RuntimeManager {
     return undefined;
   }
 
+  getPort() {
+    return this.port;
+  }
+
+  setPort(newPort) {
+    this.port = newPort;
+  }
+
   /**
    * Originally after promise is resolved it invoked `process.exit()`
    * @returns a promise
@@ -119,7 +155,6 @@ class RuntimeManager {
           properties: ['openFile'] 
         });
         if (flowFile){
-          console.log('[runtime-manager] flowFile = ', flowFile);
           return flowFile[0];
         } else {
           throw new Error('A valid flow file must be selected')
@@ -137,5 +172,6 @@ class RuntimeManager {
   }
   // onClose(fn) {
 }
+const editorManager = new EditorManagerClass();
 
-module.exports = RuntimeManager;
+module.exports = editorManager;

package/src/app/main-process/main-window.js

@@ -5,6 +5,7 @@ const url = require('url');
 const { defaultKeys } = require('../lib/stores/user-preference-store');
 const { BrowserWindow } = electron;
 const EventEmitter = require('events');
+
 let { ipcMain } = electron;
 
 // using electron-updater instead of builtin autoUpdater
@@ -12,6 +13,7 @@ let { ipcMain } = electron;
 const { autoUpdater } = require('electron-updater');
 
 const preloadJsPath = path.join(__dirname, '..', 'preload.js');
+const editorManager = require('./editor-manager');
 
 class MainWindow {
   window = null;
@@ -42,7 +44,9 @@ class MainWindow {
       webPreferences: {
         nodeIntegration: false,
         preload: preloadJsPath,
-        contextIsolation: false
+        contextIsolation: false,
+        enableRemoteModule: true,
+        additionalArguments: [`--port=${editorManager.getPort()}`]
       },
       show: false,
       icon: path.join(__dirname, '../ui/editor-client/src/kumologica-app.png'),
@@ -120,7 +124,7 @@ class MainWindow {
   load() {
     this.window.loadURL(
       url.format({
-        pathname: '127.0.0.1:1880',
+        pathname: `127.0.0.1:${editorManager.getPort()}`,
         protocol: 'http:',
         slashes: true,
       }),

package/src/app/main-process/modal-home.js

@@ -3,6 +3,8 @@ const path = require('path');
 const url = require('url');
 const EventEmitter = require('events');
 const dependencies = require('../lib/dependencies.js');
+const editorManager = require('./editor-manager');
+const PORT = editorManager.getPort();
 
 const { BrowserWindow } = electron;
 const preloadJsPath = path.join(__dirname, '..', 'preload.js');
@@ -30,7 +32,9 @@ class ModalHome {
       webPreferences: {
         nodeIntegration: false,
         preload: preloadJsPath,
-        contextIsolation: false
+        contextIsolation: false,
+        enableRemoteModule: true,
+        additionalArguments: [`--port=${PORT}`]
       },
       show: false
     };
@@ -79,7 +83,7 @@ class ModalHome {
   load() {
     this.window.loadURL(
       url.format({
-        pathname: '127.0.0.1:1880/__home',
+        pathname: `127.0.0.1:${PORT}/__home`,
         protocol: 'http:',
         slashes: true
       }),

package/src/app/main-process/modal-newproject.js

@@ -3,6 +3,8 @@ const path = require('path');
 const url = require('url');
 const { BrowserWindow } = electron;
 const preloadJsPath = path.join(__dirname, '..', 'preload.js');
+const editorManager = require('./editor-manager');
+const PORT = editorManager.getPort();
 
 class ModalNewProject {
   // Properties
@@ -26,12 +28,14 @@ class ModalNewProject {
         nodeIntegration: false,
         preload: preloadJsPath,
         enableRemoteModule: true,
-        contextIsolation: false
+        contextIsolation: false,
+        additionalArguments: [`--port=${PORT}`]
       },
       show: false,
     };
 
     this.window = new BrowserWindow(windowOptions);
+    require("@electron/remote/main").enable(this.window.webContents);
     // this.window.webContents.openDevTools(); 
 
     this.window.on('focus', () => this.window.webContents.send('focus'));
@@ -56,7 +60,7 @@ class ModalNewProject {
   load() {
     this.window.loadURL(
       url.format({
-        pathname: '127.0.0.1:1880/__newProject',
+        pathname: `127.0.0.1:${PORT}/__newProject`,
         protocol: 'http:',
         slashes: true,
       }),