jens/flipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Track client connections and autostop server add-ons when all clients leave

Browse Source 
Reviewed By: mweststrate

Differential Revision: D34045584

fbshipit-source-id: 1ad0cfffb9d304f0359c973d76d6956f7e932f72
This commit is contained in:
Andrey Goncharov
2022-02-28 03:50:34 -08:00
committed by Facebook GitHub Bot
parent 9113006851
commit 3b390b74ff
9 changed files with 87 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
desktop/flipper-common/src/server-types.tsx
View File

@@ -249,8 +249,14 @@ export type FlipperServerCommands = {
path: string,
) => Promise<InstalledPluginDetails>;
'plugins-remove-plugins': (names: string[]) => Promise<void>;
'plugins-server-add-on-start': (pluginName: string) => Promise<void>;
'plugins-server-add-on-stop': (pluginName: string) => Promise<void>;
'plugins-server-add-on-start': (
pluginName: string,
owner: string,
) => Promise<void>;
'plugins-server-add-on-stop': (
pluginName: string,
owner: string,
) => Promise<void>;
'doctor-get-healthchecks': (
settings: FlipperDoctor.HealthcheckSettings,
) => Promise<FlipperDoctor.Healthchecks>;

18
desktop/flipper-plugin/src/plugin/DevicePlugin.tsx
View File

