@onekeyfe/hd-transport-react-native 1.2.0-alpha.6 → 1.2.0-alpha.61

package/dist/subscribeBleOn.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"subscribeBleOn.d.ts","sourceRoot":"","sources":["../src/subscribeBleOn.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,eAAO,MAAM,cAAc,eAAgB,aAAa,kBAAc,QAAQ,IAAI,CAqB9E,CAAC"}
+{"version":3,"file":"subscribeBleOn.d.ts","sourceRoot":"","sources":["../src/subscribeBleOn.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,eAAO,MAAM,cAAc,eAAgB,aAAa,kBAAc,QAAQ,IAAI,CAmB9E,CAAC"}

package/dist/transportLog.d.ts

@@ -0,0 +1,2 @@
+export { createTransportCallLog } from '@onekeyfe/hd-transport';
+//# sourceMappingURL=transportLog.d.ts.map

package/dist/transportLog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transportLog.d.ts","sourceRoot":"","sources":["../src/transportLog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/types.d.ts

@@ -7,5 +7,6 @@ export type BleAcquireInput = {
     uuid: string;
     forceCleanRunPromise?: boolean;
     expectedProtocol?: ProtocolType;
+    protocolHint?: ProtocolType;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE3D,YAAY,EAAE,UAAU,IAAI,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAExE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,gBAAgB,CAAC,EAAE,YAAY,CAAC;CACjC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE3D,YAAY,EAAE,UAAU,IAAI,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAExE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC"}

package/jest.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  preset: '../../jest.config.js',
+  testEnvironment: 'node',
+  modulePathIgnorePatterns: ['node_modules', '<rootDir>/dist'],
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onekeyfe/hd-transport-react-native",
-  "version": "1.2.0-alpha.6",
+  "version": "1.2.0-alpha.61",
   "homepage": "https://github.com/OneKeyHQ/hardware-js-sdk#readme",
   "license": "MIT",
   "main": "dist/index.js",
@@ -15,15 +15,16 @@
   "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.0-alpha.6",
-    "@onekeyfe/hd-shared": "1.2.0-alpha.6",
-    "@onekeyfe/hd-transport": "1.2.0-alpha.6",
-    "@onekeyfe/react-native-ble-utils": "^0.1.4",
+    "@onekeyfe/hd-core": "1.2.0-alpha.61",
+    "@onekeyfe/hd-shared": "1.2.0-alpha.61",
+    "@onekeyfe/hd-transport": "1.2.0-alpha.61",
+    "@onekeyfe/react-native-ble-utils": "^0.1.6",
     "react-native-ble-plx": "3.5.1"
   },
-  "gitHead": "b0a8d032546250b02bc737d72ac23932bdc07a61"
+  "gitHead": "19c6dc68cec2250bab703e802209ec7be586521d"
 }

package/src/BleTransport.ts

@@ -1,12 +1,7 @@
-import { BleErrorCode } from 'react-native-ble-plx';
-import { wait } from '@onekeyfe/hd-shared';
-
-import { bleLogger } from './logger';
+import { Platform } from 'react-native';
 
 import type { Characteristic, Device, Subscription } from 'react-native-ble-plx';
 
