@onekeyfe/hd-ble-sdk 1.2.2-alpha.11 → 1.2.2-alpha.111

package/README.md

@@ -30,7 +30,7 @@ function init() {
 
 ## Docs
 
-Documentation is available [hardware-js-sdk](https://developer.onekey.so/connect-to-hardware/hardware-sdk/start)
+Documentation is available [Hardware SDK Getting Started](https://developer.onekey.so/en/hardware-sdk/getting-started)
 
 ## Examples
 // TODO: add example url

package/__tests__/device-state-events.test.ts

@@ -1,5 +1,22 @@
 import { readFileSync } from 'fs';
 import { resolve } from 'path';
+import EventEmitter from 'events';
+import { CORE_EVENT, initCore } from '@onekeyfe/hd-core';
+import { createDeferred } from '@onekeyfe/hd-shared';
+
+import sdkExport, { messagePromises } from '../src';
+
+jest.mock('../../core/src/data/config', () => ({
+  getSDKVersion: jest.fn(() => '1.0.0-test'),
+  DEFAULT_DOMAIN: 'https://jssdk.onekey.so/1.0.0-test/',
+}));
+jest.mock('@onekeyfe/hd-core', () => ({
+  ...jest.requireActual('@onekeyfe/hd-core'),
+  __esModule: true,
+  default: (options: unknown) => options,
+  initCore: jest.fn(),
+}));
+jest.mock('@onekeyfe/hd-transport-react-native', () => ({}));
 
 describe('hd-ble-sdk device state events', () => {
   test('forwards DEVICE.STATE to React Native SDK consumers', () => {
@@ -13,3 +30,64 @@ describe('hd-ble-sdk device state events', () => {
     expect(deviceEventHandler).toContain('eventEmitter.emit(message.type, message.payload)');
   });
 });
+
+const sdk = sdkExport as unknown as {
+  init(settings: Record<string, unknown>): Promise<boolean>;
+  call(params: Record<string, unknown>): Promise<unknown>;
+  dispose(): Promise<void>;
+};
+
+describe('SDK request cleanup', () => {
+  const core = Object.assign(new EventEmitter(), {
+    handleMessage: jest.fn(),
+    dispose: jest.fn(),
+  });
+
+  beforeEach(async () => {
+    core.handleMessage.mockReset();
+    core.dispose.mockReset().mockImplementation(() => {
+      core.removeAllListeners();
+      return Promise.resolve();
+    });
+    jest.mocked(initCore).mockResolvedValue(core as never);
+    await sdk.init({ env: 'desktop-web-ble' });
+  });
+
+  afterEach(async () => {
+    await sdk.dispose();
+  });
+
+  test('removes only the completed request when calls settle out of order', async () => {
+    const first = createDeferred<unknown>();
+    const second = createDeferred<unknown>();
+    core.handleMessage.mockReturnValueOnce(first.promise).mockReturnValueOnce(second.promise);
+    const firstCall = sdk.call({ method: 'getDeviceState' });
+    const secondCall = sdk.call({ method: 'getDeviceState' });
+    expect(Object.keys(messagePromises)).toHaveLength(2);
+    second.resolve({ success: true, payload: {} });
+    await secondCall;
+    expect(Object.keys(messagePromises)).toHaveLength(1);
+    first.reject(new Error('Connection failed'));
+    await firstCall;
+    expect(Object.keys(messagePromises)).toHaveLength(0);
+  });
+
+  test('waits for Core disposal and does not retain old listeners after reinitialization', async () => {
+    const cleanup = createDeferred<void>();
+    core.dispose.mockImplementationOnce(async () => {
+      await cleanup.promise;
+      core.removeAllListeners();
+    });
+    let finished = false;
+    const disposing = sdk.dispose().then(() => {
+      finished = true;
+    });
+    await Promise.resolve();
+    expect(core.dispose).toHaveBeenCalledTimes(1);
+    expect(finished).toBe(false);
+    cleanup.resolve();
+    await disposing;
+    await sdk.init({ env: 'desktop-web-ble' });
+    expect(core.listenerCount(CORE_EVENT)).toBe(1);
+  });
+});

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AASpD,eAAO,MAAM,eAAe,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAA;CAAO,CAAC;AAuJpE,QAAA,MAAM,cAAc,qCASlB,CAAC;AAEH,eAAe,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AASpD,eAAO,MAAM,eAAe,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAA;CAAO,CAAC;AA+JpE,QAAA,MAAM,cAAc,qCASlB,CAAC;AAEH,eAAe,cAAc,CAAC"}

package/dist/index.js

@@ -523,10 +523,17 @@ let _core;
 let _settings = HardwareSdk.parseConnectSettings();
 let _messageID = 0;
 const messagePromises = {};
-const dispose = () => {
+const dispose = () => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    const core = _core;
+    _core = undefined;
     eventEmitter.removeAllListeners();
+    Object.keys(messagePromises).forEach(key => {
+        delete messagePromises[Number(key)];
+    });
     _settings = HardwareSdk.parseConnectSettings();
-};
+    yield ((_a = core === null || core === void 0 ? void 0 : core.dispose) === null || _a === void 0 ? void 0 : _a.call(core));
+});
 const uiResponse = (response) => {
     if (!_core) {
         throw hdShared.ERRORS.TypedError(hdShared.HardwareErrorCode.NotInitialized);
@@ -597,9 +604,14 @@ function postMessage(message, usePromise = true) {
         }
         if (usePromise) {
             _messageID++;
-            messagePromises[_messageID] = hdShared.createDeferred();
-            const response = yield _core.handleMessage(Object.assign(Object.assign({}, message), { id: `${_messageID}` }));
-            return response;
+            const messageId = _messageID;
+            messagePromises[messageId] = hdShared.createDeferred();
+            try {
+                return yield _core.handleMessage(Object.assign(Object.assign({}, message), { id: `${messageId}` }));
+            }
+            finally {
+                delete messagePromises[messageId];
+            }
         }
         _core.handleMessage(message);
     });
@@ -620,7 +632,7 @@ const init = (settings) => __awaiter(void 0, void 0, void 0, function* () {
     }
 });
 const call = (params) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b, _c;
+    var _b, _c, _d;
     const blockLog = HardwareSdk.getLogBlockLabel(params);
     Log.debug('call: ', blockLog !== null && blockLog !== void 0 ? blockLog : params);
     try {
@@ -628,13 +640,13 @@ const call = (params) => __awaiter(void 0, void 0, void 0, function* () {
         if (response) {
             Log.debug('response: ', blockLog ? '[REDACTED]' : response);
             if (!response.success) {
-                if (((_a = response.payload) === null || _a === void 0 ? void 0 : _a.code) === hdShared.HardwareErrorCode.BlePermissionError) {
+                if (((_b = response.payload) === null || _b === void 0 ? void 0 : _b.code) === hdShared.HardwareErrorCode.BlePermissionError) {
                     postMessage(HardwareSdk.createUiMessage(HardwareSdk.UI_REQUEST.BLUETOOTH_PERMISSION), false);
                 }
-                if (((_b = response.payload) === null || _b === void 0 ? void 0 : _b.code) === hdShared.HardwareErrorCode.BleLocationError) {
+                if (((_c = response.payload) === null || _c === void 0 ? void 0 : _c.code) === hdShared.HardwareErrorCode.BleLocationError) {
                     postMessage(HardwareSdk.createUiMessage(HardwareSdk.UI_REQUEST.LOCATION_PERMISSION), false);
                 }
-                if (((_c = response.payload) === null || _c === void 0 ? void 0 : _c.code) === hdShared.HardwareErrorCode.BleLocationServicesDisabled) {
+                if (((_d = response.payload) === null || _d === void 0 ? void 0 : _d.code) === hdShared.HardwareErrorCode.BleLocationServicesDisabled) {
                     postMessage(HardwareSdk.createUiMessage(HardwareSdk.UI_REQUEST.LOCATION_SERVICE_PERMISSION), false);
                 }
             }

package/jest.config.js

@@ -0,0 +1,10 @@
+module.exports = {
+  preset: '../../jest.config.js',
+  testEnvironment: 'node',
+  modulePathIgnorePatterns: ['node_modules', '<rootDir>/dist'],
+  moduleNameMapper: {
+    '^@onekeyfe/hd-core$': '<rootDir>/../core/src/index.ts',
+    '^@onekeyfe/hd-shared$': '<rootDir>/../shared/src/index.ts',
+    '^@onekeyfe/hd-transport-react-native$': '<rootDir>/../hd-transport-react-native/src/index.ts',
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onekeyfe/hd-ble-sdk",
-  "version": "1.2.2-alpha.11",
+  "version": "1.2.2-alpha.111",
   "author": "OneKey",
   "homepage": "https://github.com/OneKeyHQ/hardware-js-sdk#readme",
   "license": "ISC",
@@ -16,13 +16,14 @@
   "scripts": {
     "dev": "rimraf dist && rollup -c ../../build/rollup.config.js -w",
     "build": "rimraf dist && rollup -c ../../build/rollup.config.js",
+    "test": "jest",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix"
   },
   "dependencies": {
-    "@onekeyfe/hd-core": "1.2.2-alpha.11",
-    "@onekeyfe/hd-shared": "1.2.2-alpha.11",
-    "@onekeyfe/hd-transport-react-native": "1.2.2-alpha.11"
+    "@onekeyfe/hd-core": "1.2.2-alpha.111",
+    "@onekeyfe/hd-shared": "1.2.2-alpha.111",
+    "@onekeyfe/hd-transport-react-native": "1.2.2-alpha.111"
   },
-  "gitHead": "8928100acb893d72361eb74422d5e2a0f7af77d8"
+  "gitHead": "a87be5a4ae4b59f91f853a9873a9e8e924bbdfd6"
 }

package/src/index.ts

@@ -33,9 +33,15 @@ let _settings = parseConnectSettings();
 let _messageID = 0;
 export const messagePromises: { [key: number]: Deferred<any> } = {};
 
-const dispose = () => {
+const dispose = async () => {
+  const core = _core;
+  _core = undefined;
   eventEmitter.removeAllListeners();
+  Object.keys(messagePromises).forEach(key => {
+    delete messagePromises[Number(key)];
+  });
   _settings = parseConnectSettings();
+  await core?.dispose?.();
 };
 
 const uiResponse = (response: UiResponseEvent) => {
@@ -114,11 +120,13 @@ async function postMessage(message: CoreMessage, usePromise = true) {
 
   if (usePromise) {
     _messageID++;
-    messagePromises[_messageID] = createDeferred();
-    // const { promise } = messagePromises[_messageID];
-    const response = await _core.handleMessage({ ...message, id: `${_messageID}` });
-    // return promise;
-    return response;
+    const messageId = _messageID;
+    messagePromises[messageId] = createDeferred();
+    try {
+      return await _core.handleMessage({ ...message, id: `${messageId}` });
+    } finally {
+      delete messagePromises[messageId];
+    }
   }
 
   _core.handleMessage(message);