bajo 2.0.2 → 2.1.0

package/class/app.js

@@ -15,10 +15,12 @@ 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'
 
 dayjs.extend(utc)
 dayjs.extend(customParseFormat)
 dayjs.extend(localizedFormat)
+dayjs.extend(weekOfYear)
 
 const { isPlainObject, get, reverse, map, isString, last, without, keys } = lodash
 let unknownLangWarning = false

package/class/helper/bajo.js

@@ -42,11 +42,18 @@ const defConfig = {
   env: 'dev',
   log: {
     timeTaken: false,
-    dateFormat: 'YYYY-MM-DDTHH:MM:ss.SSS[Z]',
-    localDate: false,
+    dateFormat: 'YYYY-MM-DDTHH:mm:ss.SSS',
+    useUtc: false,
     pretty: false,
     applet: false,
-    traceHook: false
+    traceHook: false,
+    save: false,
+    rotation: {
+      cycle: 'none', // none, daily, weekly, monthly
+      compressOld: true,
+      byPlugin: false,
+      retain: 5
+    }
   },
   lang: Intl.DateTimeFormat().resolvedOptions().lang ?? 'en-US',
   intl: {
@@ -109,12 +116,9 @@ export async function buildBaseConfig () {
   set(this, 'dir.base', this.app.dir)
   const path = currentLoc(import.meta).dir + '/../..'
   set(this, 'dir.pkg', this.resolvePath(path))
+  if (get(this, 'config.dir.data')) set(this, 'dir.data', this.config.dir.data)
   if (!get(this, 'dir.data')) set(this, 'dir.data', `${this.dir.base}/data`)
   this.dir.data = this.resolvePath(this.dir.data)
-  if (!fs.existsSync(this.dir.data)) {
-    console.log('Data directory (%s) doesn\'t exist yet', this.dir.data)
-    process.exit(1)
-  }
   fs.ensureDirSync(`${this.dir.data}/config`)
   if (!this.dir.tmp) {
     this.dir.tmp = `${this.resolvePath(os.tmpdir())}/${this.ns}`
@@ -222,6 +226,7 @@ export async function buildExtConfig () {
     if (!this.config.log.applet) this.config.log.level = 'silent'
     this.config.exitHandler = false
   }
+  this.log.trace('dataDir%s', this.dir.data)
   this.log.debug('configHandlers%s', this.join(exts))
 }
 

package/class/misc/log.js

@@ -1,11 +1,8 @@
 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'
+import dayjs from 'dayjs'
 
 /**
  * Log output in stringified JSON format. Returned when app run in ```prod``` environment
@@ -53,12 +50,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 +71,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 +90,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 +103,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 +117,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
+    let 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
   }
 
   /**

package/extend/bajo/intl/en-US.json

@@ -22,6 +22,7 @@
   "appRunningAsApplet": "App runs in applet mode",
   "setupBootOrder": "Setup boot order",
   "configHandlers%s": "Config handlers: %s",
+  "dataDir%s": "Data dir: %s",
   "exited": "Exited",
   "appShutdown": "App shutdown",
   "appletModeActivated": "Applet mode activated",

package/extend/bajo/intl/id.json

@@ -22,6 +22,7 @@
   "appRunningAsApplet": "App berjalan di mode applet",
   "setupBootOrder": "Atur urutan booting",
   "configHandlers%s": "Pengatur konfigurasi: %s",
+  "dataDir%s": "Dir data: %s",
   "exited": "Exited",
   "appShutdown": "Aplikasi ditutup",
   "appletModeActivated": "Mode applet diaktifkan",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bajo",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "The ultimate framework for whipping up massive apps in no time",
   "main": "index.js",
   "scripts": {

package/wiki/CONFIG.md

@@ -7,9 +7,15 @@ The following table shows the default app settings. To change these to suit your
 | ```log``` | ```object``` | | |
 |     ```dateFormat``` | ```string``` | ```YYYY-MM-DDTHH:MM:ss.SSS[Z]```| See [dayjs string & format](https://day.js.org/docs/en/parse/string-format) for more info |
 |     ```timeTaken``` | ```boolean``` | ```false```| Show time taken from previous activity in ms |
-|     ```localDate``` | ```boolean``` | ```false```| Use local date, defaults: UTC |
+|     ```useUtc``` | ```boolean``` | ```false```| Use UTC, defaults: local date/time |
 |     ```pretty``` | ```boolean``` | ```false```| Colorful, pretty styling |
 |     ```applet``` | ```boolean``` | ```false```| Show log even in applet mode |
+|     ```save``` | ```boolean``` | ```false```| Save log in '{dataDir}/log' |
+|     ```rotation``` | ```object``` | | Log rotation config if ```save``` is true  |
+|         ```cycle``` | ```string``` | ```none``` | Available values: ```none```, ```daily```, ```weekly```, ```monthly``` |
+|         ```compressOld``` | ```boolean``` | ```false``` | Set to ```true``` to compress old logs |
+|         ```byPlugin``` | ```boolean``` | ```false``` | Split log by plugin's name |
+|         ```retain``` | ```integer``` | ```5``` | How many old logs will be kept/retained |
 | ```lang``` | ```string``` | Auto detected | Valid language code e.g: 'en-US', 'id', etc. |
 | ```intl``` | ```object``` | | Internationalization settings |
 |     ```supported``` | ```array``` | ```['en-US', 'id']``` | Supported languages |