vrack2-core 1.0.4 → 1.1.0

package/README.md

@@ -9,7 +9,21 @@ VRack2 Core
 
 --------
 
-### Последнее обновление 1.0.4
+### Последнее обновление 1.1.0
+
+- Переход компиляции на `es2021` - теперь минимальная версия Node.js ≥ 16
+- Добавлен класс `ReactiveRef` для создания переменных с очень простой реактивностью
+- Добавлен класс `UniversalWorkers` для создания воркеров разных типов и работы с ними
+
+### обновление 1.0.5
+ - В Container добавлена ошибка `CTR_IGNORE_SERVICE_AUTORELOAD` её можно использовать, когда не хочется что бы после завершения работы сервиса - сервис автоматически перезапускался
+ - В класс `Device` добавлены
+   - Свойство `works: boolean = true` - если `false` - устройство перестает принимать и отправлять данные через порты
+   - Метод `beforeTerminate(){ return }` - может вызываться перед завершением сервиса (зависит от реализации)
+ - Теперь бинд входящего порта осуществляется по другому. Теперь вместо замены `DevicePort.push` ссылка на хендлер складывается в `DevicePort.bind` и уже после этого происходит вызов `DevicePort.bind()` внутри `DevicePort.push`
+  
+
+### обновление 1.0.4
 
  - `BasicType` (класс `Rule`) `require()` deprecated - используем `required()`
  - **ErrorManager** - Теперь не создаёт ошибку при повторной регистрации с одинаковыми параметрами
@@ -17,11 +31,6 @@ VRack2 Core
    - isCode(error: any, code: string) - Проверяет является ли ошибка VRack2 Error и соответсвует ли код переданной ошибке (проверяет vShort и vCode)
    - isError(error: any) - Проверяет - пренадлежит ли объект ошибки CoreError
 
-### Обновление 1.0.3
-
- - Теперь порты `DevicePort` имеют ссылки на устройство своего владельца `Device`
- - Добавлено свойство meta внутри контейнера для хранения дополнительной информации
-
 **Использовать эту документацию имеет смысл только для более глубокого изучения устройства VRack2 или для создания сервиса независимого от VRack2**
 
 -------

package/lib/Bootstrap.js

@@ -3,15 +3,6 @@
  * Copyright © 2024 Boris Bobylev. All rights reserved.
  * Licensed under the Apache License, Version 2.0
 */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -65,21 +56,19 @@ class Bootstrap {
      *
      * @param Container Container for which loading is performed
     */
-    loadBootList(Container) {
-        return __awaiter(this, void 0, void 0, function* () {
-            for (const cn in this.config) {
-                const conf = this.config[cn];
-                const ExClass = yield ImportManager_1.default.importClass(conf.path);
-                this.loaded[cn] = new ExClass(cn, ImportManager_1.default.importClassName(conf.path), Container, conf.options);
-                if (!(this.loaded[cn] instanceof BootClass_1.default)) {
-                    throw _1.ErrorManager.make('BTSP_INSTANCE_OF_INCORRECT', { path: conf.path });
-                }
+    async loadBootList(Container) {
+        for (const cn in this.config) {
+            const conf = this.config[cn];
+            const ExClass = await ImportManager_1.default.importClass(conf.path);
+            this.loaded[cn] = new ExClass(cn, ImportManager_1.default.importClassName(conf.path), Container, conf.options);
+            if (!(this.loaded[cn] instanceof BootClass_1.default)) {
+                throw _1.ErrorManager.make('BTSP_INSTANCE_OF_INCORRECT', { path: conf.path });
             }
-            for (const bc in this.loaded)
-                this.loaded[bc].process();
-            for (const bc in this.loaded)
-                yield this.loaded[bc].processPromise();
-        });
+        }
+        for (const bc in this.loaded)
+            this.loaded[bc].process();
+        for (const bc in this.loaded)
+            await this.loaded[bc].processPromise();
     }
     /**
      * Getting an initialized class

package/lib/Container.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -85,6 +76,7 @@ ErrorManager_1.default.register('Container', 'XR1K10R0OOUC', 'CTR_INCOMPATIBLE_P
 });
 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.', {});
+ErrorManager_1.default.register('Container', 'LYC0VA1AWYKU', 'CTR_IGNORE_SERVICE_AUTORELOAD', 'Error that ignores service restart flag', {});
 /**
  * Service Load Class. It loads all devices in the list,
  * establishes connections between them, and performs device startup.
@@ -124,11 +116,9 @@ class Container extends events_1.default {
     /**
      * Run container
     */
-    run() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.init();
-            yield this.runProcess();
-        });
+    async run() {
+        await this.init();
+        await this.runProcess();
     }
     /**
      * Extends service from config file
@@ -172,87 +162,83 @@ class Container extends events_1.default {
      *
      * @see structure
     */
-    init() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.inited)
-                return;
-            this.inited = true;
-            this.emit('configure');
-            try {
-                this.fillConfFile();
+    async init() {
+        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;
             }
-            catch (err) {
-                if (err instanceof Error) {
-                    const ner = ErrorManager_1.default.make('CTR_CONF_EXTENDS_PROBLEM', {}).setTrace(err).add(err);
-                    throw ner;
-                }
-                throw err;
+            throw err;
+        }
+        this.emit('beforeInit');
+        this.emit('init');
+        for (const device of this.service.devices) {
+            try {
+                this.emit('initDevice', device);
+                await this.initDevice(device);
             }
-            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 });
-                    ner.add(error);
-                    throw ner;
-                }
+            catch (error) {
+                const ner = ErrorManager_1.default.make('CTR_ERROR_INIT_DEVICE', { deviceConfig: device });
+                ner.add(error);
+                throw ner;
             }
