@onekeyfe/hd-core 1.2.0-alpha.75 → 1.2.0-alpha.76

package/__tests__/firmware-update/firmware-update-prepared-plan.test.ts

@@ -0,0 +1,231 @@
+import { EDeviceType, EFirmwareType } from '@onekeyfe/hd-shared';
+
+import { buildFirmwareUpdatePlan } from '../../src/api/firmware/FirmwareUpdatePlan';
+import {
+  assertFirmwareUpdatePreparedPlanBinding,
+  assertFirmwareUpdatePreparedPlanDeviceIdentity,
+  prepareFirmwareUpdatePlan,
+  validateFirmwareUpdatePreparedPlan,
+} from '../../src/api/firmware/FirmwareUpdatePreparedPlan';
+
+import type { Features } from '../../src/types';
+
+const buildPlan = () =>
+  buildFirmwareUpdatePlan({
+    features: {
+      deviceType: EDeviceType.Classic1s,
+      serialNo: 'classic1s-device-id',
+      firmwareVersion: '1.0.0',
+      bootloaderVersion: '1.0.0',
+    } as Features,
+    firmwareType: EFirmwareType.Universal,
+    platform: 'native',
+    firmware: {
+      status: 'outdated',
+      release: {
+        url: 'https://firmware.onekey.so/classic/firmware.bin',
+        expectedSize: 4,
+        fingerprint: 'a'.repeat(64),
+        version: [3, 0, 0],
+        resource: 'https://firmware.onekey.so/classic/resource.zip',
+        resourceExpectedSize: 8,
+        resourceFingerprint: 'b'.repeat(64),
+      },
+    },
+    ble: {
+      status: 'valid',
+      release: undefined,
+    },
+    bootloader: {
+      status: 'valid',
+      release: undefined,
+    },
+  });
+
+const artifact = (sha256: string, size: number) => ({
+  artifactRef: `fw:${sha256}`,
+  size,
+  sha256,
+});
+
+describe('FirmwareUpdatePreparedPlan', () => {
+  test('binds all receipts into a URL-free, network-forbidden plan', () => {
+    const plan = buildPlan();
+    const prepared = prepareFirmwareUpdatePlan({
+      plan,
+      leaseRef: 'fwlease:00000000-0000-4000-8000-000000000001',
+      artifacts: [
+        {
+          artifactId: 'firmware',
+          artifact: artifact('a'.repeat(64), 4),
+        },
+        {
+          artifactId: 'resource',
+          artifact: artifact('b'.repeat(64), 8),
+          materializedEntries: [
+            {
+              entryName: 'resource/index.bin',
+              artifact: artifact('c'.repeat(64), 2),
+            },
+          ],
+        },
+      ],
+    });
+
+    expect(prepared.networkPolicy).toBe('forbid');
+    expect(prepared.planDigest).toBe(plan.planDigest);
+    expect(prepared.preparedPlanDigest).toMatch(/^[a-f0-9]{64}$/u);
+    expect(JSON.stringify(prepared)).not.toContain('https://');
+    expect(validateFirmwareUpdatePreparedPlan(prepared)).toEqual(prepared);
+    expect(
+      assertFirmwareUpdatePreparedPlanDeviceIdentity({
+        preparedPlan: prepared,
+        deviceIdentity: plan.deviceIdentity,
+      })
+    ).toEqual(prepared);
+    expect(() =>
+      assertFirmwareUpdatePreparedPlanDeviceIdentity({
+        preparedPlan: prepared,
+        deviceIdentity: 'different-device-id',
+      })
+    ).toThrow();
+    expect(
+      assertFirmwareUpdatePreparedPlanBinding({
+        preparedPlan: prepared,
+        executor: 'v2',
+        platform: 'native',
+        scopeTargets: ['firmware', 'resource'],
+        bindings: [
+          {
+            target: 'firmware',
+            artifact: artifact('a'.repeat(64), 4),
+          },
+          {
+            target: 'resource',
+            entryName: 'resource/index.bin',
+            artifact: artifact('c'.repeat(64), 2),
+          },
+        ],
+      })
+    ).toEqual(prepared);
+    expect(() =>
+      assertFirmwareUpdatePreparedPlanBinding({
+        preparedPlan: prepared,
+        executor: 'v2',
+        platform: 'native',
+        scopeTargets: ['firmware', 'resource'],
+        bindings: [
+          {
+            target: 'firmware',
+            artifact: artifact('a'.repeat(64), 4),
+          },
+          {
+            target: 'resource',
+            artifact: artifact('b'.repeat(64), 8),
+          },
+        ],
+      })
+    ).toThrow('artifact binding is invalid');
+    expect(() =>
+      assertFirmwareUpdatePreparedPlanBinding({
+        preparedPlan: prepared,
+        executor: 'v2',
+        platform: 'native',
+        scopeTargets: ['firmware'],
+        bindings: [
+          {
+            target: 'firmware',
+            artifact: artifact('b'.repeat(64), 8),
+          },
+        ],
+      })
+    ).toThrow('artifact binding is invalid');
+  });
+
+  test('rejects receipt drift and a tampered update plan digest', () => {
+    const plan = buildPlan();
+    expect(() =>
+      prepareFirmwareUpdatePlan({
+        plan,
+        leaseRef: 'fwlease:00000000-0000-4000-8000-000000000001',
+        artifacts: [
+          {
+            artifactId: 'firmware',
+            artifact: artifact('d'.repeat(64), 4),
+          },
+          {
+            artifactId: 'resource',
+            artifact: artifact('b'.repeat(64), 8),
+            materializedEntries: [
+              {
+                entryName: 'resource/index.bin',
+                artifact: artifact('c'.repeat(64), 2),
+              },
+            ],
+          },
+        ],
+      })
+    ).toThrow('receipt does not match');
+
+    expect(() =>
+      prepareFirmwareUpdatePlan({
+        plan: { ...plan, planDigest: 'f'.repeat(64) },
+        leaseRef: 'fwlease:00000000-0000-4000-8000-000000000001',
+        artifacts: [],
+      })
+    ).toThrow('plan digest is invalid');
+  });
+
+  test('projects portable archive paths to unique device resource names', () => {
+    const plan = buildPlan();
+    const buildArtifacts = (entryNames: string[]) => [
+      {
+        artifactId: 'firmware',
+        artifact: artifact('a'.repeat(64), 4),
+      },
+      {
+        artifactId: 'resource',
+        artifact: artifact('b'.repeat(64), 8),
+        materializedEntries: entryNames.map((entryName, index) => ({
+          entryName,
+          artifact: artifact(String(index + 1).repeat(64), 2),
+        })),
+      },
+    ];
+
+    expect(() =>
+      prepareFirmwareUpdatePlan({
+        plan,
+        leaseRef: 'fwlease:00000000-0000-4000-8000-000000000001',
+        artifacts: buildArtifacts(['icons/index.bin', 'fonts/index.bin']),
+      })
+    ).toThrow('duplicate entry names');
+    expect(() =>
+      prepareFirmwareUpdatePlan({
+        plan,
+        leaseRef: 'fwlease:00000000-0000-4000-8000-000000000001',
+        artifacts: buildArtifacts(['../index.bin']),
+      })
+    ).toThrow('entry name is invalid');
+  });
+
+  test('rejects unknown fields even when a caller presents a plan-shaped object', () => {
+    const plan = buildPlan();
+    expect(() =>
+      prepareFirmwareUpdatePlan({
+        plan: {
+          ...plan,
+          artifacts: [
+            {
+              ...plan.artifacts[0],
+              unexpectedUrl: 'https://attacker.invalid/payload',
+            },
+            plan.artifacts[1],
+          ],
+        } as typeof plan,
+        leaseRef: 'fwlease:00000000-0000-4000-8000-000000000001',
+        artifacts: [],
+      })
+    ).toThrow('invalid field set');
+  });
+});

