Fixes columnNameMappers applied to json column when using FieldExpres…

…sions (Vincit#1089)

.gitignore

@@ -12,4 +12,5 @@ profiling
 npm-debug.log*
 .vscode
 /**/yarn.lock
-/**/.vuepress/dist
+/**/.vuepress/dist
+docker-compose.override.yml

doc/release-notes/changelog.md

@@ -29,7 +29,7 @@
 
 ### What's new
 
-- Only add AJV formats if they weren't added in user-land already [#2482](https://github.com/Vincit/objection.js/pull/2482)
+- Only add Ajv formats if they weren't added in user-land already [#2482](https://github.com/Vincit/objection.js/pull/2482)
 
 ## 3.1.0
 

lib/model/AjvValidator.js

@@ -36,8 +36,10 @@ class AjvValidator extends Validator {
     self.cache = new Map();
 
     const setupAjv = (ajv) => {
-      conf.onCreateAjv(ajv);
-      // Only add AJV formats if they weren't added in user-space already
+      if (conf.onCreateAjv) {
+        conf.onCreateAjv(ajv);
+      }
+      // Only add Ajv formats if they weren't added in user-space already
       if (!ajv.formats['date-time']) {
         addFormats(ajv);
       }
@@ -77,7 +79,7 @@ class AjvValidator extends Validator {
     }
 
     validator.call(model, json);
-    const error = parseValidationError(validator.errors, modelClass, options);
+    const error = parseValidationError(validator.errors, modelClass, options, this.ajvOptions);
 
     if (error) {
       throw error;
@@ -87,7 +89,7 @@ class AjvValidator extends Validator {
   }
 
   getValidator(modelClass, jsonSchema, isPatchObject) {
-    // Use the AJV custom serializer if provided.
+    // Use the Ajv custom serializer if provided.
     const createCacheKey = this.ajvOptions.serialize || JSON.stringify;
 
     // Optimization for the common case where jsonSchema is never modified.
@@ -103,7 +105,7 @@ class AjvValidator extends Validator {
     if (!validators) {
       validators = {
         // Validator created for the schema object without `required` properties
-        // using the AJV instance that doesn't set default values.
+        // using the Ajv instance that doesn't set default values.
         patchValidator: null,
 
         // Validator created for the unmodified schema.
@@ -143,7 +145,7 @@ class AjvValidator extends Validator {
   }
 }
 
-function parseValidationError(errors, modelClass, options) {
+function parseValidationError(errors, modelClass, options, ajvOptions) {
   if (!errors) {
     return null;
   }
@@ -178,13 +180,21 @@ function parseValidationError(errors, modelClass, options) {
     // More than one error can occur for the same key in Ajv, merge them in the array:
     const array = errorHash[key] || (errorHash[key] = []);
 
-    // Use unshift instead of push so that the last error ends up at [0],
-    // preserving previous behavior where only the last error was stored.
-    array.unshift({
+    // Prepare error object
+    const errorObj = {
       message: error.message,
       keyword: error.keyword,
       params: error.params,
-    });
+    };
+
+    // Add data if verbose enabled
+    if (ajvOptions.verbose) {
+      errorObj.data = error.data;
+    }
+
+    // Use unshift instead of push so that the last error ends up at [0],
+    // preserving previous behavior where only the last error was stored.
+    array.unshift(errorObj);
 
     ++numErrors;
   }

lib/model/Model.js

@@ -98,19 +98,26 @@ class Model {
     const columnNameMappers = this.constructor.getColumnNameMappers();
 
     if (columnNameMappers) {
-      json = columnNameMappers.parse(json);
+      json = columnNameMappers.parse(json, this.isJsonColumn(this.constructor.$$columnInfo));
     }
 
     return parseJsonAttributes(json, this.constructor);
   }
 
+  isJsonColumn(columnInfo) {
+    return (columnName) =>
+      typeof columnInfo == 'object' &&
+      columnInfo.hasOwnProperty(columnName) &&
+      (columnInfo[columnName]['type'] == 'json' || columnInfo[columnName]['type'] == 'jsonb');
+  }
+
   $formatDatabaseJson(json) {
     const columnNameMappers = this.constructor.getColumnNameMappers();
 
     json = formatJsonAttributes(json, this.constructor);
 
     if (columnNameMappers) {
-      json = columnNameMappers.format(json);
+      json = columnNameMappers.format(json, this.isJsonColumn(this.constructor.$$columnInfo));
     }
 
     return json;
@@ -317,9 +324,6 @@ class Model {
 
   static createValidator() {
     return new AjvValidator({
-      onCreateAjv: (ajv) => {
-        /* Do Nothing by default */
-      },
       options: {
         allErrors: true,
         validateSchema: false,
@@ -408,6 +412,10 @@ class Model {
     return this.modifiers || {};
   }
 
+  static async columnInfo(creator) {
+    return await cachedGetAsync(this, '$$columnInfo', creator);
+  }
+
   static columnNameToPropertyName(columnName) {
     let colToProp = cachedGet(this, '$$colToProp', () => new Map());
     let propertyName = colToProp.get(columnName);
@@ -819,6 +827,14 @@ function relatedQuery({ modelClass, relationName, transaction, alwaysReturnArray
     });
 }
 
+async function cachedGetAsync(target, hiddenPropertyName, creator) {
+  if (!target.hasOwnProperty(hiddenPropertyName)) {
+    defineNonEnumerableProperty(target, hiddenPropertyName, await creator(target));
+  }
+
+  return target[hiddenPropertyName];
+}
+
 function cachedGet(target, hiddenPropertyName, creator) {
   if (!target.hasOwnProperty(hiddenPropertyName)) {
     defineNonEnumerableProperty(target, hiddenPropertyName, creator(target));

lib/model/modelUtils.js

@@ -17,6 +17,7 @@ const staticHiddenProps = [
   '$$readOnlyAttributes',
   '$$idRelationProperty',
   '$$virtualAttributes',
+  '$$columnInfo',
 ];
 
 function defineNonEnumerableProperty(obj, prop, value) {

lib/queryBuilder/QueryBuilder.js

@@ -440,8 +440,11 @@ class QueryBuilder extends QueryBuilderBase {
   async execute() {
     // Take a clone so that we don't modify this instance during execution.
     const builder = this.clone();
+    const colBuilder = this.clone();
 
     try {
+      // Lazy fetch columns info (fixes #1089)
+      await builder._modelClass.columnInfo(async (_) => await colBuilder.columnInfo());
       await beforeExecute(builder);
       const result = await doExecute(builder);
       return await afterExecute(builder, result);
@@ -1097,7 +1100,6 @@ function doExecute(builder) {
     promise = Promise.resolve(queryExecutorOperation.queryExecutor(builder));
   } else {
     promise = Promise.resolve(buildKnexQuery(builder));
-
     promise = chainOperationHooks(promise, builder, 'onRawResult');
     promise = promise.then((result) => createModels(result, builder));
   }

lib/utils/identifierMapping.js

@@ -145,7 +145,7 @@ function mapLastPart(mapper, separator) {
 // Returns a function that takes an object as an input and maps the object's keys
 // using `mapper`. If the input is not an object, the input is returned unchanged.
 function keyMapper(mapper) {
-  return (obj) => {
+  return (obj, isJsonColumn = () => false) => {
     if (!isObject(obj) || Array.isArray(obj)) {
       return obj;
     }
@@ -155,7 +155,17 @@ function keyMapper(mapper) {
 
     for (let i = 0, l = keys.length; i < l; ++i) {
       const key = keys[i];
-      out[mapper(key)] = obj[key];
+
+      if (key.indexOf(':') > -1) {
+        const parts = key.split(':');
+        if (isJsonColumn(mapper(parts[0]))) {
+          out[`${mapper(parts[0])}:${parts[1]}`] = obj[key];
+        } else {
+          out[mapper(key)] = obj[key];
+        }
+      } else {
+        out[mapper(key)] = obj[key];
+      }
     }
 
     return out;