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

package/src/api/FirmwareUpdateV2.ts

@@ -14,44 +14,27 @@ import { BaseMethod } from './BaseMethod';
 import { validateParams } from './helpers/paramsValidator';
 import { DevicePool } from '../device/DevicePool';
 import { getBinary, getInfo, getSysResourceBinary } from './firmware/getBinary';
+import { updateResources, uploadFirmware } from './firmware/uploadFirmware';
 import {
-  updateResources,
-  updateResourcesFromSources,
-  uploadFirmwareFromSource,
-} from './firmware/uploadFirmware';
-import { LoggerNames, getLogger, wait } from '../utils';
+  LoggerNames,
+  getDeviceFirmwareVersion,
+  getDeviceType,
+  getDeviceUUID,
+  getFirmwareType,
+  getLogger,
+  wait,
+} from '../utils';
 import { FirmwareUpdateTipMessage, createUiMessage } from '../events/ui-request';
 import { DeviceModelToTypes } from '../types';
 import { DataManager } from '../data-manager';
 import { DEVICE } from '../events';
-import { type FirmwareByteSource, openFirmwareByteSource } from './firmware/FirmwareArtifactSource';
-import { FirmwareCheckpointWriter } from './firmware/FirmwareCheckpoint';
-import { resolveFirmwareUpdateHostBinding } from './firmware/FirmwareHostBinding';
-import {
-  assertFirmwareUpdatePreparedPlanBinding,
-  getFirmwareUpdateResourceName,
-} from './firmware/FirmwareUpdatePreparedPlan';
 
 import type { Features, KnownDevice } from '../types';
+import type { Device } from '../device/Device';
 import type { FirmwareBinary } from './firmware/getBinary';
-import type {
-  FirmwareArtifactReader,
-  FirmwareArtifactReference,
-  FirmwareCheckpointParams,
-} from '../types/api/firmwareUpdate';
-import type { FirmwareUpdatePreparedPlan } from '../types/api/firmwareUpdatePreparedPlan';
-
-type Params = FirmwareCheckpointParams & {
+
+type Params = {
   binary?: ArrayBuffer;
-  artifact?: FirmwareArtifactReference;
-  resourceArtifact?: FirmwareArtifactReference;
-  resourceEntries?: Array<{
-    entryName: string;
-    artifact: FirmwareArtifactReference;
-  }>;
-  artifactReader?: FirmwareArtifactReader;
-  preparedPlan?: FirmwareUpdatePreparedPlan;
-  platform?: FirmwareUpdatePreparedPlan['platform'];
   version?: number[];
   updateType: 'firmware' | 'ble';
   forcedUpdateRes?: boolean;
@@ -132,13 +115,6 @@ const normalizeFirmwareBinary = (binary: unknown): FirmwareBinary | undefined =>
   return normalized.buffer;
 };
 
-const toArrayBuffer = (binary: FirmwareBinary): ArrayBuffer => {
-  if (binary instanceof ArrayBuffer) {
-    return binary;
-  }
-  return new Uint8Array(binary.buffer, binary.byteOffset, binary.byteLength).slice().buffer;
-};
-
 export default class FirmwareUpdateV2 extends BaseMethod<Params> {
   checkPromise: Deferred<any> | null = null;
 
@@ -185,42 +161,6 @@ export default class FirmwareUpdateV2 extends BaseMethod<Params> {
         binary: payload.binary,
       };
     }
-
-    if ('artifact' in payload) {
-      const hostBinding = resolveFirmwareUpdateHostBinding(payload.hostBindingGeneration);
-      const target = payload.isUpdateBootloader ? 'bootloader' : payload.updateType;
-      const resourceBindings = [
-        ...(payload.resourceArtifact
-          ? [{ target: 'resource' as const, artifact: payload.resourceArtifact }]
-          : []),
-        ...(payload.resourceEntries ?? []).map(
-          (entry: { entryName: string; artifact: FirmwareArtifactReference }) => ({
-            target: 'resource' as const,
-            entryName: entry.entryName,
-            artifact: entry.artifact,
-          })
-        ),
-      ];
-      assertFirmwareUpdatePreparedPlanBinding({
-        preparedPlan: payload.preparedPlan,
-        executor: 'v2',
-        platform: payload.platform,
-        scopeTargets: [target, ...(target === 'firmware' ? (['resource'] as const) : [])],
-        bindings: [{ target, artifact: payload.artifact }, ...resourceBindings],
-      });
-      this.params = {
-        ...this.params,
-        preparedPlan: payload.preparedPlan,
-        hostBindingGeneration: payload.hostBindingGeneration,
-        artifact: payload.artifact,
-        resourceArtifact: payload.resourceArtifact,
-        resourceEntries: payload.resourceEntries,
-        artifactReader: hostBinding.artifactReader,
-        checkpointSink: hostBinding.checkpointSink,
-        checkpointSequenceStart: payload.checkpointSequenceStart,
-        resumeCheckpoint: payload.resumeCheckpoint,
-      };
-    }
   }
 
   postTipMessage = (message: string) => {
@@ -234,7 +174,7 @@ export default class FirmwareUpdateV2 extends BaseMethod<Params> {
     );
   };
 
