8cf182cc26
Summary: Expose executeShell explicitly through the device interface Reviewed By: jameslawson Differential Revision: D31055959 fbshipit-source-id: b14395d0783ede265c6ae39c397ea93a85a78336
111 lines
3.0 KiB
TypeScript
111 lines
3.0 KiB
TypeScript
/**
|
|
* 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 {SandyPluginDefinition} from './SandyPluginDefinition';
|
|
import {BasePluginInstance, BasePluginClient} from './PluginBase';
|
|
import {FlipperLib} from './FlipperLib';
|
|
import {Atom, ReadOnlyAtom} from '../state/atom';
|
|
import {DeviceOS, DeviceType} from '../types/server-types';
|
|
|
|
export type DeviceLogListener = (entry: DeviceLogEntry) => void;
|
|
|
|
export type DeviceLogEntry = {
|
|
readonly date: Date;
|
|
readonly type: LogLevel;
|
|
readonly message: string;
|
|
readonly pid: number;
|
|
readonly tid: number;
|
|
readonly app?: string;
|
|
readonly tag: string;
|
|
};
|
|
|
|
export type LogLevel =
|
|
| 'unknown'
|
|
| 'verbose'
|
|
| 'debug'
|
|
| 'info'
|
|
| 'warn'
|
|
| 'error'
|
|
| 'fatal';
|
|
|
|
export interface Device {
|
|
readonly realDevice: any; // TODO: temporarily, clean up T70688226
|
|
readonly isArchived: boolean;
|
|
readonly isConnected: boolean;
|
|
readonly os: DeviceOS;
|
|
readonly serial: string;
|
|
readonly deviceType: DeviceType;
|
|
onLogEntry(cb: DeviceLogListener): () => void;
|
|
executeShell(command: string): Promise<string>;
|
|
}
|
|
|
|
export type DevicePluginPredicate = (device: Device) => boolean;
|
|
|
|
export type DevicePluginFactory = (client: DevicePluginClient) => object;
|
|
|
|
export interface DevicePluginClient extends BasePluginClient {
|
|
/**
|
|
* opens a different plugin by id, optionally providing a deeplink to bring the plugin to a certain state
|
|
*/
|
|
selectPlugin(pluginId: string, deeplinkPayload?: unknown): void;
|
|
|
|
readonly isConnected: boolean;
|
|
readonly connected: ReadOnlyAtom<boolean>;
|
|
}
|
|
|
|
/**
|
|
* Wrapper interface around BaseDevice in Flipper
|
|
*/
|
|
export interface RealFlipperDevice {
|
|
os: DeviceOS;
|
|
serial: string;
|
|
isArchived: boolean;
|
|
connected: Atom<boolean>;
|
|
deviceType: DeviceType;
|
|
addLogListener(callback: DeviceLogListener): Symbol;
|
|
removeLogListener(id: Symbol): void;
|
|
executeShell(command: string): Promise<string>;
|
|
}
|
|
|
|
export class SandyDevicePluginInstance extends BasePluginInstance {
|
|
static is(thing: any): thing is SandyDevicePluginInstance {
|
|
return thing instanceof SandyDevicePluginInstance;
|
|
}
|
|
|
|
/** client that is bound to this instance */
|
|
readonly client: DevicePluginClient;
|
|
|
|
constructor(
|
|
flipperLib: FlipperLib,
|
|
definition: SandyPluginDefinition,
|
|
realDevice: RealFlipperDevice,
|
|
pluginKey: string,
|
|
initialStates?: Record<string, any>,
|
|
) {
|
|
super(flipperLib, definition, realDevice, pluginKey, initialStates);
|
|
this.client = {
|
|
...this.createBasePluginClient(),
|
|
selectPlugin(pluginId: string, deeplink?: unknown) {
|
|
flipperLib.selectPlugin(realDevice, null, pluginId, deeplink);
|
|
},
|
|
get isConnected() {
|
|
return realDevice.connected.get();
|
|
},
|
|
connected: realDevice.connected,
|
|
};
|
|
this.initializePlugin(() =>
|
|
definition.asDevicePluginModule().devicePlugin(this.client),
|
|
);
|
|
}
|
|
|
|
toJSON() {
|
|
return '[SandyDevicePluginInstance]';
|
|
}
|
|
}
|