objection 3.0.5 → 3.1.0

package/README.md

@@ -17,7 +17,7 @@ What objection.js gives you:
 - **Simple and fun way to [fetch, insert, update and delete](https://vincit.github.io/objection.js/guide/query-examples.html) objects using the full power of SQL**
 - **Powerful mechanisms for [eager loading](https://vincit.github.io/objection.js/guide/query-examples.html#eager-loading), [inserting](https://vincit.github.io/objection.js/guide/query-examples.html#graph-inserts) and [upserting](https://vincit.github.io/objection.js/guide/query-examples.html#graph-upserts) object graphs**
 - **Easy to use [transactions](https://vincit.github.io/objection.js/guide/transactions.html)**
-- **Official [TypeScript](https://github.com/Vincit/objection.js/blob/master/typings/objection/index.d.ts) support**
+- **Official [TypeScript](https://github.com/Vincit/objection.js/blob/main/typings/objection/index.d.ts) support**
 - **Optional [JSON schema](https://vincit.github.io/objection.js/guide/validation.html) validation**
 - **A way to [store complex documents](https://vincit.github.io/objection.js/guide/documents.html) as single rows**
 
@@ -36,9 +36,9 @@ What objection.js **doesn't** give you:
   For simple things it is useful that the database schema is automatically generated from the model definitions,
   but usually just gets in your way when doing anything non-trivial. Objection.js leaves the schema related things
   to you. knex has a great [migration tool](https://knexjs.org/guide/migrations.html) that we recommend for this job. Check
-  out the [example project](https://github.com/Vincit/objection.js/tree/master/examples/koa-ts).
+  out the [example project](https://github.com/Vincit/objection.js/tree/main/examples/koa-ts).
 
-The best way to get started is to clone our [example project](https://github.com/Vincit/objection.js/tree/master/examples/koa) and start playing with it. There's also a [typescript version](https://github.com/Vincit/objection.js/tree/master/examples/koa-ts) available.
+The best way to get started is to clone our [example project](https://github.com/Vincit/objection.js/tree/main/examples/koa) and start playing with it. There's also a [typescript version](https://github.com/Vincit/objection.js/tree/main/examples/koa-ts) available.
 
 Check out [this issue](https://github.com/Vincit/objection.js/issues/1069) to see who is using objection and what they think about it.
 
@@ -46,7 +46,7 @@ Shortcuts:
 
 - [Who uses objection.js](https://github.com/Vincit/objection.js/issues/1069)
 - [API reference](https://vincit.github.io/objection.js/api/query-builder/)
-- [Example projects](https://github.com/Vincit/objection.js/tree/master/examples)
+- [Example projects](https://github.com/Vincit/objection.js/tree/main/examples)
 - [Changelog](https://vincit.github.io/objection.js/release-notes/changelog.html)
 - [v1 -> v2 migration guide](https://vincit.github.io/objection.js/release-notes/migration.html)
 - [Contribution guide](https://vincit.github.io/objection.js/guide/contributing.html)

package/lib/model/Model.js

@@ -172,11 +172,6 @@ class Model {
     // Do nothing by default.
   }
 
-  // TODO: Deprecate & remove
-  $afterGet(queryContext) {
-    // Do nothing by default.
-  }
-
   $afterFind(queryContext) {
     // Do nothing by default.
   }

package/lib/model/getModel.js

@@ -0,0 +1,9 @@
+'use strict';
+
+// A small helper method for cached lazy-importing of the Model class.
+let Model;
+const getModel = () => Model || (Model = require('./Model').Model);
+
+module.exports = {
+  getModel,
+};

package/lib/queryBuilder/QueryBuilder.js

@@ -1070,11 +1070,11 @@ function beforeExecute(builder) {
   // Resolve all before hooks before building and executing the query
   // and the rest of the hooks.
   promise = chainOperationHooks(promise, builder, 'onBefore1');
+  promise = chainOperationHooks(promise, builder, 'onBefore2');
 
   promise = chainHooks(promise, builder, builder.context().runBefore);
   promise = chainHooks(promise, builder, builder.internalContext().runBefore);
 
-  promise = chainOperationHooks(promise, builder, 'onBefore2');
   promise = chainOperationHooks(promise, builder, 'onBefore3');
 
   return promise;

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

@@ -1,5 +1,6 @@
 'use strict';
 
+const { getModel } = require('../../../model/getModel');
 const { GraphAction } = require('../GraphAction');
 const { isInternalProp } = require('../../../utils/internalPropUtils');
 const { union, difference, isObject, jsonEquals } = require('../../../utils/objectUtils');
@@ -30,20 +31,40 @@ class GraphPatchAction extends GraphAction {
     // properties. That's why we handle them here.
     const changePropsBecauseOfBelongsToOneDelete = this._handleBelongsToOneDeletes(node);
 
-    const { changedProps, unchangedProps } = this._findChanges(node);
-    const allProps = union(changedProps, unchangedProps);
+    const handleUpdate = () => {
+      const { changedProps, unchangedProps } = this._findChanges(node);
+      const allProps = union(changedProps, unchangedProps);
+
+      const propsToUpdate = difference(
+        shouldPatch || shouldUpdate
+          ? changedProps
+          : [...changedPropsBecauseOfBelongsToOneInsert, ...changePropsBecauseOfBelongsToOneDelete],
+
+        // Remove id properties from the props to update. With upsertGraph
+        // it never makes sense to change the id.
+        node.modelClass.getIdPropertyArray()
+      );
+
+      const update = propsToUpdate.length > 0;
+      if (update) {
+        // Don't update the fields that we know not to change.
+        node.obj.$omitFromDatabaseJson(difference(allProps, propsToUpdate));
+        node.userData.updated = true;
+      }
 
-    const propsToUpdate = difference(
-      shouldPatch || shouldUpdate
-        ? changedProps
-        : [...changedPropsBecauseOfBelongsToOneInsert, ...changePropsBecauseOfBelongsToOneDelete],
+      return update;
+    };
 
-      // Remove id properties from the props to update. With upsertGraph
-      // it never makes sense to change the id.
-      node.modelClass.getIdPropertyArray()
-    );
+    const Model = getModel();
+    // 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.
+    const hasBeforeUpdate =
+      node.obj.constructor.beforeUpdate !== Model.beforeUpdate ||
+      node.obj.$beforeUpdate !== Model.prototype.$beforeUpdate;
 
-    if (propsToUpdate.length === 0) {
+    if (!hasBeforeUpdate && !handleUpdate()) {
       return null;
     }
 
@@ -56,14 +77,31 @@ class GraphPatchAction extends GraphAction {
       patch: shouldPatch || (!shouldPatch && !shouldUpdate),
     });
 
-    // Don't update the fields that we know not to change.
-    node.obj.$omitFromDatabaseJson(difference(allProps, propsToUpdate));
-    node.userData.updated = true;
-
     const updateBuilder = this._createBuilder(node)
-      .childQueryOf(builder)
+      .childQueryOf(builder, childQueryOptions())
       .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);
+          }
+        });
+    }
+
     if (shouldPatch) {
       updateBuilder.patch(node.obj);
     } else {
@@ -197,6 +235,15 @@ class GraphPatchAction extends GraphAction {
   }
 }
 
+class ReturnNullException {}
+
+function childQueryOptions() {
+  return {
+    fork: true,
+    isInternalQuery: true,
+  };
+}
+
 function nonStrictEquals(val1, val2) {
   if (val1 == val2) {
     return true;

package/lib/queryBuilder/operations/FindOperation.js

@@ -154,8 +154,6 @@ function doCallAfterFind(ctx, model, result) {
 function getAfterFindHook(model) {
   if (model.$afterFind !== model.$objectionModelClass.prototype.$afterFind) {
     return model.$afterFind;
-  } else if (model.$afterGet !== model.$objectionModelClass.prototype.$afterGet) {
-    return model.$afterGet;
   } else {
     return null;
   }

package/lib/relations/manyToMany/ManyToManyRelation.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const getModel = () => require('../../model/Model').Model;
+const { getModel } = require('../../model/getModel');
 const { Relation } = require('../Relation');
 const { RelationProperty } = require('../RelationProperty');
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "objection",
-  "version": "3.0.5",
+  "version": "3.1.0",
   "description": "An SQL-friendly ORM for Node.js",
   "main": "lib/objection.js",
   "license": "MIT",
@@ -33,7 +33,7 @@
     "url": "git://github.com/vincit/objection.js.git"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14.0.0"
   },
   "keywords": [
     "orm",

package/typings/objection/index.d.ts

@@ -10,7 +10,7 @@
 // * Joseph T Lapp <https://github.com/jtlapp>
 // * Drew R. <https://github.com/drew-r>
 // * Karl Blomster <https://github.com/kblomster>
-// * And many others: See <https://github.com/Vincit/objection.js/blob/master/typings/objection/index.d.ts>
+// * And many others: See <https://github.com/Vincit/objection.js/blob/main/typings/objection/index.d.ts>
 
 import Ajv, { Options as AjvOptions } from 'ajv';
 import * as dbErrors from 'db-errors';
@@ -1677,7 +1677,6 @@ declare namespace Objection {
     $afterInsert(queryContext: QueryContext): Promise<any> | void;
     $afterUpdate(opt: ModelOptions, queryContext: QueryContext): Promise<any> | void;
     $beforeUpdate(opt: ModelOptions, queryContext: QueryContext): Promise<any> | void;
-    $afterGet(queryContext: QueryContext): Promise<any> | void;
     $afterFind(queryContext: QueryContext): Promise<any> | void;
     $beforeDelete(queryContext: QueryContext): Promise<any> | void;
     $afterDelete(queryContext: QueryContext): Promise<any> | void;