flipper/desktop/flipper-server-core/src/devices/ServerDevice.tsx

/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @format
 */

import {DeviceDescription, DeviceLogEntry} from 'flipper-common';
import {FlipperServerImpl} from '../FlipperServerImpl';

export abstract class ServerDevice {
  readonly info: DeviceDescription;
  readonly flipperServer: FlipperServerImpl;
  connected = true;

  constructor(flipperServer: FlipperServerImpl, info: DeviceDescription) {
    this.flipperServer = flipperServer;
    this.info = info;
  }

  get serial(): string {
    return this.info.serial;
  }

  addLogEntry(entry: DeviceLogEntry) {
    this.flipperServer.emit('device-log', {
      serial: this.serial,
      entry,
    });
  }

  /**
   * The device might have no active connection
   */
  disconnect(): void {
    this.connected = false;
  }

  startLogging() {
    // to be subclassed
  }

  stopLogging() {
    // to be subclassed
  }

  async screenshotAvailable(): Promise<boolean> {
    return false;
  }

  screenshot(): Promise<Buffer> {
    return Promise.reject(
      new Error('No screenshot support for current device'),
    );
  }

  async screenCaptureAvailable(): Promise<boolean> {
    return false;
  }

  async startScreenCapture(_destination: string): Promise<void> {
    throw new Error('startScreenCapture not implemented on BaseDevice ');
  }

  async stopScreenCapture(): Promise<string> {
    throw new Error('stopScreenCapture not implemented on BaseDevice ');
  }

  async executeShell(_command: string): Promise<string> {
    throw new Error('executeShell not implemented on BaseDevice');
  }

  async forwardPort(_local: string, _remote: string): Promise<boolean> {
    throw new Error('forwardPort not implemented on BaseDevice');
  }

  async clearLogs(): Promise<void> {
    // no-op on most devices
  }

  async navigateToLocation(_location: string) {
    throw new Error('navigateLocation not implemented on BaseDevice');
  }
}