ef4 / ember-data-relationship-tracker Goto Github PK

Overview

Add an example model setup to README

Why is this needed?

Currently there is some misleading information in the README. First, the README states that you need a version field on your model, when you really need a relationshipTrackerVersion variable.

Second, I think the documentation could be improved by providing users with an example model setup.

This addon was an extraction from an app, and I've realized that it is depending on some behavior of that app's particular server: it expects the server to set a changed timestamp on each record.

We can it adjust it to not depend on that, but as it is it won't work right with servers that don't do this.

Overview

As an edrt user I need a way to clear all relationships on save regardless of whether my relationshipTrackerVersion updates.

Why is this needed?

Let's say we have a Post model and a Comment model. The Post model has a hasMany relationship on comments. In my case when I save a post with related comments, and a comment changes, the version of the changed comments increments, while the Post version stays the same. The problem is that this causes the Post model to remain in a state where hasDirtyFields is true.

Implementation Details

I think we need a way to allow the user to indicate that the relationshipTracker should be reset after a save. For example, I am doing this in a current model that is being affected by this issue:

clearRelationshipTracking() {
    this._relationshipTracker = Object.create(null);
    this.notifyPropertyChange('relationshipTrackerVersion');
  },

I am then calling clearRelationshipTracking any time I perform a save on the Post model.