-
Notifications
You must be signed in to change notification settings - Fork 5
/
index.js
277 lines (221 loc) · 8.84 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
/*
Async Node.js webserver w/ restify and node-mysql for RocketMap.
Supports gzip compression, load limiting w/ toobusy-js and multiprocessing
with cluster.
Developed by Sébastien Vercammen, for devkat.
It's all thanks to our Patrons: https://www.patreon.com/devkat
Thank you for supporting us to do what we do best.
*/
// Parse config.
require('dotenv').config();
const fs = require('fs');
const debug = require('debug')('devkat:master');
const cluster = require('cluster');
const utils = require('./inc/utils.js');
const db = require('./inc/db.js');
var shuttingDown = false; // Are we shutting down?
var online_workers = {}; // Status per worker PID.
/* Readability references. */
const fixWinSIGINT = utils.fixWinSIGINT;
/* Settings. */
const SERVER_NAME = 'devkat RM Webserver';
const SERVER_VERSION = '2.2.1';
const HTTPS = process.env.ENABLE_HTTPS === 'true' || false;
const HTTPS_KEY_PATH = process.env.HTTPS_KEY_PATH || 'privkey.pem';
const HTTPS_CERT_PATH = process.env.HTTPS_CERT_PATH || 'cert.pem';
const GZIP = process.env.ENABLE_GZIP === 'true' || false;
const WEB_HOST = process.env.WEB_HOST || '0.0.0.0';
const WEB_PORT = parseInt(process.env.WEB_PORT) || 3000;
const WEB_WORKERS = parseInt(process.env.WEB_WORKERS) || require('os').cpus().length;
const ENABLE_LOAD_LIMITER = process.env.ENABLE_LOAD_LIMITER !== 'false' || false;
const ENABLE_LOAD_LIMITER_LOGGING = process.env.ENABLE_LOAD_LIMITER_LOGGING !== 'false' || false;
const MAX_LAG_MS = parseInt(process.env.MAX_LAG_MS) || 75;
const LAG_INTERVAL_MS = parseInt(process.env.LAG_INTERVAL_MS) || 500;
const ENABLE_CLUSTER = process.env.ENABLE_CLUSTER !== 'false' || false;
const AUTORESTART_WORKERS = process.env.AUTORESTART_WORKERS !== 'false' || false;
const ENABLE_THROTTLE = process.env.ENABLE_THROTTLE !== 'false' || false;
const THROTTLE_RATE = parseInt(process.env.THROTTLE_RATE) || 5;
const THROTTLE_BURST = parseInt(process.env.THROTTLE_BURST) || 10;
// If we're on Windows, fix the SIGINT event.
//fixWinSIGINT();
// If we're the cluster master, manage our processes.
if (ENABLE_CLUSTER && cluster.isMaster) {
debug('Master cluster setting up %s workers...', WEB_WORKERS);
for (let i = 0; i < WEB_WORKERS; i++) {
cluster.fork();
}
// Worker is online, but not yet ready to handle requests.
cluster.on('online', function (worker) {
debug('Worker %s (PID %s) is starting...', worker.id, worker.process.pid);
});
// Worker is ded :(
cluster.on('exit', function (worker, code, signal) {
let id = worker.id;
let pid = worker.process.pid;
// Don't continue if we're shutting down.
if (shuttingDown) {
debug('Worker %s (PID %s) has exited.', worker.id, worker.process.pid);
return;
}
// If the worker wasn't online yet, something happened during startup.
if (!online_workers.hasOwnProperty(worker.process.pid)) {
debug('Worker %s (PID %s) encountered an error on startup. Exiting.', id, pid);
shuttingDown = true;
// Graceful shutdown instead of process.exit().
process.emit('SIGINT');
return;
}
debug('Worker %s died with code %s, and signal %s.', pid, code, signal);
if (AUTORESTART_WORKERS) debug('Starting a new worker.');
// Start new worker if autorestart is enabled.
if (AUTORESTART_WORKERS)
cluster.fork();
});
// Worker disconnected, either on graceful shutdown or kill.
cluster.on('disconnect', (worker) => {
debug('Worker %s (PID %s) has disconnected.', worker.id, worker.process.pid);
});
// Receive messages from workers.
cluster.on('message', (worker, msg, handle) => {
var status = msg.status;
var id = msg.id;
var pid = msg.pid;
// Worker had a successful startup.
if (status === 'ONLINE') {
online_workers[pid] = status;
}
});
/* Graceful shutdown. */
process.on('SIGINT', function graceful() {
shuttingDown = true;
debug('Gracefully closing server...');
// Kill all workers, but let them kill themselves because otherwise they
// might not be ready listening, and you end up with EPIPE errors.
for (var id in cluster.workers) {
let worker = cluster.workers[id];
// Disconnected workers will exit themselves.
if (worker.isConnected()) {
worker.send('shutdown');
worker.disconnect();
}
}
// Make sure all workers have exited.
function allWorkersDied(workers) {
for (var id in workers) {
let worker = workers[id];
if (!worker.isDead()) return false;
}
return true;
}
// Run code when all workers are dead w/o starving CPU.
function waitUntilAllWorkersDied(workers, interval_ms, callback) {
if (!allWorkersDied(workers)) {
setTimeout(() => {
waitUntilAllWorkersDied(workers, interval_ms, callback);
}, interval_ms);
} else {
// All dead! Yay!
callback();
}
}
waitUntilAllWorkersDied(cluster.workers, 500, () => {
process.exit(0);
});
});
} else {
// We're a worker, prepare to handle requests.
const toobusy = require('toobusy-js');
const restify = require('restify');
const errors = require('restify-errors');
const restifyPlugins = restify.plugins;
// Webserver settings & optional HTTPS.
const HTTP_OPTIONS = {
name: SERVER_NAME,
version: SERVER_VERSION
};
if (HTTPS) {
HTTP_OPTIONS.key = fs.readFileSync(HTTPS_KEY_PATH);
HTTP_OPTIONS.certificate = fs.readFileSync(HTTPS_CERT_PATH);
}
// Create our server.
const server = restify.createServer(HTTP_OPTIONS);
// Middleware.
server.use(restifyPlugins.jsonBodyParser({ mapParams: true }));
server.use(restifyPlugins.acceptParser(server.acceptable));
server.use(restifyPlugins.queryParser({ mapParams: true }));
server.use(restifyPlugins.fullResponse());
if (GZIP) {
server.use(restifyPlugins.gzipResponse());
}
if (ENABLE_THROTTLE) {
debug('Throttle enabled: %d requests per second, %d burst.', THROTTLE_RATE, THROTTLE_BURST);
server.use(restifyPlugins.throttle({
rate: THROTTLE_RATE,
burst: THROTTLE_BURST,
ip: true
}));
}
// Middleware which blocks requests when we're too busy.
if (ENABLE_LOAD_LIMITER) {
toobusy.maxLag(MAX_LAG_MS);
toobusy.interval(LAG_INTERVAL_MS);
debug('Enabled load limiter: ' + MAX_LAG_MS + 'ms limit, ' + LAG_INTERVAL_MS + ' ms check.');
server.use(function (req, res, next) {
if (toobusy()) {
return next(new errors.ServiceUnavailableError());
} else {
return next();
}
});
toobusy.onLag((currentLag) => {
currentLag = Math.round(currentLag);
if (ENABLE_LOAD_LIMITER_LOGGING) {
debug('[%s] Event loop lag detected! Latency: %sms.', process.pid, currentLag);
}
});
}
/* App. */
// Workers can share any TCP connection.
server.listen(WEB_PORT, WEB_HOST, () => {
// Connect to DB.
db.connect(() => {
// Attach routes.
require('./routes')(server);
// BEEP BOOP, R O B O T I S S E N T I E N T.
if (ENABLE_CLUSTER) {
debug('Worker %s (PID %s) is listening on %s.', cluster.worker.id, process.pid, server.url);
// We're online. Let's tell our sensei (it's a "master" joke 👀).
process.send({
'status': 'ONLINE',
'id': cluster.worker.id,
'pid': process.pid
});
} else {
debug('Server (PID %s) is listening on %s.', process.pid, server.url);
}
});
});
/* Graceful worker shutdown. */
function shutdownWorker() {
if (ENABLE_LOAD_LIMITER) {
// Calling .shutdown allows your process to exit normally.
toobusy.shutdown();
}
server.close();
if (ENABLE_CLUSTER) {
debug('Gracefully closed worker %s (PID %s).', cluster.worker.id, process.pid);
} else {
debug('Gracefully closed server (PID %s).', process.pid);
}
process.exit(0);
}
process.on('message', function workerMsg(msg) {
if (msg === 'shutdown') {
shutdownWorker();
}
});
// Handle graceful shutdown if we're not using cluster/process management.
process.on('SIGINT', function gracefulWorker() {
shutdownWorker();
});
}