@onekeyfe/hd-transport-web-device 1.2.0-alpha.134 → 1.2.0-alpha.136

package/__tests__/webusb-protocol-cache.test.ts

@@ -16,12 +16,17 @@ const schema = {
   },
 };
 
-function buildAcquirableTransport() {
+function buildAcquirableTransport(path = 'pro-webusb') {
   const webusb = new WebUsbTransport() as any;
   webusb.Log = { debug: jest.fn() };
   webusb.rotateProtocolV2UsbGeneration = jest.fn().mockResolvedValue(undefined);
   webusb.closeOpenDevice = jest.fn().mockResolvedValue(undefined);
   webusb.connect = jest.fn().mockResolvedValue(undefined);
+  // Simulate a device that stayed connected since the probe: same USBDevice
+  // object present in the device list and recorded as the probed object.
+  const deviceObject = { serialNumber: path } as unknown as USBDevice;
+  webusb.deviceList = [{ path, device: deviceObject, commType: 'webusb' }];
+  webusb.probedDeviceObjects.set(path, deviceObject);
   return webusb;
 }
 
@@ -64,6 +69,25 @@ describe('WebUsbTransport protocol probe cache', () => {
     expect(webusb.detectProtocol).toHaveBeenCalledWith(path, 'V1', undefined);
   });
 
+  test('acquire re-probes when the USBDevice object identity changed since the probe', async () => {
+    const webusb = buildAcquirableTransport();
+    const path = 'pro-webusb';
+    webusb.deviceProtocol.set(path, 'V1');
+    // Simulate a replug the transport never saw a disconnect event for: the OS
+    // re-enumerated the device, so the list now holds a NEW USBDevice object.
+    webusb.deviceList = [
+      { path, device: { serialNumber: path } as unknown as USBDevice, commType: 'webusb' },
+    ];
+    webusb.detectProtocol = jest.fn().mockImplementation((p: string) => {
+      webusb.deviceProtocol.set(p, 'V1');
+      return Promise.resolve('V1');
+    });
+
+    await expect(webusb.acquire({ path, expectedProtocol: 'V1' })).resolves.toBe(path);
+
+    expect(webusb.detectProtocol).toHaveBeenCalledTimes(1);
+  });
+
   test('acquire re-probes a stale-marked path even when a protocol is cached', async () => {
     const webusb = buildAcquirableTransport();
     const path = 'pro-webusb';

package/dist/index.d.ts

@@ -27,6 +27,14 @@ declare class WebUsbTransport extends ProtocolV2UsbTransportBase<string> {
     private staleProtocolPaths;
     /** Paths currently acquired (between a successful acquire() and its release()). */
     private acquiredPaths;
+    /**
+     * The exact USBDevice object each cached protocol was probed against. The
+     * browser returns the same object identity for a device as long as it stays
+     * connected, and a replug/reboot always yields a new object — so an identity
+     * mismatch proves the device was re-enumerated since the probe, even when the
+     * disconnect event itself was delayed or missed.
+     */
+    private probedDeviceObjects;
     /** Per-path USB endpoint / interface numbers (discovered from USB descriptors) */
     private deviceEndpoints;
     name: string;

package/dist/index.js

@@ -59,7 +59,8 @@ function inferProtocolHintFromDeviceName$1(name) {
 }
 let activeWebUsbTransport;
 let usbDisconnectListenerAttached = false;
-function attachUsbDisconnectListener(usb) {
+function registerActiveWebUsbTransport(instance, usb) {
+    activeWebUsbTransport = instance;
     if (usbDisconnectListenerAttached)
         return;
     usbDisconnectListenerAttached = true;
@@ -82,6 +83,7 @@ class WebUsbTransport extends transport.ProtocolV2UsbTransportBase {
         this.deviceProtocolHints = new Map();
         this.staleProtocolPaths = new Set();
         this.acquiredPaths = new Set();
+        this.probedDeviceObjects = new Map();
         this.deviceEndpoints = new Map();
         this.name = 'WebUsbTransport';
         this.stopped = false;
@@ -98,11 +100,11 @@ class WebUsbTransport extends transport.ProtocolV2UsbTransportBase {
             throw hdShared.ERRORS.TypedError(hdShared.HardwareErrorCode.RuntimeError, 'WebUSB is not supported by current browsers');
         }
         this.usb = usb;
-        activeWebUsbTransport = this;
-        attachUsbDisconnectListener(usb);
+        registerActiveWebUsbTransport(this, usb);
     }
     markProtocolStale(path) {
         this.staleProtocolPaths.add(path);
+        this.probedDeviceObjects.delete(path);
     }
     configure(signedData) {
         const messages = parseConfigure$1(signedData);
@@ -169,7 +171,7 @@ class WebUsbTransport extends transport.ProtocolV2UsbTransportBase {
         });
     }
     acquire(input) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e, _f;
         return __awaiter(this, void 0, void 0, function* () {
             if (!input.path)
                 return;
@@ -181,19 +183,29 @@ class WebUsbTransport extends transport.ProtocolV2UsbTransportBase {
                     this.staleProtocolPaths.delete(input.path);
                     this.deviceProtocol.delete(input.path);
                 }
+                if (this.deviceProtocol.has(input.path)) {
+                    const currentDevice = (_b = this.deviceList.find(d => d.path === input.path)) === null || _b === void 0 ? void 0 : _b.device;
+                    if (!currentDevice || currentDevice !== this.probedDeviceObjects.get(input.path)) {
+                        this.deviceProtocol.delete(input.path);
+                    }
+                }
                 const cachedProtocol = this.deviceProtocol.get(input.path);
                 if (cachedProtocol && input.expectedProtocol && cachedProtocol !== input.expectedProtocol) {
                     this.deviceProtocol.delete(input.path);
                 }
                 if (!this.deviceProtocol.has(input.path)) {
-                    const deviceName = (_b = this.deviceList.find(device => device.path === input.path)) === null || _b === void 0 ? void 0 : _b.device.productName;
+                    const deviceName = (_c = this.deviceList.find(device => device.path === input.path)) === null || _c === void 0 ? void 0 : _c.device.productName;
                     const protocolHint = input.expectedProtocol
                         ? undefined
-                        : (_d = (_c = input.protocolHint) !== null && _c !== void 0 ? _c : this.deviceProtocolHints.get(input.path)) !== null && _d !== void 0 ? _d : inferProtocolHintFromDeviceName$1(deviceName);
+                        : (_e = (_d = input.protocolHint) !== null && _d !== void 0 ? _d : this.deviceProtocolHints.get(input.path)) !== null && _e !== void 0 ? _e : inferProtocolHintFromDeviceName$1(deviceName);
                     if (protocolHint) {
                         this.deviceProtocolHints.set(input.path, protocolHint);
                     }
                     yield this.detectProtocol(input.path, input.expectedProtocol, protocolHint);
+                    const probedDevice = (_f = this.deviceList.find(d => d.path === input.path)) === null || _f === void 0 ? void 0 : _f.device;
+                    if (probedDevice) {
+                        this.probedDeviceObjects.set(input.path, probedDevice);
+                    }
                 }
                 this.acquiredPaths.add(input.path);
                 return yield Promise.resolve(input.path);

package/dist/webusb.d.ts

@@ -14,6 +14,7 @@ export default class WebUsbTransport extends ProtocolV2UsbTransportBase<string>
     private deviceProtocolHints;
     private staleProtocolPaths;
     private acquiredPaths;
+    private probedDeviceObjects;
     private deviceEndpoints;
     name: string;
     stopped: boolean;

package/dist/webusb.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webusb.d.ts","sourceRoot":"","sources":["../src/webusb.ts"],"names":[],"mappings":";AACA,OAAO,SAAS,EAAE,EAQhB,0BAA0B,EAE3B,MAAM,wBAAwB,CAAC;AAUhC,OAAO,KAAK,EACV,YAAY,EACZ,oBAAoB,EACpB,YAAY,EACZ,qBAAqB,EACrB,iBAAiB,EACjB,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AA0BhC,MAAM,WAAW,UAAW,SAAQ,oBAAoB;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,SAAS,CAAC;IAClB,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAiCD,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,0BAA0B,CAAC,MAAM,CAAC;IAC7E,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;IAEpE,OAAO,CAAC,sBAAsB,CAAqB;IAGnD,OAAO,CAAC,cAAc,CAAwC;IAE9D,OAAO,CAAC,mBAAmB,CAAwC;IAMnE,OAAO,CAAC,kBAAkB,CAA0B;IAGpD,OAAO,CAAC,aAAa,CAA0B;IAG/C,OAAO,CAAC,eAAe,CAA2C;IAElE,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;;IAa3B,IAAI,CAAC,MAAM,EAAE,GAAG;IAyBhB,iBAAiB,CAAC,IAAI,EAAE,MAAM;IAO9B,SAAS,CAAC,UAAU,EAAE,GAAG;IASzB,mBAAmB,CAAC,UAAU,EAAE,GAAG;IAsB7B,kBAAkB;IAmBlB,SAAS;IAQT,mBAAmB;IAiCnB,OAAO,CAAC,KAAK,EAAE,YAAY;IA8CjC,OAAO,CAAC,2BAA2B;IAOnC,OAAO,CAAC,+BAA+B;IAOvC,OAAO,CAAC,4BAA4B;YAItB,cAAc;IAmEtB,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;YAgCpC,eAAe;YAkBf,iBAAiB;IAsB/B,OAAO,CAAC,cAAc;IAShB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IASvE,OAAO,CAAC,eAAe;IAUvB,OAAO,CAAC,wBAAwB;YAalB,yBAAyB;IAsCvC,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,aAAa;YASP,oBAAoB;YA2BpB,eAAe;YAaf,mBAAmB;YA2CnB,cAAc;YAWd,yBAAyB;YAKzB,yBAAyB;YAMzB,uBAAuB;YA0CvB,eAAe;YAoBf,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;YA2BlB,cAAc;YAkCd,cAAc;IAYtB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;IAgD5C,OAAO,CAAC,IAAI,EAAE,MAAM;IAY1B,SAAS,CAAC,uBAAuB,IAAI,iBAAiB;IAUtD,SAAS,CAAC,sBAAsB;cAIhB,wBAAwB,CACtC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,UAAU,EACjB,QAAQ,EAAE,qBAAqB,GAC9B,OAAO,CAAC,IAAI,CAAC;cAIA,uBAAuB,CACrC,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,qBAAqB,GAC9B,OAAO,CAAC,UAAU,CAAC;cASN,4BAA4B,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1F,SAAS,CAAC,8BAA8B,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAKrE,SAAS,CAAC,+BAA+B,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,KAAK;IAWjF,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,SAAS,EAAE,EAQhB,0BAA0B,EAE3B,MAAM,wBAAwB,CAAC;AAUhC,OAAO,KAAK,EACV,YAAY,EACZ,oBAAoB,EACpB,YAAY,EACZ,qBAAqB,EACrB,iBAAiB,EACjB,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AA0BhC,MAAM,WAAW,UAAW,SAAQ,oBAAoB;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,SAAS,CAAC;IAClB,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAkCD,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,0BAA0B,CAAC,MAAM,CAAC;IAC7E,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;IAEpE,OAAO,CAAC,sBAAsB,CAAqB;IAGnD,OAAO,CAAC,cAAc,CAAwC;IAE9D,OAAO,CAAC,mBAAmB,CAAwC;IAMnE,OAAO,CAAC,kBAAkB,CAA0B;IAGpD,OAAO,CAAC,aAAa,CAA0B;IAS/C,OAAO,CAAC,mBAAmB,CAAqC;IAGhE,OAAO,CAAC,eAAe,CAA2C;IAElE,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;;IAa3B,IAAI,CAAC,MAAM,EAAE,GAAG;IAwBhB,iBAAiB,CAAC,IAAI,EAAE,MAAM;IAQ9B,SAAS,CAAC,UAAU,EAAE,GAAG;IASzB,mBAAmB,CAAC,UAAU,EAAE,GAAG;IAsB7B,kBAAkB;IAmBlB,SAAS;IAQT,mBAAmB;IAiCnB,OAAO,CAAC,KAAK,EAAE,YAAY;IA2DjC,OAAO,CAAC,2BAA2B;IAOnC,OAAO,CAAC,+BAA+B;IAOvC,OAAO,CAAC,4BAA4B;YAItB,cAAc;IAmEtB,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;YAgCpC,eAAe;YAkBf,iBAAiB;IAsB/B,OAAO,CAAC,cAAc;IAMhB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IASvE,OAAO,CAAC,eAAe;IAUvB,OAAO,CAAC,wBAAwB;YAalB,yBAAyB;IAsCvC,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,aAAa;YASP,oBAAoB;YA2BpB,eAAe;YAaf,mBAAmB;YA2CnB,cAAc;YAWd,yBAAyB;YAKzB,yBAAyB;YAMzB,uBAAuB;YA0CvB,eAAe;YAoBf,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;YA2BlB,cAAc;YAkCd,cAAc;IAYtB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;IAgD5C,OAAO,CAAC,IAAI,EAAE,MAAM;IAY1B,SAAS,CAAC,uBAAuB,IAAI,iBAAiB;IAUtD,SAAS,CAAC,sBAAsB;cAIhB,wBAAwB,CACtC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,UAAU,EACjB,QAAQ,EAAE,qBAAqB,GAC9B,OAAO,CAAC,IAAI,CAAC;cAIA,uBAAuB,CACrC,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,qBAAqB,GAC9B,OAAO,CAAC,UAAU,CAAC;cASN,4BAA4B,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1F,SAAS,CAAC,8BAA8B,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAKrE,SAAS,CAAC,+BAA+B,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,KAAK;IAWjF,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.134",
+  "version": "1.2.0-alpha.136",
   "author": "OneKey",
   "homepage": "https://github.com/OneKeyHQ/hardware-js-sdk#readme",
   "license": "MIT",
@@ -21,13 +21,13 @@
     "lint:fix": "eslint . --fix"
   },
   "dependencies": {
-    "@onekeyfe/hd-shared": "1.2.0-alpha.134",
-    "@onekeyfe/hd-transport": "1.2.0-alpha.134"
+    "@onekeyfe/hd-shared": "1.2.0-alpha.136",
+    "@onekeyfe/hd-transport": "1.2.0-alpha.136"
   },
   "devDependencies": {
-    "@onekeyfe/hd-transport-electron": "1.2.0-alpha.134",
+    "@onekeyfe/hd-transport-electron": "1.2.0-alpha.136",
     "@types/w3c-web-usb": "^1.0.6",
     "@types/web-bluetooth": "^0.0.17"
   },
-  "gitHead": "47de2b0244584f6a541a84b0f94e4676bf63221a"
+  "gitHead": "92945bc4aae3d6602dd44c2e028e902e6bce7b55"
 }

package/src/webusb.ts

@@ -79,7 +79,8 @@ interface TransferCancelToken {
 let activeWebUsbTransport: WebUsbTransport | undefined;
 let usbDisconnectListenerAttached = false;
 
-function attachUsbDisconnectListener(usb: USB) {
+function registerActiveWebUsbTransport(instance: WebUsbTransport, usb: USB) {
+  activeWebUsbTransport = instance;
   if (usbDisconnectListenerAttached) return;
   usbDisconnectListenerAttached = true;
   usb.addEventListener('disconnect', event => {
@@ -111,6 +112,15 @@ export default class WebUsbTransport extends ProtocolV2UsbTransportBase<string>
   /** Paths currently acquired (between a successful acquire() and its release()). */
   private acquiredPaths: Set<string> = new Set();
 
+  /**
+   * The exact USBDevice object each cached protocol was probed against. The
+   * browser returns the same object identity for a device as long as it stays
+   * connected, and a replug/reboot always yields a new object — so an identity
+   * mismatch proves the device was re-enumerated since the probe, even when the
+   * disconnect event itself was delayed or missed.
+   */
+  private probedDeviceObjects: Map<string, USBDevice> = new Map();
+
   /** Per-path USB endpoint / interface numbers (discovered from USB descriptors) */
   private deviceEndpoints: Map<string, DeviceEndpoints> = new Map();
 
@@ -158,8 +168,7 @@ export default class WebUsbTransport extends ProtocolV2UsbTransportBase<string>
       );
     }
     this.usb = usb;
-    activeWebUsbTransport = this;
-    attachUsbDisconnectListener(usb);
+    registerActiveWebUsbTransport(this, usb);
   }
 
   /**
@@ -174,6 +183,7 @@ export default class WebUsbTransport extends ProtocolV2UsbTransportBase<string>
    */
   markProtocolStale(path: string) {
     this.staleProtocolPaths.add(path);
+    this.probedDeviceObjects.delete(path);
   }
 
   /**
@@ -282,6 +292,15 @@ export default class WebUsbTransport extends ProtocolV2UsbTransportBase<string>
         this.staleProtocolPaths.delete(input.path);
         this.deviceProtocol.delete(input.path);
       }
+      if (this.deviceProtocol.has(input.path)) {
+        const currentDevice = this.deviceList.find(d => d.path === input.path)?.device;
+        if (!currentDevice || currentDevice !== this.probedDeviceObjects.get(input.path)) {
+          // The OS re-enumerated the device since the probe (a replug/reboot we
+          // may not have seen a disconnect event for) — the cached protocol can
+          // no longer be trusted; re-probe on the wire below.
+          this.deviceProtocol.delete(input.path);
+        }
+      }
       const cachedProtocol = this.deviceProtocol.get(input.path);
       if (cachedProtocol && input.expectedProtocol && cachedProtocol !== input.expectedProtocol) {
         // The caller expects a different protocol than the cached probe result;
@@ -300,6 +319,10 @@ export default class WebUsbTransport extends ProtocolV2UsbTransportBase<string>
           this.deviceProtocolHints.set(input.path, protocolHint);
         }
         await this.detectProtocol(input.path, input.expectedProtocol, protocolHint);
+        const probedDevice = this.deviceList.find(d => d.path === input.path)?.device;
+        if (probedDevice) {
+          this.probedDeviceObjects.set(input.path, probedDevice);
+        }
       }
       this.acquiredPaths.add(input.path);
       return await Promise.resolve(input.path);
@@ -550,10 +573,7 @@ export default class WebUsbTransport extends ProtocolV2UsbTransportBase<string>
    */
   private assertAcquired(path: string) {
     if (!this.acquiredPaths.has(path)) {
-      throw ERRORS.TypedError(
-        HardwareErrorCode.RuntimeError,
-        `Device is not acquired for ${path}`
-      );
+      throw ERRORS.TypedError(HardwareErrorCode.RuntimeError, `Device is not acquired for ${path}`);
     }
   }