@onekeyfe/hd-transport-react-native 1.2.0-alpha.33 → 1.2.0-alpha.35

package/src/BleTransport.ts

@@ -1,12 +1,5 @@
-import { BleErrorCode } from 'react-native-ble-plx';
-import { wait } from '@onekeyfe/hd-shared';
-
-import { bleLogger } from './logger';
-
 import type { Characteristic, Device, Subscription } from 'react-native-ble-plx';
 
-const Log = bleLogger;
-
 export default class BleTransport {
   id: string;
 
@@ -28,10 +21,6 @@ export default class BleTransport {
 
   monitorToken?: number;
 
-  static MAX_RETRIES = 5;
-
-  static RETRY_DELAY = 2000;
-
   constructor(
     device: Device,
     writeCharacteristic: Characteristic,
@@ -43,37 +32,7 @@ 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> {
+    await this.writeCharacteristic.writeWithoutResponse(data);
   }
 }

package/src/__tests__/BleTransport.test.ts

@@ -0,0 +1,41 @@
+import { BleErrorCode } from 'react-native-ble-plx';
+
+import BleTransport from '../BleTransport';
+
+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', () => {
+  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)),
+    };
+    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.writeWithoutResponse).toHaveBeenCalledTimes(1);
+    expect(device.connect).not.toHaveBeenCalled();
+  });
+});

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__/protocolV2Link.test.ts

@@ -5,10 +5,11 @@ import transportPackage, {
   TRANSPORT_EVENT,
   bytesToHex,
 } from '@onekeyfe/hd-transport';
-import { HardwareErrorCode } from '@onekeyfe/hd-shared';
+import { HardwareErrorCode, createDeferred } from '@onekeyfe/hd-shared';
 
 import ReactNativeBleTransport, {
   configureProtocolV2BleTuning,
+  getFirmwareUploadWriteRetryType,
   resetProtocolV2BleTuning,
 } from '../index';
 
