@codiac.io/codiac-cli 1.2.234 → 1.2.236

package/dist/uilogic/lrp-watcher-predef.js

@@ -0,0 +1,157 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LrpWatcherPredef = void 0;
+const tslib_1 = require("tslib");
+const inversify_1 = require("inversify");
+const listr2_1 = require("listr2");
+const codiac_common_1 = require("@codiac.io/codiac-common");
+const contracts_1 = require("@codiac.io/codiac-common/contracts");
+const contracts_2 = require("../apis/codiac-relay/contracts");
+const relay_websocket_client_1 = require("../relay/wsclient/relay-websocket-client");
+const relay_queue_manager_1 = require("../relay/wsclient/relay-queue-manager");
+const _ = require("lodash");
+const lrp_watcher_utils_1 = require("./lrp-watcher-utils");
+/** Triggers and renders real time status for a Long Running Process using a predefined call tree.
+ *
+ * That is, it fires an async request to trigger the process,
+ * then monitors a socket for real time status messages,
+ * and renders them in sequential order.
+ */
+let LrpWatcherPredef = class LrpWatcherPredef {
+    constructor(relayWebSocket, logger) {
+        this.relayWebSocket = relayWebSocket;
+        this.logger = logger;
+        this.qmgr = new relay_queue_manager_1.QueueManager();
+    }
+    removeStatusListeners() {
+        let closed = false;
+        if (this.relayWebSocket) {
+            closed = closed && this.relayWebSocket.unlisten(lrp_watcher_utils_1.LrpWatcherUtils.STATUS_MSG_TYPE, this.statusHandlerId);
+        }
+        return closed;
+    }
+    triggerAndWatch(trigger) {
+        var _a, _b;
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            let result = new contracts_1.Result(false);
+            try {
+                let socketId = yield this.relayWebSocket.open();
+                this.statusHandlerId = this.relayWebSocket.listenFor(lrp_watcher_utils_1.LrpWatcherUtils.STATUS_MSG_TYPE, (msg) => {
+                    // gotta queue these to prevent msg loss due to 
+                    // client-server latency in triggering each task watcher 
+                    // (server may send messages before the local client task starts listening).
+                    let status = msg.payload;
+                    this.qmgr.push(msg, status.opCode); // todo: consider prefixing with "<CorrelationId>."
+                });
+                // TODO: Make this the first task in the taskMap
+                let ack = yield this.invokeOperation(socketId, trigger);
+                let statusView = yield this.buildStatusView(ack.taskMap);
+                let finalCtx = yield statusView.run();
+                result = finalCtx.result;
+            }
+            catch (err) {
+                this.logger.error((_a = err.message) !== null && _a !== void 0 ? _a : err.stack);
+                result.error = err;
+                result.message = (_b = err.message) !== null && _b !== void 0 ? _b : "Error executing operation: See logs for details";
+            }
+            finally {
+                yield this.relayWebSocket.close();
+                return result;
+            }
+        });
+    }
+    /** Throws when not successful or when no ack is returned. */
+    invokeOperation(socketId, trigger) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            let ackResult = yield trigger(socketId);
+            if (ackResult.success != true) {
+                let logMsg = "Failed invoking operation ".concat("[CID ", (_b = (_a = ackResult.output) === null || _a === void 0 ? void 0 : _a.correlationId) !== null && _b !== void 0 ? _b : "none", "]: ", (_g = (_e = (_c = ackResult.message) !== null && _c !== void 0 ? _c : (_d = ackResult.error) === null || _d === void 0 ? void 0 : _d.message) !== null && _e !== void 0 ? _e : (_f = ackResult.error) === null || _f === void 0 ? void 0 : _f.stack) !== null && _g !== void 0 ? _g : "no details available");
+                this.logger.error(logMsg, ackResult.error);
+                let friendlyMsg = "Failed invoking operation: ".concat((_k = (_h = ackResult.message) !== null && _h !== void 0 ? _h : (_j = ackResult.error) === null || _j === void 0 ? void 0 : _j.message) !== null && _k !== void 0 ? _k : "See logs for details");
+                throw new Error(friendlyMsg);
+            }
+            else if (ackResult.output == undefined) {
+                throw new Error("No acknowledgement received. ".concat((_l = ackResult.message) !== null && _l !== void 0 ? _l : "").trimEnd());
+            }
+            return ackResult.output;
+        });
+    }
+    buildStatusView(taskMap) {
+        // Set up the Listr control
+        if (taskMap == undefined) {
+            throw new Error("No TaskMap provided");
+            // TODO: Wire up a LrpWatcher instead.
+        }
+        else {
+            // PERFERRED: Predefined task map with completion statuses
+            let statusUi = new listr2_1.Listr({
+                title: taskMap.opIngTitle,
+                task: (taskMap.tasks) ? (ctx, task) => {
+                    return task.newListr(taskMap.tasks.map(x => {
+                        return {
+                            title: x.opIngTitle,
+                            rendererOptions: { outputBar: true },
+                            task: (ctx, tx) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                                return new Promise((resolve, reject) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                                    // subscribe to our queue
+                                    this.qmgr.subscribeTo(x.opCode, (msg) => {
+                                        if (msg.payload) {
+                                            let status = msg.payload;
+                                            if (status.state == contracts_2.OperationStateEnum.Completed) {
+                                                tx.task.complete();
+                                                // TODO: address status.completionCode and status.message
+                                                ctx.result = lrp_watcher_utils_1.LrpWatcherUtils.resultFromStatusMessage(status);
+                                                // Poor man's DRAIN
+                                                // TODO: drain the socket messages and the Listr tasks before we close up shop
+                                                setTimeout(() => {
+                                                    this.removeStatusListeners();
+                                                    if (ctx.result.error) {
+                                                        reject(ctx.result.error);
+                                                    }
+                                                    else {
+                                                        resolve();
+                                                    }
+                                                }, 1000);
+                                            }
+                                            else {
+                                                if (status.message != undefined && !_.isEmpty(status.message)) {
+                                                    tx.output = status.message;
+                                                }
+                                            }
+                                        }
+                                        else {
+                                            // no payload; ignore as a ping or heartbeat
+                                        }
+                                    }); // Perhaps this handler can be absorbed into the qmgr?
+                                    // pull any existing from our queue
+                                    // if complete, close the task
+                                    // else, render output
+                                }));
+                                // await delay(1500);
+                                // return;              }
+                            })
+                        };
+                    }), {
+                        concurrent: false,
+                        rendererOptions: { collapseSubtasks: false }
+                    });
+                } : /* no sub tasks */ (ctx, task) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                    // TODO: subscribe to opCode queue
+                    yield (0, listr2_1.delay)(1500);
+                    return;
+                })
+            });
+            return statusUi;
+            // this._ui.userMessage(`Execution completed.`);
+        }
+    }
+};
+LrpWatcherPredef = tslib_1.__decorate([
+    (0, inversify_1.injectable)(),
+    tslib_1.__param(0, (0, inversify_1.inject)(relay_websocket_client_1.RelayWebsocketClient)),
+    tslib_1.__param(1, (0, inversify_1.inject)(codiac_common_1.INTERFACES.IBetterLogger)),
+    tslib_1.__metadata("design:paramtypes", [relay_websocket_client_1.RelayWebsocketClient, Object])
+], LrpWatcherPredef);
+exports.LrpWatcherPredef = LrpWatcherPredef;
+//# sourceMappingURL=lrp-watcher-predef.js.map

