@ditojs/server 1.5.0 → 1.5.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ditojs/server",
-  "version": "1.5.0",
+  "version": "1.5.3",
   "type": "module",
   "description": "Dito.js Server – Dito.js is a declarative and modern web framework, based on Objection.js, Koa.js and Vue.js",
   "repository": "https://github.com/ditojs/dito/tree/master/packages/server",
@@ -30,7 +30,7 @@
     "@originjs/vite-plugin-commonjs": "^1.0.3",
     "ajv": "^8.11.0",
     "ajv-formats": "^2.1.1",
-    "aws-sdk": "^2.1106.0",
+    "aws-sdk": "^2.1108.0",
     "axios": "^0.26.1",
     "bcryptjs": "^2.4.3",
     "bytes": "^3.1.2",
@@ -60,6 +60,7 @@
     "passport-local": "^1.0.0",
     "passthrough-counter": "^1.0.0",
     "picocolors": "^1.0.0",
+    "picomatch": "^2.3.1",
     "pino": "^7.9.2",
     "pino-pretty": "^7.6.0",
     "pluralize": "^8.0.0",
@@ -75,10 +76,10 @@
     "objection": "^3.0.1"
   },
   "devDependencies": {
-    "knex": "^1.0.4",
+    "knex": "^1.0.5",
     "objection": "^3.0.1",
     "pg": "^8.7.3",
     "sqlite3": "^5.0.2"
   },
-  "gitHead": "36a57512228cc233211bf6e4038123a9e775f5c5"
+  "gitHead": "ec436ef535d96b1653914df6194cc865dfe16ead"
 }

package/src/app/Application.js

@@ -22,8 +22,8 @@ import helmet from 'koa-helmet'
 import responseTime from 'koa-response-time'
 import Router from '@ditojs/router'
 import {
-  isArray, isObject, isString, asArray, isPlainObject, hyphenate, clone, merge,
-  parseDataPath, normalizeDataPath, isModule
+  isArray, isObject, isString, asArray, isPlainObject, isModule,
+  hyphenate, clone, merge, parseDataPath, normalizeDataPath, toPromiseCallback
 } from '@ditojs/utils'
 import SessionStore from './SessionStore.js'
 import { Validator } from './Validator.js'
