vrack2-core 0.0.1 → 1.0.0

package/lib/Container.js

@@ -13,6 +13,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const events_1 = __importDefault(require("events"));
+const DeviceManager_1 = __importDefault(require("./boot/DeviceManager"));
 const ErrorManager_1 = __importDefault(require("./errors/ErrorManager"));
 const Rule_1 = __importDefault(require("./validator/Rule"));
 const CoreError_1 = __importDefault(require("./errors/CoreError"));
@@ -20,6 +21,9 @@ const Validator_1 = __importDefault(require("./validator/Validator"));
 const ImportManager_1 = __importDefault(require("./ImportManager"));
 const DevicePort_1 = __importDefault(require("./service/DevicePort"));
 const DeviceConnect_1 = __importDefault(require("./service/DeviceConnect"));
+const Utility_1 = __importDefault(require("./Utility"));
+const fs_1 = require("fs");
+/***** ********      DEVICE ERROR      ********************/
 ErrorManager_1.default.register('Container', 'FBDRkSAWnlcc', 'CTR_ERROR_INIT_DEVICE', 'Device initialization error', {
     deviceConfig: Rule_1.default.object().description('Device configuration')
 });
@@ -32,9 +36,24 @@ ErrorManager_1.default.register('Container', '2RZznI3JDNUW', 'CTR_ERROR_PREPARE_
     message: Rule_1.default.string().description('Exception error string')
 });
 ErrorManager_1.default.register('Container', 'NDW2oD7mFxqB', 'CTR_DEVICE_ACTION_NF', 'Action on device not found', {
+    device: Rule_1.default.string().description('Device ID'),
     action: Rule_1.default.string().description('Action name'),
-    method: Rule_1.default.string().description('Method name')
+    method: Rule_1.default.string().description('Method name'),
 });
+ErrorManager_1.default.register('Container', 'XOXLMVCN9OBI', 'CTR_DEVICE_NF', 'Device in container found', {
+    device: Rule_1.default.string().description('Device ID'),
+});
+ErrorManager_1.default.register('Container', '570RD59JEYVN', 'CTR_DEVICE_ACTION_HANDLER_NF', 'Device handler action not found', {
+    device: Rule_1.default.string().description('Device ID'),
+    action: Rule_1.default.string().description('Device action name'),
+});
+ErrorManager_1.default.register('Container', 'RJV0KT2DFZBZ', 'CTR_DEVICE_PROCESS_EXCEPTION', 'During process execution - the device threw an exception', {
+    device: Rule_1.default.string().description('Device ID'),
+});
+ErrorManager_1.default.register('Container', 'K65XWSYOBVFG', 'CTR_DEVICE_PROCESS_PROMISE_EXCEPTION', 'During processPromise execution - the device threw an exception', {
+    device: Rule_1.default.string().description('Device ID'),
+});
+/***** ********      PORTS ERROR      ********************/
 ErrorManager_1.default.register('Container', 'jkIpU1p4z5uz', 'CTR_INCORRECT_DYNAMIC_PN', 'Incorrect dynamic port name', {
     port: Rule_1.default.string().description('Incorrect port name')
 });
@@ -45,6 +64,10 @@ ErrorManager_1.default.register('Container', 'qPevPU6SRJ18', 'CTR_INPUT_HANDLER_
     port: Rule_1.default.string().description('Port name for handler'),
     handler: Rule_1.default.string().description('Handler name')
 });
