@onekeyfe/hd-transport 1.2.0-alpha.21 → 1.2.0-alpha.22

package/__tests__/messages.test.js

@@ -101,17 +101,44 @@ describe('messages', () => {
     expect(v2Messages.nested.MessageType.values).toMatchObject({
       MessageType_DeviceStatusGet: 60602,
       MessageType_DeviceStatus: 60603,
-      MessageType_DeviceSessionGet: 60606,
       MessageType_DeviceSession: 60607,
       MessageType_DeviceSessionAskPin: 60608,
+      MessageType_DeviceSessionOpen: 60609,
     });
     expect(v2Messages.nested.DeviceStatusGet).toEqual({ fields: {} });
-    expect(v2Messages.nested.DeviceSessionGet.fields.session_id).toMatchObject({
+    expect(v2Messages.nested.ProtocolInfoRequest.fields.eventless_wallet_session).toMatchObject({
+      id: 1,
+      type: 'bool',
+      options: { default: false },
+    });
+    expect(v2Messages.nested).not.toHaveProperty('DeviceSessionGet');
+    expect(v2Messages.nested.DeviceSessionResume.fields.session_id).toMatchObject({
+      rule: 'required',
       id: 1,
       type: 'bytes',
     });
-    expect(v2Messages.nested).not.toHaveProperty('DeviceSessionOpen');
-    expect(v2Messages.nested).not.toHaveProperty('DeviceSessionResume');
+    expect(v2Messages.nested.DeviceSessionOpen.fields).toMatchObject({
+      resume: { id: 1, type: 'DeviceSessionResume' },
+      select: { id: 2, type: 'DeviceSessionSelect' },
+    });
+    expect(v2Messages.nested.DeviceSessionSelect.fields).toMatchObject({
+      host_passphrase: { id: 1, type: 'DeviceSessionHostPassphrase' },
+      passphrase_on_device: { id: 2, type: 'DeviceSessionPassphraseOnDevice' },
+      attach_pin_on_device: { id: 3, type: 'DeviceSessionAttachPinOnDevice' },
+    });
+    expect(v2Messages.nested.DeviceSessionHostPassphrase.fields.passphrase).toMatchObject({
+      rule: 'required',
+      id: 1,
+      type: 'string',
+    });
+    expect(v2Messages.nested.DeviceSessionErrorCode.values).toEqual({
+      DeviceSessionError_None: 0,
+      DeviceSessionError_UserCancelled: 1,
+      DeviceSessionError_InvalidSession: 2,
+      DeviceSessionError_AttachPinUnavailable: 3,
+      DeviceSessionError_PassphraseDisabled: 4,
+      DeviceSessionError_Busy: 5,
+    });
     expect(v2Messages.nested).not.toHaveProperty('DeviceWalletSelect');
     expect(v2Messages.nested).not.toHaveProperty('DeviceWalletType');
     expect(v2Messages.nested).not.toHaveProperty('DeviceHiddenWalletSelect');
@@ -126,9 +153,7 @@ describe('messages', () => {
     expect(v2Messages.nested.MessageType.values).not.toHaveProperty(
       'MessageType_DeviceSessionPinResult'
     );
-    expect(v2Messages.nested.MessageType.values).not.toHaveProperty(
-      'MessageType_DeviceSessionOpen'
-    );
+    expect(v2Messages.nested.MessageType.values).not.toHaveProperty('MessageType_DeviceSessionGet');
   });
 
   test('Protocol V2 onboarding status matches the current firmware-pro2 schema', () => {

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

@@ -55,7 +55,12 @@ const rewriteSeq = (frame, seq) => {
 const createAdapterFactory = sentSeqs => {
   const adapters = [];
   let generation = 0;
-  const success = ProtocolV2.encodeFrame(schemas, 'Success', { message: 'ok' });
+  const success = ProtocolV2.encodeFrame(
+    schemas,
+    'Success',
+    { message: 'ok' },
+    { router: 1, packetSrc: 0, seq: 1 }
+  );
 
   return {
     adapters,
@@ -108,12 +113,15 @@ describe('ProtocolV2LinkManager', () => {
 
     await manager.call('device-a', createAdapter, 'Ping', { message: '1' }, { timeoutMs: 123 });
 
-    expect(adapters[0].prepareCall).toHaveBeenCalledWith({
-      messageName: 'Ping',
-      timeoutMs: 123,
-      highVolume: false,
-      generation: 1,
-    });
+    expect(adapters[0].prepareCall).toHaveBeenCalledWith(
+      expect.objectContaining({
+        messageName: 'Ping',
+        timeoutMs: 123,
+        highVolume: false,
+        generation: 1,
+        signal: expect.any(AbortSignal),
+      })
+    );
   });
 
   test('invalidates a link-fatal call before the next call creates a new link', async () => {
@@ -200,7 +208,12 @@ describe('ProtocolV2LinkManager', () => {
     const deviceABlocked = new Promise(resolve => {
       releaseDeviceA = resolve;
     });
-    const success = ProtocolV2.encodeFrame(schemas, 'Success', { message: 'ok' });
+    const success = ProtocolV2.encodeFrame(
+      schemas,
+      'Success',
+      { message: 'ok' },
+      { router: 1, packetSrc: 0, seq: 1 }
+    );
     const createAdapter = key => {
       let requestSeq = 0;
       return {
@@ -298,7 +311,12 @@ describe('ProtocolV2LinkManager', () => {
     const writeBlocked = new Promise(resolve => {
       releaseWrite = resolve;
     });
-    const success = ProtocolV2.encodeFrame(schemas, 'Success', { message: 'ok' });
+    const success = ProtocolV2.encodeFrame(
+      schemas,
+      'Success',
+      { message: 'ok' },
+      { router: 1, packetSrc: 0, seq: 1 }
+    );
     const adapter = {
       router: 1,
       generation: 1,

package/__tests__/protocol-v2.test.js

@@ -2,13 +2,17 @@ const { ProtocolV2 } = require('../src/protocols');
 const { parseConfigure } = require('../src/serialization/protobuf/messages');
 const {
   ProtocolV2FrameAssembler,
+  ProtocolV2LinkError,
   ProtocolV2SequenceCursor,
   ProtocolV2Session,
   hexToBytes,
   probeProtocolV2,
 } = require('../src/protocols/v2/session');
 const protocolV2 = require('../src/protocols/v2');
-const { PROTOCOL_V2_FRAME_MAX_BYTES } = require('../src/constants');
+const {
+  PROTOCOL_V2_DEFAULT_RESPONSE_TIMEOUT_MS,
+  PROTOCOL_V2_FRAME_MAX_BYTES,
+} = require('../src/constants');
 
 const protocolV1Messages = parseConfigure({
   nested: {
@@ -221,6 +225,7 @@ const schemas = {
 
 const rewriteSeq = (frame, seq) => {
   const copy = new Uint8Array(frame);
+  copy[4] = 1;
   copy[6] = seq;
   copy[copy.length - 1] = protocolV2.crc8(copy, copy.length - 1);
   return copy;
@@ -429,7 +434,7 @@ describe('Protocol V2 framing and session', () => {
       logger,
       logPrefix: 'ProtocolV2 Test',
       writeFrame: () => Promise.resolve(),
-      readFrame: () => Promise.resolve(response),
+      readFrame: () => Promise.resolve(rewriteSeq(response, 1)),
     });
 
     await expect(session.call('Ping', { message: 'hello' })).rejects.toThrow();
@@ -451,7 +456,10 @@ describe('Protocol V2 framing and session', () => {
     const response = ProtocolV2.encodeFrame(schemas, 'Success', {
       message: 'ok',
     });
-    const readFrame = jest.fn().mockResolvedValueOnce(ack).mockResolvedValueOnce(response);
+    const readFrame = jest
+      .fn()
+      .mockResolvedValueOnce(ack)
+      .mockResolvedValueOnce(rewriteSeq(response, 1));
     const session = new ProtocolV2Session({
       schemas,
       router: 1,
@@ -468,6 +476,96 @@ describe('Protocol V2 framing and session', () => {
     expect(readFrame).toHaveBeenCalledTimes(2);
   });
 
+  test('session accepts a terminal response before an ACK', async () => {
+    const response = ProtocolV2.encodeFrame(schemas, 'Success', {
+      message: 'ok',
+    });
+    const session = new ProtocolV2Session({
+      schemas,
+      router: 1,
+      writeFrame: () => Promise.resolve(),
+      readFrame: () => Promise.resolve(rewriteSeq(response, 1)),
+    });
+
+    await expect(
+      session.call('Ping', { message: 'hello' }, { expectedTypes: ['Success'] })
+    ).resolves.toEqual({
+      type: 'Success',
+      message: {
+        message: 'ok',
+      },
+    });
+  });
+
+  test('session uses the unified response timeout before the first ACK', async () => {
+    const response = ProtocolV2.encodeFrame(schemas, 'Success', {
+      message: 'ok',
+    });
+    const readFrame = jest.fn(() => Promise.resolve(rewriteSeq(response, 1)));
+    const session = new ProtocolV2Session({
+      schemas,
+      router: 1,
+      writeFrame: () => Promise.resolve(),
+      readFrame,
+    });
+
+    await expect(
+      session.call(
+        'Ping',
+        { message: 'hello' },
+        {
+          timeoutMs: 12_345,
+          expectedTypes: ['Success'],
+        }
+      )
+    ).resolves.toEqual({
+      type: 'Success',
+      message: {
+        message: 'ok',
+      },
+    });
+    expect(readFrame).toHaveBeenCalledWith(expect.objectContaining({ timeoutMs: 12_345 }));
+  });
+
+  test('session rejects an ACK that belongs to another request sequence', async () => {
+    const ack = new Uint8Array(8);
+    ack[0] = 0x5a;
+    ack[1] = 8;
+    ack[4] = 1;
+    ack[5] = 1;
+    ack[6] = 2;
+    ack[3] = protocolV2.crc8(ack, 3);
+    ack[7] = protocolV2.crc8(ack, 7);
+    const session = new ProtocolV2Session({
+      schemas,
+      router: 1,
+      writeFrame: () => Promise.resolve(),
+      readFrame: () => Promise.resolve(ack),
+    });
+
+    await expect(session.call('Ping', { message: 'hello' })).rejects.toEqual(
+      expect.objectContaining({
+        name: 'ProtocolV2LinkError',
+        code: 'ack-sequence',
+        message: 'Protocol V2 ACK sequence mismatch: expected 1, got 2',
+      })
+    );
+  });
+
+  test('session rejects a response from another routing channel', async () => {
+    const response = ProtocolV2.encodeFrame(schemas, 'Success', { message: 'wrong route' });
+    const session = new ProtocolV2Session({
+      schemas,
+      router: 1,
+      writeFrame: () => Promise.resolve(),
+      readFrame: () => Promise.resolve(response),
+    });
+
+    await expect(session.call('Ping', { message: 'hello' })).rejects.toBeInstanceOf(
+      ProtocolV2LinkError
+    );
+  });
+
   test('session rejects BLE frames above its configured frame limit before writing', async () => {
     const writeFrame = jest.fn().mockResolvedValue(undefined);
     const response = ProtocolV2.encodeFrame(schemas, 'Success', {
@@ -478,7 +576,7 @@ describe('Protocol V2 framing and session', () => {
       router: 1,
       maxFrameBytes: 2048,
       writeFrame,
-      readFrame: () => Promise.resolve(response),
+      readFrame: () => Promise.resolve(rewriteSeq(response, 1)),
     });
 
     await expect(session.call('Ping', { message: 'x'.repeat(2048) })).rejects.toThrow(
@@ -487,28 +585,40 @@ describe('Protocol V2 framing and session', () => {
     expect(writeFrame).not.toHaveBeenCalled();
   });
 
-  test('session starts response timeout after the frame is written', async () => {
-    const response = ProtocolV2.encodeFrame(schemas, 'Success', {
-      message: 'ok',
-    });
+  test('session watchdog covers a write that never settles', async () => {
+    const readFrame = jest.fn();
+    let writeSignal;
     const session = new ProtocolV2Session({
       schemas,
       router: 1,
-      writeFrame: () =>
-        new Promise(resolve => {
-          setTimeout(resolve, 30);
-        }),
-      readFrame: () => Promise.resolve(response),
+      writeFrame: (_frame, context) => {
+        writeSignal = context.signal;
+        return new Promise(() => {});
+      },
+      readFrame,
     });
 
     await expect(
       session.call('Ping', { message: 'hello' }, { timeoutMs: 10, expectedTypes: ['Success'] })
-    ).resolves.toEqual({
-      type: 'Success',
-      message: {
-        message: 'ok',
-      },
+    ).rejects.toThrow('Protocol V2 response timeout after 10ms for Ping');
+    expect(writeSignal.aborted).toBe(true);
+    expect(readFrame).not.toHaveBeenCalled();
+  });
+
+  test('session watchdog covers prepareCall before writing', async () => {
+    const writeFrame = jest.fn();
+    const session = new ProtocolV2Session({
+      schemas,
+      router: 1,
+      prepareCall: () => new Promise(() => {}),
+      writeFrame,
+      readFrame: jest.fn(),
     });
+
+    await expect(session.call('Ping', { message: 'hello' }, { timeoutMs: 10 })).rejects.toThrow(
+      'Protocol V2 response timeout after 10ms for Ping'
+    );
+    expect(writeFrame).not.toHaveBeenCalled();
   });
 
   test('session logs a device-owned response seq without rejecting the frame', async () => {
@@ -538,6 +648,41 @@ describe('Protocol V2 framing and session', () => {
     expect(logger.debug).not.toHaveBeenCalled();
   });
 
+  test('session accepts gaps in the firmware-global response sequence', async () => {
+    const response = ProtocolV2.encodeFrame(schemas, 'Success', { message: 'ok' });
+    const readFrame = jest
+      .fn()
+      .mockResolvedValueOnce(rewriteSeq(response, 1))
+      .mockResolvedValueOnce(rewriteSeq(response, 4));
+    const session = new ProtocolV2Session({
+      schemas,
+      router: 1,
+      writeFrame: () => Promise.resolve(),
+      readFrame,
+    });
+
+    await session.call('Ping', { message: 'first' });
+    await expect(session.call('Ping', { message: 'second' })).resolves.toMatchObject({
+      type: 'Success',
+    });
+  });
+
+  test('session rejects a duplicate device response sequence', async () => {
+    const response = ProtocolV2.encodeFrame(schemas, 'Success', { message: 'ok' });
+    const readFrame = jest.fn(() => Promise.resolve(rewriteSeq(response, 7)));
+    const session = new ProtocolV2Session({
+      schemas,
+      router: 1,
+      writeFrame: () => Promise.resolve(),
+      readFrame,
+    });
+
+    await session.call('Ping', { message: 'first' });
+    await expect(session.call('Ping', { message: 'second' })).rejects.toThrow(
+      'Protocol V2 duplicate response sequence: 7'
+    );
+  });
+
   test('session does not log transmit or receive payload details', async () => {
     const response = ProtocolV2.encodeFrame(schemas, 'Success', {
       message: 'accepted',
@@ -549,7 +694,7 @@ describe('Protocol V2 framing and session', () => {
       schemas,
       router: 1,
       writeFrame: () => Promise.resolve(),
-      readFrame: () => Promise.resolve(response),
+      readFrame: () => Promise.resolve(rewriteSeq(response, 1)),
       logger,
       logPrefix: 'ProtocolV2 Test',
     });
@@ -575,7 +720,7 @@ describe('Protocol V2 framing and session', () => {
       schemas,
       router: 1,
       writeFrame: () => Promise.resolve(),
-      readFrame: () => Promise.resolve(response),
+      readFrame: () => Promise.resolve(rewriteSeq(response, 1)),
       logger,
     });
 
@@ -600,7 +745,10 @@ describe('Protocol V2 framing and session', () => {
     const logger = {
       debug: jest.fn(),
     };
-    const readFrame = jest.fn().mockResolvedValueOnce(stale).mockResolvedValueOnce(response);
+    const readFrame = jest
+      .fn()
+      .mockResolvedValueOnce(rewriteSeq(stale, 1))
+      .mockResolvedValueOnce(rewriteSeq(response, 2));
     const session = new ProtocolV2Session({
       schemas,
       router: 1,
@@ -637,7 +785,9 @@ describe('Protocol V2 framing and session', () => {
       const [writtenFrame] = written;
       const { seq } = protocolV2.decodeFrame(writtenFrame);
       return Promise.resolve(
-        readFrame.mock.calls.length === 1 ? rewriteSeq(progress, seq) : rewriteSeq(success, seq)
+        readFrame.mock.calls.length === 1
+          ? rewriteSeq(progress, seq)
+          : rewriteSeq(success, protocolV2.nextProtoSeq(seq))
       );
     });
     const session = new ProtocolV2Session({
@@ -814,7 +964,7 @@ describe('Protocol V2 framing and session', () => {
         }
         return Promise.resolve();
       },
-      readFrame: () => Promise.resolve(response),
+      readFrame: () => Promise.resolve(rewriteSeq(response, 1)),
     });
 
     await expect(session.call('Ping', { message: '1' })).rejects.toThrow('transport write failed');
@@ -883,6 +1033,7 @@ describe('Protocol V2 framing and session', () => {
     const writeContexts = [];
     const readContexts = [];
     const response = ProtocolV2.encodeFrame(schemas, 'Success', { message: 'ok' });
+    let responseSeq = 0;
     const session = new ProtocolV2Session({
       schemas,
       router: 1,
@@ -893,18 +1044,65 @@ describe('Protocol V2 framing and session', () => {
       },
       readFrame: context => {
         readContexts.push(context);
-        return Promise.resolve(response);
+        responseSeq = protocolV2.nextProtoSeq(responseSeq);
+        return Promise.resolve(rewriteSeq(response, responseSeq));
       },
     });
 
     await session.call('Ping', { message: 'ping' }, { timeoutMs: 123 });
     await session.call('FileWrite', {}, { timeoutMs: 456 });
+    await session.call('Ping', { message: 'default-timeout' });
 
-    expect(writeContexts).toEqual([
-      { messageName: 'Ping', timeoutMs: 123, highVolume: false, generation: 7 },
-      { messageName: 'FileWrite', timeoutMs: 456, highVolume: true, generation: 7 },
+    const normalizeContext = ({ signal, ...context }) => ({
+      ...context,
+      signalAborted: signal.aborted,
+    });
+    expect(writeContexts.map(normalizeContext)).toEqual([
+      {
+        messageName: 'Ping',
+        timeoutMs: 123,
+        highVolume: false,
+        generation: 7,
+        signalAborted: false,
+      },
+      {
+        messageName: 'FileWrite',
+        timeoutMs: 456,
+        highVolume: true,
+        generation: 7,
+        signalAborted: false,
+      },
+      {
+        messageName: 'Ping',
+        timeoutMs: PROTOCOL_V2_DEFAULT_RESPONSE_TIMEOUT_MS,
+        highVolume: false,
+        generation: 7,
+        signalAborted: false,
+      },
+    ]);
+    expect(readContexts.map(normalizeContext)).toEqual([
+      {
+        messageName: 'Ping',
+        timeoutMs: 123,
+        highVolume: false,
+        generation: 7,
+        signalAborted: false,
+      },
+      {
+        messageName: 'FileWrite',
+        timeoutMs: 456,
+        highVolume: true,
+        generation: 7,
+        signalAborted: false,
+      },
+      {
+        messageName: 'Ping',
+        timeoutMs: PROTOCOL_V2_DEFAULT_RESPONSE_TIMEOUT_MS,
+        highVolume: false,
+        generation: 7,
+        signalAborted: false,
+      },
     ]);
-    expect(readContexts).toEqual(writeContexts);
   });
 
   test('assembler throws and resets on frames with an impossible length field', () => {

package/dist/constants.d.ts

@@ -14,4 +14,5 @@ export declare const PROTOCOL_V2_CHANNEL_USB = 0;
 export declare const PROTOCOL_V2_CHANNEL_BLE_UART = 1;
 export declare const PROTOCOL_V2_CHANNEL_SOCKET = 2;
 export declare const PROTOCOL_V2_PACKET_SRC_COMMAND = 0;
+export declare const PROTOCOL_V2_DEFAULT_RESPONSE_TIMEOUT_MS: number;
 //# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,qBAAqB,KAAO,CAAC;AAG1C,eAAO,MAAM,uBAAuB,KAAO,CAAC;AAG5C,eAAO,MAAM,8BAA8B,KAAK,CAAC;AAGjD,eAAO,MAAM,2BAA2B,QAAqC,CAAC;AAG9E,eAAO,MAAM,+BAA+B,QAAQ,CAAC;AAGrD,eAAO,MAAM,gCAAgC,QAA0C,CAAC;AAKxF,eAAO,MAAM,2BAA2B,OAAO,CAAC;AAGhD,eAAO,MAAM,kCAAkC,OAAO,CAAC;AAGvD,eAAO,MAAM,+BAA+B,OAAO,CAAC;AAGpD,eAAO,MAAM,oCAAoC,MAAM,CAAC;AAGxD,eAAO,MAAM,+BAA+B,OAAO,CAAC;AAGpD,eAAO,MAAM,2BAA2B,OAAqC,CAAC;AAM9E,eAAO,MAAM,uBAAuB,IAAI,CAAC;AACzC,eAAO,MAAM,4BAA4B,IAAI,CAAC;AAC9C,eAAO,MAAM,0BAA0B,IAAI,CAAC;AAG5C,eAAO,MAAM,8BAA8B,IAAI,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,qBAAqB,KAAO,CAAC;AAG1C,eAAO,MAAM,uBAAuB,KAAO,CAAC;AAG5C,eAAO,MAAM,8BAA8B,KAAK,CAAC;AAGjD,eAAO,MAAM,2BAA2B,QAAqC,CAAC;AAG9E,eAAO,MAAM,+BAA+B,QAAQ,CAAC;AAGrD,eAAO,MAAM,gCAAgC,QAA0C,CAAC;AAKxF,eAAO,MAAM,2BAA2B,OAAO,CAAC;AAGhD,eAAO,MAAM,kCAAkC,OAAO,CAAC;AAGvD,eAAO,MAAM,+BAA+B,OAAO,CAAC;AAGpD,eAAO,MAAM,oCAAoC,MAAM,CAAC;AAGxD,eAAO,MAAM,+BAA+B,OAAO,CAAC;AAGpD,eAAO,MAAM,2BAA2B,OAAqC,CAAC;AAM9E,eAAO,MAAM,uBAAuB,IAAI,CAAC;AACzC,eAAO,MAAM,4BAA4B,IAAI,CAAC;AAC9C,eAAO,MAAM,0BAA0B,IAAI,CAAC;AAG5C,eAAO,MAAM,8BAA8B,IAAI,CAAC;AAQhD,eAAO,MAAM,uCAAuC,QAAgB,CAAC"}