@onekeyfe/hd-core 1.1.34-alpha.2 → 1.1.34-alpha.3

package/__tests__/firmware-update/firmware-update-recovery.test.ts

@@ -0,0 +1,81 @@
+import { EFirmwareType } from '@onekeyfe/hd-shared';
+
+import FirmwareUpdateV3 from '../../src/api/FirmwareUpdateV3';
+import { FirmwareCheckpointWriter } from '../../src/api/firmware/FirmwareCheckpoint';
+
+jest.mock('../../src/data/config', () => ({
+  getSDKVersion: jest.fn(() => '1.0.0'),
+  DEFAULT_DOMAIN: 'https://jssdk.onekey.so/1.0.0/',
+}));
+
+const createMethod = ({ firmwareVersion }: { firmwareVersion: string }) => {
+  const checkpoints: unknown[] = [];
+  const method = new FirmwareUpdateV3({
+    id: 1,
+    payload: {
+      method: 'firmwareUpdateV3',
+      platform: 'desktop',
+      firmwareVersion: [4, 10, 0],
+      firmwareType: EFirmwareType.Universal,
+      checkpointSequenceStart: 1,
+      resumeCheckpoint: {
+        schemaVersion: 1,
+        sequence: 1,
+        stage: 'INSTALL_ACCEPTED',
+        destructiveActionStarted: true,
+        target: 'firmware',
+      },
+      checkpointSink: {
+        commit(checkpoint) {
+          checkpoints.push(checkpoint);
+          return Promise.resolve();
+        },
+      },
+    },
+  });
+  method.init();
+  (method as any).checkpointWriter = new FirmwareCheckpointWriter((method as any).params, {
+    required: true,
+  });
+  const features = {
+    firmwareVersion,
+    bootloaderVersion: '2.8.0',
+    bleVersion: '1.0.0',
+    firmwareType: EFirmwareType.Universal,
+    capabilities: [],
+  };
+  return { checkpoints, features, method };
+};
+
+describe('firmware recovery reconciliation', () => {
+  it('finishes an acknowledged V3 install only after expected versions match', async () => {
+    const { checkpoints, features, method } = createMethod({
+      firmwareVersion: '4.10.0',
+    });
+
+    await expect((method as any).reconcileInterruptedInstall(features)).resolves.toEqual({
+      bootloaderVersion: '2.8.0',
+      bleVersion: '1.0.0',
+      firmwareVersion: '4.10.0',
+    });
+    expect(checkpoints).toEqual([
+      expect.objectContaining({
+        sequence: 2,
+        stage: 'FINAL_VERIFIED',
+      }),
+    ]);
+  });
+
+  it('never resends an ambiguous V3 install when versions cannot reconcile it', async () => {
+    const { checkpoints, features, method } = createMethod({
+      firmwareVersion: '4.9.0',
+    });
+
+    await expect((method as any).reconcileInterruptedInstall(features)).rejects.toMatchObject({
+      params: {
+        firmwareUpdateCode: 'FirmwareReconciliationUnavailable',
+      },
+    });
+    expect(checkpoints).toEqual([]);
+  });
+});

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

@@ -1,8 +1,8 @@
-import { HardwareErrorCode } from '@onekeyfe/hd-shared';
+import { EDeviceType, EFirmwareType, 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';
 
@@ -113,6 +116,14 @@ const createMethod = ({
     },
     commands,
     getCommands: () => commands,
+    getCurrentDeviceType: () =>
+      deviceType === 'PURE' ? EDeviceType.ClassicPure : EDeviceType.Classic1s,
+    getCurrentFirmwareType: () => EFirmwareType.Universal,
+    getCurrentFirmwareVersionString: () => '3.0.0',
+    getCurrentBootloaderVersionString: () => '0.0.0',
+    getCurrentSerialNo: () => (deviceType === 'PURE' ? 'CP123456' : 'CL123456'),
+    isBootloader: () => bootloaderMode,
+    isProtocolV2: () => false,
     acquire,
     toMessageObject: jest.fn(() => ({})),
   } as any;
@@ -167,7 +178,7 @@ 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.each([
@@ -208,9 +219,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,
@@ -240,15 +253,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
       );
     }
@@ -263,11 +276,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,
@@ -292,9 +305,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();
@@ -325,7 +338,7 @@ describe('FirmwareUpdateV2 download-before-reboot safety', () => {
 
     expectNoFirmwareMutationCalls(typedCall);
     expect(acquire).not.toHaveBeenCalled();
-    expect(mockUploadFirmware).not.toHaveBeenCalled();
+    expect(mockUploadFirmwareFromSource).not.toHaveBeenCalled();
   });
 
   it.each([
@@ -334,23 +347,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
       );
     }
@@ -361,17 +374,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([
@@ -389,6 +406,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-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);
+  });
+});