Allow self referencing relationships

Author: phortx

dist/vuex-orm-graphql.esm.js

@@ -25390,7 +25390,7 @@ var DataStore = /** @class */ (function () {
     return DataStore;
 }());
 
-var version_1 = "2.3.1";
+var version_1 = "2.3.5";
 
 var __assign$7 = (undefined && undefined.__assign) || Object.assign || function(t) {
     for (var s, i = 1, n = arguments.length; i < n; i++) {
@@ -28324,7 +28324,12 @@ var QueryBuilder = /** @class */ (function () {
                 relatedModel = context.getModel(name);
                 context.logger.log('WARNING: field has neither parent nor related property. Fallback to attribute name', field);
             }
-            var ignore = path.includes(relatedModel.singularName);
+            // We will ignore the field, when it's already in the path. Means: When it's already queried. However there are
+            // cases where the model will have a relationship to itself. For example a nested category strucure where the
+            // category model has a parent: belongsTo(Category). So we also check if the model references itself. If this is
+            // the case, we allow the nesting up to 5 times.
+            var referencesItSelf = takeWhile(path.slice(0).reverse(), function (p) { return p === relatedModel.singularName; }).length;
+            var ignore = referencesItSelf ? referencesItSelf > 5 : path.includes(relatedModel.singularName);
             // console.log(`-----> Will ${ignore ? '' : 'not'} ignore ${model.singularName}.${name}, path: ${path.join('.')}`);
             if (model.shouldEagerLoadRelation(name, field, relatedModel) && !ignore) {
                 var newPath = path.slice(0);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuex-orm/plugin-graphql",
-  "version": "1.0.0-rc.14",
+  "version": "1.0.0-rc.15",
   "description": "Vuex-ORM Plugin to sync the data against a GraphQL API.",
   "main": "dist/vuex-orm-graphql.common.js",
   "module": "dist/vuex-orm-graphql.esm.js",

src/graphql/query-builder.ts

@@ -317,7 +317,12 @@ export default class QueryBuilder {
         context.logger.log('WARNING: field has neither parent nor related property. Fallback to attribute name', field);
       }
 
-      const ignore = path.includes(relatedModel.singularName);
+      // We will ignore the field, when it's already in the path. Means: When it's already queried. However there are
+      // cases where the model will have a relationship to itself. For example a nested category strucure where the
+      // category model has a parent: belongsTo(Category). So we also check if the model references itself. If this is
+      // the case, we allow the nesting up to 5 times.
+      const referencesItSelf = _.takeWhile(path.slice(0).reverse(), p => p === relatedModel.singularName).length;
+      const ignore = referencesItSelf ? referencesItSelf > 5 : path.includes(relatedModel.singularName);
 
       // console.log(`-----> Will ${ignore ? '' : 'not'} ignore ${model.singularName}.${name}, path: ${path.join('.')}`);
 

test/support/mock-data.js

@@ -132,6 +132,19 @@ export class TariffOption extends ORMModel {
   }
 }
 
+export class Category extends ORMModel {
+  static entity = 'categories';
+
+  static fields () {
+    return {
+      id: this.increment(),
+      name: this.string(''),
+
+      parentId: this.number(0),
+      parent: this.belongsTo(Category, 'parentId'),
+    }
+  }
+}
 
 export async function setupMockData() {
   let store, vuexOrmGraphQL;
@@ -144,7 +157,8 @@ export async function setupMockData() {
     { model: Comment },
     { model: TariffOption },
     { model: Tariff },
-    { model: TariffTariffOption }
+    { model: TariffTariffOption },
+    { model: Category }
   ]);
 
   return [store, vuexOrmGraphQL];

test/support/mock-schema.js

@@ -1,6 +1,7 @@
 import { User, Profile, Video, Post, Comment, Tariff, TariffOption } from 'test/support/mock-data'
 import inflection from 'inflection';
 import * as _ from 'lodash';
+import {Category} from "./mock-data";
 
 
 export const typeDefs = `
@@ -21,6 +22,8 @@ export const typeDefs = `
     tariffs(filter: TariffFilter): TariffTypeConnection!
     tariffTariffOption(id: ID!): TariffTariffOption!
     tariffTariffOptions(filter: TariffTariffOptionFilter): TariffTariffOptionTypeConnection!
+    category(id: ID!): Category!
+    categories(filter: CategoryFilter): CategoryTypeConnection!
     
     unpublishedPosts(authorId: ID!): PostTypeConnection
     status: Status
@@ -320,6 +323,34 @@ export const typeDefs = `
   type TariffTariffOptionTypeConnection {
     nodes: [TariffTariffOption!]!
   }
+
+  type Category {
+    id: ID
+    name: String
+    parentId: ID
+    parent: Category
+  }
+
+
+  input CategoryFilter {
+    id: ID
+    name: String
+    parentId: ID
+    parent: CategoryInput
+  }
+
+
+   input CategoryInput {
+    id: ID
+    name: String
+    parentId: ID
+    parent: CategoryInput
+  }
+
+
+  type CategoryTypeConnection {
+    nodes: [Category!]!
+  }
 `;
 
 
@@ -493,6 +524,56 @@ const tariffOptions = [
   }
 ];
 
+const categories = [
+  {
+    id: 1,
+    name: 'Programming',
+    parentId: 0,
+  },
+
+  {
+    id: 2,
+    name: 'Frameworks',
+    parentId: 1,
+  },
+
+  {
+    id: 3,
+    name: 'Languages',
+    parentId: 1,
+  },
+
+  {
+    id: 4,
+    name: 'Patterns',
+    parentId: 1,
+  },
+
+  {
+    id: 5,
+    name: 'Ruby',
+    parentId: 3,
+  },
+
+  {
+    id: 6,
+    name: 'JavaScript',
+    parentId: 3,
+  },
+
+  {
+    id: 7,
+    name: 'PHP',
+    parentId: 3,
+  },
+
+  {
+    id: 8,
+    name: 'RSpec',
+    parentId: 5,
+  },
+];
+
 
 function addRelations(model, record, path = []) {
   if (!record) return record;
@@ -530,6 +611,10 @@ function addRelations(model, record, path = []) {
       if (!ignoreRelation(Tariff, path)) record.tariffs = findMany(Tariff, tariffs, () => true, path);
       break;
 
+    case Category:
+      if (record.parentId) record.parent = findOne(Category, categories, record.parentId);
+      break;
+
   }
 
   return record;
@@ -600,6 +685,8 @@ export const resolvers = {
     tariffs: (parent, { filter }) => findMany(Tariff, tariffs, filter),
     tariffOption: (parent, { id }) => findOne(TariffOption, tariffOptions, id),
     tariffOptions: (parent, { filter }) => findMany(TariffOption, tariffOptions, filter),
+    category: (parent, { id }) => findOne(Category, categories, id),
+    categories: (parent, { filter }) => findMany(Category, categories, filter),
 
     unpublishedPosts: (parent, { authorId }) => findMany(Post, posts, { authorId }),
     status: (parent, args) => ({

test/unit/QueryBuilder.spec.js

@@ -114,6 +114,37 @@ query test {
 }
       `.trim());
     });
+
+
+    it('respects nested categories', () => {
+      const fields = QueryBuilder.buildRelationsQuery(context.getModel('category'), ['category']);
+      const query = prettify(`query test { ${fields} }`).trim();
+
+      expect(query).toEqual(`
+query test {
+  parent {
+    id
+    name
+    parent {
+      id
+      name
+      parent {
+        id
+        name
+        parent {
+          id
+          name
+          parent {
+            id
+            name
+          }
+        }
+      }
+    }
+  }
+}
+      `.trim());
+    });
   });