Rename and documentation for start dev server (attach)
Summary: Same as with the previous diff. The function doesn't really start a server. Instead it attaches the routing of messages from the existing server into FlipperServer. Reviewed By: passy Differential Revision: D36310703 fbshipit-source-id: 7ac9a742fb36c3806597382c9aadcf96f4770484
This commit is contained in:
Lorenzo Blasa
committed by
Facebook GitHub Bot
Facebook GitHub Bot
parent
582966d139
commit
242d26e199
211
desktop/flipper-server/src/attachSocketServer.tsx
Normal file
211
desktop/flipper-server/src/attachSocketServer.tsx
Normal file
@@ -0,0 +1,211 @@
|
||||
/**
|
||||
* Copyright (c) Meta Platforms, Inc. and 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 chalk from 'chalk';
|
||||
import {
|
||||
ClientWebSocketMessage,
|
||||
ExecResponseWebSocketMessage,
|
||||
ExecResponseErrorWebSocketMessage,
|
||||
ServerEventWebSocketMessage,
|
||||
GenericWebSocketError,
|
||||
UserError,
|
||||
SystemError,
|
||||
getLogger,
|
||||
} from 'flipper-common';
|
||||
import {FlipperServerImpl} from 'flipper-server-core';
|
||||
import {WebSocketServer} from 'ws';
|
||||
import {
|
||||
FlipperServerCompanion,
|
||||
FlipperServerCompanionEnv,
|
||||
} from 'flipper-server-companion';
|
||||
import {URLSearchParams} from 'url';
|
||||
|
||||
/**
|
||||
* Attach and handle incoming messages from clients.
|
||||
* @param flipperServer A FlipperServer instance.
|
||||
* @param socket A ws socket on which to listen for events.
|
||||
*/
|
||||
export function attachSocketServer(
|
||||
flipperServer: FlipperServerImpl,
|
||||
socket: WebSocketServer,
|
||||
companionEnv: FlipperServerCompanionEnv,
|
||||
) {
|
||||
socket.on('connection', (client, req) => {
|
||||
const clientAddress =
|
||||
(req.socket.remoteAddress &&
|
||||
` ${req.socket.remoteAddress}:${req.socket.remotePort}`) ||
|
||||
'';
|
||||
|
||||
console.log(chalk.green(`Client connected${clientAddress}`));
|
||||
|
||||
let connected = true;
|
||||
|
||||
let flipperServerCompanion: FlipperServerCompanion | undefined;
|
||||
if (req.url) {
|
||||
const params = new URLSearchParams(req.url.slice(1));
|
||||
|
||||
if (params.get('server_companion')) {
|
||||
flipperServerCompanion = new FlipperServerCompanion(
|
||||
flipperServer,
|
||||
getLogger(),
|
||||
companionEnv.pluginInitializer.loadedPlugins,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
async function onServerEvent(event: string, payload: any) {
|
||||
if (flipperServerCompanion) {
|
||||
switch (event) {
|
||||
case 'client-message': {
|
||||
const client = flipperServerCompanion.getClient(payload.id);
|
||||
if (!client) {
|
||||
console.warn(
|
||||
'flipperServerCompanion.handleClientMessage -> unknown client',
|
||||
event,
|
||||
payload,
|
||||
);
|
||||
return;
|
||||
}
|
||||
client.onMessage(payload.message);
|
||||
return;
|
||||
}
|
||||
case 'client-disconnected': {
|
||||
if (flipperServerCompanion.getClient(payload.id)) {
|
||||
flipperServerCompanion.destroyClient(payload.id);
|
||||
}
|
||||
// We use "break" here instead of "return" because a flipper desktop client still might be interested in the "client-disconnect" event to update its list of active clients
|
||||
break;
|
||||
}
|
||||
case 'device-disconnected': {
|
||||
if (flipperServerCompanion.getDevice(payload.id)) {
|
||||
flipperServerCompanion.destroyDevice(payload.id);
|
||||
}
|
||||
// We use "break" here instead of "return" because a flipper desktop client still might be interested in the "device-disconnect" event to update its list of active devices
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const message = {
|
||||
event: 'server-event',
|
||||
payload: {
|
||||
event,
|
||||
data: payload,
|
||||
},
|
||||
} as ServerEventWebSocketMessage;
|
||||
client.send(JSON.stringify(message));
|
||||
}
|
||||
|
||||
flipperServer.onAny(onServerEvent);
|
||||
|
||||
client.on('message', (data) => {
|
||||
let [event, payload]: [event: string | null, payload: any | null] = [
|
||||
null,
|
||||
null,
|
||||
];
|
||||
try {
|
||||
({event, payload} = JSON.parse(
|
||||
data.toString(),
|
||||
) as ClientWebSocketMessage);
|
||||
} catch (err) {
|
||||
console.warn('flipperServer -> onMessage: failed to parse JSON', err);
|
||||
const response: GenericWebSocketError = {
|
||||
event: 'error',
|
||||
payload: {message: `Failed to parse JSON request: ${err}`},
|
||||
};
|
||||
client.send(JSON.stringify(response));
|
||||
return;
|
||||
}
|
||||
|
||||
switch (event) {
|
||||
case 'exec': {
|
||||
const {id, command, args} = payload;
|
||||
|
||||
if (typeof args[Symbol.iterator] !== 'function') {
|
||||
console.warn(
|
||||
'flipperServer -> exec: args argument in payload is not iterable',
|
||||
);
|
||||
const responseError: ExecResponseErrorWebSocketMessage = {
|
||||
event: 'exec-response-error',
|
||||
payload: {
|
||||
id,
|
||||
data: 'Payload args argument is not an iterable.',
|
||||
},
|
||||
};
|
||||
client.send(JSON.stringify(responseError));
|
||||
return;
|
||||
}
|
||||
|
||||
const execRes = flipperServerCompanion?.canHandleCommand(command)
|
||||
? flipperServerCompanion.exec(command, ...args)
|
||||
: flipperServer.exec(command, ...args);
|
||||
|
||||
execRes
|
||||
.then((result: any) => {
|
||||
if (connected) {
|
||||
const response: ExecResponseWebSocketMessage = {
|
||||
event: 'exec-response',
|
||||
payload: {
|
||||
id,
|
||||
data: result,
|
||||
},
|
||||
};
|
||||
|
||||
client.send(JSON.stringify(response));
|
||||
}
|
||||
})
|
||||
.catch((error: any) => {
|
||||
if (error instanceof UserError) {
|
||||
console.warn(
|
||||
`flipper-server.startSocketServer.exec: ${error.message}`,
|
||||
error.context,
|
||||
error.stack,
|
||||
);
|
||||
}
|
||||
if (error instanceof SystemError) {
|
||||
console.error(
|
||||
`flipper-server.startSocketServer.exec: ${error.message}`,
|
||||
error.context,
|
||||
error.stack,
|
||||
);
|
||||
}
|
||||
if (connected) {
|
||||
// TODO: Serialize error
|
||||
// TODO: log if verbose console.warn('Failed to handle response', error);
|
||||
const responseError: ExecResponseErrorWebSocketMessage = {
|
||||
event: 'exec-response-error',
|
||||
payload: {
|
||||
id,
|
||||
data:
|
||||
error.toString() +
|
||||
(error.stack ? `\n${error.stack}` : ''),
|
||||
},
|
||||
};
|
||||
client.send(JSON.stringify(responseError));
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
client.on('close', () => {
|
||||
console.log(chalk.red(`Client disconnected ${clientAddress}`));
|
||||
connected = false;
|
||||
flipperServer.offAny(onServerEvent);
|
||||
flipperServerCompanion?.destroyAll();
|
||||
});
|
||||
|
||||
client.on('error', (e) => {
|
||||
console.error(chalk.red(`Socket error ${clientAddress}`), e);
|
||||
connected = false;
|
||||
flipperServer.offAny(onServerEvent);
|
||||
flipperServerCompanion?.destroyAll();
|
||||
});
|
||||
});
|
||||
}
|
||||
Reference in New Issue
Block a user