@athenna/logger 3.0.9 → 3.1.1

package/src/Drivers/DiscordDriver.js

@@ -1,43 +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 { HttpClient } from '@athenna/common'
-import { Driver } from '#src/Drivers/Driver'
-
-export class DiscordDriver extends Driver {
-  /**
-   * Creates a new instance of DiscordDriver.
-   *
-   * @param {any} configs
-   * @return {DiscordDriver}
-   */
-  constructor(configs) {
-    super(configs)
-  }
-
-  /**
-   * Transport the log.
-   *
-   * @param {string} level
-   * @param {string} message
-   * @return {Promise<any>}
-   */
-  async transport(level, message) {
-    if (!this.couldBeTransported(level)) {
-      return
-    }
-
-    const formatted = this.format(level, message, true)
-
-    return HttpClient.builder(true).post(this.configs.url, {
-      username: this.configs.username,
-      content: formatted,
-    })
-  }
-}

package/src/Drivers/Driver.js

@@ -1,134 +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 { Json } from '@athenna/common'
-import { FormatterFactory } from '#src/index'
-
-export class Driver {
-  /**
-   * Holds the configuration object itself.
-   *
-   * @type {any}
-   */
-  configs = {}
-
-  /**
-   * Holds the configuration object of driver.
-   *
-   * @type {any}
-   */
-  driverConfig = {}
-
-  /**
-   * Holds the formatter string value.
-   *
-   * @type {string}
-   */
-  formatter = 'none'
-
-  /**
-   * Holds the configuration object of formatter.
-   *
-   * @type {any}
-   */
-  formatterConfig = {}
-
-  /**
-   * The max log level that this driver can transport.
-   *
-   * @return {string}
-   */
-  level = 'info'
-
-  /**
-   * The log level order to check if log could
-   * be transported or not.
-   *
-   * @type {string[]}
-   */
-  levelOrder = ['trace', 'debug', 'info', 'success', 'warn', 'error', 'fatal']
-
-  /**
-   * Creates a new instance of ConsoleDriver.
-   *
-   * @param {any} configs
-   * @return {ConsoleDriver}
-   */
-  constructor(configs = {}) {
-    this.configs = configs
-
-    const json = Json.copy(configs)
-
-    delete json.formatter
-    delete json.formatterConfig
-
-    this.driverConfig = json
-    this.level = json.level || 'info'
-    this.formatter = configs.formatter || 'none'
-    this.formatterConfig = configs.formatterConfig || {}
-  }
-
-  /**
-   * Transport the log.
-   *
-   * @param {string} level
-   * @param {string} message
-   * @return {any | Promise<any>}
-   */
-  transport(level, message) {}
-
-  /**
-   * Check if message could be transported.
-   *
-   * @param level {string}
-   * @return {boolean}
-   */
-  couldBeTransported(level) {
-    const levelIndex = this.levelOrder.indexOf(level)
-    const maxLevelIndex = this.levelOrder.indexOf(this.level)
-
-    return levelIndex >= maxLevelIndex
-  }
-
-  /**
-   * Call formatter factory to format the message.
-   *
-   * @param level {string}
-   * @param message {string}
-   * @param [clean] {boolean}
-   * @return {any}
-   */
-  format(level, message, clean = false) {
-    const formatterConfig = { level, clean, ...this.formatterConfig }
-
-    return FormatterFactory.fabricate(this.formatter)
-      .config(formatterConfig)
-      .format(message)
-  }
-
-  /**
-   * Get the stream type for level.
-   *
-   * @param level {string}
-   * @return {string}
-   */
-  getStreamTypeFor(level) {
-    if (this.driverConfig.streamType) {
-      return this.driverConfig.streamType
-    }
-
-    let streamType = 'stdout'
-
-    if (level === 'error' || level === 'fatal') {
-      streamType = 'stderr'
-    }
-
-    return streamType
-  }
-}

package/src/Drivers/FileDriver.js

