Returning inherited models of various types

[ryedeer]

Hello!

I ran into a problem while writing tests for our application. We have a certain backend route that can return various models inherited from a single base model. When I tried to mock it, I found out that the mock replaces the types of the supplied model instances with the type specified as the modelName for the mock, so the data aren't loaded properly.

To illustrate this, I wrote a simple test based on your test setup:

test("mock returns inherited models with proper types", function(assert) {
  const smallHat = make('small-hat');
  const bigHat = make('big-hat');
  let mock = mockQuery('hat', { size: 'all' }).returns({ models: [smallHat, bigHat] });
  let responseData = mock.responseJson.data;
  equal(responseData[0].type, 'small-hat');
  equal(responseData[1].type, 'big-hat');
});

As it turned out, the data type specified in the JSON is 'hat' in both cases.

I would greatly appreciate your suggestions on handling this situation.

[danielspaniel]

I will put this test to use in finding out what is going on ... on first glance it is probably due to the way polymorphism is handled in factory guy and that I have tested in a relationship setting and not freestyle as this one is ( load some polymorphic models on their own )

[danielspaniel]

this issue is now fixed in version 2.7.4 .. thanks for bringing it up

[ryedeer]

Thank you very much for fixing it! It will help us a lot.

[danielspaniel]

Your 100% welcome. I always like that you give me very clear idea of what is going on and write a test I can work with to fix the issue.

[ryedeer]

Hello! It seems that this issue strikes again. The polymorphic models are returned just fine when we use buildList (I see that a modified version of the test from my original post is included into the test suite), but the modelName is replaced with the one from the mock definition if we try to use returns({models: ...}). Here's the test I tried to include into the shared-adapter-behaviour.js:

test("using returns with model instances for a polymorphic route", function(assert) {
  run(() => {
    let done = assert.async();
    let bigHat = make('big-hat');

    console.log(bigHat.constructor.modelName); // "big-hat"

    mockQuery('hat', {size: 'all'}).returns({models: [bigHat]});

    FactoryGuy.store.query('hat', {size: 'all'}).then(function(hats) {
      assert.equal(hats.get('length'), 1);

      console.log(hats.get('firstObject').constructor.modelName); // "hat"

      assert.equal(hats.get('firstObject').constructor.modelName, bigHat.constructor.modelName) // fails
      assert.equal(FactoryGuy.store.peekAll('hat').get('content').length, 0, "does not make another hat"); // fails again
      done();
    });
  });
});

It seems that the previous behaviour was broken by this fix. Our test cases started to work just fine when we returned type: model.constructor.modelName into the model definition, but I see that it may break some other use cases. I don't know what to suggest... maybe we just need some kind of config option that would define the preferred behaviour for a mock.

[danielspaniel]

Interesting, I am going to try this out and see if i can figure this out.