@onekeyfe/hd-transport-web-device 1.2.0-alpha.22 → 1.2.0-alpha.23

package/__tests__/webusb-protocol-v2-timeout.test.ts

@@ -43,6 +43,38 @@ describe('WebUsbTransport Protocol V2 timeout recovery', () => {
     expect(webusb.deviceProtocol.get(path)).toBe('V2');
   });
 
+  test('retries an expected Protocol V2 probe once after resetting the connection', async () => {
+    const webusb = new WebUsbTransport() as any;
+    const path = 'pro2-webusb';
+    webusb.probeProtocolV1 = jest.fn();
+    webusb.probeProtocolV2 = jest.fn().mockResolvedValueOnce(false).mockResolvedValueOnce(true);
+    webusb.resetConnectionAfterProbe = jest.fn().mockResolvedValue(undefined);
+
+    await expect(webusb.detectProtocol(path, 'V2')).resolves.toBe('V2');
+
+    expect(webusb.probeProtocolV2).toHaveBeenCalledTimes(2);
+    expect(webusb.probeProtocolV1).not.toHaveBeenCalled();
+    expect(webusb.resetConnectionAfterProbe).toHaveBeenCalledTimes(1);
+    expect(webusb.deviceProtocol.get(path)).toBe('V2');
+  });
+
+  test('reports a Protocol V2 probe timeout only after the bounded retry is exhausted', async () => {
+    const webusb = new WebUsbTransport() as any;
+    const path = 'pro2-webusb';
+    webusb.probeProtocolV1 = jest.fn();
+    webusb.probeProtocolV2 = jest.fn().mockResolvedValue(false);
+    webusb.resetConnectionAfterProbe = jest.fn().mockResolvedValue(undefined);
+
+    await expect(webusb.detectProtocol(path, 'V2')).rejects.toThrow(
+      'Protocol V2 probe timeout after 2 attempts'
+    );
+
+    expect(webusb.probeProtocolV2).toHaveBeenCalledTimes(2);
+    expect(webusb.probeProtocolV1).not.toHaveBeenCalled();
+    expect(webusb.resetConnectionAfterProbe).toHaveBeenCalledTimes(2);
+    expect(webusb.deviceProtocol.has(path)).toBe(false);
+  });
+
   test('invalidates and resets the cached connection before another call can start', async () => {
     const webusb = new WebUsbTransport() as any;
     const path = 'pro2-webusb';

package/dist/index.d.ts

@@ -88,6 +88,7 @@ declare class WebUsbTransport {
      * fall back to a Protocol V2 Ping probe.
      */
     private createProtocolMismatchError;
+    private createProtocolProbeTimeoutError;
     private createProtocolDetectionError;
     private detectProtocol;
     /**

package/dist/index.js

@@ -60,6 +60,7 @@ const HEADER_LENGTH = transport.PROTOCOL_V1_MESSAGE_HEADER_SIZE;
 const PACKET_IO_MAX_RETRIES = 3;
 const PACKET_IO_RETRY_DELAY = 300;
 const PROTOCOL_PROBE_TIMEOUT = 1000;
+const EXPECTED_PROTOCOL_V2_PROBE_ATTEMPTS = 2;
 function inferProtocolHintFromDeviceName$1(name) {
     return /\bpro\s*2\b/i.test(name !== null && name !== void 0 ? name : '') ? 'V2' : undefined;
 }
@@ -183,10 +184,14 @@ class WebUsbTransport {
     createProtocolMismatchError(expected) {
         return hdShared.ERRORS.TypedError(hdShared.HardwareErrorCode.RuntimeError, `Device protocol mismatch: expected ${expected}, but device did not respond to expected protocol`);
     }
+    createProtocolProbeTimeoutError(expected, attempts) {
+        return hdShared.ERRORS.TypedError(hdShared.HardwareErrorCode.RuntimeError, `Protocol ${expected} probe timeout after ${attempts} attempts`);
+    }
     createProtocolDetectionError() {
         return hdShared.ERRORS.TypedError(hdShared.HardwareErrorCode.RuntimeError, 'Unable to detect USB protocol: device did not respond to Protocol V1 Initialize or Protocol V2 Ping');
     }
     detectProtocol(path, expectedProtocol, protocolHint) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             if (expectedProtocol === 'V1') {
                 if (yield this.probeProtocolV1(path)) {
@@ -197,11 +202,18 @@ class WebUsbTransport {
                 throw this.createProtocolMismatchError(expectedProtocol);
             }
             if (expectedProtocol === 'V2') {
-                if (yield this.probeProtocolV2(path)) {
-                    this.deviceProtocol.set(path, 'V2');
-                    return 'V2';
+                for (let attempt = 1; attempt <= EXPECTED_PROTOCOL_V2_PROBE_ATTEMPTS; attempt += 1) {
+                    if (yield this.probeProtocolV2(path)) {
+                        this.deviceProtocol.set(path, 'V2');
+                        return 'V2';
+                    }
+                    yield this.resetConnectionAfterProbe(path);
+                    if (attempt < EXPECTED_PROTOCOL_V2_PROBE_ATTEMPTS) {
+                        (_a = this.Log) === null || _a === void 0 ? void 0 : _a.debug(`[WebUsbTransport] Protocol V2 probe timed out, retrying ${attempt + 1}/${EXPECTED_PROTOCOL_V2_PROBE_ATTEMPTS}`);
+                    }
                 }
-                throw this.createProtocolMismatchError(expectedProtocol);
+                this.deviceProtocol.delete(path);
+                throw this.createProtocolProbeTimeoutError(expectedProtocol, EXPECTED_PROTOCOL_V2_PROBE_ATTEMPTS);
             }
             const probeOrder = protocolHint === 'V2' || this.deviceProtocol.get(path) === 'V2' ? ['V2', 'V1'] : ['V1', 'V2'];
             for (const protocol of probeOrder) {
@@ -210,9 +222,7 @@ class WebUsbTransport {
                     this.deviceProtocol.set(path, protocol);
                     return protocol;
                 }
-                if (protocol === 'V1') {
-                    yield this.resetConnectionAfterProbe(path);
-                }
+                yield this.resetConnectionAfterProbe(path);
             }
             this.deviceProtocol.delete(path);
             throw this.createProtocolDetectionError();
@@ -574,7 +584,7 @@ class WebUsbTransport {
                 return false;
             }
             return transport.probeProtocolV2({
-                call: (name, data, options) => this.callProtocolV2(path, name, data, options),
+                call: (name, data, options) => this.callProtocolV2(path, name, data, options, false),
                 timeoutMs: PROTOCOL_PROBE_TIMEOUT,
                 logger: this.Log,
                 logPrefix: 'ProtocolV2 WebUSB',
@@ -624,7 +634,7 @@ class WebUsbTransport {
             return check$1.call(jsonData);
         });
     }
-    callProtocolV2(path, name, data, options) {
+    callProtocolV2(path, name, data, options, resetOnError = true) {
         return __awaiter(this, void 0, void 0, function* () {
             const protocolV1Messages = this.messages;
             if (!this.messagesV2) {
@@ -659,7 +669,7 @@ class WebUsbTransport {
                 return yield session.call(name, data, options);
             }
             catch (error) {
-                if (transport.isProtocolV2LinkError(error) || this.isRetryablePacketIoError(error)) {
+                if (resetOnError && (transport.isProtocolV2LinkError(error) || this.isRetryablePacketIoError(error))) {
                     try {
                         yield this.resetConnectionAfterProbe(path);
                     }

package/dist/webusb.d.ts

@@ -35,6 +35,7 @@ export default class WebUsbTransport {
     getConnectedDevices(): Promise<DeviceInfo[]>;
     acquire(input: AcquireInput): Promise<string | undefined>;
     private createProtocolMismatchError;
+    private createProtocolProbeTimeoutError;
     private createProtocolDetectionError;
     private detectProtocol;
     findDevice(path: string): Promise<USBDevice>;

package/dist/webusb.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webusb.d.ts","sourceRoot":"","sources":["../src/webusb.ts"],"names":[],"mappings":";AACA,OAAO,SAaN,MAAM,wBAAwB,CAAC;AAYhC,OAAO,KAAK,EACV,YAAY,EACZ,oBAAoB,EACpB,YAAY,EACZ,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAqBhC,MAAM,WAAW,UAAW,SAAQ,oBAAoB;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,SAAS,CAAC;IAClB,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAaD,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC,QAAQ,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;IAGlE,UAAU,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;IAGpE,OAAO,CAAC,cAAc,CAAwC;IAE9D,OAAO,CAAC,mBAAmB,CAAwC;IAGnE,OAAO,CAAC,oBAAoB,CAAoD;IAGhF,OAAO,CAAC,kBAAkB,CAA6C;IAGvE,OAAO,CAAC,mBAAmB,CAAoD;IAG/E,OAAO,CAAC,eAAe,CAA2C;IAMlE,OAAO,CAAC,eAAe,CAA6C;IAEpE,OAAO,CAAC,iBAAiB,CAAK;IAE9B,IAAI,SAAqB;IAEzB,OAAO,UAAS;IAEhB,UAAU,UAAS;IAEnB,GAAG,CAAC,EAAE,GAAG,CAAC;IAEV,GAAG,CAAC,EAAE,GAAG,CAAC;IAMV,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAM;IAEnC,eAAe,SAAoB;IAEnC,UAAU,SAAe;IAEzB,WAAW,SAAgB;IAK3B,IAAI,CAAC,MAAM,EAAE,GAAG;IAgBhB,SAAS,CAAC,UAAU,EAAE,GAAG;IASzB,mBAAmB,CAAC,UAAU,EAAE,GAAG;IAU7B,kBAAkB;IAmBlB,SAAS;IAQf,OAAO,CAAC,aAAa;IAmBf,mBAAmB;IAgCnB,OAAO,CAAC,KAAK,EAAE,YAAY;IA0BjC,OAAO,CAAC,2BAA2B;IAOnC,OAAO,CAAC,4BAA4B;YAOtB,cAAc;IAiDtB,UAAU,CAAC,IAAI,EAAE,MAAM;IAwBvB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO;IAkB1C,OAAO,CAAC,iBAAiB;IAiCnB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO;YAmCpC,eAAe;YAmBf,iBAAiB;IAezB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAIvE,OAAO,CAAC,eAAe;IAUvB,OAAO,CAAC,wBAAwB;YAalB,yBAAyB;IAiCvC,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,aAAa;YASP,oBAAoB;YA2BpB,eAAe;YAaf,mBAAmB;YA2CnB,yBAAyB;YAwBzB,uBAAuB;YA0CvB,eAAe;YAaf,eAAe;IAgBvB,IAAI,CACR,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,CAAC,EAAE,oBAAoB;YA8BlB,cAAc;YAkCd,cAAc;YA0Dd,sBAAsB;IAqC9B,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;IAgD5C,OAAO,CAAC,IAAI,EAAE,MAAM;IAkB1B,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;CAGxD"}
+{"version":3,"file":"webusb.d.ts","sourceRoot":"","sources":["../src/webusb.ts"],"names":[],"mappings":";AACA,OAAO,SAaN,MAAM,wBAAwB,CAAC;AAYhC,OAAO,KAAK,EACV,YAAY,EACZ,oBAAoB,EACpB,YAAY,EACZ,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAsBhC,MAAM,WAAW,UAAW,SAAQ,oBAAoB;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,SAAS,CAAC;IAClB,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAaD,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC,QAAQ,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;IAGlE,UAAU,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;IAGpE,OAAO,CAAC,cAAc,CAAwC;IAE9D,OAAO,CAAC,mBAAmB,CAAwC;IAGnE,OAAO,CAAC,oBAAoB,CAAoD;IAGhF,OAAO,CAAC,kBAAkB,CAA6C;IAGvE,OAAO,CAAC,mBAAmB,CAAoD;IAG/E,OAAO,CAAC,eAAe,CAA2C;IAMlE,OAAO,CAAC,eAAe,CAA6C;IAEpE,OAAO,CAAC,iBAAiB,CAAK;IAE9B,IAAI,SAAqB;IAEzB,OAAO,UAAS;IAEhB,UAAU,UAAS;IAEnB,GAAG,CAAC,EAAE,GAAG,CAAC;IAEV,GAAG,CAAC,EAAE,GAAG,CAAC;IAMV,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAM;IAEnC,eAAe,SAAoB;IAEnC,UAAU,SAAe;IAEzB,WAAW,SAAgB;IAK3B,IAAI,CAAC,MAAM,EAAE,GAAG;IAgBhB,SAAS,CAAC,UAAU,EAAE,GAAG;IASzB,mBAAmB,CAAC,UAAU,EAAE,GAAG;IAU7B,kBAAkB;IAmBlB,SAAS;IAQf,OAAO,CAAC,aAAa;IAmBf,mBAAmB;IAgCnB,OAAO,CAAC,KAAK,EAAE,YAAY;IA0BjC,OAAO,CAAC,2BAA2B;IAOnC,OAAO,CAAC,+BAA+B;IAOvC,OAAO,CAAC,4BAA4B;YAOtB,cAAc;IA6DtB,UAAU,CAAC,IAAI,EAAE,MAAM;IAwBvB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO;IAkB1C,OAAO,CAAC,iBAAiB;IAiCnB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO;YAmCpC,eAAe;YAmBf,iBAAiB;IAezB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAIvE,OAAO,CAAC,eAAe;IAUvB,OAAO,CAAC,wBAAwB;YAalB,yBAAyB;IAiCvC,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,aAAa;YASP,oBAAoB;YA2BpB,eAAe;YAaf,mBAAmB;YA2CnB,yBAAyB;YAwBzB,uBAAuB;YA0CvB,eAAe;YAaf,eAAe;IAgBvB,IAAI,CACR,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,CAAC,EAAE,oBAAoB;YA8BlB,cAAc;YAkCd,cAAc;YA2Dd,sBAAsB;IAqC9B,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;IAgD5C,OAAO,CAAC,IAAI,EAAE,MAAM;IAkB1B,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;CAGxD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onekeyfe/hd-transport-web-device",
-  "version": "1.2.0-alpha.22",
+  "version": "1.2.0-alpha.23",
   "author": "OneKey",
   "homepage": "https://github.com/OneKeyHQ/hardware-js-sdk#readme",
   "license": "MIT",
@@ -20,13 +20,13 @@
     "lint:fix": "eslint . --fix"
   },
   "dependencies": {
-    "@onekeyfe/hd-shared": "1.2.0-alpha.22",
-    "@onekeyfe/hd-transport": "1.2.0-alpha.22"
+    "@onekeyfe/hd-shared": "1.2.0-alpha.23",
+    "@onekeyfe/hd-transport": "1.2.0-alpha.23"
   },
   "devDependencies": {
-    "@onekeyfe/hd-transport-electron": "1.2.0-alpha.22",
+    "@onekeyfe/hd-transport-electron": "1.2.0-alpha.23",
     "@types/w3c-web-usb": "^1.0.6",
     "@types/web-bluetooth": "^0.0.17"
   },
-  "gitHead": "ce94a5ebbe141b0c15db7c68d08085ca1ddb0166"
+  "gitHead": "7cadb40ca6414053a488756f28a9f413164b235d"
 }

package/src/webusb.ts

@@ -43,6 +43,7 @@ const HEADER_LENGTH = PROTOCOL_V1_MESSAGE_HEADER_SIZE;
 const PACKET_IO_MAX_RETRIES = 3;
 const PACKET_IO_RETRY_DELAY = 300;
 const PROTOCOL_PROBE_TIMEOUT = 1000;
+const EXPECTED_PROTOCOL_V2_PROBE_ATTEMPTS = 2;
 function inferProtocolHintFromDeviceName(name?: string | null): ProtocolType | undefined {
   return /\bpro\s*2\b/i.test(name ?? '') ? 'V2' : undefined;
 }
@@ -269,6 +270,13 @@ export default class WebUsbTransport {
     );
   }
 
+  private createProtocolProbeTimeoutError(expected: ProtocolType, attempts: number) {
+    return ERRORS.TypedError(
+      HardwareErrorCode.RuntimeError,
+      `Protocol ${expected} probe timeout after ${attempts} attempts`
+    );
+  }
+
   private createProtocolDetectionError() {
     return ERRORS.TypedError(
       HardwareErrorCode.RuntimeError,
@@ -291,11 +299,25 @@ export default class WebUsbTransport {
     }
 
     if (expectedProtocol === 'V2') {
-      if (await this.probeProtocolV2(path)) {
-        this.deviceProtocol.set(path, 'V2');
-        return 'V2';
+      for (let attempt = 1; attempt <= EXPECTED_PROTOCOL_V2_PROBE_ATTEMPTS; attempt += 1) {
+        if (await this.probeProtocolV2(path)) {
+          this.deviceProtocol.set(path, 'V2');
+          return 'V2';
+        }
+        await this.resetConnectionAfterProbe(path);
+        if (attempt < EXPECTED_PROTOCOL_V2_PROBE_ATTEMPTS) {
+          this.Log?.debug(
+            `[WebUsbTransport] Protocol V2 probe timed out, retrying ${
+              attempt + 1
+            }/${EXPECTED_PROTOCOL_V2_PROBE_ATTEMPTS}`
+          );
+        }
       }
-      throw this.createProtocolMismatchError(expectedProtocol);
+      this.deviceProtocol.delete(path);
+      throw this.createProtocolProbeTimeoutError(
+        expectedProtocol,
+        EXPECTED_PROTOCOL_V2_PROBE_ATTEMPTS
+      );
     }
 
     // Protocol must be actively probed after connection. Name, PID, and descriptors only
@@ -310,12 +332,10 @@ export default class WebUsbTransport {
         this.deviceProtocol.set(path, protocol);
         return protocol;
       }
-      if (protocol === 'V1') {
-        // A timed-out WebUSB transferIn cannot be cancelled in place. Closing and
-        // reopening the device guarantees the next protocol probe cannot consume a
-        // late V1 response. V2 timeout recovery is owned by callProtocolV2.
-        await this.resetConnectionAfterProbe(path);
-      }
+      // A timed-out WebUSB transferIn cannot be cancelled in place. Closing and
+      // reopening the device guarantees the next protocol probe cannot consume a
+      // late response from the previous protocol generation.
+      await this.resetConnectionAfterProbe(path);
     }
 
     this.deviceProtocol.delete(path);
@@ -716,7 +736,7 @@ export default class WebUsbTransport {
     }
 
     return probeProtocolV2Helper({
-      call: (name, data, options) => this.callProtocolV2(path, name, data, options),
+      call: (name, data, options) => this.callProtocolV2(path, name, data, options, false),
       timeoutMs: PROTOCOL_PROBE_TIMEOUT,
       logger: this.Log,
       logPrefix: 'ProtocolV2 WebUSB',
@@ -798,7 +818,8 @@ export default class WebUsbTransport {
     path: string,
     name: string,
     data: Record<string, unknown>,
-    options?: TransportCallOptions
+    options?: TransportCallOptions,
+    resetOnError = true
   ) {
     const protocolV1Messages = this.messages;
     if (!this.messagesV2) {
@@ -841,7 +862,7 @@ export default class WebUsbTransport {
     try {
       return await session.call(name, data, options);
     } catch (error) {
-      if (isProtocolV2LinkError(error) || this.isRetryablePacketIoError(error)) {
+      if (resetOnError && (isProtocolV2LinkError(error) || this.isRetryablePacketIoError(error))) {
         try {
           await this.resetConnectionAfterProbe(path);
         } catch (resetError) {