objection 3.1.2 → 3.1.4

package/lib/model/Model.js

@@ -219,27 +219,27 @@ class Model {
     return this.constructor.traverseAsync(filterConstructor, this, callback);
   }
 
-  $omitFromJson(props) {
+  $omitFromJson(...props) {
     if (arguments.length === 0) {
       return this.$$omitFromJson;
     } else {
       if (!this.hasOwnProperty('$$omitFromJson')) {
-        defineNonEnumerableProperty(this, '$$omitFromJson', props);
-      } else {
-        this.$$omitFromJson = this.$$omitFromJson.concat(props);
+        defineNonEnumerableProperty(this, '$$omitFromJson', []);
       }
+      this.$$omitFromJson = this.$$omitFromJson.concat(asPropsArray(props));
+      return this;
     }
   }
 
-  $omitFromDatabaseJson(props) {
+  $omitFromDatabaseJson(...props) {
     if (arguments.length === 0) {
       return this.$$omitFromDatabaseJson;
     } else {
       if (!this.hasOwnProperty('$$omitFromDatabaseJson')) {
-        defineNonEnumerableProperty(this, '$$omitFromDatabaseJson', props);
-      } else {
-        this.$$omitFromDatabaseJson = this.$$omitFromDatabaseJson.concat(props);
+        defineNonEnumerableProperty(this, '$$omitFromDatabaseJson', []);
       }
+      this.$$omitFromDatabaseJson = this.$$omitFromDatabaseJson.concat(asPropsArray(props));
+      return this;
     }
   }
 
@@ -907,6 +907,20 @@ function getTraverseArgs(filterConstructor, models, traverser) {
   };
 }
 
+function asPropsArray(props) {
+  if (props.length === 1) {
+    const arg = props[0];
+    if (Array.isArray(arg)) {
+      return arg;
+    } else if (arg && typeof arg === 'object') {
+      return Object.entries(arg)
+        .filter(([, value]) => value)
+        .map(([key]) => key);
+    }
+  }
+  return props;
+}
+
 module.exports = {
   Model,
 };

package/lib/queryBuilder/InternalOptions.js

@@ -4,6 +4,7 @@ class InternalOptions {
   constructor() {
     this.skipUndefined = false;
     this.keepImplicitJoinProps = false;
+    this.returnImmediatelyValue = undefined;
     this.isInternalQuery = false;
     this.debug = false;
     this.schema = undefined;
@@ -14,6 +15,7 @@ class InternalOptions {
 
     copy.skipUndefined = this.skipUndefined;
     copy.keepImplicitJoinProps = this.keepImplicitJoinProps;
+    copy.returnImmediatelyValue = this.returnImmediatelyValue;
     copy.isInternalQuery = this.isInternalQuery;
     copy.debug = this.debug;
     copy.schema = this.schema;

package/lib/queryBuilder/QueryBuilder.js

@@ -1119,7 +1119,24 @@ function afterExecute(builder, result) {
   return promise;
 }
 
+class ReturnImmediatelyException {
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+function handleReturnImmediatelyValue(builder) {
+  const { returnImmediatelyValue } = builder.internalOptions();
+  if (returnImmediatelyValue !== undefined) {
+    throw new ReturnImmediatelyException(returnImmediatelyValue);
+  }
+}
+
 function handleExecuteError(builder, err) {
+  if (err instanceof ReturnImmediatelyException) {
+    return Promise.resolve(err.value);
+  }
+
   let promise = Promise.reject(wrapError(err));
 
   builder.forEachOperation(true, (op) => {
@@ -1139,9 +1156,11 @@ function chainOperationHooks(promise, builder, hookName) {
 
     builder.forEachOperation(true, (op) => {
       if (op.hasHook(hookName)) {
-        promise = promise.then((result) =>
-          builder.callAsyncOperationMethod(op, hookName, [builder, result]),
-        );
+        promise = promise.then((result) => {
+          const res = builder.callAsyncOperationMethod(op, hookName, [builder, result]);
+          handleReturnImmediatelyValue(builder);
+          return res;
+        });
       }
     });
 
@@ -1261,7 +1280,11 @@ async function chainHooks(promise, builder, func) {
     let promise = Promise.resolve(result);
 
     if (isFunction(func)) {
-      promise = promise.then((result) => func.call(builder, result, builder));
+      promise = promise.then((result) => {
+        const res = func.call(builder, result, builder);
+        handleReturnImmediatelyValue(builder);
+        return res;
+      });
     } else if (Array.isArray(func)) {
       func.forEach((func) => {
         promise = chainHooks(promise, builder, func);

package/lib/queryBuilder/ReferenceBuilder.js

@@ -76,8 +76,8 @@ class ReferenceBuilder {
     const table = this.tableName
       ? this.tableName
       : this.modelClass
-      ? builder.tableRefFor(this.modelClass)
-      : null;
+        ? builder.tableRefFor(this.modelClass)
+        : null;
 
     if (table) {
       return `${table}.${this.column}`;

package/lib/queryBuilder/graph/patch/GraphPatchAction.js

@@ -3,7 +3,7 @@
 const { getModel } = require('../../../model/getModel');
 const { GraphAction } = require('../GraphAction');
 const { isInternalProp } = require('../../../utils/internalPropUtils');
-const { union, difference, isObject, jsonEquals } = require('../../../utils/objectUtils');
+const { difference, isObject, jsonEquals } = require('../../../utils/objectUtils');
 const promiseUtils = require('../../../utils/promiseUtils');
 
 class GraphPatchAction extends GraphAction {
@@ -33,7 +33,7 @@ class GraphPatchAction extends GraphAction {
 
     const handleUpdate = () => {
       const { changedProps, unchangedProps } = this._findChanges(node);
-      const allProps = union(changedProps, unchangedProps);
+      const allProps = [...changedProps, ...unchangedProps];
 
       const propsToUpdate = difference(
         shouldPatch || shouldUpdate
@@ -59,12 +59,16 @@ class GraphPatchAction extends GraphAction {
     // See if the model defines a beforeUpdate or $beforeUpdate hook. If it does
     // not, we can check for updated properties now and drop out immediately if
     // there is nothing to update. Otherwise, we need to wait for the hook to be
-    // called before calling handleUpdate. See issue #2233.
+    // called before calling handleUpdate, but only if the node contains changes
+    // that aren't id properties (relates). See issues #2233, #2605.
     const hasBeforeUpdate =
       node.obj.constructor.beforeUpdate !== Model.beforeUpdate ||
       node.obj.$beforeUpdate !== Model.prototype.$beforeUpdate;
 
-    if (!hasBeforeUpdate && !handleUpdate()) {
+    if (
+      (hasBeforeUpdate && !this._hasNonIdPropertyChanges(node)) ||
+      (!hasBeforeUpdate && !handleUpdate())
+    ) {
       return null;
     }
 
@@ -82,24 +86,15 @@ class GraphPatchAction extends GraphAction {
       .copyFrom(builder, GraphAction.ReturningAllSelector);
 
     if (hasBeforeUpdate) {
-      updateBuilder
-        .context({
-          runBefore: () => {
-            // Call handleUpdate in the runBefore hook which runs after the
-            // $beforeUpdate hook, allowing it to modify the object before the
-            // updated properties are determined. See issue #2233.
-            if (hasBeforeUpdate && !handleUpdate()) {
-              throw new ReturnNullException();
-            }
-          },
-        })
-        .onError((error) => {
-          if (error instanceof ReturnNullException) {
-            return null;
-          } else {
-            return Promise.reject(error);
-          }
-        });
+      updateBuilder.internalContext().runBefore.push((result, builder) => {
+        // Call handleUpdate in the runBefore hook which runs after the
+        // $beforeUpdate hook, allowing it to modify the object before the
+        // updated properties are determined. See issue #2233.
+        if (hasBeforeUpdate && !handleUpdate()) {
+          builder.internalOptions().returnImmediatelyValue = null;
+        }
+        return result;
+      });
     }
 
     if (shouldPatch) {
@@ -216,6 +211,11 @@ class GraphPatchAction extends GraphAction {
     };
   }
 
+  _hasNonIdPropertyChanges(node) {
+    const idProps = node.modelClass.getIdPropertyArray();
+    return this._findChanges(node).changedProps.some((prop) => !idProps.includes(prop));
+  }
+
   _createBuilder(node) {
     if (node.parentEdge && !node.parentEdge.relation.isObjectionHasManyRelation) {
       return this._createRelatedBuilder(node);
@@ -235,8 +235,6 @@ class GraphPatchAction extends GraphAction {
   }
 }
 
-class ReturnNullException {}
-
 function childQueryOptions() {
   return {
     fork: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "objection",
-  "version": "3.1.2",
+  "version": "3.1.4",
   "description": "An SQL-friendly ORM for Node.js",
   "main": "lib/objection.js",
   "license": "MIT",
@@ -53,7 +53,7 @@
   ],
   "types": "./typings/objection/index.d.ts",
   "dependencies": {
-    "ajv": "^8.6.2",
+    "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
     "db-errors": "^0.2.3"
   },
@@ -61,20 +61,20 @@
     "knex": ">=1.0.1"
   },
   "devDependencies": {
-    "@types/node": "^20.1.7",
-    "chai": "^4.3.4",
+    "@types/node": "^20.10.0",
+    "chai": "^4.3.10",
     "chai-subset": "^1.6.0",
-    "eslint": "^8.1.0",
+    "eslint": "^8.54.0",
     "eslint-formatter-codeframe": "^7.32.1",
-    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-prettier": "^5.0.1",
     "expect.js": "^0.3.1",
-    "knex": ">=1.0.1",
+    "knex": "^3.0.1",
     "mocha": "^10.2.0",
     "mysql": "^2.18.1",
-    "pg": "^8.7.1",
-    "prettier": "3.0.3",
-    "sqlite3": "^5.0.2",
-    "typescript": ">=4.5.4",
+    "pg": "^8.11.3",
+    "prettier": "3.2.5",
+    "sqlite3": "^5.1.6",
+    "typescript": ">=5.3.2",
     "vuepress": "1.9.10"
   }
 }

package/typings/objection/index.d.ts

@@ -203,10 +203,10 @@ declare namespace Objection {
     [K in DataPropertyNames<T>]?: Defined<T[K]> extends Model
       ? T[K]
       : Defined<T[K]> extends Array<infer I>
-      ? I extends Model
-        ? I[]
-        : Expression<T[K]>
-      : Expression<T[K]>;
+        ? I extends Model
+          ? I[]
+          : Expression<T[K]>
+        : Expression<T[K]>;
   };
 
   /**
@@ -229,13 +229,14 @@ declare namespace Objection {
       }
     : never;
 
-  type PartialModelGraphField<F> = Defined<F> extends Model
-    ? PartialModelGraph<Defined<F>>
-    : Defined<F> extends Array<infer I>
-    ? I extends Model
-      ? PartialModelGraph<I>[]
-      : Expression<F>
-    : Expression<F>;
+  type PartialModelGraphField<F> =
+    Defined<F> extends Model
+      ? PartialModelGraph<Defined<F>>
+      : Defined<F> extends Array<infer I>
+        ? I extends Model
+          ? PartialModelGraph<I>[]
+          : Expression<F>
+        : Expression<F>;
 
   /**
    * Extracts the property names (excluding relations) of a model class.
@@ -245,12 +246,12 @@ declare namespace Objection {
       [K in keyof T]?: Defined<T[K]> extends Model
         ? never
         : Defined<T[K]> extends Array<infer I>
-        ? I extends Model
-          ? never
-          : K
-        : T[K] extends Function
-        ? never
-        : K;
+          ? I extends Model
+            ? never
+            : K
+          : T[K] extends Function
+            ? never
+            : K;
     }[keyof T],
     undefined | 'QueryBuilderType'
   >;
@@ -263,10 +264,10 @@ declare namespace Objection {
       [K in keyof T]?: Defined<T[K]> extends Model
         ? K
         : Defined<T[K]> extends Array<infer I>
-        ? I extends Model
-          ? K
-          : never
-        : never;
+          ? I extends Model
+            ? K
+            : never
+          : never;
     }[keyof T]
   >;
 
@@ -277,10 +278,10 @@ declare namespace Objection {
   type RelatedQueryBuilder<T> = T extends Model
     ? SingleQueryBuilder<QueryBuilderType<T>>
     : T extends Array<infer I>
-    ? I extends Model
-      ? QueryBuilderType<I>
-      : never
-    : never;
+      ? I extends Model
+        ? QueryBuilderType<I>
+        : never
+      : never;
 
   /**
    * Just like RelatedQueryBuilder but always returns an array
@@ -290,10 +291,10 @@ declare namespace Objection {
   type ArrayRelatedQueryBuilder<T> = T extends Model
     ? QueryBuilderType<T>
     : T extends Array<infer I>
-    ? I extends Model
-      ? QueryBuilderType<I>
-      : never
-    : never;
+      ? I extends Model
+        ? QueryBuilderType<I>
+        : never
+      : never;
 
   /**
    * Gets the query builder type for a model type.
@@ -1418,9 +1419,9 @@ declare namespace Objection {
     table?: string;
   }
 
-  export type Constructor<TResult, TParams extends any[] = any[]> = new (
-    ...params: TParams
-  ) => TResult;
+  export interface Constructor<T> {
+    new (): T;
+  }
 
   export interface ModelConstructor<M extends Model> extends Constructor<M> {}
 
@@ -1699,13 +1700,13 @@ declare namespace Objection {
     ): this;
 
     $set(obj: Pojo): this;
-    $omit(keys: string | string[] | { [key: string]: boolean }): this;
-    $pick(keys: string | string[] | { [key: string]: boolean }): this;
     $clone(opt?: CloneOptions): this;
     $traverse(filterConstructor: typeof Model, traverser: TraverserFunction): this;
     $traverse(traverser: TraverserFunction): this;
     $traverseAsync(filterConstructor: typeof Model, traverser: TraverserFunction): Promise<this>;
     $traverseAsync(traverser: TraverserFunction): Promise<this>;
+    $omitFromJson(keys: string | string[] | { [key: string]: boolean }): this;
+    $omitFromDatabaseJson(keys: string | string[] | { [key: string]: boolean }): this;
 
     $knex(): Knex;
     $transaction(): Knex;