package/dist/uilogic/lrp-watcher-predef.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lrp-watcher-predef.js","sourceRoot":"","sources":["../../src/uilogic/lrp-watcher-predef.ts"],"names":[],"mappings":";;;;AAAA,yCAA+C;AAC/C,mCAAoD;AACpD,4DAAqE;AACrE,kEAA0E;AAC1E,8DAAqJ;AACrJ,qFAAgF;AAEhF,+EAAqE;AACrE,4BAA6B;AAC7B,2DAAuF;AAGvF;;;;;GAKG;AAEI,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAE3B,YACwC,cAAoC,EAChC,MAAqB;QADzB,mBAAc,GAAd,cAAc,CAAsB;QAChC,WAAM,GAAN,MAAM,CAAe;QAE/D,IAAI,CAAC,IAAI,GAAG,IAAI,kCAAY,EAAE,CAAC;IACjC,CAAC;IAOO,qBAAqB;QAC3B,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,MAAM,GAAG,MAAM,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,mCAAe,CAAC,eAAe,EAAE,IAAI,CAAC,eAAgB,CAAC,CAAC;SACzG;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAGY,eAAe,CAAyB,OAAqB;;;YACxE,IAAI,MAAM,GAAG,IAAI,kBAAM,CAAC,KAAK,CAAC,CAAC;YAC/B,IAAI;gBACF,IAAI,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;gBAEhD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,mCAAe,CAAC,eAAe,EAAE,CAAC,GAAiB,EAAE,EAAE;oBAC1G,gDAAgD;oBAChD,yDAAyD;oBACzD,4EAA4E;oBAC5E,IAAI,MAAM,GAAG,GAAG,CAAC,OAA0B,CAAC;oBAC5C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAE,mDAAmD;gBAC1F,CAAC,CAAC,CAAC;gBAEH,gDAAgD;gBAChD,IAAI,GAAG,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;gBAEvD,IAAI,UAAU,GAAG,MAAM,IAAI,CAAC,eAAe,CAAU,GAAG,CAAC,OAAO,CAAC,CAAC;gBAClE,IAAI,QAAQ,GAAG,MAAM,UAAU,CAAC,GAAG,EAAE,CAAC;gBACtC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;aAG1B;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAA,GAAG,CAAC,OAAO,mCAAI,GAAG,CAAC,KAAK,CAAC,CAAA;gBAC3C,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC;gBACnB,MAAM,CAAC,OAAO,GAAG,MAAA,GAAG,CAAC,OAAO,mCAAI,iDAAiD,CAAC;aAEnF;oBAAS;gBACR,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;gBAClC,OAAO,MAAiB,CAAC;aAC1B;;KACF;IAGD,6DAA6D;IAC/C,eAAe,CAAyB,QAAgB,EAAE,OAAqB;;;YAC3F,IAAI,SAAS,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAC;YACxC,IAAI,SAAS,CAAC,OAAO,IAAI,IAAI,EAAE;gBAC7B,IAAI,MAAM,GAAG,4BAA4B,CAAC,MAAM,CAAC,OAAO,EAAE,MAAA,MAAA,SAAS,CAAC,MAAM,0CAAE,aAAa,mCAAI,MAAM,EAAE,KAAK,EAAE,MAAA,MAAA,MAAA,SAAS,CAAC,OAAO,mCAAI,MAAA,SAAS,CAAC,KAAK,0CAAE,OAAO,mCAAI,MAAA,SAAS,CAAC,KAAK,0CAAE,KAAK,mCAAI,sBAAsB,CAAC,CAAC;gBAC/M,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,KAAK,CAAC,CAAA;gBAC1C,IAAI,WAAW,GAAG,6BAA6B,CAAC,MAAM,CAAC,MAAA,MAAA,SAAS,CAAC,OAAO,mCAAI,MAAA,SAAS,CAAC,KAAK,0CAAE,OAAO,mCAAI,sBAAsB,CAAC,CAAC;gBAChI,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;aAC9B;iBAAM,IAAI,SAAS,CAAC,MAAM,IAAI,SAAS,EAAE;gBACxC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,MAAM,CAAC,MAAA,SAAS,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;aAC5F;YACD,OAAO,SAAS,CAAC,MAAM,CAAC;;KACzB;IAIO,eAAe,CAAyB,OAA6B;QAE3E,2BAA2B;QAC3B,IAAI,OAAO,IAAI,SAAS,EAAE;YACxB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;YACvC,sCAAsC;SACvC;aAAM;YAEL,0DAA0D;YAC1D,IAAI,QAAQ,GAAG,IAAI,cAAK,CAAkD;gBACxE,KAAK,EAAE,OAAO,CAAC,UAAU;gBACzB,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,EAA0D,EAAE;oBAE5F,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;wBAC1C,OAAO;4BACL,KAAK,EAAE,CAAC,CAAC,UAAU;4BACnB,eAAe,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE;4BACpC,IAAI,EAAE,CAAO,GAAG,EAAE,EAAE,EAAiB,EAAE;gCACrC,OAAO,IAAI,OAAO,CAAO,CAAO,OAAO,EAAE,MAAM,EAAE,EAAE;oCAEjD,yBAAyB;oCACzB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE;wCAEtC,IAAI,GAAG,CAAC,OAAO,EAAE;4CACf,IAAI,MAAM,GAAG,GAAG,CAAC,OAA0B,CAAC;4CAC5C,IAAI,MAAM,CAAC,KAAK,IAAI,8BAAkB,CAAC,SAAS,EAAE;gDAChD,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;gDACnB,yDAAyD;gDACzD,GAAG,CAAC,MAAM,GAAG,mCAAe,CAAC,uBAAuB,CAAC,MAAM,CAAY,CAAC;gDAExE,mBAAmB;gDACnB,8EAA8E;gDAC9E,UAAU,CAAC,GAAG,EAAE;oDACd,IAAI,CAAC,qBAAqB,EAAE,CAAC;oDAC7B,IAAI,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE;wDACpB,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;qDAC1B;yDAAM;wDACL,OAAO,EAAE,CAAC;qDACX;gDACH,CAAC,EAAE,IAAI,CAAC,CAAC;6CAEV;iDAAM;gDACL,IAAI,MAAM,CAAC,OAAO,IAAI,SAAS,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;oDAC7D,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC;iDAC5B;6CACF;yCAEF;6CAAM;4CACL,4CAA4C;yCAC7C;oCAIH,CAAC,CAAC,CAAC,CAAE,sDAAsD;oCAE3D,mCAAmC;oCAEnC,8BAA8B;oCAC9B,sBAAsB;gCAGxB,CAAC,CAAA,CAAC,CAAC;gCACH,qBAAqB;gCACrB,yBAAyB;4BAC3B,CAAC,CAAA;yBACF,CAAA;oBACH,CAAC,CAAC,EAAE;wBACF,UAAU,EAAE,KAAK;wBACjB,eAAe,EAAE,EAAE,gBAAgB,EAAE,KAAK,EAAE;qBAC7C,CAAC,CAAC;gBAEL,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAO,GAAG,EAAE,IAAI,EAAiB,EAAE;oBACxD,kCAAkC;oBAClC,MAAM,IAAA,cAAK,EAAC,IAAI,CAAC,CAAC;oBAClB,OAAO;gBACT,CAAC,CAAA;aACF,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;YAChB,gDAAgD;SAEjD;IACH,CAAC;CACF,CAAA;AA1JY,gBAAgB;IAD5B,IAAA,sBAAU,GAAE;IAIR,mBAAA,IAAA,kBAAM,EAAC,6CAAoB,CAAC,CAAA;IAC5B,mBAAA,IAAA,kBAAM,EAAC,0BAAU,CAAC,aAAa,CAAC,CAAA;6CADqB,6CAAoB;GAHjE,gBAAgB,CA0J5B;AA1JY,4CAAgB"}

