Adding item to filtered result from ember-data

Question

I have a DS.Store which uses the DS.RESTAdapter and a ChatMessage object defined as such:

App.ChatMessage = DS.Model.extend({
    contents: DS.attr('string'),
    roomId:   DS.attr('string')
});

Note that a chat message exists in a room (not shown for simplicity), so in my chat messages controller (which extends Ember.ArrayController) I only want to load messages for the room the user is currently in:

loadMessages: function(){ 
    var room_id = App.getPath("current_room.id");
    this.set("content", App.store.find(App.ChatMessage, {room_id: room_id}); 
}

This sets the content to a DS.AdapterPopulatedModelArray and my view happily displays all the returned chat messages in an {{#each}} block.

Now it comes to adding a new message, I have the following in the same controller:

postMessage: function(contents) {
    var room_id = App.getPath("current_room.id");
    App.store.createRecord(App.ChatMessage, {
        contents: contents,
        room_id: room_id
    });

    App.store.commit();
}

This initiates an ajax request to save the message on the server, all good so far, but it doesn't update the view. This pretty much makes sense as it's a filtered result and if I remove the room_id filter on App.store.find then it updates as expected.

Trying this.pushObject(message) with the message record returned from App.store.createRecord raises an error.

How do I manually add the item to the results? There doesn't seem to be a way as far as I can tell as both DS.AdapterPopulatedModelArray and DS.FilteredModelArray are immutable.

score 8 · Answer 1 · answered Apr 18 '12 at 20:36

so couple of thoughts:

(reference: https://github.com/emberjs/data/issues/190)

how to listen for new records in the datastore

a normal Model.find()/findQuery() will return you an AdapterPopulatedModelArray, but that array will stand on its own... it wont know that anything new has been loaded into the database

a Model.find() with no params (or store.findAll()) will return you ALL records a FilteredModelArray, and ember-data will "register" it into a list, and any new records loaded into the database will be added to this array.

calling Model.filter(func) will give you back a FilteredModelArray, which is also registered with the store... and any new records in the store will cause ember-data to "updateModelArrays", meaning it will call your filter function with the new record, and if you return true, then it will stick it into your existing array.

SO WHAT I ENDED UP DOING: was immediately after creating the store, I call store.findAll(), which gives me back an array of all models for a type... and I attach that to the store... then anywhere else in the code, I can addArrayObservers to those lists.. something like:

App.MyModel = DS.Model.extend()
App.store = DS.Store.create()
App.store.allMyModels = App.store.findAll(App.MyModel)

//some other place in the app... a list controller perhaps
App.store.allMyModels.addArrayObserver({
   arrayWillChange: function(arr, start, removeCount, addCount) {}
   arrayDidChange: function(arr, start, removeCount, addCount) {}
})

how to push a model into one of those "immutable" arrays:

First to note: all Ember-Data Model instances (records) have a clientId property... which is a unique integer that identifies the model in the datastore cache whether or not it has a real server-id yet (example: right after doing a Model.createRecord).

so the AdapterPopulatedModelArray itself has a "content" property... which is an array of these clientId's... and when you iterate over the AdapterPopulatedModelArray, the iterator loops over these clientId's and hands you back the full model instances (records) that map to each clientId.

SO WHAT I HAVE DONE (this doesn't mean it's "right"!) is to watch those findAll arrays, and push new clientId's into the content property of the AdapterPopulatedModelArray... SOMETHING LIKE:

arrayDidChange:function(arr, start, removeCount, addCount){
    if (addCount == 0) {return;} //only care about adds right now... not removes...
        arr.slice(start, start+addCount).forEach(function(item) {
            //push clientId of this item into AdapterPopulatedModelArray content list
            self.getPath('list.content').pushObject(item.get('clientId'));
        });
    }

what I can say is: "its working for me" :) will it break on the next ember-data update? totally possible

score 2 · Answer 2 · answered Oct 02 '13 at 07:54

For those still struggling with this, you can get yourself a dynamic DS.FilteredArray instead of a static DS.AdapterPopulatedRecordArray by using the store.filter method. It takes 3 parameters: type, query and finally a filter callback.

loadMessages: function() { 
  var self = this,
      room_id = App.getPath('current_room.id');

  this.store.filter(App.ChatMessage, {room_id: room_id}, function (msg) {
    return msg.get('roomId') === room_id;
  })
  // set content only after promise has resolved
  .then(function (messages) {
    self.set('content', messages);
  });         
}

You could also do this in the model hook without the extra clutter, because the model hook will accept a promise directly:

model: function() { 
  var self = this,
      room_id = App.getPath("current_room.id");

  return this.store.filter(App.ChatMessage, {room_id: room_id}, function (msg) {
    return msg.get('roomId') === room_id;
  });
}

score 0 · Answer 3 · answered Apr 08 '12 at 17:30

0

My reading of the source (DS.Store.find) shows that what you'd actually be receiving in this instance is an AdapterPopulatedModelArray. A FilteredModelArray would auto-update as you create records. There are passing tests for this behaviour.

answered Apr 08 '12 at 17:30

Christopher Swasey

10,392
1
31
25

You're right, it's a AdapterPopulatedModelArray. I've updated the question - sorry for the typo! – rlivsey Apr 08 '12 at 17:58

score 0 · Answer 4 · edited Jun 20 '20 at 09:12

As of ember.data 1.13 store.filter was marked for removal, see the following ember blog post.

The feature was made available as a mixin. The GitHub page contains the following note

We recommend that you refactor away from using this addon. Below is a short guide for the three filter use scenarios and how to best refactor each.

Why? Simply put, it's far more performant (and not a memory leak) for you to manage filtering yourself via a specialized computed property tailored specifically for your needs

Adding item to filtered result from ember-data

4 Answers4

Linked