Kill IPC rendering / connection

Summary:
Remove IPC rendering / connection implementation. This has been behind GK for a couple of weeks, and no one complained / white listed. See also D30367413.

flipper_js_client_emulator

Reviewed By: passy

Differential Revision: D30452442

fbshipit-source-id: fbe7b4914fecc023f3ec78a027106ea32c5a99bd
This commit is contained in:
Michel Weststrate
2021-09-01 03:18:40 -07:00
committed by Facebook GitHub Bot
parent 07e82aae9f
commit bd8912080b
11 changed files with 4 additions and 460 deletions

View File

@@ -1,108 +0,0 @@
/**
* 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 {Button} from '../ui';
import React, {Component} from 'react';
import {connect} from 'react-redux';
import {State as Store} from '../reducers';
import {launchJsEmulator} from '../server/devices/webapp/jsServerUtils';
import {updateSettings, Action} from '../reducers/settings';
import {Settings} from '../reducers/settings';
import {Collapse, Form, Input as AntInput} from 'antd';
import {Html5Outlined} from '@ant-design/icons';
type OwnProps = {
onHide: () => void;
};
type StateFromProps = {
settings: Settings;
};
type DispatchFromProps = {
updateSettings: (settings: Settings) => Action;
};
type State = {
url: string;
height: number;
width: number;
};
type Props = OwnProps & StateFromProps & DispatchFromProps;
class JSEmulatorLauncherSheet extends Component<Props, State> {
state: State = {...this.props.settings.jsApps.webAppLauncher};
applyChanges = async () => {
launchJsEmulator(this.state.url, this.state.height, this.state.width);
this.props.updateSettings({
...this.props.settings,
jsApps: {
webAppLauncher: {...this.state},
},
});
this.props.onHide();
};
onUrlChange = (e: React.ChangeEvent<HTMLInputElement>) => {
this.setState({url: e.target.value});
};
onHeightChange = (e: React.ChangeEvent<HTMLInputElement>) => {
this.setState({height: Number(e.target.value)});
};
onWidthChange = (e: React.ChangeEvent<HTMLInputElement>) => {
this.setState({width: Number(e.target.value)});
};
render() {
const {url, height, width} = this.state;
return (
<Form labelCol={{span: 4}}>
<Form.Item label="Url">
<AntInput value={url} onChange={this.onUrlChange} />
</Form.Item>
<Form.Item label="Height">
<AntInput value={height} onChange={this.onHeightChange} />
</Form.Item>
<Form.Item label="Width">
<AntInput value={width} onChange={this.onWidthChange} />
</Form.Item>
<Form.Item wrapperCol={{offset: 4}}>
<Button onClick={this.applyChanges} type="primary">
Launch
</Button>
</Form.Item>
</Form>
);
}
}
const Launcher = connect<StateFromProps, DispatchFromProps, OwnProps, Store>(
({settingsState}) => ({
settings: settingsState,
}),
{updateSettings},
)(JSEmulatorLauncherSheet);
export default Launcher;
export function JSEmulatorLauncherSheetSandy({onClose}: {onClose(): void}) {
return (
<Collapse>
<Collapse.Panel
extra={<Html5Outlined />}
header="Launch JS Web App"
key="launch-js-web-app">
<Launcher onHide={onClose} />
</Collapse.Panel>
</Collapse>
);
}

View File

@@ -12,7 +12,6 @@ import ShareSheetExportUrl from './ShareSheetExportUrl';
import SignInSheet from './fb-stubs/SignInSheet';
import ExportDataPluginSheet from './ExportDataPluginSheet';
import ShareSheetExportFile from './ShareSheetExportFile';
import JSEmulatorLauncherSheet from './JSEmulatorLauncherSheet';
import Sheet from './Sheet';
import {
ACTIVE_SHEET_PLUGINS,
@@ -23,7 +22,6 @@ import {
ACTIVE_SHEET_SHARE_DATA_IN_FILE,
ACTIVE_SHEET_SELECT_PLUGINS_TO_EXPORT,
ACTIVE_SHEET_PLUGIN_SHEET,
ACTIVE_SHEET_JS_EMULATOR_LAUNCHER,
ACTIVE_SHEET_CHANGELOG,
ACTIVE_SHEET_CHANGELOG_RECENT_ONLY,
} from '../reducers/application';
@@ -80,8 +78,6 @@ export function SheetRenderer({logger}: {logger: Logger}) {
case ACTIVE_SHEET_PLUGIN_SHEET:
// Currently unused.
return null;
case ACTIVE_SHEET_JS_EMULATOR_LAUNCHER:
return <JSEmulatorLauncherSheet onHide={onHide} />;
default:
return null;
}

View File

@@ -26,8 +26,6 @@ export const ACTIVE_SHEET_SHARE_DATA_IN_FILE: 'SHARE_DATA_IN_FILE' =
export const SET_EXPORT_STATUS_MESSAGE: 'SET_EXPORT_STATUS_MESSAGE' =
'SET_EXPORT_STATUS_MESSAGE';
export const UNSET_SHARE: 'UNSET_SHARE' = 'UNSET_SHARE';
export const ACTIVE_SHEET_JS_EMULATOR_LAUNCHER: 'ACTIVE_SHEET_JS_EMULATOR_LAUNCHER' =
'ACTIVE_SHEET_JS_EMULATOR_LAUNCHER';
export const ACTIVE_SHEET_CHANGELOG = 'ACTIVE_SHEET_CHANGELOG';
export const ACTIVE_SHEET_CHANGELOG_RECENT_ONLY =
'ACTIVE_SHEET_CHANGELOG_RECENT_ONLY';
@@ -41,7 +39,6 @@ export type ActiveSheet =
| typeof ACTIVE_SHEET_DOCTOR
| typeof ACTIVE_SHEET_SHARE_DATA_IN_FILE
| typeof ACTIVE_SHEET_SELECT_PLUGINS_TO_EXPORT
| typeof ACTIVE_SHEET_JS_EMULATOR_LAUNCHER
| typeof ACTIVE_SHEET_CHANGELOG
| typeof ACTIVE_SHEET_CHANGELOG_RECENT_ONLY
| null;

View File

@@ -24,8 +24,6 @@ import {
launchSimulator, // TODO: move to iOSDeviceManager
IOSDeviceParams,
} from '../../server/devices/ios/iOSDeviceManager';
import GK from '../../fb-stubs/GK';
import {JSEmulatorLauncherSheetSandy} from '../../chrome/JSEmulatorLauncherSheet';
const COLD_BOOT = 'cold-boot';
@@ -143,7 +141,7 @@ export const LaunchEmulatorDialog = withTrackingScope(
onClick={() =>
launchSimulator(device.udid)
.catch((e) => {
console.error(e);
console.error('Failed to start simulator: ', e);
message.error('Failed to start simulator: ' + e);
})
.then(onClose)
@@ -152,15 +150,6 @@ export const LaunchEmulatorDialog = withTrackingScope(
</Button>
)),
];
// Launch JS emulator
if (GK.get('flipper_js_client_emulator')) {
items.push(
<JSEmulatorLauncherSheetSandy
key="js-emulator-launcher"
onClose={onClose}
/>,
);
}
return (
<Modal

View File

@@ -19,9 +19,7 @@ import {reportPlatformFailures} from '../../utils/metrics';
import {EventEmitter} from 'events';
import invariant from 'invariant';
import GK from '../../fb-stubs/GK';
import {initJsEmulatorIPC} from '../devices/webapp/jsServerUtils';
import {buildClientId} from '../../utils/clientUtils';
import JSDevice from '../devices/webapp/JSDevice';
import DummyDevice from '../../server/devices/DummyDevice';
import BaseDevice from '../../server/devices/BaseDevice';
import {sideEffect} from '../../utils/sideEffect';
@@ -130,10 +128,6 @@ class ServerController extends EventEmitter implements ServerEventsListener {
reportPlatformFailures(this.initialized, 'initializeServer');
if (GK.get('flipper_js_client_emulator')) {
initJsEmulatorIPC(this.flipperServer, this.connections);
}
return this.initialized;
}
@@ -212,13 +206,6 @@ class ServerController extends EventEmitter implements ServerEventsListener {
appName: appNameWithUpdateHint(clientQuery),
};
this.emit('start-client-setup', client);
if (clientQuery.os === 'JSWebApp') {
this.store.dispatch({
type: 'REGISTER_DEVICE',
payload: new JSDevice(clientQuery.device_id, clientQuery.app, 1),
});
}
}
onProcessCSR(

View File

@@ -171,8 +171,7 @@ class ServerWebSocket extends ServerWebSocketBase {
str === 'Android' ||
str === 'Metro' ||
str === 'Windows' ||
str === 'MacOS' ||
str === 'JSWebApp'
str === 'MacOS'
);
}

View File

@@ -57,7 +57,7 @@ class ServerWebSocketBrowser extends ServerWebSocketBase {
device_id: deviceId,
device,
app: device,
os: 'JSWebApp',
os: 'MacOS', // TODO: not hardcoded! Use host device?
};
this.listener.onConnectionAttempt(clientQuery);

View File

@@ -27,7 +27,7 @@ export type DeviceShell = {
stdin: stream.Writable;
};
export type OS = PluginOS | 'Windows' | 'MacOS' | 'JSWebApp';
export type OS = PluginOS | 'Windows' | 'MacOS';
type PluginDefinition = _SandyPluginDefinition;
type PluginMap = Map<string, PluginDefinition>;

View File

@@ -1,19 +0,0 @@
/**
* 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 BaseDevice from '../BaseDevice';
export default class JSDevice extends BaseDevice {
webContentsId: number;
constructor(serial: string, title: string, webContentsId: number) {
super(serial, 'emulator', title, 'JSWebApp');
this.webContentsId = webContentsId;
}
}

View File

@@ -1,203 +0,0 @@
/**
* 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 Client, {ClientQuery} from '../../../Client';
import {
ClientConnection,
ConnectionStatus,
ConnectionStatusChange,
ResponseType,
} from '../../comms/ClientConnection';
import {ipcRenderer, remote, IpcRendererEvent} from 'electron';
import JSDevice from './JSDevice';
import {buildClientId} from '../../../utils/clientUtils';
import {FlipperServer} from '../../FlipperServer';
const connections: Map<number, JSClientFlipperConnection> = new Map();
const availablePlugins: Map<number, Array<string>> = new Map();
function jsDeviceId(windowId: number): string {
return 'test_js_device' + windowId;
}
export function initJsEmulatorIPC(
flipperServer: FlipperServer,
flipperConnections: Map<
string,
{
connection: ClientConnection | null | undefined;
client: Client;
}
>,
) {
ipcRenderer.on(
'from-js-emulator-init-client',
(_event: IpcRendererEvent, message: any) => {
const {windowId} = message;
const {plugins, appName} = message.payload;
const device = new JSDevice(jsDeviceId(windowId), 'jsEmulator', windowId);
flipperServer.registerDevice(device);
const connection = new JSClientFlipperConnection(windowId);
connections.set(windowId, connection);
availablePlugins.set(windowId, plugins);
const query: ClientQuery = {
app: appName,
os: 'JSWebApp',
device: 'jsEmulator',
device_id: jsDeviceId(windowId),
sdk_version: 2, // hack to bybass callbacks in Client, will be fixed when JS Connection will be fully implemented
};
const clientId = buildClientId(query);
const client = new Client(
clientId,
query,
connection,
flipperServer.logger,
flipperServer.store,
plugins,
device,
);
flipperConnections.set(clientId, {
connection: connection,
client: client,
});
connection.subscribeToEvents((status) => {
if (
status == ConnectionStatus.ERROR ||
status == ConnectionStatus.CLOSED
) {
console.debug(`Device disconnected ${client.id}`, 'server');
flipperServer.server.removeConnection(client.id);
flipperServer.unregisterDevice(jsDeviceId(windowId));
connections.delete(windowId);
availablePlugins.delete(windowId);
}
});
client
.init()
.then(() => {
console.log(client);
flipperServer.server.emit('new-client', client);
flipperServer.server.emit('clients-change');
client.emit('plugins-change');
ipcRenderer.on(
'from-js-emulator',
(_event: IpcRendererEvent, message: any) => {
const {command, payload} = message;
if (command === 'sendFlipperObject') {
client.onMessage(
JSON.stringify({
params: {
api: payload.api,
method: payload.method,
params: JSON.parse(payload.params),
},
method: 'execute',
}),
);
}
},
);
})
.catch((_) => {});
},
);
}
export function launchJsEmulator(url: string, height: number, width: number) {
const BrowserWindow = remote.BrowserWindow;
const win = new BrowserWindow({
height: height,
width: width,
webPreferences: {
enableRemoteModule: true,
preload: require('path').join(
remote.app.getAppPath(),
'SupportJSClientPreload.js',
),
nodeIntegration: false,
contextIsolation: false,
allowRunningInsecureContent: true,
},
});
win.webContents.on('preload-error', (_event, path, error) => {
console.log(path, error);
});
win.loadURL(url);
win.webContents.on('did-finish-load', () => {
win.webContents.send('parent-window-id', remote.getCurrentWebContents().id);
const childWindowId = win.webContents.id;
win.on('closed', () => {
connections.get(childWindowId)?.close();
});
});
}
export class JSClientFlipperConnection implements ClientConnection {
webContentsId: number;
connStatusSubscribers: Set<ConnectionStatusChange> = new Set();
connStatus: ConnectionStatus;
constructor(webContentsId: number) {
this.webContentsId = webContentsId;
this.connStatus = ConnectionStatus.CONNECTED;
}
subscribeToEvents(subscriber: ConnectionStatusChange): void {
this.connStatusSubscribers.add(subscriber);
}
send(data: any): void {
ipcRenderer.sendTo(
this.webContentsId,
'message-to-plugin',
JSON.parse(data != null ? data : '{}'),
);
}
// TODO: fully implement and return actual result
sendExpectResponse(data: any): Promise<ResponseType> {
return new Promise((resolve, _) => {
const method = data != null ? JSON.parse(data).method : 'not-defined';
if (method !== 'getPlugins') {
this.send(data);
}
if (method === 'getPlugins') {
resolve({
success: {
plugins: availablePlugins.get(this.webContentsId),
},
length: 0,
});
} else {
resolve({
success: undefined,
length: 0,
});
}
});
}
close(): void {
this.connStatus = ConnectionStatus.CLOSED;
this.connStatusSubscribers.forEach((subscriber) => {
subscriber(this.connStatus);
});
}
}

View File

@@ -1,94 +0,0 @@
/**
* 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
*/
// ==============
// Preload script
// ==============
const {remote, ipcRenderer} = require('electron');
const flipperState = {
mainWindowId: 0,
isClientInit: false,
plugins: null,
appName: 'JS App',
};
ipcRenderer.on('parent-window-id', (event, message) => {
flipperState.mainWindowId = message;
});
function cleanUpGWTArray(arr) {
const res = [];
for (let i = 0; i < arr.length; i++) {
res.push(arr[i]);
}
return res;
}
function initClient(plugins, appName) {
if (flipperState.isClientInit) {
return;
}
if (plugins) {
flipperState.plugins = cleanUpGWTArray(plugins);
}
if (appName) {
flipperState.appName = appName;
}
if (flipperState.mainWindowId != 0) {
ipcRenderer.sendTo(
flipperState.mainWindowId,
'from-js-emulator-init-client',
{
command: 'initClient',
windowId: remote.getCurrentWebContents().id,
payload: {
plugins: flipperState.plugins,
appName: flipperState.appName,
},
},
);
flipperState.isClientInit = true;
}
}
window.FlipperWebviewBridge = {
registerPlugins: function (plugins) {
flipperState.plugins = plugins;
},
start: function (appName) {
flipperState.appName = appName;
initClient();
},
sendFlipperObject: function (plugin, method, data) {
initClient();
if (flipperState.mainWindowId != 0) {
ipcRenderer.sendTo(flipperState.mainWindowId, 'from-js-emulator', {
command: 'sendFlipperObject',
payload: {
api: plugin,
method: method,
params: data,
},
});
}
},
isFlipperSupported: true,
initClient: initClient,
};
ipcRenderer.on('message-to-plugin', (event, message) => {
const flipper = window.flipper;
if (!flipper) {
return;
}
const receiver = flipper.FlipperWebviewMessageReceiver.receive;
const {api, method, params} = message.params;
receiver(api, method, JSON.stringify(params));
});