package/dist/uilogic/lrp-watcher-utils.d.ts

@@ -0,0 +1,16 @@
+import { Result, SingleResult } from "@codiac.io/codiac-common/contracts";
+import { OperationStatus, AsyncAck } from "../apis/codiac-relay/contracts";
+/** A function expression that invokes a long running process
+ * (without waiting for it to complete)
+ * and returns an immediate acknowledgement. */
+export type AsyncTrigger = (socketId: string) => Promise<SingleResult<AsyncAck>>;
+export type StatusViewContext<TResult extends Result> = {
+    values: any;
+    result: TResult;
+};
+/** Shared logic between LrpWatchers. */
+export declare abstract class LrpWatcherUtils {
+    /** The value of the `action` field in a SocketAction for status messages. */
+    static readonly STATUS_MSG_TYPE = "operationStatus";
+    static resultFromStatusMessage(status: OperationStatus): Result;
+}

package/dist/uilogic/lrp-watcher-utils.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LrpWatcherUtils = void 0;
+const contracts_1 = require("@codiac.io/codiac-common/contracts");
+const contracts_2 = require("../apis/codiac-relay/contracts");
+/** Shared logic between LrpWatchers. */
+class LrpWatcherUtils {
+    static resultFromStatusMessage(status) {
+        var _a, _b;
+        let result = new contracts_1.Result(false);
+        // success
+        result.success = Boolean(status.completionCode == contracts_2.OperationCompletionCodeEnum.Success);
+        // message
+        if (status.completionCode != contracts_2.OperationCompletionCodeEnum.Success) {
+            result.message = status.opCode.concat(" ", (_a = status.completionCode) !== null && _a !== void 0 ? _a : "", ": ", (_b = status.message) !== null && _b !== void 0 ? _b : "").trimEnd();
+        }
+        else if (status.message) {
+            result.message = status.message;
+        }
+        // error
+        if (status.completionCode == contracts_2.OperationCompletionCodeEnum.Failed) {
+            result.error = new Error(result.message);
+        }
+        return result;
+    }
+}
+exports.LrpWatcherUtils = LrpWatcherUtils;
+/** The value of the `action` field in a SocketAction for status messages. */
+LrpWatcherUtils.STATUS_MSG_TYPE = "operationStatus";
+//# sourceMappingURL=lrp-watcher-utils.js.map