+ErrorManager_1.default.register('Container', 'QlcUh744VzAG', 'CTR_DEVICE_PORT_NF', 'Port on device not found', {
+    port: Rule_1.default.string().description('Port name'),
+});
+/***** ********      CONNECTION ERROR      ********************/
 ErrorManager_1.default.register('Container', 'Kp74OuVGNU0u', 'CTR_CONNECTION_INCORRECT', 'Incorrect connection format', {
     connection: Rule_1.default.string().description('Connection string'),
     error: Rule_1.default.string().description('String of error problem'),
@@ -57,58 +80,234 @@ ErrorManager_1.default.register('Container', 'CwFj1G47H45E', 'CTR_CONNECTION_POR
     connection: Rule_1.default.string().description('Connection string'),
     port: Rule_1.default.string().description('Port name not found')
 });
+ErrorManager_1.default.register('Container', 'XR1K10R0OOUC', 'CTR_INCOMPATIBLE_PORTS', 'Incompatible ports', {
+    connection: Rule_1.default.string().description('Connection string'),
+});
+ErrorManager_1.default.register('Container', 'MmVoDOQwaYkx', 'CTR_INCORRECT_BOOSTRAP', 'The required DeviceManager class is not specified correctly', {});
+ErrorManager_1.default.register('Container', 'e090R0MLyb7y', 'CTR_CONF_EXTENDS_PROBLEM', 'Problem with extending service configuration.', {});
+/**
+ * Service Load Class. It loads all devices in the list,
+ * establishes connections between them, and performs device startup.
+ *
+ * This class is a bit complicated for a simple description.
+ * It is recommended to familiarize yourself with the source code
+*/
 class Container extends events_1.default {
-    constructor(config, dm) {
+    /**
+     * Create container needed service structure & device manager
+     *
+     * @param service Service structure
+     * @param bootstrap Bootstrap class Object
+     *
+     * */
+    constructor(id, service, Bootstrap, confFile) {
         super();
+        /** Unique service ID */
+        this.id = '';
+        /** List of devices in container */
         this.devices = {};
-        this.config = config;
-        this.DeviceManager = dm;
+        /** inited flag */
+        this.inited = false;
+        /** run flag */
+        this.runned = false;
+        /**
+         * Container structure
+        */
+        this.structure = {};
+        this.id = id;
+        this.service = service;
         this.deviceActions = {};
+        this.deviceMetrics = {};
+        this.confFile = confFile;
+        this.Bootstrap = Bootstrap;
     }
+    /**
+     * Run container
+    */
     run() {
         return __awaiter(this, void 0, void 0, function* () {
-            for (const device of this.config.devices) {
+            yield this.init();
+            yield this.runProcess();
+        });
+    }
+    /**
+     * Extends service from config file
+     *
+     * Sometimes there is a need to override the settings of some devices.
+     * To do this, you can use a special configuration file of the service.
+     * It contains the same as the main service file and replaces with its settings
+     * and parameters the settings and parameters of the main service.
+     *
+     * @see init()
+    */
+    fillConfFile() {
+        if (!this.confFile || !(0, fs_1.existsSync)(this.confFile))
+            return;
+        const conf = ImportManager_1.default.importJSON(this.confFile);
+        if (conf.devices === undefined || !Array.isArray(conf.devices))
+            conf.devices = [];
+        for (const device of conf.devices) {
+            if (!device.id || device.options === undefined || typeof device.options !== 'object')
+                continue;
+            for (const cdev of this.service.devices) {
+                if (cdev.id === device.id) {
+                    for (const pname in device.options)
+                        cdev.options[pname] = device.options[pname];
+                    if (device.connections)
+                        cdev.connections = device.connections;
+                }
+            }
+        }
+    }
+    /**
+     * Creates device classes. Preprocesses the device,
+     * then adds ports to it and creates connections between ports.
+     *
+     * When adding and creating devices, ports and connections,
+     * the service structure is also created
+     *
+     * 1. Init device
+     * 2. Init individual device connections
+     * 3. Init other connections
+     *
+     * @see structure
+    */
+    init() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.inited)
+                return;
+            this.inited = true;
+            this.emit('configure');
+            try {
+                this.fillConfFile();
+            }
+            catch (err) {
+                if (err instanceof Error) {
+                    const ner = ErrorManager_1.default.make('CTR_CONF_EXTENDS_PROBLEM', {}).setTrace(err).add(err);
+                    throw ner;
+                }
+                throw err;
+            }
+            this.emit('beforeInit');
+            this.emit('init');
+            for (const device of this.service.devices) {
                 try {
+                    this.emit('initDevice', device);
                     yield this.initDevice(device);
                 }
                 catch (error) {
                     const ner = ErrorManager_1.default.make('CTR_ERROR_INIT_DEVICE', { deviceConfig: device });
-                    if (error instanceof CoreError_1.default)
-                        ner.add(error);
+                    ner.add(error);
                     throw ner;
                 }
             }
-            for (const conn of this.config.connections) {
+            this.emit('afterInit');
+            this.emit('beforeConnections');
+            this.emit('connections');
+            for (const device of this.service.devices) {
+                if (!device.connections)
+                    continue;
+                for (const conn of device.connections) {
+                    this.emit('connection', conn);
+                    this.initConnection(conn);
+                }
+            }
+            if (Array.isArray(this.service.connections)) {
+                for (const conn of this.service.connections) {
+                    this.initConnection(conn);
+                }
+            }
+            this.emit('afterConnections');
+        });
+    }
+    /**
+     * Run process & processPromise of all devices
+    */
+    runProcess() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.runned)
+                return;
+            this.runned = true;
+            this.emit('beforeProcess');
+            for (const key in this.devices) {
                 try {
-                    yield this.initConnection(conn);
+                    this.emit('process', key);
+                    this.devices[key].process();
                 }
                 catch (error) {
-                    const ner = ErrorManager_1.default.make('CTR_ERROR_INIT_CONNECTION', { connection: conn });
-                    if (error instanceof CoreError_1.default)
-                        ner.add(error);
-                    throw ner;
+                    throw ErrorManager_1.default.make('CTR_DEVICE_PROCESS_EXCEPTION', { device: key }).add(error);
+                }
+            }
+            this.emit('afterProcess');
+            this.emit('beforeProcessPromise');
+            for (const key in this.devices) {
+                try {
+                    this.emit('processPromise', key);
+                    yield this.devices[key].processPromise();
+                }
+                catch (error) {
+                    throw ErrorManager_1.default.make('CTR_DEVICE_PROCESS_PROMISE_EXCEPTION', { device: key }).add(error);
                 }
             }
