@kumologica/sdk 3.5.4 → 3.6.0-alpha7

package/cli/cli.js

@@ -1,9 +1,32 @@
-const chalk = require('chalk');
+const { logError } = require("./utils/logger"); //("../utils/logger");
 
-require('yargs/yargs')(process.argv.slice(2))
-  .commandDir('commands')
-  .demandCommand()
-  .help('help', 'Show usage information & exit')
-  .alias('help', 'h')
- // .epilog("copyright 2021")
-  .argv
+const validCommands = [
+  "build",
+  "create-node",
+  "create",
+  "doc",
+  "export",
+  "list-templates",
+  "login",
+  "open",
+  "serve",
+  "run",
+  "test",
+];
+
+require("yargs/yargs")(process.argv.slice(2))
+  .commandDir("commands")
+  .demandCommand(1, "Error: Command missing.")
+  .check((argv) => {
+    if (!validCommands.includes(argv._[0].toLowerCase())) {
+      throw new Error(`Unknown command: ${argv._[0]}. `);
+    }
+    return true;
+  })
+  .help("help", "Show usage information & exit")
+  .alias("help", "h")
+  .fail((msg, err, yargs) => {
+    logError(msg);
+    yargs.showHelp();
+    process.exit(1);
+  }).argv;

package/cli/commands/open.js

@@ -1,9 +1,38 @@
 const path = require('path');
 const { spawn } = require("child_process");
 const { Updater } = require('@kumologica/builder');
+const { confirm } = require('enquirer');
 
 const { logError } = require('../utils/logger');
-const rootPath = path.join(__dirname, '..', '..',);
+const rootPath = path.join(__dirname, '..', '..', '..', '..');
+
+function displayTable(data) {
+    if (!data.length) {
+        return;
+    }
+
+    // Get the keys (property names) from the first row
+    const keys = Object.keys(data[0]);
+
+    // Get the maximum width for each column
+    const colWidths = keys.map(key =>
+        Math.max(...data.map(row => row[key].length), key.length) // Include header (key) length
+    );
+
+    // Display the headers (property names)
+    const headerRow = keys
+        .map((key, i) => key.padEnd(colWidths[i])) // Align headers
+        .join('   '); // Add spaces between columns
+    console.log(headerRow);
+
+    // Display rows with left-aligned columns
+    data.forEach(row => {
+        const formattedRow = keys
+            .map((key, i) => row[key].padEnd(colWidths[i])) // Align row data
+            .join('   '); // Add spaces between columns
+        console.log(formattedRow);
+    });
+}
 
 function startElectron(projectDir) {
     console.debug(`Project directory: ${projectDir}`);
@@ -31,17 +60,8 @@ function startElectron(projectDir) {
     });
 }
 
-async function updater(projectDir) {
-    if (!projectDir) {
-        console.debug("Project directory not provided, skipping upgrade check");
-        return;
-    }
-
-    const { confirm } = require('enquirer');
-
-    const updater = new Updater(projectDir);
-    const updates = updater.updatesAvailable();
-
+// Prompt to upgrade to aws sdk v3
+async function promptV3(updates) {
     if (updates.v3) {
         console.log("");
         console.log("This project uses the deprecated aws-sdk v2. Migration to aws-sdk v3 is available.");
@@ -64,10 +84,63 @@ async function updater(projectDir) {
             }
         }
 
-        await updater.update();
+       return "v3";       
     }
 }
 
