@miot-rn/common-component 1.0.2 → 1.0.4

package/dist/store/useGlobalSpecManager.test.js

@@ -0,0 +1,247 @@
+/// <reference types="jest" />
+
+import useGlobalSpecManager, { toKey } from "./useGlobalSpecManager";
+import { setProps, subscribe } from "../service/specs/index.js";
+jest.mock("../service/specs/index.js", () => ({
+  getProps: jest.fn(),
+  setProps: jest.fn(),
+  doAction: jest.fn(),
+  subscribe: jest.fn()
+}), {
+  virtual: true
+});
+jest.mock("../utils/spec.js", () => ({
+  encodeProp: prop => {
+    const type = prop.eiid != null ? 'event' : prop.aiid != null ? 'action' : 'prop';
+    const id = prop.eiid ?? prop.aiid ?? prop.piid;
+    return `${type}.${prop.siid}.${id}`;
+  }
+}), {
+  virtual: true
+});
+jest.mock("../utils/objects.js", () => ({
+  deepEqual: (left, right) => JSON.stringify(left) === JSON.stringify(right)
+}), {
+  virtual: true
+});
+const spec = {
+  siid: 2,
+  piid: 1
+};
+const key = toKey(spec);
+const baseSetSpecs = useGlobalSpecManager.getState().setSpecs;
+let setSpecsRequests = [];
+const getSpecState = () => useGlobalSpecManager.getState();
+const resetManager = () => {
+  useGlobalSpecManager.setState({
+    specsMetaInfo: {},
+    specsState: {},
+    pendingKeys: new Set(),
+    eventListeners: {},
+    subscribedSpecs: new Set(),
+    specUpdateListeners: []
+  });
+};
+const subscribeToSpec = async () => {
+  let onUpdate;
+  subscribe.mockImplementationOnce(async (_specs, listener) => {
+    onUpdate = listener;
+    return {
+      unsubscribe: jest.fn()
+    };
+  });
+  await useGlobalSpecManager.getState().subscribeSpecs([spec]);
+  if (!onUpdate) {
+    throw new Error('subscribe callback was not registered');
+  }
+  return onUpdate;
+};
+const flushPromises = async () => {
+  await Promise.resolve();
+  jest.advanceTimersByTime(0);
+  await Promise.resolve();
+  jest.advanceTimersByTime(0);
+  await Promise.resolve();
+};
+const sentValues = () => {
+  const calls = setProps.mock.calls;
+  return calls.map(call => call[0][0].value);
+};
+describe('useGlobalSpecManager spec updates', () => {
+  beforeEach(() => {
+    jest.useFakeTimers();
+    jest.clearAllMocks();
+    resetManager();
+    setSpecsRequests = [];
+    useGlobalSpecManager.setState({
+      setSpecs: specs => {
+        const request = baseSetSpecs(specs);
+        setSpecsRequests.push(request);
+        return request;
+      }
+    });
+    setProps.mockResolvedValue([{
+      code: 0,
+      specDataSource: 'set-response'
+    }]);
+  });
+  afterEach(() => {
+    jest.runOnlyPendingTimers();
+    jest.useRealTimers();
+  });
+  it('sends 1 and 3, then displays pushed value 4 when the push arrives after trailing set', async () => {
+    const onUpdate = await subscribeToSpec();
+    await useGlobalSpecManager.getState().setSpec({
+      ...spec,
+      value: 1
+    });
+    jest.advanceTimersByTime(100);
+    await useGlobalSpecManager.getState().setSpec({
+      ...spec,
+      value: 2
+    });
+    jest.advanceTimersByTime(100);
+    await useGlobalSpecManager.getState().setSpec({
+      ...spec,
+      value: 3
+    });
+    jest.advanceTimersByTime(1010);
+    expect(sentValues()).toEqual([1, 3]);
+    await setSpecsRequests[1];
+    onUpdate({
+      ...spec,
+      value: 4,
+      updateTime: 1010,
+      specDataSource: 'device-push'
+    });
+    jest.advanceTimersByTime(2000);
+    await flushPromises();
+    expect(getSpecState().specsState[key]).toBe(4);
+  });
+  it('delays a push received 1000ms after a second leading set, then displays the pushed value', async () => {
+    const onUpdate = await subscribeToSpec();
+    await useGlobalSpecManager.getState().setSpec({
+      ...spec,
+      value: 1
+    });
+    jest.advanceTimersByTime(1010);
+    await useGlobalSpecManager.getState().setSpec({
+      ...spec,
+      value: 2
+    });
+    expect(sentValues()).toEqual([1, 2]);
+    jest.advanceTimersByTime(1000);
+    onUpdate({
+      ...spec,
+      value: 3,
+      updateTime: 2010,
+      specDataSource: 'device-push'
+    });
+    expect(getSpecState().specsState[key]).toBe(2);
+    jest.advanceTimersByTime(1000);
+    await flushPromises();
+    expect(getSpecState().specsState[key]).toBe(3);
+  });
+  it('sends 1 and 2, and ignores an intermediate pushed value 3', async () => {
+    const onUpdate = await subscribeToSpec();
+    await useGlobalSpecManager.getState().setSpec({
+      ...spec,
+      value: 1
+    });
+    jest.advanceTimersByTime(100);
+    await useGlobalSpecManager.getState().setSpec({
+      ...spec,
+      value: 2
+    });
+    jest.advanceTimersByTime(400);
+    onUpdate({
+      ...spec,
+      value: 3,
+      updateTime: 500,
+      specDataSource: 'device-push'
+    });
+    jest.advanceTimersByTime(600);
+    expect(sentValues()).toEqual([1, 2]);
+    await setSpecsRequests[1];
+    jest.advanceTimersByTime(2000);
+    await flushPromises();
+    expect(getSpecState().specsState[key]).toBe(2);
+  });
+  it('sends 1 and eventually displays pushed value 3 when there is no trailing set', async () => {
+    const onUpdate = await subscribeToSpec();
+    await useGlobalSpecManager.getState().setSpec({
+      ...spec,
+      value: 1
+    });
+    jest.advanceTimersByTime(20);
+    onUpdate({
+      ...spec,
+      value: 3,
+      updateTime: 20,
+      specDataSource: 'device-push'
+    });
+    expect(sentValues()).toEqual([1]);
+    jest.advanceTimersByTime(2000);
+    await flushPromises();
+    expect(getSpecState().specsState[key]).toBe(3);
+  });
+  it('sends 1 and 3, with trailing value 3 overriding a push of 4 received after 10ms', async () => {
+    const onUpdate = await subscribeToSpec();
+    await useGlobalSpecManager.getState().setSpec({
+      ...spec,
+      value: 1
+    });
+    jest.advanceTimersByTime(100);
+    await useGlobalSpecManager.getState().setSpec({
+      ...spec,
+      value: 2
+    });
+    jest.advanceTimersByTime(100);
+    await useGlobalSpecManager.getState().setSpec({
+      ...spec,
+      value: 3
+    });
+    jest.advanceTimersByTime(10);
+    onUpdate({
+      ...spec,
+      value: 4,
+      updateTime: 210,
+      specDataSource: 'device-push'
+    });
+    jest.advanceTimersByTime(990);
+    expect(sentValues()).toEqual([1, 3]);
+    await setSpecsRequests[1];
+    expect(getSpecState().specsState[key]).toBe(3);
+  });
+  it('sends only the leading and final values for five rapid updates', async () => {
+    await subscribeToSpec();
+    await useGlobalSpecManager.getState().setSpec({
+      ...spec,
+      value: 1
+    });
+    jest.advanceTimersByTime(100);
+    await useGlobalSpecManager.getState().setSpec({
+      ...spec,
+      value: 2
+    });
+    jest.advanceTimersByTime(100);
+    await useGlobalSpecManager.getState().setSpec({
+      ...spec,
+      value: 3
+    });
+    jest.advanceTimersByTime(100);
+    await useGlobalSpecManager.getState().setSpec({
+      ...spec,
+      value: 4
+    });
+    jest.advanceTimersByTime(100);
+    await useGlobalSpecManager.getState().setSpec({
+      ...spec,
+      value: 5
+    });
+    jest.advanceTimersByTime(1000);
+    expect(sentValues()).toEqual([1, 5]);
+    await setSpecsRequests[1];
+    expect(getSpecState().specsState[key]).toBe(5);
+  });
+});

