Merge pull request #580 from share/destroying-docs

🐛 Allow getting a `Doc` while it's being destroyed

Author: alecgibson

lib/client/connection.js

@@ -521,6 +521,7 @@ Connection.prototype.get = function(collection, id) {
     this.emit('doc', doc);
   }
 
+  doc._wantsDestroy = false;
   return doc;
 };
 
@@ -531,7 +532,9 @@ Connection.prototype.get = function(collection, id) {
  * @private
  */
 Connection.prototype._destroyDoc = function(doc) {
+  if (!doc._wantsDestroy) return;
   util.digAndRemove(this.collections, doc.collection, doc.id);
+  doc.emit('destroy');
 };
 
 Connection.prototype._addDoc = function(doc) {

lib/client/doc.js

@@ -76,6 +76,8 @@ function Doc(connection, collection, id) {
   // Whether to re-establish the subscription on reconnect
   this.wantSubscribe = false;
 
+  this._wantsDestroy = false;
+
   // The op that is currently roundtripping to the server, or null.
   //
   // When the connection reconnects, the inflight op is resubmitted.
@@ -122,6 +124,7 @@ function Doc(connection, collection, id) {
 emitter.mixin(Doc);
 
 Doc.prototype.destroy = function(callback) {
+  this._wantsDestroy = true;
   var doc = this;
   doc.whenNothingPending(function() {
     if (doc.wantSubscribe) {
@@ -131,12 +134,10 @@ Doc.prototype.destroy = function(callback) {
           return doc.emit('error', err);
         }
         doc.connection._destroyDoc(doc);
-        doc.emit('destroy');
         if (callback) callback();
       });
     } else {
       doc.connection._destroyDoc(doc);
-      doc.emit('destroy');
       if (callback) callback();
     }
   });

test/client/doc.js

@@ -43,11 +43,31 @@ describe('Doc', function() {
       if (err) return done(err);
       var doc2 = connection.get('dogs', 'fido');
       expect(doc).not.equal(doc2);
-      expect(doc).eql(doc2);
       done();
     });
   });
 
+  it('destroying then getting synchronously does not destroy the new doc', function(done) {
+    var connection = this.connection;
+    var doc = connection.get('dogs', 'fido');
+    var doc2;
+
+    doc.create({name: 'fido'}, function(error) {
+      if (error) return done(error);
+
+      doc.destroy(function(error) {
+        if (error) return done(error);
+        var doc3 = connection.get('dogs', 'fido');
+        async.parallel([
+          doc2.submitOp.bind(doc2, [{p: ['snacks'], oi: true}]),
+          doc3.submitOp.bind(doc3, [{p: ['color'], oi: 'gray'}])
+        ], done);
+      });
+
+      doc2 = connection.get('dogs', 'fido');
+    });
+  });
+
   it('doc.destroy() works without a callback', function() {
     var doc = this.connection.get('dogs', 'fido');
     doc.destroy();