@onekeyfe/hd-common-connect-sdk 1.2.3-alpha.2 → 1.2.3-alpha.4

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-event.test.js

@@ -2,6 +2,10 @@ import { CORE_EVENT, DEVICE, DEVICE_EVENT, initCore } from '@onekeyfe/hd-core';
 
 import HardwareCommonConnectSdk 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', () => {
   const actual = jest.requireActual('@onekeyfe/hd-core');
   return {

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

@@ -1,5 +1,25 @@
 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-http', () => ({}));
+jest.mock('@onekeyfe/hd-transport-web-device', () => ({}));
+jest.mock('@onekeyfe/hd-transport-lowlevel', () => ({}));
+jest.mock('@onekeyfe/hd-transport-emulator', () => ({}));
 
 describe('hd-common-connect-sdk device state events', () => {
   test('forwards the canonical DEVICE.STATE event to SDK consumers', () => {
@@ -9,3 +29,64 @@ describe('hd-common-connect-sdk device state events', () => {
     expect(source).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.js

@@ -679,22 +679,26 @@ function handleMessage(message) {
 function postMessage(message, usePromise) {
     if (usePromise === void 0) { usePromise = true; }
     return __awaiter(this, void 0, void 0, function () {
-        var response;
+        var messageId;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
                     if (!_core) {
                         throw hdShared.ERRORS.TypedError('postMessage: _core not found');
                     }
-                    if (!usePromise) return [3 /*break*/, 2];
+                    if (!usePromise) return [3 /*break*/, 4];
                     _messageID++;
-                    messagePromises[_messageID] = hdShared.createDeferred();
-                    return [4 /*yield*/, _core.handleMessage(__assign(__assign({}, message), { id: "".concat(_messageID) }))];
+                    messageId = _messageID;
+                    messagePromises[messageId] = hdShared.createDeferred();
+                    _a.label = 1;
                 case 1:
-                    response = _a.sent();
-                    // return promise;
-                    return [2 /*return*/, response];
-                case 2:
+                    _a.trys.push([1, , 3, 4]);
+                    return [4 /*yield*/, _core.handleMessage(__assign(__assign({}, message), { id: "".concat(messageId) }))];
+                case 2: return [2 /*return*/, _a.sent()];
+                case 3:
+                    delete messagePromises[messageId];
+                    return [7 /*endfinally*/];
+                case 4:
                     _core.handleMessage(message);
                     return [2 /*return*/];
             }

package/jest.config.js

@@ -0,0 +1,9 @@
+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',
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onekeyfe/hd-common-connect-sdk",
-  "version": "1.2.3-alpha.2",
+  "version": "1.2.3-alpha.4",
   "author": "OneKey",
   "homepage": "https://github.com/OneKeyHQ/hardware-js-sdk#readme",
   "license": "ISC",
@@ -16,17 +16,18 @@
   "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.3-alpha.2",
-    "@onekeyfe/hd-shared": "1.2.3-alpha.2",
-    "@onekeyfe/hd-transport-emulator": "1.2.3-alpha.2",
-    "@onekeyfe/hd-transport-http": "1.2.3-alpha.2",
-    "@onekeyfe/hd-transport-lowlevel": "1.2.3-alpha.2",
-    "@onekeyfe/hd-transport-usb": "1.2.3-alpha.2",
-    "@onekeyfe/hd-transport-web-device": "1.2.3-alpha.2"
+    "@onekeyfe/hd-core": "1.2.3-alpha.4",
+    "@onekeyfe/hd-shared": "1.2.3-alpha.4",
+    "@onekeyfe/hd-transport-emulator": "1.2.3-alpha.4",
+    "@onekeyfe/hd-transport-http": "1.2.3-alpha.4",
+    "@onekeyfe/hd-transport-lowlevel": "1.2.3-alpha.4",
+    "@onekeyfe/hd-transport-usb": "1.2.3-alpha.4",
+    "@onekeyfe/hd-transport-web-device": "1.2.3-alpha.4"
   },
-  "gitHead": "8b790c78394debdd3d9999db2f6a56235efb7a18"
+  "gitHead": "705729baaec54b86a4fc28cce310a85b67b82730"
 }

package/src/index.ts

@@ -132,11 +132,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);