-            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);
-                }
+        }
+        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);
-                }
+        }
+        if (Array.isArray(this.service.connections)) {
+            for (const conn of this.service.connections) {
+                this.initConnection(conn);
             }
-            this.emit('afterConnections');
-        });
+        }
+        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 {
-                    this.emit('process', key);
-                    this.devices[key].process();
-                }
-                catch (error) {
-                    throw ErrorManager_1.default.make('CTR_DEVICE_PROCESS_EXCEPTION', { device: key }).add(error);
-                }
+    async runProcess() {
+        if (this.runned)
+            return;
+        this.runned = true;
+        this.emit('beforeProcess');
+        for (const key in this.devices) {
+            try {
+                this.emit('process', key);
+                this.devices[key].process();
             }
-            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);
-                }
+            catch (error) {
+                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);
+                await this.devices[key].processPromise();
+            }
+            catch (error) {
+                throw ErrorManager_1.default.make('CTR_DEVICE_PROCESS_PROMISE_EXCEPTION', { device: key }).add(error);
             }
-            this.emit('afterProcessPromise');
-            this.emit('beforeLoaded');
-            this.emit('loaded');
-        });
+        }
+        this.emit('afterProcessPromise');
+        this.emit('beforeLoaded');
+        this.emit('loaded');
     }
     /**
      * Check device action and run him
@@ -261,29 +247,25 @@ class Container extends events_1.default {
      * @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);
-        });
+    async deviceAction(device, action, data) {
+        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 await deviceClass[method](data);
     }
     /**
      * Return structure
     */
-    getStructure() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.structure;
-        });
+    async getStructure() {
+        return this.structure;
     }
     /**
      * Init one device
@@ -296,102 +278,101 @@ class Container extends events_1.default {
      * 6. make device inputs ports
      * 7. make device outputs ports
      **/
