@onekeyfe/hd-transport-lowlevel 1.2.0-alpha.1 → 1.2.0-alpha.100

package/__tests__/firmware-upload-progress.test.js

@@ -0,0 +1,42 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+const { getProtocolV1SendOptions, shouldLogFirmwareUploadProgress } = require('../src');
+
+describe('firmware upload progress logging', () => {
+  test('按 5% 进度限流打印', () => {
+    expect(
+      shouldLogFirmwareUploadProgress({
+        percent: 9,
+        lastLoggedPercent: 5,
+        now: 5_000,
+        lastLoggedAt: 0,
+      })
+    ).toBe(false);
+
+    expect(
+      shouldLogFirmwareUploadProgress({
+        percent: 10,
+        lastLoggedPercent: 5,
+        now: 5_000,
+        lastLoggedAt: 0,
+      })
+    ).toBe(true);
+  });
+
+  test('进度不足 5% 时最长每 10 秒打印一次心跳', () => {
+    expect(
+      shouldLogFirmwareUploadProgress({
+        percent: 7,
+        lastLoggedPercent: 5,
+        now: 10_000,
+        lastLoggedAt: 0,
+      })
+    ).toBe(true);
+  });
+});
+
+describe('firmware upload write mode', () => {
+  test('固件上传使用带响应写入，普通命令保持默认模式', () => {
+    expect(getProtocolV1SendOptions('FirmwareUpload')).toEqual({ withoutResponse: false });
+    expect(getProtocolV1SendOptions('Initialize')).toBeUndefined();
+  });
+});

package/__tests__/protocol-v2.test.js

