@onekeyfe/hd-transport-react-native 1.2.0-alpha.65 → 1.2.0-alpha.66

package/jest.config.js

@@ -2,9 +2,4 @@ module.exports = {
   preset: '../../jest.config.js',
   testEnvironment: 'node',
   modulePathIgnorePatterns: ['node_modules', '<rootDir>/dist'],
-  moduleNameMapper: {
-    // The workspace symlinks resolve to prebuilt dist outputs that can lag behind src.
-    '^@onekeyfe/hd-transport$': '<rootDir>/../hd-transport/src/index.ts',
-    '^@onekeyfe/hd-shared$': '<rootDir>/../shared/src/index.ts',
-  },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onekeyfe/hd-transport-react-native",
-  "version": "1.2.0-alpha.65",
+  "version": "1.2.0-alpha.66",
   "homepage": "https://github.com/OneKeyHQ/hardware-js-sdk#readme",
   "license": "MIT",
   "main": "dist/index.js",
@@ -20,11 +20,11 @@
     "lint:fix": "eslint . --fix"
   },
   "dependencies": {
-    "@onekeyfe/hd-core": "1.2.0-alpha.65",
-    "@onekeyfe/hd-shared": "1.2.0-alpha.65",
-    "@onekeyfe/hd-transport": "1.2.0-alpha.65",
+    "@onekeyfe/hd-core": "1.2.0-alpha.66",
+    "@onekeyfe/hd-shared": "1.2.0-alpha.66",
+    "@onekeyfe/hd-transport": "1.2.0-alpha.66",
     "@onekeyfe/react-native-ble-utils": "^0.1.6",
     "react-native-ble-plx": "3.5.1"
   },
-  "gitHead": "2850b5b34935d4e97a1fe8a6459eb5a96a5cf0f6"
+  "gitHead": "81629c086665bb92ce4d52087ae47f084976da79"
 }

package/src/BleTransport.ts

@@ -1,3 +1,5 @@
+import { Platform } from 'react-native';
+
 import type { Characteristic, Device, Subscription } from 'react-native-ble-plx';
 
 export default class BleTransport {
@@ -33,6 +35,10 @@ export default class BleTransport {
   }
 
   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

@@ -1,7 +1,16 @@
 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',
   () => ({
@@ -19,12 +28,18 @@ jest.mock('@onekeyfe/hd-shared', () => ({
 }));
 
 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 = {
-      writeWithoutResponse: jest.fn(() => Promise.reject(error)),
+      isWritableWithResponse: true,
+      writeWithResponse: jest.fn(() => Promise.reject(error)),
+      writeWithoutResponse: jest.fn(() => Promise.resolve()),
     };
     const device = {
       id: 'classic-id',
@@ -35,7 +50,44 @@ describe('BleTransport side-effecting writes', () => {
 
     await expect(transport.writeWithRetry('payload')).rejects.toBe(error);
 
-    expect(writeCharacteristic.writeWithoutResponse).toHaveBeenCalledTimes(1);
+    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__/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']);
+  });
+});