@@ -1,47 +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 { File } from '@athenna/common'
-
-import { Driver } from '#src/Drivers/Driver'
-
-export class FileDriver extends Driver {
-  /**
-   * Creates a new instance of FileDriver.
-   *
-   * @param {any} configs
-   * @return {FileDriver}
-   */
-  constructor(configs) {
-    super(configs)
-  }
-
-  /**
-   * Transport the log.
-   *
-   * @param {string} level
-   * @param {string} message
-   * @return {Promise<any>}
-   */
-  async transport(level, message) {
-    if (!this.couldBeTransported(level)) {
-      return
-    }
-
-    const filePath = this.driverConfig.filePath
-    const formatted = this.format(level, message, true)
-    const buffer = Buffer.from(`${formatted}\n`, 'utf-8')
-
-    if (await File.exists(filePath)) {
-      return new File(filePath).append(buffer)
-    }
-
-    return new File(filePath, buffer).load()
-  }
-}

package/src/Drivers/NullDriver.js

@@ -1,33 +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 { Driver } from '#src/Drivers/Driver'
-
-export class NullDriver extends Driver {
-  /**
-   * Creates a new instance of NullDriver.
-   *
-   * @param {string} configs
-   * @return {NullDriver}
-   */
-  constructor(configs) {
-    super(configs)
-  }
-
-  /**
-   * Transport the log.
-   *
-   * @param {string} level
-   * @param {string} message
-   * @return {any}
-   */
-  transport(level, message) {
-    return null
-  }
-}

package/src/Drivers/SlackDriver.js

@@ -1,40 +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 { HttpClient } from '@athenna/common'
-import { Driver } from '#src/Drivers/Driver'
-
-export class SlackDriver extends Driver {
-  /**
-   * Creates a new instance of SlackDriver.
-   *
-   * @param {any} configs
-   * @return {SlackDriver}
-   */
-  constructor(configs) {
-    super(configs)
-  }
-
-  /**
-   * Transport the log.
-   *
-   * @param {string} level
-   * @param {string} message
-   * @return {Promise<any>}
-   */
-  async transport(level, message) {
-    if (!this.couldBeTransported(level)) {
-      return
-    }
-
-    const formatted = this.format(level, message, true)
-
-    return HttpClient.builder(true).post(this.configs.url, { text: formatted })
-  }
-}

package/src/Drivers/StackDriver.js

@@ -1,45 +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 { Json } from '@athenna/common'
-
-import { Driver } from '#src/Drivers/Driver'
-import { DriverFactory } from '#src/Factories/DriverFactory'
-
-export class StackDriver extends Driver {
-  /**
-   * Creates a new instance of StackDriver.
-   *
-   * @param {any} configs
-   * @return {StackDriver}
-   */
-  constructor(configs) {
-    super(configs)
-  }
-
-  /**
-   * Transport the log.
-   *
-   * @param {string} level
-   * @param {any} message
-   * @return {any}
-   */
-  transport(level, message) {
-    const configs = Json.copy(this.configs)
-
-    delete configs.driver
-    delete configs.channels
-
-    return Promise.all(
-      this.driverConfig.channels.map(c =>
-        DriverFactory.fabricate(c, configs).transport(level, message),
-      ),
-    )
-  }
-}

package/src/Drivers/TelegramDriver.js

@@ -1,46 +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 { Telegraf } from 'telegraf'
-import { Driver } from '#src/Drivers/Driver'
-
-export class TelegramDriver extends Driver {
-  /**
-   * Creates a new instance of TelegramDriver.
-   *
-   * @param {any} configs
-   * @return {TelegramDriver}
-   */
-  constructor(configs) {
-    super(configs)
-  }
-
-  /**
-   * Transport the log.
-   *
-   * @param {string} level
-   * @param {string} message
-   * @return {Promise<any>}
-   */
-  async transport(level, message) {
-    if (!this.couldBeTransported(level)) {
-      return
-    }
-
-    const formatted = this.format(level, message, true)
-
-    return new Telegraf(this.driverConfig.token).telegram.sendMessage(
-      this.driverConfig.chatId,
-      formatted,
-      {
-        parse_mode: this.driverConfig.parseMode,
-      },
-    )
-  }
-}

package/src/Exceptions/DriverExistException.js

