bajo 1.2.8 → 2.0.0

package/boot/class/bajo-core/boot-order.js

@@ -1,35 +0,0 @@
-import lodash from 'lodash'
-import fs from 'fs-extra'
-
-const { reduce, map, isNaN, trim, forOwn, orderBy } = lodash
-
-async function bootOrder () {
-  this.log.debug('setupBootOrder')
-  const order = reduce(this.pluginPkgs, (o, k, i) => {
-    const key = map(k.split(':'), m => trim(m))
-    if (key[1] && !isNaN(Number(key[1]))) o[key[0]] = Number(key[1])
-    else o[key[0]] = 10000 + i
-    return o
-  }, {})
-  const norder = {}
-  for (let n of this.pluginPkgs) {
-    n = map(n.split(':'), m => trim(m))[0]
-    const dir = n === this.mainNs ? (`${this.dir.base}/${this.mainNs}`) : this.getModuleDir(n)
-    if (n !== this.mainNs && !fs.existsSync(dir)) throw this.error('packageNotFoundOrNotBajo%s', n)
-    norder[n] = NaN
-    try {
-      norder[n] = Number(trim(await fs.readFile(`${dir}/.bootorder`, 'utf8')))
-    } catch (err) {}
-  }
-  const result = []
-  forOwn(order, (v, k) => {
-    const item = { k, v: isNaN(norder[k]) ? v : norder[k] }
-    result.push(item)
-  })
-  this.pluginPkgs = map(orderBy(result, ['v']), 'k')
-  this.log.info('runInEnv%s', this.print.write(this.envs[this.config.env]))
-  // misc
-  this.freeze(this.config)
-}
-
-export default bootOrder

package/boot/class/bajo-core/boot-plugins.js

@@ -1,17 +0,0 @@
-import buildConfig from '../bajo-plugin/build-config.js'
-import checkDependency from '../bajo-plugin/check-dependency.js'
-import checkClash from '../bajo-plugin/check-clash.js'
-import attachMethod from '../bajo-plugin/attach-method.js'
-import collectHooks from '../bajo-plugin/collect-hooks.js'
-import run from '../bajo-plugin/run.js'
-
-async function bootPlugins () {
-  await buildConfig.call(this.app)
-  await checkClash.call(this.app)
-  await checkDependency.call(this.app)
-  await attachMethod.call(this.app)
-  await collectHooks.call(this.app)
-  await run.call(this.app)
-}
-
-export default bootPlugins

package/boot/class/bajo-core/build-config.js

