mirror of
https://github.com/ether/etherpad-lite.git
synced 2025-04-22 08:26:16 -04:00
move server.ts
This commit is contained in:
Jannik Streek
parent
f727adacc7
commit
4cf2e61dc0
13 changed files with 36 additions and 35 deletions
|
|
@ -1,289 +0,0 @@
|
|||
#!/usr/bin/env node
|
||||
|
||||
'use strict';
|
||||
|
||||
/**
|
||||
* This module is started with src/bin/run.sh. It sets up a Express HTTP and a Socket.IO Server.
|
||||
* Static file Requests are answered directly from this module, Socket.IO messages are passed
|
||||
* to MessageHandler and minfied requests are passed to minified.
|
||||
*/
|
||||
|
||||
/*
|
||||
* 2011 Peter 'Pita' Martischka (Primary Technology Ltd)
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import {PluginType} from "./types/Plugin";
|
||||
import {ErrorCaused} from "./types/ErrorCaused";
|
||||
import {PromiseHooks} from "node:v8";
|
||||
|
||||
import log4js from 'log4js';
|
||||
|
||||
const settings = require('./utils/Settings');
|
||||
|
||||
let wtfnode: any;
|
||||
if (settings.dumpOnUncleanExit) {
|
||||
// wtfnode should be loaded after log4js.replaceConsole() so that it uses log4js for logging, and
|
||||
// it should be above everything else so that it can hook in before resources are used.
|
||||
wtfnode = require('wtfnode');
|
||||
}
|
||||
|
||||
/*
|
||||
* early check for version compatibility before calling
|
||||
* any modules that require newer versions of NodeJS
|
||||
*/
|
||||
const NodeVersion = require('./utils/NodeVersion');
|
||||
NodeVersion.enforceMinNodeVersion('12.17.0');
|
||||
NodeVersion.checkDeprecationStatus('12.17.0', '1.9.0');
|
||||
|
||||
const UpdateCheck = require('./utils/UpdateCheck');
|
||||
const db = require('./db/DB');
|
||||
const express = require('./hooks/express');
|
||||
const hooks = require('../static/js/pluginfw/hooks');
|
||||
const pluginDefs = require('../static/js/pluginfw/plugin_defs');
|
||||
const plugins = require('../static/js/pluginfw/plugins');
|
||||
const installer = require('../static/js/pluginfw/installer');
|
||||
const {Gate} = require('./utils/promises');
|
||||
const stats = require('./stats')
|
||||
|
||||
const logger = log4js.getLogger('server');
|
||||
|
||||
const State = {
|
||||
INITIAL: 1,
|
||||
STARTING: 2,
|
||||
RUNNING: 3,
|
||||
STOPPING: 4,
|
||||
STOPPED: 5,
|
||||
EXITING: 6,
|
||||
WAITING_FOR_EXIT: 7,
|
||||
STATE_TRANSITION_FAILED: 8,
|
||||
};
|
||||
|
||||
let state = State.INITIAL;
|
||||
|
||||
const removeSignalListener = (signal: NodeJS.Signals, listener: NodeJS.SignalsListener) => {
|
||||
logger.debug(`Removing ${signal} listener because it might interfere with shutdown tasks. ` +
|
||||
`Function code:\n${listener.toString()}\n` +
|
||||
`Current stack:\n${new Error()!.stack!.split('\n').slice(1).join('\n')}`);
|
||||
process.off(signal, listener);
|
||||
};
|
||||
|
||||
|
||||
let startDoneGate: { resolve: () => void; }
|
||||
exports.start = async () => {
|
||||
switch (state) {
|
||||
case State.INITIAL:
|
||||
break;
|
||||
case State.STARTING:
|
||||
await startDoneGate;
|
||||
// Retry. Don't fall through because it might have transitioned to STATE_TRANSITION_FAILED.
|
||||
return await exports.start();
|
||||
case State.RUNNING:
|
||||
return express.server;
|
||||
case State.STOPPING:
|
||||
case State.STOPPED:
|
||||
case State.EXITING:
|
||||
case State.WAITING_FOR_EXIT:
|
||||
case State.STATE_TRANSITION_FAILED:
|
||||
throw new Error('restart not supported');
|
||||
default:
|
||||
throw new Error(`unknown State: ${state.toString()}`);
|
||||
}
|
||||
logger.info('Starting Etherpad...');
|
||||
startDoneGate = new Gate();
|
||||
state = State.STARTING;
|
||||
try {
|
||||
// Check if Etherpad version is up-to-date
|
||||
UpdateCheck.check();
|
||||
|
||||
// @ts-ignore
|
||||
stats.gauge('memoryUsage', () => process.memoryUsage().rss);
|
||||
// @ts-ignore
|
||||
stats.gauge('memoryUsageHeap', () => process.memoryUsage().heapUsed);
|
||||
|
||||
process.on('uncaughtException', (err: ErrorCaused) => {
|
||||
logger.debug(`uncaught exception: ${err.stack || err}`);
|
||||
|
||||
// eslint-disable-next-line promise/no-promise-in-callback
|
||||
exports.exit(err)
|
||||
.catch((err: ErrorCaused) => {
|
||||
logger.error('Error in process exit', err);
|
||||
// eslint-disable-next-line n/no-process-exit
|
||||
process.exit(1);
|
||||
});
|
||||
});
|
||||
// As of v14, Node.js does not exit when there is an unhandled Promise rejection. Convert an
|
||||
// unhandled rejection into an uncaught exception, which does cause Node.js to exit.
|
||||
process.on('unhandledRejection', (err: ErrorCaused) => {
|
||||
logger.debug(`unhandled rejection: ${err.stack || err}`);
|
||||
throw err;
|
||||
});
|
||||
|
||||
for (const signal of ['SIGINT', 'SIGTERM'] as NodeJS.Signals[]) {
|
||||
// Forcibly remove other signal listeners to prevent them from terminating node before we are
|
||||
// done cleaning up. See https://github.com/andywer/threads.js/pull/329 for an example of a
|
||||
// problematic listener. This means that exports.exit is solely responsible for performing all
|
||||
// necessary cleanup tasks.
|
||||
for (const listener of process.listeners(signal)) {
|
||||
removeSignalListener(signal, listener);
|
||||
}
|
||||
process.on(signal, exports.exit);
|
||||
// Prevent signal listeners from being added in the future.
|
||||
process.on('newListener', (event, listener) => {
|
||||
if (event !== signal) return;
|
||||
removeSignalListener(signal, listener);
|
||||
});
|
||||
}
|
||||
|
||||
await db.init();
|
||||
await installer.checkForMigration();
|
||||
await plugins.update();
|
||||
const installedPlugins = (Object.values(pluginDefs.plugins) as PluginType[])
|
||||
.filter((plugin) => plugin.package.name !== 'ep_etherpad-lite')
|
||||
.map((plugin) => `${plugin.package.name}@${plugin.package.version}`)
|
||||
.join(', ');
|
||||
logger.info(`Installed plugins: ${installedPlugins}`);
|
||||
logger.debug(`Installed parts:\n${plugins.formatParts()}`);
|
||||
logger.debug(`Installed server-side hooks:\n${plugins.formatHooks('hooks', false)}`);
|
||||
await hooks.aCallAll('loadSettings', {settings});
|
||||
await hooks.aCallAll('createServer');
|
||||
} catch (err) {
|
||||
logger.error('Error occurred while starting Etherpad');
|
||||
state = State.STATE_TRANSITION_FAILED;
|
||||
startDoneGate.resolve();
|
||||
return await exports.exit(err);
|
||||
}
|
||||
|
||||
logger.info('Etherpad is running');
|
||||
state = State.RUNNING;
|
||||
startDoneGate.resolve();
|
||||
|
||||
// Return the HTTP server to make it easier to write tests.
|
||||
return express.server;
|
||||
};
|
||||
|
||||
const stopDoneGate = new Gate();
|
||||
exports.stop = async () => {
|
||||
switch (state) {
|
||||
case State.STARTING:
|
||||
await exports.start();
|
||||
// Don't fall through to State.RUNNING in case another caller is also waiting for startup.
|
||||
return await exports.stop();
|
||||
case State.RUNNING:
|
||||
break;
|
||||
case State.STOPPING:
|
||||
await stopDoneGate;
|
||||
// fall through
|
||||
case State.INITIAL:
|
||||
case State.STOPPED:
|
||||
case State.EXITING:
|
||||
case State.WAITING_FOR_EXIT:
|
||||
case State.STATE_TRANSITION_FAILED:
|
||||
return;
|
||||
default:
|
||||
throw new Error(`unknown State: ${state.toString()}`);
|
||||
}
|
||||
logger.info('Stopping Etherpad...');
|
||||
state = State.STOPPING;
|
||||
try {
|
||||
let timeout: NodeJS.Timeout = null as unknown as NodeJS.Timeout;
|
||||
await Promise.race([
|
||||
hooks.aCallAll('shutdown'),
|
||||
new Promise((resolve, reject) => {
|
||||
timeout = setTimeout(() => reject(new Error('Timed out waiting for shutdown tasks')), 3000);
|
||||
}),
|
||||
]);
|
||||
clearTimeout(timeout);
|
||||
} catch (err) {
|
||||
logger.error('Error occurred while stopping Etherpad');
|
||||
state = State.STATE_TRANSITION_FAILED;
|
||||
stopDoneGate.resolve();
|
||||
return await exports.exit(err);
|
||||
}
|
||||
logger.info('Etherpad stopped');
|
||||
state = State.STOPPED;
|
||||
stopDoneGate.resolve();
|
||||
};
|
||||
|
||||
let exitGate: any;
|
||||
let exitCalled = false;
|
||||
exports.exit = async (err: ErrorCaused|string|null = null) => {
|
||||
/* eslint-disable no-process-exit */
|
||||
if (err === 'SIGTERM') {
|
||||
// Termination from SIGTERM is not treated as an abnormal termination.
|
||||
logger.info('Received SIGTERM signal');
|
||||
err = null;
|
||||
} else if (typeof err == "object" && err != null) {
|
||||
logger.error(`Metrics at time of fatal error:\n${JSON.stringify(stats.toJSON(), null, 2)}`);
|
||||
logger.error(err.stack || err.toString());
|
||||
process.exitCode = 1;
|
||||
if (exitCalled) {
|
||||
logger.error('Error occurred while waiting to exit. Forcing an immediate unclean exit...');
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
if (!exitCalled) logger.info('Exiting...');
|
||||
exitCalled = true;
|
||||
switch (state) {
|
||||
case State.STARTING:
|
||||
case State.RUNNING:
|
||||
case State.STOPPING:
|
||||
await exports.stop();
|
||||
// Don't fall through to State.STOPPED in case another caller is also waiting for stop().
|
||||
// Don't pass err to exports.exit() because this err has already been processed. (If err is
|
||||
// passed again to exit() then exit() will think that a second error occurred while exiting.)
|
||||
return await exports.exit();
|
||||
case State.INITIAL:
|
||||
case State.STOPPED:
|
||||
case State.STATE_TRANSITION_FAILED:
|
||||
break;
|
||||
case State.EXITING:
|
||||
await exitGate;
|
||||
// fall through
|
||||
case State.WAITING_FOR_EXIT:
|
||||
return;
|
||||
default:
|
||||
throw new Error(`unknown State: ${state.toString()}`);
|
||||
}
|
||||
exitGate = new Gate();
|
||||
state = State.EXITING;
|
||||
exitGate.resolve();
|
||||
|
||||
// Node.js should exit on its own without further action. Add a timeout to force Node.js to exit
|
||||
// just in case something failed to get cleaned up during the shutdown hook. unref() is called
|
||||
// on the timeout so that the timeout itself does not prevent Node.js from exiting.
|
||||
setTimeout(() => {
|
||||
logger.error('Something that should have been cleaned up during the shutdown hook (such as ' +
|
||||
'a timer, worker thread, or open connection) is preventing Node.js from exiting');
|
||||
|
||||
if (settings.dumpOnUncleanExit) {
|
||||
wtfnode.dump();
|
||||
} else {
|
||||
logger.error('Enable `dumpOnUncleanExit` setting to get a dump of objects preventing a ' +
|
||||
'clean exit');
|
||||
}
|
||||
|
||||
logger.error('Forcing an unclean exit...');
|
||||
process.exit(1);
|
||||
}, 5000).unref();
|
||||
|
||||
logger.info('Waiting for Node.js to exit...');
|
||||
state = State.WAITING_FOR_EXIT;
|
||||
/* eslint-enable no-process-exit */
|
||||
};
|
||||
|
||||
if (require.main === module) exports.start();
|
||||
|
||||
// @ts-ignore
|
||||
if (typeof(PhusionPassenger) !== 'undefined') exports.start();
|
||||
Loading…
Add table
Add a link
Reference in a new issue