@contrail/cli 2.0.6 → 2.0.7

package/README.md

@@ -15,7 +15,7 @@ $ npm install -g @contrail/cli
 $ contrail COMMAND
 running command...
 $ contrail (--version)
-@contrail/cli/2.0.6 darwin-arm64 node-v18.13.0
+@contrail/cli/2.0.7 darwin-arm64 node-v18.13.0
 $ contrail --help [COMMAND]
 USAGE
   $ contrail COMMAND
@@ -388,11 +388,12 @@ Exports an data of an instance including types and users
 
 ```
 USAGE
-  $ contrail instance export [--outDir <value>] [--overwrite]
+  $ contrail instance export [-d <value>] [-f]
 
 FLAGS
-  --outDir=<value>  [default: .] The directory to which to export the instance data. Defaults to the current directory
-  --overwrite       Replaces any existing export files in outDir
+  -d, --outDir=<value>  [default: .] The directory to which to export the instance data. Defaults to the current
+                        directory
+  -f, --overwrite       Replaces any existing export files in outDir
 
 DESCRIPTION
   Exports an data of an instance including types and users

package/dist/api/apps.js

@@ -17,6 +17,7 @@ async function getAllAvailableApps(options) {
         criteria: {
             orgId: options.orgId,
             private: false,
+            hidden: true,
         },
     }));
     return apps;

package/dist/commands/instance/export.js

@@ -19,6 +19,6 @@ ExportInstance.examples = [
 `,
 ];
 ExportInstance.flags = {
-    outDir: core_1.Flags.string({ description: 'The directory to which to export the instance data. Defaults to the current directory', required: false, default: '.' }),
-    overwrite: core_1.Flags.boolean({ description: 'Replaces any existing export files in outDir', required: false, default: false })
+    outDir: core_1.Flags.string({ char: 'd', description: 'The directory to which to export the instance data. Defaults to the current directory', required: false, default: '.' }),
+    overwrite: core_1.Flags.boolean({ char: 'f', description: 'Replaces any existing export files in outDir', required: false, default: false })
 };

package/dist/helpers/workflow-template-definitions/workflow-template-definition-deployer.js

@@ -8,6 +8,7 @@ const apps_1 = require("../../api/apps");
 const event_workflow_templates_1 = require("../../api/event-workflow-templates");
 const event_workflow_template_definition_1 = require("../../api/event-workflow-template-definition");
 const actions_deployer_1 = require("../app/actions-deployer");
