@onekeyfe/hd-transport 1.2.0-alpha.8 → 1.2.0-alpha.9

package/__tests__/messages.test.js

@@ -3,6 +3,10 @@ const {
   createMessageFromType,
   parseConfigure,
 } = require('../src/serialization/protobuf/messages');
+const v1Messages = require('../messages.json');
+const v2Messages = require('../messages-protocol-v2.json');
+const coreV2Messages = require('../../core/src/data/messages/messages-protocol-v2.json');
+
 // const json = require('./data/messages.json');
 
 const json = {
@@ -58,6 +62,64 @@ const json = {
 };
 
 describe('messages', () => {
+  test('V1 GetPassphraseState includes attach-to-pin request flags', () => {
+    const { fields } = v1Messages.nested.GetPassphraseState;
+
+    expect(fields._only_main_pin).toMatchObject({ id: 2, type: 'bool' });
+    expect(fields.allow_create_attach_pin).toMatchObject({ id: 3, type: 'bool' });
+  });
+
+  test('Protocol V2 firmware targets match the current firmware-pro2 enum', () => {
+    expect(v2Messages.nested.DeviceFirmwareTargetType.values).toEqual({
+      FW_MGMT_TARGET_INVALID: 0,
+      FW_MGMT_TARGET_CRATE: 1,
+      FW_MGMT_TARGET_ROMLOADER: 2,
+      FW_MGMT_TARGET_BOOTLOADER: 3,
+      FW_MGMT_TARGET_APPLICATION_P1: 4,
+      FW_MGMT_TARGET_APPLICATION_P2: 5,
+      FW_MGMT_TARGET_COPROCESSOR: 6,
+      FW_MGMT_TARGET_SE01: 7,
+      FW_MGMT_TARGET_SE02: 8,
+      FW_MGMT_TARGET_SE03: 9,
+      FW_MGMT_TARGET_SE04: 10,
+    });
+  });
+
+  test('Protocol V2 device status and session messages match firmware-pro2', () => {
+    expect(v2Messages.nested.MessageType.values).toMatchObject({
+      MessageType_DeviceStatusGet: 60602,
+      MessageType_DeviceStatus: 60603,
+      MessageType_DeviceSessionGet: 60606,
+      MessageType_DeviceSession: 60607,
+    });
+    expect(v2Messages.nested.DeviceStatusGet).toEqual({ fields: {} });
+    expect(v2Messages.nested.DeviceSessionGet.fields.session_id).toMatchObject({
+      id: 1,
+      type: 'bytes',
+    });
+    expect(v2Messages.nested.DeviceSession.fields).toMatchObject({
+      session_id: { id: 1, type: 'bytes' },
+      btc_test_address: { id: 2, type: 'string' },
+    });
+  });
+
+  test('Protocol V2 temporarily restores unlock ids without restoring old passphrase ids', () => {
+    expect(v2Messages.nested.MessageType.values).toMatchObject({
+      MessageType_UnLockDevice: 10030,
+      MessageType_UnLockDeviceResponse: 10031,
+    });
+    expect(v2Messages.nested.MessageType.values).not.toHaveProperty(
+      'MessageType_GetPassphraseState'
+    );
+    expect(v2Messages.nested.MessageType.values).not.toHaveProperty('MessageType_PassphraseState');
+    expect(v2Messages.nested.UnLockDevice).toBeDefined();
+    expect(v2Messages.nested.UnLockDeviceResponse).toBeDefined();
+  });
+
+  test('Protocol V2 transport and core schemas stay identical', () => {
+    expect(coreV2Messages).toEqual(v2Messages);
+  });
+
   test('createMessageFromName (common case)', () => {
     const messages = parseConfigure(json);
     const name = 'Initialize';

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

@@ -0,0 +1,326 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+const { ProtocolV2, ProtocolV2LinkManager } = require('../src');
+const { parseConfigure } = require('../src/serialization/protobuf/messages');
+const protocolV2 = require('../src/protocols/v2');
+
+const protocolV1Messages = parseConfigure({
+  nested: {
+    Failure: {
+      fields: {
+        code: { type: 'uint32', id: 1 },
+        message: { type: 'string', id: 2 },
+      },
+    },
+    MessageType: {
+      values: {
+        MessageType_Failure: 3,
+      },
+    },
+  },
+});
+
+const protocolV2Messages = parseConfigure({
+  nested: {
+    Ping: {
+      fields: {
+        message: { type: 'string', id: 1 },
+      },
+    },
+    Success: {
+      fields: {
+        message: { type: 'string', id: 1 },
+      },
+    },
+    MessageType: {
+      values: {
+        MessageType_Ping: 60206,
+        MessageType_Success: 60207,
+      },
+    },
+  },
+});
+
+const schemas = {
+  protocolV1: protocolV1Messages,
+  protocolV2: protocolV2Messages,
+};
+
+const rewriteSeq = (frame, seq) => {
+  const copy = new Uint8Array(frame);
+  copy[6] = seq;
+  copy[copy.length - 1] = protocolV2.crc8(copy, copy.length - 1);
+  return copy;
+};
+
+const createAdapterFactory = sentSeqs => {
+  const adapters = [];
+  let generation = 0;
+  const success = ProtocolV2.encodeFrame(schemas, 'Success', { message: 'ok' });
+
+  return {
+    adapters,
+    createAdapter: () => {
+      let requestSeq = 0;
+      const adapter = {
+        router: 1,
+        generation: ++generation,
+        prepareCall: jest.fn(),
+        writeFrame: jest.fn(frame => {
+          const [, , , , , , seq] = frame;
+          requestSeq = seq;
+          sentSeqs.push(requestSeq);
+          return Promise.resolve();
+        }),
+        readFrame: jest.fn(() => Promise.resolve(rewriteSeq(success, requestSeq))),
+        reset: jest.fn(() => Promise.resolve()),
+      };
+      adapters.push(adapter);
+      return adapter;
+    },
+  };
+};
+
+describe('ProtocolV2LinkManager', () => {
+  test('retains the device sequence cursor when an active link is rebuilt', async () => {
+    const sentSeqs = [];
+    const { adapters, createAdapter } = createAdapterFactory(sentSeqs);
+    const manager = new ProtocolV2LinkManager({
+      getSchemas: () => schemas,
+      classifyError: () => 'recoverable',
+    });
+
+    await manager.call('device-a', createAdapter, 'Ping', { message: '1' });
+    await manager.invalidateLink('device-a', 'reconnect');
+    await manager.call('device-a', createAdapter, 'Ping', { message: '2' });
+
+    expect(sentSeqs).toEqual([1, 2]);
+    expect(adapters).toHaveLength(2);
+    expect(adapters[0].reset).toHaveBeenCalledWith('reconnect');
+  });
+
+  test('prepares the active adapter with the same call context used for frame IO', async () => {
+    const sentSeqs = [];
+    const { adapters, createAdapter } = createAdapterFactory(sentSeqs);
+    const manager = new ProtocolV2LinkManager({
+      getSchemas: () => schemas,
+      classifyError: () => 'recoverable',
+    });
+
+    await manager.call('device-a', createAdapter, 'Ping', { message: '1' }, { timeoutMs: 123 });
+
+    expect(adapters[0].prepareCall).toHaveBeenCalledWith({
+      messageName: 'Ping',
+      timeoutMs: 123,
+      highVolume: false,
+      generation: 1,
+    });
+  });
+
+  test('invalidates a link-fatal call before the next call creates a new link', async () => {
+    const sentSeqs = [];
+    const onLinkInvalidated = jest.fn();
+    const { adapters, createAdapter: createWorkingAdapter } = createAdapterFactory(sentSeqs);
+    const createAdapter = jest
+      .fn()
+      .mockImplementationOnce(() => {
+        const adapter = createWorkingAdapter();
+        adapter.writeFrame.mockImplementationOnce(frame => {
+          sentSeqs.push(frame[6]);
+          return Promise.reject(new Error('transport write failed'));
+        });
+        return adapter;
+      })
+      .mockImplementation(() => createWorkingAdapter());
+    const manager = new ProtocolV2LinkManager({
+      getSchemas: () => schemas,
+      classifyError: () => 'link-fatal',
+      onLinkInvalidated,
+    });
+
+    await expect(manager.call('device-a', createAdapter, 'Ping', { message: '1' })).rejects.toThrow(
+      'transport write failed'
+    );
+    await expect(
+      manager.call('device-a', createAdapter, 'Ping', { message: '2' })
+    ).resolves.toEqual({
+      type: 'Success',
+      message: { message: 'ok' },
+    });
+
+    expect(createAdapter).toHaveBeenCalledTimes(2);
+    expect(adapters[0].reset).toHaveBeenCalledWith(
+      expect.stringContaining('transport write failed')
+    );
+    expect(onLinkInvalidated).toHaveBeenCalledWith(
+      'device-a',
+      expect.stringContaining('transport write failed')
+    );
+    expect(sentSeqs).toEqual([1, 2]);
+  });
+
+  test('invalidates every active link while retaining per-device cursors', async () => {
+    const sentSeqs = [];
+    const { adapters, createAdapter } = createAdapterFactory(sentSeqs);
+    const manager = new ProtocolV2LinkManager({
+      getSchemas: () => schemas,
+      classifyError: () => 'recoverable',
+    });
+
+    await manager.call('device-a', createAdapter, 'Ping', { message: 'a1' });
+    await manager.call('device-b', createAdapter, 'Ping', { message: 'b1' });
+    await manager.invalidateAllLinks('schema changed');
+    await manager.call('device-a', createAdapter, 'Ping', { message: 'a2' });
+    await manager.call('device-b', createAdapter, 'Ping', { message: 'b2' });
+
+    expect(sentSeqs).toEqual([1, 1, 2, 2]);
+    expect(adapters).toHaveLength(4);
+    expect(adapters[0].reset).toHaveBeenCalledWith('schema changed');
+    expect(adapters[1].reset).toHaveBeenCalledWith('schema changed');
+  });
+
+  test('dispose clears active links and sequence cursors', async () => {
+    const sentSeqs = [];
+    const { adapters, createAdapter } = createAdapterFactory(sentSeqs);
+    const manager = new ProtocolV2LinkManager({
+      getSchemas: () => schemas,
+      classifyError: () => 'recoverable',
+    });
+
+    await manager.call('device-a', createAdapter, 'Ping', { message: '1' });
+    await manager.dispose('transport disposed');
+    await manager.call('device-a', createAdapter, 'Ping', { message: '2' });
+
+    expect(sentSeqs).toEqual([1, 1]);
+    expect(adapters[0].reset).toHaveBeenCalledWith('transport disposed');
+  });
+
+  test('serializes calls per device without blocking another device', async () => {
+    const events = [];
+    let releaseDeviceA;
+    const deviceABlocked = new Promise(resolve => {
+      releaseDeviceA = resolve;
+    });
+    const success = ProtocolV2.encodeFrame(schemas, 'Success', { message: 'ok' });
+    const createAdapter = key => {
+      let requestSeq = 0;
+      return {
+        router: 1,
+        generation: 1,
+        prepareCall: jest.fn(),
+        writeFrame: jest.fn(frame => {
+          const [, , , , , , seq] = frame;
+          requestSeq = seq;
+          events.push(`write:${key}:${requestSeq}`);
+          return Promise.resolve();
+        }),
+        readFrame: jest.fn(async () => {
+          if (key === 'device-a' && requestSeq === 1) {
+            await deviceABlocked;
+          }
+          events.push(`read:${key}:${requestSeq}`);
+          return rewriteSeq(success, requestSeq);
+        }),
+        reset: jest.fn(),
+      };
+    };
+    const manager = new ProtocolV2LinkManager({
+      getSchemas: () => schemas,
+      classifyError: () => 'recoverable',
+    });
+
+    const firstA = manager.call('device-a', () => createAdapter('device-a'), 'Ping', {
+      message: 'a1',
+    });
+    const secondA = manager.call('device-a', () => createAdapter('device-a'), 'Ping', {
+      message: 'a2',
+    });
+    const firstB = manager.call('device-b', () => createAdapter('device-b'), 'Ping', {
+      message: 'b1',
+    });
+
+    await firstB;
+    expect(events).toEqual(['write:device-a:1', 'write:device-b:1', 'read:device-b:1']);
+    releaseDeviceA();
+    await Promise.all([firstA, secondA]);
+    expect(events).toEqual([
+      'write:device-a:1',
+      'write:device-b:1',
+      'read:device-b:1',
+      'read:device-a:1',
+      'write:device-a:2',
+      'read:device-a:2',
+    ]);
+  });
+
+  test('keeps a recoverable link after a call error', async () => {
+    const sentSeqs = [];
+    const { adapters, createAdapter } = createAdapterFactory(sentSeqs);
+    const manager = new ProtocolV2LinkManager({
+      getSchemas: () => schemas,
+      classifyError: () => 'recoverable',
+    });
+    const adapter = createAdapter();
+    adapter.writeFrame.mockImplementationOnce(frame => {
+      sentSeqs.push(frame[6]);
+      return Promise.reject(new Error('application retryable error'));
+    });
+    const factory = jest.fn(() => adapter);
+
+    await expect(manager.call('device-a', factory, 'Ping', { message: '1' })).rejects.toThrow(
+      'application retryable error'
+    );
+    await manager.call('device-a', factory, 'Ping', { message: '2' });
+
+    expect(factory).toHaveBeenCalledTimes(1);
+    expect(adapter.reset).not.toHaveBeenCalled();
+    expect(sentSeqs).toEqual([1, 2]);
+  });
+
+  test('removes a settled per-device call queue', async () => {
+    const sentSeqs = [];
+    const { createAdapter } = createAdapterFactory(sentSeqs);
+    const manager = new ProtocolV2LinkManager({
+      getSchemas: () => schemas,
+      classifyError: () => 'recoverable',
+    });
+
+    await manager.call('device-a', createAdapter, 'Ping', { message: 'done' });
+
+    expect(manager.callQueues.size).toBe(0);
+  });
+
+  test('stops an in-flight call before reading when its link is invalidated during write', 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' });
+    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 manager = new ProtocolV2LinkManager({
+      getSchemas: () => schemas,
+      classifyError: () => 'recoverable',
+    });
+
+    const call = manager.call('device-a', () => adapter, 'Ping', { message: 'pending' });
+    await writeStarted;
+    await manager.invalidateLink('device-a', 'device disconnected');
+    releaseWrite();
+
+    await expect(call).rejects.toThrow('device disconnected');
+    expect(adapter.readFrame).not.toHaveBeenCalled();
+  });
+});

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

@@ -0,0 +1,296 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+const {
+  PROTOCOL_V2_CHANNEL_USB,
+  PROTOCOL_V2_FRAME_MAX_BYTES,
+  ProtocolV2,
+  ProtocolV2UsbTransportBase,
+} = require('../src');
+const { parseConfigure } = require('../src/serialization/protobuf/messages');
+
+const protocolV1Messages = parseConfigure({
+  nested: {
+    Failure: {
+      fields: {
+        code: { type: 'uint32', id: 1 },
+        message: { type: 'string', id: 2 },
+      },
+    },
+    MessageType: {
+      values: {
+        MessageType_Failure: 3,
+      },
+    },
+  },
+});
+
+const protocolV2Messages = parseConfigure({
+  nested: {
+    Ping: {
+      fields: {
+        message: { type: 'string', id: 1 },
+      },
+    },
+    Success: {
+      fields: {
+        message: { type: 'string', id: 1 },
+      },
+    },
+    MessageType: {
+      values: {
+        MessageType_Ping: 60206,
+        MessageType_Success: 60207,
+      },
+    },
+  },
+});
+
+const schemas = {
+  protocolV1: protocolV1Messages,
+  protocolV2: protocolV2Messages,
+};
+
+class FakeUsbTransport extends ProtocolV2UsbTransportBase {
+  constructor() {
+    super({
+      router: PROTOCOL_V2_CHANNEL_USB,
+      maxFrameBytes: PROTOCOL_V2_FRAME_MAX_BYTES,
+      logPrefix: 'ProtocolV2 FakeUSB',
+    });
+    this.sentSeqs = [];
+    this.readContexts = [];
+    this.readCounts = new Map();
+    this.packetQueues = new Map();
+    this.nativeResets = [];
+    this.invalidations = [];
+    this.nextReadError = undefined;
+    this.writeBlock = undefined;
+    this.readBlock = undefined;
+  }
+
+  callDevice(key, message, timeoutMs) {
+    return this.callProtocolV2Usb(
+      key,
+      'Ping',
+      { message },
+      timeoutMs === undefined ? undefined : { timeoutMs }
+    );
+  }
+
+  rotate(key, reason = 'USB connection rotated') {
+    return this.rotateProtocolV2UsbGeneration(key, reason);
+  }
+
+  invalidate(key, reason) {
+    return this.invalidateProtocolV2UsbLink(key, reason);
+  }
+
+  dispose(reason) {
+    return this.disposeProtocolV2UsbLinks(reason);
+  }
+
+  failNextRead(error) {
+    this.nextReadError = error;
+  }
+
+  blockNextWrite() {
+    let release;
+    let markStarted;
+    const started = new Promise(resolve => {
+      markStarted = resolve;
+    });
+    const blocked = new Promise(resolve => {
+      release = resolve;
+    });
+    this.writeBlock = { blocked, markStarted };
+    return { started, release };
+  }
+
+  blockNextRead() {
+    let release;
+    let markStarted;
+    const started = new Promise(resolve => {
+      markStarted = resolve;
+    });
+    const blocked = new Promise(resolve => {
+      release = resolve;
+    });
+    this.readBlock = { blocked, markStarted };
+    return { started, release };
+  }
+
+  getProtocolV2UsbSchemas() {
+    return schemas;
+  }
+
+  getProtocolV2UsbLogger() {
+    return undefined;
+  }
+
+  async writeProtocolV2UsbPacket(key, frame) {
+    const seq = frame[6];
+    this.sentSeqs.push([key, seq]);
+    const response = ProtocolV2.encodeFrame(
+      schemas,
+      'Success',
+      { 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)]);
+
+    const block = this.writeBlock;
+    if (block) {
+      this.writeBlock = undefined;
+      block.markStarted();
+      await block.blocked;
+    }
+  }
+
+  readProtocolV2UsbPacket(key, context) {
+    this.readContexts.push([key, context.timeoutMs]);
+    this.readCounts.set(key, Number(this.readCounts.get(key) ?? 0) + 1);
+    if (this.nextReadError) {
+      const error = this.nextReadError;
+      this.nextReadError = undefined;
+      return Promise.reject(error);
+    }
+    const readPacket = async () => {
+      const block = this.readBlock;
+      if (block) {
+        this.readBlock = undefined;
+        block.markStarted();
+        await block.blocked;
+      }
+      const packet = this.packetQueues.get(key)?.shift();
+      if (!packet) throw new Error(`No queued USB packet for ${key}`);
+      return packet;
+    };
+    return readPacket();
+  }
+
+  resetProtocolV2UsbNativeLink(key, reason) {
+    this.nativeResets.push([key, reason]);
+    return Promise.resolve();
+  }
+
+  onProtocolV2UsbLinkInvalidated(key, reason) {
+    this.invalidations.push([key, reason]);
+  }
+
+  createProtocolV2UsbTimeoutError(name, timeoutMs) {
+    return new Error(`USB timeout after ${timeoutMs}ms for ${name}`);
+  }
+}
+
+describe('ProtocolV2UsbTransportBase', () => {
+  test('keeps seq across USB generation rotation', async () => {
+    const transport = new FakeUsbTransport();
+
+    await transport.rotate('device-a');
+    await transport.callDevice('device-a', 'first');
+    await transport.rotate('device-a', 'USB reconnected');
+    await transport.callDevice('device-a', 'second');
+
+    expect(transport.sentSeqs).toEqual([
+      ['device-a', 1],
+      ['device-a', 2],
+    ]);
+    expect(transport.nativeResets).toEqual([['device-a', 'USB reconnected']]);
+  });
+
+  test('passes each queued call its own timeout context', async () => {
+    const transport = new FakeUsbTransport();
+    await transport.rotate('device-a');
+
+    await Promise.all([
+      transport.callDevice('device-a', 'first', 111),
+      transport.callDevice('device-a', 'second', 222),
+    ]);
+
+    expect(transport.readContexts).toEqual([
+      ['device-a', 111],
+      ['device-a', 111],
+      ['device-a', 222],
+      ['device-a', 222],
+    ]);
+  });
+
+  test('does not block a different USB path', async () => {
+    const transport = new FakeUsbTransport();
+    await transport.rotate('device-a');
+    await transport.rotate('device-b');
+    const blockedWrite = transport.blockNextWrite();
+
+    const callA = transport.callDevice('device-a', 'blocked');
+    await blockedWrite.started;
+    await expect(transport.callDevice('device-b', 'parallel')).resolves.toMatchObject({
+      type: 'Success',
+    });
+    blockedWrite.release();
+    await expect(callA).resolves.toMatchObject({ type: 'Success' });
+  });
+
+  test('invalidates an in-flight generation before it can read', async () => {
+    const transport = new FakeUsbTransport();
+    await transport.rotate('device-a');
+    const blockedWrite = transport.blockNextWrite();
+
+    const call = transport.callDevice('device-a', 'blocked');
+    await blockedWrite.started;
+    await transport.rotate('device-a', 'USB generation changed');
+    blockedWrite.release();
+
+    await expect(call).rejects.toThrow('USB generation changed');
+    expect(transport.readCounts.get('device-a') ?? 0).toBe(0);
+  });
+
+  test('rejects an in-flight packet read without waiting for native IO to settle', async () => {
+    const transport = new FakeUsbTransport();
+    await transport.rotate('device-a');
+    const blockedRead = transport.blockNextRead();
+
+    const call = transport.callDevice('device-a', 'blocked-read', 5000);
+    const outcome = call.then(
+      () => 'resolved',
+      error => error.message
+    );
+    await blockedRead.started;
+    await transport.invalidate('device-a', 'USB transport released');
+    const settled = await Promise.race([
+      outcome,
+      new Promise(resolve => {
+        setTimeout(() => resolve('still pending'), 50);
+      }),
+    ]);
+    blockedRead.release();
+
+    expect(settled).toContain('USB transport released');
+  });
+
+  test('invalidates the native link after a packet read failure', async () => {
+    const transport = new FakeUsbTransport();
+    await transport.rotate('device-a');
+    transport.failNextRead(new Error('USB transfer failed'));
+
+    await expect(transport.callDevice('device-a', 'failure')).rejects.toThrow(
+      'USB transfer failed'
+    );
+    expect(transport.nativeResets).toEqual([
+      ['device-a', expect.stringContaining('USB transfer failed')],
+    ]);
+    expect(transport.invalidations).toEqual([
+      ['device-a', expect.stringContaining('USB transfer failed')],
+    ]);
+  });
+
+  test('dispose clears the cursor and restarts seq from one', async () => {
+    const transport = new FakeUsbTransport();
+    await transport.rotate('device-a');
+    await transport.callDevice('device-a', 'before-dispose');
+    await transport.dispose('transport disposed');
+    await transport.rotate('device-a');
+    await transport.callDevice('device-a', 'after-dispose');
+
+    expect(transport.sentSeqs.map(([, seq]) => seq)).toEqual([1, 1]);
+  });
+});