@contrail/cli 1.0.67 → 1.0.69

package/templates/typescript/package.json

@@ -1,52 +1,54 @@
-{
-  "name": "test-app",
-  "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
-  "bin": {
-    "@contrail/contrail-cli": "bin/init",
-    "contrail": "bin/init"
-  },
-  "config": {
-    "wf": "/workflow-actions-prod"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "build": "tsc",
-    "start": "nodemon --watch 'actions/**/*.ts' --exec ts-node actions/mock-server.ts",
-    "debug": "nodemon -r ts-node/register --inspect=127.0.0.1:60002 --watch 'actions/**/*.ts' --exec node actions/mock-server.ts",
-    "lint": "eslint . --fix",
-    "test": "jest",
-    "test-watch": "jest --watch",
-    "docker-build": "docker build . -t \"${npm_package_name}:${npm_package_version}\"",
-    "docker-build:win": "docker build . -t \"%npm_package_name%:%npm_package_version%\"",
-    "docker-run-entry": "docker run -it --entrypoint=/bin/bash \"${npm_package_name}:${npm_package_version}\"",
-    "docker-run-entry:win": "docker run -it --entrypoint=/bin/bash \"%npm_package_name%:%npm_package_version%\"",
-    "docker-run": "docker run --env CONTRAIL_CLI_ENV=DEV -p 9000:8080 \"${npm_package_name}:${npm_package_version}\"",
-    "docker-run:win": "docker run  --env CONTRAIL_CLI_ENV=DEV -p 9000:8080 \"%npm_package_name%:%npm_package_version%\"",
-    "docker-ecr-login": "aws ecr get-login-password | docker login --username AWS --password-stdin ${AWS_REGISTRY}",
-    "docker-ecr-login:win": "aws ecr get-login-password | docker login --username AWS --password-stdin %AWS_REGISTRY%",
-    "docker-tag": "docker tag ${npm_package_name}:${npm_package_version} \"${AWS_REGISTRY}${npm_package_config_wf}:${npm_package_name}.${npm_package_version}\"",
-    "docker-tag:win": "docker tag %npm_package_name%:%npm_package_version% %AWS_REGISTRY%%npm_package_config_wf%:%npm_package_name%.%npm_package_version%",
-    "docker-push": "docker push \"${AWS_REGISTRY}${npm_package_config_wf}:${npm_package_name}.${npm_package_version}\"",
-    "docker-push:win": "docker push \"%AWS_REGISTRY%%npm_package_config_wf%:%npm_package_name%.%npm_package_version%\""
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "@contrail/sdk": "^1.1.53",
-    "chalk": "^4.0.0"
-  },
-  "devDependencies": {
-    "body-parser": "^1.20.2",
-    "express": "^4.18.2",
-    "nodemon": "^1.19.4",
-    "jest": "^29.2.2",
-    "ts-jest": "^29.0.3",
-    "ts-node": "^7.0.1",
-    "typescript": "^4.7.4"
-  }
-}
+{
+  "name": "test-app",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "bin": {
+    "@contrail/contrail-cli": "bin/init",
+    "contrail": "bin/init"
+  },
+  "config": {
+    "wf": "/workflow-actions-prod"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "start": "nodemon --watch \"src/**/*.ts\" --exec ts-node src/framework/mock-server.ts",
+    "debug": "nodemon -r ts-node/register --inspect=127.0.0.1:60002 --watch 'actions/**/*.ts' --exec node src/framework/mock-server.ts",
+    "lint": "eslint . --fix",
+    "test": "jest",
+    "test-watch": "jest --watch",
+    "docker-build": "docker build . -t \"${npm_package_name}:${npm_package_version}\"",
+    "docker-build:win": "docker build . -t \"%npm_package_name%:%npm_package_version%\"",
+    "docker-run-entry": "docker run -it --entrypoint=/bin/bash \"${npm_package_name}:${npm_package_version}\"",
+    "docker-run-entry:win": "docker run -it --entrypoint=/bin/bash \"%npm_package_name%:%npm_package_version%\"",
+    "docker-run": "docker run --env CONTRAIL_CLI_ENV=DEV -p 9000:8080 \"${npm_package_name}:${npm_package_version}\"",
+    "docker-run:win": "docker run  --env CONTRAIL_CLI_ENV=DEV -p 9000:8080 \"%npm_package_name%:%npm_package_version%\"",
+    "docker-ecr-login": "aws ecr get-login-password | docker login --username AWS --password-stdin ${AWS_REGISTRY}",
+    "docker-ecr-login:win": "aws ecr get-login-password | docker login --username AWS --password-stdin %AWS_REGISTRY%",
+    "docker-tag": "docker tag ${npm_package_name}:${npm_package_version} \"${AWS_REGISTRY}${npm_package_config_wf}:${npm_package_name}.${npm_package_version}\"",
+    "docker-tag:win": "docker tag %npm_package_name%:%npm_package_version% %AWS_REGISTRY%%npm_package_config_wf%:%npm_package_name%.%npm_package_version%",
+    "docker-push": "docker push \"${AWS_REGISTRY}${npm_package_config_wf}:${npm_package_name}.${npm_package_version}\"",
+    "docker-push:win": "docker push \"%AWS_REGISTRY%%npm_package_config_wf%:%npm_package_name%.%npm_package_version%\""
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@contrail/sdk": "^1.1.54",
+    "chalk": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^18.14.6",
+    "body-parser": "^1.20.2",
+    "express": "^4.18.2",
+    "jest": "^29.2.2",
+    "js-yaml": "^4.1.0",
+    "nodemon": "^1.19.4",
+    "ts-jest": "^29.0.3",
+    "ts-node": "^7.0.1",
+    "typescript": "^4.7.4"
+  }
+}

