@onekeyfe/hd-core 1.2.8 → 1.2.9

package/__tests__/core-error-output.test.ts

@@ -3,7 +3,7 @@ import { ERRORS, HardwareErrorCode } from '@onekeyfe/hd-shared';
 import { initConnector, initCore } from '../src/core';
 import { DataManager } from '../src/data-manager';
 import TransportManager from '../src/data-manager/TransportManager';
-import { IFRAME } from '../src/events';
+import { IFRAME, createErrorMessage } from '../src/events';
 import SearchDevices from '../src/api/SearchDevices';
 import { DeviceList } from '../src/device/DeviceList';
 import { Device } from '../src/device/Device';
@@ -28,6 +28,40 @@ describe('Core 错误输出边界', () => {
     jest.restoreAllMocks();
   });
 
+  test('entry-point errors preserve USB recovery context across JSON serialization', () => {
+    const params = {
+      operation: 'open',
+      nativeErrorName: 'SecurityError',
+      nativeErrorMessage: 'Access denied',
+    };
+    const error = ERRORS.TypedError(
+      HardwareErrorCode.BridgeNeedsPermission,
+      'Access denied',
+      params
+    );
+    expect(JSON.parse(JSON.stringify(createErrorMessage(error)))).toEqual({
+      success: false,
+      payload: { code: HardwareErrorCode.BridgeNeedsPermission, error: 'Access denied', params },
+    });
+  });
+
+  test.each([
+    [HardwareErrorCode.TransportProtocolProbeFailed, { expectedProtocol: 'V1' }],
+    [
+      HardwareErrorCode.TransportProtocolMismatch,
+      { expectedProtocol: 'V2', detectedProtocol: 'V1' },
+    ],
+  ] as const)(
+    'preserves protocol error %s and structured context across the public boundary',
+    (code, params) => {
+      const error = ERRORS.TypedError(code, undefined, params);
+      expect(JSON.parse(JSON.stringify(createErrorMessage(error)))).toEqual({
+        success: false,
+        payload: { code, error: error.message, params },
+      });
+    }
+  );
+
   test.each([
     ['webusb', false],
     ['desktop-webusb', false],
@@ -108,14 +142,32 @@ describe('Core 错误输出边界', () => {
     HardwareErrorCode.BleDeviceBondedCanceled,
     HardwareErrorCode.BleDeviceDisconnected,
     HardwareErrorCode.PollingTimeout,
+    HardwareErrorCode.BlePoweredOff,
+    HardwareErrorCode.BleUnsupported,
+    HardwareErrorCode.BridgeNeedsPermission,
+    HardwareErrorCode.WebUsbDeviceAccessError,
+    HardwareErrorCode.TransportProtocolProbeFailed,
+    HardwareErrorCode.TransportProtocolMismatch,
   ])(
-    'preserves terminal BLE error %s in the public response without polling again',
+    'preserves terminal transport error %s in the public response without polling again',
     async errorCode => {
-      jest.spyOn(DataManager, 'getSettings').mockReturnValue('react-native' as never);
+      jest
+        .spyOn(DataManager, 'getSettings')
+        .mockReturnValue(
+          [
+            HardwareErrorCode.BridgeNeedsPermission,
+            HardwareErrorCode.WebUsbDeviceAccessError,
+            HardwareErrorCode.TransportProtocolProbeFailed,
+            HardwareErrorCode.TransportProtocolMismatch,
+          ].includes(errorCode)
+            ? ('desktop-webusb' as never)
+            : ('react-native' as never)
+        );
       const error = ERRORS.TypedError(errorCode);
       const acquire = jest.fn().mockRejectedValue(error);
       jest.spyOn(TransportManager, 'getTransport').mockReturnValue({
         acquire,
+        enumerate: jest.fn().mockResolvedValue([{ path: 'ble-pairing-test' }]),
         release: jest.fn().mockResolvedValue(true),
         stop: jest.fn().mockResolvedValue(undefined),
       } as never);

package/__tests__/device-connector-protocol.test.ts

@@ -75,8 +75,11 @@ describe('DeviceConnector protocol validation', () => {
     });
     const connector = new DeviceConnector();
 
-    await expect(connector.acquire('classic-id', undefined, undefined, 'V2')).rejects.toThrow(
-      'Device protocol mismatch: expected V2, detected V1'
+    await expect(connector.acquire('classic-id', undefined, undefined, 'V2')).rejects.toMatchObject(
+      {
+        errorCode: HardwareErrorCode.TransportProtocolMismatch,
+        params: { expectedProtocol: 'V2', detectedProtocol: 'V1' },
+      }
     );
   });
 

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

@@ -10,7 +10,6 @@ import {
   isMissingDetectedProtocolV2Error,
   isRetryableBleConnectionError,
   isRetryableBleProtocolV2ProbeError,
-  isTerminalBleStaleBondError,
   resolveBleConnectProtocol,
 } from '../src/core';
 import { DataManager } from '../src/data-manager';
@@ -81,6 +80,102 @@ describe('public device lifecycle events', () => {
     jest.restoreAllMocks();
   });
 
+  test.each([
+    ['react-native', 'V2', EDeviceType.Pro2, true],
+    ['react-native', 'V2', EDeviceType.Neo, true],
+    ['desktop-web-ble', 'V2', EDeviceType.Pro2, true],
+    ['desktop-web-ble', 'V2', EDeviceType.Neo, true],
+    ['react-native', 'V1', EDeviceType.Pro, false],
+    ['desktop-web-ble', 'V1', EDeviceType.Touch, false],
+    ['react-native', 'V1', EDeviceType.Pro2, false],
+    ['react-native', 'V2', EDeviceType.Unknown, false],
+    ['desktop-webusb', 'V2', EDeviceType.Pro2, false],
+    ['lowlevel', 'V2', EDeviceType.Neo, false],
+  ] as const)(
+    'releases the task and keeps only the intended BLE links: %s / %s / %s',
+    async (env, protocol, deviceType, keepConnection) => {
+      jest.spyOn(DataManager, 'getSettings').mockReturnValue(env as never);
+      const device = createInitializedDevice(protocol);
+      device.features = { ...device.features, deviceType } as never;
+      device.originalDescriptor.session = device.mainId;
+      (device as unknown as { deviceAcquired: boolean }).deviceAcquired = true;
+      const release = jest.fn().mockResolvedValue(true);
+      const disconnect = jest.fn().mockResolvedValue(undefined);
+      device.deviceConnector = { release, disconnect } as never;
+      const commands = {
+        disposed: false,
+        dispose: jest.fn(() => {
+          commands.disposed = true;
+          return Promise.resolve();
+        }),
+        cancel: jest.fn().mockResolvedValue(undefined),
+      };
+      device.commands = commands as never;
+
+      await device.release();
+
+      expect(release).toHaveBeenCalledWith(device.mainId, false, keepConnection);
+      expect(device.hasDeviceAcquire()).toBe(false);
+      expect(commands.disposed).toBe(true);
+      expect(device.keepSession).toBe(false);
+
+      await device.interruptionFromUser();
+      expect(disconnect).toHaveBeenCalledTimes(keepConnection ? 0 : 1);
+    }
+  );
+
+  test('still disconnects when setup is cancelled after a kept-alive release', async () => {
+    jest.spyOn(DataManager, 'getSettings').mockReturnValue('react-native' as never);
+    const device = createInitializedDevice('V2');
+    const pendingAcquire = createDeferred<{ uuid: string; protocolType: 'V2' }>();
+    const release = jest.fn().mockResolvedValue(true);
+    const disconnect = jest.fn().mockResolvedValue(undefined);
+    device.deviceConnector = {
+      release,
+      disconnect,
+      acquire: jest.fn(() => pendingAcquire.promise),
+    } as never;
+    device.commands = {
+      disposed: true,
+      dispose: jest.fn().mockResolvedValue(undefined),
+      cancel: jest.fn().mockResolvedValue(undefined),
+    } as never;
+    await device.release();
+    device.beginConnectionAttempt();
+    const acquiring = device.acquire('V2');
+
+    await device.interruptionFromUser();
+    expect(disconnect).toHaveBeenCalledWith(device.mainId);
+    pendingAcquire.resolve({ uuid: 'late-kept-alive-session', protocolType: 'V2' });
+    await expect(acquiring).rejects.toMatchObject({
+      errorCode: HardwareErrorCode.DeviceInterruptedFromUser,
+    });
+    expect(disconnect).toHaveBeenLastCalledWith('late-kept-alive-session');
+  });
+
+  test.each(['release failure', 'disconnect event'])(
+    'does not treat %s as a kept-alive connection',
+    async reason => {
+      jest.spyOn(DataManager, 'getSettings').mockReturnValue('react-native' as never);
+      const device = createInitializedDevice('V2');
+      const release = jest.fn().mockResolvedValue(true);
+      if (reason === 'release failure') release.mockRejectedValueOnce(new Error('release failed'));
+      const disconnect = jest.fn().mockResolvedValue(undefined);
+      device.deviceConnector = { release, disconnect } as never;
+      device.commands = {
+        disposed: true,
+        dispose: jest.fn().mockResolvedValue(undefined),
+        cancel: jest.fn().mockResolvedValue(undefined),
+      } as never;
+      await device.release();
+      if (reason === 'disconnect event') device.markTransportDisconnected();
+
+      await device.interruptionFromUser();
+
+      expect(disconnect).toHaveBeenCalledWith(device.mainId);
+    }
+  );
+
   test.each(['V1', 'V2'] as const)(
     'preserves the %s acknowledged result and waits for release before the next acquire',
     async protocol => {
@@ -364,11 +459,11 @@ describe('public device lifecycle events', () => {
 
   test('clears the cleanup barrier when its deadline expires', async () => {
     const realSetTimeout = setTimeout;
-    jest
-      .spyOn(global, 'setTimeout')
-      .mockImplementation((callback, delay, ...args) =>
-        realSetTimeout(callback, delay === 5_000 ? 0 : delay, ...args)
-      );
+    const cleanupDeadline = createDeferred<() => void>();
+    jest.spyOn(global, 'setTimeout').mockImplementation((callback, delay, ...args) => {
+      if (delay === 5_000) cleanupDeadline.resolve(() => callback(...args));
+      return realSetTimeout(callback, delay, ...args);
+    });
     {
       jest.spyOn(DataManager, 'getSettings').mockReturnValue('react-native' as never);
       const acquire = jest.spyOn(Device.prototype, 'acquire').mockResolvedValue(undefined);
@@ -382,13 +477,15 @@ describe('public device lifecycle events', () => {
         type: IFRAME.CALL,
         payload: { method: 'getDeviceState', connectId: 'draining-device', connectProtocol: 'V2' },
       } as CoreMessage);
-      setImmediate(() => cancel(context, 'draining-device'));
+      const expireCleanupDeadline = await cleanupDeadline.promise;
+      cancel(context, 'draining-device');
+      expireCleanupDeadline();
       await expect(result).resolves.toBeDefined();
-      gate.resolve();
       await new Promise(resolve => {
         setImmediate(resolve);
       });
       expect(context.getPrePendingCallPromise('draining-device')).toBeUndefined();
+      gate.resolve();
     }
   });
 
@@ -609,17 +706,18 @@ describe('public device lifecycle events', () => {
   );
 
   test.each([
-    [HardwareErrorCode.RuntimeError, true],
+    [HardwareErrorCode.TransportProtocolProbeFailed, true],
+    [HardwareErrorCode.TransportProtocolMismatch, false],
+    [HardwareErrorCode.RuntimeError, false],
     [HardwareErrorCode.BleDeviceBondError, false],
-    [HardwareErrorCode.BlePeerRemovedPairingInformation, false],
   ] as const)(
     'retries a Protocol V2 probe mismatch with error code %s: %s',
     (errorCode, expected) => {
       const method = { payload: { connectProtocol: 'V2' } } as never;
       const error = {
         errorCode,
-        message:
-          'Device protocol mismatch: expected V2, but device did not respond to expected protocol',
+        message: 'diagnostic wording is not used for classification',
+        params: { expectedProtocol: 'V2' },
       };
 
       expect(isRetryableBleProtocolV2ProbeError(method, error)).toBe(expected);
@@ -629,10 +727,10 @@ describe('public device lifecycle events', () => {
   test.each([
     [HardwareErrorCode.BleConnectedError, true],
     [HardwareErrorCode.BleTimeoutError, true],
+    [HardwareErrorCode.TransportProtocolProbeFailed, true],
+    [HardwareErrorCode.TransportProtocolMismatch, false],
     [HardwareErrorCode.PollingTimeout, false],
     [HardwareErrorCode.BleDeviceBondError, false],
-    [HardwareErrorCode.BlePeerRemovedPairingInformation, false],
-    [HardwareErrorCode.BleBondInvalid, false],
   ] as const)('retries a BLE connection error with error code %s: %s', (errorCode, expected) => {
     const method = { payload: { connectProtocol: 'V2' } } as never;
     const error = {
@@ -643,6 +741,21 @@ describe('public device lifecycle events', () => {
     expect(isRetryableBleConnectionError(method, error)).toBe(expected);
   });
 
+  test('does not retry a failed strict V1 probe as a V2 probe or after user cancellation', () => {
+    const error = ERRORS.TypedError(HardwareErrorCode.TransportProtocolProbeFailed, undefined, {
+      expectedProtocol: 'V1',
+    });
+    const method = { payload: { connectProtocol: 'V2' } } as never;
+    expect(isRetryableBleProtocolV2ProbeError(method, error)).toBe(false);
+    expect(isRetryableBleConnectionError(method, error)).toBe(false);
+    expect(
+      isRetryableBleConnectionError(
+        { payload: {}, device: { wasInterruptedByUser: () => true } } as never,
+        ERRORS.TypedError(HardwareErrorCode.TransportProtocolProbeFailed)
+      )
+    ).toBe(false);
+  });
+
   test('does not retry the desktop acquire deadline fallback', () => {
     const method = { payload: { connectProtocol: 'V2' } } as never;
     const error = {
@@ -685,19 +798,6 @@ describe('public device lifecycle events', () => {
     }
   );
 
-  test.each([
-    [HardwareErrorCode.BleDeviceBondError, true],
-    [HardwareErrorCode.BlePeerRemovedPairingInformation, true],
-    [HardwareErrorCode.BleBondInvalid, true],
-    [HardwareErrorCode.DeviceNotFound, false],
-  ] as const)('treats BLE stale-bond error code %s as terminal: %s', (errorCode, expected) => {
-    const error = {
-      errorCode,
-    };
-
-    expect(isTerminalBleStaleBondError(error)).toBe(expected);
-  });
-
   test.each([
     [HardwareErrorCode.DeviceCheckDeviceIdError, true],
     [HardwareErrorCode.DeviceNotFound, false],
@@ -729,6 +829,48 @@ describe('public device lifecycle events', () => {
     expect(() => JSON.stringify(disconnectMessage?.payload.device)).not.toThrow();
   });
 
+  test.each(['V1', 'V2'] as const)(
+    'preserves the %s connection identity for a transport disconnect after wipe',
+    protocol => {
+      jest.spyOn(DataManager, 'getSettings').mockReturnValue('webusb' as never);
+      core = initCore();
+      initConnector();
+      const messages: CoreMessage[] = [];
+      core.on(CORE_EVENT, message => messages.push(message));
+      const device = createInitializedDevice(protocol);
+      const connectId = device.getConnectId();
+      DevicePool.devicesCache[connectId] = device;
+
+      device.invalidateAfterWipe();
+      expect(device.toMessageObject()).toBeNull();
+      DevicePool.emitter.emit(DEVICE.CONNECT, device);
+      expect(messages.some(message => message.type === DEVICE.CONNECT)).toBe(false);
+      DevicePool.emitter.emit(TRANSPORT_EVENT.DEVICE_DISCONNECT, { connectId });
+
+      const disconnects = messages.filter(message => message.type === DEVICE.DISCONNECT);
+      expect(disconnects).toHaveLength(1);
+      expect(disconnects[0].payload.device).toMatchObject({
+        connectId,
+        serialNo: 'SERIAL-001',
+        deviceId: 'wallet-device-id',
+      });
+      expect(() => JSON.stringify(disconnects[0].payload.device)).not.toThrow();
+
+      device.features = {
+        ...createInitializedDevice(protocol).features,
+        deviceId: 'new-device-id',
+        initialized: false,
+        mode: 'notInitialized',
+      } as never;
+      DevicePool.emitter.emit(TRANSPORT_EVENT.DEVICE_DISCONNECT, { connectId });
+      const nextDisconnects = messages.filter(message => message.type === DEVICE.DISCONNECT);
+      expect(nextDisconnects[1].payload.device).toMatchObject({
+        deviceId: 'new-device-id',
+        mode: 'notInitialized',
+      });
+    }
+  );
+
   test('treats an acquired BLE device as reusable until the transport disconnects', async () => {
     jest.spyOn(DataManager, 'getSettings').mockReturnValue('desktop-web-ble' as never);
     const device = createInitializedDevice('V2');
@@ -1014,6 +1156,28 @@ describe('public device lifecycle events', () => {
     expect(device.wasInterruptedByUser()).toBe(false);
   });
 
+  test.each(['V1', 'V2'] as const)(
+    'retires a failed USB %s session before the next user attempt',
+    async protocol => {
+      jest.spyOn(DataManager, 'getSettings').mockReturnValue('desktop-webusb' as never);
+      const device = createInitializedDevice(protocol);
+      device.originalDescriptor = { ...device.originalDescriptor, session: device.mainId };
+      const disconnect = jest.fn().mockResolvedValue(undefined);
+      const release = jest.fn().mockResolvedValue(undefined);
+      device.deviceConnector = { disconnect, release } as never;
+      device.commands = { disposed: false, dispose: jest.fn() } as never;
+      (device as unknown as { deviceAcquired: boolean }).deviceAcquired = true;
+      const error = ERRORS.TypedError(HardwareErrorCode.WebUsbDeviceAccessError);
+      await expect(device.run(() => Promise.reject(error))).rejects.toBe(error);
+      await new Promise(resolve => {
+        setImmediate(resolve);
+      });
+      expect(disconnect).toHaveBeenCalledWith(device.mainId);
+      expect(release).toHaveBeenCalledTimes(1);
+      expect(device.hasDeviceAcquire()).toBe(false);
+    }
+  );
+
   test('waits for the canceled run to finish releasing before cancellation completes', async () => {
     jest.spyOn(DataManager, 'getSettings').mockReturnValue('react-native' as never);
     const device = createInitializedDevice('V2');

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

@@ -85,6 +85,56 @@ describe('DevicePool state lifecycle', () => {
     expect(result.deviceList).toEqual([device]);
   });
 
+  test.each([
+    ['V1', undefined],
+    ['V1', 'wipe-path'],
+    ['V2', undefined],
+    ['V2', 'wipe-path'],
+  ] as const)('rediscovers a wiped %s device with connect id %s', async (protocol, connectId) => {
+    const descriptor = { path: 'wipe-path', protocolType: protocol } as never;
+    const device = Device.fromDescriptor(descriptor);
+    device.features = {
+      protocol,
+      deviceType: protocol === 'V2' ? 'pro2' : 'classic',
+      deviceId: 'old-device-id',
+      serialNo: 'wipe-path',
+      initialized: true,
+      mode: 'normal',
+    } as never;
+    DevicePool.devicesCache = { 'wipe-path': device };
+    device.invalidateAfterWipe();
+    expect(device.toMessageObject()).toBeNull();
+    const connect = jest.spyOn(device, 'connect').mockResolvedValue(true);
+    const initialize = jest.spyOn(device, 'initialize').mockImplementation(() => {
+      device.features = {
+        protocol,
+        deviceType: protocol === 'V2' ? 'pro2' : 'classic',
+        deviceId: 'new-device-id',
+        serialNo: 'wipe-path',
+        initialized: false,
+        mode: 'notInitialized',
+      } as never;
+      return Promise.resolve();
+    });
+    const release = jest.spyOn(device, 'release').mockResolvedValue(undefined);
+
+    try {
+      const result = await DevicePool.getDevices([descriptor], connectId);
+      expect(initialize).toHaveBeenCalledTimes(1);
+      expect(connect).toHaveBeenCalledTimes(1);
+      expect(release).toHaveBeenCalledTimes(1);
+      expect(result.deviceList[0].toMessageObject()).toMatchObject({
+        deviceId: 'new-device-id',
+        mode: 'notInitialized',
+        features: { initialized: false },
+      });
+      await DevicePool.getDevices([descriptor], connectId);
+      expect(initialize).toHaveBeenCalledTimes(1);
+    } finally {
+      jest.restoreAllMocks();
+    }
+  });
+
   test('keeps a discovered device when its Protocol V2 label cannot be read', async () => {
     const labelError = new Error('settings unavailable');
     const getDeviceState = jest

package/__tests__/firmware-update/firmware-artifact-source.test.ts

@@ -31,6 +31,10 @@ const createReader = (bytes = artifactBytes) => {
 };
 
 describe('FirmwareArtifactSource', () => {
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+
   it('materializes verified bytes before exposing the source', async () => {
     const backingBytes = Uint8Array.from(artifactBytes);
     const { reader, read, close } = createReader(backingBytes);
@@ -86,6 +90,10 @@ describe('FirmwareArtifactSource', () => {
       sha256: bytesToHex(sha256(bytes)),
     };
     const { reader, read } = createReader(bytes);
+    const hasher = sha256.create();
+    const update = jest.spyOn(hasher, 'update');
+    const digest = jest.spyOn(hasher, 'digest');
+    jest.spyOn(sha256, 'create').mockReturnValue(hasher);
 
     const source = await openFirmwareByteSource({ artifact: largeArtifact, reader });
     if (!source) {
@@ -103,6 +111,9 @@ describe('FirmwareArtifactSource', () => {
         length: 3,
       },
     ]);
+    expect(update).toHaveBeenCalledTimes(2);
+    expect(update.mock.invocationCallOrder[0]).toBeLessThan(read.mock.invocationCallOrder[1]);
+    expect(digest.mock.invocationCallOrder[0]).toBeGreaterThan(update.mock.invocationCallOrder[1]);
     await source.close();
   });