log.ts

/*
Copyright  2018 matrix-appservice-discord

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 { createLogger, Logger, format, transports } from "winston";
import { DiscordBridgeConfigLogging, LoggingFile} from "./config";
import { inspect } from "util";
import "winston-daily-rotate-file";

const FORMAT_FUNC = format.printf((info) => {
    return `${info.timestamp} [${info.module}] ${info.level}: ${info.message}`;
});

export class Log {
    public static get level(): string {
        return this.logger.level;
    }

    public static set level(level: string) {
        this.logger.level = level;
    }

    public static Configure(config: DiscordBridgeConfigLogging): void {
        // Merge defaults.
        Log.config = Object.assign(new DiscordBridgeConfigLogging(), config);
        Log.setupLogger();
    }

    public static ForceSilent(): void {
        new Log("Log").warn("Log set to silent");
        Log.logger.silent = true;
    }

    private static config: DiscordBridgeConfigLogging;
    private static logger: Logger;

    private static isValidLevel(level: string) {
        return ["silly", "verbose", "info", "http", "warn", "error", "silent"].includes(level);
    }

    private static setupLogger(): void {
        if (Log.logger) {
            Log.logger.close();
        }
        const tsports: transports.StreamTransportInstance[] = Log.config.files.map((file) =>
            Log.setupFileTransport(file),
        );
        if (Log.config.console && !Log.isValidLevel(Log.config.console)) {
            new Log("Log").warn("Console log level is invalid. Please pick one of the case-sensitive levels provided in the sample config.");
        }
        tsports.push(new transports.Console({
            level: Log.config.console,
        }));
        Log.logger = createLogger({
            format: format.combine(
                format.timestamp({
                    format: Log.config.lineDateFormat,
                }),
                format.colorize(),
                FORMAT_FUNC,
            ),
            transports: tsports,
        });
    }

    private static setupFileTransport(config: LoggingFile): transports.FileTransportInstance {
        config = Object.assign(new LoggingFile(), config);
        const filterOutMods = format((info, _) => {
            if (config.disabled.includes(info.module as string) ||
                config.enabled.length > 0 &&
                !config.enabled.includes(info.module as string)
            ) {
                return false;
            }
            return info;
        });

        if (config.level && !Log.isValidLevel(config.level)) {
            new Log("Log").warn(`Log level of ${config.file} is invalid. Please pick one of the case-sensitive levels provided in the sample config.`);
        }

        const opts = {
            datePattern: config.datePattern,
            filename: config.file,
            format: format.combine(
                filterOutMods(),
                FORMAT_FUNC,
            ),
            level: config.level,
            maxFiles: config.maxFiles,
            maxSize: config.maxSize,
        };

        // eslint-disable-next-line @typescript-eslint/no-explicit-any
        return new (transports as any).DailyRotateFile(opts);
    }

    constructor(private module: string) { }

    public error(...msg: unknown[]): void {
        this.log("error", msg);
    }

    public warn(...msg: unknown[]): void {
        this.log("warn", msg);
    }

    public warning(...msg: unknown[]): void {
        this.warn(...msg);
    }

    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    public info(...msg: unknown[]): void {
        this.log("info", msg);
    }

    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    public verbose(...msg: unknown[]): void {
        this.log("verbose", msg);
    }

    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    public silly(...msg: unknown[]): void {
        this.log("silly", msg);
    }

    private log(level: string, msg: unknown[]): void {
        if (!Log.logger) {
            // We've not configured the logger yet, so create a basic one.
            Log.config = new DiscordBridgeConfigLogging();
            Log.setupLogger();
        }
        const msgStr = msg.map((item) => {
            return typeof(item) === "string" ? item : inspect(item);
        }).join(" ");

        Log.logger.log(level, msgStr, {module: this.module});
    }
}