mirror of
https://github.com/smogon/pokemon-showdown.git
synced 2026-04-26 02:39:38 -05:00
78439b4a02
ESLint has a whole new config format, so I figure it's a good time to make the config system saner. - First, we no longer have separate eslint-no-types configs. Lint performance shouldn't be enough of a problem to justify the relevant maintenance complexity. - Second, our base config should work out-of-the-box now. `npx eslint` will work as expected, without any CLI flags. You should still use `npm run lint` which adds the `--cached` flag for performance. - Third, whatever updates I did fixed style linting, which apparently has been bugged for quite some time, considering all the obvious mixed-tabs-and-spaces issues I found in the upgrade. Also here are some changes to our style rules. In particular: - Curly brackets (for objects etc) now have spaces inside them. Sorry for the huge change. ESLint doesn't support our old style, and most projects use Prettier style, so we might as well match them in this way. See https://github.com/eslint-stylistic/eslint-stylistic/issues/415 - String + number concatenation is no longer allowed. We now consistently use template strings for this.
93 lines
2.3 KiB
TypeScript
93 lines
2.3 KiB
TypeScript
/**
|
|
* 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
|
|
*/
|
|
|
|
import * as fs from 'fs';
|
|
import * as path from 'path';
|
|
|
|
const CRASH_EMAIL_THROTTLE = 5 * 60 * 1000; // 5 minutes
|
|
|
|
const logPath = path.resolve(
|
|
// not sure why this is necessary, but in Windows testing it was
|
|
__dirname, '../', __dirname.includes(`${path.sep}dist${path.sep}`) ? '..' : '',
|
|
path.join(global.Config?.logsdir || 'logs', 'errors.txt')
|
|
);
|
|
let lastCrashLog = 0;
|
|
let transport: any;
|
|
|
|
/**
|
|
* Logs when a crash happens to console, then e-mails those who are configured
|
|
* to receive them.
|
|
*/
|
|
export function crashlogger(
|
|
error: unknown,
|
|
description: string,
|
|
data: AnyObject | null = null,
|
|
emailConfig: AnyObject | null = null,
|
|
): string | null {
|
|
const datenow = Date.now();
|
|
|
|
let stack = (typeof error === 'string' ? error : (error as Error)?.stack) || '';
|
|
if (data) {
|
|
stack += `\n\nAdditional information:\n`;
|
|
for (const k in data) {
|
|
stack += ` ${k} = ${data[k]}\n`;
|
|
}
|
|
}
|
|
|
|
console.error(`\nCRASH: ${stack}\n`);
|
|
const out = fs.createWriteStream(logPath, { flags: 'a' });
|
|
out.on('open', () => {
|
|
out.write(`\n${stack}\n`);
|
|
out.end();
|
|
}).on('error', (err: Error) => {
|
|
console.error(`\nSUBCRASH: ${err.stack}\n`);
|
|
});
|
|
|
|
const emailOpts = emailConfig || global.Config?.crashguardemail;
|
|
if (emailOpts && ((datenow - lastCrashLog) > CRASH_EMAIL_THROTTLE)) {
|
|
lastCrashLog = datenow;
|
|
|
|
if (!transport) {
|
|
try {
|
|
require.resolve('nodemailer');
|
|
} catch {
|
|
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(emailOpts.options);
|
|
} catch {
|
|
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: emailOpts.from,
|
|
to: emailOpts.to,
|
|
subject: emailOpts.subject,
|
|
text,
|
|
}, (err: Error | null) => {
|
|
if (err) console.error(`Error sending email: ${err}`);
|
|
});
|
|
}
|
|
|
|
return null;
|
|
}
|