@onekeyfe/hd-transport-lowlevel 1.2.0-alpha.16 → 1.2.0-alpha.17

package/__tests__/firmware-upload-progress.test.js

@@ -0,0 +1,42 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+const { getProtocolV1SendOptions, shouldLogFirmwareUploadProgress } = require('../src');
+
+describe('firmware upload progress logging', () => {
+  test('按 5% 进度限流打印', () => {
+    expect(
+      shouldLogFirmwareUploadProgress({
+        percent: 9,
+        lastLoggedPercent: 5,
+        now: 5_000,
+        lastLoggedAt: 0,
+      })
+    ).toBe(false);
+
+    expect(
+      shouldLogFirmwareUploadProgress({
+        percent: 10,
+        lastLoggedPercent: 5,
+        now: 5_000,
+        lastLoggedAt: 0,
+      })
+    ).toBe(true);
+  });
+
+  test('进度不足 5% 时最长每 10 秒打印一次心跳', () => {
+    expect(
+      shouldLogFirmwareUploadProgress({
+        percent: 7,
+        lastLoggedPercent: 5,
+        now: 10_000,
+        lastLoggedAt: 0,
+      })
+    ).toBe(true);
+  });
+});
+
+describe('firmware upload write mode', () => {
+  test('固件上传使用带响应写入，普通命令保持默认模式', () => {
+    expect(getProtocolV1SendOptions('FirmwareUpload')).toEqual({ withoutResponse: false });
+    expect(getProtocolV1SendOptions('Initialize')).toBeUndefined();
+  });
+});

package/dist/index.d.ts

@@ -7,6 +7,15 @@ type LowLevelAcquireInput = {
     expectedProtocol?: ProtocolType;
 };
 
