c0ckp1t 1.0.0

package/core/Island.mjs

@@ -0,0 +1,429 @@
+/**
+ * Important that you assigned it to the registry before you init it
+ *
+ */
+// ________________________________________________________________________________
+// IMPORT
+// ________________________________________________________________________________
+import {markRaw, reactive, watch, defineAsyncComponent, getCurrentInstance} from 'vue'
+import {ok, nok, sha1} from "JsUtils"
+import {getLogger} from 'Logging';
+import Constants from "Constants";
+import Connection from "./ws-client/Connection.mjs";
+
+import {indexOfNonString} from "JsUtils";
+import {fromBinary, fromByteArray, Http} from "WsUtils";
+
+const {map, pipe, takeWhile, filter, take, distinctUntilChanged, tap} = rxjs.operators;
+const {throwError} = rxjs;
+
+// ________________________________________________________________________________
+// Default Island
+// ________________________________________________________________________________
+/**
+ *  state
+ *      isLoading
+ *      isReady
+ *  store
+ *      id
+ *  connection
+ */
+export default class Island {
+
+    /**
+     *
+     * @param config
+     *   instanceId
+     *
+     * @param apiMain
+     */
+    constructor(apiMain, config) {
+
+        this.instanceId = config.instanceId
+
+        this.LOG_HEADER = `${this.instanceId}`;
+        this.logger = getLogger(this.LOG_HEADER);
+        this.logger.debug('[INIT]');
+
+        this.connection = new Connection(config)
+
+        // ________________________________________________________________________________
+        // STATE - NOT saved in browser storage
+        // ________________________________________________________________________________
+        this.state = reactive({
+            isLoading: false,
+            isReady: false,
+        })
+
+        // ________________________________________________________________________________
+        // STORE - saved in browser storage
+        // ________________________________________________________________________________
+        this.store = reactive({
+            id: this.LOG_HEADER,
+            updated: null,
+
+            showRegistry: true,
+            root: null,
+            selectedNode: null,
+        })
+
+        this.sfcOptions = config.sfcOptions
+        this.apiMain = apiMain
+
+    } // end of constructor
+
+    // ________________________________________________________________________________
+    // NODE METHODS
+    // ________________________________________________________________________________
+    routeByEndpoint = async (endpoint) => {
+        this.logger.debug(`routeByEndpoint - endpoint=${endpoint}`);
+        await this.apiMain.routeByEndpoint(`/${this.instanceId}${endpoint}`);
+    }
+
+    /**
+     * Select the default dashboard (root).
+     * @returns {Promise<void>}
+     */
+    selectDefaultDashboard = async () => {
+        await this.apiMain.routerPush(`/${this.instanceId}`);
+    }
+
+    /**
+     * Select a node and navigate to its endpoint.
+     * A node has:
+     *   - endpoint = "/documentation"
+     *   - name = "documentation"
+     * @param {Object} node
+     * @returns {Promise<void>}
+     */
+    selectNode = async (node) => {
+        this.logger.info(`selectNode - node.endpoint=${node.endpoint}`);
+        // this.apiMain.
+        this.store.selectedNode = null;
+        this.store.selectedNode = node;
+        await this.routeByEndpoint(node.endpoint);
+    }
+
+    // ________________________________________________________________________________
+    // CONNECTION MANAGEMENT
+    // ________________________________________________________________________________
+    async connect() {
+        this.logger.info("[connect] - start ...");
+        const res = await this.connection.connect();
+        this.logger.info(`[connect] - res=${res}`);
+
+        await this.userContext();
+        // await this.userSettings();
+        await this.rootNode();
+
+        // if (this.store.context?.accessLevel < 500) {
+        //     await this.subscribeToNotify();
+        // }
+
+        // const currentRoute = router.currentRoute.value;
+        // this.logger.info(`Current route: ${currentRoute.fullPath}`);
+
+        // if (currentRoute.fullPath === '/') {
+        //     await this.routeByEndpoint(this.store.settings.defaultEndpoint);
+        // }
+    }
+
+    async disconnect() {
+        this.logger.info("[disconnect]");
+        return this.connection.disconnect();
+    }
+
+    // ________________________________________________________________________________
+    // USER API
+    // ________________________________________________________________________________
+    userContext = async () => {
+        const resp = await this.exec('/user', ["userContext"])
+        this.logger.debug(resp)
+        if (!resp.isOk) {
+            this.logger.warn(`[${this.store.id}] - userContext failed`, `${resp.result}`)
+            return this.store.context
+        }
+        this.store.context = JSON.parse(resp.result)
+        return this.store.context
+    }
+    /**
+     * Fetch and set the root node.
+     * @returns {Promise<void>}
+     */
+    rootNode = async () => {
+        this.logger.debug('[rootNode]');
+        this.logger.debug(`[rootNode] - exec('/', [infoNode])`);
+        const resp = await this.exec("/", ["infoNode"]);
+        this.logger.debug(resp);
+        if (!resp.isOk) {
+            this.logger.error(resp.result);
+            return;
+        }
+
+        const rootNode = JSON.parse(resp.result);
+        adjustNode(rootNode)
+        this.logger.debug("rootNode:");
+        this.logger.debug(rootNode);
+
+        // Note: possibly mutates rootNode
+        await this._initializeRootNode(rootNode);
+        // adjustNode(rootNode)
+
+        this.store.root = rootNode;
+    }
+
+
+    _initializeRootNode = async (node) => {
+        node._expanded = node.expanded;
+        node.store = {};
+        if (node.config && typeof node.config.path === "string") {
+            this.logger.debug(`[node=${node.name}] - loading=${node.config.path}`)
+            const args = ["read", node.config.path];
+            const res = await this.exec("/sys/resolver", args)
+            if (res.isOk) {
+                this.logger.debug(`[node=${node.name}] - load config=${node.config} -) ${res.result}`)
+                // TODO: warnign will not work if node.depth !== 1
+                const config = JSON.parse(res.result.replaceAll("##instanceId##", this.instanceId))
+                adjustConfig(config, this.instanceId)
+                await this.apiMain.insertRoutes(`/${this.instanceId}${node.endpoint}`, config)
+            } else {
+                this.logger.warn(`[node=${node.name}] - failed to load config`)
+                this.logger.warn(`endpoint=/${this.instanceId}${node.endpoint}`)
+                this.logger.warn(`depth=${node.depth}`)
+                this.logger.warn(`accessLevel=${this.store.context.accessLevel}`)
+                // This happens when i.e osgi doesn't have a config.json
+                // it tries to read it and fails
+                if (node.depth === 1) {
+                    if (this.store.context.accessLevel < 500 ) {
+                        await this.apiMain.insertRoutes(`/${this.instanceId}${node.endpoint}`,
+                                [{"path": node.name, "location": `/${this.instanceId}/v3/actions/root/admin/_admin.vue`}],
+                        )
+                    } else {
+                        await this.apiMain.insertRoutes(`/${this.instanceId}${node.endpoint}`,
+                            [{"path": node.name, "location": "/core/nodes/_api.vue"}]
+                        )
+                    }
+                }
+            }
+            // NO CONFIG FOUND
+        } else {
+            if (node.depth === 1) {
+                if (this.store.context.accessLevel < 500) {
+                    await this.apiMain.insertRoutes(`/${this.instanceId}${node.endpoint}`,
+                        [{"path": node.name, "location": `/${this.instanceId}/v3/actions/root/admin/_admin.vue`}],
+                    )
+                } else {
+                    await this.apiMain.insertRoutes(`/${this.instanceId}${node.endpoint}`,
+                        [{"path": node.name, "location": "/core/nodes/_api.vue"}]
+                    )
+                }
+            }
+        }
+
+        if (node.children) {
+            for (const child of node.children) {
+                await this._initializeRootNode(child);
+            }
+        }
+    }
+    // ________________________________________________________________________________
+    // EXEC API
+    // ________________________________________________________________________________
+    /**
+     * Execute a command on the given endpoint.
+     * @param {string} endpointId
+     * @param {Array} args
+     * @param {*} bytes
+     * @returns {Promise<Object>}
+     */
+    exec = async (endpointId, args = [], bytes = null) => {
+        if (typeof endpointId !== 'string') {
+            return nok('[INVALID_ARGUMENT] - endpointId must be string', ['exec']);
+        }
+        if (!Array.isArray(args)) {
+            return nok('[INVALID_ARGUMENT] - args must be an array', ['exec']);
+        }
+        if (!endpointId) {
+            return nok(`[INVALID_ARGUMENT] - endpointId=${endpointId}`, ['exec']);
+        }
+
+        try {
+            return await this.connection.execute(endpointId, args, bytes);
+        } catch (e) {
+            const errorMsg = `[EXCEPTION] - endpointId=${endpointId} - args=${args}`;
+            this.logger.info(errorMsg);
+            this.logger.info(e);
+            return nok(e.toLocaleString(), ['exec', errorMsg]);
+        }
+    }
+
+    /**
+     * Execute a command - returns an Observable, throws on validation errors
+     * @param {string} endpointId
+     * @param {string[]} args
+     * @param {*} bytes
+     * @returns {Observable}
+     */
+    exec2(endpointId, args = [], bytes = null) {
+        if (!endpointId) {
+            return throwError(() => new Error(`[INVALID_ARGUMENT] - endpointId=${endpointId}`));
+        }
+        if (typeof endpointId !== 'string') {
+            return throwError(() => new Error('[INVALID_ARGUMENT] - endpointId must be string'));
+        }
+        if (!Array.isArray(args)) {
+            return throwError(() => new Error('[INVALID_ARGUMENT] - args must be an array'));
+        }
+
+        const idxArgsError = indexOfNonString(args);
+        if (idxArgsError !== -1) {
+            return throwError(() => new Error(
+                `[INVALID_ARGUMENT] - args must contain only strings but idx=${idxArgsError} is not string`
+            ));
+        }
+
+        return this.connection.execute2(endpointId, args, bytes);
+    }
+
+    /**
+     * Execute and return structured result with text STDOUT
+     * @param {string} endpointId
+     * @param {string[]} args
+     * @param {*} bytes
+     * @returns {Observable}
+     */
+    exec2Result(endpointId, args = [], bytes = null) {
+        return this.exec2(endpointId, args, bytes).pipe(
+            map(this._createExecResultMapper(true))
+        );
+    }
+
+    // ________________________________________________________________________________
+    // HTTP
+    // ________________________________________________________________________________
+    resolver = async (endpoint, type) => {
+        this.logger.info(`[resolver] -  endpoint=${endpoint}`)
+
+        if (endpoint.startsWith('/c0ckp1t/')) {
+            const endpointAdjusted = endpoint.replace("/c0ckp1t/", `/`)
+            const path = `${Constants.SERVER_API_URL}${endpointAdjusted}`;
+            this.logger.debug(`[resolver] - endpointAdjusted=${path}`);
+            const res = await Http.getText(path)
+            if (res.isOk) {
+                return new Response(res.result, {status: 200, statusText: 'OK'});
+            } else {
+                return new Response(res.result, {status: 500, statusText: 'NOK'});
+            }
+        }
+
+        const args = ["read", endpoint]
+        const res = await this.exec("/sys/resolver", args)
+        if (!res.isOk) {
+            throw Error(`[READ_ERROR] - args=${args} - result=${res.result}`)
+        }
+        const text = res.result.replaceAll("##instanceId##", this.instanceId)
+        return new Response(text, {status: 200, statusText: 'OK'});
+    }
+
+    getText = async (endpoint) => {
+        this.logger.info(`[getText] -  endpoint=${endpoint}`)
+        if (endpoint.startsWith('/c0ckp1t/')) {
+            const path = `${Constants.SERVER_API_URL}${endpoint}`;
+            return await Http.getText(path)
+        }
+        const args = ["read", endpoint]
+        const res = await this.exec("/sys/resolver", args)
+        if (!res.isOk) {
+            this.logger.info(`[getText] - error - endpoint=${endpoint}`)
+            throw Error(`[READ_ERROR] - args=${args} - result=${res.result}`)
+        }
+        return res
+    }
+
+    async getBinary(endpoint) {
+        const path = `${Constants.SERVER_API_URL}${endpoint}`;
+        this.logger.debug(`[getBinary] - ${path}`);
+        return await Http.getBinary(path)
+    }
+
+    async getJson(endpoint) {
+        const path = `${Constants.SERVER_API_URL}${endpoint}`;
+        this.logger.debug(`[getJson] - ${path}`);
+        return await Http.getJson(path)
+    }
+
+    async postJson(endpoint, body) {
+        const path = `${Constants.SERVER_API_URL}${endpoint}`;
+        this.logger.debug(`[postJson] - ${path}`);
+        return await Http.postJson(path, body)
+    }
+
+    // ________________________________________________________________________________
+    // init
+    // ________________________________________________________________________________
+    init = async () => {
+        await this.connect()
+        this.state.isReady = true
+    }
+
+
+    _createExecResultMapper(convertStdoutToText = true) {
+        return (pktBytes) => {
+            const result = fromBinary(pktBytes);
+
+            switch (result.type) {
+                case "START":
+                    return {
+                        type: result.type,
+                        id: result.id,
+                        currentTimeMs: result.currentTimeMs,
+                    };
+                case "END":
+                    return {
+                        type: result.type,
+                        runtimeMs: result.runtimeMs,
+                        exitCode: result.exitCode,
+                    };
+                case "STDOUT":
+                    return {
+                        type: result.type,
+                        result: convertStdoutToText ? fromByteArray(result.bytes) : result.bytes
+                    };
+                case "STDIELD":
+                    return {
+                        type: result.type,
+                        result: fromByteArray(result.bytes)
+                    };
+                case "STDERR":
+                    return {
+                        type: result.type,
+                        result: fromByteArray(result.bytes)
+                    };
+                default:
+                    throw new Error(`[UNEXPECTED_TYPE] - type=${result.type}`);
+            }
+        };
+    }
+} // end of IslandDefault class
+
+
+// ________________________________________________________________________________
+// HELPER METHODS
+// ________________________________________________________________________________
+function adjustNode(node) {
+    node._expanded = true;
+    node.children.forEach((child) => {
+        adjustNode(child);
+    });
+}
+
+function adjustConfig(children, instanceId) {
+    children.forEach((node) => {
+        if (node.location) {
+            node.location = `/${instanceId}${node.location}`
+        }
+        if (node.children) {
+            adjustConfig(node.children, instanceId);
+        }
+    });
+}