-    initDevice(dconf) {
-        return __awaiter(this, void 0, void 0, function* () {
-            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' || !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
-            for (const key in dconf.options)
-                dev.options[key] = dconf.options[key];
-            // try prepare options
-            try {
-                dev.prepareOptions();
-            }
-            catch (error) {
-                let message = '';
-                if (error instanceof Error)
-                    message = error.toString();
-                const ner = ErrorManager_1.default.make('CTR_ERROR_PREPARE_OPTIONS', { message });
-                if (error instanceof CoreError_1.default)
-                    ner.add(error);
-                throw ner;
-            }
-            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();
-            for (const action in this.deviceActions[dev.id]) {
-                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 inputPorts
-            const iPorts = dev.inputs();
-            for (const key in iPorts) {
-                const exp = iPorts[key].export();
-                const pList = this.getPortList(key, exp);
-                for (const subkey in pList) {
-                    this.checkPortName(subkey);
-                    const handler = ImportManager_1.default.camelize('input.' + subkey);
-                    this.checkInputHandler(subkey, handler, dev);
-                    const ndp = new DevicePort_1.default(subkey, pList[subkey], dev);
-                    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);
-                }
+    async initDevice(dconf) {
+        const DM = this.Bootstrap.getBootClass('DeviceManager', DeviceManager_1.default);
+        const cs = await DM.get(dconf.type);
+        // 
+        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
+        for (const key in dconf.options)
+            dev.options[key] = dconf.options[key];
+        // try prepare options
+        try {
+            dev.prepareOptions();
+        }
+        catch (error) {
+            let message = '';
+            if (error instanceof Error)
+                message = error.toString();
+            const ner = ErrorManager_1.default.make('CTR_ERROR_PREPARE_OPTIONS', { message });
+            if (error instanceof CoreError_1.default)
+                ner.add(error);
+            throw ner;
+        }
+        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();
+        for (const action in this.deviceActions[dev.id]) {
+            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 inputPorts
+        const iPorts = dev.inputs();
+        for (const key in iPorts) {
+            const exp = iPorts[key].export();
+            const pList = this.getPortList(key, exp);
+            for (const subkey in pList) {
+                this.checkPortName(subkey);
+                const handler = ImportManager_1.default.camelize('input.' + subkey);
+                this.checkInputHandler(subkey, handler, dev);
+                const ndp = new DevicePort_1.default(subkey, pList[subkey], dev);
+                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]));
+                // биндимся а не заменяем push для контроля внутри push
+                if (handler in dev)
+                    ndp.bind = dev[handler].bind(dev);
             }
-            // make output ports
-            const oPorts = dev.outputs();
-            for (const key in oPorts) {
-                const exp = oPorts[key].export();
-                const pList = this.getPortList(key, exp);
-                for (const subkey in pList) {
-                    this.checkPortName(subkey);
-                    const ndp = new DevicePort_1.default(subkey, pList[subkey], dev);
-                    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]));
-                }
+        }
+        // make output ports
+        const oPorts = dev.outputs();
+        for (const key in oPorts) {
+            const exp = oPorts[key].export();
+            const pList = this.getPortList(key, exp);
+            for (const subkey in pList) {
+                this.checkPortName(subkey);
+                const ndp = new DevicePort_1.default(subkey, pList[subkey], dev);
+                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
@@ -445,7 +426,6 @@ class Container extends events_1.default {
      * @return Connection object
     */
     toConnection(con) {
-        var _a, _b;
         const act = con.split('->');
         if (act.length !== 2)
             throw ErrorManager_1.default.make('CTR_CONNECTION_INCORRECT', { connection: con, error: "Syntax connection error, syntax have -> beetwen device" });
@@ -455,9 +435,9 @@ class Container extends events_1.default {
             throw ErrorManager_1.default.make('CTR_CONNECTION_INCORRECT', { connection: con, error: "Syntax connection error, syntax have more 3 actets on side" });
         if (outputDeviceActs.length < 2 || inputDeviceActs.length < 2)
             throw ErrorManager_1.default.make('CTR_CONNECTION_INCORRECT', { connection: con, error: "Syntax connection error, syntax have less 2 actets on side" });
-        let outputDevice = (_a = outputDeviceActs.shift()) === null || _a === void 0 ? void 0 : _a.trim();
+        let outputDevice = outputDeviceActs.shift()?.trim();
         const outputPort = outputDeviceActs.join('.').trim();
-        let inputDevice = (_b = inputDeviceActs.shift()) === null || _b === void 0 ? void 0 : _b.trim();
+        let inputDevice = inputDeviceActs.shift()?.trim();
         const inputPort = inputDeviceActs.join('.').trim();
         if (outputDevice === undefined)
             outputDevice = '';