bajo 2.14.1 → 2.15.0

package/class/app/cache.js

@@ -0,0 +1,90 @@
+class Cache {
+  constructor (app) {
+    this.app = app
+  }
+
+  getRootDir = () => {
+    const { getPluginDataDir } = this.app.bajo
+    return `${getPluginDataDir('bajo')}/cache`
+  }
+
+  prep = (name, ttlDur = 0) => {
+    const { breakNsPath } = this.app.bajo
+    const { aneka, fs } = this.app.lib
+    const { ns, subNs, path } = breakNsPath(name)
+    ttlDur = aneka.parseDuration(ttlDur)
+    if (ttlDur === 0 || !subNs) return
+    const cacheDir = `${this.getRootDir()}/${ns}/${subNs}`
+    const dir = `${cacheDir}/${ttlDur}`
+    fs.ensureDirSync(dir)
+    const file = `${dir}/${path}`
+    return { dir, file, cacheDir }
+  }
+
+  load = async (name, ttlDur = 0) => {
+    const { fs } = this.app.lib
+    const { dir, file } = this.prep(name, ttlDur) ?? {}
+    if (!file) return
+    if (!fs.existsSync(file)) return
+    const { mtimeMs } = await fs.stat(dir)
+    if (Date.now() - mtimeMs > ttlDur) {
+      await fs.remove(dir)
+      return
+    }
+    let content = fs.readFileSync(file, 'utf8')
+    try {
+      if (['{', '['].includes(content[0]) && ['}', ']'].includes(content[content.length - 1])) content = JSON.parse(content)
+    } catch (err) {}
+    return content
+  }
+
+  save = async (name, item, ttlDur = 0) => {
+    const { fs } = this.app.lib
+    const { cloneDeep, isArray, isPlainObject } = this.app.lib._
+    const { dir, file } = this.prep(name, ttlDur) ?? {}
+    if (!file || !item) return
+    fs.ensureDirSync(dir)
+    let content = cloneDeep(item)
+    if (isArray(item) || isPlainObject(item)) content = JSON.stringify(content)
+    fs.writeFileSync(file, content, 'utf8')
+  }
+
+  sync = async (name, item, ttlDur = 0) => {
+    const content = await this.loadCache(name, ttlDur)
+    if (!content) await this.saveCache(name, item, ttlDur)
+    return content
+  }
+
+  _purgeItem = (name) => {
+    if (!this.app.bajo) return
+    const { fs, fastGlob } = this.app.lib
+    try {
+      if (name === '*') {
+        const dirs = fastGlob.globSync(`${this.getRootDir()}/*`, { onlyDirectories: true })
+        for (const dir of dirs) {
+          fs.removeSync(dir)
+        }
+      } else fs.removeSync(`${this.getRootDir()}/${name}`)
+    } catch (err) {}
+  }
+
+  purge = (name) => {
+    if (!this.app.bajo) return
+    if (name) return this._purgeItem(name)
+    const { fastGlob, fs } = this.app.lib
+    const dirs = fastGlob.globSync(`${this.getRootDir()}/*/*/*`, { onlyDirectories: true })
+    for (const dir of dirs) {
+      try {
+        const ttlDur = Number(dir.split('/').pop())
+        const { mtimeMs } = fs.statSync(dir)
+        if (Date.now() - mtimeMs > ttlDur) fs.removeSync(dir)
+      } catch (err) {}
+    }
+  }
+
+  dispose = async () => {
+    this.app = null
+  }
+}
+
+export default Cache

package/class/app.js

@@ -2,6 +2,7 @@ import util from 'util'
 import Bajo from './bajo.js'
 import Base from './base.js'
 import { runAsApplet } from './helper/bajo.js'
+import Cache from './app/cache.js'
 import Tools from './plugin/tools.js'
 
 import { outmatchNs, parseObject, lib } from './helper/app.js'