+declare function shouldLogFirmwareUploadProgress({ percent, lastLoggedPercent, now, lastLoggedAt, }: {
+    percent: number;
+    lastLoggedPercent: number;
+    now: number;
+    lastLoggedAt: number;
+}): boolean;
+declare function getProtocolV1SendOptions(name: string): {
+    withoutResponse: boolean;
+} | undefined;
 declare class LowlevelTransport {
     _messages: ReturnType<typeof transport__default.parseConfigure> | undefined;
     _messagesV2: ReturnType<typeof transport__default.parseConfigure> | undefined;
@@ -51,4 +60,4 @@ declare class LowlevelTransport {
     cancel(): void;
 }
 
-export { LowlevelTransport as default };
+export { LowlevelTransport as default, getProtocolV1SendOptions, shouldLogFirmwareUploadProgress };

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,OAAO,SAWN,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,YAAY,MAAM,QAAQ,CAAC;AACvC,OAAO,KAAK,EACV,cAAc,EACd,6BAA6B,EAC7B,YAAY,EACZ,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAqBpD,MAAM,CAAC,OAAO,OAAO,iBAAiB;IACpC,SAAS,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;IAEnE,WAAW,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;IAErE,UAAU,UAAS;IAEnB,GAAG,CAAC,EAAE,GAAG,CAAC;IAEV,OAAO,CAAC,EAAE,YAAY,CAAC;IAEvB,MAAM,EAAE,6BAA6B,CAAuC;IAE5E,OAAO,CAAC,cAAc,CAAwC;IAE9D,OAAO,CAAC,mBAAmB,CAAwC;IAEnE,OAAO,CAAC,oBAAoB,CAAoD;IAEhF,OAAO,CAAC,qBAAqB,CAAkC;IAE/D,OAAO,CAAC,gBAAgB,CAA0B;IAElD,OAAO,CAAC,eAAe,CA6BpB;IAEH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAIvD,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,6BAA6B;IAO9E,SAAS,CAAC,UAAU,EAAE,GAAG;IAMzB,mBAAmB,CAAC,UAAU,EAAE,GAAG;IAOnC,MAAM;IAIA,SAAS;IAWT,OAAO,CAAC,KAAK,EAAE,oBAAoB;;;;IA6BnC,OAAO,CAAC,IAAI,EAAE,MAAM;IAgBpB,IAAI,CACR,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,CAAC,EAAE,oBAAoB;YAsBlB,cAAc;IAoC5B,OAAO,CAAC,0BAA0B;IAOlC,OAAO,CAAC,2BAA2B;IAOnC,OAAO,CAAC,4BAA4B;IAOpC,OAAO,CAAC,kBAAkB;YAMZ,cAAc;YAsDd,yBAAyB;YAiCzB,eAAe;YAgBf,eAAe;YA6Bf,UAAU;YAUV,qBAAqB;YAmBrB,mBAAmB;YAqBnB,oBAAoB;YAOpB,cAAc;IA6B5B,OAAO,CAAC,uBAAuB;IAkC/B,OAAO,CAAC,2BAA2B;IAMnC,MAAM;CAGP"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,OAAO,SAWN,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,YAAY,MAAM,QAAQ,CAAC;AACvC,OAAO,KAAK,EACV,cAAc,EACd,6BAA6B,EAC7B,YAAY,EACZ,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAWpD,wBAAgB,+BAA+B,CAAC,EAC9C,OAAO,EACP,iBAAiB,EACjB,GAAG,EACH,YAAY,GACb,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;CACtB,WAMA;AAED,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM;;cAEpD;AAcD,MAAM,CAAC,OAAO,OAAO,iBAAiB;IACpC,SAAS,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;IAEnE,WAAW,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;IAErE,UAAU,UAAS;IAEnB,GAAG,CAAC,EAAE,GAAG,CAAC;IAEV,OAAO,CAAC,EAAE,YAAY,CAAC;IAEvB,MAAM,EAAE,6BAA6B,CAAuC;IAE5E,OAAO,CAAC,cAAc,CAAwC;IAE9D,OAAO,CAAC,mBAAmB,CAAwC;IAEnE,OAAO,CAAC,oBAAoB,CAAoD;IAEhF,OAAO,CAAC,qBAAqB,CAAkC;IAE/D,OAAO,CAAC,gBAAgB,CAA0B;IAElD,OAAO,CAAC,eAAe,CA6BpB;IAEH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAIvD,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,6BAA6B;IAO9E,SAAS,CAAC,UAAU,EAAE,GAAG;IAMzB,mBAAmB,CAAC,UAAU,EAAE,GAAG;IAOnC,MAAM;IAIA,SAAS;IAWT,OAAO,CAAC,KAAK,EAAE,oBAAoB;;;;IA6BnC,OAAO,CAAC,IAAI,EAAE,MAAM;IAgBpB,IAAI,CACR,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,CAAC,EAAE,oBAAoB;YAsBlB,cAAc;IAmE5B,OAAO,CAAC,0BAA0B;IAOlC,OAAO,CAAC,2BAA2B;IAOnC,OAAO,CAAC,4BAA4B;IAOpC,OAAO,CAAC,kBAAkB;YAMZ,cAAc;YAsDd,yBAAyB;YAiCzB,eAAe;YAgBf,eAAe;YA6Bf,UAAU;YAUV,qBAAqB;YAmBrB,mBAAmB;YAqBnB,oBAAoB;YAOpB,cAAc;IA6B5B,OAAO,CAAC,uBAAuB;IAkC/B,OAAO,CAAC,2BAA2B;IAMnC,MAAM;CAGP"}

package/dist/index.js

@@ -1,5 +1,7 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var hdShared = require('@onekeyfe/hd-shared');
 var transport = require('@onekeyfe/hd-transport');
 
@@ -42,6 +44,16 @@ const PROTOCOL_PROBE_TIMEOUT_MS = 1000;
 const PROTOCOL_V2_PROBE_TIMEOUT_MS = 5000;
 const LOWLEVEL_PROTOCOL_TIMEOUT_MS = 30000;
 const LOWLEVEL_PROTOCOL_V2_PACKET_LENGTH = 64;