package/dist/uilogic/lrp-watcher-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lrp-watcher-utils.js","sourceRoot":"","sources":["../../src/uilogic/lrp-watcher-utils.ts"],"names":[],"mappings":";;;AAAA,kEAA0E;AAC1E,8DAAwG;AAWxG,wCAAwC;AACxC,MAAsB,eAAe;IAM5B,MAAM,CAAC,uBAAuB,CAAC,MAAuB;;QAC3D,IAAI,MAAM,GAAG,IAAI,kBAAM,CAAC,KAAK,CAAC,CAAC;QAE/B,UAAU;QACV,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,IAAI,uCAA2B,CAAC,OAAO,CAAC,CAAC;QACvF,UAAU;QACV,IAAI,MAAM,CAAC,cAAc,IAAI,uCAA2B,CAAC,OAAO,EAAE;YAChE,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAA,MAAM,CAAC,cAAc,mCAAI,EAAE,EAAE,IAAI,EAAE,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SAC/G;aAAM,IAAI,MAAM,CAAC,OAAO,EAAE;YACzB,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;SACjC;QACD,QAAQ;QACR,IAAI,MAAM,CAAC,cAAc,IAAI,uCAA2B,CAAC,MAAM,EAAE;YAC/D,MAAM,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;SAC1C;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;;AAvBH,0CA0BC;AAxBC,6EAA6E;AACtD,+BAAe,GAAG,iBAAiB,CAAC"}

