@athenna/logger 1.2.8 → 1.2.9

package/README.md

@@ -31,4 +31,12 @@
 
 ---
 
-Made with 🖤 by [Athenna Team](https://github.com/AthennaIO) :wave:
+<p align='center'>
+  With 💜 by <a href='https://github.com/AthennaIO'>Athenna community</a>
+</p>
+
+<p align='center'>
+  <a href='https://github.com/AthennaIO/Logger/graphs/contributors'>
+    <img src='https://contrib.rocks/image?repo=AthennaIO/Logger'/>
+  </a>
+</p>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/logger",
-  "version": "1.2.8",
+  "version": "1.2.9",
   "description": "The Athenna logging solution. Log in stdout, files and buckets.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -47,13 +47,10 @@
     "./providers/LoggerProvider": "./src/Providers/LoggerProvider.js"
   },
   "dependencies": {
-    "@athenna/ioc": "1.2.3",
-    "@secjs/utils": "1.9.7",
+    "@athenna/ioc": "1.2.4",
+    "@secjs/utils": "1.9.9",
     "axios": "0.26.1",
     "chalk": "5.0.1",
-    "debug": "4.3.4",
-    "pino": "7.10.0",
-    "pino-pretty": "7.6.1",
     "telegraf": "4.7.0"
   },
   "devDependencies": {
@@ -62,9 +59,10 @@
     "@japa/runner": "2.0.7",
     "@japa/spec-reporter": "1.1.12",
     "c8": "7.11.2",
-    "commitizen": "4.2.4",
+    "commitizen": "4.2.5",
     "cross-env": "7.0.3",
     "cz-conventional-changelog": "3.3.0",
+    "dotenv": "^16.0.2",
     "eslint": "8.14.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-config-standard": "17.0.0",
@@ -84,16 +82,15 @@
     "include": [
       "src/**/*.js"
     ],
+    "exclude": [
+      "src/Helpers/ColorHelper.js"
+    ],
     "reporter": [
       "text-summary",
       "html"
     ],
     "report-dir": "./tests/Coverage",
-    "check-coverage": true,
-    "statements": "80",
-    "branches": "80",
-    "functions": "50",
-    "lines": "80"
+    "check-coverage": true
   },
   "husky": {
     "hooks": {

package/src/Drivers/ConsoleDriver.js

@@ -7,46 +7,34 @@
  * file that was distributed with this source code.
  */
 
-import { Config } from '@secjs/utils'
-
-import { FactoryHelper, FormatterFactory } from '#src/index'
-
-export class ConsoleDriver {
-  /**
-   * Holds the configuration set of ConsoleDriver.
-   *
-   * @type {{ streamType?: 'stdout' | 'stderr', formatter?: any, formatterConfig?: any }}
-   */
-  configs
+import { Driver } from '#src/Drivers/Driver'
 
+export class ConsoleDriver extends Driver {
   /**
    * Creates a new instance of ConsoleDriver.
    *
-   * @param {string} channel
-   * @param {any} [configs]
+   * @param {any} configs
    * @return {ConsoleDriver}
    */
-  constructor(channel, configs) {
-    const channelConfig = Config.get(`logging.channels.${channel}`)
-
-    this.configs = FactoryHelper.groupConfigs(configs, channelConfig)
+  constructor(configs) {
+    super(configs)
   }
 
   /**
    * Transport the log.
    *
-   * @param {string} message
-   * @param {{ streamType?: 'stdout' | 'stderr', formatter?: any, formatterConfig?: any }} [options]
-   * @return {void}
+   * @param {string} level
+   * @param {any} message
+   * @return {any}
    */
-  transport(message, options = {}) {
-    const configs = FactoryHelper.groupConfigs(options, this.configs)
+  transport(level, message) {
+    if (!this.couldBeTransported(level)) {
+      return
+    }
 
-    message = FormatterFactory.fabricate(configs.formatter).format(
-      message,
-      configs.formatterConfig,
-    )
+    const formatted = this.format(level, message)
+    const streamType = this.getStreamTypeFor(level)
 
-    process[configs.streamType].write(`${message}\n`)
+    return process[streamType].write(`${formatted}\n`)
   }
 }

package/src/Drivers/DiscordDriver.js

@@ -9,49 +9,36 @@
 
 import axios from 'axios'
 
-import { Config } from '@secjs/utils'
-
-import { ColorHelper, FactoryHelper, FormatterFactory } from '#src/index'
-
-export class DiscordDriver {
-  /**
-   * Holds the configuration set of DiscordDriver.
-   *
-   * @type {{ url?: string, username?: string, formatter?: any, formatterConfig?: any }}
-   */
-  configs
+import { Driver } from '#src/Drivers/Driver'
 
+export class DiscordDriver extends Driver {
   /**
    * Creates a new instance of DiscordDriver.
    *
-   * @param {string} channel
-   * @param {any} [configs]
+   * @param {any} configs
    * @return {DiscordDriver}
    */
-  constructor(channel, configs = {}) {
-    const channelConfig = Config.get(`logging.channels.${channel}`)
-
-    this.configs = FactoryHelper.groupConfigs(configs, channelConfig)
+  constructor(configs) {
+    super(configs)
   }
 
   /**
    * Transport the log.
    *
+   * @param {string} level
    * @param {string} message
-   * @param {{ url?: string, username?: string, formatter?: any, formatterConfig?: any }} [options]
-   * @return {Promise<void>}
+   * @return {Promise<any>}
    */
-  async transport(message, options = {}) {
-    const configs = FactoryHelper.groupConfigs(options, this.configs)
+  async transport(level, message) {
+    if (!this.couldBeTransported(level)) {
+      return
+    }
 
-    message = FormatterFactory.fabricate(configs.formatter).format(
-      message,
-      configs.formatterConfig,
-    )
+    const formatted = this.format(level, message, true)
 
-    await axios.post(configs.url, {
-      username: configs.username,
-      content: ColorHelper.removeColors(message),
+    return axios.post(this.configs.url, {
+      username: this.configs.username,
+      content: formatted,
     })
   }
 }

package/src/Drivers/Driver.js

@@ -0,0 +1,134 @@
+/**
+ * @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 '@secjs/utils'
+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
+    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

@@ -7,55 +7,41 @@
  * file that was distributed with this source code.
  */
 
-import { Config, File } from '@secjs/utils'
+import { File } from '@secjs/utils'
 
-import { ColorHelper, FactoryHelper, FormatterFactory } from '#src/index'
-
-export class FileDriver {
-  /**
-   * Holds the configuration set of FileDriver.
-   *
-   * @type {{ filePath?: string, formatter?: any, formatterConfig?: any }}
-   */
-  configs
+import { Driver } from '#src/Drivers/Driver'
 
+export class FileDriver extends Driver {
   /**
    * Creates a new instance of FileDriver.
    *
-   * @param {string} channel
-   * @param {any} [configs]
+   * @param {any} configs
    * @return {FileDriver}
    */
-  constructor(channel, configs = {}) {
-    const channelConfig = Config.get(`logging.channels.${channel}`)
-
-    this.configs = FactoryHelper.groupConfigs(configs, channelConfig)
+  constructor(configs) {
+    super(configs)
   }
 
   /**
    * Transport the log.
    *
+   * @param {string} level
    * @param {string} message
-   * @param {{ filePath?: string, formatter?: any, formatterConfig?: any }} [options]
-   * @return {Promise<void>}
+   * @return {Promise<any>}
    */
-  async transport(message, options = {}) {
-    const configs = FactoryHelper.groupConfigs(options, this.configs)
-
-    message = FormatterFactory.fabricate(configs.formatter).format(
-      message,
-      configs.formatterConfig,
-    )
-
-    const messageBuffer = Buffer.from(`${ColorHelper.removeColors(message)}\n`)
+  async transport(level, message) {
+    if (!this.couldBeTransported(level)) {
+      return
+    }
 
-    const file = new File(configs.filePath, messageBuffer)
-    const fileExists = await File.exists(configs.filePath)
+    const filePath = this.driverConfig.filePath
+    const formatted = this.format(level, message, true)
+    const buffer = Buffer.from(`${formatted}\n`, 'utf-8')
 
-    if (!fileExists) {
-      return file.load()
+    if (await File.exists(filePath)) {
+      return new File(filePath).append(buffer)
     }
 
-    return file.append(messageBuffer)
+    return new File(filePath, buffer).load()
   }
 }

package/src/Drivers/NullDriver.js

@@ -7,22 +7,27 @@
  * file that was distributed with this source code.
  */
 
-export class NullDriver {
+import { Driver } from '#src/Drivers/Driver'
+
+export class NullDriver extends Driver {
   /**
    * Creates a new instance of NullDriver.
    *
-   * @param {string} _channel
-   * @param {any} [_configs]
+   * @param {string} configs
    * @return {NullDriver}
    */
-  constructor(_channel, _configs = {}) {}
+  constructor(configs) {
+    super(configs)
+  }
 
   /**
    * Transport the log.
    *
-   * @param {string} _message
-   * @param {any} [_options]
-   * @return {void}
+   * @param {string} level
+   * @param {string} message
+   * @return {any}
    */
-  transport(_message, _options) {}
+  transport(level, message) {
+    return null
+  }
 }

package/src/Drivers/SlackDriver.js

@@ -9,46 +9,33 @@
 
 import axios from 'axios'
 
-import { Config } from '@secjs/utils'
-
-import { ColorHelper, FactoryHelper, FormatterFactory } from '#src/index'
-
-export class SlackDriver {
-  /**
-   * Holds the configuration set of SlackDriver.
-   *
-   * @type {{ url?: string, formatter?: 'pino-pretty', formatterConfig?: import('pino-pretty').PrettyOptions }}
-   */
-  configs
+import { Driver } from '#src/Drivers/Driver'
 
+export class SlackDriver extends Driver {
   /**
    * Creates a new instance of SlackDriver.
    *
-   * @param {string} channel
-   * @param {any} [configs]
+   * @param {any} configs
    * @return {SlackDriver}
    */
-  constructor(channel, configs = {}) {
-    const channelConfig = Config.get(`logging.channels.${channel}`)
-
-    this.configs = FactoryHelper.groupConfigs(configs, channelConfig)
+  constructor(configs) {
+    super(configs)
   }
 
   /**
    * Transport the log.
    *
+   * @param {string} level
    * @param {string} message
-   * @param {{ url?: string, formatter?: 'pino-pretty', formatterConfig?: import('pino-pretty').PrettyOptions }} [options]
-   * @return {Promise<void>}
+   * @return {Promise<any>}
    */
-  async transport(message, options = {}) {
-    const configs = FactoryHelper.groupConfigs(options, this.configs)
+  async transport(level, message) {
+    if (!this.couldBeTransported(level)) {
+      return
+    }
 
-    message = FormatterFactory.fabricate(configs.formatter).format(
-      message,
-      configs.formatterConfig,
-    )
+    const formatted = this.format(level, message, true)
 
-    await axios.post(configs.url, { text: ColorHelper.removeColors(message) })
+    return axios.post(this.configs.url, { text: formatted })
   }
 }

package/src/Drivers/TelegramDriver.js

@@ -8,45 +8,38 @@
  */
 
 import { Telegraf } from 'telegraf'
+import { Driver } from '#src/Drivers/Driver'
 
-import { Config } from '@secjs/utils'
-
-import { ColorHelper, FactoryHelper, FormatterFactory } from '#src/index'
-
-export class TelegramDriver {
+export class TelegramDriver extends Driver {
   /**
-   * Holds the configuration set of SlackDriver.
+   * Creates a new instance of TelegramDriver.
    *
-   * @type {{ token?: string, chatId?: string|number, parseMode?: 'HTML'|'Markdown'|'MarkdownV2', formatter?: 'pino-pretty', formatterConfig?: import('pino-pretty').PrettyOptions }}
+   * @param {any} configs
+   * @return {TelegramDriver}
    */
-  configs
-
-  constructor(channel, configs = {}) {
-    const channelConfig = Config.get(`logging.channels.${channel}`)
-
-    this.configs = FactoryHelper.groupConfigs(configs, channelConfig)
+  constructor(configs) {
+    super(configs)
   }
 
   /**
    * Transport the log.
    *
+   * @param {string} level
    * @param {string} message
-   * @param {{ token?: string, chatId?: string|number, parseMode?: 'HTML'|'Markdown'|'MarkdownV2', formatter?: 'pino-pretty', formatterConfig?: import('pino-pretty').PrettyOptions }} [options]
-   * @return {Promise<void>}
+   * @return {Promise<any>}
    */
-  async transport(message, options = {}) {
-    const configs = FactoryHelper.groupConfigs(options, this.configs)
+  async transport(level, message) {
+    if (!this.couldBeTransported(level)) {
+      return
+    }
 
-    message = FormatterFactory.fabricate(configs.formatter).format(
-      message,
-      configs.formatterConfig,
-    )
+    const formatted = this.format(level, message, true)
 
-    await new Telegraf(configs.token).telegram.sendMessage(
-      configs.chatId,
-      ColorHelper.removeColors(message),
+    return new Telegraf(this.driverConfig.token).telegram.sendMessage(
+      this.driverConfig.chatId,
+      formatted,
       {
-        parse_mode: configs.parseMode,
+        parse_mode: this.driverConfig.parseMode,
       },
     )
   }

package/src/Exceptions/NotFoundDriverException.js

@@ -25,7 +25,7 @@ export class NotFoundDriverException extends Exception {
       content,
       500,
       'E_NOT_FOUND',
-      `Available drivers are: ${availableDrivers}. Look into your config/logger file if ${driverName} driver is implemented by logger. Or create ${driverName} driver implementation using DriverFactory.createDriver("${driverName}", ...) method.`,
+      `Available drivers are: ${availableDrivers}. Look into your config/logger.js file if ${driverName} driver is implemented by logger. Or create ${driverName} driver implementation using DriverFactory.createDriver("${driverName}", ...) method.`,
     )
   }
 }

package/src/Exceptions/NotFoundFormatterException.js

@@ -25,7 +25,7 @@ export class NotFoundFormatterException extends Exception {
       content,
       500,
       'E_NOT_FOUND',
-      `Available formatters are: ${availableDrivers}. Look into your config/logger file if ${formatterName} formatter is implemented by logger. Or create ${formatterName} formatter implementation using FormatterFactory.createFormatter("${formatterName}", ...) method.`,
+      `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

@@ -0,0 +1,38 @@
+/**
+ * @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, Exception } from '@secjs/utils'
+
+export class NotImplementedConfigException extends Exception {
+  /**
+   * Creates a new instance of NotImplementedConfigException.
+   *
+   * @param {string} channelName
+   * @return {NotImplementedConfigException}
+   */
+  constructor(channelName) {
+    const content = `Channel ${channelName} is not configured inside logging.channels object from config/logging file.`
+
+    let help = ''
+
+    if (Config.get('logging.channels')) {
+      const availableConfigs = Object.keys(Config.get('logging.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 "new Config().safeLoad(Path.config('logging.js'))`
+
+    super(content, 500, 'E_NOT_IMPLEMENTED_CONFIG_ERROR', help)
+  }
+}

package/src/Facades/Log.js

@@ -12,6 +12,6 @@ import { Facade } from '@athenna/ioc'
 /**
  * Log facade.
  *
- * @type {Facade & import('../index').Logger}
+ * @type {Facade & import('#src/index').Logger}
  */
 export const Log = Facade.createFor('Athenna/Core/Logger')