Multiplex
';
+
+function RenderLoginForm() {
+ return `
+
+`;
+}
+function RenderManager() {
+ let response = logoHtml;
+ response += ``;
+ response += ``;
+ response += ``;
+ response += ``;
+ response += RenderActiveGraphsList();
+ response += RenderSavedGraphsList();
+ response += `
`;
+ response += ``;
+ response += RenderNewGraphForm();
+ response += RenderGenerateTokensForm();
+ response += `
`;
+ response += RenderMemoryReport();
+ response += `Updated: ${new Date().toLocaleTimeString()}
`; + return response; +} + +/** + * Returns a list of databases in the runtime folder + * formatted as HTML- ';
+ let dbs = NCUTILS.GetDatabaseNamesArray();
+ dbs.forEach(db => {
+ // Don't list dbs that are already open
+ if (!DBIsRunning(db)) response += `
- ${db} `; + }); + response += `
`;
+ response += `
+
+
`;
+ response += `
`;
+ return response;
+}
+
+function RenderSavedGraphsList() {
+ let response = `Active Graphs
+| Graph | Port | Websocket | + | |
| ${route.db} | +${route.port} | ${route.netport} | ${kill} | + |
Number of Active Graphs: ${ + childProcesses.length - 1 + } / ${PROCESS_MAX} (max)`; + response += `
Reload browser to refresh Active Graphs.
`; + response += `"Stop" active graphs if you're not using them anymore.
(Closing the window does not stop the graph.)
`;
+ response += `
`;
+ return response;
+}
+
+function RenderNewGraphForm() {
+ return `
+ Saved Graphs
`; + response += `Graph/database files saved on server. Click to open.
`; + response += RenderDatabaseList(); + response += `
+
`;
+}
+
+function RenderGenerateTokensForm() {
+ let response = `New Graph
+ + +Add a template file with the same name to the /runtime folder. Otherwise, the system + will generate a copy from the default template.
+ +`;
+ let dbnames = NCUTILS.GetDatabaseNamesArray().reduce(
+ (acc, curr) => acc + "',
+ ''
+ );
+ response += `
+
+
`;
+ return response;
+}
+
+function RenderMemoryReport() {
+ const mem = process.memoryUsage();
+ let response = `Generate Tokens
+
+
+ +
+ `;
+ response += `Select a database, enter a class id, a project id, and number of tokens to generate. Then click "Generate Tokens".
+ + + + ++ +
MEMORY :: Used: + ${numberWithCommas(Math.trunc(mem.heapUsed / 1024))}mb / + ${numberWithCommas(mem.heapTotal / 1024)}mb + (${(100 * (mem.heapUsed / mem.heapTotal)).toFixed(2)}%) `; + response += ` :: Remaining: ${numberWithCommas( + Math.trunc((mem.heapTotal - mem.heapUsed) / 1024) + )}mb`; + response += ` :: Out of memory: ${OutOfMemory()}
`; + return response; +} + +/////////////////////////////////////////////////////////////////////////////// +// +// PROCESS MANAGERS + +/** + * Use this to spawn a new node instance + * Calls PromiseApp. + * + * @param {string} db + * @return {integer} port to be used by router function + * in app.use(`/graph/:graph/:file`...). + */ +async function SpawnApp(db) { + try { + const newProcessDef = await PromiseApp(db); + AddChildProcess(newProcessDef); + return newProcessDef.port; + } catch (err) { + console.error(PRE + 'SpawnApp Failed with error', err); + } +} + +/** + * Promises a new node NetCreate application process + * + * In general, don't call this directly. Use SpawnApp. + * + * This starts `nc-start.js` via a fork. + * `nc-start.js` will generate the `netcreate-config.js` + * configuration file, and then start the brunch server. + * + * When `nc-start.js` has completed, it sends a message back + * via fork messaging, at which point this promise is resolved + * and then we redirect the user to the new port. + * + * @param {string} db + * @resolve {object} sends the forked process and meta info + * + */ +function PromiseApp(db) { + return new Promise((resolve, reject) => { + const ports = PickPort(); + if (ports === undefined) { + reject(`Unable to find a free port. ${db} not created.`); + } + + // 1. Define the fork + const forked = fork('./nc-launch-instance.js'); + + // 2. Define fork success handler + // When the child node process is up and running, it will + // send a message back to this handler, which in turn + // sends the new spec back to SpawnApp + forked.on('message', msg => { + console.log(PRE, $T(), 'Received message from spawned fork:', msg); + console.log(PRE); + console.log(PRE, $T(), `${db} STARTED!`); + console.log(PRE); + const newProcessDef = { + db, + port: ports.appport, + netport: ports.netport, + portindex: ports.index, + googlea: googlea, + process: forked + }; + resolve(newProcessDef); // pass to SpawnApp + }); + + // 3. Send message to start fork + // This sends the necessary startup prarameters to nc-start.js + // When nc-start is completed, it will call the message + // handler in #2 above + const ncStartParams = { + db, + port: ports.appport, + netport: ports.netport, + process: forked, + ip, + googlea + }; + forked.send(ncStartParams); + }); +} + +/** + * Add the newProcess to the array of childProcesses + * but only if it doesn't already exist + * @param {object} route + */ +function AddChildProcess(newProcess) { + if (childProcesses.find(route => route.db === newProcess.db)) return; + childProcesses.push(newProcess); +} + +/** + * Used to check if we have enough memory to start a new node process + * This is used to prevent node from starting too many processes. + */ +function OutOfMemory() { + let mem = process.memoryUsage(); + return mem.heapTotal / 1024 - mem.heapUsed / 1024 < MEMORY_MIN; +} + +/////////////////////////////////////////////////////////////////////////////// +// +// HTTP-PROXY-MIDDLEWARE ROUTING +// + +// ---------------------------------------------------------------------------- +// INIT +console.log(`\n\n\n`) +console.log(PRE, $T(), 'STARTED!'); +console.log(PRE); + +// START BASE APP +// This is needed to handle static file requests. +// Most imports/requires do not specify the db route /graph/dbname/ +// so we need to provide a base app that responds to those static file +// requests. This starts a generic "base" dataset at port 3000. +SpawnApp('base'); + +// ---------------------------------------------------------------------------- +// ROUTE FUNCTIONS + +/** + * RouterGraph + * @param {object} req + * + * The router function tries to route to the correct port by: + * a) if process is already running, use existing port + * b) if the process isn't running, spawn a new process + * and pass the port + * c) if no more ports are available, redirect back to the root. + * + */ +async function RouterGraph(req) { + const db = req.params.graph; + let port; + let path = ''; + + // Authenticate to allow spawning + let ALLOW_SPAWN = false; + if (CookieIsValid(req)) { + ALLOW_SPAWN = true; + } + + // Is it already running? + let route = childProcesses.find(route => route.db === db); + if (route) { + // a) Yes. Use existing route! + console.log(PRE + $T() + '--> mapping to ', route.db, route.port); + port = route.port; + } else if (PortPoolIsEmpty()) { + console.log(PRE + $T() + '--> No more ports. Not spawning', db); + // b) No more ports available. + path = `/error_out_of_ports`; + } else if (OutOfMemory()) { + // c) Not enough memory to spawn new node instance + path = `/error_out_of_memory`; + } else if (ALLOW_NEW || ALLOW_SPAWN) { + // c) Not defined yet, Create a new one. + console.log(PRE + $T() + '--> not running yet, starting new', db); + port = await SpawnApp(db); + } else { + // c) Not defined yet. Report error. + path = `/error_no_database`; + } + return { + protocol: 'http:', + host: 'localhost', + port: port, + path: path + }; +} + +// ---------------------------------------------------------------------------- +// ROUTES + +// HANDLE `/graph/:graph/netcreate-config.js` +// +// The config file needs to be dynamically served for each node instance, +// otherwise they would share (and clobber) the same static file. +// +// This has to go before `/graph/:graph/:file?` or it won't get triggered +// +app.get(`/graph/:graph/${NC_URL_CONFIG}`, (req, res) => { + const db = req.params.graph; + let response = ''; + console.log('############ returning netcreate-config.js for', db); + const child = childProcesses.find(child => child.db === db); + if (child) { + response += NCUTILS.GetNCConfig(child); + } else { + response += 'ERROR: No database found to netcreate-config.js: ' + db; + } + res.set('Content-Type', 'application/javascript'); + res.send(response); +}); + +// HANDLE `/graph/:graph/:file?` +// +// * `:file` is optional. It catches db-specific file requests, +// for example, the`netcreate-config.js` request. +// * If there's a missing trailing "/", the URL is malformed +// +app.use( + '/graph/:graph/:file?', + createProxyMiddleware( + (pathname, req) => { + // only match if there is a trailing '/' + if (req.params.file) return true; // legit file + if (req.params.graph && req.originalUrl.endsWith('/')) return true; // legit graph + return false; + }, + { + router: RouterGraph, + pathRewrite: function (path, req) { + // remove '/graph/db/' for the rerouted calls + // e.g. localhost/graph/hawaii/#/edit/mop => localhost:3000/#/edit/mop + return (rewrite = path.replace(`/graph/${req.params.graph}`, '')); + }, + target: `http://localhost:3000`, // default fallback, router takes precedence + ws: true, + changeOrigin: true + } + ) +); + +// - - - - - - - - - - - - - - - - - - - - - - - - - - +// ERROR HANDLERS + +function SendErrorResponse(res, msg) { + res.set('Content-Type', 'text/html'); + res.send( + `${msg}
+ ` + ); +} + +// HANDLE NO DATABASE -- RETURN ERROR +app.get('/error_no_database', (req, res) => { + console.log(PRE + $T() + '================== Handling ERROR NO DATABASE!'); + SendErrorResponse(res, 'This graph is not currently open.'); +}); + +// HANDLE NOT AUTHORIZED -- RETURN ERROR +app.get('/error_not_authorized', (req, res) => { + console.log(PRE + $T() + '================== Handling ERROR NOT AUTHORIZED!'); + SendErrorResponse(res, 'Not Authorized.'); +}); + +// HANDLE OUT OF PORTS -- RETURN ERROR +app.get('/error_out_of_ports', (req, res) => { + console.log(PRE + $T() + '================== Handling ERROR OUT OF PORTS!'); + SendErrorResponse(res, "Ran out of ports. Can't start the graph."); +}); + +// HANDLE OUT OF MEMORY -- RETURN ERROR +app.get('/error_out_of_memory', (req, res) => { + console.log(PRE + $T() + '================== Handling ERROR OUT OF MEMORY!'); + SendErrorResponse(res, "Ran out of Memory. Can't start the graph."); +}); + +// HANDLE MISSING TRAILING ".../" -- RETURN ERROR +app.get('/graph/:file', (req, res) => { + console.log(PRE + $T() + '================== Handling BAD URL!'); + SendErrorResponse(res, "Bad URL. Missing trailing '/'."); +}); + +// - - - - - - - - - - - - - - - - - - - - - - - - - - +// UTILITIES + +// HANDLE "/kill/:graph" -- KILL REQUEST +app.get('/kill/:graph/', (req, res) => { + console.log(PRE + $T() + '================== Handling / KILL!'); + const db = req.params.graph; + res.set('Content-Type', 'text/html'); + let response = `NetCreate Manager
`; + const child = childProcesses.find(child => child.db === db); + if (child) { + try { + child.process.kill(); + // Return the port index to the pool + ReleasePort(child.portindex); + // Remove child from childProcesses + childProcesses = childProcesses.filter(child => child.db !== db); + response += `Process ${db} killed.`; + } catch (e) { + response += `
ERROR while trying to kill ${db}
`; + response += `${e}
`; + } + } else { + response += 'ERROR: No database found to kill: ' + db; + } + response += ``; + + res.send(response); +}); + +// HANDLE "/maketoken" -- GENERATE TOKENS +app.get('/maketoken/:clsid/:projid/:dataset/:numgroups', (req, res) => { + console.log(PRE + $T() + '================== Handling / MAKE TOKEN!'); + const { clsid, projid, dataset, numgroups } = req.params; + let response = MakeToken(clsid, projid, dataset, parseInt(numgroups)); + res.set('Content-Type', 'text/html'); + res.send(response); +}); + +// - - - - - - - - - - - - - - - - - - - - - - - - - - +// MANAGE +// +// Authentication +// +// Authentication uses a cookie with a hashed password. +// The cookie expires after AUTH_MINUTES +// +// 1. /manage initially redirects to /login +// 2. On the /login form, the administrator enters a password +// 3. /login POSTS to /authorize +// 4. /authorize checks the password against the PASSWORD +// If there's no match, the user is redirected to /error_not_authorized +// 5. /authorize then sets a cookie with the PASSWORD_HASH and +// the user is redirected to /manage +// 6. /manage checks the cookie against the PASSWORD_HASH +// If the cookie matches, the manage page is displayed +// If the cookie doesn't match, the user is redirected back to /login +// 7. The cookie expires after AUTH_MINUTES +// + +// HANDLE "/manage" -- MANAGER PAGE +app.get('/manage', (req, res) => { + console.log(PRE + $T() + '================== Handling / MANAGE!'); + if (CookieIsValid(req)) { + res.set('Content-Type', 'text/html'); + res.send(RenderManager()); + } else { + res.redirect(`/login`); + } +}); + +app.get('/login', (req, res) => { + console.log(PRE + $T() + '================== Handling / LOGIN!'); + if (CookieIsValid(req)) { + // Cookie already set, no need to log in, redirect to manage + res.redirect(`/manage`); + } else { + // Show login form + res.set('Content-Type', 'text/html'); + res.send(logoHtml + RenderLoginForm()); + } +}); + +app.post('/authorize', (req, res) => { + console.log(PRE + $T() + '================== Handling / AUTHORIZE!'); + let str = new String(req.body.password); + if (req.body.password === PASSWORD) { + res.cookie('nc-multiplex-auth', PASSWORD_HASH, { + maxAge: AUTH_MINUTES * 60 * 1000 + }); // ms + res.redirect(`/manage`); + } else { + res.redirect(`/error_not_authorized`); + } +}); + +// - - - - - - - - - - - - - - - - - - - - - - - - - - +// HOME + +// HANDLE "/" -- HOME PAGE +app.get('/', (req, res) => { + console.log(PRE + $T() + '================== Handling / ROOT!'); + if (HOMEPAGE_EXISTS) { + res.sendFile(path.join(__dirname, 'home.html')); + } else { + res.set('Content-Type', 'text/html'); + let response = logoHtml; + response += `Please contact Professor Kalani Craig, Institute for Digital Arts & Humanities at (812) 856-5721 (BH) or craigkl@indiana.edu with questions or concerns and/or to request information contained on this website in an accessible format.
`; + res.send(response); + } +}); + +// - - - - - - - - - - - - - - - - - - - - - - - - - - +// HANDLE STATIC FILES +// +// Route Everything else to :3000 +// :3000 is a "BASE" app that is actually a full NetCreate app +// but it does nothing but serve static files. +// +// This is necessary to catch static page requests that do not have +// parameters, such as imports, requires, .js, .css, etc. +// +// This HAS to come LAST! +// +app.use( + createProxyMiddleware('/', { + target: `http://localhost:3000`, + ws: true, + changeOrigin: true + }) +); + +// ---------------------------------------------------------------------------- + +// `request` parameters reference +// +// console.log(`\n\nREQUEST: ${req.originalUrl}`) +// console.log("...pathname", pathname); // `/hawaii/` +// console.log("...req.path", req.path); // '/' +// console.log("...req.baseUrl", req.baseUrl); // '/hawaii' +// console.log("...req.originalUrl", req.originalUrl); // '/hawaii/' +// console.log("...req.params", req.params); // '{}' +// console.log("...req.query", req.query); // '{}' +// console.log("...req.route", req.route); // undefined +// console.log("...req.hostname", req.hostname); // 'sub.localhost' +// console.log("...req.subdomains", req.subdomains); // [] + +/////////////////////////////////////////////////////////////////////////////// +// +// START PROXY + +app.listen(PORT_ROUTER, () => console.log(PRE, $T(), `running on port ${PORT_ROUTER}.`)); From 7db781c34313e5ba063170cc63eb78e02b82ff1b Mon Sep 17 00:00:00 2001 From: DSri Seah <11952933+dsriseah@users.noreply.github.com> Date: Mon, 19 Aug 2024 19:37:37 -0400 Subject: [PATCH 04/47] dev-sri/timestamps: clean-up nc-multiplex-sri so it's clearer to see what it does --- .gitignore | 6 +- nc-launch-config.js | 2 +- nc-launch-instance.js | 11 +- nc-multiplex-sri.js | 815 +++++++++++++++++++----------------------- package-lock.json | 80 ++++- package.json | 3 +- 6 files changed, 461 insertions(+), 456 deletions(-) diff --git a/.gitignore b/.gitignore index e6f09e8..4b20d62 100644 --- a/.gitignore +++ b/.gitignore @@ -8,4 +8,8 @@ # ignore custom password file # this should never be commited to the repo to expose the password -SESAME \ No newline at end of file +SESAME + +# ignore digital ocean start script, logs +do-start.sh +log.txt \ No newline at end of file diff --git a/nc-launch-config.js b/nc-launch-config.js index c27d70d..8d6a003 100755 --- a/nc-launch-config.js +++ b/nc-launch-config.js @@ -13,7 +13,7 @@ const path = require('node:path'); /// CONSTANTS & DECLARATIONS ////////////////////////////////////////////////// /// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -const PRE = '...nc-launch-config:'; +const PRE = '_MUX_CNF -'; const SPC = ''.padStart(PRE.length, ' '); /// REPO_PATHS is listed in order of precedence /// if multiple matches are found, a warning will be emitted diff --git a/nc-launch-instance.js b/nc-launch-instance.js index 5a5c5c8..806db41 100755 --- a/nc-launch-instance.js +++ b/nc-launch-instance.js @@ -24,7 +24,7 @@ const {strDateStamp, strTimeStamp} = require('./modules/nc-logging-utils'); const TSTART = `${strDateStamp()} ${strTimeStamp()}`; // Start time const $T=()=>`${strDateStamp()} ${strTimeStamp()}`; // Update time -const PRE = '...nc-launch-instance:'; +const PRE = '_MUX_LN -'; function writeConfig(data) { let script = NCUTILS.GetNCConfig(data); @@ -41,13 +41,10 @@ function promiseServer(port) { process.on('message', data => { console.log(PRE,$T()); - console.log(PRE,$T(), 'STARTING DB', data.db); - console.log(PRE,$T()); - - console.log(PRE,$T(), '1. Setting netcreate-config.js.'); + console.log(PRE, 'STARTING DB', data.db); + console.log(PRE, '1. Setting netcreate-config.js.'); writeConfig(data); - - console.log(PRE,$T(), '2. Starting server'); + console.log(PRE, '2. Starting server'); startServer(data.port); }); diff --git a/nc-multiplex-sri.js b/nc-multiplex-sri.js index cf154a6..621fedc 100644 --- a/nc-multiplex-sri.js +++ b/nc-multiplex-sri.js @@ -1,62 +1,62 @@ -/* +/*///////////////////////////////// ABOUT \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\ - nc-multiplex.js + To start a new graph: + http://localhost/graph/tacitus/ - This creates a node-based proxy server that will - spin up individual NetCreate graph instances - running on their own node processes. + If the graph already exists, it will be loaded. Otherwise it will create a new graph. + You need to be logged into the manager for this to work. - To start this manually: - `node nc-multiplex.js` + Manager runs on `http://localhost:80` - Or use `npm run start` + proxied routes + / => localhost:80 Root: NetCreate Manager page + /graph/ Multiplex
';
-
+/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
function RenderLoginForm() {
return `
`;
}
+/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
function RenderManager() {
let response = logoHtml;
response += ``;
- response += ``;
- response += ``;
- response += ``;
- response += RenderActiveGraphsList();
- response += RenderSavedGraphsList();
- response += `
`;
- response += ``;
- response += RenderNewGraphForm();
- response += RenderGenerateTokensForm();
- response += `
`;
- response += RenderMemoryReport();
- response += `Updated: ${new Date().toLocaleTimeString()}
`; - return response; -} -/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -/** Returns a list of databases in the runtime folder - * formatted as HTML- ';
- let dbs = NCUTILS.GetDatabaseNamesArray();
- dbs.forEach(db => {
- // Don't list dbs that are already open
- if (!m_DatabaseIsRunning(db))
- response += `
- ${db} `; - }); - response += `
`;
- response += `
-
-
`;
- response += `
`;
- return response;
-}
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-function RenderSavedGraphsList() {
- let response = `Active Graphs
-| Graph | Port | Websocket | - | |
| ${route.db} | -${route.port} | ${route.netport} | ${kill} | - |
Number of Active Graphs: ${ - m_child_processes.length - 1 - } / ${PROCESS_MAX} (max)`; - response += `
Reload browser to refresh Active Graphs.
`; - response += `"Stop" active graphs if you're not using them anymore.
(Closing the window does not stop the graph.)
`;
- response += `
`;
- return response;
-}
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-function RenderNewGraphForm() {
- return `
- Saved Graphs
`; - response += `Graph/database files saved on server. Click to open.
`; - response += RenderDatabaseList(); - response += `
-
`;
-}
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-function RenderGenerateTokensForm() {
- let response = `New Graph
- - -Add a template file with the same name to the /runtime folder. Otherwise, the system - will generate a copy from the default template.
- -`;
- let dbnames = NCUTILS.GetDatabaseNamesArray().reduce(
- (acc, curr) => acc + "',
- ''
- );
- response += `
-
-
`;
- return response;
-}
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-function RenderMemoryReport() {
- const mem = m_MemoryReport();
- const { unit, heapUsed, heapTotal, heapPercent, heapBuffer, pids } = mem;
- const { sysTotalGB, sysFreeGB } = mem;
-
- let response = `Generate Tokens
-
-
- -
- `;
- response += `Select a database, enter a class id, a project id, and number of tokens to generate. Then click "Generate Tokens".
- - - - -- -
MEMORY`; - response += ` :: Used: ${heapUsed}${unit} / ${heapTotal}${unit} (${heapPercent}%) `; - response += ` :: Remaining: ${heapBuffer}${unit}`; - response += ` :: LowMem: ${OutOfMemory()}
`; - const psOut = m_GetInstancePIDs(); - response += `DETECTED LAUNCH INSTANCES\n${psOut}`;
- return response;
-}
-
-/// PROCESS MANAGERS //////////////////////////////////////////////////////////
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-/** API: Use this to spawn a new node instance via m_PromiseApp.
- * @param {string} db - dataset name
- * @return {integer} port to be used by router function
- * in app.use(`/graph/:graph/:file`...).
- */
-async function SpawnApp(db) {
- try {
- const newProcessDef = await m_PromiseApp(db);
- AddChildProcess(newProcessDef);
- SaveProcessState();
- return newProcessDef.port;
- } catch (err) {
- console.error(PRE + 'SpawnApp Failed with error', err);
- }
-}
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-/** UTILITY: Promises a new node NetCreate application process. This forks
- * `nc-launch-instance.jssh`.
- *
- * To initiate the launch process, m_PromiseApp() uses process.send to
- * supply the parameters necessary to write its netcreate-config.js file
- * and start the server using the supplied ports.
- *
- * After the server has launched, the child process sends a message back
- * to report success or faiure.
- *
- * @param {string} db - dataset name to use
- * @resolve {object} sends the forked process and meta info
- */
-function m_PromiseApp(db) {
- return new Promise((resolve, reject) => {
- const ports = PickPort();
- if (ports === undefined) {
- reject(`Unable to find a free port. ${db} not created.`);
- }
- const { index, appport, netport } = ports;
- // 1. Define the fork
- const info = `${db}:${index}/${appport}/${netport}`; // ignored by launcher
- const forked = fork('./nc-launch-instance.jssh', [info]);
- // 2. Define fork success handler
- // When the child node process is up and running, it will
- // send a message back to this handler, which in turn
- // sends the new spec back to SpawnApp
- forked.on('message', msg => {
- const { event } = msg;
- if (event === 'SUCCESS') {
- console.log(
- PRE,
- $T(),
- `${CYN}instance confirmed '${db}' has launched (port ${appport})`,
- RST
- );
- const newProcessDef = {
- db,
- port: ports.appport,
- netport: ports.netport,
- portindex: ports.index,
- GOOGLEA: GOOGLEA,
- process: forked
- };
- resolve(newProcessDef); // pass to SpawnApp
- } else {
- console.log(PRE, `${RED}instance '${db}' failed to start`, RST);
- reject(`Failed to start instance '${db}'`);
- }
- });
-
- // 3. Send message to start fork
- // This sends the necessary startup prarameters to nc-start.js
- // When nc-start is completed, it will call the message
- // handler in #2 above
- const ncStartParams = {
- db,
- port: ports.appport,
- netport: ports.netport,
- process: forked,
- IP,
- GOOGLEA
- };
- console.log(
- PRE,
- `initializing launch of '${db}' on port:${ports.appport} netport:${ports.netport}`
- );
- forked.send(ncStartParams);
- });
-}
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-/** Add the newProcess to the array of m_child_processes
- * but only if it doesn't already exist
- * @param {object} route
- */
-function AddChildProcess(newProcess) {
- if (m_child_processes.find(route => route.db === newProcess.db)) return;
- m_child_processes.push(newProcess);
-}
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-/** Save the Process Datastructures from m_child_processes and m_proxy_pool
- * to a file. This is used to save the state of the multiplex server */
-function SaveProcessState() {
- const process_entries = m_child_processes.map(route => {
- return {
- db: route.db,
- port: route.port,
- netport: route.netport,
- portindex: route.portindex
- };
- });
- const ncmState = {
- child_processes: process_entries,
- proxy_pool: m_proxy_pool
- };
- fs.writeFileSync('.nc-process-state.json', JSON.stringify(ncmState));
-}
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-/** Restore Process Datastructures, bypassing the m_PromiseApp() process
- * Duplicated much of m_PromiseApp()
- */
-async function LoadProcessState(child_processes, proxy_pool) {
- console.log(PRE, `${GRNR} <<< RESTORING DATASETS <<< ${RST}`);
- for (route of child_processes) {
- const { db, port, netport, portindex } = route;
- const info = `${db}:${port}/${netport}`;
- console.log(PRE, `${GRN}<<< restarting '${db}' on ${info} ${RST}`);
- await new Promise((resolve, reject) => {
- const forked = fork('./nc-launch-instance.jssh', [info]);
- // define success handler
- forked.on('message', msg => {
- const { event } = msg;
- if (event === 'SUCCESS') {
- console.log(PRE, $T(), `${GRN}<<< RESTORED '${db}' on (port ${port})`, RST);
- route.process = forked;
- resolve();
- } else {
- console.log(PRE, `${RED}<<< RESTORE '${db}' failed`, RST);
- reject(`Failed to restart instance '${db}'`);
- }
- }); // end forked.on
- const ncStartParams = {
- db,
- port,
- netport,
- portindex,
- GOOGLEA: GOOGLEA,
- process: forked
- };
- forked.send(ncStartParams);
- }); // end promise
- } // end for
- m_proxy_pool = proxy_pool;
- m_child_processes = child_processes;
-}
-
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-/** Used to check if we have enough memory to start a new node process
- * This is used to prevent node from starting too many processes.
- */
-function OutOfMemory() {
- let free = os.freemem() / 1024; // mb
- return free < MEMORY_MIN;
-}
-
-/*///////////////////////////// RUNTIME START \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\
-
-
- Start of Server Execution on Module Load
- - emit console header timestamp
- - check .nvmrc and node version
- - detect home page availability
- - read management password from SESAME file
-
-
-\*\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\ * /////////////////////////////////////*/
-
-/// RUNTIME: START LOGGING OUTPUT /////////////////////////////////////////////
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-console.log(`\n\n\n`);
-console.log('-'.repeat(80));
-console.log(PRE, 'nc-multiplex started:', $T());
-console.log(PRE);
-
-/// RUNTIME: CHECK FOR BASE REPO //////////////////////////////////////////////
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-const { primary, count } = ScanForRepos();
-if (primary === undefined) {
- console.log(PRE, `${RED}ERROR: no primary NetCreate repo found${RST}`);
- console.log(SPC, `Make sure you installed a repo to launch from.`);
- console.log(SPC, `See ${WARN}ReadMe.md${RST} for details.`);
- process.exit(1);
-}
-if (count === 1) {
- console.log(PRE, `reference subrepo: ${primary.repo}`);
-} else {
- console.log(
- PRE,
- `${WARN}WARNING: multiple NetCreate repos (${count}) found${RST}`
- );
- console.log(SPC, `defaulting to ${WARN}${primary.repo}${RST}`);
-}
-
-
-/// RUNTIME: CHECK NODE VERSION ///////////////////////////////////////////////
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-try {
- NVMRC = fs.readFileSync('./.nvmrc', 'utf8').trim();
-} catch (err) {
- console.error('could not read .nvmrc', err);
- throw Error(`Could not read .nvmrc ${err}`);
-}
-exec('node --version', (error, stdout, stderr) => {
- if (stdout) {
- stdout = stdout.trim();
- if (stdout !== NVMRC) {
- console.log('\x1b[97;41m');
- console.log(PRE, '*** NODE VERSION MISMATCH ***');
- console.log(PRE, '.. expected', NVMRC, 'got', stdout);
- console.log(PRE, '.. did you remember to run nvm use?\x1b[0m');
- console.log('');
- }
- console.log(PRE, 'NODE VERSION:', stdout, 'OK');
- }
-});
-
-/// RUNTIME: DETECT CUSTOM HOME PAGE //////////////////////////////////////////
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-try {
- fs.accessSync('home.html', fs.constants.R_OK);
- HOMEPAGE_EXISTS = true;
-} catch (err) {
- // no home page, use default
- HOMEPAGE_EXISTS = false;
-}
-
-/// RUNTIME: SET PASSWORD /////////////////////////////////////////////////////
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-/// If 'SESAME' file exists, use the password in there instead of default
-try {
- let sesame = fs.readFileSync('SESAME', 'utf8');
- PASSWORD = sesame;
-} catch (err) {
- PASSWORD = DEFAULT_PASSWORD; // no password, use default
-}
-PASSWORD_HASH = GetHash(PASSWORD);
-
-/// RUNTIME: START HEARTBEAT TIMER ///////////////////////////////////////////////
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-m_MemLog();
-setInterval(m_MemLog, HEARTBEAT * 60 * 1000); // log memory usage every X minutes
-
-/// EXPRESS CONFIGURATION /////////////////////////////////////////////////////
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-// START BASE APP
-// This is needed to handle static file requests.
-// Most imports/requires do not specify the db route /graph/dbname/
-// so we need to provide a base app that responds to those static file
-// requests. This starts a generic "base" dataset at port 3000.
-
-const app = express();
-app.use(express.urlencoded({ extended: true }));
-app.use(cookieParser());
-
-/// EXPRESS DATA ACCESS ROUTES ////////////////////////////////////////////////
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-/** HANDLE /graph/:graph/netcreate-config.js
- * The config file needs to be dynamically served for each node instance,
- * otherwise they would share (and clobber) the same static file.
- * This route has to go before /graph/:graph/:file? below
- */
-app.get(`/graph/:graph/${NC_URL_CONFIG}`, (req, res) => {
- const db = req.params.graph;
- let response = '';
- const child = m_child_processes.find(child => child.db === db);
- if (child) {
- console.log(
- PRE,
- $T(),
- `GET /graph/${child.db}/${NC_URL_CONFIG} (client ${req.ip})`
- );
- response += NCUTILS.GetNCConfig(child);
- } else {
- console.log(PRE, $T(), 'no graph-specific netcreate-config.js found for', db);
- response += 'ERROR: No database found to netcreate-config.js: ' + db;
- }
- res.set('Content-Type', 'application/javascript');
- res.send(response);
-});
-
-/// PROXY GRAPH REDIRECT //////////////////////////////////////////////////////
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-/** CONFIG FUNCTION: m_RouterLogic used by http-proxy-middleware to route to
- * the correct port
- * @param {Express.Request} req The router function tries to route to the
- * correct port and path, checking whether it already exists. If flags allow,
- * it will spawn a new process if able to.
- */
-async function m_RouterLogic(req) {
- if (req.params === undefined) {
- console.log(PRE, $T(), 'ERROR in m_RouterLogic: req.params is undefined');
- console.log(PRE, $T(), 'req.ip:', req.ip);
- }
- const db = req.params.graph;
- let port;
- let path = '';
-
- // Authenticate to allow spawning
- let ALLOW_SPAWN = false;
- if (CookieIsValid(req)) {
- ALLOW_SPAWN = true;
- }
- // Is it already running?
- let route = m_child_processes.find(route => route.db === db);
- if (route) {
- // a) Yes. Use existing route!
- console.log(
- PRE,
- $T(),
- `>>> proxying request /graph/${route.db}:80 to :${route.port} (client ${req.ip})`
- );
- port = route.port;
- } else if (PortPoolIsEmpty()) {
- // b) No more ports available.
- console.log(PRE, $T(), '!!! no more ports. Not spawning', db);
- path = `/error_out_of_ports`;
- } else if (OutOfMemory()) {
- // c) Not enough memory to spawn new node instance
- console.log(PRE, $T(), '!!! out of memory. Not spawning', db);
- path = `/error_out_of_memory`;
- } else if (AUTO_NEW || ALLOW_SPAWN) {
- // c) Not defined yet, Create a new one.
- let reason = ALLOW_SPAWN ? 'spawn=true ' : 'spawn=false ';
- reason += AUTO_NEW ? 'new=true' : 'new=false';
- console.log(PRE, $T(), `*** auto spawning (${reason})`, db);
- port = await SpawnApp(db);
- } else {
- // c) Not defined or running, and not allowed to spawn
- console.log(
- PRE,
- $T(),
- `!!! /graph/${db} not allowed to spawn (AUTO_NEW=ALOW_SPAWN=false)`
- );
- path = `/error_no_database?graph=${db}`;
- }
- return {
- protocol: 'http:',
- host: 'localhost',
- port: port,
- path: path // if path is empty, it will be ignored
- };
-}
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-/** CONFIG FUNCTION: m_ProxyFilter nominally rewrites the /graph/{db} to
- * localhost:{port}, but it also contains some debug code to detect if
- * req.params is undefined as we have seen this on our servers and are trying
- * to log the conditions when this happens.
- * @param {string} rpath - route to check (remainder after any params)
- * @param {Express.Request} req - request object
- */
-function m_ProxyFilter(rpath, req) {
- // sri debug detect if req.params is undefined
- if (req === undefined) {
- console.log(PRE, $T(), `??? USE ${route} req is undefined`);
- return false;
- }
- // detect if this is a websocket connection
- if (req.headers && req.headers.upgrade) {
- const { upgrade } = req.headers;
- if (typeof upgrade === 'string' && upgrade.toLowerCase() === 'websocket') {
- const ip = req.headers['x-forwarded-for'] || req.connection.remoteAddress;
- console.log(
- PRE,
- $T(),
- `${WARN}??? USE ${rpath} is a websocket connection attempt from ${ip}`,
- RST
- );
- }
- }
- if (req.params === undefined) {
- console.log(PRE, $T(), `${WARN}??? USE ${rpath} req.params is undefined`, RST);
- return false;
- }
- // pass if there is a file
- // (srinote: this param only contains the first segment, which may be a bug)
- if (req.params.file) return true; // only first segment of path (bug?)
- // pass if there is a trailing '/'
- if (req.params.graph && req.originalUrl.endsWith('/')) return true; // legit graph
- return false;
-}
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-/** CONFIG FUNCTION: m_ProxyRewrite rewrites the path to remove the /graph/db/
- * prefix, used to reroute the calls to the correct port in the main proxy
- * middleware for /graph/dbname/ requests.
- */
-function m_ProxyRewrite(rpath, req) {
- // remove '/graph/db/' for the rerouted calls
- // e.g. localhost/graph/hawaii/#/edit/mop => localhost:3000/#/edit/mop
-
- const fullPath = req.originalUrl;
- if (req.originalUrl === undefined) {
- console.log(PRE, $T(), '??? ProxyRewrite req.originalUrl is undefined');
- return rpath;
- }
-
- /*/ srinote: in hpm 3, path is the remainder after the /graph/db/ prefix
- instead of the full path as before, so use req.originalUrl instead
- /*/
-
- // const rewrite = rpath.replace(`/graph/${req.params.graph}`, '');
- const rewrite = fullPath.replace(`/graph/${req.params.graph}/`, '/');
- return rewrite;
-}
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-/** MAIN HANDLER /graph/:graph/:file?
- * The intention is to proxy file requests from /graph/dbname/filename
- * to localhost:3000/filename (e.g. `netcreate-config.js` requests).
- */
-const proxy = createProxyMiddleware({
- // this is the actual proxy setup object
- router: m_RouterLogic,
- pathFilter: m_ProxyFilter,
- pathRewrite: m_ProxyRewrite,
- target: `http://localhost:3000`, // default fallback, router takes precedence
- ws: true,
- changeOrigin: true,
- on: {
- error: (err, req, res, target) => {
- console.log(PRE, $T(), '??? Proxy Error:', err);
- if (res.writeHead && !res.headersSent) {
- res.writeHead(500, {
- 'Content-Type': 'text/plain'
- });
- }
- res.end('Something went wrong with the proxy.');
- },
- close: (proxyRes, proxySocket, proxyHead) => {
- console.log(PRE, $T(), '??? Proxy client closed');
- }
- }
-});
-app.use('/graph/:graph/:file?', proxy);
-
-/// EXPRESS ERROR ROUTES //////////////////////////////////////////////////////
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-/// HANDLE NO DATABASE -- RETURN ERROR
-app.get('/error_no_database', (req, res) => {
- // get the ?graph value the query string
- let db = '';
- if (req.query && req.query.graph) db = req.query.graph;
- // overblown pretty-print formating
- if (db.endsWith('/')) db = db.slice(0, -1);
- db = db.length > 0 ? ` '${db}' ` : ' ';
- m_SendErrorResponse(res, `Requested graph${db}is not currently open`);
-});
-/// HANDLE NOT AUTHORIZED -- RETURN ERROR
-app.get('/error_not_authorized', (req, res) => {
- m_SendErrorResponse(res, 'Not Authorized.');
-});
-/// HANDLE OUT OF PORTS -- RETURN ERROR
-app.get('/error_out_of_ports', (req, res) => {
- m_SendErrorResponse(res, "Ran out of ports. Can't start the graph.");
-});
-/// HANDLE OUT OF MEMORY -- RETURN ERROR
-app.get('/error_out_of_memory', (req, res) => {
- m_SendErrorResponse(res, "Ran out of Memory. Can't start the graph.");
-});
-/// HANDLE MISSING TRAILING ".../" -- RETURN ERROR
-app.get('/graph/:file', (req, res) => {
- m_SendErrorResponse(res, "Bad URL. Missing trailing '/'.");
-});
-
-// EXPRESS UTILITY ROUTES /////////////////////////////////////////////////////
-/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-// HANDLE "/kill/:graph" -- KILL REQUEST
-app.get('/kill/:graph/', (req, res) => {
- if (req.params === undefined) {
- console.log(PRE, $T(), 'ERROR: req.params is undefined for /kill/:graph/');
- const fullUrl = req.protocol + '://' + req.get('host') + req.originalUrl;
- console.log(PRE, `error url: ${fullUrl}`);
- console.log(PRE, `client ip: ${req.ip}`);
- return;
- }
- const db = req.params ? req.params.graph : '';
- console.log(PRE, $T(), `GET /kill/${db} (client ${req.ip})`);
- res.set('Content-Type', 'text/html');
- let response = `NetCreate Manager
`; - - const child = m_child_processes.find(child => child.db === db); - if (child) { - try { - child.process.kill(); - // Return the port index to the pool - ReleasePort(child.portindex); - // Remove child from m_child_processes - m_child_processes = m_child_processes.filter(child => child.db !== db); - SaveProcessState(); // save state after updating process data structure - console.log(PRE, $T(), `/kill/${db} process killed`); - response += `Process ${db} killed.
`; - } catch (e) { - console.log(PRE, $T(), `/kill/${db} process failed with ${e}`); - response += `ERROR while trying to kill ${db}
`; - response += `${e}
`; - } - } else { - console.log(PRE, $T(), `/kill/${db} database not found`); - response += 'ERROR: No database found to kill: ' + db; - } - response += ``; - res.send(response); -}); -/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -/// HANDLE "/maketoken" -- GENERATE TOKENS -app.get('/maketoken/:clsid/:projid/:dataset/:numgroups', (req, res) => { - const { clsid, projid, dataset, numgroups } = req.params; - console.log( - PRE, - $T(), - 'maketoken GET on /maketoken', - clsid, - projid, - dataset, - numgroups - ); - let response = MakeToken(clsid, projid, dataset, parseInt(numgroups)); - res.set('Content-Type', 'text/html'); - res.send(response); -}); - -/// EXPRESS MANAGEMENT ROUTES ////////////////////////////////////////////////// -/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - *\ - Authentication uses a cookie with a hashed password. - The cookie expires after AUTH_MINUTES - - 1. /manage initially redirects to /login - 2. On the /login form, the administrator enters a password - 3. /login POSTS to /authorize - 4. /authorize checks the password against the PASSWORD - If there's no match, the user is redirected to /error_not_authorized - 5. /authorize then sets a cookie with the PASSWORD_HASH and - the user is redirected to /manage - 6. /manage checks the cookie against the PASSWORD_HASH - If the cookie matches, the manage page is displayed - If the cookie doesn't match, the user is redirected back to /login - 7. The cookie expires after AUTH_MINUTES -/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */ -/// HANDLE MANAGER PAGE -app.get('/manage', (req, res) => { - console.log(PRE, $T(), `GET /manage (client ${req.ip})`); - if (CookieIsValid(req)) { - res.set('Content-Type', 'text/html'); - res.send(RenderManager()); - } else { - res.redirect(`/login`); - } -}); -/// 2. redirected from /manage -app.get('/login', (req, res) => { - console.log(PRE, $T(), `GET /login (client ${req.ip})`); - if (CookieIsValid(req)) { - // Cookie already set, no need to log in, redirect to manage - res.redirect(`/manage`); - } else { - // Show login form - res.set('Content-Type', 'text/html'); - res.send(logoHtml + RenderLoginForm()); - } -}); -/// 3. post from Login Form -app.post('/authorize', (req, res) => { - console.log(PRE, $T(), `POST /authorize (client ${req.ip})`); - let str = new String(req.body.password); - if (req.body.password === PASSWORD) { - res.cookie('nc-multiplex-auth', PASSWORD_HASH, { - maxAge: AUTH_MINUTES * 60 * 1000 - }); // ms - res.redirect(`/manage`); - } else { - res.redirect(`/error_not_authorized`); - } -}); - -/// EXPRESS HOME PAGE ROUTES ////////////////////////////////////////////////// -/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -/// HANDLE "/" -- HOME PAGE -app.get('/', (req, res) => { - console.log(PRE, $T(), `GET / (client ${req.ip})`); - if (HOMEPAGE_EXISTS) { - console.log(PRE, '.. sending home.html'); - res.sendFile(path.join(__dirname, 'home.html')); - } else { - console.log(PRE, '.. no home.html, sending default'); - res.set('Content-Type', 'text/html'); - let response = logoHtml; - response += `Please contact Professor Kalani Craig, Institute for Digital Arts & Humanities at (812) 856-5721 (BH) or craigkl@indiana.edu with questions or concerns and/or to request information contained on this website in an accessible format.
`; - res.send(response); - } -}); - -/// EXPRESS STATIC FILE ROUTES ///////////////////////////////////////////////// -/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -/** Route Everything else to :3000 - * :3000 is a "BASE" app that is actually a full NetCreate app - * but it does nothing but serve static files. - * - * This is necessary to catch static page requests that do not have - * parameters, such as imports, requires, .js, .css, etc. - * - * This HAS to be the last route! - */ -app.use( - '/', - createProxyMiddleware({ - target: `http://localhost:3000`, - ws: true, - changeOrigin: true - }) -); - -/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -/** REQUEST PARAMETERS REFERENCE - * - console.log(`\n\nREQUEST: ${req.originalUrl}`) - console.log("...pathname", pathname); // `/hawaii/` - console.log("...req.path", req.path); // '/' - console.log("...req.baseUrl", req.baseUrl); // '/hawaii' - console.log("...req.originalUrl", req.originalUrl); // '/hawaii/' - console.log("...req.params", req.params); // '{}' - console.log("...req.query", req.query); // '{}' - console.log("...req.route", req.route); // undefined - console.log("...req.hostname", req.hostname); // 'sub.localhost' - console.log("...req.subdomains", req.subdomains); // [] -**/ - -/// EXPRESS START LISTENING /////////////////////////////////////////////////// -/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -app.listen(PORT_ROUTER, () => { - console.log(PRE, $T()); - console.log(PRE, `NC-MULTIPLEX Express Server running on port ${PORT_ROUTER}.`); - - // if .nc-process-state.json exists, read and parse it - if (!fs.existsSync('.nc-process-state.json')) { - console.log(PRE, 'No .nc-process-state.json found. Starting fresh.'); - SpawnApp('base'); - SaveProcessState(); - } else { - try { - const text = fs.readFileSync('.nc-process-state.json', 'utf8'); - const json = JSON.parse(text); - const { child_processes, proxy_pool } = json; - if (child_processes.length > 0) { - LoadProcessState(child_processes, proxy_pool); - } else { - SpawnApp('base'); - SaveProcessState(); - } - } catch (err) { - console.log(PRE, $T(), 'error loading .nc-process-state.json', err); - console.log( - PRE, - $T(), - 'check contents of file, delete file, and restart manually' - ); - process.exit(1); - } - } -}); - -/// PROCESS SIGNAL HANDLERS /////////////////////////////////////////////////// -/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -process.on('SIGINT', () => { - console.log(PRE, '*** SIGINT RECEIVED - EXITING ***'); - console.log(PRE, 'nc-multiplex stopped via SIGINT:', $T()); - process.exit(0); -}); -/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -process.on('SIGTERM', () => { - console.log(PRE, '*** SIGTERM RECEIVED - EXITING ***'); - console.log(PRE, 'nc-multiplex stopped via SIGTERM:', $T()); - process.exit(0); -}); diff --git a/nc-multiplex.js b/nc-multiplex.js index cf154a6..c93ed95 100644 --- a/nc-multiplex.js +++ b/nc-multiplex.js @@ -1,258 +1,182 @@ -/* +/*///////////////////////////////// ABOUT \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\ - nc-multiplex.js + NETCREATE MULTIPLEX SERVER - REMIX (2024) + Reformatted for debugging by Sri, so new bugs are mine :-) - This creates a node-based proxy server that will - spin up individual NetCreate graph instances - running on their own node processes. + --- original comments --- - To start this manually: - `node nc-multiplex.js` + To start a new graph: + http://localhost/graph/tacitus/ - Or use `npm run start` + If the graph already exists, it will be loaded. Otherwise it will create a new graph. + You need to be logged into the manager for this to work. - Then go to `localhost` to view the manager. - (NOTE: This runs on port 80, so need to add a port) + Manager runs on `http://localhost:80` - The manager will list the running databases. + proxied routes + / => localhost:80 Root: NetCreate Manager page + /graph/${msg}
+ ` + ); } -/** - * Returns true if the db is currently running as a process - * @param {string} db - */ -function DBIsRunning(db) { - return childProcesses.find(route => route.db === db); -} - -/** - * Generates a list of tokens using the NetCreate commoon-session module - * REVIEW: Requiring a module from the secondary netcreate-2018 repo - * is a little iffy. - * @param {string} clsId - * @param {string} projId - * @param {string} dataset - * @param {integer} numGroups - * @return {string} +/// SESSION OPERATIONS //////////////////////////////////////////////////////// +/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +/** Generates a list of tokens using the NetCreate common-session module + * REVIEW: Requiring a module from the secondary netcreate-2018 repo + * is a little iffy. + * @param {string} clsId - classId + * @param {string} projId - projectId + * @param {string} dataset - database name + * @param {integer} numGroups - number of tokens to generate + * @return {string} */ function MakeToken(clsId, projId, dataset, numGroups) { - const rpath = `${NC_SERVER_PATH}/app/unisys/common-session.js`; - const SESSION = require(rpath); // from nc-logic.js if (typeof clsId !== 'string') return 'args: str classId, str projId, str dataset, int numGroups'; @@ -274,20 +198,19 @@ function MakeToken(clsId, projId, dataset, numGroups) { } return out; } - -/** - * Used to generate a hashed password for use in the cookie - * so that password text is not visible in the cookie. - * @param {string} pw +/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +/** Used to generate a hashed password for use in the cookie + * so that password text is not visible in the cookie. + * @param {string} pw - plain text password + * @return {string} hash of password */ function GetHash(pw) { let hash = crypto.createHash('sha1').update(pw).digest('hex'); return hash; } - -/** - * HASH is generated from the PASSWORD - * @param {string} pw +/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +/** HASH is generated from the PASSWORD + * @param {string} pw */ function CookieIsValid(req) { if (!req || !req.cookies) return false; @@ -296,60 +219,80 @@ function CookieIsValid(req) { return pw === PASSWORD_HASH; } -///// PORT POOL --------------------------------------------------------------- - -// Initialize port pool -// port 0 is for the base app -const port_pool = []; // array of available port indices, usu [1...100] +/// PORT POOLING ////////////////////////////////////////////////////////////// +/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +/** The proxy server runs on port 80, hosting various management routes as well + * as the /graph/ Multiplex
';
-
+/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
function RenderLoginForm() {
return `
`;
}
+/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
function RenderManager() {
let response = logoHtml;
response += ``;
response += ``;
response += ``;
@@ -324,7 +340,7 @@ function RenderManager() {
response += RenderGenerateTokensForm();
response += ``;
response += RenderMemoryReport();
- response += `Updated: ${new Date().toLocaleTimeString()}
`; + response += `page last loaded on: ${m_stat.refreshed.toLocaleTimeString()}
`; return response; } /// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -453,16 +469,16 @@ function RenderGenerateTokensForm() { } /// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - function RenderMemoryReport() { - const mem = m_MemoryReport(); - const { unit, heapUsed, heapTotal, heapPercent, heapBuffer, pids } = mem; - const { sysTotalGB, sysFreeGB } = mem; - - let response = `MEMORY`; - response += ` :: Used: ${heapUsed}${unit} / ${heapTotal}${unit} (${heapPercent}%) `; - response += ` :: Remaining: ${heapBuffer}${unit}`; - response += ` :: LowMem: ${OutOfMemory()}
`; + const { sysUsedMB, sysFreeMB, sysTotalMB, sysPercent } = m_MemoryReport(); + let response = ''; + response += `SERVER STARTED AT :: ${m_stat.start}`;
+ response += `SERVER MEMORY LOAD`;
+ response += ` :: Used: ${sysUsedMB}MB / ${sysTotalMB}MB (${sysPercent}%)`;
+ response += ` :: Remaining: ${sysFreeMB}MB`;
+ response += ` :: LowMem: ${OutOfMemory()}`;
+ response += ``;
const psOut = m_GetInstancePIDs();
- response += `DETECTED LAUNCH INSTANCES\n${psOut}`;
+ response += `LAUNCHED PROCESSES ::\n\n${psOut}`;
return response;
}
@@ -626,7 +642,7 @@ async function LoadProcessState(child_processes, proxy_pool) {
*/
function OutOfMemory() {
let free = os.freemem() / 1024; // mb
- return free < MEMORY_MIN;
+ return free < SYSMEM_MIN;
}
/*///////////////////////////// RUNTIME START \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\
@@ -643,9 +659,16 @@ function OutOfMemory() {
/// RUNTIME: START LOGGING OUTPUT /////////////////////////////////////////////
/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+const m_stat = {
+ start: '', // timestamp of server start
+ refreshed: '' // timestamp of last refresh
+};
+m_stat.start = $T();
+fs.writeFileSync('.nc-server-start.txt', m_stat.start);
+///
console.log(`\n\n\n`);
console.log('-'.repeat(80));
-console.log(PRE, 'nc-multiplex started:', $T());
+console.log(PRE, 'nc-multiplex started:', m_stat.start);
console.log(PRE);
/// RUNTIME: CHECK FOR BASE REPO //////////////////////////////////////////////
@@ -660,14 +683,10 @@ if (primary === undefined) {
if (count === 1) {
console.log(PRE, `reference subrepo: ${primary.repo}`);
} else {
- console.log(
- PRE,
- `${WARN}WARNING: multiple NetCreate repos (${count}) found${RST}`
- );
+ console.log(PRE, `${WARN}WARNING: multiple NetCreate repos (${count}) found${RST}`);
console.log(SPC, `defaulting to ${WARN}${primary.repo}${RST}`);
}
-
/// RUNTIME: CHECK NODE VERSION ///////////////////////////////////////////////
/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
try {
@@ -736,7 +755,7 @@ app.use(cookieParser());
* This route has to go before /graph/:graph/:file? below
*/
app.get(`/graph/:graph/${NC_URL_CONFIG}`, (req, res) => {
- const db = req.params.graph;
+ const db = STAT.graph;
let response = '';
const child = m_child_processes.find(child => child.db === db);
if (child) {
@@ -763,11 +782,11 @@ app.get(`/graph/:graph/${NC_URL_CONFIG}`, (req, res) => {
* it will spawn a new process if able to.
*/
async function m_RouterLogic(req) {
- if (req.params === undefined) {
- console.log(PRE, $T(), 'ERROR in m_RouterLogic: req.params is undefined');
+ if (STAT === undefined) {
+ console.log(PRE, $T(), 'ERROR in m_RouterLogic: STAT is undefined');
console.log(PRE, $T(), 'req.ip:', req.ip);
}
- const db = req.params.graph;
+ const db = STAT.graph;
let port;
let path = '';
@@ -819,13 +838,13 @@ async function m_RouterLogic(req) {
/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
/** CONFIG FUNCTION: m_ProxyFilter nominally rewrites the /graph/{db} to
* localhost:{port}, but it also contains some debug code to detect if
- * req.params is undefined as we have seen this on our servers and are trying
+ * STAT is undefined as we have seen this on our servers and are trying
* to log the conditions when this happens.
* @param {string} rpath - route to check (remainder after any params)
* @param {Express.Request} req - request object
*/
function m_ProxyFilter(rpath, req) {
- // sri debug detect if req.params is undefined
+ // sri debug detect if STAT is undefined
if (req === undefined) {
console.log(PRE, $T(), `??? USE ${route} req is undefined`);
return false;
@@ -843,15 +862,15 @@ function m_ProxyFilter(rpath, req) {
);
}
}
- if (req.params === undefined) {
- console.log(PRE, $T(), `${WARN}??? USE ${rpath} req.params is undefined`, RST);
+ if (STAT === undefined) {
+ console.log(PRE, $T(), `${WARN}??? USE ${rpath} STAT is undefined`, RST);
return false;
}
// pass if there is a file
// (srinote: this param only contains the first segment, which may be a bug)
- if (req.params.file) return true; // only first segment of path (bug?)
+ if (STAT.file) return true; // only first segment of path (bug?)
// pass if there is a trailing '/'
- if (req.params.graph && req.originalUrl.endsWith('/')) return true; // legit graph
+ if (STAT.graph && req.originalUrl.endsWith('/')) return true; // legit graph
return false;
}
/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
@@ -873,8 +892,8 @@ function m_ProxyRewrite(rpath, req) {
instead of the full path as before, so use req.originalUrl instead
/*/
- // const rewrite = rpath.replace(`/graph/${req.params.graph}`, '');
- const rewrite = fullPath.replace(`/graph/${req.params.graph}/`, '/');
+ // const rewrite = rpath.replace(`/graph/${STAT.graph}`, '');
+ const rewrite = fullPath.replace(`/graph/${STAT.graph}/`, '/');
return rewrite;
}
/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
@@ -940,14 +959,14 @@ app.get('/graph/:file', (req, res) => {
/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// HANDLE "/kill/:graph" -- KILL REQUEST
app.get('/kill/:graph/', (req, res) => {
- if (req.params === undefined) {
- console.log(PRE, $T(), 'ERROR: req.params is undefined for /kill/:graph/');
+ if (STAT === undefined) {
+ console.log(PRE, $T(), 'ERROR: STAT is undefined for /kill/:graph/');
const fullUrl = req.protocol + '://' + req.get('host') + req.originalUrl;
console.log(PRE, `error url: ${fullUrl}`);
console.log(PRE, `client ip: ${req.ip}`);
return;
}
- const db = req.params ? req.params.graph : '';
+ const db = STAT ? STAT.graph : '';
console.log(PRE, $T(), `GET /kill/${db} (client ${req.ip})`);
res.set('Content-Type', 'text/html');
let response = `NetCreate Manager
`; @@ -978,7 +997,7 @@ app.get('/kill/:graph/', (req, res) => { /// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - /// HANDLE "/maketoken" -- GENERATE TOKENS app.get('/maketoken/:clsid/:projid/:dataset/:numgroups', (req, res) => { - const { clsid, projid, dataset, numgroups } = req.params; + const { clsid, projid, dataset, numgroups } = STAT; console.log( PRE, $T(), @@ -1012,8 +1031,12 @@ app.get('/maketoken/:clsid/:projid/:dataset/:numgroups', (req, res) => { /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */ /// HANDLE MANAGER PAGE app.get('/manage', (req, res) => { + m_stat.refreshed = new Date(); console.log(PRE, $T(), `GET /manage (client ${req.ip})`); if (CookieIsValid(req)) { + res.cookie('nc-multiplex-auth', PASSWORD_HASH, { + maxAge: AUTH_MINUTES * 60 * 1000 + }); // ms res.set('Content-Type', 'text/html'); res.send(RenderManager()); } else { @@ -1091,7 +1114,7 @@ app.use( console.log("...req.path", req.path); // '/' console.log("...req.baseUrl", req.baseUrl); // '/hawaii' console.log("...req.originalUrl", req.originalUrl); // '/hawaii/' - console.log("...req.params", req.params); // '{}' + console.log("...STAT", STAT); // '{}' console.log("...req.query", req.query); // '{}' console.log("...req.route", req.route); // undefined console.log("...req.hostname", req.hostname); // 'sub.localhost' @@ -1136,12 +1159,14 @@ app.listen(PORT_ROUTER, () => { /// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - process.on('SIGINT', () => { console.log(PRE, '*** SIGINT RECEIVED - EXITING ***'); + console.log(PRE); console.log(PRE, 'nc-multiplex stopped via SIGINT:', $T()); process.exit(0); }); /// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - process.on('SIGTERM', () => { console.log(PRE, '*** SIGTERM RECEIVED - EXITING ***'); + console.log(PRE); console.log(PRE, 'nc-multiplex stopped via SIGTERM:', $T()); process.exit(0); }); From c9471ee9111db30d92d8f771f4e8b65c59da7cc6 Mon Sep 17 00:00:00 2001 From: DSri Seah <11952933+dsriseah@users.noreply.github.com> Date: Sun, 25 Aug 2024 00:49:04 -0400 Subject: [PATCH 36/47] timestamps: fix weird change of "req.params'" to "STAT" --- nc-multiplex.js | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/nc-multiplex.js b/nc-multiplex.js index 4f71824..516d25c 100644 --- a/nc-multiplex.js +++ b/nc-multiplex.js @@ -755,7 +755,7 @@ app.use(cookieParser()); * This route has to go before /graph/:graph/:file? below */ app.get(`/graph/:graph/${NC_URL_CONFIG}`, (req, res) => { - const db = STAT.graph; + const db = req.params.graph; let response = ''; const child = m_child_processes.find(child => child.db === db); if (child) { @@ -782,11 +782,11 @@ app.get(`/graph/:graph/${NC_URL_CONFIG}`, (req, res) => { * it will spawn a new process if able to. */ async function m_RouterLogic(req) { - if (STAT === undefined) { - console.log(PRE, $T(), 'ERROR in m_RouterLogic: STAT is undefined'); + if (req.params === undefined) { + console.log(PRE, $T(), 'ERROR in m_RouterLogic: req.params is undefined'); console.log(PRE, $T(), 'req.ip:', req.ip); } - const db = STAT.graph; + const db = req.params.graph; let port; let path = ''; @@ -838,13 +838,13 @@ async function m_RouterLogic(req) { /// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - /** CONFIG FUNCTION: m_ProxyFilter nominally rewrites the /graph/{db} to * localhost:{port}, but it also contains some debug code to detect if - * STAT is undefined as we have seen this on our servers and are trying + * req.params is undefined as we have seen this on our servers and are trying * to log the conditions when this happens. * @param {string} rpath - route to check (remainder after any params) * @param {Express.Request} req - request object */ function m_ProxyFilter(rpath, req) { - // sri debug detect if STAT is undefined + // sri debug detect if req.params is undefined if (req === undefined) { console.log(PRE, $T(), `??? USE ${route} req is undefined`); return false; @@ -862,15 +862,15 @@ function m_ProxyFilter(rpath, req) { ); } } - if (STAT === undefined) { - console.log(PRE, $T(), `${WARN}??? USE ${rpath} STAT is undefined`, RST); + if (req.params === undefined) { + console.log(PRE, $T(), `${WARN}??? USE ${rpath} req.params is undefined`, RST); return false; } // pass if there is a file // (srinote: this param only contains the first segment, which may be a bug) - if (STAT.file) return true; // only first segment of path (bug?) + if (req.params.file) return true; // only first segment of path (bug?) // pass if there is a trailing '/' - if (STAT.graph && req.originalUrl.endsWith('/')) return true; // legit graph + if (req.params.graph && req.originalUrl.endsWith('/')) return true; // legit graph return false; } /// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -892,8 +892,8 @@ function m_ProxyRewrite(rpath, req) { instead of the full path as before, so use req.originalUrl instead /*/ - // const rewrite = rpath.replace(`/graph/${STAT.graph}`, ''); - const rewrite = fullPath.replace(`/graph/${STAT.graph}/`, '/'); + // const rewrite = rpath.replace(`/graph/${req.params.graph}`, ''); + const rewrite = fullPath.replace(`/graph/${req.params.graph}/`, '/'); return rewrite; } /// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -959,14 +959,14 @@ app.get('/graph/:file', (req, res) => { /// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - // HANDLE "/kill/:graph" -- KILL REQUEST app.get('/kill/:graph/', (req, res) => { - if (STAT === undefined) { - console.log(PRE, $T(), 'ERROR: STAT is undefined for /kill/:graph/'); + if (req.params === undefined) { + console.log(PRE, $T(), 'ERROR: req.params is undefined for /kill/:graph/'); const fullUrl = req.protocol + '://' + req.get('host') + req.originalUrl; console.log(PRE, `error url: ${fullUrl}`); console.log(PRE, `client ip: ${req.ip}`); return; } - const db = STAT ? STAT.graph : ''; + const db = req.params ? req.params.graph : ''; console.log(PRE, $T(), `GET /kill/${db} (client ${req.ip})`); res.set('Content-Type', 'text/html'); let response = `NetCreate Manager
`; @@ -997,7 +997,7 @@ app.get('/kill/:graph/', (req, res) => { /// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - /// HANDLE "/maketoken" -- GENERATE TOKENS app.get('/maketoken/:clsid/:projid/:dataset/:numgroups', (req, res) => { - const { clsid, projid, dataset, numgroups } = STAT; + const { clsid, projid, dataset, numgroups } = req.params; console.log( PRE, $T(), @@ -1114,7 +1114,7 @@ app.use( console.log("...req.path", req.path); // '/' console.log("...req.baseUrl", req.baseUrl); // '/hawaii' console.log("...req.originalUrl", req.originalUrl); // '/hawaii/' - console.log("...STAT", STAT); // '{}' + console.log("...req.params", req.params); // '{}' console.log("...req.query", req.query); // '{}' console.log("...req.route", req.route); // undefined console.log("...req.hostname", req.hostname); // 'sub.localhost' From 65ede3a52c4bcadb974f8dfb7a1ce79c2c447809 Mon Sep 17 00:00:00 2001 From: DSri Seah <11952933+dsriseah@users.noreply.github.com> Date: Sun, 25 Aug 2024 13:37:48 -0400 Subject: [PATCH 37/47] timestamps: rename start.sh to start-nc-multiplex.sh so it's clearer when using pm2 avoid absurdist commands that look like "pm2 stop start" --- start.sh => start-nc-multiplex.sh | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename start.sh => start-nc-multiplex.sh (100%) diff --git a/start.sh b/start-nc-multiplex.sh similarity index 100% rename from start.sh rename to start-nc-multiplex.sh From 95af812ab3bf8673c039fc991bfe07b1979324a1 Mon Sep 17 00:00:00 2001 From: DSri Seah <11952933+dsriseah@users.noreply.github.com> Date: Sun, 25 Aug 2024 13:45:15 -0400 Subject: [PATCH 38/47] timestamps: add pm2 instructions to the start-nc-multiplex.sh comments --- start-nc-multiplex.sh | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/start-nc-multiplex.sh b/start-nc-multiplex.sh index 0384ad2..eb04630 100755 --- a/start-nc-multiplex.sh +++ b/start-nc-multiplex.sh @@ -4,10 +4,19 @@ # the node process is restarted if it crashes, though you can # also run it directly from the command line. +# the script is often run using the pm2 process manager. +# [app] is start-nc-multiplex.sh +# pm2 list +# pm2 stop [app] # stop the process in the pm2 list +# pm2 delete [app] # to remove from pm2 list +# pm2 save # to save the current list of processes +# pm2 start [app] # to start the process + printf "starting nc-multiplex.js\n" printf ".. browse to http://host:80/manage for control\n" printf ".. output is appended to log.txt\n" printf ".. press ctrl+c to stop.\n" +printf "using pm2? commands are listed in script comments.\n" # start the node process (sri's version) node nc-multiplex >> log.txt 2>&1 \ No newline at end of file From 742d40febf22bc4a06070b980a269c8e2ad04e07 Mon Sep 17 00:00:00 2001 From: DSri Seah <11952933+dsriseah@users.noreply.github.com> Date: Sun, 25 Aug 2024 14:20:26 -0400 Subject: [PATCH 39/47] timestamps: add additional hardening for issue seen on digital ocean req.params.graph is undefined --- nc-multiplex.js | 13 ++++++++++--- start-nc-multiplex.sh | 2 +- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/nc-multiplex.js b/nc-multiplex.js index 516d25c..71b2913 100644 --- a/nc-multiplex.js +++ b/nc-multiplex.js @@ -782,13 +782,20 @@ app.get(`/graph/:graph/${NC_URL_CONFIG}`, (req, res) => { * it will spawn a new process if able to. */ async function m_RouterLogic(req) { + let port; + let path = ''; + + // sri debug detect if req.params is undefined if (req.params === undefined) { console.log(PRE, $T(), 'ERROR in m_RouterLogic: req.params is undefined'); console.log(PRE, $T(), 'req.ip:', req.ip); + } else if (req.params.graph === undefined) { + console.log(PRE, $T(), 'ERROR in m_RouterLogic: req.params.graph is undefined'); + console.log(PRE, $T(), 'req.ip:', req.ip); } - const db = req.params.graph; - let port; - let path = ''; + + // if req.params.graph is unexpectedly undefined, use an unfindable graph name + const db = req.params.graph || 'SERVER MEMORY LOAD`;
response += ` :: Used: ${sysUsedMB}MB / ${sysTotalMB}MB (${sysPercent}%)`;
response += ` :: Remaining: ${sysFreeMB}MB`;
- response += ` :: LowMem: ${OutOfMemory()}`;
+ response += ` :: Status: ${OutOfMemory()}`;
response += ``;
const psOut = m_GetInstancePIDs();
response += `LAUNCHED PROCESSES ::\n\n${psOut}`;
@@ -642,8 +642,15 @@ async function LoadProcessState(child_processes, proxy_pool) {
* This is used to prevent node from starting too many processes.
*/
function OutOfMemory() {
- let free = os.freemem() / 1024; // mb
- return free < SYSMEM_MIN;
+ const bytesToMB = 1024 * 1024;
+ let free = os.freemem() / bytesToMB; // mb
+ const warnMem = SYSMEM_MIN;
+ const critMem = SYSMEM_MIN / 4;
+ const low = free < critMem;
+ const warn = free < warnMem;
+ if (low) return `**CRITICAL** (< crit fail buffer ${critMem}MB)`;
+ if (warn) return `**WARNING** (< mem buffer ${warnMem}MB`;
+ return `OK (>${SYSMEM_MIN}MB free)`;
}
/*///////////////////////////// RUNTIME START \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\