-  private async _promptDeviceInBootloaderForWebDevice() {
+  private async _promptDeviceInBootloaderForWebDevice({ device }: { device: Device }) {
     return new Promise((resolve, reject) => {
       if (this.device.listenerCount(DEVICE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE) > 0) {
         this.device.emit(
@@ -265,8 +205,9 @@ export default class FirmwareUpdateV2 extends BaseMethod<Params> {
     // eslint-disable-next-line prefer-const
     let timeoutTimer: ReturnType<typeof setTimeout> | undefined;
 
-    const deviceType = this.device?.getCurrentDeviceType();
-    const isTouchOrProDevice = deviceType === EDeviceType.Touch || deviceType === EDeviceType.Pro;
+    const isTouchOrProDevice =
+      getDeviceType(this?.device?.features) === EDeviceType.Touch ||
+      getDeviceType(this?.device?.features) === EDeviceType.Pro;
 
     const intervalTimer: ReturnType<typeof setInterval> | undefined = setInterval(
       async () => {
@@ -288,7 +229,9 @@ export default class FirmwareUpdateV2 extends BaseMethod<Params> {
 
           try {
             this.postTipMessage(FirmwareUpdateTipMessage.SelectDeviceInBootloaderForWebDevice);
-            const confirmed = await this._promptDeviceInBootloaderForWebDevice();
+            const confirmed = await this._promptDeviceInBootloaderForWebDevice({
+              device: this.device,
+            });
             if (confirmed) {
               await this._checkDeviceInBootloaderMode(connectId, intervalTimer, timeoutTimer);
             }
@@ -310,7 +253,7 @@ export default class FirmwareUpdateV2 extends BaseMethod<Params> {
               true
             );
             await this.device.initialize();
-            if (this.device.isBootloader()) {
+            if (this.device.features?.bootloader_mode) {
               clearInterval(intervalTimer);
               this.checkPromise?.resolve(true);
             }
@@ -343,7 +286,7 @@ export default class FirmwareUpdateV2 extends BaseMethod<Params> {
     const devicesDescriptor = deviceDiff?.descriptors ?? [];
     const { deviceList } = await DevicePool.getDevices(devicesDescriptor, connectId);
 
-    if (deviceList.length === 1 && deviceList[0]?.isBootloader()) {
+    if (deviceList.length === 1 && deviceList[0]?.features?.bootloader_mode) {
       // should update current device from cache
       // because device was reboot and had some new requests
       this.device.updateFromCache(deviceList[0]);
@@ -357,22 +300,22 @@ export default class FirmwareUpdateV2 extends BaseMethod<Params> {
     return false;
   }
 
-  isEnteredManuallyBoot() {
-    const deviceType = this.device.getCurrentDeviceType();
+  isEnteredManuallyBoot(features: Features) {
+    const deviceType = getDeviceType(features);
     const isMini = deviceType === EDeviceType.Mini;
     const isBoot183ClassicUpBle =
       this.params.updateType === 'firmware' &&
       deviceType === EDeviceType.Classic &&
-      this.device.getCurrentBootloaderVersionString() === '1.8.3';
+      features.bootloader_version === '1.8.3';
     return isMini || isBoot183ClassicUpBle;
   }
 
-  isSupportResourceUpdate(updateType: string) {
+  isSupportResourceUpdate(features: Features, updateType: string) {
     if (updateType !== 'firmware') return false;
 
-    const deviceType = this.device.getCurrentDeviceType();
+    const deviceType = getDeviceType(features);
     const isTouchMode = deviceType === EDeviceType.Touch || deviceType === EDeviceType.Pro;
-    const currentVersion = this.device.getCurrentFirmwareVersionString() ?? '0.0.0';
+    const currentVersion = getDeviceFirmwareVersion(features).join('.');
 
     return isTouchMode && semver.gte(currentVersion, '3.2.0');
   }
@@ -383,8 +326,8 @@ export default class FirmwareUpdateV2 extends BaseMethod<Params> {
    */
   checkVersionForCopyTouchResource(features: Features | undefined, firmwareType: EFirmwareType) {
     if (!features) return;
-    const deviceType = this.device.getCurrentDeviceType();
-    const currentVersion = this.device.getCurrentFirmwareVersionString() ?? '0.0.0';
+    const deviceType = getDeviceType(features);
+    const currentVersion = getDeviceFirmwareVersion(features).join('.');
     const targetVersion = this.params.version?.join('.');
     const { updateType } = this.params;
 
@@ -408,302 +351,153 @@ export default class FirmwareUpdateV2 extends BaseMethod<Params> {
   async run() {
     const { device, params } = this;
     const { features, commands } = device;
-    const deviceType = device.getCurrentDeviceType();
-    const checkpointWriter = new FirmwareCheckpointWriter(params, {
-      required: !!params.artifactReader,
-    });
-
-    // Protocol V2 (Pro2) uses DeviceFirmwareUpdate and must not enter this legacy flow.
-    if (device.isProtocolV2()) {
-      throw ERRORS.TypedError(
-        HardwareErrorCode.RuntimeError,
-        'Protocol V2 firmware update must use firmwareUpdateV4'
-      );
-    }
+    const deviceType = getDeviceType(features);
 
-    const deviceFirmwareType = device.getCurrentFirmwareType();
+    const deviceFirmwareType = getFirmwareType(device.features);
     const firmwareType = params.firmwareType ?? deviceFirmwareType;
 
     this.checkVersionForCopyTouchResource(features, firmwareType);
 
-    let preparedSource: FirmwareByteSource | undefined;
-    try {
-      const acquireFirmwareSource = async (): Promise<FirmwareByteSource> => {
-        try {
-          if (preparedSource) {
-            return preparedSource;
-          }
+    let preparedBinary: FirmwareBinary | undefined;
+    const acquireFirmwareBinary = async (): Promise<FirmwareBinary> => {
+      try {
+        if (preparedBinary) {
+          return preparedBinary;
+        }
 
-          if (params.binary !== undefined) {
-            const binary = normalizeFirmwareBinary(params.binary);
-            if (!binary) {
-              throw new Error('firmware binary is empty or invalid');
-            }
-            const source = await openFirmwareByteSource({
-              binary: toArrayBuffer(binary),
-            });
-            if (!source) {
-              throw new Error('firmware binary is empty or invalid');
-            }
-            preparedSource = source;
-            return source;
+        if (params.binary !== undefined) {
+          preparedBinary = normalizeFirmwareBinary(params.binary);
+          if (!preparedBinary) {
+            throw new Error('firmware binary is empty or invalid');
           }
+          return preparedBinary;
+        }
 
-          if (params.artifact) {
-            const source = await openFirmwareByteSource({
-              artifact: params.artifact,
-              reader: params.artifactReader,
-            });
-            if (!source) {
-              throw new Error('firmware artifact is not prepared');
-            }
-            preparedSource = source;
-            return source;
-          }
+        if (!device.features) {
+          throw ERRORS.TypedError(
+            HardwareErrorCode.RuntimeError,
+            'no features found for this device'
+          );
+        }
 
-          if (!device.features) {
-            throw ERRORS.TypedError(
-              HardwareErrorCode.RuntimeError,
-              'no features found for this device'
-            );
-          }
+        this.postTipMessage('DownloadFirmware');
+        const firmware = await getBinary({
+          features: device.features,
+          version: params.version,
+          updateType: params.updateType,
+          isUpdateBootloader: params.isUpdateBootloader,
+          firmwareType,
+          requestOptions: FIRMWARE_DOWNLOAD_REQUEST_OPTIONS,
+        });
+        preparedBinary = normalizeFirmwareBinary(firmware.binary);
+        if (!preparedBinary) {
+          throw new Error('downloaded firmware binary is empty or invalid');
+        }
+        this.postTipMessage('DownloadFirmwareSuccess');
+        return preparedBinary;
+      } catch (err) {
+        throw ERRORS.TypedError(HardwareErrorCode.FirmwareUpdateDownloadFailed, err.message ?? err);
+      }
+    };
 
-          if (
-            params.artifactReader ||
-            DataManager.getSettings('firmwareManifestMode') === 'external-only'
-          ) {
-            throw ERRORS.TypedError(
-              HardwareErrorCode.RuntimeError,
-              'Firmware must be prepared by the external firmware host',
-              {
-                firmwareUpdateCode: 'FirmwareArtifactsNotPrepared',
-                artifactName: 'firmware',
-              }
-            );
-          }
+    if (!features?.bootloader_mode && features) {
+      const uuid = getDeviceUUID(features);
+      // should go to bootloader mode manually
+      if (this.isEnteredManuallyBoot(features)) {
+        return Promise.reject(ERRORS.TypedError(HardwareErrorCode.FirmwareUpdateManuallyEnterBoot));
+      }
 
-          this.postTipMessage('DownloadFirmware');
-          const firmware = await getBinary({
-            features: device.features,
-            version: params.version,
-            updateType: params.updateType,
-            isUpdateBootloader: params.isUpdateBootloader,
-            firmwareType,
-            requestOptions: FIRMWARE_DOWNLOAD_REQUEST_OPTIONS,
-          });
-          const binary = normalizeFirmwareBinary(firmware.binary);
-          if (!binary) {
-            throw new Error('downloaded firmware binary is empty or invalid');
-          }
-          const source = await openFirmwareByteSource({
-            binary: toArrayBuffer(binary),
-          });
-          if (!source) {
-            throw new Error('downloaded firmware binary is empty or invalid');
+      // check & upgrade firmware resource
+      if (features && this.isSupportResourceUpdate(features, params.updateType)) {
+        this.postTipMessage('CheckLatestUiResource');
+        const resourceUrl = DataManager.getSysResourcesLatestRelease({
+          features,
+          forcedUpdateRes: params.forcedUpdateRes,
+          firmwareType,
+        });
+        if (resourceUrl) {
+          this.postTipMessage('DownloadLatestUiResource');
+          const resource = await getSysResourceBinary(resourceUrl);
+          this.postTipMessage('DownloadLatestUiResourceSuccess');
+          if (resource) {
+            await updateResources(
+              this.device.getCommands().typedCall.bind(this.device.getCommands()),
+              this.postMessage,
+              device,
+              resource.binary
+            );
           }
-          preparedSource = source;
-          this.postTipMessage('DownloadFirmwareSuccess');
-          return source;
-        } catch (err) {
-          throw ERRORS.TypedError(
-            HardwareErrorCode.FirmwareUpdateDownloadFailed,
-            err.message ?? err
-          );
         }
-      };
+      }
 
-      if (!device.isBootloader() && features) {
-        const serialNo = device.getCurrentSerialNo();
-        // should go to bootloader mode manually
-        if (this.isEnteredManuallyBoot()) {
-          throw ERRORS.TypedError(HardwareErrorCode.FirmwareUpdateManuallyEnterBoot);
+      // check if the device commands has been disposed
+      this.device?.commands?.checkDisposed();
+
+      // A failed firmware download must leave the device in normal mode.
+      await acquireFirmwareBinary();
+
+      // The request may outlive the current transport command instance.
+      this.device?.commands?.checkDisposed();
+
+      // auto go to bootloader mode
+      try {
+        this.postTipMessage('AutoRebootToBootloader');
+        const bootRes = await commands.typedCall('DeviceBackToBoot', 'Success');
+        // @ts-expect-error
+        if (bootRes.type === 'CallMethodError') {
+          throw ERRORS.TypedError(HardwareErrorCode.FirmwareUpdateAutoEnterBootFailure);
         }
+        this.postTipMessage('GoToBootloaderSuccess');
+        this.checkDeviceToBootloader(this.payload.connectId);
 
-        // All network-backed input must be ready before the first device mutation.
-        await acquireFirmwareSource();
-
-        // check & upgrade firmware resource
-        if (this.isSupportResourceUpdate(params.updateType)) {
-          this.postTipMessage('CheckLatestUiResource');
-          const resourceUrl = DataManager.getSysResourcesLatestRelease({
-            features,
-            forcedUpdateRes: params.forcedUpdateRes,
-            firmwareType,
-          });
-          if (resourceUrl) {
-            this.postTipMessage('DownloadLatestUiResource');
-            if (params.resourceEntries?.length) {
-              const sources: Array<{
-                entryName: string;
-                source: FirmwareByteSource;
-              }> = [];
-              try {
-                for (const entry of params.resourceEntries) {
-                  const resourceName = getFirmwareUpdateResourceName(entry.entryName);
-                  const source = await openFirmwareByteSource({
-                    artifact: entry.artifact,
-                    reader: params.artifactReader,
-                  });
-                  if (!source) {
-                    throw new Error('Firmware resource entry is not prepared');
-                  }
-                  sources.push({ entryName: resourceName, source });
-                }
-                await checkpointWriter.commit({
-                  stage: 'FILE_TRANSFER_STARTED',
-                  target: 'resource',
-                });
-                await updateResourcesFromSources(
-                  this.device.getCommands().typedCall.bind(this.device.getCommands()),
-                  this.postMessage,
-                  device,
-                  sources.map(entry => ({
-                    entryName: entry.entryName,
-                    source: entry.source,
-                  }))
-                );
-                await checkpointWriter.commit({
-                  stage: 'FILE_TRANSFER_COMPLETED',
-                  target: 'resource',
-                });
-              } finally {
-                await Promise.all(
-                  sources.map(entry => entry.source.close().catch(() => undefined))
-                );
-              }
-              this.postTipMessage('DownloadLatestUiResourceSuccess');
-            } else {
-              let resourceBinary: ArrayBuffer | Buffer;
-              if (params.resourceArtifact) {
-                throw ERRORS.TypedError(
-                  HardwareErrorCode.RuntimeError,
-                  'Firmware resource archive must be materialized into prepared entries',
-                  {
-                    firmwareUpdateCode: 'FirmwareArtifactsNotPrepared',
-                    artifactName: 'resource',
-                  }
-                );
-              } else {
-                if (
-                  params.artifactReader ||
-                  DataManager.getSettings('firmwareManifestMode') === 'external-only'
-                ) {
-                  throw ERRORS.TypedError(
-                    HardwareErrorCode.RuntimeError,
-                    'Firmware resource must be prepared by the external firmware host',
-                    {
-                      firmwareUpdateCode: 'FirmwareArtifactsNotPrepared',
-                      artifactName: 'resource',
-                    }
-                  );
-                }
-                resourceBinary = (await getSysResourceBinary(resourceUrl)).binary;
-              }
-              this.postTipMessage('DownloadLatestUiResourceSuccess');
-              await checkpointWriter.commit({
-                stage: 'FILE_TRANSFER_STARTED',
-                target: 'resource',
-              });
-              await updateResources(
-                this.device.getCommands().typedCall.bind(this.device.getCommands()),
-                this.postMessage,
-                device,
-                resourceBinary
-              );
-              await checkpointWriter.commit({
-                stage: 'FILE_TRANSFER_COMPLETED',
-                target: 'resource',
-              });
-            }
-          }
+        // force clean classic device cache so that the device can initialize again
+        if (DeviceModelToTypes.model_classic.includes(deviceType)) {
+          DevicePool.clearDeviceCache(uuid);
         }
+        delete DevicePool.devicesCache[''];
+        await this.checkPromise?.promise;
+        this.checkPromise = null;
 
         // check if the device commands has been disposed
         this.device?.commands?.checkDisposed();
 
-        // The request may outlive the current transport command instance.
-        this.device?.commands?.checkDisposed();
-
-        // auto go to bootloader mode
-        try {
-          this.postTipMessage('AutoRebootToBootloader');
-          await checkpointWriter.commit({
-            stage: 'BEFORE_DEVICE_MODE_CHANGE',
-            target: params.isUpdateBootloader ? 'bootloader' : params.updateType,
-          });
-          const bootRes = await commands.typedCall('DeviceBackToBoot', 'Success');
-          // @ts-expect-error
-          if (bootRes.type === 'CallMethodError') {
-            throw ERRORS.TypedError(HardwareErrorCode.FirmwareUpdateAutoEnterBootFailure);
-          }
-          this.postTipMessage('GoToBootloaderSuccess');
-          this.checkDeviceToBootloader(this.payload.connectId);
-
-          // force clean classic device cache so that the device can initialize again
-          if (DeviceModelToTypes.model_classic.includes(deviceType)) {
-            DevicePool.clearDeviceCache(serialNo);
-          }
-          delete DevicePool.devicesCache[''];
-          await this.checkPromise?.promise;
-          this.checkPromise = null;
-
-          // check if the device commands has been disposed
-          this.device?.commands?.checkDisposed();
-
-          /**
-           * Touch 1 with bootloader v2.5.0 issue: BLE chip need more time for looking up name, here change the delay time to 3000ms after rebooting.
-           */
-          const isTouch = DeviceModelToTypes.model_touch.includes(deviceType);
-          await wait(isTouch ? 3000 : 1500);
-        } catch (e) {
-          if (e instanceof HardwareError) {
-            return Promise.reject(e);
-          }
-          console.log('auto go to bootloader mode failed: ', e);
-          return Promise.reject(
-            ERRORS.TypedError(HardwareErrorCode.FirmwareUpdateAutoEnterBootFailure)
-          );
+        /**
+         * Touch 1 with bootloader v2.5.0 issue: BLE chip need more time for looking up name, here change the delay time to 3000ms after rebooting.
+         */
+        const isTouch = DeviceModelToTypes.model_touch.includes(deviceType);
+        await wait(isTouch ? 3000 : 1500);
+      } catch (e) {
+        if (e instanceof HardwareError) {
+          return Promise.reject(e);
         }
+        console.log('auto go to bootloader mode failed: ', e);
+        return Promise.reject(
+          ERRORS.TypedError(HardwareErrorCode.FirmwareUpdateAutoEnterBootFailure)
+        );
       }
+    }
 
-      // Devices already in bootloader mode still acquire through the same helper.
-      const source = await acquireFirmwareSource();
+    // Devices already in bootloader mode still acquire through the same helper.
+    const binary = await acquireFirmwareBinary();
 
-      // check if the device commands has been disposed
-      this.device?.commands?.checkDisposed();
+    // check if the device commands has been disposed
+    this.device?.commands?.checkDisposed();
 
-      await this.device.acquire();
-
-      const target = params.isUpdateBootloader ? 'bootloader' : params.updateType;
-      await checkpointWriter.commit({
-        stage: 'FILE_TRANSFER_STARTED',
-        target,
-      });
-      const response = await uploadFirmwareFromSource(
-        params.updateType,
-        this.device.getCommands().typedCall.bind(this.device.getCommands()),
-        this.postMessage,
-        device,
-        source,
-        true,
-        params.isUpdateBootloader
-      );
-      await checkpointWriter.commit({
-        stage: 'FILE_TRANSFER_COMPLETED',
-        target,
-      });
+    await this.device.acquire();
 
-      if (this.connectId) {
-        DevicePool.clearDeviceCache(this.connectId);
-      }
+    const response = await uploadFirmware(
+      params.updateType,
+      this.device.getCommands().typedCall.bind(this.device.getCommands()),
+      this.postMessage,
+      device,
+      { payload: binary, rebootOnSuccess: true },
+      params.isUpdateBootloader
+    );
 
-      await checkpointWriter.commit({
-        stage: 'FINAL_VERIFIED',
-        target,
-      });
-      return response;
-    } finally {
-      await preparedSource?.close().catch(() => undefined);
+    if (this.connectId) {
+      DevicePool.clearDeviceCache(this.connectId);
     }
+
+    return response;
   }
 }