package/core/IslandDefault.mjs

@@ -0,0 +1,229 @@
+// ________________________________________________________________________________
+// IMPORT
+// ________________________________________________________________________________
+import {markRaw, reactive, watch, defineAsyncComponent, getCurrentInstance} from 'vue'
+import {ok, nok, sha1} from "JsUtils"
+import {Http} from "WsUtils"
+import {getLogger} from 'Logging';
+import Constants from "Constants";
+import {loadModule, options } from "./VueUtils.mjs";
+
+// ________________________________________________________________________________
+// Default Island
+// ________________________________________________________________________________
+/**
+ *  state
+ *      isLoading
+ *      isReady
+ *  store
+ *      id
+ *  connection
+ */
+export default class IslandDefault {
+    constructor(apiMain, config) {
+
+        this.instanceId = config.instanceId
+        this.config = config
+
+        this.LOG_HEADER = `${this.instanceId}`;
+        this.logger = getLogger(this.LOG_HEADER);
+        this.logger.debug('[INIT]');
+
+        this.connection = {
+            state: {
+                isConnected: true,
+                isAuthenticated: false,
+                isReady: true,
+                sessionStateString: "INITIALIZED",
+                connStateString: "CONNECTED",
+                errorMessages: [],
+                subscriptionCount: 0,
+            },
+            store: {
+                username: "default",
+            }
+        };
+
+        // ________________________________________________________________________________
+        // STATE - NOT saved in browser storage
+        // ________________________________________________________________________________
+        this.state = reactive({
+            isLoading: false,
+            isReady: false,
+        })
+
+        // ________________________________________________________________________________
+        // STORE - saved in browser storage
+        // ________________________________________________________________________________
+        this.store = reactive({
+            id: this.LOG_HEADER,
+            updated: null,
+
+            showRegistry: true,
+            root: null,
+            selectedNode: null,
+        })
+        this.apiMain = apiMain
+        this.sfcOptions = options
+
+    } // end of constructor
+
+    // ________________________________________________________________________________
+    // NODE METHODS
+    // ________________________________________________________________________________
+    routeByEndpoint = async (endpoint) => {
+        this.logger.debug(`routeByEndpoint - endpoint=${endpoint}`);
+        await this.apiMain.routeByEndpoint(
+            this.instanceId,
+            `/${this.instanceId}${endpoint}`
+        );
+    }
+
+    /**
+     * Select the default dashboard (root).
+     * @returns {Promise<void>}
+     */
+    selectDefaultDashboard = async () => {
+        await this.apiMain.routerPush(`/${this.instanceId}`);
+    }
+
+    /**
+     * Select a node and navigate to its endpoint.
+     * A node has:
+     *   - endpoint = "/documentation"
+     *   - name = "documentation"
+     * @param {Object} node
+     * @returns {Promise<void>}
+     */
+    selectNode = async (node) => {
+        this.logger.info(`selectNode - node.endpoint=${node.endpoint}`);
+        this.store.selectedNode = null;
+        this.store.selectedNode = node;
+        await this.apiMain.routeByEndpoint( node.endpoint );
+    }
+
+    // ________________________________________________________________________________
+    // MODULE API
+    // ________________________________________________________________________________
+    loadModule = async (path) => {
+        try {
+            this.logger.debug(`[loadModule] - path=${path}`);
+            return await loadModule(path, options);
+        } catch(e) {
+            this.logger.error(`[loadModule] - ERROR - path=${path} - ${e}`);
+            throw e // Rethrow the error so Vue can handle it
+        }
+    }
+
+    // ________________________________________________________________________________
+    // USER API
+    // ________________________________________________________________________________
+    userContext = async () => {
+        return this.store.context
+    }
+
+    /**
+     * Fetch and set the root node.
+     * @returns {Promise<void>}
+     */
+    rootNode = async () => {
+        this.logger.debug('[rootNode]');
+        console.log(this.config)
+        const root = this.config.root
+        adjustNode(root)
+        this.store.root = root
+    }
+
+    // ________________________________________________________________________________
+    // EXEC API
+    // ________________________________________________________________________________
+    /**
+     * Execute a command on the given endpoint.
+     * @param {string} endpointId
+     * @param {Array} args
+     * @param {*} bytes
+     * @returns {Promise<Object>}
+     */
+    exec = async (endpointId, args = [], bytes = null) => {
+        if (typeof endpointId !== 'string') {
+            return nok('[INVALID_ARGUMENT] - endpointId must be string', ['exec']);
+        }
+        if (!Array.isArray(args)) {
+            return nok('[INVALID_ARGUMENT] - args must be an array', ['exec']);
+        }
+        if (!endpointId) {
+            return nok(`[INVALID_ARGUMENT] - endpointId=${endpointId}`, ['exec']);
+        }
+
+        try {
+            return nok("[NOT_IMPLEMENTED]", ['exec']);
+        } catch (e) {
+            const errorMsg = `[EXCEPTION] - endpointId=${endpointId} - args=${args}`;
+            this.logger.info(errorMsg);
+            this.logger.info(e);
+            return nok(e.toLocaleString(), ['exec', errorMsg]);
+        }
+    }
+
+    // ________________________________________________________________________________
+    // HTTP
+    // ________________________________________________________________________________
+    /**
+     *
+     * @param path
+     * @param type
+     * @returns {Promise<Response>}
+     */
+    resolver =  async (path, type) => {
+        this.logger.debug(`[resolver] - fetching - ${path} - ${type}`)
+        const res = await fetch(path);
+        if (!res.ok) throw Object.assign(new Error(res.statusText + ' ' + path), {res});
+        return res
+    }
+
+
+    getText = async (endpoint) => {
+            const path = `${Constants.SERVER_API_URL}${endpoint}`;
+            this.logger.debug(`[getText] - ${path}`);
+            return await Http.getText(path)
+    }
+
+    async getBinary(endpoint) {
+        const path = `${Constants.SERVER_API_URL}${endpoint}`;
+        this.logger.debug(`[getBinary] - ${path}`);
+        return await Http.getBinary(path)
+    }
+
+    async getJson(endpoint, params = {}) {
+        const path = `${Constants.SERVER_API_URL}${endpoint}`;
+        this.logger.debug(`[getJson] - ${path}`);
+        return await Http.getJson(path)
+    }
+
+    async postJson(endpoint, body) {
+        const path = `${Constants.SERVER_API_URL}${endpoint}`;
+        this.logger.debug(`[postJson] - ${path}`);
+        return await Http.postJson(path, body)
+    }
+
+    // ________________________________________________________________________________
+    // init
+    // ________________________________________________________________________________
+    init = async ()   => {
+       await this.rootNode()
+       this.state.isReady = true
+    }
+
+} // end of IslandDefault class
+
+
+// ________________________________________________________________________________
+// HELPER METHODS
+// ________________________________________________________________________________
+function adjustNode(node) {
+    node._expanded = true;
+    node.children.forEach((child) => {
+        adjustNode(child);
+    });
+}
+