package/dist/utils/subscribe-log.d.ts

@@ -0,0 +1 @@
+export declare function reportSubLog(line: string, level?: 'log' | 'error'): void;

package/dist/utils/subscribe-log.js

@@ -0,0 +1,37 @@
+/* eslint-disable no-console, global-require, @typescript-eslint/no-var-requires */
+
+/**
+ * 订阅链路日志：同时写 console 和用户反馈日志。
+ *
+ * console 只有连着调试工具才看得见，测试同学复现「偶现收不到订阅推送」后捞不到；
+ * 只有 Service.smarthome.reportLog 才会落到可上传的反馈日志里。
+ * 订阅链路的静默失败只能靠现场日志定位，因此这条链路必须双写。
+ *
+ * 入参是已经拼好的整行日志（而不是分段字段），这样各调用点的字符串保持原样：
+ * 既让 console 与反馈日志内容完全一致，也不影响按 console 输出断言的既有用例。
+ *
+ * 注意：这里刻意用惰性 require 而非顶层 import 'miot'。
+ * 'miot' 由插件宿主在运行时提供，本仓库并未安装（单测里是 jest.mock(..., { virtual: true })），
+ * 顶层 import 会让所有引入本文件的模块在未 mock 'miot' 的用例里直接解析失败。
+ * 请勿"顺手"改成顶层 import。
+ *
+ * @param line 已格式化的日志行，约定以 [SPEC-SUB] 开头，便于在反馈日志里 grep
+ * @param level console 输出级别，保持与各调用点原有的严重级别一致
+ */
+export function reportSubLog(line, level = 'log') {
+  if (level === 'error') {
+    console.error(line);
+  } else {
+    console.log(line);
+  }
+  try {
+    const {
+      Device,
+      Service
+    } = require('miot');
+    Service.smarthome.reportLog(Device.model, line);
+  } catch (e) {
+    // 上报失败绝不能影响订阅链路本身，降级为 console
+    console.log(`[SPEC-SUB][reportSubLog] 反馈日志上报失败: ${e?.message}`);
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@miot-rn/common-component",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "scripts": {
     "build": "rm -rf dist && rm -f tsconfig.tsbuildinfo && tsc && babel src -d dist --config-file ../../babel.config.js --extensions '.ts,.tsx' --verbose",
     "lint": "eslint src/**/*.ts",
@@ -23,5 +23,5 @@
     "react-native": "0.61.0",
     "zustand": "^4.4.1"
   },
-  "gitHead": "2920def2cc542a8d0efcf100814e477830d94bb3"
+  "gitHead": "6b073a3112c245f3984c25378074473d5153c235"
 }