@@ -1,85 +0,0 @@
-import readAllConfigs from '../../lib/read-all-configs.js'
-import currentLoc from '../../lib/current-loc.js'
-import omitDeep from 'omit-deep'
-import os from 'os'
-import fs from 'fs-extra'
-
-import lodash from 'lodash'
-const { map, pick, values, keys, set, get } = lodash
-
-const omitted = ['spawn', 'cwd', 'name', 'alias', 'applet', 'a', 'plugins']
-
-const defConfig = {
-  log: {
-    dateFormat: 'YYYY-MM-DDTHH:MM:ss.SSS[Z]',
-    applet: false,
-    traceHook: false
-  },
-  lang: Intl.DateTimeFormat().resolvedOptions().lang ?? 'en-US',
-  intl: {
-    supported: ['en-US', 'id'],
-    fallback: 'en-US',
-    lookupOrder: [],
-    format: {
-      emptyValue: '',
-      datetime: { dateStyle: 'medium', timeStyle: 'short' },
-      date: { dateStyle: 'medium' },
-      time: { timeStyle: 'short' },
-      float: { maximumFractionDigits: 2 },
-      double: { maximumFractionDigits: 5 },
-      smallint: {},
-      integer: {}
-    },
-    unitSys: {
-      'en-US': 'imperial',
-      id: 'metric'
-    }
-  },
-  exitHandler: true
-}
-
-export async function buildBaseConfig () {
-  const { defaultsDeep } = this.lib.aneka
-  this.applet = this.app.argv._.applet
-  this.config = defaultsDeep({}, this.app.env._, this.app.argv._)
-  this.alias = this.name
-  set(this, 'dir.base', this.app.dir)
-  const path = currentLoc(import.meta).dir + '/../../..'
-  set(this, 'dir.pkg', this.resolvePath(path))
-  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.name}`
-    fs.ensureDirSync(this.dir.tmp)
-  }
-  this.app.addPlugin(this)
-}
-
-export async function buildExtConfig () {
-  // config merging
-  const { defaultsDeep } = this.lib.aneka
-  let resp = await readAllConfigs.call(this.app, `${this.dir.data}/config/${this.name}`)
-  resp = omitDeep(pick(resp, ['log', 'exitHandler', 'env']), omitted)
-  this.config = defaultsDeep({}, resp, this.config, defConfig)
-  this.config.env = (this.config.env ?? 'dev').toLowerCase()
-  if (values(this.envs).includes(this.config.env)) this.config.env = this.lib.aneka.getKeyByValue(this.envs, this.config.env)
-  if (!keys(this.envs).includes(this.config.env)) throw new Error(`Unknown environment '${this.config.env}'. Supported: ${this.join(keys(this.envs))}`)
-  process.env.NODE_ENV = this.envs[this.config.env]
-  if (!this.config.log.level) this.config.log.level = this.config.env === 'dev' ? 'debug' : 'info'
-  if (this.config.silent) this.config.log.level = 'silent'
-  if (this.applet) {
-    if (!this.pluginPkgs.includes('bajo-cli')) throw new Error('Applet needs to have \'bajo-cli\' loaded first')
-    if (!this.config.log.applet) this.config.log.level = 'silent'
-    this.config.exitHandler = false
-  }
-  const exts = map(this.configHandlers, 'ext')
-  this.initPrint()
-  this.initLog()
-  this.log.debug('configHandlers%s', this.join(exts))
-  this.config = this.parseObject(this.config, { parseValue: true })
-}

package/boot/class/bajo-core/build-plugins.js

@@ -1,44 +0,0 @@
-import lodash from 'lodash'
-import fs from 'fs-extra'
-import resolvePath from '../../lib/resolve-path.js'
-
-const { isString, filter, map, trim, without, uniq, camelCase, isEmpty, omit } = lodash
-
-async function buildPlugins () {
-  let pluginPkgs = this.config.plugins ?? []
-  if (isString(pluginPkgs)) pluginPkgs = [pluginPkgs]
-  const pluginsFile = `${this.dir.data}/config/.plugins`
-  if (fs.existsSync(pluginsFile)) {
-    pluginPkgs = pluginPkgs.concat(filter(map(trim(fs.readFileSync(pluginsFile, 'utf8')).split('\n'), p => trim(p)), b => !isEmpty(b)))
-  }
-  this.pluginPkgs = map(filter(without(uniq(pluginPkgs), this.mainNs), p => {
-    return p[0] !== '#'
-  }), p => {
-    return trim(p.split('#')[0])
-  })
-  this.pluginPkgs.push(this.mainNs)
-  for (const pkg of this.pluginPkgs) {
-    const ns = camelCase(pkg)
-    let dir
-    if (ns === 'main') {
-      dir = `${this.dir.base}/${this.mainNs}`
-      fs.ensureDirSync(dir)
-      fs.ensureDirSync(`${dir}/plugin`)
-    } else dir = this.getModuleDir(pkg)
-    let plugin
-    const factory = `${dir}/index.js`
-    if (fs.existsSync(factory)) {
-      const { default: builder } = await import(resolvePath(factory, true))
-      const FactoryClass = await builder.call(this, pkg)
-      plugin = new FactoryClass()
-      if (!(plugin instanceof this.lib.BajoPlugin)) throw new Error(`Plugin package '${pkg}' should be an instance of BajoPlugin`)
-    } else {
-      plugin = new this.lib.BajoPlugin(pkg, this.app)
-    }
-    this.pluginNames.push(plugin.name)
-    this.app.addPlugin(plugin)
-  }
-  this.config = omit(this.config, this.pluginNames)
-}
-
-export default buildPlugins

package/boot/class/bajo-core/collect-config-handlers.js

@@ -1,20 +0,0 @@
-import lodash from 'lodash'
-const { isFunction, isPlainObject, camelCase } = lodash
-
-async function collectConfigHandlers () {
-  for (const pkg of this.pluginPkgs) {
-    let dir
-    try {
-      dir = this.getModuleDir(pkg)
-    } catch (err) {}
-    if (!dir) continue
-    const file = `${dir}/bajo/config-handlers.js`
-    let mod = await this.importModule(file)
-    if (!mod) continue
-    if (isFunction(mod)) mod = await mod.call(this.app[camelCase(pkg)])
-    if (isPlainObject(mod)) mod = [mod]
-    this.configHandlers = this.configHandlers.concat(mod)
-  }
-}
-
-export default collectConfigHandlers

package/boot/class/bajo-core/exit-handler.js

@@ -1,53 +0,0 @@
-async function exit (signal) {
-  const { eachPlugins } = this
-  this.log.warn('signalReceived%s', signal)
-  await eachPlugins(async function ({ ns }) {
-    try {
-      await this.stop()
-    } catch (err) {}
-    this.log.debug('exited')
-  })
-  this.log.debug('appShutdown')
-  process.exit(0)
-}
-
-async function exitHandler () {
-  if (!this.config.exitHandler) return
-
-  process.on('SIGINT', async () => {
-    await exit.call(this, 'SIGINT')
-  })
-
-  process.on('SIGTERM', async () => {
-    await exit.call(this, 'SIGTERM')
-  })
-
-  process.on('uncaughtException', (error, origin) => {
-    setTimeout(() => {
-      console.error(error)
-      // process.exit(1)
-    }, 50)
-  })
-
-  process.on('unhandledRejection', (reason, promise) => {
-    const stackFile = reason.stack.split('\n')[1]
-    let file
-    const info = stackFile.match(/\((.*)\)/) // file is in (<file>)
-    if (info) file = info[1]
-    else if (stackFile.startsWith('    at ')) file = stackFile.slice(7) // file is stackFile itself
-    if (!file) return
-    const parts = file.split(':')
-    const column = parseInt(parts[parts.length - 1])
-    const line = parseInt(parts[parts.length - 2])
-    parts.pop()
-    parts.pop()
-    file = parts.join(':')
-    this.log.error({ file, line, column }, '%s', reason.message)
-  })
-
-  process.on('warning', warning => {
-    this.log.error('%s', warning.message)
-  })
-}
-
-export default exitHandler

package/boot/class/bajo-core/run-as-applet.js

@@ -1,26 +0,0 @@
-async function runAsApplet () {
-  const { isString, map, find } = this.lib._
-  await this.eachPlugins(async function ({ file, ns, alias }) {
-    this.app.bajo.applets.push({ ns, file, alias })
-  }, { glob: 'applet.js', prefix: 'bajoCli' })
-
-  this.log.debug('appletModeActivated')
-  this.print.info('appRunningAsApplet')
-  if (this.applets.length === 0) this.print.fatal('noAppletLoaded')
-  let name = this.applet
-  if (!isString(this.applet)) {
-    const select = await this.importPkg('bajoCli:@inquirer/select')
-    name = await select({
-      message: this.print.write('Please select:'),
-      choices: map(this.applets, t => ({ value: t.ns }))
-    })
-  }
-  const [ns, path] = name.split(':')
-  const applet = find(this.applets, a => (a.ns === ns || a.alias === ns))
-  if (!applet) this.print.fatal('notFound%s%s', this.print.write('applet'), name)
-  await this.runHook(`${this.app[applet.ns]}:beforeAppletRun`)
-  await this.app.bajoCli.runApplet(applet, path, ...this.app.args)
-  await this.runHook(`${this.app[applet.ns]}:afterAppletRun`)
-}
-
-export default runAsApplet

package/boot/class/bajo-plugin/attach-method.js

@@ -1,14 +0,0 @@
-import createMethod from '../../lib/create-method.js'
-
-async function attachMethod () {
-  const { eachPlugins } = this.bajo
-  const me = this
-  me.bajo.log.debug('attachMethods')
-  await eachPlugins(async function ({ ns, pkgName }) {
-    const dir = ns === me.bajo.mainNs ? (`${me.bajo.dir.base}/${me.bajo.mainNs}`) : me.bajo.getModuleDir(pkgName)
-    const num = await createMethod.call(me[ns], `${dir}/plugin-method`, pkgName)
-    me.bajo.log.trace('- %s (%d)', ns, num)
-  })
-}
-
-export default attachMethod

package/boot/class/bajo-plugin/build-config.js

@@ -1,15 +0,0 @@
-import lodash from 'lodash'
-
-const { camelCase } = lodash
-
-async function buildConfig () {
-  this.bajo.log.debug('readConfigs')
-  for (const pkg of this.bajo.pluginPkgs) {
-    const plugin = this[camelCase(pkg)]
-    await plugin.loadConfig()
-    plugin.initPrint()
-    plugin.initLog()
-  }
-}
-
-export default buildConfig

package/boot/class/bajo-plugin/check-clash.js

@@ -1,18 +0,0 @@
-import lodash from 'lodash'
-
-const { find } = lodash
-
-async function checkAlias () {
-  const { eachPlugins } = this.bajo
-  this.bajo.log.debug('checkAliasNameClash')
-  const refs = []
-  await eachPlugins(async function ({ ns, pkgName, alias }) {
-    let item = find(refs, { ns })
-    if (item) throw this.error('pluginNameClash%s%s%s%s', ns, pkgName, item.ns, item.pkgName, { code: 'BAJO_NAME_CLASH' })
-    item = find(refs, { alias })
-    if (item) throw this.error('pluginNameClash%s%s%s%s', alias, pkgName, item.alias, item.pkgName, { code: 'BAJO_ALIAS_CLASH' })
-    refs.push({ ns, alias, pkgName })
-  })
-}
-
-export default checkAlias

package/boot/class/bajo-plugin/check-dependency.js

@@ -1,39 +0,0 @@
-import lodash from 'lodash'
-import semver from 'semver'
-
-const { reduce, map, trim, keys, intersection, each, camelCase, get } = lodash
-
-async function runner ({ ns, pkgName }) {
-  const { join } = this.app.bajo
-  this.app.bajo.log.trace('- %s', ns)
-  const odep = reduce(this.dependencies, (o, k) => {
-    const item = map(k.split('@'), m => trim(m))
-    if (k[0] === '@') o['@' + item[1]] = item[2]
-    else o[item[0]] = item[1]
-    return o
-  }, {})
-  const deps = keys(odep)
-  if (deps.length > 0) {
-    if (intersection(this.app.bajo.pluginPkgs, deps).length !== deps.length) {
-      throw this.error('dependencyUnfulfilled%s%s', pkgName, join(deps), { code: 'BAJO_DEPENDENCY' })
-    }
-    each(deps, d => {
-      if (!odep[d]) return
-      const ver = get(this.app[camelCase(d)], 'config.pkg.version')
-      if (!ver) return
-      if (!semver.satisfies(ver, odep[d])) {
-        throw this.error('semverCheckFailed%s%s', pkgName, `${d}@${odep[d]}`, { code: 'BAJO_DEPENDENCY_SEMVER' })
-      }
-    })
-  }
-}
-
-async function checkDependency () {
-  const { eachPlugins } = this.bajo
-  this.bajo.log.debug('checkDeps')
-  await eachPlugins(async function ({ ns, pkgName, config }) {
-    await runner.call(this, { ns, pkgName, config })
-  })
-}
-
-export default checkDependency

package/boot/class/bajo-plugin/collect-hooks.js

@@ -1,31 +0,0 @@
-import lodash from 'lodash'
-
-const { merge, forOwn, groupBy } = lodash
-
-async function collectHooks () {
-  const { eachPlugins, runHook, isLogInRange, importModule, breakNsPathFromFile } = this.bajo
-  const me = this
-  me.bajo.hooks = this.bajo.hooks ?? []
-  me.bajo.log.debug('collectHooks')
-  // collects
-  await eachPlugins(async function ({ ns, dir, file }) {
-    const { fullNs, path } = breakNsPathFromFile({ file, dir, baseNs: ns, suffix: '/hook/' })
-    const mod = await importModule(file, { asHandler: true })
-    if (!mod) return undefined
-    merge(mod, { ns: fullNs, path, src: ns })
-    me.bajo.hooks.push(mod)
-  }, { glob: 'hook/**/*.js', prefix: me.bajo.name })
-  // for log trace purpose only
-  if (!isLogInRange('trace')) return
-  const items = groupBy(me.bajo.hooks, 'ns')
-  forOwn(items, (v, k) => {
-    const hooks = groupBy(v, 'path')
-    forOwn(hooks, (v1, k1) => {
-      me.bajo.log.trace('- %s:%s (%d)', k, k1, v1.length)
-    })
-  })
-  // run handler
-  await runHook('bajo:afterCollectHooks')
-}
-
-export default collectHooks

package/boot/class/bajo-plugin/run.js

@@ -1,23 +0,0 @@
-import lodash from 'lodash'
-const { camelCase, map } = lodash
-
-async function run () {
-  const me = this
-  const { runHook, eachPlugins, join } = me.bajo
-  const { freeze } = me.bajo
-  const methods = ['init']
-  if (!me.bajo.applet) methods.push('start')
-  for (const method of methods) {
-    await runHook(`bajo:${camelCase(`before ${method} all plugins`)}`)
-    await eachPlugins(async function ({ ns }) {
-      if (method === 'start') freeze(me[ns].config)
-      await runHook(`${ns}:${camelCase(`before ${method}`)}`)
-      await me[ns][method]()
-      await runHook(`${ns}:${camelCase(`after ${method}`)}`)
-    })
-    await runHook(`bajo:${camelCase(`after ${method} all plugins`)}`)
-  }
-  me.bajo.log.debug('loadedPlugins%s', join(map(me.bajo.pluginPkgs, b => camelCase(b))))
-}
-
-export default run

package/boot/class/log.js

@@ -1,90 +0,0 @@
-import os from 'os'
-import lodash from 'lodash'
-import dayjs from 'dayjs'
-import logLevels from '../lib/log-levels.js'
-
-const { isEmpty, without, merge, upperFirst } = lodash
-
-export function isIgnored (level) {
-  const { filter, isArray } = this.lib._
-  let ignore = this.app.bajo.config.log.ignore ?? []
-  if (!isArray(ignore)) ignore = [ignore]
-  const items = filter(ignore, i => {
-    const [ns, lvl] = i.split(':')
-    if (lvl) return ns === this.name && lvl === level
-    return ns === this.name
-  })
-  return items.length > 0
-}
-
-class Log {
-  constructor (plugin) {
-    this.plugin = plugin
-    this.format = 'YYYY-MM-DDTHH:mm:ss.SSS[Z]'
-  }
-
-  init = () => {
-    this.bajoLog = this.plugin.app.bajo.config.log.logger ?? 'bajoLogger'
-  }
-
-  write = (text, ...args) => {
-    return this.plugin.print.write(text, ...args)
-  }
-
-  isExtLogger = () => {
-    return this.plugin.app[this.bajoLog] && this.plugin.app[this.bajoLog].logger
-  }
-
-  isIgnored = level => {
-    return isIgnored.call(this.plugin, level)
-  }
-
-  child = () => {
-    if (this.isExtLogger()) return this.plugin.app[this.bajoLog].logger.child()
-    return this.plugin.app
-  }
-
-  formatMsg = (level, ...params) => {
-    if (this.plugin.app.bajo.config.log.level === 'silent') return
-    if (!this.plugin.app.bajo.isLogInRange(level)) return
-    let [data, msg, ...args] = params
-    if (typeof data === 'string') {
-      args.unshift(msg)
-      msg = data
-      data = null
-    }
-    args = without(args, undefined)
-    if (data instanceof Error) {
-      msg = 'error%s'
-      args = [data.message]
-    }
-    msg = `[${this.plugin.name}] ${this.write(msg, ...args)}`
-    if (this.plugin.app[this.bajoLog] && this.plugin.app[this.bajoLog].logger) {
-      this.plugin.app[this.bajoLog].logger[level](data, msg, ...args)
-    } else {
-      let text
-      const dt = new Date()
-      if (this.plugin.app.bajo.config.env === 'prod') {
-        const json = { level: logLevels[level], time: dt.valueOf(), pid: process.pid, hostname: os.hostname() }
-        if (!isEmpty(data)) merge(json, data)
-        merge(json, { msg })
-        text = JSON.stringify(json)
-      } else {
-        text = `[${dayjs(dt).utc(true).format(this.format)}] ${upperFirst(level)}: ${msg}`
-        if (!isEmpty(data)) text += '\n' + JSON.stringify(data)
-      }
-      if (!this.isIgnored(level)) {
-        console.log(text)
-        if (data instanceof Error && level === 'trace') console.error(data)
-      }
-    }
-  }
-}
-
-Object.keys(logLevels).forEach(level => {
-  Log.prototype[level] = function (...params) {
-    this.formatMsg(level, ...params)
-  }
-})
-
-export default Log

package/boot/class/plugin.js

@@ -1,79 +0,0 @@
-import lodash from 'lodash'
-import omittedPluginKeys from '../lib/omitted-plugin-keys.js'
-import Log from './log.js'
-import Print from './print.js'
-import BajoError from './error.js'
-import fastGlob from 'fast-glob'
-import { sprintf } from 'sprintf-js'
-import outmatch from 'outmatch'
-import dayjs from '../lib/dayjs.js'
-import fs from 'fs-extra'
-import aneka from 'aneka/index.js'
-
-function outmatchNs (source, pattern) {
-  const { breakNsPath } = this.app.bajo
-  const [src, subSrc] = source.split(':')
-  if (!subSrc) return pattern === src
-  try {
-    const { fullNs, path } = breakNsPath(pattern)
-    const isMatch = outmatch(path)
-    return src === fullNs && isMatch(subSrc)
-  } catch (err) {
-    return false
-  }
-}
-
-const lib = {
-  _: lodash,
-  fs,
-  fastGlob,
-  sprintf,
-  outmatch,
-  dayjs,
-  aneka
-}
-
-const { get, isEmpty, cloneDeep, omit, isPlainObject, camelCase } = lodash
-
-class Plugin {
-  constructor (pkgName, app) {
-    this.pkgName = pkgName
-    this.name = camelCase(pkgName)
-    this.app = app
-    this.config = {}
-    this.lib = lib
-    this.lib.outmatchNs = outmatchNs.bind(this)
-  }
-
-  getConfig = (path, options = {}) => {
-    let obj = isEmpty(path) ? this.config : get(this.config, path, options.defValue ?? {})
-    options.omit = options.omit ?? omittedPluginKeys
-    if (isPlainObject(obj) && !isEmpty(options.omit)) obj = omit(obj, options.omit)
-    if (!options.noclone) obj = cloneDeep(obj)
-    return obj
-  }
-
-  initLog = () => {
-    this.log = new Log(this)
-    this.log.init()
-  }
-
-  initPrint = (opts) => {
-    this.print = new Print(this, opts)
-    this.print.init()
-  }
-
-  error = (msg, ...args) => {
-    if (!this.print) return new Error(msg, ...args)
-    const error = new BajoError(this, msg, ...args)
-    return error.write()
-  }
-
-  fatal = (msg, ...args) => {
-    if (!this.print) return new Error(msg, ...args)
-    const error = new BajoError(this, msg, ...args)
-    return error.fatal()
-  }
-}
-
-export default Plugin