@mirta/testing 0.4.12 → 0.5.0

package/dist/index.d.mts

@@ -3,20 +3,15 @@ interface SimulatorInstance {
     reset(): void;
 }
 
-interface DefineRuleOptions {
-    /**
-     * Отключает защиту от расхождения в поведении с настоящей функцией `defineRule`.
-     *
-     * Контроллер не отправляет одно и то же значение дважды при использовании `whenChanged`.
-     */
-    allowSameValue?: boolean;
+interface RunOptions {
+    force?: boolean;
 }
 interface DefineRuleSimulator extends SimulatorInstance {
     /** Отправляет одно или несколько сообщений. */
-    run(payload: WbRules.MqttMessage | WbRules.MqttMessage[]): void;
+    run(payload: WbRules.MqttMessage | WbRules.MqttMessage[], options?: RunOptions): void;
 }
 /** Имитатор конструкции defineRule. */
-declare function useDefineRule(options?: DefineRuleOptions): DefineRuleSimulator;
+declare function useDefineRule(): DefineRuleSimulator;
 
 interface WithDevice {
     publish(controlId: string, value: WbRules.MqttValue): WithDevice;
@@ -67,12 +62,8 @@ interface CoreSimulator extends SimulatorInstance {
     get trackMqtt(): TrackMqttSimulator;
     defineZigbeeDevice(deviceId: string): ZigbeeDevice;
 }
-interface CoreSimulatorOptions {
-    /** Параметры имитатора `defineRule`. */
-    defineRule?: DefineRuleOptions;
-}
 /** Единая точка входа для настройки симуляции. */
-declare function useSimulator(options?: CoreSimulatorOptions): CoreSimulator;
+declare function useSimulator(): CoreSimulator;
 
 export { defineZigbeeDevice, useDefineRule, useGetControl, useGetDevice, useSimulator, useTrackMqtt };
-export type { ControlValue, DefineRuleOptions, DefineRuleSimulator, GetControlSimulator, GetDeviceSimulator, TrackMqttSimulator, ZigbeeDevice };
+export type { ControlValue, DefineRuleSimulator, GetControlSimulator, GetDeviceSimulator, TrackMqttSimulator, ZigbeeDevice };

package/dist/index.mjs

@@ -1,57 +1,106 @@
-import { useEvent } from 'mirta';
+import { useEvent, isObject } from 'mirta';
 import { mock } from 'vitest-mock-extended';
 
-class SameTopicValueError extends Error {
-    constructor(message) {
-        const text = `[Behavior] Value of the topic "${message.topic}"`
-            + ` must be different from a previous one,`
-            + ` got "${message.value.toString()}".`
-            + `\nYou can suppress this error by passing 'allowSameValue: true' option to 'useDefineRule' call.`;
-        super(text);
+class DevSetValueError extends Error {
+    constructor(property) {
+        super(`[dev] Missing control name in "${property}"`);
+        Error.captureStackTrace(this, DevSetValueError);
     }
 }
-function createInstance$2(options) {
+// Используем простой объект в качестве базового хранилища.
+let state;
+function setValueSilent(controlPath, value) {
+    state[controlPath] = value;
+}
+/**
+ * Создаёт прокси для объекта `dev`, который автоматически реагирует
+ * на изменения значений, запуская соответствующие симуляторы.
+ *
+ * @param options Объект с зависимостями симуляторов.
+ */
+function createDev({ trackMqtt, defineRule }) {
+    const handler = {
+        get(_target, prop) {
+            // Прозрачное чтение значения.
+            return state[prop];
+        },
+        set(_target, prop, value) {
+            const changed = state[prop] !== value;
+            // Устанавливаем новое значение в хранилище.
+            if (changed)
+                state[prop] = value;
+            const [deviceName, controlName] = prop.split('/');
+            if (!controlName)
+                throw new DevSetValueError(prop);
+            // Оповещаем о любом обновлении.
+            trackMqtt.publish({
+                topic: `/devices/${deviceName}/controls/${controlName}`,
+                value,
+            });
+            // Отправляем только изменённое значение.
+            if (changed)
+                defineRule.run({
+                    topic: prop,
+                    value,
+                }, {
+                    force: true,
+                });
+            return true;
+        },
+    };
+    function reset() {
+        state = {};
+        global.dev = new Proxy(state, handler);
+    }
+    reset();
+    // Возвращаем прокси, который будет использоваться как `global.dev`.
+    return {
+        reset,
+    };
+}
+/**
+ * Хранилище для экземпляра прокси, чтобы он был доступен при сбросе.
+ */
+let instance$4;
+/**
+ * Возвращает инициализированный прокси для `dev`. Создает его, если он еще не существует.
+ * @param options Конфигурация с зависимостями.
+ */
+function useDev(options) {
+    return instance$4 ??= createDev(options);
+}
+
+function createInstance$2() {
     let mqttEvent;
-    let values = {};
     function reset() {
         mqttEvent = useEvent();
-        values = {};
         global.defineRule = (variantA, variantB) => {
             const rule = typeof variantA !== 'string'
                 ? variantA
                 : variantB;
             if (!rule)
-                return;
+                return 0;
             mqttEvent.on(({ topic, value }) => {
                 if (rule.whenChanged === topic)
                     rule.then(value);
             });
+            return 0;
         };
     }
-    // Поведение движка wb-rules, отправляет только изменившиеся значения.
-    function isValueChanged(message) {
-        if (options.allowSameValue)
-            return true;
-        if (values[message.topic] === message.value) {
-            const error = new SameTopicValueError(message);
-            Error.captureStackTrace(error, isValueChanged);
-            throw error;
-        }
-        values[message.topic] = message.value;
-        return true;
-    }
     /** Отправляет одно или несколько сообщений */
-    function run(payload) {
-        if (!Array.isArray(payload)) {
-            if (isValueChanged(payload))
-                mqttEvent.raise(payload);
-        }
-        else {
-            payload.forEach((item) => {
-                if (isValueChanged(item))
-                    mqttEvent.raise(item);
-            });
-        }
+    function run(payload, options = {}) {
+        const { force = false } = options;
+        payload = Array.isArray(payload) ? payload : [payload];
+        payload.forEach((item) => {
+            if (dev[item.topic] === item.value && !force) {
+                // Значение не изменилось, симуляторы не запускаем.
+                return;
+            }
+            // Устанавливаем значение во внутреннее состояние.
+            setValueSilent(item.topic, item.value);
+            // Инициируем событие. Ивент не проверяет изменения, он просто вызывает коллбек.
+            mqttEvent.raise(item);
+        });
     }
     reset();
     return {
@@ -61,10 +110,21 @@ function createInstance$2(options) {
 }
 // let instance: DefineRuleSimulator | undefined
 /** Имитатор конструкции defineRule. */
-function useDefineRule(options = {}) {
-    return /* instance ??= */ createInstance$2(options);
+function useDefineRule() {
+    return /* instance ??= */ createInstance$2();
 }
 
+function parseDeviceTopic(topic) {
+    if (!topic.startsWith('/devices/'))
+        return;
+    const match = /^\/devices\/([^/]+)\/controls\/([^/]+)$/.exec(topic);
+    if (!match)
+        return;
+    return {
+        deviceName: match[1],
+        controlName: match[2],
+    };
+}
 function createInstance$1() {
     let mqttEvent;
     function reset() {
@@ -77,17 +137,22 @@ function createInstance$1() {
         };
     }
     function publish(payload) {
-        if (!Array.isArray(payload))
-            mqttEvent.raise(payload);
-        else
-            payload.forEach((item) => {
-                mqttEvent.raise(item);
-            });
+        payload = Array.isArray(payload) ? payload : [payload];
+        payload.forEach((item) => {
+            const parts = parseDeviceTopic(item.topic);
+            if (parts) {
+                // Устанавливаем значение во внутреннее состояние.
+                setValueSilent(`${parts.deviceName}/${parts.controlName}`, item.value);
+            }
+            // Инициируем событие. Ивент не проверяет изменения, он просто вызывает коллбек.
+            mqttEvent.raise(item);
+        });
     }
     function withDevice(deviceId) {
         return {
             publish(controlId, value) {
-                mqttEvent.raise({
+                // Устанавливаем значение через publish, чтобы не дублировать логику.
+                publish({
                     topic: `/devices/${deviceId}/controls/${controlId}`,
                     value,
                 });
@@ -128,21 +193,22 @@ function useGetDevice() {
 }
 
 function createInstance() {
-    let values = {};
     function reset() {
-        values = {};
-        global.getControl = (devicePath) => {
+        global.getControl = (controlPath) => {
             return mock({
-                getValue: () => values[devicePath],
+                getValue: () => dev[controlPath],
+                setValue: rawValue => dev[controlPath] = isObject(rawValue)
+                    ? rawValue.value
+                    : rawValue,
             });
         };
     }
     function defineValue(deviceId, controlId, value) {
-        values[`${deviceId}/${controlId}`] = value;
+        dev[`${deviceId}/${controlId}`] = value;
     }
     function defineValues(presets) {
         presets.forEach((preset) => {
-            values[`${preset.deviceId}/${preset.controlId}`] = preset.value;
+            dev[`${preset.deviceId}/${preset.controlId}`] = preset.value;
         });
     }
     reset();
@@ -196,7 +262,7 @@ function defineZigbeeDevice(deviceId) {
     };
 }
 
-function createSimulator(options) {
+function createSimulator() {
     const simulators = {};
     function reset() {
         for (const key in simulators)
@@ -204,8 +270,11 @@ function createSimulator(options) {
     }
     const getDevice = (simulators.getDevice ??= useGetDevice());
     const getControl = (simulators.getControl ??= useGetControl());
-    const defineRule = (simulators.defineRule ??= useDefineRule(options.defineRule));
+    const defineRule = (simulators.defineRule ??= useDefineRule());
     const trackMqtt = (simulators.trackMqtt ??= useTrackMqtt());
+    // Создаем и устанавливаем прокси на dev, передавая ему зависимости.
+    // Это должно быть сделано ПОСЛЕ инициализации defineRule и trackMqtt.
+    simulators.dev ??= useDev({ defineRule, trackMqtt });
     return {
         reset,
         getDevice,
@@ -217,8 +286,8 @@ function createSimulator(options) {
 }
 let instance;
 /** Единая точка входа для настройки симуляции. */
-function useSimulator(options = {}) {
-    return instance ??= createSimulator(options);
+function useSimulator() {
+    return instance ??= createSimulator();
 }
 
 export { defineZigbeeDevice, useDefineRule, useGetControl, useGetDevice, useSimulator, useTrackMqtt };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mirta/testing",
   "description": "A unit-test runner equipped with built-in Wiren Board runtime emulation",
-  "version": "0.4.12",
+  "version": "0.5.0",
   "license": "Unlicense",
   "keywords": [
     "mirta",
@@ -14,6 +14,9 @@
     "README.md"
   ],
   "types": "./dist/index.d.mts",
+  "imports": {
+    "#*": "./src/*.js"
+  },
   "exports": {
     ".": {
       "import": {
@@ -39,12 +42,12 @@
   },
   "dependencies": {
     "vitest-mock-extended": "^3.1.0",
-    "@mirta/env-loader": "0.4.12",
-    "@mirta/workspace": "0.4.12",
-    "mirta": "0.4.12"
+    "@mirta/env-loader": "0.5.0",
+    "@mirta/workspace": "0.5.0",
+    "mirta": "0.5.0"
   },
   "devDependencies": {
-    "@mirta/rollup": "0.4.12"
+    "@mirta/rollup": "0.5.0"
   },
   "scripts": {
     "build:mono": "rollup -c"