@@ -50,6 +51,7 @@ const { parseConfigure } = transportPackage;
 const protocolV1Schema = {
   nested: {
     Initialize: { fields: {} },
+    GetFeatures: { fields: {} },
     Success: {
       fields: {
         message: { type: 'string', id: 1 },
@@ -59,6 +61,7 @@ const protocolV1Schema = {
       values: {
         MessageType_Initialize: 1,
         MessageType_Success: 2,
+        MessageType_GetFeatures: 55,
       },
     },
   },
@@ -140,7 +143,7 @@ const createHarness = () => {
     id: uuid,
     name: 'OneKey Pro 2',
     localName: 'OneKey Pro 2',
-    serviceUUIDs: ['fffd'],
+    serviceUUIDs: ['00000001-0000-1000-8000-00805f9b34fb'],
     isConnected: jest.fn(() => Promise.resolve(true)),
     cancelConnection: jest.fn(() => Promise.resolve()),
     onDisconnected: jest.fn(callback => {
@@ -181,11 +184,186 @@ const createHarness = () => {
   };
 };
 
+const createV1Harness = () => {
+  const uuid = 'rn-classic-id';
+  const notifySubscriptionRemovers: jest.Mock[] = [];
+  const disconnectSubscriptionRemovers: jest.Mock[] = [];
+  let notifyCallback:
+    | ((error: Error | null, characteristic: { value: string } | null) => void)
+    | undefined;
+  const notifyCharacteristic = {
+    uuid: '0003',
+    deviceID: uuid,
+    isNotifiable: true,
+    monitor: jest.fn(callback => {
+      notifyCallback = callback;
+      const remove = jest.fn();
+      notifySubscriptionRemovers.push(remove);
+      return { remove };
+    }),
+  };
+  let writeCount = 0;
+  const writeCharacteristic = {
+    uuid: '0002',
+    deviceID: uuid,
+    isWritableWithResponse: true,
+    isWritableWithoutResponse: true,
+    writeWithoutResponse: jest.fn(() => {
+      writeCount += 1;
+      if (writeCount === 1) {
+        notifyCallback?.(null, {
+          value: Buffer.from('3f23230002000000040a026f6b', 'hex').toString('base64'),
+        });
+      }
+      return Promise.resolve();
+    }),
+  };
+  const device = {
+    id: uuid,
+    name: 'OneKey Classic',
+    localName: 'OneKey Classic',
+    serviceUUIDs: ['00000001-0000-1000-8000-00805f9b34fb'],
+    isConnected: jest.fn(() => Promise.resolve(true)),
+    cancelConnection: jest.fn(() => Promise.resolve()),
+    onDisconnected: jest.fn(() => {
+      const remove = jest.fn();
+      disconnectSubscriptionRemovers.push(remove);
+      return { remove };
+    }),
+  };
+  const transport = new ReactNativeBleTransport({ scanTimeout: 1 });
+  const bleManager = {
+    devices: jest.fn(() => Promise.resolve([device])),
+    connectedDevices: jest.fn(() => Promise.resolve([])),
+    cancelTransaction: jest.fn(() => Promise.resolve()),
+  };
+  transport.blePlxManager = bleManager as any;
+  transport.resolveCharacteristics = jest.fn(() =>
+    Promise.resolve({ writeCharacteristic, notifyCharacteristic })
+  );
+  transport.init({ debug: jest.fn(), error: jest.fn() }, new EventEmitter());
+  transport.configure(protocolV1Schema);
+  transport.configureProtocolV2(protocolV2Schema);
+  return {
+    transport,
+    uuid,
+    device,
+    bleManager,
+    notifySubscriptionRemovers,
+    disconnectSubscriptionRemovers,
+  };
+};
+
 describe('ReactNativeBleTransport Protocol V2 link lifecycle', () => {
+  test('does not classify disconnects as retryable firmware writes', () => {
+    expect(
+      getFirmwareUploadWriteRetryType({
+        errorCode: 205,
+        message: 'Device disconnected after write',
+      })
+    ).toBeNull();
+  });
+
+  test('keeps another device reader when releasing a device with an active V1 call', async () => {
+    const transport = new ReactNativeBleTransport({ scanTimeout: 1 }) as any;
+    const activeV1Call = createDeferred<string>();
+    const otherDeviceReader = createDeferred<Uint8Array>();
+    activeV1Call.promise.catch(() => undefined);
+    otherDeviceReader.promise.catch(() => undefined);
+    transport.runPromise = activeV1Call;
+    transport.runPromiseDeviceId = 'device-a';
+    transport.protocolV2FramePromises.set('device-b', otherDeviceReader);
+
+    await transport.releaseNative('device-a', true);
+
+    expect(transport.protocolV2FramePromises.get('device-b')).toBe(otherDeviceReader);
+  });
+
+  test('rejects a pending reader when its device frame state resets', async () => {
+    const transport = new ReactNativeBleTransport({ scanTimeout: 1 }) as any;
+    const reader = createDeferred<Uint8Array>();
+    transport.protocolV2FramePromises.set('device-a', reader);
+    const result = Promise.race([
+      reader.promise.then(
+        () => 'resolved',
+        () => 'rejected'
+      ),
+      new Promise(resolve => {
+        setTimeout(() => resolve('pending'), 20);
+      }),
+    ]);
+
+    transport.resetProtocolV2Frames('device-a');
+
+    await expect(result).resolves.toBe('rejected');
+  });
+
   test('keeps the legacy default BLE scan timeout', () => {
     expect(new ReactNativeBleTransport({}).scanTimeout).toBe(3000);
   });
 
+  test('reconnects before falling back to Protocol V1 after a fatal V2 probe failure', async () => {
+    const { transport, uuid, device, notifySubscriptionRemovers, disconnectSubscriptionRemovers } =
+      createV1Harness();
+    const probeProtocolV2 = jest
+      .spyOn(transport as any, 'probeProtocolV2')
+      .mockImplementationOnce(async () => {
+        await (transport as any).releaseNative(uuid, true);
+        return false;
+      });
+    const resolveCharacteristics = jest.spyOn(transport as any, 'resolveCharacteristics');
+
+    await expect(transport.acquire({ uuid, protocolHint: 'V2' })).resolves.toEqual({
+      uuid,
+      protocolType: 'V1',
+    });
+
+    expect(probeProtocolV2).toHaveBeenCalledTimes(1);
+    expect(resolveCharacteristics).toHaveBeenCalledTimes(2);
+    expect(transport.getProtocolType(uuid)).toBe('V1');
+    expect(device.onDisconnected).toHaveBeenCalledTimes(1);
+    expect(notifySubscriptionRemovers).toHaveLength(2);
+    expect(notifySubscriptionRemovers[0]).toHaveBeenCalledTimes(1);
+
+    await transport.release(uuid, true);
+
+    expect(notifySubscriptionRemovers[1]).toHaveBeenCalledTimes(1);
+    expect(disconnectSubscriptionRemovers).toHaveLength(1);
+    expect(disconnectSubscriptionRemovers[0]).toHaveBeenCalledTimes(1);
+  });
+
+  test('cleans the rebuilt transport when Protocol V1 fallback also fails', async () => {
+    const { transport, uuid, device, bleManager, notifySubscriptionRemovers } = createV1Harness();
+    jest.spyOn(transport as any, 'probeProtocolV2').mockImplementationOnce(async () => {
+      await (transport as any).releaseNative(uuid, true);
+      return false;
+    });
+    jest.spyOn(transport as any, 'probeProtocolV1').mockResolvedValue(false);
+
+    await expect(transport.acquire({ uuid, protocolHint: 'V2' })).rejects.toMatchObject({
+      errorCode: HardwareErrorCode.BleTimeoutError,
+    });
+
+    expect(device.onDisconnected).not.toHaveBeenCalled();
+    expect(notifySubscriptionRemovers).toHaveLength(2);
+    expect(notifySubscriptionRemovers[0]).toHaveBeenCalledTimes(1);
+    expect(notifySubscriptionRemovers[1]).toHaveBeenCalledTimes(1);
+    expect(bleManager.cancelTransaction).toHaveBeenCalled();
+    expect(transport.getProtocolType(uuid)).toBeUndefined();
+  });
+
+  test('disconnects and invalidates a Protocol V1 link after a response timeout', async () => {
+    const { transport, uuid, device } = createV1Harness();
+
+    await transport.acquire({ uuid, expectedProtocol: 'V1' });
+    await expect(transport.call(uuid, 'Initialize', {}, { timeoutMs: 5 })).rejects.toMatchObject({
+      errorCode: HardwareErrorCode.BleTimeoutError,
+    });
+
+    expect(device.cancelConnection).toHaveBeenCalled();
+    expect(transport.getProtocolType(uuid)).toBeUndefined();
+  });
+
   afterEach(() => {
     resetProtocolV2BleTuning();
   });

package/src/constants.ts

@@ -1,3 +1,5 @@
+import { createKnownBleUuidAliases, matchesKnownBleUuid } from '@onekeyfe/hd-shared';
+
 export const IOS_PACKET_LENGTH = 128;
 export const ANDROID_PACKET_LENGTH = 192;
 export const ANDROID_DEFAULT_MTU = 23;
@@ -12,7 +14,6 @@ type BluetoothServices = Record<
 >;
 
 const ClassicServiceUUID = '00000001-0000-1000-8000-00805f9b34fb';
-const Pro2ServiceUUID = 'fffd';
 
 const OneKeyServices: Record<string, BluetoothServices> = {
   classic: {
@@ -21,11 +22,6 @@ const OneKeyServices: Record<string, BluetoothServices> = {
       writeUuid: '00000002-0000-1000-8000-00805f9b34fb',
       notifyUuid: '00000003-0000-1000-8000-00805f9b34fb',
     },
-    [Pro2ServiceUUID]: {
-      serviceUuid: Pro2ServiceUUID,
-      writeUuid: '00000002-0000-1000-8000-00805f9b34fb',
-      notifyUuid: '00000003-0000-1000-8000-00805f9b34fb',
-    },
   },
 };
 
@@ -48,7 +44,7 @@ export const getInfosForServiceUuid = (serviceUuid: string, deviceType: 'classic
     Object.values(services).find(
       item =>
         normalizeBleUuid(item.serviceUuid) === normalizedServiceUuid ||
-        getBleUuidKey(item.serviceUuid) === getBleUuidKey(serviceUuid)
+        matchesKnownBleUuid(serviceUuid, createKnownBleUuidAliases(item.serviceUuid))
     );
   if (!service) {
     return null;
@@ -59,17 +55,7 @@ export const getInfosForServiceUuid = (serviceUuid: string, deviceType: 'classic
 export const normalizeBleUuid = (uuid?: string | null) =>
   (uuid ?? '').replace(/-/g, '').toLowerCase();
 
-export const getBleUuidKey = (uuid?: string | null) => {
-  const normalized = normalizeBleUuid(uuid);
-  return normalized.length >= 8 ? normalized.substring(4, 8) : normalized;
-};
-
 export const isSameBleUuid = (left?: string | null, right?: string | null) => {
-  const normalizedLeft = normalizeBleUuid(left);
-  const normalizedRight = normalizeBleUuid(right);
-
-  return (
-    normalizedLeft === normalizedRight ||
-    (getBleUuidKey(left) !== '' && getBleUuidKey(left) === getBleUuidKey(right))
-  );
+  if (!left || !right) return false;
+  return matchesKnownBleUuid(left, createKnownBleUuidAliases(right));
 };