sharedb 3.2.0 → 3.2.2

package/lib/client/connection.js

@@ -10,6 +10,7 @@ var ACTIONS = require('../message-actions').ACTIONS;
 var types = require('../types');
 var util = require('../util');
 var logger = require('../logger');
+var DocPresenceEmitter = require('./presence/doc-presence-emitter');
 
 var ERROR_CODE = ShareDBError.CODES;
 
@@ -51,6 +52,7 @@ function Connection(socket) {
 
   // Maps from channel -> presence objects
   this._presences = {};
+  this._docPresenceEmitter = new DocPresenceEmitter();
 
   // Map from snapshot request ID -> snapshot request
   this._snapshotRequests = {};
@@ -521,6 +523,7 @@ Connection.prototype.get = function(collection, id) {
     this.emit('doc', doc);
   }
 
+  doc._wantsDestroy = false;
   return doc;
 };
 
@@ -531,7 +534,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) {
@@ -773,17 +778,21 @@ Connection.prototype._initialize = function(message) {
 
 Connection.prototype.getPresence = function(channel) {
   var connection = this;
-  return util.digOrCreate(this._presences, channel, function() {
+  var presence = util.digOrCreate(this._presences, channel, function() {
     return new Presence(connection, channel);
   });
+  presence._wantsDestroy = false;
+  return presence;
 };
 
 Connection.prototype.getDocPresence = function(collection, id) {
   var channel = DocPresence.channel(collection, id);
   var connection = this;
-  return util.digOrCreate(this._presences, channel, function() {
+  var presence = util.digOrCreate(this._presences, channel, function() {
     return new DocPresence(connection, collection, id);
   });
+  presence._wantsDestroy = false;
+  return presence;
 };
 
 Connection.prototype._sendPresenceAction = function(action, seq, presence) {

package/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();
     }
   });

package/lib/client/presence/doc-presence-emitter.js

@@ -0,0 +1,75 @@
+var util = require('../../util');
+var EventEmitter = require('events').EventEmitter;
+
+var EVENTS = [
+  'create',
+  'del',
+  'destroy',
+  'load',
+  'op'
+];
+
+module.exports = DocPresenceEmitter;
+
+function DocPresenceEmitter() {
+  this._docs = {};
+  this._forwarders = {};
+  this._emitters = {};
+}
+
+DocPresenceEmitter.prototype.addEventListener = function(doc, event, listener) {
+  this._registerDoc(doc);
+  var emitter = util.dig(this._emitters, doc.collection, doc.id);
+  emitter.on(event, listener);
+};
+
+DocPresenceEmitter.prototype.removeEventListener = function(doc, event, listener) {
+  var emitter = util.dig(this._emitters, doc.collection, doc.id);
+  if (!emitter) return;
+  emitter.off(event, listener);
+  // We'll always have at least one, because of the destroy listener
+  if (emitter._eventsCount === 1) this._unregisterDoc(doc);
+};
+
+DocPresenceEmitter.prototype._registerDoc = function(doc) {
+  var alreadyRegistered = true;
+  util.digOrCreate(this._docs, doc.collection, doc.id, function() {
+    alreadyRegistered = false;
+    return doc;
+  });
+
+  if (alreadyRegistered) return;
+
+  var emitter = util.digOrCreate(this._emitters, doc.collection, doc.id, function() {
+    var e = new EventEmitter();
+    // Set a high limit to avoid unnecessary warnings, but still
+    // retain some degree of memory leak detection
+    e.setMaxListeners(1000);
+    return e;
+  });
+
+  var self = this;
+  EVENTS.forEach(function(event) {
+    var forwarder = util.digOrCreate(self._forwarders, doc.collection, doc.id, event, function() {
+      return emitter.emit.bind(emitter, event);
+    });
+
+    doc.on(event, forwarder);
+  });
+
+  this.addEventListener(doc, 'destroy', this._unregisterDoc.bind(this, doc));
+};
+
+DocPresenceEmitter.prototype._unregisterDoc = function(doc) {
+  var forwarders = util.dig(this._forwarders, doc.collection, doc.id);
+  for (var event in forwarders) {
+    doc.off(event, forwarders[event]);
+  }
+
+  var emitter = util.dig(this._emitters, doc.collection, doc.id);
+  emitter.removeAllListeners();
+
+  util.digAndRemove(this._forwarders, doc.collection, doc.id);
+  util.digAndRemove(this._emitters, doc.collection, doc.id);
+  util.digAndRemove(this._docs, doc.collection, doc.id);
+};

package/lib/client/presence/local-doc-presence.js

@@ -11,6 +11,7 @@ function LocalDocPresence(presence, presenceId) {
   this.id = this.presence.id;
 
   this._doc = this.connection.get(this.collection, this.id);
+  this._emitter = this.connection._docPresenceEmitter;
   this._isSending = false;
   this._docDataVersionByPresenceVersion = {};
 
@@ -43,11 +44,11 @@ LocalDocPresence.prototype.submit = function(value, callback) {
 };
 
 LocalDocPresence.prototype.destroy = function(callback) {
-  this._doc.removeListener('op', this._opHandler);
-  this._doc.removeListener('create', this._createOrDelHandler);
-  this._doc.removeListener('del', this._createOrDelHandler);
-  this._doc.removeListener('load', this._loadHandler);
-  this._doc.removeListener('destroy', this._destroyHandler);
+  this._emitter.removeEventListener(this._doc, 'op', this._opHandler);
+  this._emitter.removeEventListener(this._doc, 'create', this._createOrDelHandler);
+  this._emitter.removeEventListener(this._doc, 'del', this._createOrDelHandler);
+  this._emitter.removeEventListener(this._doc, 'load', this._loadHandler);
+  this._emitter.removeEventListener(this._doc, 'destroy', this._destroyHandler);
 
   LocalPresence.prototype.destroy.call(this, callback);
 };
@@ -72,11 +73,11 @@ LocalDocPresence.prototype._sendPending = function() {
 };
 
 LocalDocPresence.prototype._registerWithDoc = function() {
-  this._doc.on('op', this._opHandler);
-  this._doc.on('create', this._createOrDelHandler);
-  this._doc.on('del', this._createOrDelHandler);
-  this._doc.on('load', this._loadHandler);
-  this._doc.on('destroy', this._destroyHandler);
+  this._emitter.addEventListener(this._doc, 'op', this._opHandler);
+  this._emitter.addEventListener(this._doc, 'create', this._createOrDelHandler);
+  this._emitter.addEventListener(this._doc, 'del', this._createOrDelHandler);
+  this._emitter.addEventListener(this._doc, 'load', this._loadHandler);
+  this._emitter.addEventListener(this._doc, 'destroy', this._destroyHandler);
 };
 
 LocalDocPresence.prototype._transformAgainstOp = function(op, source) {

package/lib/client/presence/presence.js

@@ -24,6 +24,7 @@ function Presence(connection, channel) {
 
   this._remotePresenceInstances = {};
   this._subscriptionCallbacksBySeq = {};
+  this._wantsDestroy = false;
 }
 emitter.mixin(Presence);
 
@@ -36,6 +37,9 @@ Presence.prototype.unsubscribe = function(callback) {
 };
 
 Presence.prototype.create = function(id) {
+  if (this._wantsDestroy) {
+    throw new Error('Presence is being destroyed');
+  }
   id = id || hat();
   var localPresence = this._createLocalPresence(id);
   this.localPresences[id] = localPresence;
@@ -43,10 +47,15 @@ Presence.prototype.create = function(id) {
 };
 
 Presence.prototype.destroy = function(callback) {
+  this._wantsDestroy = true;
   var presence = this;
+  // Store these at the time of destruction: any LocalPresence on this
+  // instance at this time will be destroyed, but if the destroy is
+  // cancelled, any future LocalPresence objects will be kept.
+  // See: https://github.com/share/sharedb/pull/579
+  var localIds = Object.keys(presence.localPresences);
   this.unsubscribe(function(error) {
     if (error) return presence._callbackOrEmit(error, callback);
-    var localIds = Object.keys(presence.localPresences);
     var remoteIds = Object.keys(presence._remotePresenceInstances);
     async.parallel(
       [
@@ -56,13 +65,18 @@ Presence.prototype.destroy = function(callback) {
           }, next);
         },
         function(next) {
+          // We don't bother stashing the RemotePresence instances because
+          // they're not really bound to our local state: if we want to
+          // destroy, we destroy them all, but if we cancel the destroy,
+          // we'll want to keep them all
+          if (!presence._wantsDestroy) return next();
           async.each(remoteIds, function(presenceId, next) {
             presence._remotePresenceInstances[presenceId].destroy(next);
           }, next);
         }
       ],
       function(error) {
-        delete presence.connection._presences[presence.channel];
+        if (presence._wantsDestroy) delete presence.connection._presences[presence.channel];
         presence._callbackOrEmit(error, callback);
       }
     );

package/lib/client/presence/remote-doc-presence.js

@@ -11,6 +11,7 @@ function RemoteDocPresence(presence, presenceId) {
   this.presenceVersion = null;
 
   this._doc = this.connection.get(this.collection, this.id);
+  this._emitter = this.connection._docPresenceEmitter;
   this._pending = null;
   this._opCache = null;
   this._pendingSetPending = false;
@@ -31,19 +32,19 @@ RemoteDocPresence.prototype.receiveUpdate = function(message) {
 };
 
 RemoteDocPresence.prototype.destroy = function(callback) {
-  this._doc.removeListener('op', this._opHandler);
-  this._doc.removeListener('create', this._createDelHandler);
-  this._doc.removeListener('del', this._createDelHandler);
-  this._doc.removeListener('load', this._loadHandler);
+  this._emitter.removeEventListener(this._doc, 'op', this._opHandler);
+  this._emitter.removeEventListener(this._doc, 'create', this._createDelHandler);
+  this._emitter.removeEventListener(this._doc, 'del', this._createDelHandler);
+  this._emitter.removeEventListener(this._doc, 'load', this._loadHandler);
 
   RemotePresence.prototype.destroy.call(this, callback);
 };
 
 RemoteDocPresence.prototype._registerWithDoc = function() {
-  this._doc.on('op', this._opHandler);
-  this._doc.on('create', this._createDelHandler);
-  this._doc.on('del', this._createDelHandler);
-  this._doc.on('load', this._loadHandler);
+  this._emitter.addEventListener(this._doc, 'op', this._opHandler);
+  this._emitter.addEventListener(this._doc, 'create', this._createDelHandler);
+  this._emitter.addEventListener(this._doc, 'del', this._createDelHandler);
+  this._emitter.addEventListener(this._doc, 'load', this._loadHandler);
 };
 
 RemoteDocPresence.prototype._setPendingPresence = function() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sharedb",
-  "version": "3.2.0",
+  "version": "3.2.2",
   "description": "JSON OT database backend",
   "main": "lib/index.js",
   "dependencies": {

package/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();

package/test/client/presence/doc-presence-emitter.js

@@ -0,0 +1,100 @@
+var Backend = require('../../../lib/backend');
+var errorHandler = require('../../util').errorHandler;
+var expect = require('chai').expect;
+
+describe('DocPresenceEmitter', function() {
+  var backend;
+  var connection;
+  var doc;
+  var emitter;
+
+  beforeEach(function(done) {
+    backend = new Backend();
+    connection = backend.connect();
+    doc = connection.get('books', 'northern-lights');
+    doc.create({title: 'Northern Lights'}, done);
+    emitter = connection._docPresenceEmitter;
+  });
+
+  it('listens to an op event', function(done) {
+    emitter.addEventListener(doc, 'op', function(op) {
+      expect(op).to.eql([{p: ['author'], oi: 'Philip Pullman'}]);
+      done();
+    });
+
+    doc.submitOp([{p: ['author'], oi: 'Philip Pullman'}], errorHandler(done));
+  });
+
+  it('stops listening to events', function(done) {
+    var listener = function() {
+      done(new Error('should not reach'));
+    };
+
+    emitter.addEventListener(doc, 'op', listener);
+    emitter.removeEventListener(doc, 'op', listener);
+
+    doc.submitOp([{p: ['author'], oi: 'Philip Pullman'}], done);
+  });
+
+  it('removes the listener from the doc if there are no more listeners', function() {
+    expect(doc._eventsCount).to.equal(0);
+    var listener = function() {};
+
+    emitter.addEventListener(doc, 'op', listener);
+
+    expect(doc._eventsCount).to.be.greaterThan(0);
+    expect(emitter._docs).not.to.be.empty;
+    expect(emitter._emitters).not.to.be.empty;
+    expect(emitter._forwarders).not.to.be.empty;
+
+    emitter.removeEventListener(doc, 'op', listener);
+
+    expect(doc._eventsCount).to.equal(0);
+    expect(emitter._docs).to.be.empty;
+    expect(emitter._emitters).to.be.empty;
+    expect(emitter._forwarders).to.be.empty;
+  });
+
+  it('only registers a single listener on the doc', function() {
+    expect(doc._eventsCount).to.equal(0);
+    var listener = function() { };
+    emitter.addEventListener(doc, 'op', listener);
+    var count = doc._eventsCount;
+    emitter.addEventListener(doc, 'op', listener);
+    expect(doc._eventsCount).to.equal(count);
+  });
+
+  it('only triggers the given event', function(done) {
+    emitter.addEventListener(doc, 'op', function(op) {
+      expect(op).to.eql([{p: ['author'], oi: 'Philip Pullman'}]);
+      done();
+    });
+
+    emitter.addEventListener(doc, 'del', function() {
+      done(new Error('should not reach'));
+    });
+
+    doc.submitOp([{p: ['author'], oi: 'Philip Pullman'}], errorHandler(done));
+  });
+
+  it('removes listeners on destroy', function(done) {
+    expect(doc._eventsCount).to.equal(0);
+    var listener = function() { };
+
+    emitter.addEventListener(doc, 'op', listener);
+
+    expect(doc._eventsCount).to.be.greaterThan(0);
+    expect(emitter._docs).not.to.be.empty;
+    expect(emitter._emitters).not.to.be.empty;
+    expect(emitter._forwarders).not.to.be.empty;
+
+    doc.destroy(function(error) {
+      if (error) return done(error);
+      expect(doc._eventsCount).to.equal(0);
+      expect(emitter._docs).to.be.empty;
+      expect(emitter._emitters).to.be.empty;
+      expect(emitter._forwarders).to.be.empty;
+      done();
+    });
+  });
+});

package/test/client/presence/doc-presence.js

@@ -1025,4 +1025,14 @@ describe('DocPresence', function() {
       }
     ], done);
   });
+
+  it('does not trigger EventEmitter memory leak warnings', function() {
+    for (var i = 0; i < 100; i++) {
+      presence1.create();
+    }
+
+    expect(doc1._events.op.warned).not.to.be.ok;
+    var emitter = connection1._docPresenceEmitter._emitters[doc1.collection][doc1.id];
+    expect(emitter._events.op.warned).not.to.be.ok;
+  });
 });

package/test/client/presence/presence.js

@@ -98,6 +98,118 @@ describe('Presence', function() {
     ], done);
   });
 
+  it('gets presence during a destroy', function(done) {
+    var localPresence1 = presence1.create('presence-1');
+    var presence2a;
+
+    async.series([
+      presence2.subscribe.bind(presence2),
+      function(next) {
+        presence2.destroy(errorHandler(done));
+        next();
+      },
+      function(next) {
+        presence2a = connection2.getPresence('test-channel');
+        presence2a.subscribe(function(error) {
+          next(error);
+        });
+      },
+      function(next) {
+        localPresence1.submit({index: 5}, errorHandler(done));
+        presence2a.once('receive', function() {
+          next();
+        });
+      }
+    ], done);
+  });
+
+  it('destroys old local presence but keeps new local presence when getting during destroy', function(done) {
+    presence2.create('presence-2');
+    var presence2a;
+
+    async.series([
+      presence2.subscribe.bind(presence2),
+      function(next) {
+        presence2.destroy(function() {
+          expect(presence2).to.equal(presence2a);
+          expect(Object.keys(presence2.localPresences)).to.eql(['presence-2a']);
+          done();
+        });
+        next();
+      },
+      function(next) {
+        presence2a = connection2.getPresence('test-channel');
+        presence2a.create('presence-2a');
+        presence2a.subscribe(function(error) {
+          next(error);
+        });
+      }
+    ], errorHandler(done));
+  });
+
+  it('destroys old local presence but keeps new local presence when getting during destroy', function(done) {
+    presence2.create('presence-2');
+    var presence2a;
+
+    async.series([
+      presence2.subscribe.bind(presence2),
+      function(next) {
+        presence2.destroy(function() {
+          expect(presence2).to.equal(presence2a);
+          expect(Object.keys(presence2.localPresences)).to.eql(['presence-2a']);
+          done();
+        });
+        next();
+      },
+      function(next) {
+        presence2a = connection2.getPresence('test-channel');
+        presence2a.create('presence-2a');
+        presence2a.subscribe(function(error) {
+          next(error);
+        });
+      }
+    ], errorHandler(done));
+  });
+
+  it('throws if trying to create local presence when wanting destroy', function(done) {
+    presence2.destroy(errorHandler(done));
+    expect(function() {
+      presence2.create('presence-2');
+    }).to.throw('Presence is being destroyed');
+    done();
+  });
+
+  it('gets presence after destroy unsubscribe', function(done) {
+    var localPresence2 = presence2.create('presence-2');
+    var presence2a;
+
+    var flushLocalPresence2Destroy;
+    sinon.stub(localPresence2, 'destroy').callsFake(function(callback) {
+      flushLocalPresence2Destroy = callback;
+    });
+
+    async.series([
+      presence2.subscribe.bind(presence2),
+      function(next) {
+        presence2.destroy(function() {
+          expect(connection2.getPresence('test-channel')).to.equal(presence2a);
+          done();
+        });
+        next();
+      },
+      // Wait for the destroy unsubscribe callback to start, where we check
+      // _wantsDestroy for the first time
+      presence2.unsubscribe.bind(presence2),
+      function(next) {
+        presence2a = connection2.getPresence('test-channel');
+        presence2a.subscribe(function(error) {
+          next(error);
+        });
+        flushLocalPresence2Destroy();
+      }
+    ], errorHandler(done));
+  });
+
   it('requests existing presence from other subscribed clients when subscribing', function(done) {
     var localPresence1 = presence1.create('presence-1');
     async.series([

package/CHANGELOG.md

@@ -1,44 +0,0 @@
-## v2.0
-
-### Breaking changes
-
-* Drop Node.js v10 support
-
-## v1.0-beta
-
-### Breaking changes
-
-* Add options argument to all public database adapter methods that read
-  or write from snapshots or ops.
-
-* DB methods that get snapshots or ops no longer return metadata unless
-  `{metadata: true}` option is passed.
-
-* Replace `source` argument with `options` in doc methods. Use `options.source`
-  instead.
-
-* Backend streams now write objects intead of strings.
-
-* MemoryDB.prototype._querySync now returns `{snapshots: ..., extra: ...}`
-  instead of just an array of snapshots.
-
-### Non-breaking changes
-
-* Add options argument to backend.submit.
-
-* Add error codes to all errors.
-
-* Add `'updated'` event on queries which fires on all query result changes.
-
-* In clients, wrap errors in Error objects to they get passed through event
-  emitters.
-
-* Sanitize stack traces when sending errors to client, but log them on the
-  server.
-
-## v0.11.37
-
-Beginning of changelog.
-
-If you're upgrading from ShareJS 0.7 or earlier,
-take a look at the [ShareJS upgrade guide](docs/upgrading-from-sharejs.md).