Experimental support for polymorphic relations

Author: phortx

README.md

@@ -135,7 +135,6 @@ the server. It's true for all records except newly created ones.
 
 ## Known issues
 
-- n:m relations and polymorphic relations are untested
 - Each model is only loaded once in the graph
 - Code documentation is deprecated and crappy
 

dist/vuex-orm-apollo.esm.js

@@ -7842,21 +7842,25 @@ var QueryBuilder = /** @class */ (function () {
             Object.keys(data).forEach(function (key) {
                 if (data[key] !== undefined && data[key] !== null) {
                     if (data[key] instanceof Object) {
+                        var localModel = _this.context.getModel(key, true) || model;
                         if (data[key].nodes) {
-                            result[inflection.pluralize(key)] = _this.transformIncomingData(data[key].nodes, model, mutation, true);
+                            result[inflection.pluralize(key)] = _this.transformIncomingData(data[key].nodes, localModel, mutation, true);
                         }
                         else {
                             var newKey = key;
                             if (mutation && !recursiveCall) {
-                                newKey = data[key].nodes ? model.pluralName : model.singularName;
+                                newKey = data[key].nodes ? localModel.pluralName : localModel.singularName;
                                 newKey = downcaseFirstLetter(newKey);
                             }
-                            result[newKey] = _this.transformIncomingData(data[key], model, mutation, true);
+                            result[newKey] = _this.transformIncomingData(data[key], localModel, mutation, true);
                         }
                     }
-                    else if (key === 'id') {
+                    else if (model.fieldIsNumber(model.fields.get(key))) {
                         result[key] = parseInt(data[key], 0);
                     }
+                    else if (key.endsWith('Type') && model.isTypeFieldOfPolymorphRelation(key)) {
+                        result[key] = inflection.pluralize(downcaseFirstLetter(data[key]));
+                    }
                     else {
                         result[key] = data[key];
                     }
@@ -8164,6 +8168,41 @@ var Model = /** @class */ (function () {
         });
         return relations;
     };
+    /**
+     * This accepts a field like `subjectType` and checks if this just randomly is called `...Type` or it is part
+     * of a polymorph relation.
+     * @param {string} name
+     * @returns {boolean}
+     */
+    Model.prototype.isTypeFieldOfPolymorphRelation = function (name) {
+        var _this = this;
+        var found = false;
+        this.context.models.forEach(function (model) {
+            if (found)
+                return false;
+            model.getRelations().forEach(function (relation) {
+                if (relation instanceof _this.context.components.MorphMany ||
+                    relation instanceof _this.context.components.MorphedByMany ||
+                    relation instanceof _this.context.components.MorphOne ||
+                    relation instanceof _this.context.components.MorphTo ||
+                    relation instanceof _this.context.components.MorphToMany) {
+                    if (relation.type === name && relation.related && relation.related.entity === _this.baseModel.entity) {
+                        found = true;
+                        return false;
+                    }
+                }
+                return true;
+            });
+            return true;
+        });
+        return found;
+    };
+    Model.prototype.fieldIsNumber = function (field) {
+        if (!field)
+            return false;
+        return field instanceof this.context.components.Number ||
+            field instanceof this.context.components.Increment;
+    };
     Model.prototype.fieldIsAttribute = function (field) {
         return field instanceof this.context.components.Increment ||
             field instanceof this.context.components.Attr ||
@@ -8199,13 +8238,15 @@ var Context = /** @class */ (function () {
      * Returns a model by name
      *
      * @param {Model|string} model
+     * @param allowNull
      * @returns {Model}
      */
-    Context.prototype.getModel = function (model) {
+    Context.prototype.getModel = function (model, allowNull) {
+        if (allowNull === void 0) { allowNull = false; }
         if (typeof model === 'string') {
             var name_1 = inflection$2.singularize(downcaseFirstLetter(model));
             model = this.models.get(name_1);
-            if (!model)
+            if (!allowNull && !model)
                 throw new Error("No such model " + name_1 + "!");
         }
         return model;

package.json

@@ -81,9 +81,9 @@
     "tslint-config-standard": "^7.0.0",
     "typescript": "^2.7.1",
     "uglify-js": "^3.3.9",
+    "vuex": "^3.0.1",
     "webpack": "^3.10.0",
-    "webpack-node-externals": "^1.6.0",
-    "vuex": "^3.0.1"
+    "webpack-node-externals": "^1.6.0"
   },
   "nyc": {
     "include": [

src/context.ts

@@ -39,13 +39,14 @@ export default class Context {
    * Returns a model by name
    *
    * @param {Model|string} model
+   * @param allowNull
    * @returns {Model}
    */
-  public getModel (model: Model | string): Model {
+  public getModel (model: Model | string, allowNull: boolean = false): Model {
     if (typeof model === 'string') {
       const name: string = inflection.singularize(downcaseFirstLetter(model));
       model = this.models.get(name) as Model;
-      if (!model) throw new Error(`No such model ${name}!`);
+      if (!allowNull && !model) throw new Error(`No such model ${name}!`);
     }
 
     return model;

src/model.ts

@@ -80,6 +80,46 @@ export default class Model {
     return relations;
   }
 
+  /**
+   * This accepts a field like `subjectType` and checks if this just randomly is called `...Type` or it is part
+   * of a polymorph relation.
+   * @param {string} name
+   * @returns {boolean}
+   */
+  public isTypeFieldOfPolymorphRelation (name: string): boolean {
+    let found: boolean = false;
+
+    this.context.models.forEach((model) => {
+      if (found) return false;
+
+      model.getRelations().forEach((relation) => {
+        if (relation instanceof this.context.components.MorphMany ||
+          relation instanceof this.context.components.MorphedByMany ||
+          relation instanceof this.context.components.MorphOne ||
+          relation instanceof this.context.components.MorphTo ||
+          relation instanceof this.context.components.MorphToMany) {
+
+          if (relation.type === name && relation.related && relation.related.entity === this.baseModel.entity) {
+            found = true;
+            return false;
+          }
+        }
+
+        return true;
+      });
+
+      return true;
+    });
+
+    return found;
+  }
+
+  public fieldIsNumber (field: Field | undefined): boolean {
+    if (!field) return false;
+    return field instanceof this.context.components.Number ||
+      field instanceof this.context.components.Increment;
+  }
+
   private fieldIsAttribute (field: Field): boolean {
     return field instanceof this.context.components.Increment ||
       field instanceof this.context.components.Attr ||

src/queryBuilder.ts

@@ -5,7 +5,6 @@ import { print } from 'graphql/language/printer';
 import { Arguments, Data, Field } from './interfaces';
 import { downcaseFirstLetter, upcaseFirstLetter } from './utils';
 import gql from 'graphql-tag';
-import { BelongsTo } from '@vuex-orm/core';
 import Context from './context';
 
 const inflection = require('inflection');
@@ -171,20 +170,25 @@ export default class QueryBuilder {
       Object.keys(data).forEach((key) => {
         if (data[key] !== undefined && data[key] !== null) {
           if (data[key] instanceof Object) {
+            const localModel: Model = this.context.getModel(key, true) || model;
+
             if (data[key].nodes) {
-              result[inflection.pluralize(key)] = this.transformIncomingData(data[key].nodes, model, mutation, true);
+              result[inflection.pluralize(key)] = this.transformIncomingData(data[key].nodes,
+                localModel, mutation, true);
             } else {
               let newKey = key;
 
               if (mutation && !recursiveCall) {
-                newKey = data[key].nodes ? model.pluralName : model.singularName;
+                newKey = data[key].nodes ? localModel.pluralName : localModel.singularName;
                 newKey = downcaseFirstLetter(newKey);
               }
 
-              result[newKey] = this.transformIncomingData(data[key], model, mutation, true);
+              result[newKey] = this.transformIncomingData(data[key], localModel, mutation, true);
             }
-          } else if (key === 'id') {
+          } else if (model.fieldIsNumber(model.fields.get(key))) {
             result[key] = parseInt(data[key], 0);
+          } else if (key.endsWith('Type') && model.isTypeFieldOfPolymorphRelation(key)) {
+            result[key] = inflection.pluralize(downcaseFirstLetter(data[key]));
           } else {
             result[key] = data[key];
           }

test/integration/VuexORMApollo.spec.js

@@ -1,7 +1,5 @@
 import {Model as ORMModel} from "@vuex-orm/core";
-import Vue from 'vue';
 import {createStore, sendWithMockFetch} from "../support/Helpers";
-import fetchMock from 'fetch-mock';
 
 let store;
 let vuexOrmApollo;
@@ -19,6 +17,23 @@ class User extends ORMModel {
   }
 }
 
+class Video extends ORMModel {
+  static entity = 'videos';
+  static eagerLoad = ['comments'];
+
+  static fields () {
+    return {
+      id: this.increment(null),
+      content: this.string(''),
+      title: this.string(''),
+      userId: this.number(0),
+      otherId: this.number(0), // This is a field which ends with `Id` but doesn't belong to any relation
+      user: this.belongsTo(User, 'userId'),
+      comments: this.morphMany(Comment, 'subjectId', 'subjectType')
+    };
+  }
+}
+
 class Post extends ORMModel {
   static entity = 'posts';
   static eagerLoad = ['comments'];
@@ -31,7 +46,7 @@ class Post extends ORMModel {
       userId: this.number(0),
       otherId: this.number(0), // This is a field which ends with `Id` but doesn't belong to any relation
       user: this.belongsTo(User, 'userId'),
-      comments: this.hasMany(Comment, 'userId')
+      comments: this.morphMany(Comment, 'subjectId', 'subjectType')
     };
   }
 }
@@ -45,23 +60,26 @@ class Comment extends ORMModel {
       id: this.increment(0),
       content: this.string(''),
       userId: this.number(0),
-      postId: this.number(0),
       user: this.belongsTo(User, 'userId'),
-      post: this.belongsTo(Post, 'postId')
+
+      subjectId: this.number(0),
+      subjectType: this.string('')
     };
   }
 }
 
 describe('VuexORMApollo', () => {
   beforeEach(() => {
-    [store, vuexOrmApollo] = createStore([{ model: User }, { model: Post }, { model: Comment }]);
+    [store, vuexOrmApollo] = createStore([{ model: User }, { model: Post }, { model: Video }, { model: Comment }]);
 
     store.dispatch('entities/users/insert', { data: { id: 1, name: 'Charlie Brown' }});
     store.dispatch('entities/users/insert', { data: { id: 2, name: 'Peppermint Patty' }});
     store.dispatch('entities/posts/insert', { data: { id: 1, userId: 1, title: 'Example post 1', content: 'Foo' }});
     store.dispatch('entities/posts/insert', { data: { id: 1, userId: 1, title: 'Example post 2', content: 'Bar' }});
-    store.dispatch('entities/comments/insert', { data: { id: 1, userId: 1, postId: 1, content: 'Example comment 1' }});
-    store.dispatch('entities/comments/insert', { data: { id: 1, userId: 2, postId: 1, content: 'Example comment 2' }});
+    store.dispatch('entities/videos/insert', { data: { id: 1, userId: 1, title: 'Example video', content: 'Video' }});
+    store.dispatch('entities/comments/insert', { data: { id: 1, userId: 1, subjectId: 1, subjectType: 'videos', content: 'Example comment 1' }});
+    store.dispatch('entities/comments/insert', { data: { id: 1, userId: 2, subjectId: 1, subjectType: 'posts', content: 'Example comment 2' }});
+    store.dispatch('entities/comments/insert', { data: { id: 1, userId: 2, subjectId: 2, subjectType: 'posts', content: 'Example comment 3' }});
   });
 
   describe('fetch', () => {
@@ -70,13 +88,19 @@ describe('VuexORMApollo', () => {
         data: {
           post: {
             __typename: 'post',
-            id: 1,
+            id: 42,
             otherId: 13548,
-            title: 'Example Post 1',
+            title: 'Example Post 5',
             content: 'Foo',
             comments: {
               __typename: 'comment',
-              nodes: []
+              nodes: [{
+                __typename: 'comment',
+                id: 15,
+                content: 'Works!',
+                subjectId: 42,
+                subjectType: 'Post'
+              }]
             },
             user: {
               __typename: 'user',
@@ -88,7 +112,7 @@ describe('VuexORMApollo', () => {
       };
 
       let request = await sendWithMockFetch(response, async () => {
-        await store.dispatch('entities/posts/fetch', { filter: { id: 1 } });
+        await store.dispatch('entities/posts/fetch', { filter: { id: 42 } });
       });
       expect(request).not.toEqual(null);
 
@@ -108,6 +132,8 @@ query Post($id: ID!) {
       nodes {
         id
         content
+        subjectId
+        subjectType
         __typename
       }
       __typename
@@ -116,6 +142,11 @@ query Post($id: ID!) {
   }
 }
         `.trim() + "\n");
+
+      const post = store.getters['entities/posts/query']().withAll().where('id', 42).first();
+      expect(post.title).toEqual('Example Post 5');
+      expect(post.comments.length).toEqual(1);
+      expect(post.comments[0].content).toEqual('Works!');
     });
 
 
@@ -392,6 +423,8 @@ mutation UpvotePost($post: PostInput!, $captchaToken: String!) {
       nodes {
         id
         content
+        subjectId
+        subjectType
         __typename
       }
       __typename