@athenna/logger 3.0.9 → 3.1.1

package/src/Factories/FormatterFactory.js

@@ -1,77 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { CliFormatter } from '#src/Formatters/CliFormatter'
-import { JsonFormatter } from '#src/Formatters/JsonFormatter'
-import { NoneFormatter } from '#src/Formatters/NoneFormatter'
-import { SimpleFormatter } from '#src/Formatters/SimpleFormatter'
-import { MessageFormatter } from '#src/Formatters/MessageFormatter'
-import { RequestFormatter } from '#src/Formatters/RequestFormatter'
-import { FormatterExistException } from '#src/Exceptions/FormatterExistException'
-import { NotFoundFormatterException } from '#src/Exceptions/NotFoundFormatterException'
-
-export class FormatterFactory {
-  /**
-   * Formatters of FormatterFactory.
-   *
-   * @type {Map<string, { Formatter: any }>}
-   */
-  static formatters = new Map()
-    .set('cli', { Formatter: CliFormatter })
-    .set('json', { Formatter: JsonFormatter })
-    .set('none', { Formatter: NoneFormatter })
-    .set('simple', { Formatter: SimpleFormatter })
-    .set('message', { Formatter: MessageFormatter })
-    .set('request', { Formatter: RequestFormatter })
-
-  /**
-   * Return an array with all available formatters.
-   *
-   * @return {any[]}
-   */
-  static availableFormatters() {
-    const availableFormatters = []
-
-    for (const [key] of this.formatters.entries()) {
-      availableFormatters.push(key)
-    }
-
-    return availableFormatters
-  }
-
-  /**
-   * Fabricate a new instance of a formatter.
-   *
-   * @param {string} formatterName
-   * @return {any}
-   */
-  static fabricate(formatterName) {
-    const formatterObject = this.formatters.get(formatterName)
-
-    if (!formatterObject) {
-      throw new NotFoundFormatterException(formatterName)
-    }
-
-    return new formatterObject.Formatter()
-  }
-
-  /**
-   * Creates a new formatter implementation.
-   *
-   * @param {string} name
-   * @param {() => any} formatter
-   */
-  static createFormatter(name, formatter) {
-    if (this.formatters.has(name)) {
-      throw new FormatterExistException(name)
-    }
-
-    this.formatters.set(name, { Formatter: formatter })
-  }
-}

package/src/Formatters/CliFormatter.js

@@ -1,24 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { Formatter } from '#src/Formatters/Formatter'
-
-export class CliFormatter extends Formatter {
-  /**
-   * Format the message.
-   *
-   * @param {string} message
-   * @return {string}
-   */
-  format(message) {
-    const level = this.cliLevel()
-
-    return this.clean(`${level} ${this.toString(message)}`)
-  }
-}

package/src/Formatters/Formatter.js