package/templates/typescript/src/actions/logItem.ts

@@ -0,0 +1,26 @@
+import { login, Entities, setAppCredentials } from "@contrail/sdk";
+import { AppActionCallBack, AppActionCallbackStatus } from "../framework";
+import { Logger } from "../framework/logger";
+
+export async function execute(event, config: any, logger: Logger): Promise<AppActionCallBack> {
+  logger.log('Starting Example Action');
+
+
+  logger.log('Loggin in');
+  // Fetch items from the SDK
+  await setAppCredentials(config.apiKey, config.orgSlug);
+  logger.log('Getting item from SDK');
+
+  const item = await new Entities().get({
+    entityName: 'item',
+    id: event.id,
+  })
+  logger.log('Got item: ', item);  
+
+  return {
+    output: {
+      item,
+    },
+    status: AppActionCallbackStatus.SUCCESS
+  };
+}

package/templates/typescript/src/framework/action-dispatcher.ts

@@ -0,0 +1,86 @@
+/** 
+ * WARNING:  Do not modify this file, it is part of the generic runtime handling logic
+ * for VibeIQ app actions.
+ */
+
+
+import { loadAppConfig } from "./app-config";
+import { AppActionCallbackStatus, AppActionRequest, AppActionResponse } from "./interfaces";
+import { Logger } from "./logger";
+
+const APP_CONFIG = loadAppConfig();
+const appName = APP_CONFIG.appIdentifier;
+
+export class ActionDispatcher {
+  
+  public static async dispatchActionRequest(data: AppActionRequest) : Promise<AppActionResponse> {
+    const logger = new Logger();
+    const event = (typeof data.event === 'string')
+      ? JSON.parse(data.event)
+      : data.event;
+
+    return ActionDispatcher.delegateToHandler(event, data, logger);
+  }
+
+  private static async delegateToHandler(event, data: AppActionRequest, logger: Logger) : Promise<AppActionResponse>{ 
+    try {
+      const handler = ActionDispatcher.getActionHandler(data);
+      let actionResults = await handler(event, data, logger)
+      let body: any = {
+        logs: logger.allEntries,
+        taskId: data.taskId,
+        status: AppActionCallbackStatus.SUCCESS,
+      };
+
+      if(typeof actionResults === 'string'){
+        body.output = { message: actionResults }
+      } else if(typeof actionResults === 'object'){
+        if(actionResults.output){
+          body.output = actionResults.output;
+        }
+        if(actionResults.status) {
+          body.status = actionResults.status;
+        }
+      } 
+      return {
+        statusCode: 200,
+        body
+      }    
+    } catch (error) {
+      console.log("Error caught in handling action: ", error)
+      return {
+        statusCode: 500,
+        body: {
+          output: {
+            errorMessage: error.message,
+          },
+          taskId: data.taskId,
+          logs: logger.allEntries,
+          status: AppActionCallbackStatus.FAILURE,
+        }
+      }    
+    }
+  }
+
+  /** Retrives the handler function for the requested action 
+  */
+  private static getActionHandler(data: AppActionRequest): (event, data, logger) => any {
+    try {
+      const actionPath = data.action;
+      const actionName = actionPath.substring(appName.length + 1, actionPath.length);
+      console.log('action: ',  actionPath, actionName);
+      const handlerFile = require(`../actions/${actionName}`);
+      if(!handlerFile) {
+        throw new Error(`Handler file could not be located for action : ${data.action}`);  
+      }   
+      const handlerFunction = handlerFile.execute;
+      if(!handlerFunction) {
+        throw new Error(`Handler function 'execute' could not be located for action : ${data.action}`);  
+      }
+      return handlerFunction;
+    } catch (error) {
+      console.log("Error caught in getActionHandler: ", error)
+      throw new Error(`Could not locate handler function for requested action: ${data.action}`);
+    }
+  }
+}

