Sharkey/packages/backend/src/logger.ts

113 lines
3.8 KiB
TypeScript
Raw Normal View History

/*
* SPDX-FileCopyrightText: syuilo and other misskey contributors
* SPDX-License-Identifier: AGPL-3.0-only
*/
import cluster from 'node:cluster';
import chalk from 'chalk';
import { default as convertColor } from 'color-convert';
2022-02-04 03:41:27 +02:00
import { format as dateFormat } from 'date-fns';
import { bindThis } from '@/decorators.js';
2022-09-17 21:27:08 +03:00
import { envOption } from './env.js';
import type { KEYWORD } from 'color-convert/conversions.js';
2022-12-10 08:45:30 +02:00
type Context = {
name: string;
color?: KEYWORD;
};
type Level = 'error' | 'success' | 'warning' | 'debug' | 'info';
// eslint-disable-next-line import/no-default-export
export default class Logger {
2022-12-10 08:45:30 +02:00
private context: Context;
private parentLogger: Logger | null = null;
private store: boolean;
2023-02-03 08:08:36 +02:00
constructor(context: string, color?: KEYWORD, store = true) {
2022-12-10 08:45:30 +02:00
this.context = {
name: context,
color: color,
};
this.store = store;
}
@bindThis
public createSubLogger(context: string, color?: KEYWORD, store = true): Logger {
2022-12-10 08:45:30 +02:00
const logger = new Logger(context, color, store);
logger.parentLogger = this;
return logger;
}
@bindThis
2022-12-10 08:45:30 +02:00
private log(level: Level, message: string, data?: Record<string, any> | null, important = false, subContexts: Context[] = [], store = true): void {
if (envOption.quiet) return;
if (!this.store) store = false;
2020-03-28 11:28:21 +02:00
if (level === 'debug') store = false;
if (this.parentLogger) {
2022-12-10 08:45:30 +02:00
this.parentLogger.log(level, message, data, important, [this.context].concat(subContexts), store);
return;
}
2022-02-04 03:41:27 +02:00
const time = dateFormat(new Date(), 'HH:mm:ss');
2023-02-09 04:46:08 +02:00
const worker = cluster.isPrimary ? '*' : cluster.worker!.id;
const l =
level === 'error' ? important ? chalk.bgRed.white('ERR ') : chalk.red('ERR ') :
level === 'warning' ? chalk.yellow('WARN') :
level === 'success' ? important ? chalk.bgGreen.white('DONE') : chalk.green('DONE') :
level === 'debug' ? chalk.gray('VERB') :
level === 'info' ? chalk.blue('INFO') :
null;
2022-12-10 08:45:30 +02:00
const contexts = [this.context].concat(subContexts).map(d => d.color ? chalk.rgb(...convertColor.keyword.rgb(d.color))(d.name) : chalk.white(d.name));
const m =
level === 'error' ? chalk.red(message) :
level === 'warning' ? chalk.yellow(message) :
level === 'success' ? chalk.green(message) :
level === 'debug' ? chalk.gray(message) :
level === 'info' ? message :
null;
2022-12-10 08:45:30 +02:00
let log = `${l} ${worker}\t[${contexts.join(' ')}]\t${m}`;
if (envOption.withLogTime) log = chalk.gray(time) + ' ' + log;
console.log(important ? chalk.bold(log) : log);
if (level === 'error' && data) console.log(data);
}
@bindThis
public error(x: string | Error, data?: Record<string, any> | null, important = false): void { // 実行を継続できない状況で使う
if (x instanceof Error) {
2022-09-17 21:27:08 +03:00
data = data ?? {};
data.e = x;
this.log('error', x.toString(), data, important);
} else if (typeof x === 'object') {
2022-09-17 21:27:08 +03:00
this.log('error', `${(x as any).message ?? (x as any).name ?? x}`, data, important);
} else {
this.log('error', `${x}`, data, important);
}
}
@bindThis
public warn(message: string, data?: Record<string, any> | null, important = false): void { // 実行を継続できるが改善すべき状況で使う
this.log('warning', message, data, important);
}
@bindThis
public succ(message: string, data?: Record<string, any> | null, important = false): void { // 何かに成功した状況で使う
this.log('success', message, data, important);
}
@bindThis
public debug(message: string, data?: Record<string, any> | null, important = false): void { // デバッグ用に使う(開発者に必要だが利用者に不要な情報)
2022-02-04 03:41:27 +02:00
if (process.env.NODE_ENV !== 'production' || envOption.verbose) {
this.log('debug', message, data, important);
}
}
@bindThis
public info(message: string, data?: Record<string, any> | null, important = false): void { // それ以外
this.log('info', message, data, important);
}
}