Rename base server to just server
Summary: ^ BaseServer doesn't really have any meaning. So, change it to just Server as it really creates the Express app and HTTP server attached to it. Reviewed By: passy Differential Revision: D36310822 fbshipit-source-id: eee5a2a395ca726679c1c4756ed58d4bc6be3cb8
This commit is contained in:
Lorenzo Blasa
committed by
Facebook GitHub Bot
Facebook GitHub Bot
parent
2493de75ab
commit
453ec4bd83
272
desktop/flipper-server/src/startServer.tsx
Normal file
272
desktop/flipper-server/src/startServer.tsx
Normal file
@@ -0,0 +1,272 @@
|
||||
/**
|
||||
* 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 os from 'os';
|
||||
import net from 'net';
|
||||
import express, {Express} from 'express';
|
||||
import http, {ServerResponse} from 'http';
|
||||
import path from 'path';
|
||||
import fs from 'fs-extra';
|
||||
import {VerifyClientCallbackSync, WebSocketServer} from 'ws';
|
||||
import {WEBSOCKET_MAX_MESSAGE_SIZE} from 'flipper-server-core';
|
||||
import {parse} from 'url';
|
||||
import xdgBasedir from 'xdg-basedir';
|
||||
import proxy from 'http-proxy';
|
||||
import exitHook from 'exit-hook';
|
||||
|
||||
type Config = {
|
||||
port: number;
|
||||
staticDir: string;
|
||||
entry: string;
|
||||
};
|
||||
|
||||
/**
|
||||
* Orchestrates the creation of the HTTP server, proxy, and web socket.
|
||||
* @param config Server configuration.
|
||||
* @returns Returns a promise to the created server, proxy and web socket.
|
||||
*/
|
||||
export async function startServer(config: Config): Promise<{
|
||||
app: Express;
|
||||
server: http.Server;
|
||||
socket: WebSocketServer;
|
||||
}> {
|
||||
const {app, server} = await startHTTPServer(config);
|
||||
const socket = addWebsocket(server, config);
|
||||
return {
|
||||
app,
|
||||
server,
|
||||
socket,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an express app with configured routing and creates
|
||||
* a proxy server.
|
||||
* @param config Server configuration.
|
||||
* @returns A promise to both app and HTTP server.
|
||||
*/
|
||||
async function startHTTPServer(
|
||||
config: Config,
|
||||
): Promise<{app: Express; server: http.Server}> {
|
||||
const app = express();
|
||||
|
||||
app.use((_req, res, next) => {
|
||||
res.header('Cache-Control', 'private, no-cache, no-store, must-revalidate');
|
||||
res.header('Expires', '-1');
|
||||
res.header('Pragma', 'no-cache');
|
||||
next();
|
||||
});
|
||||
|
||||
app.get('/', (_req, res) => {
|
||||
fs.readFile(path.join(config.staticDir, config.entry), (_err, content) => {
|
||||
res.end(content);
|
||||
});
|
||||
});
|
||||
|
||||
app.get('/health', (_req, res) => {
|
||||
res.end('flipper-ok');
|
||||
});
|
||||
|
||||
app.use(express.static(config.staticDir));
|
||||
|
||||
return startProxyServer(config, app);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a socket is in used for given path.
|
||||
* If the path doesn't exist then is not in use. If it does,
|
||||
* create a socket client and attempt to connect to it.
|
||||
* If the connection is established, then there's a process
|
||||
* already listening. Otherwise, it kind of indicates the
|
||||
* contrary.
|
||||
* @param path Path used instead of port number.
|
||||
* @returns True or false dependning on whether the socket is in
|
||||
* use or not.
|
||||
*/
|
||||
async function checkSocketInUse(path: string): Promise<boolean> {
|
||||
if (!(await fs.pathExists(path))) {
|
||||
return false;
|
||||
}
|
||||
return new Promise((resolve, _reject) => {
|
||||
const client = net
|
||||
.createConnection(path, () => {
|
||||
resolve(true);
|
||||
client.destroy();
|
||||
})
|
||||
.on('error', (e) => {
|
||||
if (e.message.includes('ECONNREFUSED')) {
|
||||
resolve(false);
|
||||
} else {
|
||||
console.warn(
|
||||
`[conn] Socket ${path} is in use, but we don't know why.`,
|
||||
e,
|
||||
);
|
||||
resolve(false);
|
||||
}
|
||||
client.destroy();
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a socket path. Used to open the socket at location.
|
||||
* Format: flipper-server-${userInfo}.sock
|
||||
* @returns The created socket path.
|
||||
*/
|
||||
async function makeSocketPath(): Promise<string> {
|
||||
const runtimeDir = xdgBasedir.runtime || '/tmp';
|
||||
await fs.mkdirp(runtimeDir);
|
||||
const filename = `flipper-server-${os.userInfo().uid}.sock`;
|
||||
const path = `${runtimeDir}/${filename}`;
|
||||
|
||||
// Depending on the OS this is between 104 and 108:
|
||||
// https://unix.stackexchange.com/a/367012/10198
|
||||
if (path.length >= 104) {
|
||||
console.warn(
|
||||
'Ignoring XDG_RUNTIME_DIR as it would exceed the total limit for domain socket paths. See man 7 unix.',
|
||||
);
|
||||
// Even with the INT32_MAX userid, we should have plenty of room.
|
||||
return `/tmp/${filename}`;
|
||||
}
|
||||
|
||||
return path;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates and starts the HTTP and proxy servers.
|
||||
* @param config Server configuration.
|
||||
* @param app Express app.
|
||||
* @returns Returns both the app and server configured and
|
||||
* listening.
|
||||
*/
|
||||
async function startProxyServer(
|
||||
config: Config,
|
||||
app: Express,
|
||||
): Promise<{app: Express; server: http.Server}> {
|
||||
const server = http.createServer(app);
|
||||
|
||||
// For now, we only support domain socket access on POSIX-like systems.
|
||||
// On Windows, a proxy is not created and the server starts
|
||||
// listening at the specified port.
|
||||
if (os.platform() === 'win32') {
|
||||
return new Promise((resolve) => {
|
||||
console.log(`Starting server on http://localhost:${config.port}`);
|
||||
server.listen(config.port, undefined, () => resolve({app, server}));
|
||||
});
|
||||
}
|
||||
|
||||
const socketPath = await makeSocketPath();
|
||||
if (await checkSocketInUse(socketPath)) {
|
||||
console.warn(
|
||||
`Cannot start flipper-server because socket ${socketPath} is in use.`,
|
||||
);
|
||||
} else {
|
||||
console.info(`Cleaning up stale socket ${socketPath}`);
|
||||
await fs.rm(socketPath, {force: true});
|
||||
}
|
||||
|
||||
const proxyServer = proxy.createProxyServer({
|
||||
target: {host: 'localhost', port: 0, socketPath},
|
||||
autoRewrite: true,
|
||||
ws: true,
|
||||
});
|
||||
console.log('Starting socket server on ', socketPath);
|
||||
console.log(`Starting proxy server on http://localhost:${config.port}`);
|
||||
|
||||
exitHook(() => {
|
||||
console.log('Cleaning up socket on exit:', socketPath);
|
||||
// This *must* run synchronously and we're not blocking any UI loop by definition.
|
||||
// eslint-disable-next-line node/no-sync
|
||||
fs.rmSync(socketPath, {force: true});
|
||||
});
|
||||
|
||||
proxyServer.on('error', (err, _req, res) => {
|
||||
console.warn('Error in proxy server:', err);
|
||||
if (res instanceof ServerResponse) {
|
||||
res.writeHead(502, 'Failed to proxy request');
|
||||
}
|
||||
res.end('Failed to proxy request: ' + err);
|
||||
});
|
||||
|
||||
return new Promise((resolve) => {
|
||||
proxyServer.listen(config.port);
|
||||
server.listen(socketPath, undefined, () => resolve({app, server}));
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a WS to the existing HTTP server.
|
||||
* @param server HTTP server.
|
||||
* @param config Server configuration. Port is used to verify
|
||||
* incoming connections origin.
|
||||
* @returns Returns the created WS.
|
||||
*/
|
||||
function addWebsocket(server: http.Server, config: Config) {
|
||||
const localhostIPV4 = `localhost:${config.port}`;
|
||||
const localhostIPV6 = `[::1]:${config.port}`;
|
||||
const localhostIPV6NoBrackets = `::1:${config.port}`;
|
||||
|
||||
const possibleHosts = [localhostIPV4, localhostIPV6, localhostIPV6NoBrackets];
|
||||
const possibleOrigins = possibleHosts.map((host) => `http://${host}`);
|
||||
|
||||
const verifyClient: VerifyClientCallbackSync = ({origin, req}) => {
|
||||
const noOriginHeader = origin === undefined;
|
||||
if (
|
||||
(noOriginHeader || possibleOrigins.includes(origin)) &&
|
||||
req.headers.host &&
|
||||
possibleHosts.includes(req.headers.host)
|
||||
) {
|
||||
// no origin header? The request is not originating from a browser, so should be OK to pass through
|
||||
// If origin matches our own address, it means we are serving the page
|
||||
return true;
|
||||
} else {
|
||||
// for now we don't allow cross origin request, so that an arbitrary website cannot try to
|
||||
// connect a socket to localhost:serverport, and try to use the all powerful Flipper APIs to read
|
||||
// for example files.
|
||||
// Potentially in the future we do want to allow this, e.g. if we want to connect to a local flipper-server
|
||||
// directly from intern. But before that, we should either authenticate the request somehow,
|
||||
// and discuss security impact and for example scope the files that can be read by Flipper.
|
||||
console.warn(
|
||||
`Refused socket connection from cross domain request, origin: ${origin}, host: ${
|
||||
req.headers.host
|
||||
}. Expected origins: ${possibleOrigins.join(
|
||||
' or ',
|
||||
)}. Expected hosts: ${possibleHosts.join(' or ')}`,
|
||||
);
|
||||
return false;
|
||||
}
|
||||
};
|
||||
|
||||
const wss = new WebSocketServer({
|
||||
noServer: true,
|
||||
maxPayload: WEBSOCKET_MAX_MESSAGE_SIZE,
|
||||
verifyClient,
|
||||
});
|
||||
|
||||
server.on('upgrade', function upgrade(request, socket, head) {
|
||||
const {pathname} = parse(request.url!);
|
||||
|
||||
// Handled by Metro
|
||||
if (pathname === '/hot') {
|
||||
return;
|
||||
}
|
||||
|
||||
if (pathname === '/') {
|
||||
wss.handleUpgrade(request, socket, head, function done(ws) {
|
||||
wss.emit('connection', ws, request);
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
console.error('addWebsocket.upgrade -> unknown pathname', pathname);
|
||||
socket.destroy();
|
||||
});
|
||||
|
||||
return wss;
|
||||
}
|
||||
Reference in New Issue
Block a user