diff --git a/desktop/flipper-server/src/startDevServer.tsx b/desktop/flipper-server/src/attachDevServer.tsx similarity index 94% rename from desktop/flipper-server/src/startDevServer.tsx rename to desktop/flipper-server/src/attachDevServer.tsx index 1b50fb1db..2cac7a99f 100644 --- a/desktop/flipper-server/src/startDevServer.tsx +++ b/desktop/flipper-server/src/attachDevServer.tsx @@ -48,7 +48,15 @@ export async function getPluginSourceFolders(): Promise { return pFilter(pluginFolders, (p) => fs.pathExists(p)); } -export async function startDevServer( +/** + * Attaches the necessary routing and middleware to observe + * for local changes and apply them to the running instance. + * @param app Express app. + * @param server HTTP server. + * @param socket Web Socket server. + * @param rootDir Root directory. + */ +export async function attachDevServer( app: Express, server: http.Server, socket: WebSocketServer, diff --git a/desktop/flipper-server/src/index.tsx b/desktop/flipper-server/src/index.tsx index 45a7ba078..5d5ac1048 100644 --- a/desktop/flipper-server/src/index.tsx +++ b/desktop/flipper-server/src/index.tsx @@ -13,7 +13,7 @@ import path from 'path'; import {startFlipperServer} from './startFlipperServer'; import {startServer} from './startServer'; import {startSocketServer} from './startSocketServer'; -import {startDevServer} from './startDevServer'; +import {attachDevServer} from './attachDevServer'; import yargs from 'yargs'; import open from 'open'; @@ -100,7 +100,7 @@ async function start() { await flipperServer.connect(); if (argv.bundler) { - await startDevServer(app, server, socket, rootDir); + await attachDevServer(app, server, socket, rootDir); } startSocketServer(flipperServer, socket, companionEnv); } diff --git a/desktop/flipper-server/src/startFlipperServer.tsx b/desktop/flipper-server/src/startFlipperServer.tsx index 15194c9e3..906f73ca6 100644 --- a/desktop/flipper-server/src/startFlipperServer.tsx +++ b/desktop/flipper-server/src/startFlipperServer.tsx @@ -25,6 +25,15 @@ import { import path from 'path'; import fs from 'fs-extra'; +/** + * Creates an instance of FlipperServer (FlipperServerImpl). This is the + * server used by clients to connect to. + * @param rootDir Application path. + * @param staticPath Static assets path. + * @param settingsString Optional settings used to override defaults. + * @param enableLauncherSettings Optional launcher settings used to override defaults. + * @returns + */ export async function startFlipperServer( rootDir: string, staticPath: string, @@ -81,7 +90,7 @@ export async function startFlipperServer( { environmentInfo, env: parseEnvironmentVariables(process.env), - // TODO: make userame parameterizable + // TODO: make username parameterizable gatekeepers: getGatekeepers(environmentInfo.os.unixname), paths: { appPath,