-            for (const key in this.devices)
-                this.devices[key].process();
-            for (const key in this.devices)
-                yield this.devices[key].processPromise();
-            // const cs = await this.DeviceManager.get('vrack.Master')
-            // const cse = new cs()
-            // console.log(cse)
-            // cse.run()
+            this.emit('afterProcessPromise');
+            this.emit('beforeLoaded');
+            this.emit('loaded');
         });
     }
+    /**
+     * Check device action and run him
+     *
+     * @param device Device ID
+     * @param action Device action (as 'action.name')
+     * @param data Data for action
+    */
+    deviceAction(device, action, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.deviceActions[device])
+                throw ErrorManager_1.default.make('CTR_DEVICE_NF', { device });
+            const deviceClass = this.devices[device];
+            const deviceActions = this.deviceActions[device];
+            const method = ImportManager_1.default.camelize('action.' + action);
+            if (!deviceActions[action])
+                throw ErrorManager_1.default.make('CTR_DEVICE_ACTION_NF', { device, action, method });
+            if (!deviceClass[method])
+                throw ErrorManager_1.default.make('CTR_DEVICE_ACTION_HANDLER_NF', { device, action });
+            const actionExport = deviceActions[action].exportRaw();
+            Validator_1.default.validate(actionExport.requirements, data);
+            return yield deviceClass[method](data);
+        });
+    }
+    /**
+     * Return structure
+    */
+    getStructure() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.structure;
+        });
+    }
+    /**
+     * Init one device
+     *
+     * 1. Make device class object
+     * 2. Fill device options
+     * 3. Run device prepareOptions method
+     * 4. Validating device options
+     * 5. Check device actions
+     * 6. make device inputs ports
+     * 7. make device outputs ports
+     **/
     initDevice(dconf) {
         return __awaiter(this, void 0, void 0, function* () {
-            const cs = yield this.DeviceManager.get(dconf.type);
+            const DM = this.Bootstrap.getBootClass('DeviceManager', DeviceManager_1.default);
+            const cs = yield DM.get(dconf.type);
             // 
-            if (dconf.id === undefined || !dconf.id || typeof dconf.id !== 'string') {
+            if (dconf.id === undefined || !dconf.id || typeof dconf.id !== 'string' || !Utility_1.default.isDeviceName(dconf.id)) {
                 throw ErrorManager_1.default.make('CTR_INCORRECT_DEVICE_ID');
             }
             // Device id is dublicated
             if (dconf.id in this.devices)
                 throw ErrorManager_1.default.make('CTR_DEVICE_DUBLICATE');
+            // Create device
             const dev = new cs(dconf.id, dconf.type, this);
             this.devices[dconf.id] = dev;
             // Fill options
@@ -130,6 +329,17 @@ class Container extends events_1.default {
             const rules = dev.checkOptions();
             // Validating
             Validator_1.default.validate(rules, dev.options);
+            /** create structure */
+            this.structure[dconf.id] = {
+                id: dconf.id,
+                type: dconf.type,
+                actions: {},
+                outputs: {},
+                inputs: {},
+                ports: [],
+                settings: {},
+                metrics: {},
+            };
             dev.preProcess();
             // Check actions 
             this.deviceActions[dev.id] = dev.actions();
@@ -137,9 +347,18 @@ class Container extends events_1.default {
                 const method = ImportManager_1.default.camelize('action.' + action);
                 if (!(method in dev))
                     throw ErrorManager_1.default.make('CTR_DEVICE_ACTION_NF', { action, method });
+                // add structure device action
+                this.structure[dconf.id].actions[action] = this.deviceActions[dev.id][action].export();
+            }
+            this.structure[dconf.id].settings = dev.settings();
+            // Make Metrics
+            this.deviceMetrics[dev.id] = dev.metrics();
+            for (const metric in this.deviceMetrics[dev.id]) {
+                const raw = this.deviceMetrics[dev.id][metric].export();
+                const nEvent = { device: dev.id, data: metric, trace: raw };
+                this.emit('device.register.metric', nEvent);
+                this.structure[dconf.id].metrics[metric] = raw;
             }
-            // make ports
-            // prepare ports
             // make inputPorts
             const iPorts = dev.inputs();
             for (const key in iPorts) {
@@ -151,10 +370,14 @@ class Container extends events_1.default {
                     this.checkInputHandler(subkey, handler, dev);
                     const ndp = new DevicePort_1.default(subkey, pList[subkey]);
                     dev.ports.input[subkey] = ndp;
+                    // add structure device input ports
+                    this.structure[dconf.id].inputs[subkey] = [];
+                    this.structure[dconf.id].ports.push(Object.assign({ port: subkey, direct: 'input' }, pList[subkey]));
                     if (handler in dev)
                         ndp.push = dev[handler].bind(dev);
                 }
             }
+            // make output ports
             const oPorts = dev.outputs();
             for (const key in oPorts) {
                 const exp = oPorts[key].export();
@@ -163,17 +386,31 @@ class Container extends events_1.default {
                     this.checkPortName(subkey);
                     const ndp = new DevicePort_1.default(subkey, pList[subkey]);
                     dev.ports.output[subkey] = ndp;
+                    // add structure device output ports
+                    this.structure[dconf.id].outputs[subkey] = [];
+                    this.structure[dconf.id].ports.push(Object.assign({ port: subkey, direct: 'output' }, pList[subkey]));
                 }
             }
         });
     }
+    /**
+     * Check device input handler
+     * Make CTR_INPUT_HANDLER_NF error if not exists
+     * @see initDevice make inputPorts
+    */
     checkInputHandler(port, handler, device) {
         if (!(handler in device))
             throw ErrorManager_1.default.make('CTR_INPUT_HANDLER_NF', { port, handler });
     }
+    /**
+     * Init device connection
+     *
+     * @param conn Device connection string like a "DevID.port -> DevIDTO.port"
+    */
     initConnection(conn) {
-        return __awaiter(this, void 0, void 0, function* () {
+        try {
             const cc = this.toConnection(conn);
+            this.emit('connection', cc);
             if (!(cc.outputDevice in this.devices))
                 throw ErrorManager_1.default.make('CTR_CONNECTION_DEVICE_NF', { connection: conn, device: cc.outputDevice });
             if (!(cc.outputPort in this.devices[cc.outputDevice].ports.output))
@@ -182,11 +419,31 @@ class Container extends events_1.default {
                 throw ErrorManager_1.default.make('CTR_CONNECTION_DEVICE_NF', { connection: conn, device: cc.inputDevice });
             if (!(cc.inputPort in this.devices[cc.inputDevice].ports.input))
                 throw ErrorManager_1.default.make('CTR_CONNECTION_PORT_NF', { connection: conn, port: cc.inputPort });
+            if (this.devices[cc.inputDevice].ports.input[cc.inputPort].type !== this.devices[cc.outputDevice].ports.output[cc.outputPort].type)
+                throw ErrorManager_1.default.make('CTR_INCOMPATIBLE_PORTS', { connection: conn });
             const outPort = this.devices[cc.outputDevice].ports.output[cc.outputPort];
             const inPort = this.devices[cc.inputDevice].ports.input[cc.inputPort];
+            // Set structure connections
+            if (this.structure[cc.outputDevice].outputs[cc.outputPort] === undefined)
+                this.structure[cc.outputDevice].outputs[cc.outputPort] = [];
+            this.structure[cc.outputDevice].outputs[cc.outputPort].push({ device: cc.inputDevice, port: cc.inputPort });
+            if (this.structure[cc.inputDevice].inputs[cc.inputPort] === undefined)
+                this.structure[cc.inputDevice].inputs[cc.inputPort] = [];
+            this.structure[cc.inputDevice].inputs[cc.inputPort].push({ device: cc.outputDevice, port: cc.outputPort });
             new DeviceConnect_1.default(outPort, inPort);
-        });
+        }
+        catch (error) {
+            const ner = ErrorManager_1.default.make('CTR_ERROR_INIT_CONNECTION', { connection: conn });
+            if (error instanceof CoreError_1.default)
+                ner.add(error);
+            throw ner;
+        }
     }
+    /**
+     * Container Helper - parse connection string to format object
+     *
+     * @return Connection object
+    */
     toConnection(con) {
         var _a, _b;
         const act = con.split('->');
@@ -211,10 +468,21 @@ class Container extends events_1.default {
         };
         return result;
     }
+    /**
+     * Check Port name (strict format a-zA-Z0-9.)
+     *
+     * @param port Port name
+    */
     checkPortName(port) {
         if (!port.match(/[a-zA-Z0-9.]/))
             throw ErrorManager_1.default.make('CTR_INCORRECT_PN', { port });
     }
+    /**
+     * Convert dynamic port to ports list
+     *
+     * @param name Port name with %d symbols
+     * @param iPort IPort object (port settings)
+    */
     getPortList(name, iPort) {
         const result = {};
         if (!iPort.dynamic) {

package/lib/IServiceStructure.d.ts

@@ -1,5 +1,13 @@
 import IStructureDevice from "./IStructureDevice";
+/** Basic service file structure */
 export default interface IServiceStructure {
+    /**
+     * Devices list
+     * @see IStructureDevice
+    */
     devices: Array<IStructureDevice>;
+    /**
+     * Connections list
+    */
     connections: Array<string>;
 }

package/lib/IStructureDevice.d.ts

@@ -1,7 +1,12 @@
 export default interface IStructureDevice {
+    /** Device ID */
     id: string;
+    /** Device type in VRack style like a 'vendor.Device' */
     type: string;
+    /** Device options */
     options: {
         [key: string]: any;
     };
+    /** Device connections */
+    connections?: Array<string>;
 }

package/lib/ImportManager.d.ts

@@ -5,11 +5,93 @@ export default class ImportManager {
      * @param {string} path Full or relative path to file
     */
     static importPath(raPath: string): Promise<any>;
+    /**
+     * Import class like a vrack2 device style
+     *
+     * Разделяюет переданную строку пути на 2 части.
+     * Первая честь является названием модуля, а вторая часть классом внутри него
+     *
+     * @example ImportManager.importClass('vrack2-core.Container')
+    */
     static importClass(cs: string): Promise<any>;
-    static importJSON(filePath: string): Promise<any>;
+    /**
+     * Attempts to open a file and use its contents as json
+     *
+     * Returns the result of parsing json
+     *
+     * @returns {any} json parsing result
+    */
+    static importJSON(filePath: string): any;
+    /**
+     * Returns the class name in the style of import vrack
+     *
+     * return `Container` from 'vrack2-core.Container' string
+     *
+     * @param cs Import class string
+     *
+    */
+    static importClassName(cs: string): string | undefined;
+    /**
+     * Returns the vendor name in the style of import vrack
+     *
+     * return `vrack2-core` from 'vrack2-core.Container' string
+     *
+     * @param cs Import class string
+    */
+    static importVendorName(cs: string): string | undefined;
+    /**
+     * Returns a list of directories in the specified directory.
+     *
+     * @param dir path to directory
+     */
+    static dirList(dir: string): string[];
+    /**
+     * Returns a list of files in the specified directory.
+     *
+     * @param dir path to directory
+     */
+    static fileList(dir: string): string[];
+    /**
+     * Checks if a path is a directory
+     *
+     * @param dir path to directory
+    */
+    static isDir(dir: string): boolean;
+    /**
+     * Checks if a path is a directory
+     *
+     * @param f path to file
+    */
+    static isFile(f: string): boolean;
+    /**
+     * Try JSON parse
+     *
+     * Returns an CoreError[IM_JSON_INCORRECT] if there is a parsing error.
+     *
+     * @param jsonRaw JSON raw string
+     *
+    */
     static tryJsonParse(jsonRaw: string): any;
-    static camelize(text: string): string;
-    protected static getSub(imp: any, get: string): any;
+    /**
+     * Return directory where VRack was launched from
+    */
     static systemPath(): string;
+    /**
+     * Camelize string for input & action handlers
+     *
+     * Splits a string with a dot and returns the string
+     * with capital letters starting from the second word
+     *
+     * @example
+     * ```ts
+     * ImportManager.camelize('input.device.port') // return inputDevicePort
+     * ```
+     *
+     * @param text Like a `input.device.port` string
+    */
+    static camelize(text: string): string;
+    /**
+     * Try import method
+    */
     protected static tryImport(p: string): Promise<any>;
 }