+// prompt to upgrade to latest versions and run install
+async function promptUpdates(updates) {
+    let displayPrompt = false;
+    if (updates.installs && updates.installs.length > 0) {
+        console.log("");
+        console.log("The following dependency versions are not installed and may affect your service logic:");
+        console.log("");
+        displayTable(updates.installs);
+        displayPrompt = true;
+    }
+
+    if (updates.updates && updates.updates.length > 0) {
+        console.log("");
+        console.log("The following dependencies have new versions available:");        
+        console.log("");
+        displayTable(updates.updates);
+        console.log("");
+        displayPrompt = true;
+    }
+
+    if (displayPrompt) {
+        return await confirm({ initial: true, message: 'Do you wish to upgrade and install latest versions in your project?' });
+    }
+    return false;
+}
+
+/*
+  check if upgrade in npmjs to the existing ones in package.json
+  check if upgrade or missing node_modules vs package.json
+  check if missing node_modules 
+*/
+async function updater(projectDir) {
+    if (!projectDir) {
+        console.debug("Project directory not provided, skipping upgrade check");
+        return;
+    }
+    const updater = new Updater(projectDir);
+    const updates = await updater.checkForUpdates();
+
+    const upd = await promptUpdates(updates);
+    if (!upd) {
+        delete updates.updates;
+        delete updates.installs;
+    }
+
+    const v3 = await promptV3(updates);
+    if (!v3) {
+        delete updates.v3;
+    }
+
+    await updater.update(updates);
+}
+
 exports.command = "open [project_directory]"
 exports.builder = (yargs) => {
     yargs.positional(`project_directory`, {
@@ -79,8 +152,8 @@ exports.builder = (yargs) => {
 exports.desc = 'Open Kumologica Designer'
 
 exports.handler = async ({ project_directory }) => {
-    const projectDir = project_directory? path.resolve(project_directory): undefined ;
-
+    const projectDir = project_directory? path.resolve(project_directory): undefined;
     await updater(projectDir);
+    
     startElectron(projectDir);
 }

package/cli/commands/run.js

@@ -0,0 +1,167 @@
+/**
+ * This command should be used to start the kumologica runtime in local mode. And it will
+ * be assisting the UI on all aspects of the project development.
+ *
+ * Example:
+ * kl run ./myproject
+ * kl run ./myproject/flow.json
+ * kl run (this will look for a flow.json in the current directory)
+ *
+ * If not flow is found, the process will be exited (with code 1)
+ *
+ * The Runtime API can be found in: packages/runtime/src/runtime/lib/api/rest/index.js
+ * The actual runtime is in: packages/runtime/src/runtime/lib/index.js
+ *
+ * Naming convention used during the code:
+ * - AdminApp (express app) is the server that serves the Runtime API
+ * - NodeApp (express app) is the server that runs the flow
+ *
+ * DEVELOPER NOTE:
+ * Current implementation seems to be mounting the runtime api in the NodeApp (see runtime/lib/index.js:534)
+ * Ideally we would like to separate the two apps and have the AdminApp running on a different port.
+ *
+ */
+
+const path = require("path");
+const fs = require("fs");
+const { codegen } = require("@kumologica/builder");
+const { DesignerServer } = require("../../src/server/DesignerServer");
+const { logError, logNotice, logInfo, logFatal } = require("../utils/logger");
+
+exports.command = "run [project_directory]";
+exports.desc = `Start a local HTTP server to execute task and then stops HTTP server and exit.`;
+
+exports.builder = (yargs) => {
+  yargs.positional(`project_directory`, {
+    type: "string",
+    describe:
+      "Path to a valid kumologica project directory or flow file. (Optional)",
+  });
+  yargs.option(`loglevel`, {
+    describe: "Logging level: [error, warn, info, debug, trace]",
+    type: "string",
+    nargs: 1,
+  });
+  yargs.option(`port`, {
+    describe: "Specifies the listening port utilized by the application",
+    type: "number",
+    nargs: 1,
+  });
+  yargs.option(`taskName`, {
+    describe: "The name of the task.",
+    type: "string",
+    alias: "t",
+    nargs: 1,
+  });
+  yargs.option(`args`, {
+    describe: "The list of arguments, either '-a one two three' or '-a one -a two -a three' ",
+    type: "array",
+    alias: "a"
+  });
+};
+
+exports.handler = async ({ project_directory, loglevel, port, taskName, args }) => {
+  logNotice(`Starting HTTP Server...`);
+  let projectDirectory = project_directory || process.cwd();
+  // project_directory can point to a directory or a flow, so lets make sure that first the directory exists
+  let absProjectDirectory;
+  let exitCode = 1;
+  try {
+    absProjectDirectory = fs.realpathSync(projectDirectory);
+  } catch (err) {
+    logFatal(`Project not found: ${projectDirectory}`);
+    process.exit(exitCode);
+  }
+
+  try {
+    // Resolve the path to the flow path
+    const [projectFlowDirname, projectFlowFullPath] = resolveProjectFlowPath(absProjectDirectory);
+    logInfo(`> Flow file found: ${projectFlowFullPath}`);
+
+    // Gather all cli params
+    const cliParams = {
+      loglevel,
+      port,
+      noadmin: true,
+    };
+
+    // Start a server
+    let server = new DesignerServer({
+      flowPath: projectFlowFullPath,
+      cliParams,
+    });
+
+    await server.start();
+
+    const tName = taskName || process.env.taskName;
+    const req = {
+      method: 'POST',
+      headers: {
+      },
+      body: JSON.stringify({args: args})
+    };
+    const url = `http://127.0.0.1:${port||1880}/__task__/${tName}`;
+    
+    const response = await fetch(url, req);
+    const data = await response.text();
+    
+    logInfo("Status:  " + response.status);
+    logInfo("Message: " + data);
+
+    await server.stop();
+    
+    exitCode = response.status >= 200 && response.status < 300 ? 0 : 1;
+
+  } catch (e) {
+    logFatal(e.message);
+  }
+
+  process.exit(exitCode);
+};
+
+/**
+ * Resolve a given path to a new path that points to the project flow json file.
+ * Scenarios:
+ *  - If path undefined will resolve using current directory
+ *  - If path directory, it should look up for a valid flow.json file, if it does not exist create it
+ *  - If path is pointing to an actual flowFile, just return it.
+ *
+ * @param {string} projectDir
+ */
+function resolveProjectFlowPath(projectDir) {
+  // output
+  let projectFlowFullPath;
+  let projectFlowDirname;
+
+  let projectDirOrFile = projectDir || process.cwd();
+
+  let isDir = isDirectory(projectDirOrFile);
+  if (isDir) {
+    let flowFileName = codegen.findFlowFile(projectDirOrFile); // returns only the flowname
+
+    if (!flowFileName) {
+      logError(`No flow found in directory: ${projectDirOrFile}`);
+      process.exit(1);
+    } else {
+      projectFlowDirname = projectDirOrFile;
+      projectFlowFullPath = path.join(projectDirOrFile, flowFileName);
+    }
+  } else if (isDir === false) {
+    projectFlowDirname = path.dirname(projectDirOrFile);
+    projectFlowFullPath = projectDirOrFile;
+  } else {
+    logError(`Directory does not exist: ${projectDirOrFile}`);
+    process.exit(1);
+  }
+
+  return [projectFlowDirname, projectFlowFullPath];
+}
+
+function isDirectory(dir) {
+  try {
+    let stats = fs.statSync(dir);
+    return stats.isDirectory();
+  } catch (err) {
+    return undefined;
+  }
+}

package/cli/commands/serve.js

@@ -0,0 +1,139 @@
+/**
+ * This command should be used to start the kumologica runtime in local mode. And it will
+ * be assisting the UI on all aspects of the project development.
+ *
+ * Example:
+ * kl start ./myproject
+ * kl start ./myproject/flow.json
+ * kl start (this will look for a flow.json in the current directory)
+ *
+ * If not flow is found, the process will be exited (with code 1)
+ *
+ * The Runtime API can be found in: packages/runtime/src/runtime/lib/api/rest/index.js
+ * The actual runtime is in: packages/runtime/src/runtime/lib/index.js
+ *
+ * Naming convention used during the code:
+ * - AdminApp (express app) is the server that serves the Runtime API
+ * - NodeApp (express app) is the server that runs the flow
+ *
+ * DEVELOPER NOTE:
+ * Current implementation seems to be mounting the runtime api in the NodeApp (see runtime/lib/index.js:534)
+ * Ideally we wouldl like to separate the two apps and have the AdminApp running on a different port.
+ *
+ */
+
+const path = require("path");
+const fs = require("fs");
+const { codegen } = require("@kumologica/builder");
+const { DesignerServer } = require("../../src/server/DesignerServer");
+const { logError, logNotice, logInfo, logFatal } = require("../utils/logger");
+// const opn = require('better-opn');
+
+exports.command = "serve [project_directory]";
+exports.desc = `Start a local HTTP server to serve a project`;
+
+exports.builder = (yargs) => {
+  yargs.positional(`project_directory`, {
+    type: "string",
+    describe:
+      "Path to a valid kumologica project directory or flow file. (Optional)",
+  });
+  yargs.option(`loglevel`, {
+    describe: "Logging level: [error, warn, info, debug, trace]",
+    type: "string",
+    nargs: 1,
+  });
+  yargs.option(`port`, {
+    describe: "Specifies the listening port utilized by the application",
+    type: "number",
+    nargs: 1,
+  });
+};
+
+exports.handler = async ({ project_directory, loglevel, port, secured }) => {
+  logNotice(`Starting HTTP Server...`);
+  let projectDirectory = project_directory || process.cwd();
+  // project_directory can point to a directory or a flow, so lets make sure that first the directory exists
+  let absProjectDirectory;
+
+  try {
+    absProjectDirectory = fs.realpathSync(projectDirectory);
+  } catch (err) {
+    logFatal(`Project not found: ${projectDirectory}`);
+    process.exit(1);
+  }
+
+  try {
+    // Resolve the path to the flow path
+    const [projectFlowDirname, projectFlowFullPath] =
+      resolveProjectFlowPath(absProjectDirectory);
+    logInfo(`> Flow file found: ${projectFlowFullPath}`);
+
+    // Gather all cli params
+    const cliParams = {
+      loglevel,
+      port,
+      noadmin: true,
+    };
+
+    // Start a server
+    let server = new DesignerServer({
+      flowPath: projectFlowFullPath,
+      cliParams,
+    });
+
+    await server.start();
+
+    // open("http://localhost:1880/hello");
+  } catch (e) {
+    console.log(e);
+    logFatal(e.message);
+  }
+};
+
+/**
+ * Resolve a given path to a new path that points to the project flow json file.
+ * Scenarios:
+ *  - If path undefined will resolve using current directory
+ *  - If path directory, it should look up for a valid flow.json file, if it does not exist create it
+ *  - If path is pointing to an actual flowFile, just return it.
+ *
+ * @param {string} projectDir
+ */
+function resolveProjectFlowPath(projectDir) {
+  // output
+  let projectFlowFullPath;
+  let projectFlowDirname;
+
+  let projectDirOrFile = projectDir || process.cwd();
+
+  let isDir = isDirectory(projectDirOrFile);
+  if (isDir) {
+    let flowFileName = codegen.findFlowFile(projectDirOrFile); // returns only the flowname
+
+    if (!flowFileName) {
+      logError(`No flow found in directory: ${projectDirOrFile}`);
+      process.exit(1);
+    } else {
+      projectFlowDirname = projectDirOrFile;
+      projectFlowFullPath = path.join(projectDirOrFile, flowFileName);
+    }
+  } else if (isDir === false) {
+    projectFlowDirname = path.dirname(projectDirOrFile);
+    projectFlowFullPath = projectDirOrFile;
+  } else {
+    logError(`Directory does not exist: ${projectDirOrFile}`);
+    process.exit(1);
+  }
+
+  return [projectFlowDirname, projectFlowFullPath];
+}
+
+function isDirectory(dir) {
+  try {
+    let stats = fs.statSync(dir);
+    return stats.isDirectory();
+  } catch (err) {
+    return undefined;
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kumologica/sdk",
-  "version": "3.5.4",
+  "version": "3.6.0-alpha7",
   "productName": "Kumologica Designer",
   "copyright": "Copyright 2020 Kumologica Pty Ltd, All Rights Reserved.",
   "author": "Kumologica Pty Ltd <contact@kumologica.com>",
@@ -82,9 +82,9 @@
     "@aws-sdk/credential-providers": "^3.556.0",
     "@aws-sdk/lib-dynamodb": "^3.549.0",
     "@electron/remote": "^2.0.8",
-    "@kumologica/builder": "3.5.4",
-    "@kumologica/devkit": "3.5.4",
-    "@kumologica/runtime": "3.5.4",
+    "@kumologica/builder": "3.6.0-alpha7",
+    "@kumologica/devkit": "3.6.0-alpha7",
+    "@kumologica/runtime": "3.6.0-alpha7",
     "adm-zip": "0.4.13",
     "ajv": "8.10.0",
     "archive-type": "^4.0.0",
@@ -102,7 +102,7 @@
     "dagre": "^0.8.5",
     "debounce": "^1.2.0",
     "decompress": "^4.2.1",
-    "electron": "19.0.0",
+    "electron": "30.0.0",
     "electron-tabs": "^1.0.1",
     "electron-updater": "4.3.9",
     "enquirer": "2.3.6",

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

@@ -42,6 +42,7 @@ class MainWindow {
       titleBarStyle: 'hiddenInset',
       icon: "./src/assets/kumologica-app.png",
       webPreferences: {
+        sandbox: false,
         webviewTag: true,
         nodeIntegration: false,
         preload: preloadJsPath,

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

@@ -28,6 +28,7 @@ class ModalHome {
       resizable: false,
       backgroundColor: '#fff',
       webPreferences: {
+        sandbox: false,
         nodeIntegration: false,
         preload: preloadJsPath,
         contextIsolation: false,

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

@@ -23,6 +23,7 @@ class ModalNewProject {
       titleBarStyle: 'hiddenInset',
       backgroundColor: '#fff',
       webPreferences: {
+        sandbox: false,
         nodeIntegration: false,
         preload: preloadJsPath,
         enableRemoteModule: true,

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

@@ -24,6 +24,7 @@ class ModalNewTab {
       titleBarStyle: 'hiddenInset',
       backgroundColor: '#fff',
       webPreferences: {
+        sandbox: false,
         nodeIntegration: false,
         preload: preloadJsPath,
         enableRemoteModule: true,

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

@@ -26,6 +26,7 @@ class ModalNodeLibrary {
       backgroundColor: '#fff',
       icon: iconPath,
       webPreferences: {
+        sandbox: false,
         nodeIntegration: false,
         preload: preloadJsPath,
         contextIsolation: false,

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

@@ -26,6 +26,7 @@ class ModalRenameTab {
       titleBarStyle: 'hiddenInset',
       backgroundColor: '#fff',
       webPreferences: {
+        sandbox: false,
         nodeIntegration: false,
         preload: preloadJsPath,
         enableRemoteModule: true,

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

@@ -26,6 +26,7 @@ class ModalWelcome {
       resizable: false,
       backgroundColor: '#fff',
       webPreferences: {
+        sandbox: false,
         nodeIntegration: false,
         preload: preloadJsPath,
         contextIsolation: false,