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

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

@@ -1,593 +0,0 @@
-import { EDeviceType, EFirmwareType } from '@onekeyfe/hd-shared';
-
-import { buildFirmwareUpdatePlan } from '../../src/api/firmware/FirmwareUpdatePlan';
-
-import type { Features } from '../../src/types';
-
-const createFeatures = ({
-  deviceType,
-  firmwareVersion = '1.0.0',
-  bootloaderVersion = '1.0.0',
-}: {
-  deviceType: EDeviceType;
-  firmwareVersion?: string;
-  bootloaderVersion?: string;
-}) =>
-  ({
-    deviceType,
-    serialNo: `${deviceType}-device-id`,
-    firmwareVersion,
-    bootloaderVersion,
-  } as Features);
-
-const noUpdate = {
-  status: 'valid',
-  release: undefined,
-};
-
-const expectFirmwarePlanInvalid = (build: () => unknown, expectedMessage?: string) => {
-  let thrown: unknown;
-  try {
-    build();
-  } catch (error) {
-    thrown = error;
-  }
-  expect(thrown).toMatchObject({
-    params: {
-      firmwareUpdateCode: 'FirmwarePlanInvalid',
-    },
-  });
-  if (expectedMessage) {
-    expect(thrown).toBeInstanceOf(Error);
-    expect((thrown as Error).message).toContain(expectedMessage);
-  }
-};
-
-type BuildPlanInput = Parameters<typeof buildFirmwareUpdatePlan>[0];
-
-const createLegacyForceInput = (
-  forceUpdateTargets: unknown,
-  release: Record<string, unknown> = {
-    url: 'https://firmware.onekey.so/pro/firmware.bin',
-    version: [4, 21, 0],
-  }
-): BuildPlanInput => ({
-  features: createFeatures({
-    deviceType: EDeviceType.Pro,
-    firmwareVersion: '4.21.0',
-    bootloaderVersion: '2.8.4',
-  }),
-  firmwareType: EFirmwareType.Universal,
-  platform: 'desktop',
-  firmware: { status: 'valid', release },
-  ble: noUpdate,
-  bootloader: noUpdate,
-  forceUpdateTargets: forceUpdateTargets as BuildPlanInput['forceUpdateTargets'],
-});
-
-const createProtocolV2ForceInput = (
-  forceUpdateTargets: unknown,
-  release: Record<string, unknown>
-): BuildPlanInput => ({
-  features: createFeatures({
-    deviceType: EDeviceType.Pro2,
-    firmwareVersion: '1.0.0',
-    bootloaderVersion: '1.0.0',
-  }),
-  firmwareType: EFirmwareType.Universal,
-  platform: 'desktop',
-  firmware: { status: 'valid', release },
-  ble: noUpdate,
-  bootloader: noUpdate,
-  forceUpdateTargets: forceUpdateTargets as BuildPlanInput['forceUpdateTargets'],
-});
-
-describe('buildFirmwareUpdatePlan', () => {
-  test('selects all legacy artifacts before execution and chooses the desktop full resource', () => {
-    const plan = buildFirmwareUpdatePlan({
-      features: createFeatures({
-        deviceType: EDeviceType.Classic1s,
-        firmwareVersion: '1.0.0',
-      }),
-      firmwareType: EFirmwareType.Universal,
-      platform: 'desktop',
-      firmware: {
-        status: 'outdated',
-        release: {
-          url: 'https://firmware.onekey.so/classic/firmware.bin',
-          expectedSize: 1024,
-          fingerprint: '1111111111111111111111111111111111111111111111111111111111111111',
-          version: [3, 0, 0],
-          resource: 'https://firmware.onekey.so/classic/resource.zip',
-          fullResource: 'https://firmware.onekey.so/classic/full-resource.zip',
-          fullResourceExpectedSize: 4096,
-          fullResourceFingerprint:
-            '2222222222222222222222222222222222222222222222222222222222222222',
-          fullResourceRange: ['2.0.0', '3.0.0'],
-        },
-      },
-      ble: {
-        status: 'outdated',
-        release: {
-          webUpdate: 'https://firmware.onekey.so/classic/ble.bin',
-          expectedSize: 512,
-          fingerprintWeb: '3333333333333333333333333333333333333333333333333333333333333333',
-        },
-      },
-      bootloader: {
-        status: 'outdated',
-        shouldUpdate: true,
-        release: {
-          bootloaderResource: 'https://firmware.onekey.so/classic/bootloader.bin',
-          bootloaderExpectedSize: 768,
-          bootloaderFingerprint: '4444444444444444444444444444444444444444444444444444444444444444',
-          bootloaderVersion: [2, 0, 0],
-        },
-      },
-    });
-
-    expect(plan.executor).toBe('v2');
-    expect(plan.artifacts).toEqual([
-      expect.objectContaining({
-        artifactId: 'bootloader',
-        role: 'bootloader',
-        expectedSize: 768,
-        targetVersion: '2.0.0',
-      }),
-      expect.objectContaining({
-        artifactId: 'firmware',
-        role: 'firmware',
-        expectedSize: 1024,
-        targetVersion: '3.0.0',
-      }),
-      expect.objectContaining({
-        artifactId: 'resource',
-        role: 'resource',
-        url: 'https://firmware.onekey.so/classic/full-resource.zip',
-        expectedSize: 4096,
-      }),
-      expect.objectContaining({
-        artifactId: 'ble',
-        role: 'ble',
-        expectedSize: 512,
-      }),
-    ]);
-    expect(plan.targetsToUpdate).toEqual(['bootloader', 'firmware', 'resource', 'ble']);
-  });
-
-  test('selects V3 for Pro with bootloader 2.8 or newer', () => {
-    const plan = buildFirmwareUpdatePlan({
-      features: createFeatures({
-        deviceType: EDeviceType.Pro,
-        bootloaderVersion: '2.8.0',
-      }),
-      firmwareType: EFirmwareType.BitcoinOnly,
-      platform: 'native',
-      firmware: {
-        status: 'outdated',
-        release: {
-          url: 'https://firmware.onekey.so/pro/firmware.bin',
-          version: [4, 0, 0],
-        },
-      },
-      ble: noUpdate,
-      bootloader: noUpdate,
-    });
-
-    expect(plan.executor).toBe('v3');
-    expect(plan.firmwareType).toBe(EFirmwareType.BitcoinOnly);
-    expect(plan.platform).toBe('native');
-  });
-
-  test('includes same-version legacy artifacts selected by the host', () => {
-    const plan = buildFirmwareUpdatePlan({
-      features: createFeatures({
-        deviceType: EDeviceType.Pro,
-        firmwareVersion: '4.21.0',
-        bootloaderVersion: '2.8.4',
-      }),
-      firmwareType: EFirmwareType.Universal,
-      platform: 'desktop',
-      firmware: {
-        status: 'valid',
-        release: {
-          url: 'https://firmware.onekey.so/pro/firmware.bin',
-          version: [4, 21, 0],
-          resource: 'https://firmware.onekey.so/pro/resource.zip',
-        },
-      },
-      ble: {
-        status: 'valid',
-        release: {
-          webUpdate: 'https://firmware.onekey.so/pro/ble.bin',
-          version: [2, 3, 7],
-        },
-      },
-      bootloader: {
-        status: 'valid',
-        release: {
-          bootloaderResource: 'https://firmware.onekey.so/pro/bootloader.bin',
-          bootloaderVersion: [2, 8, 4],
-        },
-      },
-      forceUpdateTargets: ['firmware', 'resource', 'ble', 'bootloader'],
-    });
-
-    expect(plan.executor).toBe('v3');
-    expect(plan.artifacts.map(artifact => artifact.artifactId)).toEqual([
-      'bootloader',
-      'firmware',
-      'resource',
-      'ble',
-    ]);
-    expect(plan.targetsToUpdate).toEqual(['bootloader', 'firmware', 'resource', 'ble']);
-  });
-
-  test('does not include a same-version resource unless the host selects it', () => {
-    const plan = buildFirmwareUpdatePlan({
-      features: createFeatures({
-        deviceType: EDeviceType.Pro,
-        firmwareVersion: '4.21.0',
-        bootloaderVersion: '2.8.4',
-      }),
-      firmwareType: EFirmwareType.Universal,
-      platform: 'desktop',
-      firmware: {
-        status: 'valid',
-        release: {
-          url: 'https://firmware.onekey.so/pro/firmware.bin',
-          version: [4, 21, 0],
-          resource: 'https://firmware.onekey.so/pro/resource.zip',
-        },
-      },
-      ble: noUpdate,
-      bootloader: noUpdate,
-      forceUpdateTargets: ['firmware'],
-    });
-
-    expect(plan.artifacts.map(artifact => artifact.artifactId)).toEqual(['firmware']);
-    expect(plan.targetsToUpdate).toEqual(['firmware']);
-  });
-
-  test.each([
-    {
-      label: 'a non-array value',
-      forceUpdateTargets: 'firmware',
-    },
-    {
-      label: 'an unknown target',
-      forceUpdateTargets: ['firmware', 'unknown'],
-    },
-    {
-      label: 'a duplicate target',
-      forceUpdateTargets: ['firmware', 'firmware'],
-    },
-  ])('rejects $label in forceUpdateTargets', ({ forceUpdateTargets }) => {
-    expectFirmwarePlanInvalid(() =>
-      buildFirmwareUpdatePlan(createLegacyForceInput(forceUpdateTargets))
-    );
-  });
-
-  test('rejects an explicitly forced legacy resource without a resource artifact', () => {
-    expectFirmwarePlanInvalid(() => buildFirmwareUpdatePlan(createLegacyForceInput(['resource'])));
-  });
-
-  test.each(['ble', 'bootloader'] as const)(
-    'rejects the unsupported Pro2 %s force target',
-    forceTarget => {
-      expectFirmwarePlanInvalid(
-        () =>
-          buildFirmwareUpdatePlan(
-            createProtocolV2ForceInput([forceTarget], {
-              components: {
-                applicationP1: {
-                  target: 'APPLICATION_P1',
-                  url: 'https://firmware.onekey.so/pro2/application-p1.bin',
-                },
-              },
-            })
-          ),
-        'does not support forced'
-      );
-    }
-  );
-
-  test.each([
-    {
-      forceTarget: 'firmware' as const,
-      release: {
-        components: {},
-        resourceBundles: [
-          {
-            name: 'images',
-            url: 'https://firmware.onekey.so/pro2/images.okpkg',
-          },
-        ],
-      },
-    },
-    {
-      forceTarget: 'resource' as const,
-      release: {
-        components: {
-          applicationP1: {
-            target: 'APPLICATION_P1',
-            url: 'https://firmware.onekey.so/pro2/application-p1.bin',
-          },
-        },
-      },
-    },
-  ])(
-    'rejects a Pro2 $forceTarget force target not represented by an artifact',
-    ({ forceTarget, release }) => {
-      expectFirmwarePlanInvalid(() =>
-        buildFirmwareUpdatePlan(createProtocolV2ForceInput([forceTarget], release))
-      );
-    }
-  );
-
-  test.each([
-    {
-      forceTarget: 'firmware' as const,
-      expectedArtifactIds: ['component:app_v1'],
-      expectedTargets: ['app_v1'],
-    },
-    {
-      forceTarget: 'resource' as const,
-      expectedArtifactIds: ['resourceBundle:images'],
-      expectedTargets: ['resource'],
-    },
-  ])(
-    'limits a Pro2 $forceTarget force to the selected artifact role',
-    ({ forceTarget, expectedArtifactIds, expectedTargets }) => {
-      const plan = buildFirmwareUpdatePlan(
-        createProtocolV2ForceInput([forceTarget], {
-          components: {
-            applicationP1: {
-              target: 'APPLICATION_P1',
-              url: 'https://firmware.onekey.so/pro2/application-p1.bin',
-            },
-          },
-          resourceBundles: [
-            {
-              name: 'images',
-              url: 'https://firmware.onekey.so/pro2/images.okpkg',
-            },
-          ],
-        })
-      );
-
-      expect(plan.artifacts.map(artifact => artifact.artifactId)).toEqual(expectedArtifactIds);
-      expect(plan.targetsToUpdate).toEqual(expectedTargets);
-    }
-  );
-
-  test('rejects a prepared native plan without a stable device identity', () => {
-    const features = createFeatures({
-      deviceType: EDeviceType.Classic1s,
-    });
-    delete (features as Partial<Features>).serialNo;
-
-    expect(() =>
-      buildFirmwareUpdatePlan({
-        features,
-        firmwareType: EFirmwareType.Universal,
-        platform: 'native',
-        firmware: {
-          status: 'outdated',
-          release: {
-            url: 'https://firmware.onekey.so/classic/firmware.bin',
-          },
-        },
-        ble: noUpdate,
-        bootloader: noUpdate,
-      })
-    ).toThrow('requires a stable device identity');
-  });
-
-  test('maps the Pro2 component order and resource bundles without downloading them', () => {
-    const plan = buildFirmwareUpdatePlan({
-      features: createFeatures({ deviceType: EDeviceType.Pro2 }),
-      firmwareType: EFirmwareType.Universal,
-      platform: 'desktop',
-      firmware: {
-        status: 'required',
-        release: {
-          installOrder: ['bootloader', 'applicationP1'],
-          components: {
-            applicationP1: {
-              target: 'APPLICATION_P1',
-              url: 'https://firmware.onekey.so/pro2/application-p1.bin',
-              expectedSize: 1024,
-              fingerprint: '1111111111111111111111111111111111111111111111111111111111111111',
-            },
-            bootloader: {
-              target: 'BOOTLOADER',
-              url: 'https://firmware.onekey.so/pro2/bootloader.bin',
-            },
-            se01: {
-              target: 'SE01',
-              url: 'https://firmware.onekey.so/pro2/se01.bin',
-            },
-          },
-          resourceBundles: [
-            {
-              name: 'images',
-              url: 'https://firmware.onekey.so/pro2/images.okpkg',
-            },
-          ],
-        },
-      },
-      ble: noUpdate,
-      bootloader: noUpdate,
-    });
-
-    expect(plan.executor).toBe('v4');
-    expect(plan.artifacts.map(artifact => artifact.artifactId)).toEqual([
-      'component:boot',
-      'component:app_v1',
-      'component:se01',
-      'resourceBundle:images',
-    ]);
-    expect(plan.targetsToUpdate).toEqual(['boot', 'app_v1', 'se01', 'resource']);
-    expect(plan.artifacts[1]).toEqual(
-      expect.objectContaining({
-        expectedSize: 1024,
-        expectedSha256: '1111111111111111111111111111111111111111111111111111111111111111',
-      })
-    );
-  });
-
-  test('rejects Pro2 ROMLOADER because it requires a separate loader flow', () => {
-    expect(() =>
-      buildFirmwareUpdatePlan({
-        features: createFeatures({ deviceType: EDeviceType.Pro2 }),
-        firmwareType: EFirmwareType.Universal,
-        platform: 'desktop',
-        firmware: {
-          status: 'required',
-          release: {
-            components: {
-              romloader: {
-                target: 'ROMLOADER',
-                url: 'https://firmware.onekey.so/pro2/romloader.bin',
-              },
-            },
-          },
-        },
-        ble: noUpdate,
-        bootloader: noUpdate,
-      })
-    ).toThrow('ROMLOADER requires its dedicated loader flow');
-  });
-
-  test.each([
-    {
-      label: 'component target',
-      release: {
-        components: {
-          application: {
-            target: 'APPLICATION_P1',
-            url: 'https://firmware.onekey.so/pro2/application.bin',
-          },
-          applicationDuplicate: {
-            target: 'APPLICATION_P1',
-            url: 'https://firmware.onekey.so/pro2/application-duplicate.bin',
-          },
-        },
-      },
-      expectedError: 'duplicates target app_v1',
-    },
-    {
-      label: 'resource bundle name',
-      release: {
-        components: {
-          application: {
-            target: 'APPLICATION_P1',
-            url: 'https://firmware.onekey.so/pro2/application.bin',
-          },
-        },
-        resourceBundles: [
-          {
-            name: 'images',
-            url: 'https://firmware.onekey.so/pro2/images.okpkg',
-          },
-          {
-            name: 'images',
-            url: 'https://firmware.onekey.so/pro2/images-duplicate.okpkg',
-          },
-        ],
-      },
-      expectedError: 'duplicates name images',
-    },
-  ])('rejects a duplicate Pro2 $label', ({ release, expectedError }) => {
-    expect(() =>
-      buildFirmwareUpdatePlan({
-        features: createFeatures({ deviceType: EDeviceType.Pro2 }),
-        firmwareType: EFirmwareType.Universal,
-        platform: 'desktop',
-        firmware: {
-          status: 'required',
-          release,
-        },
-        ble: noUpdate,
-        bootloader: noUpdate,
-      })
-    ).toThrow(expectedError);
-  });
-
-  test('produces a deterministic digest and binds it to the platform', () => {
-    const input = {
-      features: createFeatures({ deviceType: EDeviceType.Classic1s }),
-      firmwareType: EFirmwareType.Universal,
-      firmware: noUpdate,
-      ble: noUpdate,
-      bootloader: noUpdate,
-    };
-    const first = buildFirmwareUpdatePlan({ ...input, platform: 'native' });
-    const second = buildFirmwareUpdatePlan({ ...input, platform: 'native' });
-    const desktop = buildFirmwareUpdatePlan({ ...input, platform: 'desktop' });
-
-    expect(first.planDigest).toMatch(/^[a-f0-9]{64}$/);
-    expect(first.planDigest).toBe(second.planDigest);
-    expect(first.planDigest).not.toBe(desktop.planDigest);
-  });
-
-  test('normalizes a malformed artifact URL to FirmwarePlanInvalid', () => {
-    let thrown: unknown;
-    try {
-      buildFirmwareUpdatePlan({
-        features: createFeatures({ deviceType: EDeviceType.Classic1s }),
-        firmwareType: EFirmwareType.Universal,
-        platform: 'native',
-        firmware: {
-          status: 'outdated',
-          release: {
-            url: 'not a url',
-            version: [3, 0, 0],
-          },
-        },
-        ble: noUpdate,
-        bootloader: noUpdate,
-      });
-    } catch (error) {
-      thrown = error;
-    }
-
-    expect(thrown).toMatchObject({
-      params: {
-        firmwareUpdateCode: 'FirmwarePlanInvalid',
-      },
-    });
-  });
-
-  test('binds trusted artifact integrity metadata into the plan digest', () => {
-    const createPlan = (fingerprint: string) =>
-      buildFirmwareUpdatePlan({
-        features: createFeatures({ deviceType: EDeviceType.Classic1s }),
-        firmwareType: EFirmwareType.Universal,
-        platform: 'native',
-        firmware: {
-          status: 'outdated',
-          release: {
-            url: 'https://firmware.onekey.so/classic/firmware.bin',
-            version: [3, 0, 0],
-            expectedSize: 1024,
-            fingerprint,
-          },
-        },
-        ble: noUpdate,
-        bootloader: noUpdate,
-      });
-
-    const first = createPlan('1111111111111111111111111111111111111111111111111111111111111111');
-    const second = createPlan('2222222222222222222222222222222222222222222222222222222222222222');
-
-    expect(first.artifacts[0]).toEqual(
-      expect.objectContaining({
-        expectedSize: 1024,
-        expectedSha256: '1111111111111111111111111111111111111111111111111111111111111111',
-      })
-    );
-    expect(first.planDigest).not.toBe(second.planDigest);
-  });
-});