package/templates/typescript/src/framework/app-config.ts

@@ -0,0 +1,27 @@
+/** 
+ * WARNING:  Do not modify this file, it is part of the generic runtime handling logic
+ * for VibeIQ app actions.
+ */
+
+
+import fs from 'fs';
+const yaml = require('js-yaml');
+
+export function loadAppConfig(){
+  const TARGET_DIR = process.cwd();
+  console.log("TARGET_DIR: ", TARGET_DIR)
+  try {
+    const separator = getSeparatorByPlatform();
+    const doc = yaml.load(fs.readFileSync(TARGET_DIR + separator + 'app.yml', 'utf8'));
+    console.log(doc);
+    return doc;
+  } catch (e) {
+    throw new Error(`ERROR PARSING YAML: ${e}`);
+  }
+}
+
+export function getSeparatorByPlatform() {
+  const isWin = process.platform === 'win32';
+  const separator = isWin ? '\\' : '/';
+  return separator;
+}

package/templates/typescript/src/framework/handler.ts

@@ -0,0 +1,11 @@
+/** 
+ * WARNING:  Do not modify this file, it is part of the generic runtime handling logic
+ * for VibeIQ app actions.
+ */
+
+
+import { AppActionRequest, AppActionResponse, ActionDispatcher } from '.';
+
+export async function execute(data: AppActionRequest): Promise<AppActionResponse> {
+  return ActionDispatcher.dispatchActionRequest(data);
+}

package/templates/typescript/src/framework/index.ts

@@ -0,0 +1,3 @@
+export * from './interfaces';
+export * from './action-dispatcher';
+export * from './logger';

package/templates/typescript/src/framework/interfaces.ts

@@ -0,0 +1,32 @@
+/** 
+ * WARNING:  Do not modify this file, it is part of the generic runtime handling logic
+ * for VibeIQ app actions.
+ */
+
+export interface AppActionRequest {
+  action: string;
+  apiKey: string;
+  orgSlug: string;
+  taskId: string; 
+  event: any;
+  [key:string] : any;
+}
+
+
+export interface AppActionResponse {
+  statusCode: number;
+  body: AppActionCallBack;
+}
+
+export interface AppActionCallBack {
+  output?: any;
+  status?: AppActionCallbackStatus;
+  logs?: Array<string>;
+  taskId?: string;
+}
+
+
+export enum AppActionCallbackStatus {
+  FAILURE = 'FAILURE',
+  SUCCESS = 'SUCCESS'
+}

package/templates/typescript/src/framework/logger.ts

@@ -0,0 +1,21 @@
+/** 
+ * WARNING:  Do not modify this file, it is part of the generic runtime handling logic
+ * for VibeIQ app actions.
+ */
+
+
+export class Logger {
+  allEntries : Array<string> = [];
+  public log(...args){
+    console.log(...args);
+    this.allEntries.push(new Date().toISOString() + ': ' + args.join(''));
+  }
+
+  public getEntries(){
+    return this.allEntries.join('\n');
+  }
+
+  public clearEntries(){
+    this.allEntries = [];
+  }
+}

package/templates/typescript/{actions → src/framework}/mock-server.ts

@@ -1,4 +1,11 @@
+/** 
+ * WARNING:  Do not modify this file, it is part of the generic runtime handling logic
+ * for VibeIQ app actions.
+ */
+
+
 import { execute } from './handler';
+
 const express = require('express');
 const bodyParser = require('body-parser');
 const app = express();

package/templates/typescript/tsconfig.json