@@ -29,21 +29,25 @@ const protocolV1Schema = {
 
 const protocolV2Schema = {
   nested: {
-    GetProtoVersion: {
+    ProtocolInfoRequest: {
       fields: {},
     },
-    ProtoVersion: {
+    ProtocolInfo: {
       fields: {
-        major_version: {
+        version: {
           type: 'uint32',
           id: 1,
         },
-        minor_version: {
+        supported_messages: {
+          rule: 'repeated',
           type: 'uint32',
           id: 2,
+          options: {
+            packed: false,
+          },
         },
-        patch_version: {
-          type: 'uint32',
+        protobuf_definition: {
+          type: 'string',
           id: 3,
         },
       },
@@ -66,8 +70,8 @@ const protocolV2Schema = {
     },
     MessageType: {
       values: {
-        MessageType_GetProtoVersion: 60200,
-        MessageType_ProtoVersion: 60201,
+        MessageType_ProtocolInfoRequest: 60200,
+        MessageType_ProtocolInfo: 60201,
         MessageType_Ping: 60206,
         MessageType_Success: 60207,
       },
@@ -118,6 +122,49 @@ 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);
+    lowlevel.protocolV2Links.invalidateAllLinks = invalidateAllLinks;
+
+    lowlevel.configureProtocolV2(protocolV2Schema);
+    lowlevel.configureProtocolV2(protocolV2Schema);
+
+    expect(invalidateAllLinks).not.toHaveBeenCalled();
+
+    lowlevel.configureProtocolV2({
+      nested: {
+        ...protocolV2Schema.nested,
+        ExtraMessage: { fields: {} },
+      },
+    });
+
+    expect(invalidateAllLinks).toHaveBeenCalledWith('Protocol V2 schema reconfigured');
+  });
+
   test('keeps Protocol V1 raw notification chunks compatible', async () => {
     const responseChunks = ProtocolV1.encodeTransportPackets(schemas.protocolV1, 'Success', {
       message: 'ok',
@@ -138,6 +185,23 @@ describe('LowlevelTransport protocol framing', () => {
     });
   });
 
+  test('uses the Protocol V2 BLE writer with the lowlevel compatibility packet size', async () => {
+    const plugin = createPlugin({ devices: [], responses: [] });
+    const lowlevel = configureTransport(plugin);
+    const context = {
+      messageName: 'Ping',
+      timeoutMs: 1000,
+      highThroughput: false,
+      generation: 1,
+      signal: new AbortController().signal,
+    };
+
+    await lowlevel.writeProtocolV2Frame('pro2-id', new Uint8Array(130), context, jest.fn());
+
+    expect(plugin.send).toHaveBeenCalledTimes(3);
+    expect(plugin.send.mock.calls.map(([, hex]) => hex.length / 2)).toEqual([64, 64, 2]);
+  });
+
   test('rejects calls before protocol detection', async () => {
     const responseChunks = ProtocolV1.encodeTransportPackets(schemas.protocolV1, 'Success', {
       message: 'ok',
@@ -162,13 +226,13 @@ describe('LowlevelTransport protocol framing', () => {
     );
     const callResponse = ProtocolV2.encodeFrame(
       schemas,
-      'ProtoVersion',
+      'ProtocolInfo',
       {
-        major_version: 2,
-        minor_version: 1,
-        patch_version: 3,
+        version: 1,
+        supported_messages: [60200, 60201, 60206, 60207],
+        protobuf_definition: 'onekey-protocol-v2',
       },
-      { router: PROTOCOL_V2_CHANNEL_BLE_UART }
+      { router: PROTOCOL_V2_CHANNEL_BLE_UART, seq: 2 }
     );
     const plugin = createPlugin({
       devices: [{ id: 'pro2-id', name: 'OneKey Pro 2', commType: 'ble' }],
@@ -183,15 +247,19 @@ describe('LowlevelTransport protocol framing', () => {
       uuid: 'pro2-id',
       protocolType: 'V2',
     });
-    await expect(lowlevel.call('pro2-id', 'GetProtoVersion', {})).resolves.toEqual({
-      type: 'ProtoVersion',
+    await expect(lowlevel.call('pro2-id', 'ProtocolInfoRequest', {})).resolves.toEqual({
+      type: 'ProtocolInfo',
       message: {
-        major_version: 2,
-        minor_version: 1,
-        patch_version: 3,
+        version: 1,
+        supported_messages: [60200, 60201, 60206, 60207],
+        protobuf_definition: 'onekey-protocol-v2',
       },
     });
     expect(plugin.send).toHaveBeenCalled();
+    const sentSeqs = plugin.send.mock.calls.map(([, hex]) =>
+      Number.parseInt(hex.slice(12, 14), 16)
+    );
+    expect(sentSeqs).toEqual([1, 2]);
   });
 
   test('falls back to Protocol V2 probe for unnamed Protocol V2 devices', async () => {
@@ -214,6 +282,97 @@ describe('LowlevelTransport protocol framing', () => {
     expect(lowlevel.getProtocolType('unknown-pro2-id')).toBe('V2');
   });
 
+  test('retains the Protocol V2 hint and sequence cursor across release and reacquire', async () => {
+    const probeResponse = ProtocolV2.encodeFrame(
+      schemas,
+      'Success',
+      { message: 'ok' },
+      { router: PROTOCOL_V2_CHANNEL_BLE_UART }
+    );
+    const plugin = createPlugin({
+      devices: [{ id: 'reconnect-pro2-id', name: 'OneKey Pro 2', commType: 'ble' }],
+      responses: [bytesToHex(probeResponse), bytesToHex(probeResponse)],
+    });
+    const lowlevel = configureTransport(plugin);
+
+    await lowlevel.enumerate();
+    await expect(lowlevel.acquire({ uuid: 'reconnect-pro2-id' })).resolves.toEqual({
+      uuid: 'reconnect-pro2-id',
+      protocolType: 'V2',
+    });
+    await lowlevel.release('reconnect-pro2-id');
+    await expect(lowlevel.acquire({ uuid: 'reconnect-pro2-id' })).resolves.toEqual({
+      uuid: 'reconnect-pro2-id',
+      protocolType: 'V2',
+    });
+
+    const sentSeqs = plugin.send.mock.calls.map(([, hex]) =>
+      Number.parseInt(hex.slice(12, 14), 16)
+    );
+    expect(sentSeqs).toEqual([1, 2]);
+  });
+
+  test('reuses the active generation when Core acquires the same BLE connection again', async () => {
+    const responses = [1, 2, 3, 4].map(seq =>
+      bytesToHex(
+        ProtocolV2.encodeFrame(
+          schemas,
+          'Success',
+          { message: 'ok' },
+          { router: PROTOCOL_V2_CHANNEL_BLE_UART, seq }
+        )
+      )
+    );
+    const plugin = createPlugin({
+      devices: [{ id: 'repeated-acquire-id', name: 'OneKey Pro 2', commType: 'ble' }],
+      responses,
+    });
+    const lowlevel = configureTransport(plugin);
+
+    await expect(
+      lowlevel.acquire({ uuid: 'repeated-acquire-id', expectedProtocol: 'V2' })
+    ).resolves.toEqual({
+      uuid: 'repeated-acquire-id',
+      protocolType: 'V2',
+    });
+    await lowlevel.call('repeated-acquire-id', 'Ping', { message: 'first-acquire' });
+    await expect(
+      lowlevel.acquire({ uuid: 'repeated-acquire-id', expectedProtocol: 'V2' })
+    ).resolves.toEqual({
+      uuid: 'repeated-acquire-id',
+      protocolType: 'V2',
+    });
+    await lowlevel.call('repeated-acquire-id', 'Ping', { message: 'second-acquire' });
+
+    const sentSeqs = plugin.send.mock.calls.map(([, hex]) =>
+      Number.parseInt(hex.slice(12, 14), 16)
+    );
+    expect(sentSeqs).toEqual([1, 2, 3, 4]);
+  });
+
+  test('actively probes explicit Protocol V2 during bootloader reconnect', async () => {
+    const probeResponse = ProtocolV2.encodeFrame(
+      schemas,
+      'Success',
+      { message: 'ok' },
+      { router: PROTOCOL_V2_CHANNEL_BLE_UART }
+    );
+    const plugin = createPlugin({
+      devices: [{ id: 'bootloader-v2-id', name: 'OneKey Pro 2', commType: 'ble' }],
+      responses: [bytesToHex(probeResponse)],
+    });
+    const lowlevel = configureTransport(plugin);
+
+    await expect(
+      lowlevel.acquire({ uuid: 'bootloader-v2-id', expectedProtocol: 'V2' })
+    ).resolves.toEqual({
+      uuid: 'bootloader-v2-id',
+      protocolType: 'V2',
+    });
+    expect(plugin.send).toHaveBeenCalledTimes(1);
+    expect(plugin.receive).toHaveBeenCalledTimes(1);
+  });
+
   test('resets the lowlevel connection before probing Protocol V2 after a V1 timeout', async () => {
     const probeResponse = ProtocolV2.encodeFrame(
       schemas,
@@ -252,6 +411,57 @@ describe('LowlevelTransport protocol framing', () => {
     expect(plugin.connect).toHaveBeenCalledTimes(2);
   });
 
+  test('disconnects a tainted Protocol V2 link after a response timeout', async () => {
+    const probeResponse = ProtocolV2.encodeFrame(
+      schemas,
+      'Success',
+      { message: 'ok' },
+      { router: PROTOCOL_V2_CHANNEL_BLE_UART }
+    );
+    const plugin = createPlugin({
+      devices: [{ id: 'timeout-v2-id', name: 'OneKey Pro 2', commType: 'ble' }],
+      responses: [bytesToHex(probeResponse)],
+    });
+    let receiveCount = 0;
+    plugin.receive.mockImplementation(() => {
+      receiveCount += 1;
+      return receiveCount === 1
+        ? Promise.resolve(bytesToHex(probeResponse))
+        : new Promise(() => {});
+    });
+    const lowlevel = configureTransport(plugin);
+
+    await lowlevel.acquire({ uuid: 'timeout-v2-id', expectedProtocol: 'V2' });
+    plugin.disconnect.mockClear();
+    await expect(
+      lowlevel.call('timeout-v2-id', 'Ping', { message: 'timeout' }, { timeoutMs: 10 })
+    ).rejects.toThrow('Lowlevel response timeout after 10ms for Ping');
+
+    expect(plugin.disconnect).toHaveBeenCalledWith('timeout-v2-id');
+  });
+
+  test('preserves an undefined business timeout outside explicit probes', async () => {
+    const plugin = createPlugin({
+      devices: [{ id: 'v2-id', name: 'OneKey Pro 2', commType: 'ble' }],
+      responses: [],
+    });
+    const lowlevel = configureTransport(plugin);
+    lowlevel.deviceProtocol.set('v2-id', 'V2');
+    const linkCall = jest
+      .spyOn(lowlevel.protocolV2Links, 'call')
+      .mockResolvedValue({ type: 'Success', message: {} });
+
+    await lowlevel.call('v2-id', 'Ping', { message: 'no-business-timeout' });
+
+    expect(linkCall).toHaveBeenCalledWith(
+      'v2-id',
+      expect.any(Function),
+      'Ping',
+      { message: 'no-business-timeout' },
+      undefined
+    );
+  });
+
   test('verifies expected Protocol V1 instead of trusting the requested protocol', async () => {
     const plugin = createPlugin({
       devices: [{ id: 'v2-id', name: 'Unknown BLE Device', commType: 'ble' }],

package/dist/index.d.ts

@@ -5,8 +5,18 @@ import EventEmitter from 'events';
 type LowLevelAcquireInput = {
     uuid: string;
     expectedProtocol?: ProtocolType;
+    protocolHint?: ProtocolType;
 };
 
+declare function shouldLogFirmwareUploadProgress({ percent, lastLoggedPercent, now, lastLoggedAt, }: {
+    percent: number;
+    lastLoggedPercent: number;
+    now: number;
+    lastLoggedAt: number;
+}): boolean;
+declare function getProtocolV1SendOptions(name: string): {
+    withoutResponse: boolean;
+} | undefined;
 declare class LowlevelTransport {
     _messages: ReturnType<typeof transport__default.parseConfigure> | undefined;
     _messagesV2: ReturnType<typeof transport__default.parseConfigure> | undefined;
@@ -17,6 +27,10 @@ declare class LowlevelTransport {
     private deviceProtocol;
     private deviceProtocolHints;
     private protocolV2Assemblers;
+    private protocolV2Generations;
+    private connectedDevices;
+    private protocolV2Links;
+    private protocolV2SchemaConfiguration;
     getProtocolType(path: string): ProtocolType | undefined;
     init(logger: any, emitter: EventEmitter, plugin: LowlevelTransportSharedPlugin): void;
     configure(signedData: any): void;
@@ -43,7 +57,9 @@ declare class LowlevelTransport {
     private readProtocolV2Frame;
     private writeProtocolV2Frame;
     private callProtocolV2;
+    private createProtocolV2Adapter;
+    private advanceProtocolV2Generation;
     cancel(): void;
 }
 
-export { LowlevelTransport as default };
+export { LowlevelTransport as default, getProtocolV1SendOptions, shouldLogFirmwareUploadProgress };

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,OAAO,SAWN,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,YAAY,MAAM,QAAQ,CAAC;AACvC,OAAO,KAAK,EACV,cAAc,EACd,6BAA6B,EAC7B,YAAY,EACZ,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAqBpD,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,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;IAInC,MAAM;IAIA,SAAS;IAWT,OAAO,CAAC,KAAK,EAAE,oBAAoB;;;;IAuBnC,OAAO,CAAC,IAAI,EAAE,MAAM;IAapB,IAAI,CACR,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,CAAC,EAAE,oBAAoB;YAmClB,cAAc;IAuC5B,OAAO,CAAC,0BAA0B;IAOlC,OAAO,CAAC,2BAA2B;IAOnC,OAAO,CAAC,4BAA4B;IAOpC,OAAO,CAAC,kBAAkB;YAMZ,cAAc;YAsDd,yBAAyB;YA0BzB,eAAe;YAgBf,eAAe;YA6Bf,UAAU;YAUV,qBAAqB;YAmBrB,mBAAmB;YAqBnB,oBAAoB;YAOpB,cAAc;IAsC5B,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"}