@onekeyfe/hd-transport 1.2.0-alpha.0 → 1.2.0-alpha.10

package/__tests__/protocol-v2.test.js

@@ -1,8 +1,12 @@
 const { ProtocolV2 } = require('../src/protocols');
 const { parseConfigure } = require('../src/serialization/protobuf/messages');
-const sessionModule = require('../src/protocols/v2/session');
-
-const { ProtocolV2FrameAssembler, ProtocolV2Session, probeProtocolV2 } = sessionModule;
+const {
+  ProtocolV2FrameAssembler,
+  ProtocolV2SequenceCursor,
+  ProtocolV2Session,
+  hexToBytes,
+  probeProtocolV2,
+} = require('../src/protocols/v2/session');
 const protocolV2 = require('../src/protocols/v2');
 
 const protocolV1Messages = parseConfigure({
@@ -15,6 +19,18 @@ const protocolV1Messages = parseConfigure({
         },
       },
     },
+    Failure: {
+      fields: {
+        code: {
+          type: 'uint32',
+          id: 1,
+        },
+        message: {
+          type: 'string',
+          id: 2,
+        },
+      },
+    },
     ButtonRequest: {
       fields: {
         code: {
@@ -32,6 +48,7 @@ const protocolV1Messages = parseConfigure({
     MessageType: {
       values: {
         MessageType_Success: 2,
+        MessageType_Failure: 3,
         MessageType_ButtonRequest: 26,
         MessageType_OnekeyGetFeatures: 10025,
         MessageType_OnekeyFeatures: 10026,
@@ -42,21 +59,22 @@ const protocolV1Messages = parseConfigure({
 
 const protocolV2Messages = parseConfigure({
   nested: {
-    GetProtoVersion: {
+    ProtocolInfoRequest: {
       fields: {},
     },
-    ProtoVersion: {
+    ProtocolInfo: {
       fields: {
-        major_version: {
+        version: {
           type: 'uint32',
           id: 1,
         },
-        minor_version: {
+        supported_messages: {
           type: 'uint32',
           id: 2,
+          rule: 'repeated',
         },
-        patch_version: {
-          type: 'uint32',
+        protobuf_definition: {
+          type: 'string',
           id: 3,
         },
       },
@@ -77,18 +95,53 @@ const protocolV2Messages = parseConfigure({
         },
       },
     },
-    DevFirmwareUpdate: {
-      fields: {},
+    DeviceFirmwareTarget: {
+      fields: {
+        target_id: {
+          type: 'uint32',
+          id: 1,
+        },
+        path: {
+          type: 'string',
+          id: 2,
+        },
+      },
+    },
+    DeviceFirmwareUpdateRequest: {
+      fields: {
+        targets: {
+          type: 'DeviceFirmwareTarget',
+          id: 1,
+          rule: 'repeated',
+        },
+      },
     },
-    DevFirmwareInstallProgress: {
+    DeviceFirmwareUpdateRecord: {
       fields: {
         target_id: {
           type: 'uint32',
           id: 1,
         },
-        progress: {
+        status: {
           type: 'uint32',
-          id: 2,
+          id: 10,
+        },
+        payload_version: {
+          type: 'uint32',
+          id: 20,
+        },
+        path: {
+          type: 'string',
+          id: 30,
+        },
+      },
+    },
+    DeviceFirmwareUpdateStatus: {
+      fields: {
+        records: {
+          type: 'DeviceFirmwareUpdateRecord',
+          id: 1,
+          rule: 'repeated',
         },
       },
     },
@@ -117,13 +170,13 @@ const protocolV2Messages = parseConfigure({
     },
     MessageType: {
       values: {
-        MessageType_GetProtoVersion: 60200,
-        MessageType_ProtoVersion: 60201,
+        MessageType_ProtocolInfoRequest: 60200,
+        MessageType_ProtocolInfo: 60201,
         MessageType_Ping: 60206,
         MessageType_Success: 60207,
         MessageType_FileWrite: 60805,
-        MessageType_DevFirmwareUpdate: 61000,
-        MessageType_DevFirmwareInstallProgress: 61001,
+        MessageType_DeviceFirmwareUpdateRequest: 61000,
+        MessageType_DeviceFirmwareUpdateStatus: 61002,
         MessageType_PartialNested: 62000,
       },
     },
@@ -144,10 +197,10 @@ const rewriteSeq = (frame, seq) => {
 
 describe('Protocol V2 framing and session', () => {
   test('encodes and decodes Protocol V2 protobuf frames', () => {
-    const frame = ProtocolV2.encodeFrame(schemas, 'ProtoVersion', {
-      major_version: 1,
-      minor_version: 2,
-      patch_version: 3,
+    const frame = ProtocolV2.encodeFrame(schemas, 'ProtocolInfo', {
+      version: 1,
+      supported_messages: [60200, 60201],
+      protobuf_definition: 'proto',
     });
 
     const parsed = protocolV2.decodeFrame(frame);
@@ -155,15 +208,15 @@ describe('Protocol V2 framing and session', () => {
 
     const decoded = ProtocolV2.decodeFrame(schemas, frame);
     expect(decoded).toEqual({
-      type: 'ProtoVersion',
-      messageName: 'ProtoVersion',
+      type: 'ProtocolInfo',
+      messageName: 'ProtocolInfo',
       messageTypeId: 60201,
       pbPayload: parsed.pbPayload,
       seq: parsed.seq,
       message: {
-        major_version: 1,
-        minor_version: 2,
-        patch_version: 3,
+        version: 1,
+        supported_messages: [60200, 60201],
+        protobuf_definition: 'proto',
       },
     });
   });
@@ -201,10 +254,9 @@ describe('Protocol V2 framing and session', () => {
   });
 
   test('reassembles split Protocol V2 frames and rejects oversized frames', () => {
-    const frame = ProtocolV2.encodeFrame(schemas, 'ProtoVersion', {
-      major_version: 1,
-      minor_version: 0,
-      patch_version: 0,
+    const frame = ProtocolV2.encodeFrame(schemas, 'ProtocolInfo', {
+      version: 1,
+      supported_messages: [],
     });
     const assembler = new ProtocolV2FrameAssembler();
 
@@ -216,15 +268,13 @@ describe('Protocol V2 framing and session', () => {
   });
 
   test('keeps bytes after the first complete frame for the next read', () => {
-    const first = ProtocolV2.encodeFrame(schemas, 'ProtoVersion', {
-      major_version: 1,
-      minor_version: 0,
-      patch_version: 0,
+    const first = ProtocolV2.encodeFrame(schemas, 'ProtocolInfo', {
+      version: 1,
+      supported_messages: [],
     });
-    const second = ProtocolV2.encodeFrame(schemas, 'ProtoVersion', {
-      major_version: 2,
-      minor_version: 0,
-      patch_version: 0,
+    const second = ProtocolV2.encodeFrame(schemas, 'ProtocolInfo', {
+      version: 2,
+      supported_messages: [],
     });
     const assembler = new ProtocolV2FrameAssembler();
     const combined = new Uint8Array(first.length + second.length);
@@ -237,10 +287,9 @@ describe('Protocol V2 framing and session', () => {
 
   test('session writes one encoded frame and decodes the response frame', async () => {
     const written = [];
-    const response = ProtocolV2.encodeFrame(schemas, 'ProtoVersion', {
-      major_version: 2,
-      minor_version: 0,
-      patch_version: 1,
+    const response = ProtocolV2.encodeFrame(schemas, 'ProtocolInfo', {
+      version: 2,
+      supported_messages: [60206],
     });
     const session = new ProtocolV2Session({
       schemas,
@@ -253,22 +302,72 @@ describe('Protocol V2 framing and session', () => {
         Promise.resolve(rewriteSeq(response, protocolV2.decodeFrame(written[0]).seq)),
     });
 
-    const result = await session.call('GetProtoVersion', {});
+    const result = await session.call('ProtocolInfoRequest', {});
 
     expect(written).toHaveLength(1);
     expect(written[0][4]).toBe(1);
     expect(written[0][5]).toBe(0);
     expect(protocolV2.decodeFrame(written[0]).messageTypeId).toBe(60200);
     expect(result).toEqual({
-      type: 'ProtoVersion',
+      type: 'ProtocolInfo',
       message: {
-        major_version: 2,
-        minor_version: 0,
-        patch_version: 1,
+        version: 2,
+        supported_messages: [60206],
+        protobuf_definition: null,
       },
     });
   });
 
+  test('session skips Proto Link ACK frames before decoding the protobuf response', async () => {
+    const ack = new Uint8Array(8);
+    ack[0] = 0x5a;
+    ack[1] = 8;
+    ack[2] = 0;
+    ack[4] = 1;
+    ack[5] = 1;
+    ack[6] = 1;
+    ack[3] = protocolV2.crc8(ack, 3);
+    ack[7] = protocolV2.crc8(ack, 7);
+
+    const response = ProtocolV2.encodeFrame(schemas, 'Success', {
+      message: 'ok',
+    });
+    const readFrame = jest.fn().mockResolvedValueOnce(ack).mockResolvedValueOnce(response);
+    const session = new ProtocolV2Session({
+      schemas,
+      router: 1,
+      writeFrame: () => Promise.resolve(),
+      readFrame,
+    });
+
+    await expect(session.call('Ping', { message: 'hello' })).resolves.toEqual({
+      type: 'Success',
+      message: {
+        message: 'ok',
+      },
+    });
+    expect(readFrame).toHaveBeenCalledTimes(2);
+  });
+
+  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', {
+      message: 'ok',
+    });
+    const session = new ProtocolV2Session({
+      schemas,
+      router: 1,
+      maxFrameBytes: 2048,
+      writeFrame,
+      readFrame: () => Promise.resolve(response),
+    });
+
+    await expect(session.call('Ping', { message: 'x'.repeat(2048) })).rejects.toThrow(
+      'Protocol V2 frame too large for transport: 2061 > 2048'
+    );
+    expect(writeFrame).not.toHaveBeenCalled();
+  });
+
   test('session starts response timeout after the frame is written', async () => {
     const response = ProtocolV2.encodeFrame(schemas, 'Success', {
       message: 'ok',
@@ -294,10 +393,9 @@ describe('Protocol V2 framing and session', () => {
   });
 
   test('session accepts response frames with a device-owned seq', async () => {
-    const response = ProtocolV2.encodeFrame(schemas, 'ProtoVersion', {
-      major_version: 2,
-      minor_version: 0,
-      patch_version: 1,
+    const response = ProtocolV2.encodeFrame(schemas, 'ProtocolInfo', {
+      version: 2,
+      supported_messages: [],
     });
     const logger = {
       debug: jest.fn(),
@@ -310,12 +408,12 @@ describe('Protocol V2 framing and session', () => {
       logger,
     });
 
-    await expect(session.call('GetProtoVersion', {})).resolves.toEqual({
-      type: 'ProtoVersion',
+    await expect(session.call('ProtocolInfoRequest', {})).resolves.toEqual({
+      type: 'ProtocolInfo',
       message: {
-        major_version: 2,
-        minor_version: 0,
-        patch_version: 1,
+        version: 2,
+        supported_messages: [],
+        protobuf_definition: null,
       },
     });
     expect(logger.debug).toHaveBeenCalledWith(expect.stringContaining('seq differs'));
@@ -399,10 +497,9 @@ describe('Protocol V2 framing and session', () => {
     const stale = ProtocolV2.encodeFrame(schemas, 'Success', {
       message: 'stale response',
     });
-    const response = ProtocolV2.encodeFrame(schemas, 'ProtoVersion', {
-      major_version: 2,
-      minor_version: 0,
-      patch_version: 1,
+    const response = ProtocolV2.encodeFrame(schemas, 'ProtocolInfo', {
+      version: 2,
+      supported_messages: [],
     });
     const logger = {
       debug: jest.fn(),
@@ -417,13 +514,13 @@ describe('Protocol V2 framing and session', () => {
     });
 
     await expect(
-      session.call('GetProtoVersion', {}, { expectedTypes: ['ProtoVersion'] })
+      session.call('ProtocolInfoRequest', {}, { expectedTypes: ['ProtocolInfo'] })
     ).resolves.toEqual({
-      type: 'ProtoVersion',
+      type: 'ProtocolInfo',
       message: {
-        major_version: 2,
-        minor_version: 0,
-        patch_version: 1,
+        version: 2,
+        supported_messages: [],
+        protobuf_definition: null,
       },
     });
 
@@ -433,9 +530,8 @@ describe('Protocol V2 framing and session', () => {
 
   test('session consumes intermediate response frames before returning the final response', async () => {
     const written = [];
-    const progress = ProtocolV2.encodeFrame(schemas, 'DevFirmwareInstallProgress', {
-      target_id: 0,
-      progress: 42,
+    const progress = ProtocolV2.encodeFrame(schemas, 'DeviceFirmwareUpdateStatus', {
+      records: [{ target_id: 4, status: 1 }],
     });
     const success = ProtocolV2.encodeFrame(schemas, 'Success', {
       message: 'ok',
@@ -459,20 +555,19 @@ describe('Protocol V2 framing and session', () => {
     });
 
     const result = await session.call(
-      'DevFirmwareUpdate',
-      {},
+      'DeviceFirmwareUpdateRequest',
+      { targets: [{ target_id: 4, path: 'vol1:firmware.bin' }] },
       {
-        intermediateTypes: ['DevFirmwareInstallProgress'],
+        intermediateTypes: ['DeviceFirmwareUpdateStatus'],
         onIntermediateResponse,
       }
     );
 
     expect(readFrame).toHaveBeenCalledTimes(2);
     expect(onIntermediateResponse).toHaveBeenCalledWith({
-      type: 'DevFirmwareInstallProgress',
+      type: 'DeviceFirmwareUpdateStatus',
       message: {
-        target_id: 0,
-        progress: 42,
+        records: [{ target_id: 4, status: 1, payload_version: null, path: null }],
       },
     });
     expect(result).toEqual({
@@ -483,7 +578,7 @@ describe('Protocol V2 framing and session', () => {
     });
   });
 
-  test('probeProtocolV2 accepts Ping success as a normal V2 probe response', async () => {
+  test('probeProtocolV2 accepts Success as a normal V2 probe response', async () => {
     await expect(
       probeProtocolV2({
         call: () => Promise.resolve({ type: 'Success', message: {} }),
@@ -562,7 +657,7 @@ describe('Protocol V2 framing and session', () => {
     });
 
     await expect(
-      session.call('GetProtoVersion', {}, { timeoutMs: 10, expectedTypes: ['ProtoVersion'] })
+      session.call('ProtocolInfoRequest', {}, { timeoutMs: 10, expectedTypes: ['ProtocolInfo'] })
     ).rejects.toThrow('Protocol V2 response timeout');
 
     // Without cancellation the loop would skip this unexpected Success frame
@@ -661,6 +756,61 @@ describe('Protocol V2 framing and session', () => {
     expect(written.map(frame => frame[6])).toEqual([1, 2, 1]);
   });
 
+  test('session reuses an injected sequence cursor across recreated sessions', async () => {
+    const written = [];
+    const cursor = new ProtocolV2SequenceCursor();
+    const makeSession = () =>
+      new ProtocolV2Session({
+        schemas,
+        router: 1,
+        sequenceCursor: cursor,
+        writeFrame: frame => {
+          written.push(frame);
+          return Promise.resolve();
+        },
+        readFrame: () => {
+          const [frame] = written.slice(-1);
+          const { seq } = protocolV2.decodeFrame(frame);
+          return Promise.resolve(
+            rewriteSeq(ProtocolV2.encodeFrame(schemas, 'Success', { message: 'ok' }), seq)
+          );
+        },
+      });
+
+    await makeSession().call('Ping', { message: '1' });
+    await makeSession().call('Ping', { message: '2' });
+
+    expect(written.map(frame => frame[6])).toEqual([1, 2]);
+  });
+
+  test('session passes per-call context to frame IO callbacks', async () => {
+    const writeContexts = [];
+    const readContexts = [];
+    const response = ProtocolV2.encodeFrame(schemas, 'Success', { message: 'ok' });
+    const session = new ProtocolV2Session({
+      schemas,
+      router: 1,
+      generation: 7,
+      writeFrame: (_frame, context) => {
+        writeContexts.push(context);
+        return Promise.resolve();
+      },
+      readFrame: context => {
+        readContexts.push(context);
+        return Promise.resolve(response);
+      },
+    });
+
+    await session.call('Ping', { message: 'ping' }, { timeoutMs: 123 });
+    await session.call('FileWrite', {}, { timeoutMs: 456 });
+
+    expect(writeContexts).toEqual([
+      { messageName: 'Ping', timeoutMs: 123, highVolume: false, generation: 7 },
+      { messageName: 'FileWrite', timeoutMs: 456, highVolume: true, generation: 7 },
+    ]);
+    expect(readContexts).toEqual(writeContexts);
+  });
+
   test('assembler throws and resets on frames with an impossible length field', () => {
     const assembler = new ProtocolV2FrameAssembler();
     // expectedLen = 0 < 8-byte minimum: without the guard this poisons the
@@ -687,10 +837,9 @@ describe('Protocol V2 framing and session', () => {
   });
 
   test('assembler drain returns every buffered complete frame', () => {
-    const first = ProtocolV2.encodeFrame(schemas, 'ProtoVersion', {
-      major_version: 1,
-      minor_version: 0,
-      patch_version: 0,
+    const first = ProtocolV2.encodeFrame(schemas, 'ProtocolInfo', {
+      version: 1,
+      supported_messages: [],
     });
     const second = ProtocolV2.encodeFrame(schemas, 'Success', { message: 'ok' });
     const third = ProtocolV2.encodeFrame(schemas, 'Success', { message: 'last' });
@@ -714,6 +863,26 @@ describe('Protocol V2 framing and session', () => {
     expect(decoded.type).toBe('ButtonRequest');
   });
 
+  test('decodes legacy V1 Failure as a Protocol V2 fallback', () => {
+    // Some device-side rejection paths still return legacy Failure(type=3)
+    // inside a Protocol V2 frame. It must surface as a device Failure, not as
+    // a protobuf catalog TypeError.
+    const frame = ProtocolV2.encodeFrame(
+      { ...schemas, protocolV2: schemas.protocolV1 },
+      'Failure',
+      {
+        code: 1,
+        message: 'Action cancelled',
+      }
+    );
+    const decoded = ProtocolV2.decodeFrame(schemas, frame);
+    expect(decoded.type).toBe('Failure');
+    expect(decoded.message).toEqual({
+      code: 1,
+      message: 'Action cancelled',
+    });
+  });
+
   test('does not fall back to legacy V1 messages outside the allowlist', () => {
     // OnekeyFeatures exists only in the V1 schema and is not allowlisted.
     const frame = protocolV2.encodeProtobufFrame(10026, new Uint8Array(0));
@@ -721,7 +890,6 @@ describe('Protocol V2 framing and session', () => {
   });
 
   test('hexToBytes converts valid hex and rejects malformed input', () => {
-    const { hexToBytes } = sessionModule;
     expect(hexToBytes('5a0102')).toEqual(new Uint8Array([0x5a, 0x01, 0x02]));
     expect(hexToBytes('')).toEqual(new Uint8Array(0));
     expect(() => hexToBytes('abc')).toThrow('Invalid hex string: odd length');
@@ -729,7 +897,7 @@ describe('Protocol V2 framing and session', () => {
   });
 
   test('probeProtocolV2 only uses Ping for acquire probing', async () => {
-    const call = jest.fn().mockRejectedValue(new Error('ping timeout'));
+    const call = jest.fn().mockRejectedValue(new Error('Ping timeout'));
     const onProbeFailed = jest.fn();
 
     await expect(
@@ -742,7 +910,7 @@ describe('Protocol V2 framing and session', () => {
     expect(call).toHaveBeenNthCalledWith(
       1,
       'Ping',
-      { message: 'probe' },
+      { message: 'protocol-v2-probe' },
       {
         timeoutMs: 1,
         expectedTypes: ['Success'],

package/dist/constants.d.ts

@@ -5,9 +5,11 @@ export declare const PROTOCOL_V1_USB_PACKET_SIZE: number;
 export declare const PROTOCOL_V1_MESSAGE_HEADER_SIZE: number;
 export declare const PROTOCOL_V1_ENVELOPE_HEADER_SIZE: number;
 export declare const PROTOCOL_V2_FRAME_MAX_BYTES = 4608;
-export declare const PROTOCOL_V2_WEBUSB_FILE_CHUNK_SIZE = 4096;
+export declare const PROTOCOL_V2_WEBUSB_FILE_CHUNK_SIZE = 4000;
 export declare const PROTOCOL_V2_BLE_FILE_CHUNK_SIZE = 1800;
-export declare const PROTOCOL_V2_FILE_CHUNK_SIZE = 4096;
+export declare const PROTOCOL_V2_BLE_FILE_READ_CHUNK_SIZE = 900;
+export declare const PROTOCOL_V2_BLE_FRAME_MAX_BYTES = 2048;
+export declare const PROTOCOL_V2_FILE_CHUNK_SIZE = 4000;
 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;

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,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"}