@onekeyfe/hd-transport 1.2.0-alpha.24 → 1.2.0-alpha.25

package/__tests__/protocol-v2-link-manager.test.js

@@ -341,4 +341,49 @@ describe('ProtocolV2LinkManager', () => {
     await expect(call).rejects.toThrow('device disconnected');
     expect(adapter.readFrame).not.toHaveBeenCalled();
   });
+
+  test('rejects calls queued before their link generation is invalidated', async () => {
+    let releaseWrite;
+    let markWriteStarted;
+    const writeStarted = new Promise(resolve => {
+      markWriteStarted = resolve;
+    });
+    const writeBlocked = new Promise(resolve => {
+      releaseWrite = resolve;
+    });
+    const success = ProtocolV2.encodeFrame(
+      schemas,
+      'Success',
+      { message: 'ok' },
+      { router: 1, packetSrc: 0, seq: 1 }
+    );
+    const adapter = {
+      router: 1,
+      generation: 1,
+      prepareCall: jest.fn(),
+      writeFrame: jest.fn(async () => {
+        markWriteStarted();
+        await writeBlocked;
+      }),
+      readFrame: jest.fn(() => Promise.resolve(success)),
+      reset: jest.fn(),
+    };
+    const createAdapter = jest.fn(() => adapter);
+    const manager = new ProtocolV2LinkManager({
+      getSchemas: () => schemas,
+      classifyError: () => 'recoverable',
+    });
+
+    const activeCall = manager.call('device-a', createAdapter, 'Ping', { message: 'active' });
+    await writeStarted;
+    const queuedCall = manager.call('device-a', createAdapter, 'Ping', { message: 'queued' });
+    await manager.invalidateLink('device-a', 'device released');
+    releaseWrite();
+
+    await expect(activeCall).rejects.toThrow('device released');
+    await expect(queuedCall).rejects.toThrow('device released');
+    expect(createAdapter).toHaveBeenCalledTimes(1);
+    expect(adapter.writeFrame).toHaveBeenCalledTimes(1);
+    expect(adapter.readFrame).not.toHaveBeenCalled();
+  });
 });

package/__tests__/protocol-v2-usb-transport-base.test.js

@@ -65,6 +65,7 @@ class FakeUsbTransport extends ProtocolV2UsbTransportBase {
     this.nextReadError = undefined;
     this.writeBlock = undefined;
     this.readBlock = undefined;
+    this.coalesceNextResponses = false;
   }
 
   callDevice(key, message, timeoutMs) {
@@ -118,6 +119,10 @@ class FakeUsbTransport extends ProtocolV2UsbTransportBase {
     return { started, release };
   }
 
+  coalesceNextTwoResponses() {
+    this.coalesceNextResponses = true;
+  }
+
   getProtocolV2UsbSchemas() {
     return schemas;
   }
@@ -135,8 +140,22 @@ class FakeUsbTransport extends ProtocolV2UsbTransportBase {
       { message: 'ok' },
       { router: PROTOCOL_V2_CHANNEL_USB, seq }
     );
-    const splitAt = Math.min(4, response.length);
-    this.packetQueues.set(key, [response.slice(0, splitAt), response.slice(splitAt)]);
+    if (this.coalesceNextResponses) {
+      this.coalesceNextResponses = false;
+      const nextResponse = ProtocolV2.encodeFrame(
+        schemas,
+        'Success',
+        { message: 'ok' },
+        { router: PROTOCOL_V2_CHANNEL_USB, seq: Number(seq) + 1 }
+      );
+      const packet = new Uint8Array(response.length + nextResponse.length);
+      packet.set(response);
+      packet.set(nextResponse, response.length);
+      this.packetQueues.set(key, [packet]);
+    } else {
+      const splitAt = Math.min(4, response.length);
+      this.packetQueues.set(key, [response.slice(0, splitAt), response.slice(splitAt)]);
+    }
 
     const block = this.writeBlock;
     if (block) {
@@ -215,6 +234,21 @@ describe('ProtocolV2UsbTransportBase', () => {
     ]);
   });
 
