bajo 2.0.2 → 2.2.0

package/.mocharc.json

@@ -0,0 +1,4 @@
+{
+  "spec": "test/**/*.test.js",
+  "timeout": 5000
+}

package/class/{misc → app}/log.js

@@ -1,11 +1,7 @@
 import os from 'os'
-import lodash from 'lodash'
-import dayjs from 'dayjs'
-import fs from 'fs-extra'
 import logLevels from '../../lib/log-levels.js'
 import chalk from 'chalk'
-
-const { isEmpty, without, merge, get } = lodash
+import { stripVTControlCharacters } from 'node:util'
 
 /**
  * Log output in stringified JSON format. Returned when app run in ```prod``` environment
@@ -53,12 +49,9 @@ class Log {
      */
     this.app = app
 
-    /**
-     * Date format to use in {@link https://day.js.org/docs/en/parse/string-format|dayjs} format. See {@tutorial config} for more info.
-     * @type {string}
-     */
-    const { dateFormat } = this.app.bajo.config.log ?? {}
-    this.dateFormat = dateFormat ?? 'YYYY-MM-DDTHH:mm:ss.SSS'
+    const { fs } = this.app.lib
+    this.logDir = `${this.app.bajo.dir.data}/log`
+    if (this.app.bajo.config.log.save) fs.ensureDirSync(this.logDir)
   }
 
   /**
@@ -77,9 +70,12 @@ class Log {
    * @see TLogJson
    */
   formatMsg = (level, prefix, ...params) => {
+    const { dayjs } = this.app.lib
+    const { isEmpty, merge, without } = this.app.lib._
+
     if (this.app.bajo.config.log.level === 'silent') return
     if (!this.app.bajo.isLogInRange(level)) return
-    const pretty = this.app.bajo.config.log.pretty
+    const { useUtc, timeTaken, dateFormat, pretty } = this.app.bajo.config.log
     let [data, msg, ...args] = params
     if (typeof data === 'string') {
       args.unshift(msg)
@@ -93,11 +89,10 @@ class Log {
     }
     msg = this.app.t(prefix, msg, ...args)
     let text
-    const dt = new Date()
+    const dt = dayjs()
     let diff = null
-    const timeTaken = !!get(this, 'app.bajo.config.log.timeTaken')
     if (timeTaken) {
-      const delta = dayjs(dt).diff(this.app.runAt, 'ms')
+      const delta = dt.diff(this.app.runAt, 'ms')
       diff = delta - this.lastDelta
       this.lastDelta = delta
     }
@@ -107,11 +102,8 @@ class Log {
       if (timeTaken) merge(json, { timeTaken: diff })
       text = JSON.stringify(json)
     } else {
-      let dateFormat = get(this, 'app.bajo.config.log.dateFormat', this.dateFormat).replaceAll('[Z]', '')
-      const localDate = get(this, 'app.bajo.config.log.localDate', false)
-      let date = dayjs(dt)
-      if (!localDate) date = date.utc()
-      if (!(dateFormat.includes('L') || dateFormat.includes('l'))) dateFormat += '[Z]'
+      let date = dt.clone()
+      if (useUtc) date = dayjs.utc(dt)
       date = date.format(dateFormat)
       let tdate = pretty ? chalk.cyan(date) : `[${date}]`
       if (timeTaken) {
@@ -124,11 +116,61 @@ class Log {
       if (!isEmpty(data)) text += '\n' + JSON.stringify(data)
     }
     console.log(text)
-    if (this.app.bajo.config.log.save) {
-      fs.ensureDirSync(`${this.app.bajo.dir.data}/log`)
-      // TODO: log write, rotation, etc
-    }
     if (data instanceof Error && level === 'trace') console.error(data)
+    if (this.app.bajo.config.log.save) this.save(text, prefix)
+  }
+
+  /**
+   * Calculate pattern used for log rotation
+   *
+   * @method
+   * @param {boolean} isPrev - If true, calculate previous rotation pattern
+   * @returns {string} Calculated pattern
+   */
+  getRotationPattern = (isPrev) => {
+    const { dayjs } = this.app.lib
+    const { cycle } = this.app.bajo.config.log.rotation
+    if (cycle === 'none') return
+    let pattern
+    const now = dayjs()
+    switch (cycle) {
+      case 'monthly': {
+        const dt = isPrev ? now.subtract(1, 'month') : now
+        pattern = dt.format('YYYY-MM')
+        break
+      }
+      case 'weekly': {
+        const dt = isPrev ? now.subtract(1, 'week') : now
+        pattern = dt.format(`YYYY-W${dt.week()}`)
+        break
+      }
+      case 'daily': {
+        const dt = isPrev ? now.subtract(1, 'day') : now
+        pattern = dt.format('YYYY-MM-DD')
+        break
+      }
+    }
+    return pattern
+  }
+
+  /**
+   * Save log to file in {dataDir}/log
+   *
+   * @method
+   * @param {string} text - Log message to save
+   * @param {string} prefix - Use prefix as basename. Defaults to 'bajo'
+   */
+  save = (text, prefix = 'bajo') => {
+    const { fs } = this.app.lib
+    const fname = this.app.bajo.config.log.rotation.byPlugin ? prefix : 'bajo'
+    let file = `${this.logDir}/${fname}.log`
+    const content = stripVTControlCharacters(text)
+    const pattern = this.getRotationPattern()
+    if (pattern) {
+      file = `${this.logDir}/${fname}.${pattern}.log`
+    }
+    fs.appendFileSync(file, `${content}\n`, 'utf8')
+    // TODO: symlink bajo.log to target
   }
 
   /**
@@ -207,6 +249,13 @@ class Log {
   silent = (prefix, ...params) => {
     this.formatMsg('silent', prefix, ...params)
   }
+
+  /**
+   * Dispose internal references
+   */
+  dispose = () => {
+    this.app = null
+  }
 }
 
 export default Log

package/class/app.js

@@ -7,20 +7,23 @@ import outmatch from 'outmatch'
 import fs from 'fs-extra'
 import aneka from 'aneka/index.js'
 import Base from './base.js'
-import resolvePath from '../lib/resolve-path.js'
-import parseArgsArgv from '../lib/parse-args-argv.js'
-import parseEnv from '../lib/parse-env.js'
+import freeze from '../lib/freeze.js'
 import { runAsApplet } from './helper/bajo.js'
+import Tools from './plugin/tools.js'
 import dayjs from 'dayjs'
 import utc from 'dayjs/plugin/utc.js'
 import customParseFormat from 'dayjs/plugin/customParseFormat.js'
 import localizedFormat from 'dayjs/plugin/localizedFormat.js'
+import weekOfYear from 'dayjs/plugin/weekOfYear.js'
+import findDeep from '../lib/find-deep.js'
 
 dayjs.extend(utc)
 dayjs.extend(customParseFormat)
 dayjs.extend(localizedFormat)
+dayjs.extend(weekOfYear)
 
-const { isPlainObject, get, reverse, map, isString, last, without, keys } = lodash
+const { camelCase, isPlainObject, get, reverse, map, last, without } = lodash
+const { pascalCase } = aneka
 let unknownLangWarning = false
 
 function outmatchNs (source, pattern) {
@@ -52,6 +55,8 @@ function outmatchNs (source, pattern) {
  * @property {Object} aneka - Access to {@link https://github.com/ardhi/aneka|aneka}
  * @property {Object} outmatch - Access to {@link https://github.com/axtgr/outmatch|outmatch}
  * @property {Object} dayjs - Access to {@link https://day.js.org|dayjs} with utc & customParseFormat plugin already applied
+ * @property {Object} freeze
+ * @property {Object} findDeep
  * @see App
  */
 const lib = {
@@ -61,7 +66,9 @@ const lib = {
   sprintf,
   outmatch,
   dayjs,
-  aneka
+  aneka,
+  freeze,
+  findDeep
 }
 
 /**
@@ -70,26 +77,26 @@ const lib = {
  * @class
  */
 class App {
-  /**
-   * Your main namespace. And yes, you suppose to NOT CHANGE this
-   *
-   * @memberof App
-   * @constant {string}
-   * @default 'main'
-   */
-  static mainNs = 'main'
-
-  /**
-   * App environments
-   * @memberof App
-   * @constant {TAppEnv}
-   */
-  static envs = { dev: 'development', prod: 'production' }
-
   /**
    * @param {string} cwd - Current working dirctory
    */
   constructor (cwd) {
+    /**
+     * Your main namespace. And yes, you suppose to NOT CHANGE this
+     *
+     * @memberof App
+     * @constant {string}
+     * @default 'main'
+     */
+    this.mainNs = 'main'
+
+    /**
+     * App environments
+     * @memberof App
+     * @constant {TAppEnv}
+     */
+    this.envs = { dev: 'development', prod: 'production' }
+
     /**
      * Date/time when your app start
      * @type {Date}
@@ -143,6 +150,20 @@ class App {
      */
     this.lib = lib
     this.lib.outmatchNs = outmatchNs.bind(this)
+    this.lib.parseObject = (obj, options = {}) => {
+      const me = this
+      const { ns, lang } = options
+      options.translator = {
+        lang,
+        prefix: 't:',
+        handler: val => {
+          const scope = ns ? me.app[ns] : me
+          const [text, ...args] = val.split('|')
+          return scope.t(text, ...args, { lang })
+        }
+      }
+      return aneka.parseObject(obj, options)
+    }
 
     /**
      * Instance of system log
@@ -152,16 +173,16 @@ class App {
     this.log = {}
 
     /**
-     * All plugin's class definitions are saved here as key-value pairs with plugin name as its key.
-     * The special key ```base``` is for {@link Base}'s class so anytime you want to
+     * All plugin's base class are saved here as key-value pairs with plugin name as its key.
+     * The special key ```Base``` && ```Tools``` is for {@link Base} & {@link Tools} class so anytime you want to
      * create your own plugin, just use something like this:
      *
      * ```javascript
-     * class MyPlugin extends this.app.pluginClass.base {
+     * class MyPlugin extends this.app.baseClass.Base {
      *   ... your class
      * }
      */
-    this.pluginClass = { base: Base }
+    this.baseClass = { Base, Tools }
 
     /**
      * If app runs in applet mode, this will be the applet's name
@@ -238,35 +259,31 @@ class App {
       const parts = l.split('=')
       cwd = parts[1]
     }
-    this.dir = resolvePath(cwd)
+    this.dir = aneka.resolvePath(cwd)
     process.env.APPDIR = this.dir
   }
 
-  get mainNs () {
-    return this.constructor.mainNs
-  }
-
   /**
-   * Add and save plugin and it's class definition (if provided)
+   * Add and save plugin and it's base class definition (if provided)
    *
    * @method
    * @param {TPlugin} plugin - A valid bajo plugin
-   * @param {Object} [pluginClass] - Plugin's class definition
+   * @param {Object} [baseClass] - Base class definition
    */
-  addPlugin = (plugin, pluginClass) => {
+  addPlugin = (plugin, baseClass) => {
     if (this[plugin.ns]) throw new Error(`Plugin '${plugin.ns}' added already`)
     this[plugin.ns] = plugin
-    if (pluginClass) this.pluginClass[plugin.ns] = pluginClass
+    if (baseClass) this.baseClass[pascalCase(plugin.ns)] = baseClass
   }
 
   /**
-   * Get all loaded plugin namesspaces
+   * Get all loaded plugin namespaces
    *
    * @method
    * @returns {string[]}
    */
   getAllNs = () => {
-    return without(keys(this.pluginClass), 'base')
+    return this.pluginPkgs.map(pkg => camelCase(pkg))
   }
 
   /**
@@ -282,7 +299,8 @@ class App {
       const result = util.inspect(arg, { depth: 10, colors: true })
       console.log(result)
     }
-    if (terminate) process.kill(process.pid, 'SIGINT')
+    // if (terminate) process.kill(process.pid, 'SIGINT')
+    if (terminate) process.exit('1')
   }
 
   /**
@@ -292,27 +310,27 @@ class App {
    * - Create {@link Bajo|Bajo} instance & initialize it
    * - {@link module:Helper/Bajo.runAsApplet|Run in applet mode} if ```-a``` or ```--applet``` is given
    *
-   * After boot process is completed, event ```bajo:afterBootComplete``` is emitted.
+   * After boot process is completed, event ```bajo:afterBootCompleted``` is emitted.
    *
    * If app mode is ```applet```, it runs your choosen applet instead.
    *
    * @method
    * @async
    * @returns {App}
-   * @fires bajo:afterBootComplete
+   * @fires bajo:afterBootCompleted
    */
   boot = async () => {
     // argv/args/env
     this.bajo = new Bajo(this)
-    const { argv, args } = await parseArgsArgv.call(this) ?? {}
+    const { argv, args } = await aneka.parseArgsArgv() ?? {}
     this.args = args
-    this.argv = argv
-    this.envVars = parseEnv.call(this)
+    this.argv = aneka.parseObject(argv, { parseValue: true })
+    this.envVars = aneka.parseObject(aneka.parseEnv(), { parseValue: true })
     this.applet = this.envVars._.applet ?? this.argv._.applet
     await this.bajo.init()
     // boot complete
     const elapsed = new Date() - this.runAt
-    this.bajo.log.debug('bootCompleted%s', this.lib.aneka.secToHms(elapsed, true))
+    this.bajo.log.debug('bootCompleted%s', aneka.secToHms(elapsed, true))
     /**
      * Run after boot process is completed
      *
@@ -321,7 +339,7 @@ class App {
      * @see {@tutorial hook}
      * @see App#boot
      */
-    await this.bajo.runHook('bajo:afterBootComplete')
+    await this.bajo.runHook('bajo:afterBootCompleted')
     if (this.applet) await runAsApplet.call(this.bajo)
     return this
   }
@@ -333,7 +351,8 @@ class App {
    * @param {string} [signal=SIGINT] - Signal to send
    */
   exit = (signal = 'SIGINT') => {
-    process.kill(process.pid, 'SIGINT')
+    if (signal === true) process.exit('1')
+    process.kill(process.pid, signal)
   }
 
   /**
@@ -407,11 +426,7 @@ class App {
       }
     }
     if (!trans) trans = text
-    const values = map(params, a => {
-      if (!isString(a)) return a
-      return a
-    })
-    return sprintf(trans, ...values)
+    return aneka.formatText(trans, ...params)
   }
 
   /**