npm - waibu - Versions diffs - 2.2.0 → 2.3.1 - Mend

waibu 2.2.0 → 2.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (23) hide show

package/extend/bajo/hook/waibu@pre-parsing.js +10 -0
package/extend/bajoTemplate/template/400.html +8 -0
package/extend/bajoTemplate/template/500.html +8 -0
package/index.js +30 -20
package/lib/{app-hook.js → handle-app-hook.js} +2 -2
package/lib/handle-error.js +25 -0
package/lib/handle-favicon.js +2 -2
package/lib/handle-forward.js +3 -4
package/lib/{home.js → handle-home.js} +2 -2
package/lib/handle-not-found.js +33 -0
package/lib/handle-redirect.js +9 -5
package/lib/handle-xml-body.js +2 -2
package/lib/{app.js → web-app.js} +8 -7
package/lib/webapp-scope/attach-intl.js +4 -0
package/lib/webapp-scope/handle-compress.js +2 -2
package/lib/webapp-scope/handle-cors.js +2 -2
package/lib/webapp-scope/handle-helmet.js +2 -2
package/lib/webapp-scope/handle-multipart-body.js +3 -3
package/lib/webapp-scope/handle-rate-limit.js +2 -2
package/lib/webapp-scope/route-hook.js +2 -2
package/package.json +1 -1
package/wiki/CHANGES.md +7 -0
package/lib/webapp-scope/error-handler.js +0 -20

package/extend/bajo/hook/waibu@pre-parsing.js ADDED Viewed

@@ -0,0 +1,10 @@
+const waibuPreParsing = {
+  level: 9,
+  handler: async function (req, reply) {
+    const { importModule } = this.app.bajo
+    const attachIntl = await importModule('waibu:/lib/webapp-scope/attach-intl.js')
+    await attachIntl.call(this, this.config.intl.detectors, req, reply)
+  }
+}
+export default waibuPreParsing

package/extend/bajoTemplate/template/400.html ADDED Viewed

@@ -0,0 +1,8 @@
+<html>
+  <head>
+  </head>
+  <body>
+    <%= text %>
+  </body>
+</html>

package/extend/bajoTemplate/template/500.html ADDED Viewed

@@ -0,0 +1,8 @@
+<html>
+  <head>
+  </head>
+  <body>
+    <%= text %>
+  </body>
+</html>

package/index.js CHANGED Viewed

@@ -1,14 +1,17 @@
 import collectRoutePathHandlers from './lib/collect-route-path-handlers.js'
 import fastify from 'fastify'
-import appHook from './lib/app-hook.js'
+import handleAppHook from './lib/handle-app-hook.js'
 import routeHook from './lib/webapp-scope/route-hook.js'
 import printRoutes from './lib/print-routes.js'
-import { boot } from './lib/app.js'
+import webApp from './lib/web-app.js'
 import sensible from '@fastify/sensible'
 import underPressure from '@fastify/under-pressure'
 import handleForward from './lib/handle-forward.js'
 import handleRedirect from './lib/handle-redirect.js'
 import handleFavicon from './lib/handle-favicon.js'
+import handleError from './lib/handle-error.js'
+import handleNotFound from './lib/handle-not-found.js'
+import handleHome from './lib/handle-home.js'
 import buildLocals from './lib/build-locals.js'
 import queryString from 'query-string'
