update elements and fix some bugs

lib/src/firebase-element/firebase-collection.html

 <!--
 @license
 Copyright (c) 2015 The Polymer Project Authors. All rights reserved.
 This code may only be used under the BSD style license found at http://polymer.github.io/LICENSE.txt
 The complete set of authors may be found at http://polymer.github.io/AUTHORS.txt
 The complete set of contributors may be found at http://polymer.github.io/CONTRIBUTORS.txt
 Code distributed by Google as part of the polymer project is also
 subject to an additional IP rights grant found at http://polymer.github.io/PATENTS.txt
 -->
 
@@ skipping 215 matching lines @@
         }
       },
 
       listeners: {
         'firebase-child-added': '_onFirebaseChildAdded',
         'firebase-child-removed': '_onFirebaseChildRemoved',
         'firebase-child-changed': '_onFirebaseChildChanged',
         'firebase-child-moved': '_onFirebaseChildMoved',
       },
 
+      created: function() {
+        this._pendingSplices = [];
+        this._lastLocallyAddedIndex = null;
+      },
+
       /**
        * Add an item to the document referenced at `location`. A key associated
        * with the item will be created by Firebase, and can be accessed via the
        * Firebase Query instance returned by this method.
        *
        * @param {Object} data A value to add to the document.
        * @return {Object} A Firebase Query instance referring to the added item.
        */
       add: function(data) {
         var query;
 
         this._log('Adding new item to collection with value:', data);
 
         query = this.query.ref().push();
         query.set(data);
 
         return query;
       },
 
       /**
        * Remove an item from the document referenced at `location`. The item
        * is assumed to be an identical reference to an item already in the
        * `data` Array.
        *
        * @param {Object} data An identical reference to an item in `this.data`.
        */
       remove: function(data) {
         if (data == null || data.__firebaseKey__ == null) {
-          this._error('Failed to remove unknown value:', data);
+          // NOTE(cdata): This might be better as an error message in the
+          // console, but `Polymer.Base._error` throws, which we don't want
+          // to happen in this case.
+          this._warn('Refusing to remove unknown value:', data);
           return;
         }
 
         this._log('Removing collection item "' + data.__firebaseKey__ + '"', data.value);
 
         this.removeByKey(data.__firebaseKey__);
       },
 
       /**
        * Look up an item in the local `data` Array by key.
        *
        * @param {String} key The key associated with the item in the parent
        * document.
        */
       getByKey: function(key) {
         return this._valueMap[key];
       },
 
       /**
        * Remove an item from the document associated with `location` by key.
        *
        * @param {String} key The key associated with the item in the document
        * located at `location`.
        */
       removeByKey: function(key) {
+        if (!this.query) {
+          this._error('Cannot remove items before query has been initialized.');
+          return;
+        }
+
         this.query.ref().child(key).remove();
       },
 