+const FIRMWARE_UPLOAD_LOG_PERCENT_STEP = 5;
+const FIRMWARE_UPLOAD_LOG_INTERVAL_MS = 10000;
+function shouldLogFirmwareUploadProgress({ percent, lastLoggedPercent, now, lastLoggedAt, }) {
+    return (percent === 100 ||
+        percent - lastLoggedPercent >= FIRMWARE_UPLOAD_LOG_PERCENT_STEP ||
+        now - lastLoggedAt >= FIRMWARE_UPLOAD_LOG_INTERVAL_MS);
+}
+function getProtocolV1SendOptions(name) {
+    return name === 'FirmwareUpload' ? { withoutResponse: false } : undefined;
+}
 function inferProtocolHintFromDeviceName(name) {
     return /\bpro\s*2\b/i.test(name !== null && name !== void 0 ? name : '') ? 'V2' : undefined;
 }
@@ -182,16 +194,42 @@ class LowlevelTransport {
         });
     }
     callProtocolV1(uuid, name, data, options) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             if (!this._messages) {
                 throw hdShared.ERRORS.TypedError(hdShared.HardwareErrorCode.TransportNotConfigured);
             }
             const messages = this._messages;
             const buffers = ProtocolV1.encodeTransportPackets(messages, name, data);
-            for (const o of buffers) {
+            const isFirmwareUpload = name === 'FirmwareUpload';
+            const uploadStartedAt = Date.now();
+            const totalBytes = buffers.reduce((sum, buffer) => sum + buffer.limit, 0);
+            let sentBytes = 0;
+            let lastLoggedPercent = 0;
+            let lastLoggedAt = uploadStartedAt;
+            for (const [index, o] of buffers.entries()) {
                 const outData = o.toString('hex');
                 try {
-                    yield this.plugin.send(uuid, outData);
+                    yield this.plugin.send(uuid, outData, getProtocolV1SendOptions(name));
+                    sentBytes += o.limit;
+                    if (isFirmwareUpload) {
+                        const now = Date.now();
+                        const percent = Math.floor(((index + 1) / buffers.length) * 100);
+                        if (shouldLogFirmwareUploadProgress({
+                            percent,
+                            lastLoggedPercent,
+                            now,
+                            lastLoggedAt,
+                        })) {
+                            const elapsedSeconds = Math.max((now - uploadStartedAt) / 1000, 0.001);
+                            const kibPerSecond = sentBytes / 1024 / elapsedSeconds;
+                            (_a = this.Log) === null || _a === void 0 ? void 0 : _a.debug(`[LowlevelTransport] FirmwareUpload progress: ${percent}% ` +
+                                `(${index + 1}/${buffers.length} packets, ${sentBytes}/${totalBytes} bytes, ` +
+                                `${elapsedSeconds.toFixed(1)}s, ${kibPerSecond.toFixed(1)} KiB/s)`);
+                            lastLoggedPercent = percent;
+                            lastLoggedAt = now;
+                        }
+                    }
                 }
                 catch (e) {
                     this.Log.debug('lowlevel transport send error: ', e);
@@ -459,4 +497,6 @@ class LowlevelTransport {
     }
 }
 
-module.exports = LowlevelTransport;
+exports["default"] = LowlevelTransport;
+exports.getProtocolV1SendOptions = getProtocolV1SendOptions;
+exports.shouldLogFirmwareUploadProgress = shouldLogFirmwareUploadProgress;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onekeyfe/hd-transport-lowlevel",
-  "version": "1.2.0-alpha.16",
+  "version": "1.2.0-alpha.17",
   "homepage": "https://github.com/OneKeyHQ/hardware-js-sdk#readme",
   "license": "MIT",
   "main": "dist/index.js",
@@ -20,8 +20,8 @@
     "lint:fix": "eslint . --fix"
   },
   "dependencies": {
-    "@onekeyfe/hd-shared": "1.2.0-alpha.16",
-    "@onekeyfe/hd-transport": "1.2.0-alpha.16"
+    "@onekeyfe/hd-shared": "1.2.0-alpha.17",
+    "@onekeyfe/hd-transport": "1.2.0-alpha.17"
   },
-  "gitHead": "2356d951f63a39a46bc995c2090348a383966175"
+  "gitHead": "9027b743e4f73beb42e1a7950397504b4191f2a3"
 }

