@onekeyfe/hd-transport-lowlevel 1.2.0-alpha.33 → 1.2.0-alpha.35

package/__tests__/protocol-v2.test.js

@@ -122,6 +122,29 @@ const splitFrame = (frame, index) => [
 ];
 
 describe('LowlevelTransport protocol framing', () => {
+  test('falls back to Protocol V2 when a cached V1 hint is stale', async () => {
+    const plugin = createPlugin({ devices: [], responses: [] });
+    const lowlevel = configureTransport(plugin);
+    const events = [];
+    lowlevel.probeProtocolV1 = jest.fn().mockImplementation(() => {
+      events.push('probe-v1');
+      return Promise.resolve(false);
+    });
+    lowlevel.resetConnectionAfterProbe = jest.fn().mockImplementation(() => {
+      events.push('reset');
+      return Promise.resolve();
+    });
+    lowlevel.probeProtocolV2 = jest.fn().mockImplementation(() => {
+      events.push('probe-v2');
+      return Promise.resolve(true);
+    });
+
+    await expect(lowlevel.detectProtocol('pro-lowlevel', undefined, 'V1')).resolves.toBe('V2');
+
+    expect(events).toEqual(['probe-v1', 'reset', 'probe-v2']);
+    expect(lowlevel.getProtocolType('pro-lowlevel')).toBe('V2');
+  });
+
   test('keeps active links when the Protocol V2 schema is configured repeatedly', () => {
     const lowlevel = new LowlevelTransport();
     const invalidateAllLinks = jest.fn().mockResolvedValue(undefined);

package/dist/index.d.ts

@@ -5,6 +5,7 @@ import EventEmitter from 'events';
 type LowLevelAcquireInput = {
     uuid: string;
     expectedProtocol?: ProtocolType;
+    protocolHint?: ProtocolType;
 };
 
 declare function shouldLogFirmwareUploadProgress({ percent, lastLoggedPercent, now, lastLoggedAt, }: {

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,OAAO,SAYN,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,YAAY,MAAM,QAAQ,CAAC;AACvC,OAAO,KAAK,EACV,cAAc,EACd,6BAA6B,EAE7B,YAAY,EACZ,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAUpD,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,OAAO,CAAC,6BAA6B,CAAqB;IAE1D,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;IAiBnC,MAAM;IAIA,SAAS;IAWT,OAAO,CAAC,KAAK,EAAE,oBAAoB;;;;IAgCnC,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;IA6E5B,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;YAgBpB,cAAc;IAwB5B,OAAO,CAAC,uBAAuB;IAgC/B,OAAO,CAAC,2BAA2B;IAMnC,MAAM;CAGP"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,OAAO,SAYN,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,YAAY,MAAM,QAAQ,CAAC;AACvC,OAAO,KAAK,EACV,cAAc,EACd,6BAA6B,EAC7B,YAAY,EAEZ,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAUpD,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,OAAO,CAAC,6BAA6B,CAAqB;IAE1D,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;IAiBnC,MAAM;IAIA,SAAS;IAWT,OAAO,CAAC,KAAK,EAAE,oBAAoB;;;;IAgCnC,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;IA6E5B,OAAO,CAAC,0BAA0B;IAOlC,OAAO,CAAC,2BAA2B;IAOnC,OAAO,CAAC,4BAA4B;IAOpC,OAAO,CAAC,kBAAkB;YAMZ,cAAc;YA2Cd,yBAAyB;YAiCzB,eAAe;YAgBf,eAAe;YA6Bf,UAAU;YAUV,qBAAqB;YAmBrB,mBAAmB;YAqBnB,oBAAoB;YAgBpB,cAAc;IAwB5B,OAAO,CAAC,uBAAuB;IAgC/B,OAAO,CAAC,2BAA2B;IAMnC,MAAM;CAGP"}

package/dist/index.js

@@ -145,7 +145,7 @@ class LowlevelTransport {
         });
     }
     acquire(input) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const alreadyConnected = this.connectedDevices.has(input.uuid);
             try {
@@ -163,7 +163,7 @@ class LowlevelTransport {
             this.protocolV2Assemblers.set(input.uuid, new transport.ProtocolV2FrameAssembler(transport.PROTOCOL_V2_BLE_FRAME_MAX_BYTES));
             const protocolHint = input.expectedProtocol
                 ? undefined
-                : this.deviceProtocolHints.get(input.uuid);
+                : (_b = input.protocolHint) !== null && _b !== void 0 ? _b : this.deviceProtocolHints.get(input.uuid);
             const protocolType = yield this.detectProtocol(input.uuid, input.expectedProtocol, protocolHint);
             return { uuid: input.uuid, protocolType };
         });
@@ -283,7 +283,7 @@ class LowlevelTransport {
         }
     }
     detectProtocol(uuid, expectedProtocol, protocolHint) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
             if (expectedProtocol === 'V2') {
                 if (yield this.probeProtocolV2(uuid)) {
@@ -301,28 +301,17 @@ class LowlevelTransport {
                 }
                 throw this.createProtocolMismatchError(expectedProtocol);
             }
-            if (protocolHint === 'V2' && (yield this.probeProtocolV2(uuid))) {
-                this.deviceProtocol.set(uuid, 'V2');
-                (_c = this.Log) === null || _c === void 0 ? void 0 : _c.debug(`[LowlevelTransport] detectProtocol: uuid=${uuid} -> V2 (hint)`);
-                return 'V2';
-            }
-            const cachedProtocol = this.deviceProtocol.get(uuid);
-            if (cachedProtocol === 'V2' && (yield this.probeProtocolV2(uuid))) {
-                this.deviceProtocol.set(uuid, 'V2');
-                (_d = this.Log) === null || _d === void 0 ? void 0 : _d.debug(`[LowlevelTransport] detectProtocol: uuid=${uuid} -> V2 (cached)`);
-                return 'V2';
-            }
-            const protocolV1Detected = yield this.probeProtocolV1(uuid);
-            if (protocolV1Detected) {
-                this.deviceProtocol.set(uuid, 'V1');
-                (_e = this.Log) === null || _e === void 0 ? void 0 : _e.debug(`[LowlevelTransport] detectProtocol: uuid=${uuid} -> V1`);
-                return 'V1';
-            }
-            yield this.resetConnectionAfterProbe(uuid, 'V1');
-            if (yield this.probeProtocolV2(uuid)) {
-                this.deviceProtocol.set(uuid, 'V2');
-                (_f = this.Log) === null || _f === void 0 ? void 0 : _f.debug(`[LowlevelTransport] detectProtocol: uuid=${uuid} -> V2`);
-                return 'V2';
+            const probeOrder = protocolHint === 'V2' || this.deviceProtocol.get(uuid) === 'V2' ? ['V2', 'V1'] : ['V1', 'V2'];
+            for (const [index, protocol] of probeOrder.entries()) {
+                if (index > 0) {
+                    yield this.resetConnectionAfterProbe(uuid, probeOrder[index - 1]);
+                }
+                const detected = protocol === 'V1' ? yield this.probeProtocolV1(uuid) : yield this.probeProtocolV2(uuid);
+                if (detected) {
+                    this.deviceProtocol.set(uuid, protocol);
+                    (_c = this.Log) === null || _c === void 0 ? void 0 : _c.debug(`[LowlevelTransport] detectProtocol: uuid=${uuid} -> ${protocol}`);
+                    return protocol;
+                }
             }
             this.deviceProtocol.delete(uuid);
             throw this.createProtocolDetectionError();

package/dist/types.d.ts

@@ -2,5 +2,6 @@ import type { ProtocolType } from '@onekeyfe/hd-transport';
 export type LowLevelAcquireInput = {
     uuid: string;
     expectedProtocol?: ProtocolType;
+    protocolHint?: ProtocolType;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE3D,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,CAAC,EAAE,YAAY,CAAC;CACjC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE3D,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onekeyfe/hd-transport-lowlevel",
-  "version": "1.2.0-alpha.33",
+  "version": "1.2.0-alpha.35",
   "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.33",
-    "@onekeyfe/hd-transport": "1.2.0-alpha.33"
+    "@onekeyfe/hd-shared": "1.2.0-alpha.35",
+    "@onekeyfe/hd-transport": "1.2.0-alpha.35"
   },
-  "gitHead": "965e837c93fc67225ccfac28d22c3403ff96ad25"
+  "gitHead": "638bd33030686c4a3321e4feb4924c3f9f5c81a8"
 }

package/src/index.ts

@@ -17,8 +17,8 @@ import type EventEmitter from 'events';
 import type {
   LowLevelDevice,
   LowlevelTransportSharedPlugin,
-  ProtocolV2CallContext,
   ProtocolType,
+  ProtocolV2CallContext,
   TransportCallOptions,
 } from '@onekeyfe/hd-transport';
 import type { LowLevelAcquireInput } from './types';
@@ -193,7 +193,7 @@ export default class LowlevelTransport {
     );
     const protocolHint = input.expectedProtocol
       ? undefined
-      : this.deviceProtocolHints.get(input.uuid);
+      : input.protocolHint ?? this.deviceProtocolHints.get(input.uuid);
     const protocolType = await this.detectProtocol(
       input.uuid,
       input.expectedProtocol,
@@ -371,31 +371,20 @@ export default class LowlevelTransport {
       throw this.createProtocolMismatchError(expectedProtocol);
     }
 
-    if (protocolHint === 'V2' && (await this.probeProtocolV2(uuid))) {
-      this.deviceProtocol.set(uuid, 'V2');
-      this.Log?.debug(`[LowlevelTransport] detectProtocol: uuid=${uuid} -> V2 (hint)`);
-      return 'V2';
-    }
-
-    const cachedProtocol = this.deviceProtocol.get(uuid);
-    if (cachedProtocol === 'V2' && (await this.probeProtocolV2(uuid))) {
-      this.deviceProtocol.set(uuid, 'V2');
-      this.Log?.debug(`[LowlevelTransport] detectProtocol: uuid=${uuid} -> V2 (cached)`);
-      return 'V2';
-    }
-
-    const protocolV1Detected = await this.probeProtocolV1(uuid);
-    if (protocolV1Detected) {
-      this.deviceProtocol.set(uuid, 'V1');
-      this.Log?.debug(`[LowlevelTransport] detectProtocol: uuid=${uuid} -> V1`);
-      return 'V1';
-    }
+    const probeOrder: ProtocolType[] =
+      protocolHint === 'V2' || this.deviceProtocol.get(uuid) === 'V2' ? ['V2', 'V1'] : ['V1', 'V2'];
 
-    await this.resetConnectionAfterProbe(uuid, 'V1');
-    if (await this.probeProtocolV2(uuid)) {
-      this.deviceProtocol.set(uuid, 'V2');
-      this.Log?.debug(`[LowlevelTransport] detectProtocol: uuid=${uuid} -> V2`);
-      return 'V2';
+    for (const [index, protocol] of probeOrder.entries()) {
+      if (index > 0) {
+        await this.resetConnectionAfterProbe(uuid, probeOrder[index - 1]);
+      }
+      const detected =
+        protocol === 'V1' ? await this.probeProtocolV1(uuid) : await this.probeProtocolV2(uuid);
+      if (detected) {
+        this.deviceProtocol.set(uuid, protocol);
+        this.Log?.debug(`[LowlevelTransport] detectProtocol: uuid=${uuid} -> ${protocol}`);
+        return protocol;
+      }
     }
 
     this.deviceProtocol.delete(uuid);

package/src/types.ts

@@ -3,4 +3,5 @@ import type { ProtocolType } from '@onekeyfe/hd-transport';
 export type LowLevelAcquireInput = {
   uuid: string;
   expectedProtocol?: ProtocolType;
+  protocolHint?: ProtocolType;
 };