xref: /expo/packages/@expo/cli/src/run/ios/appleDevice/protocol/UsbmuxProtocol.ts (revision c4ef02ae)

/**
 * Copyright (c) 2021 Expo, Inc.
 * Copyright (c) 2018 Drifty Co.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

import plist from '@expo/plist';
import Debug from 'debug';
import { Socket } from 'net';

import type { ProtocolWriter } from './AbstractProtocol';
import { PlistProtocolReader, ProtocolClient, ProtocolReaderFactory } from './AbstractProtocol';

const debug = Debug('expo:apple-device:protocol:usbmux');

export const USBMUXD_HEADER_SIZE = 16;

export interface UsbmuxMessage {
  messageType: string;
  extraFields?: { [key: string]: any };
}

export class UsbmuxProtocolClient extends ProtocolClient<UsbmuxMessage> {
  constructor(socket: Socket) {
    super(socket, new ProtocolReaderFactory(UsbmuxProtocolReader), new UsbmuxProtocolWriter());
  }
}

export class UsbmuxProtocolReader extends PlistProtocolReader {
  constructor(callback: (data: any) => any) {
    super(USBMUXD_HEADER_SIZE, callback);
  }

  parseHeader(data: Buffer) {
    return data.readUInt32LE(0) - USBMUXD_HEADER_SIZE;
  }

  parseBody(data: Buffer) {
    const resp = super.parseBody(data);
    debug(`Response: ${JSON.stringify(resp)}`);
    return resp;
  }
}

export class UsbmuxProtocolWriter implements ProtocolWriter {
  private useTag = 0;

  write(socket: Socket, msg: UsbmuxMessage) {
    // TODO Usbmux message type
    debug(`socket write: ${JSON.stringify(msg)}`);
    const { messageType, extraFields } = msg;
    const plistMessage = plist.build({
      BundleID: 'dev.expo.native-run', // TODO
      ClientVersionString: 'usbmux.js', // TODO
      MessageType: messageType,
      ProgName: 'native-run', // TODO
      kLibUSBMuxVersion: 3,
      ...extraFields,
    });

    const dataSize = plistMessage ? plistMessage.length : 0;
    const protocolVersion = 1;
    const messageCode = 8;

    const header = Buffer.alloc(USBMUXD_HEADER_SIZE);
    header.writeUInt32LE(USBMUXD_HEADER_SIZE + dataSize, 0);
    header.writeUInt32LE(protocolVersion, 4);
    header.writeUInt32LE(messageCode, 8);
    header.writeUInt32LE(this.useTag++, 12); // TODO
    socket.write(header);
    socket.write(plistMessage);
  }
}