@ditojs/server 0.270.0 → 0.273.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ditojs/server",
-  "version": "0.270.0",
+  "version": "0.273.0",
   "description": "Dito.js Server – Dito.js is a declarative and modern web framework, based on Objection.js, Koa.js and Vue.js",
   "main": "lib/index.js",
   "repository": "https://github.com/ditojs/dito/tree/master/packages/server",
@@ -25,34 +25,34 @@
     "yarn": ">= 1.0.0"
   },
   "browserslist": [
-    "node 14"
+    "node >= 14"
   ],
   "dependencies": {
-    "@babel/core": "^7.15.5",
-    "@babel/runtime": "^7.15.4",
-    "@ditojs/admin": "^0.270.0",
-    "@ditojs/router": "^0.270.0",
-    "@ditojs/utils": "^0.270.0",
+    "@babel/core": "^7.17.5",
+    "@babel/runtime": "^7.17.2",
+    "@ditojs/admin": "^0.273.0",
+    "@ditojs/router": "^0.273.0",
+    "@ditojs/utils": "^0.273.0",
     "@koa/cors": "^3.1.0",
     "@koa/multer": "^3.0.0",
-    "@vue/cli-service": "^4.5.13",
+    "@vue/cli-service": "^4.5.15",
     "ajv": "^7.2.4",
     "ajv-formats": "^1.6.1",
-    "aws-sdk": "^2.999.0",
-    "axios": "^0.22.0",
+    "aws-sdk": "^2.1085.0",
+    "axios": "^0.26.0",
     "babel-loader": "^8.2.2",
     "bcryptjs": "^2.4.3",
-    "bytes": "^3.1.0",
+    "bytes": "^3.1.2",
     "chalk": "^4.1.2",
-    "core-js": "^3.18.1",
+    "core-js": "^3.21.1",
     "data-uri-to-buffer": "^3.0.1",
-    "eventemitter2": "^6.4.4",
+    "eventemitter2": "^6.4.5",
     "file-type": "^16.5.3",
-    "fs-extra": "^10.0.0",
+    "fs-extra": "^10.0.1",
     "html-webpack-tags-plugin": "^2.0.17",
-    "image-size": "^1.0.0",
-    "is-svg": "^4.3.1",
-    "koa": "^2.13.3",
+    "image-size": "^1.0.1",
+    "is-svg": "^4.3.2",
+    "koa": "^2.13.4",
     "koa-bodyparser": "^4.3.0",
     "koa-compose": "^4.1.0",
     "koa-compress": "^5.1.0",
@@ -66,14 +66,14 @@
     "koa-session": "^6.2.0",
     "koa-static": "^5.0.0",
     "koa-webpack": "^6.0.0",
-    "mime-types": "^2.1.33",
-    "multer": "^1.4.3",
-    "multer-s3": "^2.9.0",
-    "nanoid": "^3.1.28",
-    "parse-duration": "^1.0.0",
+    "mime-types": "^2.1.34",
+    "multer": "^1.4.4",
+    "multer-s3": "^2.10.0",
+    "nanoid": "^3.3.1",
+    "parse-duration": "^1.0.2",
     "passport-local": "^1.0.0",
     "passthrough-counter": "^1.0.0",
-    "pino": "^6.13.3",
+    "pino": "^6.14.0",
     "pino-pretty": "^6.0.0",
     "pluralize": "^8.0.0",
     "repl": "^0.1.3",
@@ -89,16 +89,16 @@
     "objection": "^2.2.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.15.7",
-    "@babel/preset-env": "^7.15.6",
-    "@ditojs/babel-preset": "^0.270.0",
+    "@babel/cli": "^7.17.6",
+    "@babel/preset-env": "^7.16.11",
+    "@ditojs/babel-preset": "^0.273.0",
     "babel-plugin-dynamic-import-node": "^2.3.3",
     "babel-plugin-module-resolver": "^4.1.0",
     "knex": "^0.21.21",
-    "objection": "^2.2.16",
-    "pg": "^8.7.1",
+    "objection": "^2.2.18",
+    "pg": "^8.7.3",
     "rimraf": "^3.0.2",
     "sqlite3": "^5.0.2"
   },