-const Log = bleLogger;
-
 export default class BleTransport {
   id: string;
 
@@ -28,10 +23,6 @@ export default class BleTransport {
 
   monitorToken?: number;
 
-  static MAX_RETRIES = 5;
-
-  static RETRY_DELAY = 2000;
-
   constructor(
     device: Device,
     writeCharacteristic: Characteristic,
@@ -43,37 +34,11 @@ export default class BleTransport {
     this.notifyCharacteristic = notifyCharacteristic;
   }
 
-  /**
-   * @description only for pro / touch , while upgrade firmware
-   * @param data
-   * @param retryCount
-   * @returns
-   */
-  async writeWithRetry(data: string, retryCount = BleTransport.MAX_RETRIES): Promise<void> {
-    try {
-      await this.writeCharacteristic.writeWithoutResponse(data);
-    } catch (error) {
-      Log?.debug(
-        `Write retry attempt ${BleTransport.MAX_RETRIES - retryCount + 1}, error: ${error}`
-      );
-      if (retryCount > 0) {
-        await wait(BleTransport.RETRY_DELAY);
-        if (
-          error.errorCode === BleErrorCode.DeviceDisconnected ||
-          error.errorCode === BleErrorCode.CharacteristicNotFound
-        ) {
-          try {
-            await this.device.connect();
-            await this.device.discoverAllServicesAndCharacteristics();
-          } catch (e) {
-            Log?.debug(`Connect or discoverAllServicesAndCharacteristics error: ${e}`);
-          }
-        } else {
-          Log?.debug(`writeCharacteristic error: ${error}`);
-        }
-        return this.writeWithRetry(data, retryCount - 1);
-      }
-      throw error;
+  async writeWithRetry(data: string): Promise<void> {
+    if (Platform.OS === 'ios' && this.writeCharacteristic.isWritableWithResponse) {
+      await this.writeCharacteristic.writeWithResponse(data);
+      return;
     }
+    await this.writeCharacteristic.writeWithoutResponse(data);
   }
 }

package/src/__tests__/BleTransport.test.ts

@@ -0,0 +1,93 @@
+import { BleErrorCode } from 'react-native-ble-plx';
+import { Platform } from 'react-native';
+
+import BleTransport from '../BleTransport';
+
+jest.mock(
+  'react-native',
+  () => ({
+    Platform: { OS: 'ios' },
+  }),
+  { virtual: true }
+);
+
+jest.mock(
+  'react-native-ble-plx',
+  () => ({
+    BleErrorCode: {
+      DeviceDisconnected: 205,
+      CharacteristicNotFound: 404,
+    },
+  }),
+  { virtual: true }
+);
+
+jest.mock('@onekeyfe/hd-shared', () => ({
+  ...jest.requireActual('@onekeyfe/hd-shared'),
+  wait: jest.fn(() => Promise.resolve()),
+}));
+
+describe('BleTransport side-effecting writes', () => {
+  beforeEach(() => {
+    Platform.OS = 'ios';
+  });
+
+  test('does not reconnect or replay after the device disconnects', async () => {
+    const error = Object.assign(new Error('device disconnected'), {
+      errorCode: BleErrorCode.DeviceDisconnected,
+    });
+    const writeCharacteristic = {
+      isWritableWithResponse: true,
+      writeWithResponse: jest.fn(() => Promise.reject(error)),
+      writeWithoutResponse: jest.fn(() => Promise.resolve()),
+    };
+    const device = {
+      id: 'classic-id',
+      connect: jest.fn(() => Promise.resolve()),
+      discoverAllServicesAndCharacteristics: jest.fn(() => Promise.resolve()),
+    };
+    const transport = new BleTransport(device as any, writeCharacteristic as any, {} as any);
+
+    await expect(transport.writeWithRetry('payload')).rejects.toBe(error);
+
+    expect(writeCharacteristic.writeWithResponse).toHaveBeenCalledTimes(1);
+    expect(device.connect).not.toHaveBeenCalled();
+  });
+
+  test('keeps Android Protocol V1 writes on writeWithoutResponse', async () => {
+    Platform.OS = 'android';
+    const writeCharacteristic = {
+      isWritableWithResponse: true,
+      writeWithResponse: jest.fn(() => Promise.resolve()),
+      writeWithoutResponse: jest.fn(() => Promise.resolve()),
+    };
+    const transport = new BleTransport(
+      { id: 'classic-id' } as any,
+      writeCharacteristic as any,
+      {} as any
+    );
+
+    await transport.writeWithRetry('payload');
+
+    expect(writeCharacteristic.writeWithResponse).not.toHaveBeenCalled();
+    expect(writeCharacteristic.writeWithoutResponse).toHaveBeenCalledWith('payload');
+  });
+
+  test('uses writeWithoutResponse on iOS when the characteristic lacks response support', async () => {
+    const writeCharacteristic = {
+      isWritableWithResponse: false,
+      writeWithResponse: jest.fn(() => Promise.resolve()),
+      writeWithoutResponse: jest.fn(() => Promise.resolve()),
+    };
+    const transport = new BleTransport(
+      { id: 'classic-id' } as any,
+      writeCharacteristic as any,
+      {} as any
+    );
+
+    await transport.writeWithRetry('payload');
+
+    expect(writeCharacteristic.writeWithResponse).not.toHaveBeenCalled();
+    expect(writeCharacteristic.writeWithoutResponse).toHaveBeenCalledWith('payload');
+  });
+});

package/src/__tests__/bleStrategy.test.ts

@@ -1,8 +1,4 @@
-import {
-  hasWritableCapability,
-  resolveBleWriteMode,
-  resolveProtocolV2PacketCapacity,
-} from '../bleStrategy';
+import { hasWritableCapability, resolveProtocolV2PacketCapacity } from '../bleStrategy';
 
 describe('React Native BLE strategy', () => {
   test('accepts writeWithoutResponse-only characteristics', () => {
@@ -12,7 +8,6 @@ describe('React Native BLE strategy', () => {
     };
 
     expect(hasWritableCapability(characteristic)).toBe(true);
-    expect(resolveBleWriteMode(characteristic)).toBe('withoutResponse');
   });
 
   test('falls back to Android default ATT payload when MTU is unavailable', () => {

package/src/__tests__/constants.test.ts

@@ -0,0 +1,20 @@
+import { getBluetoothServiceUuids, getInfosForServiceUuid } from '../constants';
+
+describe('React Native BLE service filters', () => {
+  test('does not scan or configure the ignored FFFD service', () => {
+    expect(getBluetoothServiceUuids()).not.toContain('fffd');
+    expect(getInfosForServiceUuid('fffd', 'classic')).toBeNull();
+    expect(getInfosForServiceUuid('0000fffd-0000-1000-8000-00805f9b34fb', 'classic')).toBeNull();
+  });
+
+  test('keeps the OneKey communication service configured', () => {
+    expect(getBluetoothServiceUuids()).toContain('00000001-0000-1000-8000-00805f9b34fb');
+    expect(getInfosForServiceUuid('0001', 'classic')).toMatchObject({
+      serviceUuid: '00000001-0000-1000-8000-00805f9b34fb',
+    });
+  });
+
+  test('does not match a vendor-specific UUID containing the OneKey short key', () => {
+    expect(getInfosForServiceUuid('abcd0001-1234-5678-9012-abcdefabcdef', 'classic')).toBeNull();
+  });
+});

package/src/__tests__/enumerate.test.ts

@@ -0,0 +1,132 @@
+import { EventEmitter } from 'events';
+
+import { getConnectedDeviceIds } from '../BleManager';
+import ReactNativeBleTransport from '../index';
+
+jest.mock(
+  'react-native',
+  () => ({
+    PermissionsAndroid: {},
+    Platform: { OS: 'ios' },
+  }),
+  { virtual: true }
+);
+
+jest.mock('react-native-ble-plx', () => ({
+  BleError: class BleError extends Error {},
+  BleErrorCode: {},
+  BleManager: jest.fn(),
+  ScanMode: { LowLatency: 2 },
+}));
+
+jest.mock('../BleManager', () => ({
+  getConnectedDeviceIds: jest.fn(),
+  onDeviceBondState: jest.fn(),
+  pairDevice: jest.fn(),
+}));
+
+jest.mock('../subscribeBleOn', () => ({
+  subscribeBleOn: jest.fn(() => Promise.resolve()),
+}));
+
+const ONEKEY_SERVICE_UUID = '00000001-0000-1000-8000-00805f9b34fb';
+
+describe('ReactNativeBleTransport iOS discovery', () => {
+  test('filters a bonded Pro2 Find My peripheral while keeping the wallet peripheral', async () => {
+    jest.mocked(getConnectedDeviceIds).mockResolvedValueOnce([
+      {
+        id: 'find-my-peripheral',
+        name: 'Pro2 6E9E - Find My',
+        localName: null,
+        serviceUUIDs: [ONEKEY_SERVICE_UUID],
+      },
+      {
+        id: 'wallet-peripheral',
+        name: 'Pro2 6E9E',
+        localName: 'Pro2 6E9E',
+        serviceUUIDs: [ONEKEY_SERVICE_UUID],
+      },
+    ] as never);
+    const blePlxManager = {
+      startDeviceScan: jest.fn(),
+      stopDeviceScan: jest.fn(),
+    };
+    const transport = new ReactNativeBleTransport({ scanTimeout: 1 });
+    transport.blePlxManager = blePlxManager as never;
+    transport.init({ debug: jest.fn(), error: jest.fn() }, new EventEmitter());
+
+    const devices = await transport.enumerate();
+
+    expect(devices.map(device => device.id)).toEqual(['wallet-peripheral']);
+  });
+
+  test('filters a scanned Pro2 Find My peripheral by name when localName is null', async () => {
+    jest.mocked(getConnectedDeviceIds).mockResolvedValueOnce([]);
+    const blePlxManager = {
+      startDeviceScan: jest.fn((_serviceUUIDs, _options, listener) => {
+        queueMicrotask(() => {
+          listener(null, {
+            id: 'find-my-peripheral',
+            name: 'Pro2 6E9E - Find My',
+            localName: null,
+            serviceUUIDs: [ONEKEY_SERVICE_UUID],
+          });
+          listener(null, {
+            id: 'wallet-peripheral',
+            name: 'Pro2 6E9E',
+            localName: 'Pro2 6E9E',
+            serviceUUIDs: [ONEKEY_SERVICE_UUID],
+          });
+        });
+      }),
+      stopDeviceScan: jest.fn(),
+    };
+    const transport = new ReactNativeBleTransport({ scanTimeout: 1 });
+    transport.blePlxManager = blePlxManager as never;
+    transport.init({ debug: jest.fn(), error: jest.fn() }, new EventEmitter());
+
+    const devices = await transport.enumerate();
+
+    expect(devices.map(device => device.id)).toEqual(['wallet-peripheral']);
+  });
+
+  test('ignores an unnamed scanned advertisement while keeping the named wallet peripheral', async () => {
+    jest.mocked(getConnectedDeviceIds).mockResolvedValueOnce([]);
+    const blePlxManager = {
+      startDeviceScan: jest.fn((_serviceUUIDs, _options, listener) => {
+        queueMicrotask(() => {
+          listener(null, {
+            id: 'unnamed-peripheral',
+            name: null,
+            localName: null,
+            serviceUUIDs: [
+              '0000180a-0000-1000-8000-00805f9b34fb',
+              '0000180f-0000-1000-8000-00805f9b34fb',
+              '0000fffd-0000-1000-8000-00805f9b34fb',
+              ONEKEY_SERVICE_UUID,
+            ],
+          });
+          listener(null, {
+            id: 'wallet-peripheral',
+            name: 'Pro2 769D',
+            localName: 'Pro2 769D',
+            serviceUUIDs: [
+              '0000180a-0000-1000-8000-00805f9b34fb',
+              '0000180f-0000-1000-8000-00805f9b34fb',
+              '0000fffd-0000-1000-8000-00805f9b34fb',
+              ONEKEY_SERVICE_UUID,
+            ],
+          });
+        });
+      }),
+      stopDeviceScan: jest.fn(),
+    };
+    const transport = new ReactNativeBleTransport({ scanTimeout: 1 });
+    transport.blePlxManager = blePlxManager as never;
+    transport.init({ debug: jest.fn(), error: jest.fn() }, new EventEmitter());
+
+    const devices = await transport.enumerate();
+
+    expect(devices.map(device => device.id)).toEqual(['wallet-peripheral']);
+  });
+});