@ditojs/server 1.14.2 → 1.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ditojs/server",
-  "version": "1.14.2",
+  "version": "1.15.0",
   "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",
@@ -25,10 +25,10 @@
     "node >= 18"
   ],
   "dependencies": {
-    "@ditojs/admin": "^1.14.1",
+    "@ditojs/admin": "^1.15.0",
     "@ditojs/build": "^1.14.0",
-    "@ditojs/router": "^1.14.0",
-    "@ditojs/utils": "^1.14.0",
+    "@ditojs/router": "^1.15.0",
+    "@ditojs/utils": "^1.15.0",
     "@koa/cors": "^4.0.0",
     "@koa/multer": "^3.0.2",
     "@originjs/vite-plugin-commonjs": "^1.0.3",
@@ -39,7 +39,6 @@
     "data-uri-to-buffer": "^4.0.0",
     "eventemitter2": "^6.4.9",
     "file-type": "^18.0.0",
-    "fs-extra": "^10.1.0",
     "image-size": "^1.0.2",
     "is-svg": "^4.3.2",
     "koa": "^2.13.4",
@@ -79,7 +78,7 @@
     "objection": "^3.0.1"
   },
   "devDependencies": {
-    "@aws-sdk/client-s3": "^3.200.0",
+    "@aws-sdk/client-s3": "^3.223.0",
     "@types/koa-bodyparser": "^4.3.10",
     "@types/koa-compress": "^4.0.3",
     "@types/koa-logger": "^3.1.2",
@@ -88,12 +87,12 @@
     "@types/koa-session": "^5.10.6",
     "@types/koa-static": "^4.0.2",
     "@types/koa__cors": "^3.3.0",
-    "@types/node": "^18.11.9",
+    "@types/node": "^18.11.10",
     "knex": "^2.3.0",
     "objection": "^3.0.1",
-    "type-fest": "^3.2.0",
+    "type-fest": "^3.3.0",
     "typescript": "^4.9.3"
   },
   "types": "types",
-  "gitHead": "3165af9ce8e5c8143fd5940ff9d2ae7c3fa45d8e"
+  "gitHead": "848aed21b94e81ac68f089c4a6bd335b1a97073d"
 }

package/src/app/Application.js

@@ -1,7 +1,7 @@
 import path from 'path'
 import util from 'util'
 import zlib from 'zlib'
-import fs from 'fs-extra'
+import fs from 'fs/promises'
 import Koa from 'koa'
 import Knex from 'knex'
 import pico from 'picocolors'