package/dist/uilogic/lrp-watcher.d.ts

@@ -0,0 +1,22 @@
+import { IBetterLogger } from "@codiac.io/codiac-common";
+import { SingleResult, Result } from '@codiac.io/codiac-common/contracts';
+import { AsyncAck } from '../apis/codiac-relay/contracts';
+import { RelayWebsocketClient } from "../relay/wsclient/relay-websocket-client";
+/** Triggers and renders real time status for Long Running Processes.
+ *
+ * That is, it fires an async request to trigger the process,
+ * then monitors a socket for real time status messages,
+ * and renders them in sequential order.
+ */
+export declare class LrpWatcher {
+    private relayWebSocket;
+    private logger;
+    constructor(relayWebSocket: RelayWebsocketClient, logger: IBetterLogger);
+    private statusHandlerId;
+    private removeStatusListeners;
+    /** Opens and closes its own web socket.
+     * Throws any errors.
+     * Renders all real time status messages as logs off the main operation.
+     */
+    triggerAndWatch<TResult extends Result, TContext extends object>(mainOpCode: string, opIngTitle: string, trigger: (socketId: string) => Promise<SingleResult<AsyncAck>>): Promise<TResult>;
+}

package/dist/uilogic/lrp-watcher.js

@@ -0,0 +1,143 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LrpWatcher = void 0;
+const tslib_1 = require("tslib");
+const inversify_1 = require("inversify");
+const listr2_1 = require("listr2");
+const codiac_common_1 = require("@codiac.io/codiac-common");
+const contracts_1 = require("../apis/codiac-relay/contracts");
+const relay_websocket_client_1 = require("../relay/wsclient/relay-websocket-client");
+const lrp_watcher_utils_1 = require("./lrp-watcher-utils");
+/** Triggers and renders real time status for Long Running Processes.
+ *
+ * That is, it fires an async request to trigger the process,
+ * then monitors a socket for real time status messages,
+ * and renders them in sequential order.
+ */
+let LrpWatcher = class LrpWatcher {
+    constructor(relayWebSocket, logger) {
+        this.relayWebSocket = relayWebSocket;
+        this.logger = logger;
+    }
+    // private setStatusHandlers(): void {
+    //   // this.spinners["operationStatus"] = ora("Cluster create interim status: ").start();
+    //   this.statusHandlerId = this.relayWebSocket.listenFor("operationStatus", msg => {
+    //     // this._ui.userMessage(`Cluster create interim status: ${JSON.stringify(msg.payload)}`);
+    //     // this.spinners?.add({
+    //     //   title: "interim from relay",
+    //     //   task: async (ctx, task): Promise<void> => {
+    //     //     task.output = "payload: ".concat(JSON.stringify(msg.payload));
+    //     //   }
+    //     //   // , rendererOptions: { outputBar: 1 }
+    //     // });
+    //   });
+    //   // this.completionHandlerId = this.relayWebSocket.listenFor("clusterCreateCompleted", msg => {
+    //   //   this.isCompleted = true;
+    //   //   // this.spinners["operationStatus"].succeed().suffixText = "Complete!";
+    //   //   this._ui.userMessage(`Cluster create completed ${JSON.stringify(msg.payload)}`);
+    //   //   this.removeStatusListeners();
+    //   // });
+    // }
+    removeStatusListeners() {
+        let closed = false;
+        if (this.relayWebSocket) {
+            closed = closed && this.relayWebSocket.unlisten(lrp_watcher_utils_1.LrpWatcherUtils.STATUS_MSG_TYPE, this.statusHandlerId);
+            // closed = closed && this.relayWebSocket.unlisten("clusterCreateCompleted", this.completionHandlerId!);
+        }
+        return closed;
+    }
+    /** Opens and closes its own web socket.
+     * Throws any errors.
+     * Renders all real time status messages as logs off the main operation.
+     */
+    triggerAndWatch(mainOpCode, opIngTitle, trigger) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            let spinners = new listr2_1.Listr({
+                title: opIngTitle,
+                rendererOptions: { outputBar: Infinity, persistentOutput: true, timer: listr2_1.PRESET_TIMER },
+                task: (ctx, task) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                    return new Promise((resolve, reject) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+                        // 1. open real time status stream
+                        let commChannel;
+                        commChannel = {
+                            socketId: yield this.relayWebSocket.open() // .start()
+                        };
+                        // this.setStatusHandlers();
+                        this.statusHandlerId = this.relayWebSocket.listenFor(lrp_watcher_utils_1.LrpWatcherUtils.STATUS_MSG_TYPE, msg => {
+                            var _a, _b, _c, _d, _e, _f;
+                            if (msg.payload) {
+                                let statusMsg = msg.payload;
+                                // COMPLETION STATUS
+                                if (statusMsg.opCode == mainOpCode && statusMsg.state == contracts_1.OperationStateEnum.Completed) {
+                                    task.output = "".concat((_b = (_a = statusMsg.completionCode) !== null && _a !== void 0 ? _a : statusMsg.message) !== null && _b !== void 0 ? _b : statusMsg.state, "!");
+                                    task.title = task.title.concat("...", (_c = statusMsg.completionCode) !== null && _c !== void 0 ? _c : statusMsg.state);
+                                    task.task.complete();
+                                    ctx.res = lrp_watcher_utils_1.LrpWatcherUtils.resultFromStatusMessage(statusMsg);
+                                    // Poor man's DRAIN
+                                    // TODO: drain the socket messages and the Listr tasks before we close up shop
+                                    setTimeout(() => {
+                                        this.removeStatusListeners();
+                                        if (result.error) {
+                                            reject(result.error);
+                                        }
+                                        else {
+                                            resolve();
+                                        }
+                                    }, 1000);
+                                }
+                                else {
+                                    if (statusMsg.state == contracts_1.OperationStateEnum.Completed) {
+                                        task.output = statusMsg.opIngTitle.concat("...", (_d = statusMsg.completionCode) !== null && _d !== void 0 ? _d : statusMsg.state, " ", (_e = statusMsg.message) !== null && _e !== void 0 ? _e : "").trimEnd();
+                                    }
+                                    else {
+                                        task.output = statusMsg.opIngTitle.concat("...", (_f = statusMsg.message) !== null && _f !== void 0 ? _f : "").trimEnd();
+                                    }
+                                }
+                            }
+                            else {
+                                // No payload - ignore as a ping/heartbeat
+                                task.output = JSON.stringify(msg);
+                            }
+                        });
+                        // 2. Fire off the async cluster create
+                        // this._ui.userMessage(`(CLI says, Starting cluster create...`);
+                        task.output = "Invoking operation...";
+                        let result = yield trigger(commChannel.socketId);
+                        if (result.success) {
+                            // 3. listen for real time status (and wait for final result)
+                            // await this.monitorExecution(result.output?.taskMap);
+                        }
+                        else {
+                            let logMsg = "Failed invoking operation ".concat(mainOpCode, " [CID ", (_b = (_a = result.output) === null || _a === void 0 ? void 0 : _a.correlationId) !== null && _b !== void 0 ? _b : "none", "]: ", (_g = (_e = (_c = result.message) !== null && _c !== void 0 ? _c : (_d = result.error) === null || _d === void 0 ? void 0 : _d.message) !== null && _e !== void 0 ? _e : (_f = result.error) === null || _f === void 0 ? void 0 : _f.stack) !== null && _g !== void 0 ? _g : "no details available");
+                            this.logger.error(logMsg, result.error);
+                            let friendlyMsg = "Failed invoking operation: ".concat((_k = (_h = result.message) !== null && _h !== void 0 ? _h : (_j = result.error) === null || _j === void 0 ? void 0 : _j.message) !== null && _k !== void 0 ? _k : "See logs for details");
+                            // Close up shop and throw
+                            // task.output = friendlyMsg;
+                            task.task.complete();
+                            result.message = friendlyMsg;
+                            ctx.res = result;
+                            this.removeStatusListeners();
+                            reject(result); // <-- result is getting treated like an Error.  Ok, cuz we want to send out the friendly message
+                        }
+                    }));
+                })
+            }, {
+                renderer: 'default',
+                rendererOptions: { timer: listr2_1.PRESET_TIMER }
+            });
+            let taskResult = yield (spinners === null || spinners === void 0 ? void 0 : spinners.run()); // we're not going to await because we cant block execution (we havent fired the actual task yet)
+            // this._ui.userMessage("CLI says, spinner task ended. ".concat(JSON.stringify(taskResult)));
+            yield this.relayWebSocket.close();
+            // return <TResult>{ success: true, message: "Process execution completed" };  // TODO: Capture the result from the completion status message
+            return taskResult.res;
+        });
+    }
+};
+LrpWatcher = tslib_1.__decorate([
+    (0, inversify_1.injectable)(),
+    tslib_1.__param(1, (0, inversify_1.inject)(codiac_common_1.INTERFACES.IBetterLogger)),
+    tslib_1.__metadata("design:paramtypes", [relay_websocket_client_1.RelayWebsocketClient, Object])
+], LrpWatcher);
+exports.LrpWatcher = LrpWatcher;
+//# sourceMappingURL=lrp-watcher.js.map

