Reload Record Hell

adapters.application.js

import DS from 'ember-data';
import Ember from 'ember';

export default DS.RESTAdapter.extend({
  namespace: 'api'
});

controllers.application.js

import Ember from 'ember';

export default Ember.Controller.extend({
  appName: 'Ember Twiddle'
});

models.contract.js

import Ember from 'ember';
import Model from "ember-data/model";
import attr from "ember-data/attr";
import { belongsTo, hasMany } from "ember-data/relationships";

export default Model.extend({
  people: hasMany('person'),
  name: attr('string')
});

models.person.js

import Model from "ember-data/model";
import attr from "ember-data/attr";
import { belongsTo, hasMany } from "ember-data/relationships";

export default Model.extend({
  name: attr('string')
});

routes.index.js

import Ember from 'ember';
import { hash } from 'rsvp';

export default Ember.Route.extend({
  init(){
    $.mockjax({ url: '/api/contracts/1', responseText: { id: '1', name: 'contract 1', people: [] }});
  	$.mockjax({
      url: '/api/people',
      responseText: [
        { id: '1', name: 'tom' },
        { id: '2', name: 'mary' },
        { id: '3', name: 'dale' }
      ]
    });
  },
  model(){
  	return hash({
      contract: this.store.findRecord('contract', '1'),
      people: this.store.findAll('person')
    });
  },
  actions: {
    reload(contract, people){
      contract.reload();
      people.update();
    },
    rollback(contract){
      contract.rollbackAttributes();
    },
    force(contract){
      contract.hasMany('people').push([]);
    },
    associate(person, contract){
      contract.people.addObject(person);
    },
    allTheThings(model){
      model.contract.unloadRecord();
      this.store.unloadAll('people');
      this.refresh();
    }
  }
});

serializers.application.js

import DS from 'ember-data';
import Ember from 'ember';

export default DS.JSONSerializer.extend({});

templates.application.hbs

<h1>Welcome to Record Reload Hell</h1>
<br>
{{outlet}}
<br>

templates.index.hbs

<p>
This twiddle shows that when a hasMany record is reloaded the relationship state is not accepted as canonical.
</p>

<hr />
Editing contract {{model.contract.id}}
<div>
  <label>Name</label>
  {{input value=model.contract.name}}
</div>

<div>
People associated with contract:
  <ul>
  {{#each model.contract.people as |person|}}
    <li>{{person.name}}</li>
  {{/each}}
  </ul>
</div>

<hr />
People available for association:
<ul>
  {{#each model.people as |person|}}
    <li>{{person.name}} <button type="button" {{action 'associate' person model.contract}}>Associate</button></li>
  {{/each}}
</ul> 

<button type="button" {{action 'reload' model.contract model.people}}>Reload the record</button>
<button type="button" {{action 'rollback' model.contract}}>Rollback the attributes</button>
<button type="button" {{action 'force' model.contract}}>Force HasMany Canonical</button>
<button type="button" {{action 'allTheThings' model}}>RELOAD ALL THE THINGS</button>

<p>
  None of these buttons do anythign except for the last one and that is an extreme case that cannot really be used in production code
</p>

twiddle.json

{
  "version": "0.12.1",
  "EmberENV": {
    "FEATURES": {}
  },
  "options": {
    "use_pods": false,
    "enable-testing": false
  },
  "dependencies": {
    "jquery": "https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.js",
    "ember": "3.2.2",
    "ember-template-compiler": "3.2.2",
    "ember-testing": "3.2.2",
    "jquery-mockjax": "https://cdnjs.cloudflare.com/ajax/libs/jquery-mockjax/1.6.2/jquery.mockjax.js"
  },
  "addons": {
    "ember-data": "3.2.0",
    "ember-power-select": "2.0.3"
  }
}