@@ -42,6 +42,7 @@ import {
 import {
   attachLogger,
   createTransaction,
+  ensureRunning,
   findRoute,
   handleError,
   handleRoute,
@@ -88,6 +89,9 @@ export class Application extends Koa {
     this.models = Object.create(null)
     this.services = Object.create(null)
     this.controllers = Object.create(null)
+    this.server = null
+    this.isRunning = false
+
     this.setupLogger()
     this.setupKnex()
     this.setupMiddleware(middleware)
@@ -283,10 +287,6 @@ export class Application extends Koa {
     return Object.values(this.services).find(callback)
   }
 
-  forEachService(callback) {
-    return Promise.all(Object.values(this.services).map(callback))
-  }
-
   addControllers(controllers, namespace) {
     for (const [key, value] of Object.entries(controllers)) {
       if (isModule(value) || isPlainObject(value)) {
@@ -508,6 +508,7 @@ export class Application extends Koa {
 
     // Setup global middleware
 
+    this.use(ensureRunning(this))
     this.use(attachLogger(this.logger))
     if (app.responseTime !== false) {
       this.use(responseTime(getOptions(app.responseTime)))
@@ -718,46 +719,56 @@ export class Application extends Koa {
       this.on('error', this.logError)
     }
     await this.emit('before:start')
-    await this.forEachService(service => service.start())
-    const { server: { host, port } } = this.config
-    this.server = await new Promise((resolve, reject) => {
-      const server = this.listen(port, host, () => {
-        const { port } = server.address()
+    this.server = await new Promise(resolve => {
+      const server = this.listen(this.config.server, () => {
+        const { address, port } = server.address()
         console.info(
-          `Dito server started at http://${host}:${port}`
+          `Dito.js server started at http://${address}:${port}`
         )
         resolve(server)
       })
-      if (!server) {
-        reject(new Error(`Unable to start server at http://${host}:${port}`))
-      }
     })
+    if (!this.server) {
+      throw new Error('Unable to start Dito.js server')
+    }
+    this.isRunning = true
     await this.emit('after:start')
   }
 
-  async stop() {
-    await this.emit('before:stop')
-    this.server = await new Promise((resolve, reject) => {
-      const { server } = this
-      if (server) {
-        server.close(err => {
-          if (err) {
-            reject(err)
-          } else {
-            resolve(null)
-          }
-        })
-        // Hack to make sure that we close the server,
-        //  even if sockets are still open.
-        //  Taken from https://stackoverflow.com/a/36830072.
-        //  A proper solution would be to use a library, ex: https://github.com/godaddy/terminus
-        setImmediate(() => server.emit('close'))
-      } else {
-        reject(new Error('Server is not running'))
-      }
-    })
-    await this.forEachService(service => service.stop())
-    await this.emit('after:stop')
+  async stop(timeout = 0) {
+    if (!this.server) {
+      throw new Error('Dito.js server is not running')
+    }
+
+    const promise = (async () => {
+      await this.emit('before:stop')
+      this.isRunning = false
+      await new Promise((resolve, reject) => {
+        this.server.close(toPromiseCallback(resolve, reject))
+      })
+      // Hack to make sure that the server is closed, even if sockets are still
+      // open after `server.close()`, see: https://stackoverflow.com/a/36830072
+      this.server.emit('close')
+      this.server = null
+      await this.emit('after:stop')
+    })()
+
+    if (timeout > 0) {
+      await Promise.race([
+        promise,
+        new Promise((resolve, reject) =>
+          setTimeout(reject,
+            timeout,
+            new Error(
+              `Timeout reached while stopping Dito.js server (${timeout}ms)`
+            )
+          )
+        )
+      ])
+    } else {
+      await promise
+    }
+
     if (this.config.log.errors !== false) {
       this.off('error', this.logError)
     }

package/src/controllers/AdminController.js

@@ -1,4 +1,5 @@
 import path from 'path'
+import { exit } from 'process'
 import Koa from 'koa'
 import serve from 'koa-static'
 import { defineConfig, createServer } from 'vite'
@@ -90,6 +91,7 @@ export class AdminController extends Controller {
     }
   }
 
+  // @override
   compose() {
     this.koa = new Koa()
     this.koa.use(this.middleware())
@@ -128,6 +130,32 @@ export class AdminController extends Controller {
         }
       }
     })
+
+    let closed = false
+
+    // Monkey-patch `process.exit()` to filter out the calls caused by vite's
+    // handling of SIGTERM, see: https://github.com/vitejs/vite/issues/7627
+    process.exit = code => {
+      // Filter out calls from inside vite by looking at the stack trace.
+      if (new Error().stack.includes('/vite/dist/')) {
+        // vite's own `exitProcess()` just called `process.exit(), and this
+        // means it has already called `server.close()` internally.
+        closed = true
+        process.exit = exit
+      } else {
+        exit(code)
+      }
+    }
+
+    this.app.once('before:stop', () => {
+      // For good timing it seems crucial to not add more ticks with async
+      // signature, so we directly return the `server.close()` promise instead.
+      if (!closed) {
+        closed = true
+        return server.close()
+      }
+    })
+
     this.koa.use(handleConnectMiddleware(server.middlewares, {
       expandMountPath: true
     }))

package/src/controllers/Controller.js

@@ -26,6 +26,12 @@ export class Controller {
   initialize() {
   }
 
+  // @return {Application|Function} [app or function]
+  compose() {
+    // To be overridden in sub-classes, if the controller needs to install
+    // middleware. For normal routes, use `this.app.addRoute()` instead.
+  }
+
   setup(isRoot = true, setupActionsObject = true) {
     this._setupEmitter(this.hooks, {
       // Support wildcard hooks only on controllers:
@@ -246,12 +252,6 @@ export class Controller {
     ])
   }
 
-  // @return {Application|Function} [app or function]
-  compose() {
-    // To be overridden in sub-classes, if the controller needs to install
-    // middleware. For normal routes, use `this.app.addRoute()` instead.
-  }
-
   getPath(type, path) {
     // To be overridden by sub-classes.
     return path

package/src/middleware/ensureRunning.js

@@ -0,0 +1,13 @@
+export function ensureRunning(app) {
+  return async (ctx, next) => {
+    if (app.isRunning) {
+      await next()
+    } else {
+      // When the app isn't running, e.g. while stopping, we don't want to send
+      // content back anymore even if the controllers would still respond. This
+      // is to avoid strange behavior during shut-down of the vite dev server.
+      // For that scenario, sending back an empty 205 response seems to work.
+      ctx.status = 205 // HTTP_RESET_CONTENT
+    }
+  }
+}

package/src/middleware/index.js

@@ -1,5 +1,6 @@
 export * from './attachLogger.js'
 export * from './createTransaction.js'
+export * from './ensureRunning.js'
 export * from './findRoute.js'
 export * from './handleConnectMiddleware.js'
 export * from './handleError.js'

package/src/services/Service.js

@@ -11,6 +11,8 @@ export class Service {
 
   setup(config) {
     this.config = config
+    this.app.on('before:start', () => this.start())
+    this.app.on('after:stop', () => this.stop())
   }
 
   // @overridable

package/src/storage/Storage.js

@@ -1,11 +1,11 @@
 import path from 'path'
+import { URL } from 'url'
 import multer from '@koa/multer'
+import picomatch from 'picomatch'
 import imageSize from 'image-size'
 import { PassThrough } from 'stream'
-import { URL } from 'url'
 import { hyphenate, toPromiseCallback } from '@ditojs/utils'
 import { AssetFile } from './AssetFile.js'
-import { matchGlobPattern } from '../utils/glob.js'
 
 const storageClasses = {}
 
@@ -59,11 +59,7 @@ export class Storage {
   }
 
   isImportSourceAllowed(url) {
-    const { allowedImports = [] } = this.config
-    for (const pattern of allowedImports) {
-      if (matchGlobPattern(url, pattern)) return true
-    }
-    return false
+    return picomatch.isMatch(url, this.config.allowedImports || [])
   }
 
   convertAssetFile(file) {

package/src/utils/glob.js

@@ -1,9 +0,0 @@
-import { escapeRegexp } from '@ditojs/utils'
-
-export function matchGlobPattern(str, pattern) {
-  const exp = escapeRegexp(pattern).replace(
-    /\\([*?])/,
-    (_, chr) => chr === '*' ? '.*' : chr
-  )
-  return new RegExp(`^${exp}$`).test(str)
-}