sharedb 4.1.3 → 4.1.5

package/lib/backend.js

@@ -909,7 +909,7 @@ Backend.prototype._fetchSnapshotByTimestamp = function(collection, id, timestamp
 };
 
 Backend.prototype._buildSnapshotFromOps = function(id, startingSnapshot, ops, callback) {
-  var snapshot = startingSnapshot || new Snapshot(id, 0, null, undefined, null);
+  var snapshot = util.clone(startingSnapshot) || new Snapshot(id, 0, null, undefined, null);
   var error = ot.applyOps(snapshot, ops, {_normalizeLegacyJson0Ops: true});
   callback(error, snapshot);
 };

package/lib/next-tick.js

@@ -0,0 +1,26 @@
+exports.messageChannel = function() {
+  var triggerCallback = createNextTickTrigger(arguments);
+  var channel = new MessageChannel();
+  channel.port1.onmessage = function() {
+    triggerCallback();
+    channel.port1.close();
+  };
+  channel.port2.postMessage('');
+};
+
+exports.setTimeout = function() {
+  var triggerCallback = createNextTickTrigger(arguments);
+  setTimeout(triggerCallback);
+};
+
+function createNextTickTrigger(args) {
+  var callback = args[0];
+  var _args = [];
+  for (var i = 1; i < args.length; i++) {
+    _args[i - 1] = args[i];
+  }
+
+  return function triggerCallback() {
+    callback.apply(null, _args);
+  };
+}

package/lib/op-stream.js

@@ -1,4 +1,3 @@
-var inherits = require('util').inherits;
 var Readable = require('stream').Readable;
 var util = require('./util');
 
@@ -10,7 +9,7 @@ function OpStream() {
 }
 module.exports = OpStream;
 
-inherits(OpStream, Readable);
+util.inherits(OpStream, Readable);
 
 // This function is for notifying us that the stream is empty and needs data.
 // For now, we'll just ignore the signal and assume the reader reads as fast

package/lib/stream-socket.js

@@ -1,5 +1,4 @@
 var Duplex = require('stream').Duplex;
-var inherits = require('util').inherits;
 var logger = require('./logger');
 var util = require('./util');
 
@@ -47,7 +46,7 @@ function ServerStream(socket) {
     socket.close('stopped');
   });
 }
-inherits(ServerStream, Duplex);
+util.inherits(ServerStream, Duplex);
 
 ServerStream.prototype.isServer = true;
 

package/lib/util.js

@@ -1,3 +1,4 @@
+var nextTickImpl = require('./next-tick');
 
 exports.doNothing = doNothing;
 function doNothing() {}
@@ -85,20 +86,13 @@ exports.truthy = function(arg) {
   return !!arg;
 };
 