@@ -101,8 +101,13 @@ export class SandyDevicePluginInstance extends BasePluginInstance {
private startServerAddOn() {
const {serverAddOn, name} = this.definition.details;
if (serverAddOn) {
this.serverAddOnControls.start(name).catch((e) => {
console.warn('Failed to start a server add on', name, e);
this.serverAddOnControls.start(name, this.device.serial).catch((e) => {
console.warn(
'Failed to start a server add on',
name,
this.device.serial,
e,
);
});
}
}
@@ -110,8 +115,13 @@ export class SandyDevicePluginInstance extends BasePluginInstance {
private stopServerAddOn() {
const {serverAddOn, name} = this.definition.details;
if (serverAddOn) {
this.serverAddOnControls.stop(name).catch((e) => {
console.warn('Failed to start a server add on', name, e);
this.serverAddOnControls.stop(name, this.device.serial).catch((e) => {
console.warn(
'Failed to start a server add on',
name,
this.device.serial,
e,
);
});
}
}

18
desktop/flipper-plugin/src/plugin/Plugin.tsx
View File

@@ -233,8 +233,13 @@ export class SandyPluginInstance extends BasePluginInstance {
if (!this.connected.get()) {
const {serverAddOn, name} = this.definition.details;
if (serverAddOn) {
this.serverAddOnControls.start(name).catch((e) => {
console.warn('Failed to start a server add on', name, e);
this.serverAddOnControls.start(name, this.realClient.id).catch((e) => {
console.warn(
'Failed to start a server add on',
name,
this.realClient.id,
e,
);
});
}
@@ -248,8 +253,13 @@ export class SandyPluginInstance extends BasePluginInstance {
if (this.connected.get()) {
const {serverAddOn, name} = this.definition.details;
if (serverAddOn) {
this.serverAddOnControls.stop(name).catch((e) => {
console.warn('Failed to stop a server add on', name, e);
this.serverAddOnControls.stop(name, this.realClient.id).catch((e) => {
console.warn(
'Failed to stop a server add on',
name,
this.realClient.id,
e,
);
});
}

9
desktop/flipper-server-core/src/FlipperServerImpl.tsx
View File

@@ -419,10 +419,11 @@ export class FlipperServerImpl implements FlipperServer {
'plugins-install-from-npm': (name) =>
this.pluginManager.installPluginFromNpm(name),
'plugin-source': (path) => this.pluginManager.loadSource(path),
'plugins-server-add-on-start': (pluginName) =>
this.pluginManager.startServerAddOn(pluginName),
'plugins-server-add-on-stop': async (pluginName) =>
this.pluginManager.stopServerAddOn(pluginName),
'plugins-server-add-on-start': (pluginName, owner) =>
this.pluginManager.startServerAddOn(pluginName, owner),
// TODO: Figure out if it needs to be async
'plugins-server-add-on-stop': async (pluginName, owner) =>
this.pluginManager.stopServerAddOn(pluginName, owner),
'doctor-get-healthchecks': getHealthChecks,
'doctor-run-healthcheck': runHealthcheck,
'open-file': openFile,

1
desktop/flipper-server-core/src/comms/ServerController.tsx
View File

@@ -510,6 +510,7 @@ export class ServerController
);
this.flipperServer.emit('client-disconnected', {id});
this.connections.delete(id);
this.flipperServer.pluginManager.stopAllServerAddOns(id);
}
}
}

1
desktop/flipper-server-core/src/devices/ServerDevice.tsx
View File

@@ -46,6 +46,7 @@ export abstract class ServerDevice {
this.connected = false;
this.logListener.stop();
this.crashWatcher.stop();
this.flipperServer.pluginManager.stopAllServerAddOns(this.info.serial);
}
async screenshotAvailable(): Promise<boolean> {

25
desktop/flipper-server-core/src/plugins/PluginManager.tsx
View File

@@ -155,34 +155,39 @@ export class PluginManager {
}
}
async startServerAddOn(pluginName: string) {
async startServerAddOn(pluginName: string, owner: string) {
console.debug('PluginManager.startServerAddOn', pluginName);
// TODO: Get owner from websocket connection ID
const fakeOwner = 'test';
const existingServerAddOn = this.serverAddOns.get(pluginName);
if (existingServerAddOn) {
console.debug(
'PluginManager.startServerAddOn -> already started, adding an owner',
pluginName,
fakeOwner,
owner,
);
existingServerAddOn.addOwner(fakeOwner);
existingServerAddOn.addOwner(owner);
return;
}
const newServerAddOn = await ServerAddOn.start(pluginName, fakeOwner);
const newServerAddOn = await ServerAddOn.start(pluginName, owner, () =>
this.serverAddOns.delete(pluginName),
);
this.serverAddOns.set(pluginName, newServerAddOn);
}
stopServerAddOn(pluginName: string) {
stopServerAddOn(pluginName: string, owner: string) {
console.debug('PluginManager.stopServerAddOn', pluginName);
const serverAddOn = this.serverAddOns.get(pluginName);
if (!serverAddOn) {
console.debug('PluginManager.stopServerAddOn -> not started', pluginName);
return;
}
// TODO: Get owner from websocket connection ID
const fakeOwner = 'test';
serverAddOn.removeOwner(fakeOwner);
serverAddOn.removeOwner(owner);
}
stopAllServerAddOns(owner: string) {
console.debug('PluginManager.stopAllServerAddOns');
this.serverAddOns.forEach((serverAddOn) => {
serverAddOn.removeOwner(owner);
});
}
}

43
desktop/flipper-server-core/src/plugins/ServerAddOn.tsx
View File

@@ -15,42 +15,49 @@ interface ServerAddOnModule {
serverAddOn?: () => Promise<ServerAddOnCleanup>;
}
// TODO: Metro does not like dynamic requires. Figure out how to properly configure metro to handle them.
// https://github.com/webpack/webpack/issues/4175#issuecomment-323023911
function requireDynamically(path: string) {
// eslint-disable-next-line no-eval
return eval(`require('${path}');`); // Ensure Metro does not analyze the require statement
}
const loadPlugin = (_pluginName: string): ServerAddOnModule => {
// TODO: Implement me
return {serverAddOn: async () => async () => {}};
};
// TODO: Fix potential race conditions when starting/stopping concurrently
export class ServerAddOn {
private owners: Set<string>;
constructor(
public readonly path: string,
public readonly pluginName: string,
private readonly cleanup: ServerAddOnCleanup,
initialOwner: string,
) {
this.owners = new Set(initialOwner);
}
static async start(path: string, initialOwner: string): Promise<ServerAddOn> {
console.info('ServerAddOn.start', path);
static async start(
pluginName: string,
initialOwner: string,
onStop: () => void,
): Promise<ServerAddOn> {
console.info('ServerAddOn.start', pluginName);
const {serverAddOn} = requireDynamically(path) as ServerAddOnModule;
const {serverAddOn} = loadPlugin(pluginName);
assertNotNull(serverAddOn);
assert(
typeof serverAddOn === 'function',
`ServerAddOn ${path} must export "serverAddOn" function.`,
`ServerAddOn ${pluginName} must export "serverAddOn" function.`,
);
const cleanup = await serverAddOn();
assert(
typeof cleanup === 'function',
`ServerAddOn ${path} must return a clean up function, instead it returned ${typeof cleanup}.`,
`ServerAddOn ${pluginName} must return a clean up function, instead it returned ${typeof cleanup}.`,
);
return new ServerAddOn(path, cleanup, initialOwner);
const onStopCombined = async () => {
onStop();
await cleanup();
};
return new ServerAddOn(pluginName, onStopCombined, initialOwner);
}
addOwner(owner: string) {
@@ -58,13 +65,13 @@ export class ServerAddOn {
}
removeOwner(owner: string) {
this.owners.delete(owner);
const ownerExisted = this.owners.delete(owner);
if (!this.owners.size) {
if (!this.owners.size && ownerExisted) {
this.stop().catch((e) => {
console.error(
'ServerAddOn.removeOwner -> failed to stop automatically when no owners left',
this.path,
this.pluginName,
e,
);
});
@@ -72,11 +79,11 @@ export class ServerAddOn {
}
private async stop() {
console.info('ServerAddOn.stop', this.path);
console.info('ServerAddOn.stop', this.pluginName);
try {
await this.cleanup();
} catch (e) {
console.error('ServerAddOn.stop -> failed to clean up', this.path);
console.error('ServerAddOn.stop -> failed to clean up', this.pluginName);
}
}
}

8
desktop/flipper-ui-core/src/utils/createServerAddOnControls.tsx
View File

@@ -12,8 +12,8 @@ import {FlipperServer, ServerAddOnControls} from 'flipper-common';
export const createServerAddOnControls = (
flipperServer: Pick<FlipperServer, 'exec'>,
): ServerAddOnControls => ({
start: (pluginName) =>
flipperServer.exec('plugins-server-add-on-start', pluginName),
stop: (pluginName) =>
flipperServer.exec('plugins-server-add-on-stop', pluginName),
start: (pluginName, owner) =>
flipperServer.exec('plugins-server-add-on-start', pluginName, owner),
stop: (pluginName, owner) =>
flipperServer.exec('plugins-server-add-on-stop', pluginName, owner),
});