mirror of
https://github.com/smogon/pokemon-showdown.git
synced 2026-03-21 17:25:10 -05:00
b66e395bf6
Config.ofe toggles whether or not to write heapdumps if sockets workers run out of memory, since ofe is an optional dependency but is not installed by default. nodemailer is now a nonDefaultDependency, and will complain if it's not installed when Config.crashguardemail is enabled.
97 lines
2.4 KiB
JavaScript
97 lines
2.4 KiB
JavaScript
/**
|
|
* Crash logger
|
|
* Pokemon Showdown - http://pokemonshowdown.com/
|
|
*
|
|
* Logs crashes, sends an e-mail notification if you've set up
|
|
* config.js to do that.
|
|
*
|
|
* @license MIT license
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
|
|
const CRASH_EMAIL_THROTTLE = 5 * 60 * 1000; // 5 minutes
|
|
const LOCKDOWN_PERIOD = 30 * 60 * 1000; // 30 minutes
|
|
|
|
const logPath = path.resolve(__dirname, 'logs/errors.txt');
|
|
let lastCrashLog = 0;
|
|
/** @type {any} */
|
|
let transport;
|
|
|
|
/**
|
|
* Logs when a crash happens to console, then e-mails those who are configured
|
|
* to receive them.
|
|
*
|
|
* @param {Error} err
|
|
* @param {string} description
|
|
* @param {?Object} [data = null]
|
|
* @return {?string}
|
|
*/
|
|
module.exports = function crashlogger(err, description, data = null) {
|
|
const datenow = Date.now();
|
|
|
|
let stack = (err.stack || err);
|
|
if (data) {
|
|
stack += `\n\nAdditional information:\n`;
|
|
for (let k in data) {
|
|
stack += ` ${k} = ${data[k]}\n`;
|
|
}
|
|
}
|
|
|
|
console.error(`\nCRASH: ${stack}\n`);
|
|
let out = fs.createWriteStream(logPath, {'flags': 'a'});
|
|
out.on('open', () => {
|
|
out.write(`\n${stack}\n`);
|
|
out.end();
|
|
}).on('error', /** @param {Error} err */ err => {
|
|
console.error(`\nSUBCRASH: ${err.stack}\n`);
|
|
});
|
|
|
|
if (Config.crashguardemail && ((datenow - lastCrashLog) > CRASH_EMAIL_THROTTLE)) {
|
|
lastCrashLog = datenow;
|
|
|
|
if (!transport) {
|
|
try {
|
|
require.resolve('nodemailer');
|
|
} catch (e) {
|
|
throw new Error(
|
|
'nodemailer is not installed, but it is required if Config.crashguardemail is configured! ' +
|
|
'Run npm install --no-save nodemailer and restart the server.'
|
|
);
|
|
}
|
|
}
|
|
|
|
let text = `${description} crashed `;
|
|
if (transport) {
|
|
text += `again with this stack trace:\n${stack}`;
|
|
} else {
|
|
try {
|
|
transport = require('nodemailer').createTransport(Config.crashguardemail.options);
|
|
} catch (e) {
|
|
throw new Error("Failed to start nodemailer; are you sure you've configured Config.crashguardemail correctly?");
|
|
}
|
|
|
|
text += `with this stack trace:\n${stack}`;
|
|
}
|
|
|
|
transport.sendMail({
|
|
from: Config.crashguardemail.from,
|
|
to: Config.crashguardemail.to,
|
|
subject: Config.crashguardemail.subject,
|
|
text,
|
|
}, /** @param {?Error} err */ err => {
|
|
if (err) console.error(`Error sending email: ${err}`);
|
|
});
|
|
}
|
|
|
|
if (process.uptime() * 1000 < LOCKDOWN_PERIOD) {
|
|
// lock down the server
|
|
return 'lockdown';
|
|
}
|
|
|
|
return null;
|
|
};
|