-  "gitHead": "99b1d3c89aa4a4aed19a0741d6a0683654a13196"
+  "gitHead": "ecdd9eee04947c3362c449623b8a685b3e02e0ab"
 }

package/src/app/Application.js

@@ -23,7 +23,13 @@ import { Controller, AdminController } from '@/controllers'
 import { Service } from '@/services'
 import { Storage } from '@/storage'
 import { convertSchema } from '@/schema'
-import { ResponseError, ValidationError, AssetError } from '@/errors'
+import { formatJson } from '@/utils'
+import {
+  ResponseError,
+  ValidationError,
+  DatabaseError,
+  AssetError
+} from '@/errors'
 import SessionStore from './SessionStore'
 import { Validator } from './Validator'
 import {
@@ -472,11 +478,26 @@ export class Application extends Koa {
     }
   }
 
-  createValidationError({ type, message, errors, options }) {
+  createValidationError({ type, message, errors, options, json }) {
     return new ValidationError({
       type,
       message,
-      errors: this.validator.parseErrors(errors, options)
+      errors: this.validator.parseErrors(errors, options),
+      // Only include the JSON data in the error if `log.errors.json`is set.
+      json: this.config.log.errors?.json ? json : undefined
+    })
+  }
+
+  createDatabaseError(error) {
+    // Remove knex SQL query and move to separate `sql` property.
+    // TODO: Fix this properly in Knex / Objection instead, see:
+    // https://gitter.im/Vincit/objection.js?at=5a68728f5a9ebe4f75ca40b0
+    const [, sql, message] = error.message.match(/^([\s\S]*) - ([\s\S]*?)$/) ||
+      [null, null, error.message]
+    return new DatabaseError(error, {
+      message,
+      // Only include the SQL query in the error if `log.errors.sql`is set.
+      sql: this.config.log.errors?.sql ? sql : undefined
     })
   }
 
@@ -485,13 +506,15 @@ export class Application extends Koa {
 
     this.use(attachLogger(this.logger))
 
-    this.use(handleError())
     if (app.responseTime !== false) {
       this.use(responseTime(getOptions(app.responseTime)))
     }
     if (log.requests) {
       this.use(logRequests())
     }
+    // Needs to be positioned after the request logger to log the correct
+    // response status.
+    this.use(handleError())
     if (app.helmet !== false) {
       this.use(helmet(getOptions(app.helmet)))
     }
@@ -655,7 +678,7 @@ export class Application extends Koa {
 
   formatError(err) {
     const message = err.toJSON
-      ? JSON.stringify(err.toJSON(), null, 2)
+      ? formatJson(err.toJSON())
       : err.message || err
     const str = `${err.name}: ${message}`
     return err.stack && this.config.log.errors?.stack !== false

package/src/app/Validator.js

@@ -2,6 +2,7 @@ import objection from 'objection'
 import Ajv from 'ajv'
 import addFormats from 'ajv-formats'
 import { isArray, isObject, clone, isAsync, isPromise } from '@ditojs/utils'
+import { formatJson } from '@/utils'
 import * as schema from '@/schema'
 
 // Dito does not rely on objection.AjvValidator but instead implements its own
@@ -83,7 +84,7 @@ export class Validator extends objection.Validator {
       }
       return opts
     }, {})
-    const cacheKey = JSON.stringify(opts)
+    const cacheKey = formatJson(opts, false)
     const { ajv } = this.ajvCache[cacheKey] || (this.ajvCache[cacheKey] = {
       ajv: this.createAjv(opts),
       options

package/src/cli/db/listAssetConfig.js

@@ -1,8 +1,10 @@
+import { formatJson } from '@/utils'
+
 export async function listAssetConfig(app, ...args) {
   const assetConfig = app.getAssetConfig({
     models: args.length > 0 ? args : Object.keys(app.models),
     normalizeDbNames: true
   })
-  console.info(JSON.stringify(assetConfig, null, 2))
+  console.info(formatJson(assetConfig))
   return true
 }

package/src/controllers/AdminController.js

@@ -6,8 +6,9 @@ import koaWebpack from 'koa-webpack'
 import historyApiFallback from 'koa-connect-history-api-fallback'
 import VueService from '@vue/cli-service'
 import HtmlWebpackTagsPlugin from 'html-webpack-tags-plugin'
-import { ControllerError } from '@/errors'
 import { Controller } from './Controller'
+import { ControllerError } from '@/errors'
+import { formatJson } from '@/utils'
 import { isString, isObject } from '@ditojs/utils'
 
 export class AdminController extends Controller {
@@ -59,7 +60,7 @@ export class AdminController extends Controller {
   sendDitoObject(ctx) {
     // Send back the global dito object as JavaScript code.
     ctx.type = 'text/javascript'
-    ctx.body = `window.dito = ${JSON.stringify(this.getDitoObject())}`
+    ctx.body = `window.dito = ${formatJson(this.getDitoObject())}`
   }
 
   middleware() {

package/src/controllers/ControllerAction.js

@@ -165,8 +165,9 @@ export default class ControllerAction {
     if (errors.length > 0) {
       throw this.createValidationError({
         type: 'ParameterValidation',
-        message: `The provided data is not valid: ${JSON.stringify(getData())}`,
-        errors
+        message: 'The provided action parameters are not valid',
+        errors,
+        json: getData()
       })
     }
   }
@@ -189,8 +190,9 @@ export default class ControllerAction {
       } catch (error) {
         throw this.createValidationError({
           type: 'ResultValidation',
-          message: `Invalid result of action: ${JSON.stringify(getResult())}`,
-          errors: error.errors
+          message: 'The returned action result is not valid',
+          errors: error.errors,
+          json: getResult()
         })
       }
     }
@@ -229,7 +231,7 @@ export default class ControllerAction {
 
   coerceValue(type, value, modelOptions) {
     // See if param needs additional coercion:
-    if (['date', 'datetime', 'timestamp'].includes(type)) {
+    if (value && ['date', 'datetime', 'timestamp'].includes(type)) {
       value = new Date(value)
     } else {
       // See if the defined type(s) require coercion to objects:

package/src/decorators/parameters.js

@@ -1,5 +1,5 @@
 import { isArray, isObject } from '@ditojs/utils'
-import { createDecorator, deprecate } from '@/utils'
+import { createDecorator, deprecate, formatJson } from '@/utils'
 
 export function parameters(parameters, options) {
   if (isObject(parameters)) {
@@ -7,7 +7,7 @@ export function parameters(parameters, options) {
     if (!isObject(first)) {
       deprecate(
         `@parameters(${
-          JSON.stringify(parameters)
+          formatJson(parameters, false)
         }) with parameter schema object is deprecated: Schema object should be passed nested inside an array or object definition.`
       )
       parameters = [...arguments]

package/src/decorators/returns.js

@@ -1,11 +1,11 @@
 import { isObject } from '@ditojs/utils'
-import { createDecorator } from '@/utils'
+import { createDecorator, formatJson } from '@/utils'
 
 export function returns(returns, options) {
   if (!isObject(returns)) {
     throw new Error(
       `@returns(${
-        JSON.stringify(returns)
+        formatJson(returns, false)
       }) needs to be defined using an object parameter definition`
     )
   }

package/src/errors/DatabaseError.js

@@ -8,7 +8,7 @@ import {
 } from 'objection'
 
 export class DatabaseError extends WrappedError {
-  constructor(error) {
+  constructor(error, overrides) {
     const status =
       error instanceof CheckViolationError ? 400
       : error instanceof NotNullViolationError ? 400
@@ -16,28 +16,7 @@ export class DatabaseError extends WrappedError {
       : error instanceof DataError ? 400
       : error instanceof DBError ? 500
       : 400
-    // Remove knex SQL query and move to separate `query` property.
-    // TODO: Fix this properly in Knex / Objection instead, see:
-    // https://gitter.im/Vincit/objection.js?at=5a68728f5a9ebe4f75ca40b0
-    const [, sql, message] = error.message.match(/^([\s\S]*) - ([\s\S]*?)$/) ||
-      [null, null, error.message]
-    const overrides = {
-      type: error.constructor.name,
-      message,
-      sql,
-      status
-    }
+    overrides = { type: error.constructor.name, status, ...overrides }
     super(error, overrides, { message: 'Database error', status })
   }
-
-  toJSON() {
-    // Remove SQL query from displayed data in front-end when not in development
-    // or test.
-    if (process.env.NODE_ENV !== 'development' ||
-    process.env.NODE_ENV !== 'test') {
-      const { sql, ...data } = this.data
-      return data
-    }
-    return this.data
-  }
 }

package/src/errors/ResponseError.js

@@ -21,14 +21,7 @@ export class ResponseError extends Error {
           ? { message: error }
           : error || {}
     const { status, ...data } = { ...defaults, ...object }
-    let { message, code } = data
-    if (process.env.NODE_ENV === 'test' && error === object) {
-      // Include full JSON error in message during tests, for better reporting.
-      const { message: _, ...rest } = data
-      if (Object.keys(rest).length > 0) {
-        message = `${message}\nError Data:\n${JSON.stringify(rest, null, 2)}`
-      }
-    }
+    const { message, code } = data
     super(message)
     this.name = this.constructor.name
     this.status = status

package/src/models/Model.js

@@ -3,9 +3,13 @@ import { QueryBuilder } from '@/query'
 import { EventEmitter, KnexHelper } from '@/lib'
 import { convertSchema, addRelationSchemas, convertRelations } from '@/schema'
 import { populateGraph, filterGraph } from '@/graph'
+import { formatJson } from '@/utils'
 import {
-  ResponseError, DatabaseError, GraphError, ModelError, NotFoundError,
-  RelationError, WrappedError
+  ResponseError,
+  GraphError, ModelError,
+  NotFoundError,
+  RelationError,
+  WrappedError
 } from '@/errors'
 import {
   isString, isObject, isArray, isFunction, isPromise, asArray, merge, flatten,
@@ -222,7 +226,7 @@ export class Model extends objection.Model {
     return super.query(trx).onError(err => {
       // TODO: Shouldn't this wrapping happen on the Controller level?
       err = err instanceof ResponseError ? err
-        : err instanceof objection.DBError ? new DatabaseError(err)
+        : err instanceof objection.DBError ? this.app.createDatabaseError(err)
         : new WrappedError(err)
       return Promise.reject(err)
     })
@@ -279,9 +283,9 @@ export class Model extends objection.Model {
         throw new ModelError(
           this,
           `Invalid amount of id values provided for reference: Unable to map ${
-            JSON.stringify(modelOrId)
+            formatJson(modelOrId, false)
           } to ${
-            JSON.stringify(idProperties)
+            formatJson(idProperties, false)
           }.`
         )
       }
@@ -729,10 +733,11 @@ export class Model extends objection.Model {
     case 'ModelValidation':
       return this.app.createValidationError({
         type,
-        message: message ||
-          `The provided data for the ${this.name} model is not valid: ${JSON.stringify(json)}`,
+        message:
+          message || `The provided data for the ${this.name} model is not valid`,
         errors,
-        options
+        options,
+        json
       })
     case 'RelationExpression':
     case 'UnallowedRelation':

package/src/utils/index.js

@@ -2,5 +2,6 @@ export * from './decorator'
 export * from './deprecate'
 export * from './emitter'
 export * from './function'
+export * from './json'
 export * from './object'
 export * from './scope'

package/src/utils/json.js

@@ -0,0 +1,3 @@
+export function formatJson(json, indented = true) {
+  return JSON.stringify(json, null, indented ? 2 : 0)
+}