@@ -1,31 +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 { Exception } from '@athenna/common'
-import { DriverFactory } from '#src/Factories/DriverFactory'
-
-export class DriverExistException extends Exception {
-  /**
-   * Creates a new instance of DriverExistException.
-   *
-   * @param {string} driverName
-   * @return {DriverExistException}
-   */
-  constructor(driverName) {
-    const content = `The driver ${driverName} already exists in DriverFactory.`
-    const availableDrivers = DriverFactory.availableDrivers().join(', ')
-
-    super(
-      content,
-      500,
-      'E_EXIST_DRIVER',
-      `Available drivers are: ${availableDrivers}. The name ${driverName} is already in use inside DriverFactory. Try using a different name for your driver implementation.`,
-    )
-  }
-}

package/src/Exceptions/FormatterExistException.js

@@ -1,32 +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 { Exception } from '@athenna/common'
-import { FormatterFactory } from '#src/Factories/FormatterFactory'
-
-export class FormatterExistException extends Exception {
-  /**
-   * Creates a new instance of FormatterExistException.
-   *
-   * @param {string} formatterName
-   * @return {FormatterExistException}
-   */
-  constructor(formatterName) {
-    const content = `The formatter ${formatterName} already exists in FormatterFactory.`
-    const availableFormatters =
-      FormatterFactory.availableFormatters().join(', ')
-
-    super(
-      content,
-      500,
-      'E_EXIST_FORMATTER',
-      `Available formatters are: ${availableFormatters}. The name ${formatterName} is already in use inside FormatterFactory. Try using a different name for your formatter implementation.`,
-    )
-  }
-}

package/src/Exceptions/NotFoundDriverException.js

@@ -1,31 +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 { Exception, Path } from '@athenna/common'
-import { DriverFactory } from '#src/Factories/DriverFactory'
-
-export class NotFoundDriverException extends Exception {
-  /**
-   * Creates a new instance of NotFoundDriverException.
-   *
-   * @param {string} driverName
-   * @return {NotFoundDriverException}
-   */
-  constructor(driverName) {
-    const content = `The driver ${driverName} has not been found.`
-    const availableDrivers = DriverFactory.availableDrivers().join(', ')
-
-    super(
-      content,
-      500,
-      'E_NOT_FOUND',
-      `Available drivers are: ${availableDrivers}. Look into your config/logger.${Path.ext()} file if ${driverName} driver is implemented by logger. Or create ${driverName} driver implementation using DriverFactory.createDriver("${driverName}", ...) method.`,
-    )
-  }
-}

package/src/Exceptions/NotFoundFormatterException.js

@@ -1,31 +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 { Exception } from '@athenna/common'
-import { FormatterFactory } from '#src/Factories/FormatterFactory'
-
-export class NotFoundFormatterException extends Exception {
-  /**
-   * Creates a new instance of NotFoundFormatterException.
-   *
-   * @param {string} formatterName
-   * @return {NotFoundFormatterException}
-   */
-  constructor(formatterName) {
-    const content = `The formatter ${formatterName} has not been found.`
-    const availableDrivers = FormatterFactory.availableFormatters().join(', ')
-
-    super(
-      content,
-      500,
-      'E_NOT_FOUND',
-      `Available formatters are: ${availableDrivers}. Look into your config/logger.js file if ${formatterName} formatter is implemented by logger. Or create ${formatterName} formatter implementation using FormatterFactory.createFormatter("${formatterName}", ...) method.`,
-    )
-  }
-}

package/src/Exceptions/NotImplementedConfigException.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 { Path, Exception } from '@athenna/common'
-
-export class NotImplementedConfigException extends Exception {
-  /**
-   * Creates a new instance of NotImplementedConfigException.
-   *
-   * @param {string} channelName
-   * @param {any[]} channels
-   * @return {NotImplementedConfigException}
-   */
-  constructor(channelName, channels) {
-    const content = `Channel ${channelName} is not configured inside logging.channels object from config/logging.${Path.ext()} file.`
-
-    let help = ''
-
-    if (channels && channels.length) {
-      const availableConfigs = Object.keys(channels).join(', ')
-
-      help += `Available configurations are: ${availableConfigs}.`
-    } else {
-      help += `The "Config.get('logging.channels')" is empty, maybe your configuration files are not loaded?`
-    }
-
-    help += ` Create your configuration inside channels object to use it. Or load your configuration files using "Config.safeLoad(Path.config('logging.${Path.ext()}'))`
-
-    super(content, 500, 'E_NOT_IMPLEMENTED_CONFIG_ERROR', help)
-  }
-}