+  test('keeps a coalesced response buffered for the next call', async () => {
+    const transport = new FakeUsbTransport();
+    await transport.rotate('device-a');
+    transport.coalesceNextTwoResponses();
+
+    await transport.callDevice('device-a', 'first');
+    await transport.callDevice('device-a', 'second');
+
+    expect(transport.readCounts.get('device-a')).toBe(1);
+    expect(transport.sentSeqs).toEqual([
+      ['device-a', 1],
+      ['device-a', 2],
+    ]);
+  });
+
   test('does not block a different USB path', async () => {
     const transport = new FakeUsbTransport();
     await transport.rotate('device-a');

package/dist/index.d.ts

@@ -131,7 +131,7 @@ declare function isAckFrame(data: Uint8Array): boolean;
  */
 declare function decodeFrame(data: Uint8Array): ProtoV2Frame;
 
-type ProtocolV2LinkErrorCode = 'response-timeout' | 'router' | 'packet-source' | 'ack-sequence' | 'response-sequence' | 'frame';
+type ProtocolV2LinkErrorCode = 'response-timeout' | 'io' | 'generation' | 'router' | 'packet-source' | 'ack-sequence' | 'response-sequence' | 'frame';
 declare class ProtocolV2LinkError extends Error {
     readonly code: ProtocolV2LinkErrorCode;
     readonly cause?: unknown;
@@ -6668,6 +6668,8 @@ declare class ProtocolV2LinkManager<Key> {
     private readonly links;
     private readonly sequences;
     private readonly callQueues;
+    private readonly generations;
+    private readonly invalidationReasons;
     private readonly options;
     constructor(options: ProtocolV2LinkManagerOptions<Key>);
     call(key: Key, createAdapter: () => ProtocolV2LinkAdapter, name: string, data: Record<string, unknown>, options?: TransportCallOptions): Promise<MessageFromOneKey>;
@@ -6677,6 +6679,7 @@ declare class ProtocolV2LinkManager<Key> {
     private getOrCreateLink;
     private executeCall;
     private clearSettledCallQueue;
+    private assertCallGeneration;
 }
 
 type ProtocolV2UsbTransportBaseOptions = {
@@ -6706,6 +6709,7 @@ declare abstract class ProtocolV2UsbTransportBase<Key> {
     private createProtocolV2UsbAdapter;
     private getProtocolV2UsbAssembler;
     private createProtocolV2UsbCancellation;
+    private createProtocolV2UsbIoError;
 }
 
 declare function info(res: any): {

package/dist/index.js

@@ -1055,12 +1055,18 @@ class ProtocolV2LinkManager {
         this.links = new Map();
         this.sequences = new Map();
         this.callQueues = new Map();
+        this.generations = new Map();
+        this.invalidationReasons = new Map();
         this.options = options;
     }
     call(key, createAdapter, name, data, options) {
-        var _a;
-        const run = () => this.executeCall(key, createAdapter, name, data, options);
-        const previous = (_a = this.callQueues.get(key)) !== null && _a !== void 0 ? _a : Promise.resolve();
+        var _a, _b;
+        const generation = (_a = this.generations.get(key)) !== null && _a !== void 0 ? _a : 0;
+        const run = () => {
+            this.assertCallGeneration(key, generation);
+            return this.executeCall(key, createAdapter, name, data, options);
+        };
+        const previous = (_b = this.callQueues.get(key)) !== null && _b !== void 0 ? _b : Promise.resolve();
         const result = previous.then(run, run);
         const queue = result.catch(() => undefined);
         this.callQueues.set(key, queue);
@@ -1070,20 +1076,24 @@ class ProtocolV2LinkManager {
         return result;
     }
     invalidateLink(key, reason) {
-        var _a, _b;
+        var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
+            const generation = ((_a = this.generations.get(key)) !== null && _a !== void 0 ? _a : 0) + 1;
+            this.generations.set(key, generation);
+            this.invalidationReasons.set(key, { generation, reason });
             const link = this.links.get(key);
             if (!link)
                 return;
             this.links.delete(key);
             link.state.invalidatedReason = reason;
             yield link.adapter.reset(reason);
-            yield ((_b = (_a = this.options).onLinkInvalidated) === null || _b === void 0 ? void 0 : _b.call(_a, key, reason));
+            yield ((_c = (_b = this.options).onLinkInvalidated) === null || _c === void 0 ? void 0 : _c.call(_b, key, reason));
         });
     }
     invalidateAllLinks(reason) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield Promise.all(Array.from(this.links.keys(), key => this.invalidateLink(key, reason)));
+            const keys = new Set([...this.links.keys(), ...this.callQueues.keys()]);
+            yield Promise.all(Array.from(keys, key => this.invalidateLink(key, reason)));
         });
     }
     dispose(reason) {
@@ -1158,6 +1168,17 @@ class ProtocolV2LinkManager {
             this.callQueues.delete(key);
         }
     }
+    assertCallGeneration(key, generation) {
+        var _a;
+        const currentGeneration = (_a = this.generations.get(key)) !== null && _a !== void 0 ? _a : 0;
+        if (currentGeneration === generation)
+            return;
+        const invalidation = this.invalidationReasons.get(key);
+        const reason = (invalidation === null || invalidation === void 0 ? void 0 : invalidation.generation) === currentGeneration
+            ? invalidation.reason
+            : 'Protocol V2 link generation changed';
+        throw new ProtocolV2LinkError('generation', reason);
+    }
 }
 
 class ProtocolV2UsbTransportBase {
@@ -1168,7 +1189,7 @@ class ProtocolV2UsbTransportBase {
         this.protocolV2UsbOptions = options;
         this.protocolV2UsbLinks = new ProtocolV2LinkManager({
             getSchemas: () => this.getProtocolV2UsbSchemas(),
-            classifyError: () => 'link-fatal',
+            classifyError: error => (isProtocolV2LinkError(error) ? 'link-fatal' : 'recoverable'),
             onLinkInvalidated: (key, reason) => __awaiter(this, void 0, void 0, function* () {
                 var _a;
                 (_a = this.protocolV2UsbAssemblers.get(key)) === null || _a === void 0 ? void 0 : _a.reset();
@@ -1218,10 +1239,10 @@ class ProtocolV2UsbTransportBase {
         }
         const assertCurrentGeneration = () => {
             if (cancellation.reason) {
-                throw new Error(cancellation.reason);
+                throw new ProtocolV2LinkError('generation', cancellation.reason);
             }
             if (this.protocolV2UsbGenerations.get(key) !== generation) {
-                throw new Error('Protocol V2 USB connection generation changed');
+                throw new ProtocolV2LinkError('generation', 'Protocol V2 USB connection generation changed');
             }
         };
         return {
@@ -1230,11 +1251,15 @@ class ProtocolV2UsbTransportBase {
             generation,
             prepareCall: () => {
                 assertCurrentGeneration();
-                this.getProtocolV2UsbAssembler(key).reset();
             },
             writeFrame: (frame, context) => __awaiter(this, void 0, void 0, function* () {
                 assertCurrentGeneration();
-                yield this.writeProtocolV2UsbPacket(key, frame, context);
+                try {
+                    yield this.writeProtocolV2UsbPacket(key, frame, context);
+                }
+                catch (error) {
+                    throw this.createProtocolV2UsbIoError('write', error);
+                }
                 assertCurrentGeneration();
             }),
             readFrame: (context) => __awaiter(this, void 0, void 0, function* () {
@@ -1242,13 +1267,15 @@ class ProtocolV2UsbTransportBase {
                 const assembler = this.getProtocolV2UsbAssembler(key);
                 let frame = assembler.push(new Uint8Array(0));
                 while (!frame) {
-                    const packetRead = this.readProtocolV2UsbPacket(key, context).then(packet => ({
-                        packet,
-                    }));
+                    const packetRead = this.readProtocolV2UsbPacket(key, context)
+                        .then(packet => ({ packet }))
+                        .catch(error => {
+                        throw this.createProtocolV2UsbIoError('read', error);
+                    });
                     const cancelled = cancellation.promise.then(reason => ({ reason }));
                     const result = yield Promise.race([packetRead, cancelled]);
                     if ('reason' in result) {
-                        throw new Error(result.reason);
+                        throw new ProtocolV2LinkError('generation', result.reason);
                     }
                     assertCurrentGeneration();
                     frame = assembler.push(result.packet);
@@ -1289,6 +1316,11 @@ class ProtocolV2UsbTransportBase {
         };
         return cancellation;
     }
+    createProtocolV2UsbIoError(operation, error) {
+        if (isProtocolV2LinkError(error))
+            return error;
+        return new ProtocolV2LinkError('io', `Protocol V2 USB ${operation} failed: ${getErrorMessage(error) || 'unknown error'}`, error);
+    }
 }
 
 const TRANSPORT_EVENT = {

package/dist/protocols/v2/errors.d.ts

@@ -1,4 +1,4 @@
-export type ProtocolV2LinkErrorCode = 'response-timeout' | 'router' | 'packet-source' | 'ack-sequence' | 'response-sequence' | 'frame';
+export type ProtocolV2LinkErrorCode = 'response-timeout' | 'io' | 'generation' | 'router' | 'packet-source' | 'ack-sequence' | 'response-sequence' | 'frame';
 export declare class ProtocolV2LinkError extends Error {
     readonly code: ProtocolV2LinkErrorCode;
     readonly cause?: unknown;

package/dist/protocols/v2/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/protocols/v2/errors.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,uBAAuB,GAC/B,kBAAkB,GAClB,QAAQ,GACR,eAAe,GACf,cAAc,GACd,mBAAmB,GACnB,OAAO,CAAC;AAEZ,qBAAa,mBAAoB,SAAQ,KAAK;IAC5C,QAAQ,CAAC,IAAI,EAAE,uBAAuB,CAAC;IAEvC,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;gBAEb,IAAI,EAAE,uBAAuB,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO;CAM5E;AAED,eAAO,MAAM,qBAAqB,UAAW,OAAO,iCACd,CAAC"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/protocols/v2/errors.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,uBAAuB,GAC/B,kBAAkB,GAClB,IAAI,GACJ,YAAY,GACZ,QAAQ,GACR,eAAe,GACf,cAAc,GACd,mBAAmB,GACnB,OAAO,CAAC;AAEZ,qBAAa,mBAAoB,SAAQ,KAAK;IAC5C,QAAQ,CAAC,IAAI,EAAE,uBAAuB,CAAC;IAEvC,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;gBAEb,IAAI,EAAE,uBAAuB,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO;CAM5E;AAED,eAAO,MAAM,qBAAqB,UAAW,OAAO,iCACd,CAAC"}

package/dist/protocols/v2/link-manager.d.ts

@@ -22,6 +22,8 @@ export declare class ProtocolV2LinkManager<Key> {
     private readonly links;
     private readonly sequences;
     private readonly callQueues;
+    private readonly generations;
+    private readonly invalidationReasons;
     private readonly options;
     constructor(options: ProtocolV2LinkManagerOptions<Key>);
     call(key: Key, createAdapter: () => ProtocolV2LinkAdapter, name: string, data: Record<string, unknown>, options?: TransportCallOptions): Promise<MessageFromOneKey>;
@@ -31,5 +33,6 @@ export declare class ProtocolV2LinkManager<Key> {
     private getOrCreateLink;
     private executeCall;
     private clearSettledCallQueue;
+    private assertCallGeneration;
 }
 //# sourceMappingURL=link-manager.d.ts.map

package/dist/protocols/v2/link-manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"link-manager.d.ts","sourceRoot":"","sources":["../../../src/protocols/v2/link-manager.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAC3E,OAAO,KAAK,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAC;AAEpG,MAAM,MAAM,iCAAiC,GAAG,YAAY,GAAG,aAAa,CAAC;AAE7E,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAClE,UAAU,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7E,SAAS,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/D,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC5C,MAAM,CAAC,EAAE,wBAAwB,CAAC,QAAQ,CAAC,CAAC;IAC5C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kBAAkB,CAAC,EAAE,wBAAwB,CAAC,oBAAoB,CAAC,CAAC;CACrE;AAED,MAAM,MAAM,4BAA4B,CAAC,GAAG,IAAI;IAC9C,UAAU,EAAE,MAAM,iBAAiB,CAAC;IACpC,aAAa,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,iCAAiC,CAAC;IACrE,iBAAiB,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CACxE,CAAC;AAUF,qBAAa,qBAAqB,CAAC,GAAG;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAkC;IAExD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA4C;IAEtE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAoC;IAE/D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoC;gBAEhD,OAAO,EAAE,4BAA4B,CAAC,GAAG,CAAC;IAItD,IAAI,CACF,GAAG,EAAE,GAAG,EACR,aAAa,EAAE,MAAM,qBAAqB,EAC1C,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IAevB,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUvD,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjD,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM5C,OAAO,CAAC,eAAe;YA+CT,WAAW;IAkBzB,OAAO,CAAC,qBAAqB;CAK9B"}
+{"version":3,"file":"link-manager.d.ts","sourceRoot":"","sources":["../../../src/protocols/v2/link-manager.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAC3E,OAAO,KAAK,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAC;AAEpG,MAAM,MAAM,iCAAiC,GAAG,YAAY,GAAG,aAAa,CAAC;AAE7E,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAClE,UAAU,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7E,SAAS,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/D,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC5C,MAAM,CAAC,EAAE,wBAAwB,CAAC,QAAQ,CAAC,CAAC;IAC5C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kBAAkB,CAAC,EAAE,wBAAwB,CAAC,oBAAoB,CAAC,CAAC;CACrE;AAED,MAAM,MAAM,4BAA4B,CAAC,GAAG,IAAI;IAC9C,UAAU,EAAE,MAAM,iBAAiB,CAAC;IACpC,aAAa,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,iCAAiC,CAAC;IACrE,iBAAiB,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CACxE,CAAC;AAUF,qBAAa,qBAAqB,CAAC,GAAG;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAkC;IAExD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA4C;IAEtE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAoC;IAE/D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA0B;IAEtD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAA0D;IAE9F,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoC;gBAEhD,OAAO,EAAE,4BAA4B,CAAC,GAAG,CAAC;IAItD,IAAI,CACF,GAAG,EAAE,GAAG,EACR,aAAa,EAAE,MAAM,qBAAqB,EAC1C,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IAmBvB,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAcvD,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKjD,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM5C,OAAO,CAAC,eAAe;YA+CT,WAAW;IAkBzB,OAAO,CAAC,qBAAqB;IAM7B,OAAO,CAAC,oBAAoB;CAW7B"}

package/dist/protocols/v2/usb-transport-base.d.ts

@@ -27,5 +27,6 @@ export declare abstract class ProtocolV2UsbTransportBase<Key> {
     private createProtocolV2UsbAdapter;
     private getProtocolV2UsbAssembler;
     private createProtocolV2UsbCancellation;
+    private createProtocolV2UsbIoError;
 }
 //# sourceMappingURL=usb-transport-base.d.ts.map

package/dist/protocols/v2/usb-transport-base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"usb-transport-base.d.ts","sourceRoot":"","sources":["../../../src/protocols/v2/usb-transport-base.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAC3E,OAAO,KAAK,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAC;AAEpG,MAAM,MAAM,iCAAiC,GAAG;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AASF,8BAAsB,0BAA0B,CAAC,GAAG;IAClD,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAA6B;IAEhE,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAA4C;IAEpF,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAA0B;IAEnE,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CAA6C;IAExF,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAoC;IAEzE,SAAS,aAAa,OAAO,EAAE,iCAAiC;IAahE,SAAS,CAAC,QAAQ,CAAC,uBAAuB,IAAI,iBAAiB;IAE/D,SAAS,CAAC,QAAQ,CAAC,sBAAsB,IAAI,wBAAwB,CAAC,QAAQ,CAAC;IAE/E,SAAS,CAAC,QAAQ,CAAC,wBAAwB,CACzC,GAAG,EAAE,GAAG,EACR,KAAK,EAAE,UAAU,EACjB,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,IAAI,CAAC;IAEhB,SAAS,CAAC,QAAQ,CAAC,uBAAuB,CACxC,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,UAAU,CAAC;IAEtB,SAAS,CAAC,QAAQ,CAAC,4BAA4B,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAExF,SAAS,CAAC,QAAQ,CAAC,+BAA+B,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,KAAK;IAE1F,SAAS,CAAC,8BAA8B,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;cAI1E,6BAA6B,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAYxF,SAAS,CAAC,iBAAiB,CACzB,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IAU7B,SAAS,CAAC,2BAA2B,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9E,SAAS,CAAC,+BAA+B,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;cAIxD,yBAAyB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOxE,OAAO,CAAC,0BAA0B;IA8DlC,OAAO,CAAC,yBAAyB;IAQjC,OAAO,CAAC,+BAA+B;CAexC"}
+{"version":3,"file":"usb-transport-base.d.ts","sourceRoot":"","sources":["../../../src/protocols/v2/usb-transport-base.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAC3E,OAAO,KAAK,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAC;AAEpG,MAAM,MAAM,iCAAiC,GAAG;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AASF,8BAAsB,0BAA0B,CAAC,GAAG;IAClD,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAA6B;IAEhE,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAA4C;IAEpF,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAA0B;IAEnE,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CAA6C;IAExF,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAoC;IAEzE,SAAS,aAAa,OAAO,EAAE,iCAAiC;IAahE,SAAS,CAAC,QAAQ,CAAC,uBAAuB,IAAI,iBAAiB;IAE/D,SAAS,CAAC,QAAQ,CAAC,sBAAsB,IAAI,wBAAwB,CAAC,QAAQ,CAAC;IAE/E,SAAS,CAAC,QAAQ,CAAC,wBAAwB,CACzC,GAAG,EAAE,GAAG,EACR,KAAK,EAAE,UAAU,EACjB,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,IAAI,CAAC;IAEhB,SAAS,CAAC,QAAQ,CAAC,uBAAuB,CACxC,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,UAAU,CAAC;IAEtB,SAAS,CAAC,QAAQ,CAAC,4BAA4B,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAExF,SAAS,CAAC,QAAQ,CAAC,+BAA+B,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,KAAK;IAE1F,SAAS,CAAC,8BAA8B,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;cAI1E,6BAA6B,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAYxF,SAAS,CAAC,iBAAiB,CACzB,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IAU7B,SAAS,CAAC,2BAA2B,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9E,SAAS,CAAC,+BAA+B,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;cAIxD,yBAAyB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOxE,OAAO,CAAC,0BAA0B;IAsElC,OAAO,CAAC,yBAAyB;IAQjC,OAAO,CAAC,+BAA+B;IAgBvC,OAAO,CAAC,0BAA0B;CAQnC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onekeyfe/hd-transport",
-  "version": "1.2.0-alpha.24",
+  "version": "1.2.0-alpha.25",
   "description": "Transport layer abstractions and utilities for OneKey hardware SDK.",
   "author": "OneKey",
   "homepage": "https://github.com/OneKeyHQ/hardware-js-sdk#readme",
@@ -28,5 +28,5 @@
     "long": "^4.0.0",
     "protobufjs": "^6.11.2"
   },
-  "gitHead": "43663337d94350430cc507c74d6eec5a076bd4e9"
+  "gitHead": "20bb98b8530c509299b9e109d2b5ada7c6a6d034"
 }

package/src/protocols/v2/errors.ts

@@ -1,5 +1,7 @@
 export type ProtocolV2LinkErrorCode =
   | 'response-timeout'
+  | 'io'
+  | 'generation'
   | 'router'
   | 'packet-source'
   | 'ack-sequence'

package/src/protocols/v2/link-manager.ts

@@ -1,4 +1,5 @@
 import { ProtocolV2SequenceCursor } from './sequence-cursor';
+import { ProtocolV2LinkError } from './errors';
 import { ProtocolV2Session, getErrorMessage } from './session';
 
 import type { MessageFromOneKey, TransportCallOptions } from '../../types';
@@ -40,6 +41,10 @@ export class ProtocolV2LinkManager<Key> {
 
   private readonly callQueues = new Map<Key, Promise<unknown>>();
 
+  private readonly generations = new Map<Key, number>();
+
+  private readonly invalidationReasons = new Map<Key, { generation: number; reason: string }>();
+
   private readonly options: ProtocolV2LinkManagerOptions<Key>;
 
   constructor(options: ProtocolV2LinkManagerOptions<Key>) {
@@ -53,7 +58,11 @@ export class ProtocolV2LinkManager<Key> {
     data: Record<string, unknown>,
     options?: TransportCallOptions
   ): Promise<MessageFromOneKey> {
-    const run = () => this.executeCall(key, createAdapter, name, data, options);
+    const generation = this.generations.get(key) ?? 0;
+    const run = () => {
+      this.assertCallGeneration(key, generation);
+      return this.executeCall(key, createAdapter, name, data, options);
+    };
     const previous = this.callQueues.get(key) ?? Promise.resolve();
     const result = previous.then(run, run);
     const queue = result.catch(() => undefined);
@@ -68,6 +77,10 @@ export class ProtocolV2LinkManager<Key> {
   }
 
   async invalidateLink(key: Key, reason: string): Promise<void> {
+    const generation = (this.generations.get(key) ?? 0) + 1;
+    this.generations.set(key, generation);
+    this.invalidationReasons.set(key, { generation, reason });
+
     const link = this.links.get(key);
     if (!link) return;
 
@@ -78,7 +91,8 @@ export class ProtocolV2LinkManager<Key> {
   }
 
   async invalidateAllLinks(reason: string): Promise<void> {
-    await Promise.all(Array.from(this.links.keys(), key => this.invalidateLink(key, reason)));
+    const keys = new Set([...this.links.keys(), ...this.callQueues.keys()]);
+    await Promise.all(Array.from(keys, key => this.invalidateLink(key, reason)));
   }
 
   async dispose(reason: string): Promise<void> {
@@ -157,4 +171,16 @@ export class ProtocolV2LinkManager<Key> {
       this.callQueues.delete(key);
     }
   }
+
+  private assertCallGeneration(key: Key, generation: number) {
+    const currentGeneration = this.generations.get(key) ?? 0;
+    if (currentGeneration === generation) return;
+
+    const invalidation = this.invalidationReasons.get(key);
+    const reason =
+      invalidation?.generation === currentGeneration
+        ? invalidation.reason
+        : 'Protocol V2 link generation changed';
+    throw new ProtocolV2LinkError('generation', reason);
+  }
 }

package/src/protocols/v2/usb-transport-base.ts

@@ -1,5 +1,7 @@
 import { ProtocolV2FrameAssembler } from './frame-assembler';
+import { ProtocolV2LinkError, isProtocolV2LinkError } from './errors';
 import { ProtocolV2LinkManager } from './link-manager';
+import { getErrorMessage } from './session';
 
 import type { MessageFromOneKey, TransportCallOptions } from '../../types';
 import type { ProtocolV2CallContext, ProtocolV2Schemas, ProtocolV2SessionOptions } from './session';
@@ -32,7 +34,7 @@ export abstract class ProtocolV2UsbTransportBase<Key> {
     this.protocolV2UsbOptions = options;
     this.protocolV2UsbLinks = new ProtocolV2LinkManager<Key>({
       getSchemas: () => this.getProtocolV2UsbSchemas(),
-      classifyError: () => 'link-fatal',
+      classifyError: error => (isProtocolV2LinkError(error) ? 'link-fatal' : 'recoverable'),
       onLinkInvalidated: async (key, reason) => {
         this.protocolV2UsbAssemblers.get(key)?.reset();
         await this.resetProtocolV2UsbNativeLink(key, reason);
@@ -118,10 +120,13 @@ export abstract class ProtocolV2UsbTransportBase<Key> {
 
     const assertCurrentGeneration = () => {
       if (cancellation.reason) {
-        throw new Error(cancellation.reason);
+        throw new ProtocolV2LinkError('generation', cancellation.reason);
       }
       if (this.protocolV2UsbGenerations.get(key) !== generation) {
-        throw new Error('Protocol V2 USB connection generation changed');
+        throw new ProtocolV2LinkError(
+          'generation',
+          'Protocol V2 USB connection generation changed'
+        );
       }
     };
 
@@ -131,11 +136,14 @@ export abstract class ProtocolV2UsbTransportBase<Key> {
       generation,
       prepareCall: () => {
         assertCurrentGeneration();
-        this.getProtocolV2UsbAssembler(key).reset();
       },
       writeFrame: async (frame: Uint8Array, context: ProtocolV2CallContext) => {
         assertCurrentGeneration();
-        await this.writeProtocolV2UsbPacket(key, frame, context);
+        try {
+          await this.writeProtocolV2UsbPacket(key, frame, context);
+        } catch (error) {
+          throw this.createProtocolV2UsbIoError('write', error);
+        }
         assertCurrentGeneration();
       },
       readFrame: async (context: ProtocolV2CallContext) => {
@@ -143,13 +151,15 @@ export abstract class ProtocolV2UsbTransportBase<Key> {
         const assembler = this.getProtocolV2UsbAssembler(key);
         let frame = assembler.push(new Uint8Array(0));
         while (!frame) {
-          const packetRead = this.readProtocolV2UsbPacket(key, context).then(packet => ({
-            packet,
-          }));
+          const packetRead = this.readProtocolV2UsbPacket(key, context)
+            .then(packet => ({ packet }))
+            .catch(error => {
+              throw this.createProtocolV2UsbIoError('read', error);
+            });
           const cancelled = cancellation.promise.then(reason => ({ reason }));
           const result = await Promise.race([packetRead, cancelled]);
           if ('reason' in result) {
-            throw new Error(result.reason);
+            throw new ProtocolV2LinkError('generation', result.reason);
           }
           assertCurrentGeneration();
           frame = assembler.push(result.packet);
@@ -191,4 +201,13 @@ export abstract class ProtocolV2UsbTransportBase<Key> {
     };
     return cancellation;
   }
+
+  private createProtocolV2UsbIoError(operation: 'read' | 'write', error: unknown) {
+    if (isProtocolV2LinkError(error)) return error;
+    return new ProtocolV2LinkError(
+      'io',
+      `Protocol V2 USB ${operation} failed: ${getErrorMessage(error) || 'unknown error'}`,
+      error
+    );
+  }
 }