@@ -1,27 +1,28 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "commonjs",
-    "declaration": true,
-    "esModuleInterop": true,
-    "outDir": "dist",
-    "strict": false,
-    "experimentalDecorators": true,
-    "strictPropertyInitialization": false,
-    "noImplicitAny": false,
-    "emitDecoratorMetadata": true,
-    "skipLibCheck": true,
-    "moduleResolution": "node",
-    "lib": [
-      "es5",
-      "ES2015",
-      "ES2016",
-      "ES2017",
-      "ES2020",
-      "dom",
-      "esnext.asynciterable"
-    ]
-  },
-  "include": ["actions"],
-  "exclude": ["node_modules", "**/__tests__/*"]
-}
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "declaration": true,
+    "esModuleInterop": true,
+    "outDir": "dist",
+    "strict": false,
+    "experimentalDecorators": true,
+    "strictPropertyInitialization": false,
+    "noImplicitAny": false,
+    "emitDecoratorMetadata": true,
+    "skipLibCheck": true,
+    "moduleResolution": "node",
+    "lib": [
+      "es5",
+      "ES2015",
+      "ES2016",
+      "ES2017",
+      "ES2020",
+      "dom",
+      "esnext.asynciterable"
+    ],
+    "types": ["node"]
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "**/__tests__/*"]
+}

package/tsconfig.json

@@ -1,31 +1,32 @@
-{
-  "compilerOptions": {
-    "target": "es2017",
-    "module": "esnext",
-    "declaration": true,
-    "esModuleInterop": true,
-    "outDir": "./lib",
-    "strict": false,
-    "experimentalDecorators": true,
-    "strictPropertyInitialization": false,
-    "noImplicitAny": false,
-    "emitDecoratorMetadata": true,
-    "skipLibCheck": true,
-    "moduleResolution": "node",
-    "lib": [
-      "es5",
-      "ES2015",
-      "ES2016",
-      "ES2017",
-      "dom",
-      "esnext.asynciterable"
-    ],
-  },
-  "include": [
-    "src"
-  ],
-  "exclude": [
-    "node_modules",
-    "**/__tests__/*"
-  ]
+{
+  "compilerOptions": {
+    "target": "es2017",
+    "module": "esnext",
+    "declaration": true,
+    "esModuleInterop": true,
+    "outDir": "./lib",
+    "strict": false,
+    "experimentalDecorators": true,
+    "strictPropertyInitialization": false,
+    "noImplicitAny": false,
+    "emitDecoratorMetadata": true,
+    "skipLibCheck": true,
+    "moduleResolution": "node",
+    "lib": [
+      "es5",
+      "ES2015",
+      "ES2016",
+      "ES2017",
+      "ES2020",
+      "dom",
+      "esnext.asynciterable"
+    ]
+  },
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "node_modules",
+    "**/__tests__/*"
+  ]
 }

package/templates/typescript/actions/handler.ts

@@ -1,62 +0,0 @@
-import { login } from '@contrail/sdk';
-import { Logger } from './utils/logger';
-
-export async function execute(data) {
-  const logger = new Logger();
-  const event = (typeof data.event === 'string')
-    ? JSON.parse(data.event)
-    : data.event;
-  data = JSON.parse(JSON.stringify(data));
-  logger.log(JSON.stringify(data, null, 2));
-  if (!data.apiHost || !data.userName || !data.password) {
-    // not really. This is just to demo how to retrieve an app config
-    const message = 'This action requires an api host, a username, and a password to run';
-    const body = {
-      message,
-      logs: [message]
-    };
-    return {
-      statusCode: 400,
-      body
-    };
-  }
-
-  try {
-    await login({ apiKey: data.apiKey, orgSlug: data.orgSlug });
-    const results = {};
-
-    logger.log('Sending message: ', event);
-    const response = await fetch(data.apiHost, {
-      headers: { 'Content-Type': 'application/json' }
-    });
-    if (!response.ok) {
-      logger.log('Webhook event failed to publish');
-    }
-    else {
-      logger.log('Published!');
-    }
-    logger.log('Response: ', JSON.stringify(response));
-
-    results['logs'] = logger.getEntries();
-
-    logger.log('returning: ' + JSON.stringify(results));
-    return {
-      statusCode: 200,
-      body: JSON.stringify(results)
-    };
-
-  } catch (e) {
-    logger.log('returning failure: ' + e.message);
-    const body = {
-      message: 'failed',
-      error: e.message,
-      logs: logger.getEntries()
-    };
-
-    return {
-      statusCode: 400,
-      body: JSON.stringify(body),
-    };
-  }
-
-}

package/templates/typescript/actions/utils/logger.ts

@@ -1,15 +0,0 @@
-export class Logger {
-  allEntries = [];
-  public log(...args){
-    console.log(...args);
-    this.allEntries.push(args);
-  }
-
-  public getEntries(){
-    return this.allEntries.join('\n');
-  }
-
-  public clearEntries(){
-    this.allEntries = [];
-  }
-}