@@ -1,266 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import rTracer from 'cls-rtracer'
-
-import { hostname } from 'node:os'
-import { Is } from '@athenna/common'
-import { ColorHelper } from '#src/Helpers/ColorHelper'
-
-export class Formatter {
-  /**
-   * Holds the configuration object of formatter.
-   */
-  configs = {}
-
-  /**
-   * Creates a new instance of Formatter.
-   *
-   * @param {any} configs
-   * @return {Formatter}
-   */
-  config(configs) {
-    this.configs = configs
-
-    return this
-  }
-
-  /**
-   * Format the message.
-   *
-   * @param {string} message
-   * @return {string}
-   */
-  format(message) {}
-
-  /**
-   * Create the PID for formatter.
-   *
-   * @return {string}
-   */
-  pid() {
-    return process.pid.toString()
-  }
-
-  /**
-   * Create the hostname for formatter.
-   *
-   * @return {string}
-   */
-  hostname() {
-    return hostname()
-  }
-
-  /**
-   * Get the level without any color or format.
-   *
-   * @return {string}
-   */
-  level() {
-    return this.configs.level
-  }
-
-  /**
-   * Get the trace id for formatter.
-   *
-   * @return {string | null}
-   */
-  traceId() {
-    return rTracer.id() || null
-  }
-
-  /**
-   * Create the timestamp for formatter.
-   *
-   * @return {string}
-   */
-  timestamp() {
-    const localeStringOptions = {
-      year: 'numeric',
-      hour: 'numeric',
-      minute: 'numeric',
-      second: 'numeric',
-      day: '2-digit',
-      month: '2-digit',
-    }
-
-    return new Date(Date.now()).toLocaleString(undefined, localeStringOptions)
-  }
-
-  /**
-   * Transform the message to string.
-   *
-   * @param message {string}
-   * @return {string}
-   */
-  toString(message) {
-    if (Is.String(message)) {
-      return message
-    }
-
-    if (Is.Object(message)) {
-      message = JSON.stringify(message)
-    }
-
-    return `${message}`
-  }
-
-  /**
-   * Clean the message removing colors if clean
-   * option is true. If force is true, then colors
-   * will be removed even if configs clean option
-   * is false.
-   *
-   * @param message {string}
-   * @param [force] {boolean}
-   * @return {string}
-   */
-  clean(message, force = false) {
-    if (this.configs.clean || force) {
-      return ColorHelper.removeColors(message)
-    }
-
-    return message
-  }
-
-  /**
-   * Apply all colors necessary to message.
-   *
-   * @param message {string}
-   * @return {string}
-   */
-  applyColors(message) {
-    message = this.toString(message)
-
-    return this.applyColorsByChalk(this.applyColorsByLevel(message))
-  }
-
-  /**
-   * Apply colors in message.
-   *
-   * @param message {string}
-   * @return {string}
-   */
-  applyColorsByChalk(message) {
-    if (!this.configs.chalk) {
-      return message
-    }
-
-    return this.configs.chalk(message)
-  }
-
-  /**
-   * Apply colors in message by level.
-   *
-   * @param message {string}
-   * @return {string}
-   */
-  applyColorsByLevel(message) {
-    const level = this.configs.level
-
-    return this.paintMessageByLevel(level, message)
-  }
-
-  /**
-   * Create the cli level string.
-   *
-   * @return {string}
-   */
-  cliLevel() {
-    const level = this.configs.level
-
-    if (!ColorHelper[level]) {
-      return level
-    }
-
-    return ColorHelper[level].bold(`[  ${level}  ]`)
-  }
-
-  /**
-   * Create the simple level string.
-   *
-   * @return {string}
-   */
-  simpleLevel() {
-    const level = this.configs.level
-
-    if (!ColorHelper[level]) {
-      return level
-    }
-
-    return ColorHelper[level].bold(`[${level.toUpperCase()}]`)
-  }
-
-  /**
-   * Create the message level emoji string.
-   *
-   * @return {string}
-   */
-  messageLevel() {
-    const level = this.configs.level
-
-    return this.getEmojiByLevel(level, this.configs.customEmoji)
-  }
-
-  /**
-   * Get the emoji by level.
-   *
-   * @param {string} level
-   * @param {string} [customEmoji]
-   * @return {string}
-   */
-  getEmojiByLevel(level, customEmoji) {
-    if (customEmoji) {
-      return customEmoji
-    }
-
-    const levelEmojis = {
-      trace: '\u{1F43E}',
-      debug: '\u{1F50E}',
-      info: '\u{2139}',
-      success: '\u{2705}',
-      warn: '\u{26A0}',
-      error: '\u{274C}',
-      fatal: '\u{1F6D1}',
-    }
-
-    if (!levelEmojis[level.toLowerCase()]) {
-      return ''
-    }
-
-    return levelEmojis[level.toLowerCase()]
-  }
-
-  /**
-   * Paint the message by level.
-   *
-   * @param {string} level
-   * @param {string} message
-   * @return {string}
-   */
-  paintMessageByLevel(level, message) {
-    const levelLower = level.toLowerCase()
-
-    const levelColors = {
-      trace: ColorHelper.trace,
-      debug: ColorHelper.debug,
-      info: ColorHelper.info,
-      success: ColorHelper.success,
-      warn: ColorHelper.warn,
-      error: ColorHelper.error,
-      fatal: ColorHelper.fatal,
-    }
-
-    if (!levelColors[levelLower]) {
-      return message
-    }
-
-    return levelColors[levelLower](message)
-  }
-}

