@onekeyfe/hd-transport 1.2.0-alpha.175 → 1.2.0-alpha.176

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

@@ -317,6 +317,76 @@ describe('ProtocolV2LinkManager', () => {
     ]);
   });
 
+  test('times out a queued call without sending it after the active call settles', async () => {
+    let releaseActiveRead;
+    let markActiveReadStarted;
+    const activeReadStarted = new Promise(resolve => {
+      markActiveReadStarted = resolve;
+    });
+    const activeReadBlocked = new Promise(resolve => {
+      releaseActiveRead = resolve;
+    });
+    const sentSeqs = [];
+    const success = ProtocolV2.encodeFrame(
+      schemas,
+      'Success',
+      { message: 'ok' },
+      { router: 1, packetSrc: 0, seq: 1 }
+    );
+    let requestSeq = 0;
+    let readCount = 0;
+    const adapter = {
+      router: 1,
+      generation: 1,
+      prepareCall: jest.fn(),
+      writeFrame: jest.fn(frame => {
+        [, , , , , , requestSeq] = frame;
+        sentSeqs.push(requestSeq);
+        return Promise.resolve();
+      }),
+      readFrame: jest.fn(async () => {
+        readCount += 1;
+        if (readCount === 1) {
+          markActiveReadStarted();
+          await activeReadBlocked;
+        }
+        return rewriteSeq(success, requestSeq);
+      }),
+      reset: jest.fn(),
+      createTimeoutError: (name, timeoutMs) =>
+        new Error(`response timeout after ${timeoutMs}ms for ${name}`),
+    };
+    const manager = new ProtocolV2LinkManager({
+      getSchemas: () => schemas,
+      classifyError: () => 'recoverable',
+    });
+    const createAdapter = jest.fn(() => adapter);
+
+    const activeCall = manager.call('device-a', createAdapter, 'Ping', { message: 'active' });
+    await activeReadStarted;
+    const queuedCall = manager.call(
+      'device-a',
+      createAdapter,
+      'Ping',
+      { message: 'queued' },
+      { timeoutMs: 20 }
+    );
+
+    await expect(queuedCall).rejects.toThrow('response timeout after 20ms for Ping');
+    expect(sentSeqs).toEqual([1]);
+
+    releaseActiveRead();
+    await activeCall;
+    await expect(
+      manager.call('device-a', createAdapter, 'Ping', { message: 'after-timeout' })
+    ).resolves.toEqual({
+      type: 'Success',
+      message: { message: 'ok' },
+    });
+
+    expect(sentSeqs).toEqual([1, 2]);
+  });
+
   test('writes flow control while the active call is waiting for its response', async () => {
     const sentSeqs = [];
     let releaseRead;

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

@@ -217,7 +217,7 @@ describe('ProtocolV2UsbTransportBase', () => {
     expect(transport.nativeResets).toEqual([['device-a', 'USB reconnected']]);
   });
 
-  test('passes each queued call its own timeout context', async () => {
+  test('passes each queued call its remaining timeout context', async () => {
     const transport = new FakeUsbTransport();
     await transport.rotate('device-a');
 
@@ -226,12 +226,14 @@ describe('ProtocolV2UsbTransportBase', () => {
       transport.callDevice('device-a', 'second', 222),
     ]);
 
-    expect(transport.readContexts).toEqual([
+    expect(transport.readContexts.slice(0, 2)).toEqual([
       ['device-a', 111],
       ['device-a', 111],
-      ['device-a', 222],
-      ['device-a', 222],
     ]);
+    const secondCallTimeouts = transport.readContexts.slice(2).map(([, timeoutMs]) => timeoutMs);
+    expect(secondCallTimeouts[0]).toBeGreaterThan(0);
+    expect(secondCallTimeouts[0]).toBeLessThanOrEqual(222);
+    expect(secondCallTimeouts[1]).toBe(secondCallTimeouts[0]);
   });
 
   test('keeps a coalesced response buffered for the next call', async () => {

package/dist/index.d.ts

@@ -6756,6 +6756,7 @@ declare class ProtocolV2LinkManager<Key> {
     private getOrCreateLink;
     private executeCall;
     private clearSettledCallQueue;
+    private createQueuedCallTimeoutError;
     private assertCallGeneration;
 }
 

package/dist/index.js

@@ -1298,17 +1298,43 @@ class ProtocolV2LinkManager {
         this.options = options;
     }
     call(key, createAdapter, name, data, options) {
-        var _a, _b;
+        var _a;
         const generation = (_a = this.generations.get(key)) !== null && _a !== void 0 ? _a : 0;
+        const previousQueue = this.callQueues.get(key);
+        const timeoutMs = (options === null || options === void 0 ? void 0 : options.timeoutMs) && options.timeoutMs > 0
+            ? options.timeoutMs
+            : PROTOCOL_V2_DEFAULT_RESPONSE_TIMEOUT_MS;
+        const queuedAt = Date.now();
+        let queueTimeout;
+        let queueTimeoutError;
+        const timeoutWhileQueued = new Promise((_, reject) => {
+            queueTimeout = setTimeout(() => {
+                queueTimeout = undefined;
+                queueTimeoutError = this.createQueuedCallTimeoutError(key, name, timeoutMs);
+                reject(queueTimeoutError);
+            }, timeoutMs);
+        });
         const run = () => {
+            if (queueTimeout) {
+                clearTimeout(queueTimeout);
+                queueTimeout = undefined;
+            }
+            if (queueTimeoutError) {
+                throw queueTimeoutError;
+            }
             this.assertCallGeneration(key, generation);
-            return this.executeCall(key, createAdapter, name, data, options);
+            const remainingTimeoutMs = previousQueue ? timeoutMs - (Date.now() - queuedAt) : timeoutMs;
+            if (remainingTimeoutMs <= 0) {
+                throw this.createQueuedCallTimeoutError(key, name, timeoutMs);
+            }
+            return this.executeCall(key, createAdapter, name, data, Object.assign(Object.assign({}, options), { timeoutMs: remainingTimeoutMs }));
         };
-        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);
+        const previous = previousQueue !== null && previousQueue !== void 0 ? previousQueue : Promise.resolve();
+        const execution = previous.then(run, run);
+        const result = Promise.race([execution, timeoutWhileQueued]);
+        const queue = execution.catch(() => undefined);
         this.callQueues.set(key, queue);
-        result
+        execution
             .then(() => this.clearSettledCallQueue(key, queue), () => this.clearSettledCallQueue(key, queue))
             .catch(() => undefined);
         return result;
@@ -1433,6 +1459,13 @@ class ProtocolV2LinkManager {
             this.callQueues.delete(key);
         }
     }
+    createQueuedCallTimeoutError(key, name, timeoutMs) {
+        var _a;
+        const adapterTimeoutError = (_a = this.links.get(key)) === null || _a === void 0 ? void 0 : _a.adapter.createTimeoutError;
+        return adapterTimeoutError
+            ? adapterTimeoutError(name, timeoutMs)
+            : new ProtocolV2LinkError('response-timeout', `Protocol V2 call timeout after ${timeoutMs}ms while queued for ${name}`);
+    }
     assertCallGeneration(key, generation) {
         var _a;
         const currentGeneration = (_a = this.generations.get(key)) !== null && _a !== void 0 ? _a : 0;

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

@@ -35,6 +35,7 @@ export declare class ProtocolV2LinkManager<Key> {
     private getOrCreateLink;
     private executeCall;
     private clearSettledCallQueue;
+    private createQueuedCallTimeoutError;
     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":"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,aAAa,CAAiC;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;IAmB7B,eAAe,CACb,GAAG,EAAE,GAAG,EACR,aAAa,EAAE,MAAM,qBAAqB,EAC1C,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,OAAO,CAAC,iBAAiB,CAAC;IAMvB,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA8BvD,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IASjD,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO5C,OAAO,CAAC,eAAe;YA+CT,WAAW;IAkBzB,OAAO,CAAC,qBAAqB;IAM7B,OAAO,CAAC,oBAAoB;CAW7B"}
+{"version":3,"file":"link-manager.d.ts","sourceRoot":"","sources":["../../../src/protocols/v2/link-manager.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,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,aAAa,CAAiC;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;IAiD7B,eAAe,CACb,GAAG,EAAE,GAAG,EACR,aAAa,EAAE,MAAM,qBAAqB,EAC1C,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,OAAO,CAAC,iBAAiB,CAAC;IAMvB,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA8BvD,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IASjD,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO5C,OAAO,CAAC,eAAe;YA+CT,WAAW;IAkBzB,OAAO,CAAC,qBAAqB;IAM7B,OAAO,CAAC,4BAA4B;IAUpC,OAAO,CAAC,oBAAoB;CAW7B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onekeyfe/hd-transport",
-  "version": "1.2.0-alpha.175",
+  "version": "1.2.0-alpha.176",
   "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": "b2cb2451bd3a56b219d18e0078597b316dbc3ba7"
+  "gitHead": "a5152148317effe811cde8adecdfe75c28e82657"
 }

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

@@ -1,6 +1,7 @@
 import { ProtocolV2SequenceCursor } from './sequence-cursor';
 import { ProtocolV2LinkError } from './errors';
 import { ProtocolV2Session, getErrorMessage } from './session';
+import { PROTOCOL_V2_DEFAULT_RESPONSE_TIMEOUT_MS } from '../../constants';
 
 import type { MessageFromOneKey, TransportCallOptions } from '../../types';
 import type { ProtocolV2CallContext, ProtocolV2Schemas, ProtocolV2SessionOptions } from './session';
@@ -61,15 +62,45 @@ export class ProtocolV2LinkManager<Key> {
     options?: TransportCallOptions
   ): Promise<MessageFromOneKey> {
     const generation = this.generations.get(key) ?? 0;
+    const previousQueue = this.callQueues.get(key);
+    const timeoutMs =
+      options?.timeoutMs && options.timeoutMs > 0
+        ? options.timeoutMs
+        : PROTOCOL_V2_DEFAULT_RESPONSE_TIMEOUT_MS;
+    const queuedAt = Date.now();
+    let queueTimeout: ReturnType<typeof setTimeout> | undefined;
+    let queueTimeoutError: Error | undefined;
+    const timeoutWhileQueued = new Promise<never>((_, reject) => {
+      queueTimeout = setTimeout(() => {
+        queueTimeout = undefined;
+        queueTimeoutError = this.createQueuedCallTimeoutError(key, name, timeoutMs);
+        reject(queueTimeoutError);
+      }, timeoutMs);
+    });
     const run = () => {
+      if (queueTimeout) {
+        clearTimeout(queueTimeout);
+        queueTimeout = undefined;
+      }
+      if (queueTimeoutError) {
+        throw queueTimeoutError;
+      }
       this.assertCallGeneration(key, generation);
-      return this.executeCall(key, createAdapter, name, data, options);
+      const remainingTimeoutMs = previousQueue ? timeoutMs - (Date.now() - queuedAt) : timeoutMs;
+      if (remainingTimeoutMs <= 0) {
+        throw this.createQueuedCallTimeoutError(key, name, timeoutMs);
+      }
+      return this.executeCall(key, createAdapter, name, data, {
+        ...options,
+        timeoutMs: remainingTimeoutMs,
+      });
     };
-    const previous = this.callQueues.get(key) ?? Promise.resolve();
-    const result = previous.then(run, run);
-    const queue = result.catch(() => undefined);
+    const previous = previousQueue ?? Promise.resolve();
+    const execution = previous.then(run, run);
+    const result = Promise.race([execution, timeoutWhileQueued]);
+    const queue = execution.catch(() => undefined);
     this.callQueues.set(key, queue);
-    result
+    execution
       .then(
         () => this.clearSettledCallQueue(key, queue),
         () => this.clearSettledCallQueue(key, queue)
@@ -206,6 +237,16 @@ export class ProtocolV2LinkManager<Key> {
     }
   }
 
+  private createQueuedCallTimeoutError(key: Key, name: string, timeoutMs: number): Error {
+    const adapterTimeoutError = this.links.get(key)?.adapter.createTimeoutError;
+    return adapterTimeoutError
+      ? adapterTimeoutError(name, timeoutMs)
+      : new ProtocolV2LinkError(
+          'response-timeout',
+          `Protocol V2 call timeout after ${timeoutMs}ms while queued for ${name}`
+        );
+  }
+
   private assertCallGeneration(key: Key, generation: number) {
     const currentGeneration = this.generations.get(key) ?? 0;
     if (currentGeneration === generation) return;