package/dist/uilogic/lrp-watcher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lrp-watcher.js","sourceRoot":"","sources":["../../src/uilogic/lrp-watcher.ts"],"names":[],"mappings":";;;;AAAA,yCAA+C;AAC/C,mCAA6C;AAC7C,4DAAqE;AAErE,8DAA4I;AAC5I,qFAAgF;AAChF,2DAAsD;AAGtD;;;;;GAKG;AAEI,IAAM,UAAU,GAAhB,MAAM,UAAU;IAErB,YACU,cAAoC,EACF,MAAqB;QADvD,mBAAc,GAAd,cAAc,CAAsB;QACF,WAAM,GAAN,MAAM,CAAe;IAGjE,CAAC;IAMD,sCAAsC;IAEtC,0FAA0F;IAE1F,qFAAqF;IACrF,gGAAgG;IAEhG,8BAA8B;IAC9B,wCAAwC;IACxC,uDAAuD;IACvD,4EAA4E;IAC5E,aAAa;IACb,kDAAkD;IAClD,aAAa;IAGb,QAAQ;IAER,mGAAmG;IACnG,kCAAkC;IAClC,iFAAiF;IACjF,0FAA0F;IAC1F,uCAAuC;IACvC,WAAW;IACX,IAAI;IAGI,qBAAqB;QAC3B,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,MAAM,GAAG,MAAM,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,mCAAe,CAAC,eAAe,EAAE,IAAI,CAAC,eAAgB,CAAC,CAAC;YACxG,wGAAwG;SACzG;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAGD;;;OAGG;IACU,eAAe,CAAkD,UAAkB,EAAE,UAAkB,EAAE,OAA8D;;YAGlL,IAAI,QAAQ,GAAG,IAAI,cAAK,CACtB;gBACE,KAAK,EAAE,UAAU;gBACjB,eAAe,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,gBAAgB,EAAE,IAAI,EAAE,KAAK,EAAE,qBAAY,EAAE;gBACrF,IAAI,EAAE,CAAO,GAAG,EAAE,IAAI,EAAiB,EAAE;oBACvC,OAAO,IAAI,OAAO,CAAO,CAAO,OAAO,EAAE,MAAM,EAAE,EAAE;;wBAEjD,kCAAkC;wBAClC,IAAI,WAA2B,CAAC;wBAChC,WAAW,GAAG;4BACZ,QAAQ,EAAE,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAE,WAAW;yBACxD,CAAC;wBAEF,4BAA4B;wBAC5B,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,mCAAe,CAAC,eAAe,EAAE,GAAG,CAAC,EAAE;;4BAC1F,IAAI,GAAG,CAAC,OAAO,EAAE;gCACf,IAAI,SAAS,GAAG,GAAG,CAAC,OAA0B,CAAC;gCAE/C,oBAAoB;gCACpB,IAAI,SAAS,CAAC,MAAM,IAAI,UAAU,IAAI,SAAS,CAAC,KAAK,IAAI,8BAAkB,CAAC,SAAS,EAAE;oCACrF,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,MAAM,CAAC,MAAA,MAAA,SAAS,CAAC,cAAc,mCAAI,SAAS,CAAC,OAAO,mCAAI,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;oCAC/F,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,MAAA,SAAS,CAAC,cAAc,mCAAI,SAAS,CAAC,KAAK,CAAC,CAAC;oCACnF,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;oCAErB,GAAG,CAAC,GAAG,GAAG,mCAAe,CAAC,uBAAuB,CAAC,SAAS,CAAY,CAAC;oCAExE,mBAAmB;oCACnB,8EAA8E;oCAC9E,UAAU,CAAC,GAAG,EAAE;wCACd,IAAI,CAAC,qBAAqB,EAAE,CAAC;wCAC7B,IAAI,MAAM,CAAC,KAAK,EAAE;4CAChB,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;yCACtB;6CAAM;4CACL,OAAO,EAAE,CAAC;yCACX;oCACH,CAAC,EAAE,IAAI,CAAC,CAAC;iCAEV;qCAAM;oCACL,IAAI,SAAS,CAAC,KAAK,IAAI,8BAAkB,CAAC,SAAS,EAAE;wCACnD,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,MAAA,SAAS,CAAC,cAAc,mCAAI,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,MAAA,SAAS,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;qCACvI;yCAAM;wCACL,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,MAAA,SAAS,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;qCACrF;iCACF;6BACF;iCAAM;gCACL,0CAA0C;gCAC1C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;6BACnC;wBACH,CAAC,CAAC,CAAC;wBAEH,uCAAuC;wBACvC,iEAAiE;wBACjE,IAAI,CAAC,MAAM,GAAG,uBAAuB,CAAC;wBACtC,IAAI,MAAM,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;wBACjD,IAAI,MAAM,CAAC,OAAO,EAAE;4BAClB,6DAA6D;4BAC7D,uDAAuD;yBACxD;6BAAM;4BACL,IAAI,MAAM,GAAG,4BAA4B,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAA,MAAA,MAAM,CAAC,MAAM,0CAAE,aAAa,mCAAI,MAAM,EAAE,KAAK,EAAE,MAAA,MAAA,MAAA,MAAM,CAAC,OAAO,mCAAI,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,mCAAI,MAAA,MAAM,CAAC,KAAK,0CAAE,KAAK,mCAAI,sBAAsB,CAAC,CAAC;4BAChN,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAA;4BACvC,IAAI,WAAW,GAAG,6BAA6B,CAAC,MAAM,CAAC,MAAA,MAAA,MAAM,CAAC,OAAO,mCAAI,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,mCAAI,sBAAsB,CAAC,CAAC;4BAE1H,0BAA0B;4BAC1B,6BAA6B;4BAC7B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;4BACrB,MAAM,CAAC,OAAO,GAAG,WAAW,CAAC;4BAC7B,GAAG,CAAC,GAAG,GAAG,MAAiB,CAAC;4BAE5B,IAAI,CAAC,qBAAqB,EAAE,CAAC;4BAC7B,MAAM,CAAC,MAAiB,CAAC,CAAC,CAAC,iGAAiG;yBAC7H;oBAEH,CAAC,CAAA,CAAC,CAAC;gBAEL,CAAC,CAAA;aACF,EAED;gBACE,QAAQ,EAAE,SAAS;gBACnB,eAAe,EAAE,EAAE,KAAK,EAAE,qBAAY,EAAE;aACzC,CACF,CAAC;YACF,IAAI,UAAU,GAAG,MAAM,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,GAAG,EAAE,CAAA,CAAC,CAAE,iGAAiG;YAE1I,6FAA6F;YAC7F,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;YAElC,6IAA6I;YAC7I,OAAO,UAAU,CAAC,GAAI,CAAC;QACzB,CAAC;KAAA;CACF,CAAA;AAnJY,UAAU;IADtB,IAAA,sBAAU,GAAE;IAKR,mBAAA,IAAA,kBAAM,EAAC,0BAAU,CAAC,aAAa,CAAC,CAAA;6CADT,6CAAoB;GAHnC,UAAU,CAmJtB;AAnJY,gCAAU"}

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.234",
+  "version": "1.2.236",
   "commands": {
     "branch": {
       "id": "branch",
@@ -4916,6 +4916,7 @@
       "pluginName": "@codiac.io/codiac-cli",
       "pluginAlias": "@codiac.io/codiac-cli",
       "pluginType": "core",
+      "hidden": true,
       "aliases": [],
       "flags": {
         "help": {
@@ -5447,6 +5448,17 @@
           "required": false,
           "multiple": false
         },
+        "provider": {
+          "name": "provider",
+          "type": "option",
+          "description": "Cloud service provider on which to provision the cluster",
+          "required": false,
+          "multiple": false,
+          "options": [
+            "azure",
+            "aws"
+          ]
+        },
         "providerSubscription": {
           "name": "providerSubscription",
           "type": "option",
@@ -5697,7 +5709,7 @@
     },
     "noc:cluster:forget": {
       "id": "noc:cluster:forget",
-      "description": "Permanently removes the record of a cluster.  This command does NOT affect any infrastructure; it simply removes the cluster from the Codiac consciousness.  Use `cod cluster capture` to re-acquire an existing but forgotten cluster.  You must remove all cabinets and environments in a cluster before forgetting it.",
+      "description": "Permanently removes the record of a cluster.  This command does NOT affect any infrastructure; it simply removes the cluster from the Codiac consciousness. You must remove all cabinets and environments in a cluster before forgetting it.",
       "strict": true,
       "pluginName": "@codiac.io/codiac-cli",
       "pluginAlias": "@codiac.io/codiac-cli",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codiac.io/codiac-cli",
   "description": "Local command line interface for registering and maintaining enterprise assets and pipelines",
-  "version": "1.2.234",
+  "version": "1.2.236",
   "author": "Codiac",
   "bin": {
     "codiac": "./bin/run",
@@ -30,7 +30,7 @@
     "@codiac.io/api-client-base": "^1.1.15",
     "@codiac.io/cli-tools": "^1.1.10",
     "@codiac.io/codiac-common": "^1.1.76",
-    "@codiac.io/codiac-domain": "^1.3.23",
+    "@codiac.io/codiac-domain": "^1.3.28",
     "@codiac.io/codiac-ops-common": "^1.1.87",
     "@codiac.io/codiac-relay-contracts": "^1.2.17",
     "@codiac.io/jwt-lib": "^1.1.6",
@@ -60,7 +60,9 @@
     "inversify": "^5.1.1",
     "json-stringify-safe": "^5.0.1",
     "jsonpath-plus": "^5.0.7",
+    "jsonschema": "^1.4.1",
     "kubernetes-client": "^8.3.7",
+    "listr2": "^7.0.2",
     "lodash": "^4.17.21",
     "log-update": "^4.0.0",
     "log4js": "^6.7.0",