logger.ts

import stdout from "./stdout.ts";
import Writer from "./writer.ts";
import eol from "./eol.ts";
import Dater from "./date.ts";
import { cyan, exists, green, red, stripAnsiCode, yellow } from "./deps.ts";
import type { fileLoggerOptions, LoggerWriteOptions } from "./interface.ts";
import Types from "./types.ts";

const { inspect } = Deno;

const noop = async () => {};

export type LoggerType = "debug" | "info" | "log" | "warn" | "error";

/**
 * Logger class
 */
export default class Logger {
  private stdout = stdout;
  private encoder = new TextEncoder();
  private writer?: Writer;
  private rotate = false;
  private dir?: string;
  private filename?: string;

  #debug = this.debug;
  #info = this.info;
  #log = this.log;
  #warn = this.warn;
  #error = this.error;
  #write = this.write;

  private format(...args: unknown[]): Uint8Array {
    const msg = args.map((arg) => typeof arg === "string" ? arg : inspect(arg))
      .join(" ");
    // const msg = args.map(arg => inspect(arg, {
    //   showHidden: true,
    //   depth: 4,
    //   colors: true,
    //   indentLevel: 2
    // })).join('');

    return this.encoder.encode(stripAnsiCode(msg) + eol);
  }

  /**
   * Log message with debug level
   * @param args data to log
   */
  async debug(...args: unknown[]): Promise<void> {
    args = [this.getDebug(), ...args];
    this.stdout(...args);
    if (this.dir) {
      await this.write({
        dir: this.dir,
        type: Types.DEBUG,
        args,
      });
    }
  }
  /**
   * Log message with info level
   * @param args data to log
   */
  async info(...args: unknown[]): Promise<void> {
    args = [this.getInfo(), ...args];
    this.stdout(...args);
    if (this.dir) {
      await this.write({
        dir: this.dir,
        type: Types.INFO,
        args,
      });
    }
  }

  /**
   * Log message with info level
   * @param args data to log
   */
  async log(...args: unknown[]): Promise<void> {
    args = [this.getLog(), ...args];
    this.stdout(...args);
    if (this.dir) {
      await this.write({
        dir: this.dir,
        type: Types.LOG,
        args,
      });
    }
  }

  /**
   * Log message with warning level
   * @param args data to log
   */
  async warn(...args: unknown[]): Promise<void> {
    args = [this.getWarn(), ...args];
    this.stdout(...args);
    if (this.dir) {
      await this.write({
        dir: this.dir,
        type: Types.WARN,
        args,
      });
    }
  }

  /**
   * Log message with error level
   * @param args data to log
   */
  async error(...args: unknown[]): Promise<void> {
    args = [this.getError(), ...args];
    this.stdout(...args);
    if (this.dir) {
      await this.write({
        dir: this.dir,
        type: Types.ERROR,
        args,
      });
    }
  }

  private write({ dir, type, args }: LoggerWriteOptions): Promise<void> {
    const date = this.getDate();
    const filename = this.filename ||
      (this.rotate === true ? `${date}_${type}` : type);
    const path = `${dir}/${filename}.log`;
    const msg = this.format(...args);
    return this.writer!.write({ path, msg, type });
  }

  /**
   * init file logger
   * @param dir
   * @param options
   */
  async initFileLogger(
    dir: string,
    options: fileLoggerOptions = {},
  ): Promise<void> {
    const exist = await exists(dir, { isDirectory: true });
    if (!exist) {
      stdout(`${this.getWarn()} Log folder does not exist`);
      try {
        Deno.mkdirSync(dir, { recursive: true });
        stdout(`${this.getInfo()} Log folder create success`);
      } catch (error) {
        stdout(`${this.getError()} Log folder create failed: ` + error);
      }
    }
    const { rotate, maxBytes, maxBackupCount } = options;
    if (rotate === true) this.rotate = true;
    this.dir = dir;
    this.filename = options?.filename;
    this.writer = new Writer({
      maxBytes,
      maxBackupCount,
    });
  }

  /**
   * disable a specific type of logger
   * @param type Level of logger to disable
   */
  disable(type?: LoggerType): void {
    if (!type) {
      this.debug = noop;
      this.info = noop;
      this.log = noop;
      this.warn = noop;
      this.error = noop;
      return;
    }
    if (type === "debug") {
      this.debug = noop;
      return;
    }
    if (type === "info") {
      this.info = noop;
      return;
    }
    if (type === "log") {
      this.log = noop;
      return;
    }
    if (type === "warn") {
      this.warn = noop;
      return;
    }
    if (type === "error") {
      this.error = noop;
      return;
    }
  }

  /**
   * Enable a specific type of logger
   * @param type Level of logger to enable
   */
  enable(type?: LoggerType): void {
    if (!type) {
      this.debug = this.#debug;
      this.info = this.#info;
      this.log = this.#log;
      this.warn = this.#warn;
      this.error = this.#error;
    }
    if (type === "debug") {
      this.debug = this.#debug;
      return;
    }
    if (type === "info") {
      this.info = this.#info;
      return;
    }
    if (type === "log") {
      this.log = this.#log;
      return;
    }
    if (type === "warn") {
      this.warn = this.#warn;
      return;
    }
    if (type === "error") {
      this.error = this.#error;
      return;
    }
  }

  /**
   * Disable console logger
   */
  disableConsole(): void {
    this.stdout = noop;
  }

  /**
   * Enable console logger
   */
  enableConsole(): void {
    this.stdout = stdout;
  }

  /**
   * Disable file logger
   */
  disableFile(): void {
    this.write = noop;
  }

  /**
   * Enable file logger
   */
  enableFile(): void {
    this.write = this.#write;
  }

  private getDebug(): string {
    return green(this.getNow() + cyan(` Debug:`));
  }

  private getInfo(): string {
    return green(this.getNow() + green(` Info:`));
  }

  private getLog(): string {
    return green(`${this.getNow()} Log:`);
  }

  private getWarn(): string {
    return green(this.getNow()) + yellow(` Warn:`);
  }

  private getError(): string {
    return green(this.getNow()) + red(` Error:`);
  }

  private getNow(): string {
    return new Dater().toLocaleString();
  }

  private getDate(): string {
    return new Dater().toLocaleDateString();
  }
}