package/__tests__/firmware-update/firmware-update-v2-download-before-boot.test.ts

@@ -1,8 +1,8 @@
-import { EDeviceType, EFirmwareType, HardwareErrorCode } from '@onekeyfe/hd-shared';
+import { EDeviceType, EFirmwareType, ERRORS, HardwareErrorCode } from '@onekeyfe/hd-shared';
 
 import FirmwareUpdateV2 from '../../src/api/FirmwareUpdateV2';
 import { getBinary } from '../../src/api/firmware/getBinary';
-import { uploadFirmware } from '../../src/api/firmware/uploadFirmware';
+import { uploadFirmwareFromSource } from '../../src/api/firmware/uploadFirmware';
 import * as utils from '../../src/utils';
 
 jest.mock('../../src/data/config', () => ({
@@ -18,7 +18,8 @@ jest.mock('../../src/api/firmware/getBinary', () => ({
 
 jest.mock('../../src/api/firmware/uploadFirmware', () => ({
   updateResources: jest.fn(),
-  uploadFirmware: jest.fn(),
+  updateResourcesFromSources: jest.fn(),
+  uploadFirmwareFromSource: jest.fn(),
 }));
 
 jest.mock('../../src/device/DevicePool', () => ({
@@ -29,7 +30,9 @@ jest.mock('../../src/device/DevicePool', () => ({
 }));
 
 const mockGetBinary = getBinary as jest.MockedFunction<typeof getBinary>;
-const mockUploadFirmware = uploadFirmware as jest.MockedFunction<typeof uploadFirmware>;
+const mockUploadFirmwareFromSource = uploadFirmwareFromSource as jest.MockedFunction<
+  typeof uploadFirmwareFromSource
+>;
 
 type DeviceType = 'CLASSIC1S' | 'PURE';
 
@@ -175,7 +178,26 @@ describe('FirmwareUpdateV2 download-before-reboot safety', () => {
     expect(mockGetBinary).toHaveBeenCalledTimes(1);
     expectNoFirmwareMutationCalls(typedCall);
     expect(acquire).not.toHaveBeenCalled();
-    expect(mockUploadFirmware).not.toHaveBeenCalled();
+    expect(mockUploadFirmwareFromSource).not.toHaveBeenCalled();
+  });
+
+  it('preserves structured preparation errors before any firmware mutation', async () => {
+    const preparationError = ERRORS.TypedError(
+      HardwareErrorCode.RuntimeError,
+      'Firmware must be prepared by the external firmware host',
+      {
+        firmwareUpdateCode: 'FirmwareArtifactsNotPrepared',
+        artifactName: 'firmware',
+      }
+    );
+    mockGetBinary.mockRejectedValue(preparationError);
+    const { method, typedCall, acquire } = createMethod();
+
+    await expect(method.run()).rejects.toBe(preparationError);
+
+    expectNoFirmwareMutationCalls(typedCall);
+    expect(acquire).not.toHaveBeenCalled();
+    expect(mockUploadFirmwareFromSource).not.toHaveBeenCalled();
   });
 
   it.each([
@@ -216,9 +238,11 @@ describe('FirmwareUpdateV2 download-before-reboot safety', () => {
           binary: firmwareBinary,
         } as Awaited<ReturnType<typeof getBinary>>);
       });
-      mockUploadFirmware.mockImplementation(() => {
+      mockUploadFirmwareFromSource.mockImplementation(() => {
         callOrder.push('upload');
-        return Promise.resolve(expectedResponse as Awaited<ReturnType<typeof uploadFirmware>>);
+        return Promise.resolve(
+          expectedResponse as Awaited<ReturnType<typeof uploadFirmwareFromSource>>
+        );
       });
       const { method, typedCall } = createMethod({
         updateType,
@@ -248,15 +272,15 @@ describe('FirmwareUpdateV2 download-before-reboot safety', () => {
           },
         })
       );
-      expect(mockUploadFirmware).toHaveBeenCalledWith(
+      expect(mockUploadFirmwareFromSource).toHaveBeenCalledWith(
         updateType,
         expect.any(Function),
         expect.any(Function),
         method.device,
-        {
-          payload: firmwareBinary,
-          rebootOnSuccess: true,
-        },
+        expect.objectContaining({
+          size: firmwareBinary.byteLength,
+        }),
+        true,
         isUpdateBootloader
       );
     }
@@ -271,11 +295,11 @@ describe('FirmwareUpdateV2 download-before-reboot safety', () => {
         binary: firmwareBinary,
       } as Awaited<ReturnType<typeof getBinary>>);
     });
-    mockUploadFirmware.mockImplementation(() => {
+    mockUploadFirmwareFromSource.mockImplementation(() => {
       callOrder.push('upload');
       return Promise.resolve({
         success: true,
-      } as Awaited<ReturnType<typeof uploadFirmware>>);
+      } as Awaited<ReturnType<typeof uploadFirmwareFromSource>>);
     });
     const { method, typedCall, acquire } = createMethod({
       bootloaderMode: true,
@@ -300,9 +324,9 @@ describe('FirmwareUpdateV2 download-before-reboot safety', () => {
           resolveDownload = resolve;
         })
     );
-    mockUploadFirmware.mockResolvedValue({
+    mockUploadFirmwareFromSource.mockResolvedValue({
       success: true,
-    } as Awaited<ReturnType<typeof uploadFirmware>>);
+    } as Awaited<ReturnType<typeof uploadFirmwareFromSource>>);
     const { method, typedCall } = createMethod();
 
     const runPromise = method.run();
@@ -333,7 +357,7 @@ describe('FirmwareUpdateV2 download-before-reboot safety', () => {
 
     expectNoFirmwareMutationCalls(typedCall);
     expect(acquire).not.toHaveBeenCalled();
-    expect(mockUploadFirmware).not.toHaveBeenCalled();
+    expect(mockUploadFirmwareFromSource).not.toHaveBeenCalled();
   });
 
   it.each([
@@ -342,23 +366,23 @@ describe('FirmwareUpdateV2 download-before-reboot safety', () => {
   ])(
     'keeps the non-empty %s binary overload and never downloads it again',
     async (_kind, binary) => {
-      mockUploadFirmware.mockResolvedValue({
+      mockUploadFirmwareFromSource.mockResolvedValue({
         success: true,
-      } as Awaited<ReturnType<typeof uploadFirmware>>);
+      } as Awaited<ReturnType<typeof uploadFirmwareFromSource>>);
       const { method } = createMethod({ binary });
 
       await method.run();
 
       expect(mockGetBinary).not.toHaveBeenCalled();
-      expect(mockUploadFirmware).toHaveBeenCalledWith(
+      expect(mockUploadFirmwareFromSource).toHaveBeenCalledWith(
         'firmware',
         expect.any(Function),
         expect.any(Function),
         method.device,
-        {
-          payload: binary,
-          rebootOnSuccess: true,
-        },
+        expect.objectContaining({
+          size: binary.byteLength,
+        }),
+        true,
         undefined
       );
     }
@@ -369,17 +393,21 @@ describe('FirmwareUpdateV2 download-before-reboot safety', () => {
     ['DataView', new DataView(new Uint8Array([9, 3, 4, 9]).buffer, 1, 2), [3, 4]],
     ['custom Buffer', createCustomBuffer(4), [1, 2, 3, 4]],
   ])('normalizes a non-empty %s before rebooting', async (_kind, binary, expectedBytes) => {
-    mockUploadFirmware.mockResolvedValue({
-      success: true,
-    } as Awaited<ReturnType<typeof uploadFirmware>>);
+    let uploadedBytes: number[] = [];
+    mockUploadFirmwareFromSource.mockImplementation(
+      async (_updateType, _typedCall, _postMessage, _device, source) => {
+        uploadedBytes = Array.from(new Uint8Array(await source.readAt(0, source.size)));
+        return {
+          success: true,
+        } as Awaited<ReturnType<typeof uploadFirmwareFromSource>>;
+      }
+    );
     const { method } = createMethod({ binary });
 
     await method.run();
 
     expect(mockGetBinary).not.toHaveBeenCalled();
-    const normalizedBinary = mockUploadFirmware.mock.calls[0][4].payload;
-    expect(normalizedBinary).toBeInstanceOf(ArrayBuffer);
-    expect(Array.from(new Uint8Array(normalizedBinary))).toEqual(expectedBytes);
+    expect(uploadedBytes).toEqual(expectedBytes);
   });
 
   it.each([
@@ -397,6 +425,6 @@ describe('FirmwareUpdateV2 download-before-reboot safety', () => {
     expect(mockGetBinary).not.toHaveBeenCalled();
     expectNoFirmwareMutationCalls(typedCall);
     expect(acquire).not.toHaveBeenCalled();
-    expect(mockUploadFirmware).not.toHaveBeenCalled();
+    expect(mockUploadFirmwareFromSource).not.toHaveBeenCalled();
   });
 });

package/__tests__/firmware-update/firmware-update-v3-reconnect.test.ts

@@ -0,0 +1,64 @@
+import FirmwareUpdateV3 from '../../src/api/FirmwareUpdateV3';
+import { DevicePool } from '../../src/device/DevicePool';
+
+import type { Device } from '../../src/device/Device';
+
+jest.mock('../../src/data/config', () => ({
+  getSDKVersion: jest.fn(() => '1.0.0'),
+  DEFAULT_DOMAIN: 'https://jssdk.onekey.so/1.0.0/',
+}));
+
+describe('FirmwareUpdateV3 reconnect', () => {
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+
+  it('keeps transient USB acquire failures inside the reconnect loop', async () => {
+    const acquire = jest.fn().mockResolvedValue(undefined);
+    const commands = {
+      disposed: true,
+      mainId: '',
+    };
+    const cachedDevice = {} as Device;
+    const updateFromCache = jest.fn();
+    jest.spyOn(DevicePool, 'getDevices').mockResolvedValue({
+      devices: {},
+      deviceList: [cachedDevice],
+    });
+
+    const method = new FirmwareUpdateV3({
+      id: 1,
+      payload: {
+        method: 'firmwareUpdateV3',
+        connectId: 'usb-path',
+      },
+    });
+    method.isBleReconnect = jest.fn(() => false);
+    method.device = {
+      originalDescriptor: {
+        id: 'usb-path',
+        path: 'usb-path',
+        protocolType: 'V1',
+      },
+      deviceConnector: {
+        enumerate: jest.fn().mockResolvedValue({
+          descriptors: [{ path: 'usb-path' }],
+        }),
+      },
+      updateFromCache,
+      acquire,
+      commands,
+      getCommands: () => commands,
+      mainId: 'usb-session',
+    } as unknown as Device;
+
+    await method.waitForDeviceReconnect(1000);
+
+    expect(updateFromCache).toHaveBeenCalledWith(cachedDevice);
+    expect(acquire).toHaveBeenCalledWith(undefined, {
+      throwOnRunPromiseError: true,
+    });
+    expect(commands.disposed).toBe(false);
+    expect(commands.mainId).toBe('usb-session');
+  });
+});

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

@@ -0,0 +1,70 @@
+import { EDeviceType } from '@onekeyfe/hd-shared';
+
+import { uploadFirmwareFromSource } from '../../src/api/firmware/uploadFirmware';
+
+import type { Device } from '../../src/device/Device';
+import type { FirmwareByteSource } from '../../src/api/firmware/FirmwareArtifactSource';
+
+jest.mock('../../src/data/config', () => ({
+  getSDKVersion: jest.fn(() => '1.0.0'),
+  DEFAULT_DOMAIN: 'https://jssdk.onekey.so/1.0.0/',
+}));
+
+describe('uploadFirmwareFromSource', () => {
+  it('serves legacy Touch firmware requests without materializing the complete artifact', async () => {
+    const size = 700 * 1024;
+    const requestedRanges: Array<{ offset: number; length: number }> = [];
+    const source: FirmwareByteSource = {
+      size,
+      readAt: jest.fn((offset: number, length: number) => {
+        requestedRanges.push({ offset, length });
+        return Promise.resolve(new ArrayBuffer(length));
+      }),
+      close: jest.fn(() => Promise.resolve()),
+    };
+    let nextOffset = 0;
+    const requestedLength = 128 * 1024;
+    const typedCall = jest.fn((type: string) => {
+      if (type === 'FirmwareErase') {
+        return Promise.resolve({
+          type: 'FirmwareRequest',
+          message: {
+            offset: nextOffset,
+            length: Math.min(requestedLength, size - nextOffset),
+          },
+        });
+      }
+      if (type === 'FirmwareUpload') {
+        nextOffset += Math.min(requestedLength, size - nextOffset);
+        if (nextOffset < size) {
+          return Promise.resolve({
+            type: 'FirmwareRequest',
+            message: {
+              offset: nextOffset,
+              length: Math.min(requestedLength, size - nextOffset),
+            },
+          });
+        }
+        return Promise.resolve({
+          type: 'Success',
+          message: { message: 'installed' },
+        });
+      }
+      return Promise.reject(new Error(`Unexpected command: ${type}`));
+    });
+    const device = {
+      features: undefined,
+      emit: jest.fn(),
+      getCurrentDeviceType: () => EDeviceType.Touch,
+      toMessageObject: () => ({}),
+    } as unknown as Device;
+
+    await expect(
+      uploadFirmwareFromSource('firmware', typedCall as never, jest.fn(), device, source)
+    ).resolves.toEqual({ message: 'installed' });
+
+    expect(requestedRanges).toHaveLength(Math.ceil(size / requestedLength));
+    expect(requestedRanges.every(({ length }) => length <= 256 * 1024)).toBe(true);
+    expect(requestedRanges.some(({ length }) => length === size)).toBe(false);
+  });
+});