@@ -289,12 +289,11 @@ export class Application extends Koa {
           data.schema = modelClass.getJsonSchema()
         }
         if (shouldLog(log.relations)) {
-          data.relations = clone(
-            modelClass.getRelationMappings(),
-            value => Model.isPrototypeOf(value)
+          data.relations = clone(modelClass.getRelationMappings(), {
+            processValue: value => Model.isPrototypeOf(value)
               ? `[Model: ${value.name}]`
               : value
-          )
+          })
         }
         if (Object.keys(data).length > 0) {
           console.info(
@@ -594,7 +593,7 @@ export class Application extends Koa {
       prettyPrint: {
         colorize: true,
         // List of keys to ignore in pretty mode.
-        ignore: 'req,res,durationMs,user,requestId,err.message',
+        ignore: 'req,res,durationMs,user,requestId',
         // SYS to use system time and not UTC.
         translateTime: 'SYS:HH:MM:ss.l'
       },
@@ -689,20 +688,32 @@ export class Application extends Koa {
     return this.config.app.normalizePaths ? hyphenate(path) : path
   }
 
-  logError(err, ctx) {
-    if (!err.expose && !this.silent) {
+  formatError(error) {
+    // Shallow-clone the error to be able to delete hidden properties.
+    const copy = clone(error, { shallow: true })
+    // Remove headers added by the CORS middleware.
+    delete copy.headers
+    if (this.config.log.errors?.stack === false) {
+      delete copy.stack
+      delete copy.cause
+    }
+    // Use `util.inspect()` instead of Pino's internal error logging for better
+    // stack traces and logging of error data.
+    return util.inspect(copy, {
+      compact: false,
+      depth: null,
+      maxArrayLength: null
+    })
+  }
+
+  logError(error, ctx) {
+    if (!error.expose && !this.silent) {
       try {
-        const clone = structuredClone(err)
-        // Remove headers added by the CORS middleware.
-        delete clone.headers
-        if (this.config.log.errors?.stack === false) {
-          delete clone.stack
-          delete clone.cause
-        }
-        const level =
-          err instanceof ResponseError && err.status < 500 ? 'info' : 'error'
         const logger = ctx?.logger || this.logger
-        logger[level](clone)
+        const level = error instanceof ResponseError && error.status < 500
+          ? 'info'
+          : 'error'
+        logger[level](this.formatError(error))
       } catch (e) {
         console.error('Could not log error', e)
       }
@@ -895,7 +906,8 @@ export class Application extends Koa {
                   data = await fs.readFile(filepath)
                 } else {
                   const response = await fetch(url)
-                  data = await response.arrayBuffer()
+                  const buffer = await response.arrayBuffer()
+                  data = new DataView(buffer)
                 }
               }
               const importedFile = await storage.addFile(file, data)

package/src/app/Validator.js

@@ -153,27 +153,29 @@ export class Validator extends objection.Validator {
 
   processSchema(jsonSchema, options = {}) {
     const { patch, async } = options
-    const schema = clone(jsonSchema, value => {
-      if (isObject(value)) {
-        if (patch) {
-          // Remove all required keywords and formats from schema for patch
-          // validation.
-          delete value.required
-          if (value.format === 'required') {
-            delete value.format
+    const schema = clone(jsonSchema, {
+      processValue: value => {
+        if (isObject(value)) {
+          if (patch) {
+            // Remove all required keywords and formats from schema for patch
+            // validation.
+            delete value.required
+            if (value.format === 'required') {
+              delete value.format
+            }
           }
-        }
-        // Convert async `validate()` keywords to `validateAsync()`:
-        if (isAsync(value.validate)) {
-          value.validateAsync = value.validate
-          delete value.validate
-        }
-        if (!async) {
-          // Remove all async keywords for synchronous validation.
-          for (const key in value) {
-            const keyword = this.getKeyword(key)
-            if (keyword?.async) {
-              delete value[key]
+          // Convert async `validate()` keywords to `validateAsync()`:
+          if (isAsync(value.validate)) {
+            value.validateAsync = value.validate
+            delete value.validate
+          }
+          if (!async) {
+            // Remove all async keywords for synchronous validation.
+            for (const key in value) {
+              const keyword = this.getKeyword(key)
+              if (keyword?.async) {
+                delete value[key]
+              }
             }
           }
         }

package/src/cli/console.js

@@ -1,6 +1,6 @@
 import repl from 'repl'
 import path from 'path'
-import fs from 'fs-extra'
+import fs from 'fs/promises'
 import pico from 'picocolors'
 import objection from 'objection'
 import { isFunction, deindent } from '@ditojs/utils'

package/src/cli/db/createMigration.js

@@ -1,5 +1,5 @@
 import path from 'path'
-import fs from 'fs-extra'
+import fs from 'fs/promises'
 import pico from 'picocolors'
 import { getRelationClass, isThroughRelationClass } from '@ditojs/server'
 import {
@@ -50,7 +50,7 @@ export async function createMigration(app, name, ...modelNames) {
     : ''
   const filename = `${getTimestamp()}_${name}.js`
   const file = path.join(migrationDir, filename)
-  if (await fs.exists(file)) {
+  if (await exists(file)) {
     // This should never happen, but let's be on the safe side here:
     console.info(pico.red(`Migration '${filename}' already exists.`))
     return false
@@ -204,3 +204,12 @@ function getTimestamp() {
     padDate(d.getMinutes()) +
     padDate(d.getSeconds())
 }
+
+async function exists(path) {
+  try {
+    await fs.access(path)
+    return true
+  } catch {
+    return false
+  }
+}

package/src/cli/db/seed.js

@@ -1,5 +1,5 @@
 import path from 'path'
-import fs from 'fs-extra'
+import fs from 'fs/promises'
 import pico from 'picocolors'
 import util from 'util'
 import pluralize from 'pluralize'

package/src/controllers/Controller.js

@@ -3,7 +3,7 @@ import { EventEmitter } from '../lib/index.js'
 import ControllerAction from './ControllerAction.js'
 import MemberAction from './MemberAction.js'
 import {
-  ResponseError, WrappedError, ControllerError, AuthorizationError
+  ResponseError, ControllerError, AuthorizationError
 } from '../errors/index.js'
 import {
   getOwnProperty, getOwnKeys, getAllKeys, processHandlerParameters,
@@ -185,7 +185,7 @@ export class Controller {
             ctx.body = res
           }
         } catch (err) {
-          throw err instanceof ResponseError ? err : new WrappedError(err)
+          throw err instanceof ResponseError ? err : new ResponseError(err)
         }
       }
     ])

package/src/errors/DatabaseError.js

@@ -1,4 +1,4 @@
-import { WrappedError } from './WrappedError.js'
+import { ResponseError } from './ResponseError.js'
 // TODO: Import directly once we can move to Objection 3 and this is fixed:
 // import {
 //   DBError,
@@ -16,16 +16,21 @@ const {
   ConstraintViolationError
 } = objection
 
-export class DatabaseError extends WrappedError {
+export class DatabaseError extends ResponseError {
   constructor(error, overrides) {
-    const status =
-      error instanceof CheckViolationError ? 400
-      : error instanceof NotNullViolationError ? 400
-      : error instanceof ConstraintViolationError ? 409
-      : error instanceof DataError ? 400
-      : error instanceof DBError ? 500
-      : 400
-    overrides = { type: error.constructor.name, status, ...overrides }
-    super(error, overrides, { message: 'Database error', status })
+    super(error, {
+      type: error.constructor.name,
+      message: 'Database error',
+      status: getStatus(error)
+    }, overrides)
   }
 }
+
+function getStatus(error) {
+  return error instanceof CheckViolationError ? 400
+    : error instanceof NotNullViolationError ? 400
+    : error instanceof ConstraintViolationError ? 409
+    : error instanceof DataError ? 400
+    : error instanceof DBError ? 500
+    : 400
+}

package/src/errors/RelationError.js

@@ -1,18 +1,21 @@
-import { WrappedError } from './WrappedError.js'
-import { isObject } from '@ditojs/utils'
+import { ResponseError } from './ResponseError.js'
 
-export class RelationError extends WrappedError {
+export class RelationError extends ResponseError {
   constructor(error) {
-    let overrides
-    if (isObject(error)) {
-      // Adjust Objection.js error messages to point to the right property.
-      const parse = str => str?.replace(/\brelationMappings\b/g, 'relations')
-      const { message, stack } = error
-      overrides = {
-        message: parse(message),
-        stack: parse(stack)
-      }
-    }
-    super(error, overrides, { message: 'Relation error', status: 400 })
+    super(
+      error,
+      { message: 'Relation error', status: 400 },
+      error instanceof Error ? getFormattedOverrides(error) : null
+    )
+  }
+}
+
+function getFormattedOverrides(error) {
+  // Adjust Objection.js error messages to point to the right property.
+  const format = str => str?.replace(/\brelationMappings\b/g, 'relations')
+  const { message, stack } = error
+  return {
+    message: format(message),
+    stack: format(stack)
   }
 }

package/src/errors/ResponseError.js

@@ -1,33 +1,54 @@
 import { isPlainObject, isString } from '@ditojs/utils'
 
 export class ResponseError extends Error {
-  constructor(error, defaults = { message: 'Response error', status: 400 }) {
+  constructor(
+    error,
+    defaults = { message: 'Response error', status: 500 },
+    overrides
+  ) {
     const object = isPlainObject(error)
       ? error
       : error instanceof Error
-        ? {
-          // Copy error into object so they can be merged with defaults after.
-          // First copy everything that is enumerable, unless the error is from
-          // axios, in which case we don't want to leak config information.
-          ...(error.isAxiosError ? null : error),
-          // Also explicitly copy message, status and code.
-          message: error.message,
-          status: error.status,
-          code: error.code
-        }
+        ? getErrorObject(error)
         : isString(error)
           ? { message: error }
           : error || {}
-    const { status, cause, ...data } = { ...defaults, ...object }
-    const { message, code } = data
-    super(message, { cause })
-    this.name = this.constructor.name
+    const { message, status, stack, cause, ...data } = {
+      ...defaults,
+      ...object,
+      ...overrides
+    }
+    super(message, cause ? { cause } : {})
     this.status = status
-    this.code = code
     this.data = data
+    // Allow `stack` overrides, e.g. for `RelationError`.
+    if (stack != null) {
+      this.stack = stack
+    }
   }
 
   toJSON() {
-    return this.data
+    return {
+      // Include the message in the JSON data sent back.
+      message: this.message,
+      ...this.data
+    }
   }
 }
+
+function getErrorObject(error) {
+  const object = {
+    // For generic errors, explicitly copy message.
+    message: error.message,
+    ...error.toJSON?.()
+  }
+  // Additionally copy status and code if present.
+  if (error.status != null) {
+    object.status = error.status
+  }
+  if (error.code != null) {
+    object.code = error.code
+  }
+  object.cause = error
+  return object
+}

package/src/errors/index.js

@@ -11,4 +11,3 @@ export * from './NotImplementedError.js'
 export * from './QueryBuilderError.js'
 export * from './RelationError.js'
 export * from './ValidationError.js'
-export * from './WrappedError.js'

package/src/models/Model.js

@@ -16,8 +16,7 @@ import {
   ResponseError,
   GraphError, ModelError,
   NotFoundError,
-  RelationError,
-  WrappedError
+  RelationError
 } from '../errors/index.js'
 import RelationAccessor from './RelationAccessor.js'
 import definitions from './definitions/index.js'
@@ -181,7 +180,7 @@ export class Model extends objection.Model {
     const shallow = json.$isObjectionModel && !options.graph
     if (shallow) {
       // Strip away relations and other internal stuff.
-      json = json.clone({ shallow: true })
+      json = json.$clone({ shallow: true })
       // We can mutate `json` now that we took a copy of it.
       options = { ...options, mutable: true }
     }
@@ -239,7 +238,7 @@ export class Model extends objection.Model {
       // TODO: Shouldn't this wrapping happen on the Controller level?
       err = err instanceof ResponseError ? err
         : err instanceof objection.DBError ? this.app.createDatabaseError(err)
-        : new WrappedError(err)
+        : new ResponseError(err)
       return Promise.reject(err)
     })
   }

package/src/storage/DiskStorage.js

@@ -1,4 +1,4 @@
-import fs from 'fs-extra'
+import fs from 'fs/promises'
 import path from 'path'
 import multer from '@koa/multer'
 import { Storage } from './Storage.js'
@@ -15,7 +15,7 @@ export class DiskStorage extends Storage {
         // Add `storageFile.key` property to internal storage file object.
         storageFile.key = this.getUniqueKey(storageFile.originalname)
         const dir = this._getPath(this._getNestedFolder(storageFile.key))
-        fs.ensureDir(dir)
+        fs.mkdir(dir, { recursive: true })
           .then(() => cb(null, dir))
           .catch(cb)
       },
@@ -41,7 +41,7 @@ export class DiskStorage extends Storage {
   async _addFile(file, buffer) {
     const filePath = this._getFilePath(file)
     const dir = path.dirname(filePath)
-    await fs.ensureDir(dir)
+    await fs.mkdir(dir, { recursive: true })
     await fs.writeFile(filePath, buffer)
     return file
   }

package/types/index.d.ts

@@ -1617,8 +1617,7 @@ export class ResponseError extends Error {
 export class AssetError extends ResponseError {}
 export class AuthenticationError extends ResponseError {}
 export class AuthorizationError extends ResponseError {}
-export class WrappedError extends ResponseError {}
-export class DatabaseError extends WrappedError {
+export class DatabaseError extends ResponseError {
   constructor(
     error:
       | dbErrors.CheckViolationError

package/src/errors/WrappedError.js

@@ -1,18 +0,0 @@
-import { ResponseError } from './ResponseError.js'
-
-export class WrappedError extends ResponseError {
-  constructor(error, overrides, defaults = {
-    message: 'Wrapped error',
-    status: 400
-  }) {
-    super(
-      overrides
-        ? Object.setPrototypeOf({ ...overrides }, error)
-        : error,
-      defaults
-    )
-    if (error?.stack) {
-      this.stack = error.stack
-    }
-  }
-}