-      _applyLocalDataChanges: function(change) {
+      _localDataChanged: function(change) {
         var pathParts = change.path.split('.');
-        var firebaseKey;
-        var key;
-        var value;
 
+        // We don't care about self-changes, and we don't respond directly to
+        // length changes:
         if (pathParts.length < 2 || pathParts[1] === 'length') {
           return;
         }
 
-        if (pathParts[1] === 'splices') {
-          this._applySplicesToRemoteData(change.value.indexSplices);
+        // Handle splices via the adoption process. `indexSplices` is known to
+        // sometimes be null, so guard against that.
+        if (pathParts[1] === 'splices' && change.value.indexSplices != null) {
+          this._adoptSplices(change.value.indexSplices);
           return;
         }
 
-        key = pathParts[1];
-        value = Polymer.Collection.get(change.base).getItem(key);
+        // Otherwise, the change is happening to a sub-path of the array.
+        this._applySubPathChange(change);
+      },
 
-        // Temporarily remove the client-only `__firebaseKey__` property:
-        firebaseKey = value.__firebaseKey__;
+      _applySubPathChange: function(change) {
+        var key = change.path.split('.')[1];
+        var value = Polymer.Collection.get(change.base).getItem(key);
+        var firebaseKey = value.__firebaseKey__;
+
+        // We don't want to accidentally reflect `__firebaseKey__` in the
+        // remote data, so we remove it temporarily. `null` values will be
+        // discarded by Firebase, so `delete` is not necessary:
         value.__firebaseKey__ = null;
-
         this.query.ref().child(firebaseKey).set(value);
-
         value.__firebaseKey__ = firebaseKey;
       },
 
-      _applySplicesToRemoteData: function(splices) {
-        this._log('splices', splices);
-        splices.forEach(function(splice) {
-          var added = splice.object.slice(splice.index, splice.index + splice.addedCount);
+      _adoptSplices: function(splices) {
+        this._pendingSplices = this._pendingSplices.concat(splices);
 
-          splice.removed.forEach(function(removed) {
-            this.remove(removed);
+        // We can afford apply removals synchronously, so we do that first
+        // and save the `added` operations for the `debounce` below.
+        this._applyLocalDataChange(function() {
+          splices.forEach(function(splice) {
+            splice.removed.forEach(function(removed) {
+              this.remove(removed);
+            }, this);
           }, this);
+        });
 
-          added.forEach(function(added) {
-            this.add(added);
-          }, this);
-        }, this);
+        // We async until the next turn. The reason we want to do this is
+        // that splicing within a splice handler will break the data binding
+        // system in some places. This is referred to as the "re-entrancy"
+        // problem. See polymer/polymer#2491.
+        this.debounce('_adoptSplices', function() {
+          this._applyLocalDataChange(function() {
+            var splices = this._pendingSplices;
+
+            this._pendingSplices = [];
+
+            splices.forEach(function(splice) {
+              var added = splice.object.slice(splice.index, splice.index + splice.addedCount);
+
+              added.forEach(function(added, index) {
+                this._lastLocallyAddedIndex = splice.index + index;
+                this.add(added);
+              }, this);
+            }, this);
+
+            this._lastLocallyAddedIndex = null;
+          });
+        });
       },
 
       _computeQuery: function(location, limitToFirst, limitToLast, orderByMethodName, startAt, endAt, equalTo) {
         var query;
 
         if (!location) {
           return;
         }
 
+        this._log('Recomputing query.', arguments);
+
         query = new Firebase(location);
 
         if (orderByMethodName) {
           if (orderByMethodName === 'orderByChild') {
             query = query[orderByMethodName](this.orderByChild);
           } else {
             query = query[orderByMethodName]();
           }
         }
 
@@ skipping 101 matching lines @@
 
           persistable[property] = value[property];
         }
 
         return persistable;
       },
 
       _onFirebaseChildAdded: function(event) {
         this._applyRemoteDataChange(function() {
           var value = this._valueFromSnapshot(event.detail.childSnapshot);
+          var key = value.__firebaseKey__;
           var previousValueKey = event.detail.previousChildName;
           var index = previousValueKey != null ?
             this.data.indexOf(this._valueMap[previousValueKey]) + 1 : 0;
+          var lastLocallyAddedValue;
 
           this._valueMap[value.__firebaseKey__] = value;
 
-          this.splice('data', index, 0, value);
+          // NOTE(cdata): The rationale for this conditional dance around the
+          // last locally added index (since you will inevitably be wondering
+          // why we do it):
+          // There may be a "locally" added value which was spliced in. If
+          // there is, it may be in the "wrong" place in the array. This is
+          // due to the fact that Firebase may be applying a sort to the
+          // data, so we won't know the correct index for the locally added
+          // value until the `child_added` event is fired.
+          // Once we get the `child_added` event, we can check to see if the
+          // locally added value is in the right place. If it is, we just
+          // `set` it to the Firebase-provided value. If it is not, then
+          // we grab the original value, splice in the Firebase-provided
+          // value in the right place, and then (importantly: at the end)
+          // find the locally-added value again (since its index may have
+          // changed by splicing-in Firebase's value) and splice it out of the
+          // array.
+          if (this._lastLocallyAddedIndex === index) {
+            this.set(['data', index], value);
+          } else {
+            if (this._lastLocallyAddedIndex != null) {
+              lastLocallyAddedValue = this.data[this._lastLocallyAddedIndex];
+            }
+
+            this.splice('data', index, 0, value);
+
+            if (this._lastLocallyAddedIndex != null) {
+              this.splice('data', this.data.indexOf(lastLocallyAddedValue), 1);
+            }
+          }
         });
       },
 
       _onFirebaseChildRemoved: function(event) {
+        if (this._receivingLocalChanges) {
+          this._valueMap[event.detail.oldChildSnapshot.key()] = null;
+          // NOTE(cdata): If we are receiving local changes, that means that
+          // the splices have already been performed and items are already
+          // removed from the local data representation. No need to remove
+          // them again.
+          return;
+        }
+
         this._applyRemoteDataChange(function() {
           var key = event.detail.oldChildSnapshot.key();
           var value = this._valueMap[key];
           var index;
 
           if (!value) {
             this._error('Received firebase-child-removed event for unknown child "' + key + '"');
             return;
           }
 
@@ skipping 49 matching lines @@
       }
     });
 
     FirebaseCollection.ORDER_VALUE_TYPES = {
       string: String,
       number: Number,
       boolean: Boolean
     };
   })();
 </script>