package/src/index.ts

@@ -27,6 +27,30 @@ const PROTOCOL_PROBE_TIMEOUT_MS = 1000;
 const PROTOCOL_V2_PROBE_TIMEOUT_MS = 5000;
 const LOWLEVEL_PROTOCOL_TIMEOUT_MS = 30_000;
 const LOWLEVEL_PROTOCOL_V2_PACKET_LENGTH = 64;
+const FIRMWARE_UPLOAD_LOG_PERCENT_STEP = 5;
+const FIRMWARE_UPLOAD_LOG_INTERVAL_MS = 10_000;
+
+export function shouldLogFirmwareUploadProgress({
+  percent,
+  lastLoggedPercent,
+  now,
+  lastLoggedAt,
+}: {
+  percent: number;
+  lastLoggedPercent: number;
+  now: number;
+  lastLoggedAt: number;
+}) {
+  return (
+    percent === 100 ||
+    percent - lastLoggedPercent >= FIRMWARE_UPLOAD_LOG_PERCENT_STEP ||
+    now - lastLoggedAt >= FIRMWARE_UPLOAD_LOG_INTERVAL_MS
+  );
+}
+
+export function getProtocolV1SendOptions(name: string) {
+  return name === 'FirmwareUpload' ? { withoutResponse: false } : undefined;
+}
 
 function inferProtocolHintFromDeviceName(name?: string | null): ProtocolType | undefined {
   return /\bpro\s*2\b/i.test(name ?? '') ? 'V2' : undefined;
@@ -216,10 +240,41 @@ export default class LowlevelTransport {
 
     const messages = this._messages;
     const buffers = ProtocolV1.encodeTransportPackets(messages, name, data);
-    for (const o of buffers) {
+    const isFirmwareUpload = name === 'FirmwareUpload';
+    const uploadStartedAt = Date.now();
+    const totalBytes = buffers.reduce((sum, buffer) => sum + buffer.limit, 0);
+    let sentBytes = 0;
+    let lastLoggedPercent = 0;
+    let lastLoggedAt = uploadStartedAt;
+
+    for (const [index, o] of buffers.entries()) {
       const outData = o.toString('hex');
       try {
-        await this.plugin.send(uuid, outData);
+        await this.plugin.send(uuid, outData, getProtocolV1SendOptions(name));
+        sentBytes += o.limit;
+
+        if (isFirmwareUpload) {
+          const now = Date.now();
+          const percent = Math.floor(((index + 1) / buffers.length) * 100);
+          if (
+            shouldLogFirmwareUploadProgress({
+              percent,
+              lastLoggedPercent,
+              now,
+              lastLoggedAt,
+            })
+          ) {
+            const elapsedSeconds = Math.max((now - uploadStartedAt) / 1000, 0.001);
+            const kibPerSecond = sentBytes / 1024 / elapsedSeconds;
+            this.Log?.debug(
+              `[LowlevelTransport] FirmwareUpload progress: ${percent}% ` +
+                `(${index + 1}/${buffers.length} packets, ${sentBytes}/${totalBytes} bytes, ` +
+                `${elapsedSeconds.toFixed(1)}s, ${kibPerSecond.toFixed(1)} KiB/s)`
+            );
+            lastLoggedPercent = percent;
+            lastLoggedAt = now;
+          }
+        }
       } catch (e) {
         this.Log.debug('lowlevel transport send error: ', e);
         throw ERRORS.TypedError(HardwareErrorCode.BleWriteCharacteristicError, e.reason);