-exports.nextTick = function(callback) {
-  if (typeof process !== 'undefined' && process.nextTick) {
-    return process.nextTick.apply(null, arguments);
-  }
-
-  var args = [];
-  for (var i = 1; i < arguments.length; i++) {
-    args[i - 1] = arguments[i];
-  }
-
-  setTimeout(function() {
-    callback.apply(null, args);
-  });
-};
+if (typeof process !== 'undefined' && typeof process.nextTick === 'function') {
+  exports.nextTick = process.nextTick;
+} else if (typeof MessageChannel !== 'undefined') {
+  exports.nextTick = nextTickImpl.messageChannel;
+} else {
+  exports.nextTick = nextTickImpl.setTimeout;
+}
 
 exports.clone = function(obj) {
   return (obj === undefined) ? undefined : JSON.parse(JSON.stringify(obj));
@@ -113,3 +107,15 @@ Object.getOwnPropertyNames(Object.prototype).forEach(function(prop) {
 exports.isDangerousProperty = function(propName) {
   return propName === '__proto__' || objectProtoPropNames[propName];
 };
+
+try {
+  var util = require('util');
+  if (typeof util.inherits !== 'function') throw new Error('Could not find util.inherits()');
+  exports.inherits = util.inherits;
+} catch (e) {
+  try {
+    exports.inherits = require('inherits');
+  } catch (e) {
+    throw new Error('If running sharedb in a browser, please install the "inherits" or "util" package');
+  }
+}

package/package.json

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

package/test/client/snapshot-version-request.js

@@ -6,6 +6,7 @@ var sinon = require('sinon');
 var async = require('async');
 var json0v2 = require('ot-json0-v2').type;
 var types = require('../../lib/types');
+var clone = require('../../lib/util').clone;
 
 describe('SnapshotVersionRequest', function() {
   var backend;
@@ -440,6 +441,39 @@ describe('SnapshotVersionRequest', function() {
       ], done);
     });
 
+    it('does not mutate the milestone snapshot', function(done) {
+      var connection = backendWithMilestones.connect();
+      var doc = connection.get('books', 'mocking-bird');
+      var milestoneDb = backendWithMilestones.milestoneDb;
+      var milestone;
+
+      async.waterfall([
+        doc.create.bind(doc, {title: 'To Kill a Mocking Bird'}),
+        doc.submitOp.bind(doc, {p: ['author'], oi: 'Harper Lea'}),
+        doc.submitOp.bind(doc, {p: ['author'], od: 'Harper Lea', oi: 'Harper Lee'}),
+        milestoneDb.getMilestoneSnapshot.bind(milestoneDb, 'books', 'mocking-bird', 3),
+        function(snapshot, next) {
+          milestone = clone(snapshot);
+          next();
+        },
+        function(next) {
+          // Internally, this calls ot.applyOps(), which mutates the snapshot it's passed.
+          // This call shouldn't cause the in-memory milestone snapshot to be mutated.
+          connection.fetchSnapshot('books', 'mocking-bird', 3, next);
+        },
+        function(snapshot, next) {
+          expect(snapshot.v).to.equal(3);
+          expect(snapshot.data).to.eql({title: 'To Kill a Mocking Bird', author: 'Harper Lee'});
+          next();
+        },
+        milestoneDb.getMilestoneSnapshot.bind(milestoneDb, 'books', 'mocking-bird', 3),
+        function(snapshot, next) {
+          expect(snapshot).to.eql(milestone);
+          next();
+        }
+      ], done);
+    });
+
     describe('with version null', function() {
       it('fetches a latest version', function(done) {
         var doc = backendWithMilestones.connect().get('books', 'mocking-bird');

package/test/next-tick.js

@@ -0,0 +1,26 @@
+var nextTickImpl = require('../lib/next-tick');
+var expect = require('chai').expect;
+
+describe('nextTick', function() {
+  ['messageChannel', 'setTimeout'].forEach(function(name) {
+    var tick = nextTickImpl[name];
+
+    it('passes args', function(done) {
+      tick(function(arg1, arg2, arg3) {
+        expect(arg1).to.equal('foo');
+        expect(arg2).to.equal(123);
+        expect(arg3).to.be.undefined;
+        done();
+      }, 'foo', 123);
+    });
+
+    it('calls asynchronously', function(done) {
+      var called = false;
+      tick(function() {
+        called = true;
+        done();
+      });
+      expect(called).to.be.false;
+    });
+  });
+});

package/test/util-test.js

@@ -1,50 +0,0 @@
-var util = require('../lib/util');
-var expect = require('chai').expect;
-
-describe('util', function() {
-  describe('nextTick', function() {
-    it('uses process.nextTick if present', function(done) {
-      expect(process.nextTick).to.be.ok;
-
-      util.nextTick(function(arg1, arg2, arg3) {
-        expect(arg1).to.equal('foo');
-        expect(arg2).to.equal(123);
-        expect(arg3).to.be.undefined;
-        done();
-      }, 'foo', 123);
-    });
-
-    describe('without nextTick', function() {
-      var nextTick;
-
-      before(function() {
-        nextTick = process.nextTick;
-        delete process.nextTick;
-      });
-
-      after(function() {
-        process.nextTick = nextTick;
-      });
-
-      it('uses a ponyfill if process.nextTick is not present', function(done) {
-        expect(process.nextTick).to.be.undefined;
-
-        util.nextTick(function(arg1, arg2, arg3) {
-          expect(arg1).to.equal('foo');
-          expect(arg2).to.equal(123);
-          expect(arg3).to.be.undefined;
-          done();
-        }, 'foo', 123);
-      });
-
-      it('calls asynchronously', function(done) {
-        var called = false;
-        util.nextTick(function() {
-          called = true;
-          done();
-        });
-        expect(called).to.be.false;
-      });
-    });
-  });
-});