@@ -82,7 +85,12 @@ async function factory (pkgName) {
         factory: {
           trustProxy: true,
           bodyLimit: 10485760,
-          pluginTimeout: 30000
+          pluginTimeout: 30000,
+          routerOptions: {
+          }
+        },
+        intl: {
+          detectors: ['qs']
         },
         deferLog: false,
         prefixVirtual: '~',
@@ -175,25 +183,27 @@ async function factory (pkgName) {
       cfg.factory.disableRequestLogging = true
       cfg.factory.querystringParser = str => this.qs.parse(str)
-      const instance = fastify(cfg.factory)
-      instance.decorateRequest('lang', null)
-      instance.decorateRequest('t', () => {})
-      instance.decorateRequest('format', () => {})
-      instance.decorateRequest('langDetector', null)
-      instance.decorateRequest('site', null)
-      instance.decorateRequest('ns', null)
-      this.instance = instance
+      this.instance = fastify(cfg.factory)
+      this.instance.decorateRequest('lang', null)
+      this.instance.decorateRequest('t', () => {})
+      this.instance.decorateRequest('format', () => {})
+      this.instance.decorateRequest('langDetector', null)
+      this.instance.decorateRequest('site', null)
+      this.instance.decorateRequest('ns', null)
       this.routes = this.routes || []
-      await runHook('waibu:afterCreateContext', instance)
-      await instance.register(sensible)
-      if (cfg.underPressure) await instance.register(underPressure)
-      await handleFavicon.call(this, instance)
-      await handleRedirect.call(this, instance)
-      await handleForward.call(this, instance)
-      await appHook.call(this)
+      await runHook('waibu:afterCreateContext', this.instance)
+      await this.instance.register(sensible)
+      if (cfg.underPressure) await this.instance.register(underPressure)
+      await handleFavicon.call(this)
+      await handleRedirect.call(this)
+      await handleForward.call(this)
+      await handleAppHook.call(this)
+      await handleError.call(this)
       await routeHook.call(this, this.ns)
-      await boot.call(this)
-      await instance.listen(cfg.server)
+      await webApp.call(this)
+      await handleHome.call(this)
+      await handleNotFound.call(this)
+      await this.instance.listen(cfg.server)
       if (cfg.printRoutes) printRoutes.call(this)
     }

package/lib/{app-hook.js → handle-app-hook.js} RENAMED Viewed

@@ -1,4 +1,4 @@
-async function appHook () {
+async function handleAppHook () {
   const { runHook } = this.app.bajo
   const hooks = ['onReady', 'onClose', 'preClose', 'onRoute', 'onRegister']
   const me = this
@@ -11,4 +11,4 @@ async function appHook () {
   }
 }
-export default appHook
+export default handleAppHook

package/lib/handle-error.js ADDED Viewed

@@ -0,0 +1,25 @@
+import { redirect } from './handle-redirect.js'
+import { notFound, writeHtml } from './handle-not-found.js'
+async function error (req, reply, err = {}) {
+  const { get } = this.app.lib._
+  const webApp = get(req, 'routeOptions.config.webApp')
+  this.log.error(err)
+  if (webApp) {
+    const plugin = this.app[webApp]
+    const errorHandler = get(plugin, 'waibuFactory.errorHandler')
+    if (errorHandler) return await errorHandler.call(plugin, err, req, reply)
+  }
+  return writeHtml.call(this, req, reply, `${this.ns}:/extend/bajoTemplate/template/500.html`, { text: this.app.log.getErrorMessage(err) })
+}
+async function handleError () {
+  const me = this
+  this.instance.setErrorHandler(async function (err, req, reply) {
+    if (err.message === '_notFound' || err.statusCode === 404) return await notFound.call(me, req, reply, err)
+    if (err.message === '_redirect' && err.redirect) return redirect.call(me, reply, err.redirect, err.options)
+    return await error.call(me, req, reply, err)
+  })
+}
+export default handleError

package/lib/handle-favicon.js CHANGED Viewed

@@ -1,7 +1,7 @@
 import path from 'path'
 import handleDownload from './handle-download.js'
-async function handleFavicon (ctx) {
+async function handleFavicon () {
   const { getPluginFile } = this.app.bajo
   let file
   let ext = '.ico'
@@ -10,7 +10,7 @@ async function handleFavicon (ctx) {
     ext = path.extname(file)
   }
   const me = this
-  ctx.get(`/favicon${ext}`, async function (req, reply) {
+  this.instance.get(`/favicon${ext}`, async function (req, reply) {
     if (!file) return reply.code(404).send()
     reply.header('cache-control', 'max-age=86400')
     return await handleDownload.call(me, file, req, reply)

package/lib/handle-forward.js CHANGED Viewed

@@ -1,6 +1,6 @@
 import replyFrom from '@fastify/reply-from'
-async function handleForward (ctx) {
+async function handleForward () {
   const { defaultsDeep } = this.app.lib.aneka
   const me = this
@@ -13,9 +13,8 @@ async function handleForward (ctx) {
   const base = `http://${this.config.server.host}:${this.config.server.port}`
   const options = defaultsDeep({ base }, this.config.forwardOpts)
-  await ctx.register(replyFrom, options)
-  ctx.decorateReply('forwardTo', function (url, options = {}) {
+  this.instance.register(replyFrom, options)
+  this.instance.decorateReply('forwardTo', function (url, options = {}) {
     if (url.startsWith('http')) return this.redirectTo(url)
     this.from(me.routePath(url, options), {
       rewriteHeaders

package/lib/{home.js → handle-home.js} RENAMED Viewed

@@ -1,4 +1,4 @@
-async function home () {
+async function handleHome () {
   const { callHandler } = this.app.bajo
   const { defaultsDeep } = this.app.lib.aneka
   const { isString, pick } = this.app.lib._
@@ -14,4 +14,4 @@ async function home () {
   }
 }
-export default home
+export default handleHome

package/lib/handle-not-found.js ADDED Viewed

@@ -0,0 +1,33 @@
+export function writeHtml (req, reply, tpl, payload) {
+  const { getPluginFile } = this.app.bajo
+  const { fs } = this.app.lib
+  const { template } = this.app.lib._
+  reply.header('Content-Type', 'text/html')
+  reply.header('Content-Language', req.lang)
+  const file = getPluginFile(tpl)
+  const content = fs.readFileSync(file)
+  const compiled = template(content)
+  return compiled(payload)
+}
+export async function notFound (req, reply, err = {}) {
+  const { get } = this.app.lib._
+  const webApp = get(req, 'routeOptions.config.webApp')
+  reply.code(404)
+  if (webApp) {
+    const plugin = this.app[webApp]
+    const errorHandler = get(plugin, 'waibuFactory.errorHandler')
+    if (errorHandler) return await errorHandler.call(plugin, req, reply)
+  }
+  const text = req.t('notFound%s%s', req.t('route'), req.url)
+  return writeHtml.call(this, req, reply, `${this.ns}:/extend/bajoTemplate/template/400.html`, { text })
+}
+async function handleNotFound () {
+  const me = this
+  me.instance.setNotFoundHandler(async function (req, reply) {
+    return await notFound.call(me, req, reply)
+  })
+}
+export default handleNotFound

package/lib/handle-redirect.js CHANGED Viewed

@@ -1,11 +1,15 @@
 import path from 'path'
-async function handleRedirect (ctx, options) {
+export function redirect (reply, url, options = {}) {
+  if (url.startsWith('http') || path.isAbsolute(url)) reply.redirect(url)
+  else reply.redirect(this.routePath(url, options))
+  return reply
+}
+async function handleRedirect (options) {
   const me = this
-  ctx.decorateReply('redirectTo', function (url, options = {}) {
-    if (url.startsWith('http') || path.isAbsolute(url)) this.redirect(url)
-    else this.redirect(me.routePath(url, options))
-    return this
+  this.instance.decorateReply('redirectTo', function (url, options = {}) {
+    return redirect.call(me, this, url, options)
   })
 }

package/lib/handle-xml-body.js CHANGED Viewed

@@ -1,6 +1,6 @@
 // based on: https://github.com/NaturalIntelligence/fastify-xml-body-parser/blob/master/index.js
-async function xmlBodyParser (ctx, opts = {}) {
+async function xmlBodyParser (opts = {}) {
   if (!this.app.bajoExtra) {
     this.log.warn('cantParseXmlBodyWithout%s', 'bajo-extra')
     return
@@ -48,7 +48,7 @@ async function xmlBodyParser (ctx, opts = {}) {
     }
   }
-  ctx.addContentTypeParser(opts.contentTypes, contentParser)
+  this.instance.addContentTypeParser(opts.contentTypes, contentParser)
 }
 export default xmlBodyParser

package/lib/{app.js → web-app.js} RENAMED Viewed

@@ -1,5 +1,3 @@
-import home from './home.js'
 export async function collect (glob = 'boot.js', baseNs) {
   const { eachPlugins, importModule } = this.app.bajo
   const { orderBy, get } = this.app.lib._
@@ -24,26 +22,29 @@ export async function collect (glob = 'boot.js', baseNs) {
   return orderBy(mods, ['level'])
 }
-export async function boot () {
+async function webApp () {
   const { runHook } = this.app.bajo
   const mods = await collect.call(this)
   await runHook(`${this.ns}:beforeAppBoot`)
+  // build routes
   for (const m of mods) {
     const disabled = this.app[m.ns].config.disabled
     if (Array.isArray(disabled) && disabled.length === 1 && ['*', 'all'].includes(disabled[0])) {
       this.log.warn('allRoutesConfigDisabled%s', m.ns)
       continue
     }
+    const plugin = this.app[m.ns]
     await runHook(`${this.ns}.${m.ns}:beforeAppBoot`)
     this.log.debug('bootApp%s', m.ns)
     await this.instance.register(async (ctx) => {
-      const plugin = this.app[m.ns]
-      plugin.instance = ctx
+      plugin.webAppCtx = ctx
+      plugin.webAppFactory = m
       await runHook(`${plugin.ns}:afterCreateContext`, ctx)
-      await m.handler.call(plugin, ctx, m.prefix)
+      await m.handler.call(plugin, m.prefix)
     }, { prefix: m.prefix })
     await runHook(`${this.ns}.${m.ns}:afterAppBoot`)
   }
   await runHook(`${this.ns}:afterAppBoot`)
-  await home.call(this)
 }
+export default webApp

package/lib/webapp-scope/attach-intl.js CHANGED Viewed

@@ -59,6 +59,10 @@ async function attachIntl (detector = [], req, reply) {
   }
   req.format = (value, type = 'auto', opts = {}) => {
     opts.lang = opts.lang ?? req.lang
+    const timeZone = get(req, 'site.setting.sumba.timeZone', this.app.bajo.config.intl.format.datetime.timeZone)
+    opts.datetime = opts.datetime ?? { timeZone }
+    opts.date = opts.date ?? { timeZone }
+    opts.time = opts.time ?? { timeZone }
     return this.app.bajo.format(value, type, opts)
   }
 }

package/lib/webapp-scope/handle-compress.js CHANGED Viewed

@@ -1,10 +1,10 @@
 import compress from '@fastify/compress'
-async function handleCompress (ctx, options = {}) {
+async function handleCompress (options = {}) {
   const { defaultsDeep } = this.app.lib.aneka
   if (options === false) return this.log.warn('middlewareDisabled%s', 'compress')
   const opts = defaultsDeep(options, this.app.waibu.config.compress)
-  await ctx.register(compress, opts)
+  await this.webAppCtx.register(compress, opts)
 }
 export default handleCompress

package/lib/webapp-scope/handle-cors.js CHANGED Viewed

@@ -1,10 +1,10 @@
 import cors from '@fastify/cors'
-async function handleCors (ctx, options = {}) {
+async function handleCors (options = {}) {
   const { defaultsDeep } = this.app.lib.aneka
   if (options === false) return this.log.warn('middlewareDisabled%s', 'cors')
   const opts = defaultsDeep(options, this.app.waibu.config.cors)
-  await ctx.register(cors, opts)
+  await this.webAppCtx.register(cors, opts)
 }
 export default handleCors

package/lib/webapp-scope/handle-helmet.js CHANGED Viewed

@@ -1,10 +1,10 @@
 import helmet from '@fastify/helmet'
-async function handleHelmet (ctx, options = {}) {
+async function handleHelmet (options = {}) {
   const { defaultsDeep } = this.app.lib.aneka
   if (options === false) return this.log.warn('middlewareDisabled%s', 'helmet')
   const opts = defaultsDeep(options, this.app.waibu.config.helmet)
-  await ctx.register(helmet, opts)
+  await this.webAppCtx.register(helmet, opts)
 }
 export default handleHelmet

package/lib/webapp-scope/handle-multipart-body.js CHANGED Viewed

@@ -16,7 +16,7 @@ async function onFileHandler () {
   }
 }
-async function handleMultipartBody (ctx, options = {}) {
+async function handleMultipartBody (options = {}) {
   const { importPkg } = this.app.bajo
   const { defaultsDeep, isSet } = this.app.lib.aneka
   const { isArray, map, trim, isPlainObject, isEmpty } = this.app.lib._
@@ -25,7 +25,7 @@ async function handleMultipartBody (ctx, options = {}) {
   const opts = defaultsDeep(options, this.app.waibu.config.multipart)
   const onFile = await onFileHandler.call(this)
   opts.onFile = onFile
-  await ctx.register(multipart, opts)
+  await this.webAppCtx.register(multipart, opts)
   function normalizeValue (value) {
     if (!isSet(value)) return
@@ -45,7 +45,7 @@ async function handleMultipartBody (ctx, options = {}) {
     return value
   }
-  ctx.addHook('preValidation', async function (req, reply) {
+  this.webAppCtx.addHook('preValidation', async function (req, reply) {
     if (req.isMultipart() && opts.attachFieldsToBody === true) {
       const body = Object.fromEntries(
         Object.keys(req.body || {}).map((key) => {

package/lib/webapp-scope/handle-rate-limit.js CHANGED Viewed

@@ -1,11 +1,11 @@
 import rateLimit from '@fastify/rate-limit'
-async function handleRateLimit (ctx, options = {}) {
+async function handleRateLimit (options = {}) {
   const { cloneDeep } = this.app.lib._
   const { defaultsDeep } = this.app.lib.aneka
   if (options === false) return this.log.warn('middlewareDisabled%s', 'rateLimit')
   const opts = defaultsDeep(options, this.app.waibu.config.rateLimit)
-  await ctx.register(rateLimit, cloneDeep(opts))
+  await this.webAppCtx.register(rateLimit, cloneDeep(opts))
 }
 export default handleRateLimit

package/lib/webapp-scope/route-hook.js CHANGED Viewed

@@ -1,9 +1,9 @@
 async function routeHook (ns) {
-  const ctx = this.app[ns].instance
+  const webAppCtx = ns === 'waibu' ? this.app.waibu.instance : this.app[ns].webAppCtx
   const { runHook } = this.app.bajo
   const { hookTypes } = this.app.baseClass.Waibu
   for (const hook of hookTypes) {
-    ctx.addHook(hook, async function (...args) {
+    webAppCtx.addHook(hook, async function (...args) {
       args.push(this)
       await runHook(`${ns}:${hook}`, ...args)
     })

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "waibu",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "description": "Web Framework for Bajo",
   "main": "index.js",
   "scripts": {

package/wiki/CHANGES.md CHANGED Viewed

@@ -1,5 +1,12 @@
 # Changes
+## 2026-02-08
+- [2.3.0] Simplify all common handler calls
+- [2.3.0] All ```webApp``` now have it's assigned fastify context ```plugin.webAppCtx```
+- [2.3.0] Simplify & unite error handler & not found handler
+- [2.3.0] Add ```options.timeZone``` in ```req.format()```
 ## 2026-02-01
 - [2.2.0] Change query string token ```match``` to ```search``` for fulltext search

package/lib/webapp-scope/error-handler.js DELETED Viewed

@@ -1,20 +0,0 @@
-async function errorHandler (ctx, extHandler) {
-  const me = this
-  ctx.setErrorHandler(async function (err, req, reply) {
-    if (err.redirect) return reply.redirect(err.redirect)
-    if (err.print) {
-      reply.send(err.print)
-      return
-    }
-    if (me.app.bajo.config.env !== 'prod' &&
-      !['_notfound', '_redirect'].includes(err.message.toLowerCase())) console.error(err)
-    if (extHandler) return await extHandler.call(me, err, req, reply, ctx)
-    if (err.message === '_notFound' || err.statusCode === 404) {
-      reply.code(err.statusCode)
-      return
-    }
-    reply.code(err.statusCode ?? 500)
-  })
-}
-export default errorHandler