@@ -196,6 +197,8 @@ class App {
      */
     this.envVars = {}
 
+    this.cache = new Cache(this)
+
     if (!options.cwd) options.cwd = process.cwd()
     const l = last(process.argv)
     if (l.startsWith('--cwd')) {
@@ -278,6 +281,9 @@ class App {
     this.applet = this.envVars._.applet ?? this.argv._.applet
     await this.bajo.runHook('bajo:beforeBoot')
     await this.bajo.init()
+    // cache
+    this.cache.purge()
+    setInterval(this.cache.purge, this.bajo.config.cache.purgeIntvDur)
     // boot complete
     const elapsed = new Date() - this.runAt
     this.bajo.log.debug('bootCompleted%s', secToHms(elapsed, true))

package/class/bajo.js

@@ -341,23 +341,20 @@ class Bajo extends Plugin {
    * @returns {any}
    */
   eachPlugins = async (handler, options = {}) => {
-    if (typeof options === 'string') options = { glob: options }
-    const { glob, useBajo, prefix = '', noUnderscore = true, returnItems } = options
+    if (isString(options)) options = { glob: options }
+    const { glob = [], useBajo, prefix = '', noUnderscore = true, returnItems, opts = {} } = options
+    const globs = isString(glob) ? [glob] : [...glob]
     const pluginPkgs = useBajo ? [...cloneDeep(this.app.pluginPkgs), 'bajo'] : this.app.pluginPkgs
     const result = {}
     for (const pkgName of pluginPkgs) {
       const ns = camelCase(pkgName)
       let r
-      if (glob) {
+      if (globs.length > 0) {
         const base = prefix === '' ? `${this.app[ns].dir.pkg}/extend` : `${this.app[ns].dir.pkg}/extend/${prefix}`
-        let opts = isString(glob) ? { pattern: [glob] } : glob
-        let pattern = opts.pattern ?? []
-        if (isString(pattern)) pattern = [pattern]
-        opts = omit(opts, ['pattern'])
-        for (const i in pattern) {
-          if (!path.isAbsolute(pattern[i])) pattern[i] = `${base}/${pattern[i]}`
-        }
-        const files = await fastGlob(pattern, opts)
+        const patterns = globs.map(glob => {
+          return !path.isAbsolute(glob) ? `${base}/${glob}` : glob
+        })
+        const files = await fastGlob.glob(patterns, opts)
         for (const f of files) {
           if (path.basename(f)[0] === '_' && noUnderscore) continue
           const resp = await handler.call(this.app[ns], { file: f, dir: base })
@@ -850,7 +847,7 @@ class Bajo extends Plugin {
     const { parseObject } = this.app.lib
     const { defaultsDeep } = this.app.lib.aneka
     const { uniq, isString, isArray, findIndex, isPlainObject, merge } = this.app.lib._
-    let { ns, baseNs, extend, checkOverride, merge: merged, pattern, ignoreError = true, defValue = {}, parserOpts = {}, globOpts = {}, handler } = options
+    let { ns, baseNs, extend, checkOverride, merge: merged, pattern, ignoreError = true, defValue = {}, parserOpts = {}, globOpts = {}, handler, cache = {} } = options
 
     const getParseOptsArgs = (opts, orig) => {
       opts.parserOpts = opts.parserOpts ?? {}
@@ -866,6 +863,7 @@ class Bajo extends Plugin {
       let orig = parseObject(obj)
       if (!baseNs || extend === false) {
         await this.runHook('bajo:afterReadConfig', file, orig, options)
+        if (cache.name) await this.app.cache.save(cache.name, orig, cache.ttlDur)
         return orig
       }
       const { suffix = '', keys = [] } = options
@@ -907,9 +905,13 @@ class Bajo extends Plugin {
       let result = isArray(orig) ? [...orig, ...ext] : binder({}, keys.length > 0 ? pick(ext, keys) : ext, orig)
       if (handler) result = await this.callHandler(this.app[ns], handler, result)
       await this.runHook('bajo:afterReadConfig', file, result, options)
+      if (cache.name) await this.app.cache.save(cache.name, result, cache.ttlDur)
       return result
     }
 
+    let result
+    if (cache.name) result = await this.app.cache.load(cache.name, cache.ttlDur)
+    if (result) return result
     await this.runHook('bajo:beforeReadConfig', file, options)
     parserOpts.readFromFile = true
     if (!ns) ns = this.ns
@@ -999,19 +1001,19 @@ class Bajo extends Plugin {
    * @param {string} path - Base path to start looking config files
    * @returns {Object}
    */
-  readAllConfigs = async (path) => {
+  readAllConfigs = async (path, options) => {
     const { defaultsDeep } = this.app.lib.aneka
     let cfg = {}
     let ext = {}
     // default config file
     try {
-      cfg = await this.readConfig(`${path}.*`)
+      cfg = await this.readConfig(`${path}.*`, options)
     } catch (err) {
       if (['BAJO_CONFIG_NO_PARSER'].includes(err.code)) throw err
     }
     // env based config file
     try {
-      ext = await this.readConfig(`${path}-${this.config.env}.*`)
+      ext = await this.readConfig(`${path}-${this.config.env}.*`, options)
     } catch (err) {
       if (!['BAJO_CONFIG_FILE_NOT_FOUND'].includes(err.code)) throw err
     }
@@ -1028,15 +1030,7 @@ class Bajo extends Plugin {
    * @returns {Array} Array of hook execution results
    */
   runHook = async (hookName, ...args) => {
-    let ns
-    let path
-    let subNs
-    try {
-      ({ ns, subNs, path } = this.breakNsPath(hookName ?? ''))
-    } catch (err) {
-      return
-    }
-    let fns = filter(this.hooks, { ns, subNs, path })
+    let fns = filter(this.hooks, { name: hookName })
     if (isEmpty(fns)) return []
     fns = orderBy(fns, ['level'])
     const results = []

package/class/helper/bajo.js

@@ -69,7 +69,11 @@ const defConfig = {
       id: 'metric'
     }
   },
-  exitHandler: true
+  exitHandler: true,
+  cache: {
+    purge: [],
+    purgeIntvDur: '5m'
+  }
 }
 
 const defMain = `async function factory (pkgName) {
@@ -203,9 +207,9 @@ export async function collectConfigHandlers () {
  */
 export async function buildExtConfig () {
   // config merging
-  const { defaultsDeep } = this.app.lib.aneka
+  const { defaultsDeep, includes } = this.app.lib.aneka
   const { parseObject, omitDeep } = this.app.lib
-  const { isEmpty, get } = this.app.lib._
+  const { isEmpty, get, isString, without } = this.app.lib._
 
   let resp = get(this, `app.options.config.${this.ns}`, {})
   if (isEmpty(resp)) resp = await this.readAllConfigs(`${this.dir.data}/config/${this.ns}`)
@@ -231,6 +235,16 @@ export async function buildExtConfig () {
     this.config.exitHandler = false
   }
   if (this.config.runtime.noWarning) process.removeAllListeners('warning')
+  if (isString(this.config.cache.purge)) this.config.cache.purge = [this.config.cache.purge]
+  this.config.cache.purge = without(this.config.cache.purge, '', null, undefined)
+  if (this.config.cache.purge.length > 0) {
+    if (includes(['all', '*'], this.config.cache.purge)) this.app.cache.purge('*')
+    else {
+      for (const name of this.config.cache.purge) {
+        this.app.cache.purge(name)
+      }
+    }
+  }
   this.app.log = new Log(this.app)
   this.log.trace('dataDir%s', this.dir.data)
   this.log.debug('configHandlers%s', this.join(exts))

package/class/helper/base.js

@@ -100,29 +100,43 @@ export async function checkDependencies () {
  */
 export async function collectHooks () {
   const { eachPlugins, runHook, isLogInRange, importModule } = this.bajo
+  const { isArray, isPlainObject } = this.lib._
   const me = this // "this" is "app"
   me.bajo.log.trace('collecting%s', this.t('hooks'))
   await eachPlugins(async function ({ dir, file }) {
-    const mod = await importModule(file, { asHandler: true })
+    let mod = await importModule(file, { asHandler: true })
     if (!mod) return undefined
-    const _file = file.replace(dir + '/hook/', '').replace('.js', '')
-    let [names, path] = _file.split('@')
-    names = names.split('$').map(n => trim(n))
-    for (const name of names) {
-      let [ns, subNs, subSubNs] = name.split('.').map(n => camelCase(n))
-      if (subSubNs) subNs = `${subNs}.${subSubNs}`
-      const m = merge({}, mod, { ns, subNs, path: camelCase(path), src: this.ns })
-      me.bajo.hooks.push(m)
+    if (file.includes('hook.js')) mod = await mod.handler.call(this)
+    if (isArray(mod)) {
+      for (const m of mod) {
+        if (!isPlainObject(m)) continue
+        if (!m.name) throw me.bajo.error('missing%s%s', 'name', file)
+        if (isArray(m.name)) {
+          for (const name of m.name) {
+            me.bajo.hooks.push(merge({}, m, { name, src: this.ns }))
+          }
+        } else {
+          m.src = this.ns
+          me.bajo.hooks.push(m)
+        }
+      }
+    } else {
+      const _file = file.replace(dir + '/hook/', '').replace('.js', '')
+      let [names, path] = _file.split('@')
+      names = names.split('$').map(n => trim(n))
+      for (let name of names) {
+        name = name.split('.').map(n => camelCase(n)).join('.')
+        const m = merge({}, mod, { name: `${name}:${camelCase(path)}`, src: this.ns })
+        me.bajo.hooks.push(m)
+      }
     }
-  }, { glob: 'hook/**/*.js', prefix: me.bajo.ns })
+  }, { glob: ['hook/*.js', 'hook.js'], prefix: me.bajo.ns })
   // for log trace purpose only
   if (isLogInRange('trace')) {
-    const items = groupBy(me.bajo.hooks, item => item.ns + (item.subNs ? `.${item.subNs}` : ''))
+    const items = groupBy(me.bajo.hooks, item => item.name)
     forOwn(items, (v, k) => {
-      const hooks = groupBy(v, 'path')
-      forOwn(hooks, (v1, k1) => {
-        me.bajo.log.trace('- %s:%s (%d)', k, k1, v1.length)
-      })
+      const [name, path] = k.split(':')
+      me.bajo.log.trace('- %s:%s (%d)', name, path, v.length)
     })
   }
 

package/package.json

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

package/wiki/CHANGES.md

@@ -1,5 +1,12 @@
 # Changes
 
+## 2026-05-28
+
+- [2.15.0] Add built-in cache feature through ```app.cache``` instance
+- [2.15.0] Bug fix in ```eachPlugins()```
+- [2.15.0] Add cache feature to ```readConfig()```
+- [2.15.0] Add feature to read many hooks as one file
+
 ## 2026-05-22
 
 - [2.14.1] Bug fix in ```helper.buildBaseConfig()```