package/src/Formatters/JsonFormatter.js

@@ -1,37 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { Is } from '@athenna/common'
-import { Formatter } from '#src/Formatters/Formatter'
-
-export class JsonFormatter extends Formatter {
-  /**
-   * Format the message.
-   *
-   * @param {any} message
-   * @return {string}
-   */
-  format(message) {
-    const base = {
-      level: this.level(),
-      time: Date.now(),
-      pid: this.pid(),
-      hostname: this.hostname(),
-      traceId: this.traceId(),
-    }
-
-    if (Is.String(message)) {
-      base.msg = message
-
-      return JSON.stringify(base)
-    }
-
-    return JSON.stringify({ ...base, ...message })
-  }
-}

package/src/Formatters/MessageFormatter.js

@@ -1,26 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { Formatter } from '#src/Formatters/Formatter'
-
-export class MessageFormatter extends Formatter {
-  /**
-   * Format the message.
-   *
-   * @param {string} message
-   * @return {string}
-   */
-  format(message) {
-    return this.clean(
-      `${this.messageLevel()} - (${this.pid()}) - (${this.hostname()}): ${this.toString(
-        message,
-      )}`,
-    )
-  }
-}

package/src/Formatters/RequestFormatter.js

@@ -1,64 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { ColorHelper } from '#src/index'
-import { Formatter } from '#src/Formatters/Formatter'
-
-export class RequestFormatter extends Formatter {
-  /**
-   * Format the message.
-   *
-   * @param {any} ctx
-   * @return {string}
-   */
-  format(ctx) {
-    const ip = ctx.request.ip
-    const status = ctx.status
-    const responseTimeMs = `${Math.round(ctx.responseTime)}ms`
-    const methodAndStatus = ColorHelper[ctx.request.method](
-      `[${ctx.request.method}::${ctx.status}]`,
-    )
-
-    if (!this.configs.asJson) {
-      return this.clean(
-        `${methodAndStatus} - [${ip}] - ${new Date().toISOString()} - ${
-          ctx.request.baseUrl
-        } ${responseTimeMs}`,
-      )
-    }
-
-    const metadata = {
-      method: ctx.request.method,
-      duration: responseTimeMs,
-      status: status <= 399 ? 'SUCCESS' : 'ERROR',
-      statusCode: status,
-      url: ctx.request.hostUrl,
-      path: ctx.request.baseUrl,
-      createdAt: Date.now(),
-      traceId: this.traceId(),
-      data: ctx.data,
-    }
-
-    const request = {
-      url: ctx.request.hostUrl,
-      method: ctx.request.method,
-      body: ctx.request.body,
-      params: ctx.request.params,
-      queries: ctx.request.queries,
-      headers: ctx.request.headers,
-    }
-
-    const response = {
-      body: ctx.body,
-      headers: ctx.headers,
-    }
-
-    return JSON.stringify({ request, response, metadata })
-  }
-}

package/src/Formatters/SimpleFormatter.js

@@ -1,27 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { Formatter } from '#src/Formatters/Formatter'
-
-export class SimpleFormatter extends Formatter {
-  /**
-   * Format the message.
-   *
-   * @param {string} message
-   * @return {string}
-   */
-  format(message) {
-    const pid = this.pid()
-    const time = this.timestamp()
-    const level = this.simpleLevel()
-    const colorizedMsg = this.applyColors(message)
-
-    return this.clean(`${level} - ${time} - (${pid}) ${colorizedMsg}`)
-  }
-}