+const interface_converters_1 = require("../../interface-converters");
 class WorkflowTemplateDefinitionDeployer {
     async cliInstallWorkflowTemplateDefinitions() {
         const installedApps = await (0, apps_1.getInstalledApps)();
@@ -94,6 +95,7 @@ class WorkflowTemplateDefinitionDeployer {
         console.log(`%s \tDeploying workflow definitions: ${workflowKey}`, chalk_1.default.yellow.bold('WORKFLOW DEFINITION'));
         const identifier = this.getWorkflowDeclarationIdentifier(workflowKey, app);
         const existingDefinition = existingWorkflows.find(ad => ad.identifier === identifier);
+        (0, interface_converters_1.convertWorkflow)(workflow);
         if (existingDefinition) {
             return await this.updateWorkflowTemplateDefinition(existingDefinition, workflow, app);
         }

package/dist/helpers/workflow-templates/helper.js

@@ -9,6 +9,7 @@ const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
 const event_workflow_action_definition_1 = require("../../api/event-workflow-action-definition");
 const event_workflow_templates_1 = require("../../api/event-workflow-templates");
 const login_1 = require("../../auth/login");
+const interface_converters_1 = require("../../interface-converters");
 const yaml = require('js-yaml');
 class LocalWorkflowTemplateDeployer {
     async deployWorkflows(wtDeclaration) {
@@ -24,6 +25,7 @@ class LocalWorkflowTemplateDeployer {
         console.log(`%s \tDeploying workflow: ${workflowKey}`, chalk_1.default.yellow.bold('WORKFLOW TEMPLATES'));
         const identifier = getWorkflowTemplateIdentifier(workflowKey);
         const existingTemplate = existingWorkflows.find(ad => ad.identifier === identifier);
+        (0, interface_converters_1.convertWorkflow)(workflow);
         if (existingTemplate) {
             return await this.updateWorkflowTemplate(workflowKey, existingTemplate, workflow);
         }
@@ -47,6 +49,7 @@ class LocalWorkflowTemplateDeployer {
     }
     async populateActionIds(workflowTemplate, workflowKey) {
         var _a;
+        console.log('workflow tempalate:', JSON.stringify(workflowTemplate, null, 2));
         if (!((_a = workflowTemplate === null || workflowTemplate === void 0 ? void 0 : workflowTemplate.workflowDefinition) === null || _a === void 0 ? void 0 : _a.paths)) {
             return;
         }
@@ -70,11 +73,14 @@ class LocalWorkflowTemplateDeployer {
         }
     }
     async updateWorkflowTemplate(workflowKey, existingWorkflowTemplate, workflowTemplate) {
+        var _a, _b;
         await this.populateActionIds(workflowTemplate, workflowKey);
         const updates = Object.assign(new Object(), {
             name: workflowTemplate.name,
             triggerKey: workflowTemplate.triggerKey,
-            workflowDefinition: workflowTemplate.workflowDefinition
+            workflowDefinition: workflowTemplate.workflowDefinition,
+            messageGroupId: (_a = workflowTemplate.messageGroupId) !== null && _a !== void 0 ? _a : existingWorkflowTemplate.messageGroupId,
+            parallelWorkerCount: (_b = workflowTemplate.parallelWorkerCount) !== null && _b !== void 0 ? _b : existingWorkflowTemplate.parallelWorkerCount,
         });
         const updatedWorkflowTemplate = await (0, event_workflow_templates_1.updateWorkflowTemplate)({ id: existingWorkflowTemplate.id, updates });
         console.log(`%s      Updated existing workflow template: ${updatedWorkflowTemplate.identifier}`, chalk_1.default.yellow.bold('WORKFLOW TEMPLATES'));
@@ -157,7 +163,6 @@ function loadTemplateConfig(saveFile) {
     const TARGET_DIR = process.cwd();
     try {
         const doc = yaml.load(fs_1.default.readFileSync(path.resolve(path.join(TARGET_DIR, saveFile)), 'utf8'));
-        console.log(doc);
         return doc;
     }
     catch (e) {

package/dist/interface-converters.d.ts

@@ -0,0 +1,3 @@
+import { WorkflowDefinition, WorkflowTemplate } from './interfaces';
+export declare const DEFAULT_WORKFLOW_PARALLELISM = 1;
+export declare function convertWorkflow(workflow: WorkflowDefinition | WorkflowTemplate): void;

package/dist/interface-converters.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertWorkflow = exports.DEFAULT_WORKFLOW_PARALLELISM = void 0;
+exports.DEFAULT_WORKFLOW_PARALLELISM = 1;
+// parses the user-facing interface of the workflow and converts it to the cloud-facing format in-place.
+function convertWorkflow(workflow) {
+    var _a;
+    workflow.parallelWorkerCount = (_a = workflow.parallelism) !== null && _a !== void 0 ? _a : exports.DEFAULT_WORKFLOW_PARALLELISM;
+    workflow.messageGroupId = workflow.groupId;
+}
+exports.convertWorkflow = convertWorkflow;

package/dist/interface-converters.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/interface-converters.spec.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const interface_converters_1 = require("./interface-converters");
+describe('Workflow Template converter tests', () => {
+    it('should use default parallelism', () => {
+        const workflow = {
+            identifier: 'identifier',
+            name: 'name1',
+            triggerKey: 'foo|bar',
+            workflowDefinition: {
+                paths: [
+                    {
+                        conditional: 'true',
+                        actionDefinitionConfigs: [
+                            {
+                                action: 'logItem',
+                                name: 'Log Item'
+                            }
+                        ]
+                    }
+                ]
+            },
+            ownerKey: 'app:123',
+            isActive: true,
+            public: true,
+            // parallelism: 3,
+        };
+        (0, interface_converters_1.convertWorkflow)(workflow);
+        expect(workflow.parallelWorkerCount).toEqual(interface_converters_1.DEFAULT_WORKFLOW_PARALLELISM);
+        expect(workflow['concurrency']).toBeUndefined();
+        expect(workflow.messageGroupId).toBeUndefined();
+    });
+    it('should pass user concurrency as parallel count', () => {
+        const workflow = {
+            identifier: 'identifier',
+            name: 'name1',
+            triggerKey: 'foo|bar',
+            workflowDefinition: {
+                paths: [
+                    {
+                        conditional: 'true',
+                        actionDefinitionConfigs: [
+                            {
+                                action: 'logItem',
+                                name: 'Log Item'
+                            }
+                        ]
+                    }
+                ]
+            },
+            ownerKey: 'app:123',
+            isActive: true,
+            public: true,
+            parallelism: 3,
+        };
+        (0, interface_converters_1.convertWorkflow)(workflow);
+        expect(workflow.parallelWorkerCount).toEqual(3);
+        expect(workflow['concurrency']).toBeUndefined();
+        expect(workflow.messageGroupId).toBeUndefined();
+    });
+    it('should ignore concurrency if we pass group ID or ', () => {
+        const workflow = {
+            identifier: 'identifier',
+            name: 'name1',
+            triggerKey: 'foo|bar',
+            workflowDefinition: {
+                paths: [
+                    {
+                        conditional: 'true',
+                        actionDefinitionConfigs: [
+                            {
+                                action: 'logItem',
+                                name: 'Log Item'
+                            }
+                        ]
+                    }
+                ]
+            },
+            ownerKey: 'app:123',
+            isActive: true,
+            public: true,
+            parallelism: 3,
+        };
+        (0, interface_converters_1.convertWorkflow)(workflow);
+        expect(workflow.parallelWorkerCount).toEqual(3);
+        expect(workflow['concurrency']).toBeUndefined();
+        expect(workflow.messageGroupId).toBeUndefined();
+    });
+});

package/dist/interfaces.d.ts

@@ -57,6 +57,8 @@ export interface WorkflowDefinition {
     isActive: boolean;
     public: boolean;
     supportingAppId?: string;
+    parallelism?: number;
+    groupId?: string;
     messageGroupId?: string;
     parallelWorkerCount?: number;
 }
@@ -74,6 +76,8 @@ export interface WorkflowTemplate {
     isActive: boolean;
     ownerKey?: string;
     supportingAppId?: string;
+    parallelism?: number;
+    groupId?: string;
     messageGroupId?: string;
     parallelWorkerCount?: number;
 }

package/dist/templates/typescript/app.yml

@@ -34,6 +34,7 @@ workflows:
     triggerKey: item|update
     isActive: true
     public: true
+    concurrency: 3  # The maximum number of concurrent jobs to run for this workflow. Defaults to 5
     workflowDefinition:
       paths:
         - conditional: "true"

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.0.6",
+  "version": "2.0.7",
   "commands": {
     "app:create": {
       "id": "app:create",
@@ -361,6 +361,7 @@
         "outDir": {
           "name": "outDir",
           "type": "option",
+          "char": "d",
           "description": "The directory to which to export the instance data. Defaults to the current directory",
           "required": false,
           "multiple": false,
@@ -369,6 +370,7 @@
         "overwrite": {
           "name": "overwrite",
           "type": "boolean",
+          "char": "f",
           "description": "Replaces any existing export files in outDir",
           "required": false,
           "allowNo": false

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/cli",
-  "version": "2.0.6",
+  "version": "2.0.7",
   "description": "VibeIQ's Contrail Platform CLI.",
   "bin": {
     "contrail-cli": "./bin/run",
@@ -50,16 +50,17 @@
   "devDependencies": {
     "@oclif/test": "^2.3.8",
     "@types/chai": "^4",
-    "@types/mocha": "^9.0.0",
+    "@types/jest": "^29.5.0",
     "@types/node": "^16.18.14",
     "chai": "^4",
     "eslint": "^8.35.0",
     "eslint-config-oclif": "^4",
     "eslint-config-oclif-typescript": "^1.0.3",
     "eslint-plugin-unused-imports": "^2.0.0",
-    "mocha": "^9",
+    "jest": "^29.5.0",
     "oclif": "^3",
     "shx": "^0.3.3",
+    "ts-jest": "^29.0.5",
     "ts-node": "^10.9.1",
     "tslib": "^2.5.0",
     "typescript": "^4.9.5"
@@ -106,16 +107,29 @@
   },
   "scripts": {
     "build": "shx rm -rf dist && tsc -b && npm run copy-templates",
-    "lint": "eslint . --ext .ts --config .eslintrc",
+    "lint": "eslint . --ext .ts --config .eslintrc.js",
     "copy-templates": "cp -r templates/ dist/templates",
     "postpack": "shx rm -f oclif.manifest.json",
-    "posttest": "yarn lint",
     "prepack": "yarn build && oclif manifest && oclif readme",
-    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "test": "jest",
     "version": "oclif readme && git add README.md"
   },
   "engines": {
     "node": ">=12.0.0"
   },
-  "types": "dist/index.d.ts"
+  "types": "dist/index.d.ts",
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".spec.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
 }