package/src/Factories/DriverFactory.js

@@ -1,128 +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 { Config } from '@athenna/config'
-
-import { FactoryHelper } from '#src/index'
-import { FileDriver } from '#src/Drivers/FileDriver'
-import { NullDriver } from '#src/Drivers/NullDriver'
-import { SlackDriver } from '#src/Drivers/SlackDriver'
-import { StackDriver } from '#src/Drivers/StackDriver'
-import { ConsoleDriver } from '#src/Drivers/ConsoleDriver'
-import { DiscordDriver } from '#src/Drivers/DiscordDriver'
-import { TelegramDriver } from '#src/Drivers/TelegramDriver'
-import { DriverExistException } from '#src/Exceptions/DriverExistException'
-import { NotFoundDriverException } from '#src/Exceptions/NotFoundDriverException'
-import { NotImplementedConfigException } from '#src/Exceptions/NotImplementedConfigException'
-import { Options } from '@athenna/common'
-
-export class DriverFactory {
-  /**
-   * Drivers of DriverFactory.
-   *
-   * @type {Map<string, { Driver: any }>}
-   */
-  static #drivers = new Map()
-    .set('file', { Driver: FileDriver })
-    .set('null', { Driver: NullDriver })
-    .set('slack', { Driver: SlackDriver })
-    .set('stack', { Driver: StackDriver })
-    .set('console', { Driver: ConsoleDriver })
-    .set('discord', { Driver: DiscordDriver })
-    .set('telegram', { Driver: TelegramDriver })
-
-  /**
-   * Return an array with all available drivers.
-   *
-   * @return {any[]}
-   */
-  static availableDrivers() {
-    const availableDrivers = []
-
-    for (const key of this.#drivers.keys()) {
-      availableDrivers.push(key)
-    }
-
-    return availableDrivers
-  }
-
-  /**
-   * Fabricate a new instance of a driver based on
-   * channel configurations.
-   *
-   * @param {string} channelName
-   * @param {any} runtimeConfig
-   * @return {any}
-   */
-  static fabricate(channelName, runtimeConfig = {}) {
-    const channelConfig = this.#getChannelConfig(channelName)
-
-    const { Driver } = this.#drivers.get(channelConfig.driver)
-
-    const configs = FactoryHelper.groupConfigs(runtimeConfig, channelConfig)
-
-    return new Driver(configs)
-  }
-
-  /**
-   * Fabricate a new instance of a driver with vanilla
-   * configurations.
-   *
-   * @param {any} configs
-   * @return {any}
-   */
-  static fabricateVanilla(configs = {}) {
-    configs = Options.create(configs, {
-      driver: 'console',
-      formatter: 'none',
-    })
-
-    const { Driver } = this.#drivers.get(configs.driver)
-
-    return new Driver(configs)
-  }
-
-  /**
-   * Creates a new driver implementation.
-   *
-   * @param {string} name
-   * @param {(channel: string, configs?: any) => any} driver
-   */
-  static createDriver(name, driver) {
-    if (this.#drivers.has(name)) {
-      throw new DriverExistException(name)
-    }
-
-    this.#drivers.set(name, { Driver: driver })
-  }
-
-  /**
-   * Get all the configuration of a channel.
-   *
-   * @param {string} channelName
-   * @return {any}
-   */
-  static #getChannelConfig(channelName) {
-    if (channelName === 'default') {
-      channelName = Config.get('logging.default') || channelName
-    }
-
-    const channelConfig = Config.get(`logging.channels.${channelName}`)
-
-    if (!channelConfig) {
-      throw new NotImplementedConfigException(channelName)
-    }
-
-    if (!this.#drivers.has(channelConfig.driver)) {
-      throw new NotFoundDriverException(channelConfig.driver)
-    }
-
-    return channelConfig
-  }
-}