Migrated to Objection v2

Author: Dekel Barzilay

README.md

@@ -141,35 +141,33 @@ Note that all this eager related options are optional.
 
 - **`allowedEager`** - relation expression to limit the allowed eager queries in
   the service. Defaults to `'[]'`, meaning no eager queries allowed. See
-  [`allowEager`](https://vincit.github.io/objection.js/api/query-builder/eager-methods.html#alloweager)
+  [`allowGraph`](https://vincit.github.io/objection.js/api/query-builder/eager-methods.html#allowgraph)
   documentation.
 - **`eagerFilters`** - option to impose compulsory eager filter. It takes an
   object or array of objects with the following properties:
   - `expression` - the relation expression that the filter will be applied.
   - `filter` - the filter function. It uses
-    [`modifyEager`](https://vincit.github.io/objection.js/api/query-builder/eager-methods.html#modifyeager)
+    [`modifyGraph`](https://vincit.github.io/objection.js/api/query-builder/eager-methods.html#modifygraph)
     internally.
-- **`namedEagerFilters`** - object containing named eager filter functions.
-  Filter is opt-in via `$eager` parameter.
 
 #### Query Operators
 
-- **`$eager`** - eager load relations defined in models'
-  `relationMappings` getter methods or in the `namedEagerFilters` option. See
-  [`eager`](https://vincit.github.io/objection.js/api/query-builder/eager-methods.html#eager) documentation.
-- **`$joinRelation`** - filter based on a relation's field. See
-  [`joinRelation`](https://vincit.github.io/objection.js/api/query-builder/join-methods.html#joinrelation)
+- **`$eager`** - eager load relations defined in models' `relationMappings` getter methods. See
+  [`withGraphFetched`](https://vincit.github.io/objection.js/api/query-builder/eager-methods.html#withgraphfetched) documentation.
+  
+- **`$joinRelation`** - filter based on a relation's field. use with `$eager` to also fetch the relation. See
+  [`joinRelated`](https://vincit.github.io/objection.js/api/query-builder/join-methods.html#joinrelated)
   documentation.
-- **`$joinEager`** - filter based on a relation's field using
-  `JoinEagerAlgorithm`. See
-  [`$joinEager`](https://vincit.github.io/objection.js/api/query-builder/eager-methods.html#joineager)
+  
+- **`$joinEager`** - filter based on a relation's field. See
+  [`withGraphJoined`](https://vincit.github.io/objection.js/api/query-builder/eager-methods.html#withgraphjoined)
   documentation.
+  
 - **`$modifyEager`** - filter relation based on a relation's field,
   e.g. `companies.find({ query: { $eager: 'employees', $modifyEager: { employees: { name: 'John' } } } })`
+  
 - **`$mergeEager`** - merge an eager expression to `$eager`,
   e.g. `companies.find({ query: { $eager: 'employees', $mergeEager: 'ceos' } })`
-- **`$pick`** - pick properties from result models. See
-  [`pick`](https://vincit.github.io/objection.js/api/query-builder/other-methods.html#pick) documentation.
 
 - **`$select`** - add SELECT statement with given array of column names. See
     [`$select`](https://vincit.github.io/objection.js/api/query-builder/find-methods.html#select) documentation.
@@ -212,10 +210,8 @@ Note that all this eager related options are optional.
   [`transaction`](https://vincit.github.io/objection.js/api/objection/#transaction)
   documentation.
 
-- **`mergeAllowEager`** - Just like allowEager but instead of replacing query
-  builder’s allowEager expression this method merges the given expression to the
-  existing expression. See
-  [`mergeAllowEager`](https://vincit.github.io/objection.js/api/query-builder/eager-methods.html#mergealloweager)
+- **`mergeAllowEager`** - Will merge the given expression to the existing expression from the `allowEager` service option. 
+  See [`allowGraph`](https://vincit.github.io/objection.js/api/query-builder/eager-methods.html#allowgraph)
   documentation.
 
 ### Composite primary keys
@@ -315,7 +311,7 @@ included in `$eager` query when using the `update` service method._
 - **`allowedUpsert`** - relation expression to allow relations to be upserted
   along with update. Defaults to `null`, meaning relations will not be
   automatically upserted unless specified here. See
-  [`allowUpsert`](https://vincit.github.io/objection.js/api/query-builder/mutate-methods.html#allowupsert)
+  [`allowGraph`](https://vincit.github.io/objection.js/api/query-builder/eager-methods.html#allowgraph)
   documentation.
 - **`upsertGraphOptions`** - See
   [`upsertGraphOptions`](https://vincit.github.io/objection.js/api/types/#type-upsertgraphoptions)
@@ -364,7 +360,7 @@ included in `$eager` query._
 - **`allowedInsert`** - relation expression to allow relations to be created
   along with insert. Defaults to `null`, meaning relations will not be
   automatically created unless specified here. See
-  [`allowInsert`](https://vincit.github.io/objection.js/api/query-builder/mutate-methods.html#allowinsert)
+  [`allowGraph`](https://vincit.github.io/objection.js/api/query-builder/eager-methods.html#allowgraph)
   documentation.
 - **`insertGraphOptions`** - See
   [`insertGraphOptions`](https://vincit.github.io/objection.js/api/types/#type-insertgraphoptions)
@@ -425,11 +421,6 @@ module.exports = function(app) {
     paginate,
     whitelist: ['$eager', '$joinRelation'],
     allowedEager: '[user, subtask]',
-    namedEagerFilters: {
-      unDone: function(builder) {
-        builder.where('done', false);
-      }
-    },
     eagerFilters: [
       {
         expression: 'subtask',
@@ -533,7 +524,7 @@ class User extends Model {
     };
   }
 
-  static get namedFilters() {
+  static get modifiers() {
     return {
       active: builder => {
         builder.where('status', 'active');
@@ -624,13 +615,16 @@ class Todo extends Model {
     };
   }
 
-  static get namedFilters() {
+  static get modifiers() {
     const knex = this.app.get('knex');
 
     return {
+      unDone: function(builder) {
+        builder.where('complete', false);
+      },
       overdue: builder => {
         builder
-          .where('complete', '=', false)
+          .where('complete', false)
           .where('dueDate', '<', knex.fn.now());
       }
     };
@@ -811,18 +805,30 @@ try {
 
 ## Migrating to `feathers-objection` v2
 
-`feathers-objection` 2.0.0 comes with important security and usability updates.
+`feathers-objection` 2.0.0 comes with important security and usability updates
 
-> **Important:** For general migration information to the new database adapter
-> functionality see
-> [crow.docs.feathersjs.com/migrating.html#database-adapters](https://crow.docs.feathersjs.com/migrating.html#database-adapters).
+> **Important:** For general migration information to the new database adapter functionality see    
+> [crow.docs.feathersjs.com/migrating.html#database-adapters](https://crow.docs.feathersjs.com/migrating.html#database-adapters)
 
 The following breaking changes have been introduced:
 
 - All methods allow additional query parameters
 - Multiple updates are disabled by default (see the `multi` option)
 - Objection related operators are disabled by default (see the `whitelist`
   option)
+  
+## Migrating to `feathers-objection` v5
+
+`feathers-objection` 5.0.0 comes with usability updates and was migrated to use Objection v2
+
+> **Important:** For general migration information to Objection v2 see  
+> [https://vincit.github.io/objection.js/release-notes/migration.html](https://vincit.github.io/objection.js/release-notes/migration.html)
+
+The following breaking changes have been introduced:
+
+- `$pick` query operator was removed
+- `namedEagerFilters` service option was removed. use Model's [`modifiers`](https://vincit.github.io/objection.js/recipes/modifiers.html#modifiers) instead
+- Model's `namedFilters` property was renamed to `modifiers`
 
 ## License
 

src/index.js

@@ -66,8 +66,6 @@ const NON_COMPARISON_OPERATORS = [
   '?&'
 ];
 
-const NO_RELATIONS = RelationExpression.create('[]');
-
 /**
  * Class representing an feathers adapter for Objection.js ORM.
  * @param {object} options
@@ -93,8 +91,7 @@ class Service extends AdapterService {
 
     this.idSeparator = options.idSeparator || ',';
     this.jsonSchema = options.model.jsonSchema;
-    this.allowedEager = options.allowedEager && RelationExpression.create(options.allowedEager);
-    this.namedEagerFilters = options.namedEagerFilters;
+    this.allowedEager = options.allowedEager;
     this.eagerFilters = options.eagerFilters;
     this.allowedInsert = options.allowedInsert && RelationExpression.create(options.allowedInsert);
     this.insertGraphOptions = options.insertGraphOptions;
@@ -162,7 +159,6 @@ class Service extends AdapterService {
     if (params.$joinRelation) { delete params.$joinRelation; }
     if (params.$modifyEager) { delete params.$modifyEager; }
     if (params.$mergeEager) { delete params.$mergeEager; }
-    if (params.$pick) { delete params.$pick; }
     if (params.$noSelect) { delete params.$noSelect; }
 
     Object.keys(params || {}).forEach(key => {
@@ -264,8 +260,9 @@ class Service extends AdapterService {
     const { filters, query } = this.filterQuery(params);
     const q = this._createQuery(params).skipUndefined();
 
-    const allowEager = this.mergeRelations(this.allowedEager, params.mergeAllowEager);
-    q.allowEager(allowEager || NO_RELATIONS);
+    if (this.allowedEager) { q.allowGraph(this.allowedEager); }
+
+    if (params.mergeAllowEager) { q.allowGraph(params.mergeAllowEager); }
 
     // $select uses a specific find syntax, so it has to come first.
     if (filters.$select) {
@@ -274,27 +271,27 @@ class Service extends AdapterService {
 
     // $eager for Objection eager queries
     if (query && query.$eager) {
-      q.eager(query.$eager, this.namedEagerFilters);
+      q.withGraphFetched(query.$eager);
+
       delete query.$eager;
     }
 
     if (query && query.$joinEager) {
-      q
-        .eagerAlgorithm(this.Model.JoinEagerAlgorithm)
-        .eager(query.$joinEager, this.namedEagerFilters);
+      q.withGraphJoined(query.$joinEager);
+
       delete query.$joinEager;
     }
 
     if (query && query.$joinRelation) {
       q
         .distinct(`${this.Model.tableName}.*`)
-        .joinRelation(query.$joinRelation);
+        .joinRelated(query.$joinRelation);
 
       delete query.$joinRelation;
     }
 
     if (query && query.$mergeEager) {
-      q.mergeEager(query.$mergeEager);
+      q[query.$joinEager ? 'withGraphJoined' : 'withGraphFetched'](query.$mergeEager);
 
       delete query.$mergeEager;
     }
@@ -304,27 +301,22 @@ class Service extends AdapterService {
       const eagerFilters = Array.isArray(this.eagerFilters) ? this.eagerFilters : [this.eagerFilters];
 
       for (const eagerFilter of eagerFilters) {
-        q.modifyEager(eagerFilter.expression, eagerFilter.filter);
+        q.modifyGraph(eagerFilter.expression, eagerFilter.filter);
       }
     }
 
     if (query && query.$modifyEager) {
       for (const eagerFilterExpression of Object.keys(query.$modifyEager)) {
         const eagerFilterQuery = query.$modifyEager[eagerFilterExpression];
 
-        q.modifyEager(eagerFilterExpression, builder => {
+        q.modifyGraph(eagerFilterExpression, builder => {
           this.objectify(builder, eagerFilterQuery);
         });
       }
 
       delete query.$modifyEager;
     }
 
-    if (query && query.$pick) {
-      q.pick(query.$pick);
-      delete query.$pick;
-    }
-
     // build up the knex query out of the query params
     this.objectify(q, query);
 
@@ -384,7 +376,7 @@ class Service extends AdapterService {
 
         if (query.$joinRelation) {
           countQuery
-            .joinRelation(query.$joinRelation)
+            .joinRelated(query.$joinRelation)
             .countDistinct({ total: idColumns });
         } else if (idColumns.length > 1) {
           countQuery.countDistinct({ total: idColumns });
@@ -441,11 +433,11 @@ class Service extends AdapterService {
 
       if (this.createUseUpsertGraph) {
         if (allowedUpsert) {
-          q.allowUpsert(allowedUpsert);
+          q.allowGraph(allowedUpsert);
         }
         q.upsertGraphAndFetch(data, this.upsertGraphOptions);
       } else if (allowedInsert) {
-        q.allowInsert(allowedInsert);
+        q.allowGraph(allowedInsert);
         q.insertGraph(data, this.insertGraphOptions);
       } else {
         q.insert(data, this.id);
@@ -503,7 +495,7 @@ class Service extends AdapterService {
         const allowedUpsert = this.mergeRelations(this.allowedUpsert, params.mergeAllowUpsert);
         if (allowedUpsert) {
           return this._createQuery(params)
-            .allowUpsert(allowedUpsert)
+            .allowGraph(allowedUpsert)
             .upsertGraphAndFetch(newObject, this.upsertGraphOptions);
         }
 
@@ -546,7 +538,7 @@ class Service extends AdapterService {
       const dataCopy = Object.assign({}, data, this.getIdsQuery(id, null, false));
 
       return this._createQuery(params)
-        .allowUpsert(allowedUpsert)
+        .allowGraph(allowedUpsert)
         .upsertGraphAndFetch(dataCopy, this.upsertGraphOptions);
     }
 

test/index.test.js

@@ -134,13 +134,8 @@ const app = feathers()
       model: Company,
       id: 'id',
       multi: ['create', 'remove', 'patch'],
-      whitelist: ['$eager', '$modifyEager', '$mergeEager', '$pick', '$between', '$notBetween', '$containsKey', '$contains', '$contained', '$any', '$all', '$noSelect', '$like'],
+      whitelist: ['$eager', '$modifyEager', '$mergeEager', '$between', '$notBetween', '$containsKey', '$contains', '$contained', '$any', '$all', '$noSelect', '$like'],
       allowedEager: '[ceos, clients]',
-      namedEagerFilters: {
-        notSnoop (builder) {
-          return builder.whereNot('name', 'Snoop');
-        }
-      },
       eagerFilters: [
         {
           expression: 'ceos',
@@ -299,12 +294,6 @@ describe('Feathers Objection Service', () => {
       });
     });
 
-    describe('when missing namedEagerFilters', () => {
-      it('sets the default to be undefined', () => {
-        expect(people.namedEagerFilters).to.equal(undefined);
-      });
-    });
-
     describe('when missing eagerFilters', () => {
       it('sets the default to be undefined', () => {
         expect(people.eagerFilters).to.equal(undefined);
@@ -805,13 +794,6 @@ describe('Feathers Objection Service', () => {
       });
     });
 
-    it('allows eager queries with pick', () => {
-      return companies.find({ query: { $eager: 'ceos', $pick: ['ceos'] } }).then(data => {
-        expect(data[0].ceos).to.be.ok;
-        expect(data[0].ceo).to.be.undefined;
-      });
-    });
-
     it('allows eager queries with named filters', () => {
       return companies
         .find({ query: { $eager: 'ceos(notSnoop)' } })
@@ -881,7 +863,7 @@ describe('Feathers Objection Service', () => {
         });
     });
 
-    it('allows joinRelation queries', () => {
+    it('allows joinRelation queries and eager', () => {
       return employees
         .find({
           query: {
@@ -896,6 +878,22 @@ describe('Feathers Objection Service', () => {
     });
 
     it('allows filtering by relation field with joinRelation queries', () => {
+      return employees
+        .find({
+          query: {
+            $joinRelation: 'company',
+            'company.name': {
+              $like: 'google'
+            }
+          }
+        })
+        .then(data => {
+          expect(data.length).to.equal(1);
+          expect(data[0].name).to.equal('Luke');
+        });
+    });
+
+    it('allows filtering by relation field with joinRelation queries and eager', () => {
       return employees
         .find({
           query: {

test/people.js

@@ -15,4 +15,10 @@ export default class People extends Model {
       created: { type: ['boolean', 'null'] }
     }
   }
+
+  static modifiers = {
+    notSnoop: builder => {
+      builder.whereNot('name', 'Snoop');
+    }
+  }
 }

types/index.d.ts

@@ -8,7 +8,6 @@ export interface ObjectionServiceOptions extends ServiceOptions {
   idSeparator: string;
   jsonSchema: any;
   allowedEager: string | object;
-  namedEagerFilters: any;
   eagerFilters: any;
   allowedInsert: string | object;
   insertGraphOptions: any;