fixes for Objection 2.x (#70)

Co-authored-by: Vignesh M <[email protected]> Co-authored-by: Igor Savin <[email protected]> Co-authored-by: Vignesh M <[email protected]>
Vincit · Jul 13, 2020 · 34309ce · 34309ce
1 parent 6910d55
commit 34309ce
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -177,7 +177,8 @@ In addition to the filter parameters, there is a set of query parameters that ha
 
 | Special parameter                 | Explanation                                                                                              |
 |-----------------------------------|----------------------------------------------------------------------------------------------------------|
-| `eager=[children, parent.movies]` | Which relations to fetch eagerly for the result models. An objection.js relation expression.             |
+| `eager=[children, parent.movies]` | Which relations to fetch eagerly for the result models. An objection.js relation expression. That pass to [withGraphFetched](https://vincit.github.io/objection.js/api/query-builder/eager-methods.html#withgraphfetched). |
+| `join=[parent, parent.movies]`    | Which relations to join and fetch eagerly for the result models. An objection.js relation expression. That pass to [withGraphJoined](https://vincit.github.io/objection.js/api/query-builder/eager-methods.html#withgraphjoined). |
 | `orderBy=firstName`               | Sort the result by certain property.                                                                     |
 | `orderByDesc=firstName`           | Sort the result by certain property in descending order.                                                 |
 | `rangeStart=10`                   | The start of the result range (inclusive). The result will be `{total: 12343, results: [ ... ]}`.        |

diff --git a/lib/FindQueryBuilder.js b/lib/FindQueryBuilder.js
@@ -8,6 +8,7 @@ const QueryParameter = require('./QueryParameter');
 
 const SPECIAL_PARAMETERS = Object.freeze({
   eager: 'eager',
+  join: 'join',
   rangeEnd: 'rangeEnd',
   rangeStart: 'rangeStart',
   orderBy: 'orderBy',
@@ -78,7 +79,8 @@ const SPECIAL_PARAMETERS = Object.freeze({
  *
  * | Special parameter             | Explanation                                                                                  |
  * |-------------------------------|----------------------------------------------------------------------------------------------|
- * | `eager=[pets, parent.movies]` | Which relations to fetch eagerly for the result models. An objection.js relation expression. |
+ * | `eager=[pets, parent.movies]` | Which relations to fetch eagerly for the result models. An objection.js relation expression. That pass to `withGraphFetched`. |
+ * | `join=[owner]`                | Which relations to fetch eagerly for the result models. An objection.js relation expression. That pass to `withGraphJoined`. |
  * | `orderBy=firstName`           | Sort the result by certain property.                                                         |
  * | `orderByDesc=firstName`       | Sort the result by certain property in descending order.                                     |
  * | `rangeStart=10`               | The start of the result range. The result will be `{total: 12343, results: [ ... ]}`.        |
@@ -338,6 +340,7 @@ class FindQueryBuilder {
     this._buildOrderBy(params, builder);
     this._buildRange(params, builder);
     this._buildEager(params, builder);
+    this._buildJoin(params, builder);
 
     return builder;
   }
@@ -499,10 +502,24 @@ class FindQueryBuilder {
     }
 
     if (this._allowEager) {
-      builder.allowEager(this._allowEager);
+      builder.allowGraph(this._allowEager);
     }
 
-    builder.eager(eager.value);
+    builder.withGraphFetched(eager.value);
+  }
+
+  _buildJoin(params, builder) {
+    let join = _.find(params, { specialParameter: 'join' });
+
+    if (!join) {
+      return;
+    }
+
+    if (this._allowEager) {
+      builder.allowGraph(this._allowEager);
+    }
+
+    builder.withGraphJoined(join.value);
   }
 
   _parsePropertyRefs(refs) {

diff --git a/lib/PropertyRef.js b/lib/PropertyRef.js
@@ -139,12 +139,10 @@ class PropertyRef {
 
     const rel = this.relation;
     if (rel && !rel.isOneToOne()) {
-      const subQuery = rel.findQuery(rel.relatedModelClass.query(), {
-        ownerIds: rel.ownerProp.refs(builder),
-      });
+      const subQuery = rel.ownerModelClass.relatedQuery(rel.name).alias(rel.relatedModelClass.name);
       subQuery[whereMethod].apply(subQuery, filter.args);
 
-      builder.whereExists(subQuery.toKnexQuery().select(1));
+      builder.whereExists(subQuery.select(1));
     } else {
       builder[whereMethod].apply(builder, filter.args);
     }

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -66,14 +66,14 @@
     "mocha": "6.2.3",
     "mysql": "^2.18.1",
     "nyc": "^15.0.1",
-    "objection": "^1.6.11",
+    "objection": "^2.0.0",
     "pg": "^7.18.2",
     "prettier": "^2.0.4",
     "sqlite3": "^4.1.1",
     "typescript": "3.8.3"
   },
   "peerDependencies": {
-    "objection": ">=1.6.11 <2.0.0"
+    "objection": ">=2.0.0 <3.0.0"
   },
   "engines": {
     "node": ">=8"

diff --git a/tests/test.js b/tests/test.js
@@ -391,9 +391,8 @@ describe('integration tests', () => {
             return objectionFind(Animal)
               .build({
                 orderByAsc: ['owner:parent:lastName'],
-                eager: 'owner.[parent]',
+                join: 'owner.[parent]',
               })
-              .eagerAlgorithm(Model.JoinEagerAlgorithm)
               .then(function (result) {
                 const names = _.map(
                   _.reject(result, (pet) => _.includes(pet.name, 'P0')),