sharedb 4.1.4 → 5.0.0

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/db/memory.js

@@ -84,10 +84,12 @@ MemoryDB.prototype.getOps = function(collection, id, from, to, options, callback
   if (typeof callback !== 'function') throw new Error('Callback required');
   util.nextTick(function() {
     var opLog = db._getOpLogSync(collection, id);
-    if (to == null) {
-      to = opLog.length;
+    if (!from) from = 0;
+    if (to == null) to = opLog.length;
+    var ops = clone(opLog.slice(from, to).filter(Boolean));
+    if (ops.length < to - from) {
+      return callback(new Error('Missing ops'));
     }
-    var ops = clone(opLog.slice(from, to));
     if (!includeMetadata) {
       for (var i = 0; i < ops.length; i++) {
         delete ops[i].m;
@@ -97,6 +99,18 @@ MemoryDB.prototype.getOps = function(collection, id, from, to, options, callback
   });
 };
 
+MemoryDB.prototype.deleteOps = function(collection, id, from, to, options, callback) {
+  if (typeof callback !== 'function') throw new Error('Callback required');
+  var db = this;
+  util.nextTick(function() {
+    var opLog = db._getOpLogSync(collection, id);
+    if (!from) from = 0;
+    if (to == null) to = opLog.length;
+    for (var i = from; i < to; i++) opLog[i] = null;
+    callback(null);
+  });
+};
+
 // The memory database query function returns all documents in a collection
 // regardless of query by default
 MemoryDB.prototype.query = function(collection, query, fields, options, callback) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sharedb",
-  "version": "4.1.4",
+  "version": "5.0.0",
   "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;
@@ -144,7 +145,18 @@ describe('SnapshotVersionRequest', function() {
 
     it('errors if asking for a version that does not exist', function(done) {
       backend.connect().fetchSnapshot('books', 'don-quixote', 4, function(error, snapshot) {
-        expect(error.code).to.equal('ERR_OP_VERSION_NEWER_THAN_CURRENT_SNAPSHOT');
+        expect(error).to.be.ok;
+        expect(snapshot).to.equal(undefined);
+        done();
+      });
+    });
+
+    it('errors if asking for a version that does not exist if the DB adapter does not error', function(done) {
+      sinon.stub(MemoryDb.prototype, 'getOps').callsFake(function(collection, id, from, to, options, callback) {
+        callback(null, []);
+      });
+      backend.connect().fetchSnapshot('books', 'don-quixote', 4, function(error, snapshot) {
+        expect(error).to.be.ok;
         expect(snapshot).to.equal(undefined);
         done();
       });
@@ -440,6 +452,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/db-memory.js

@@ -1,6 +1,8 @@
 var expect = require('chai').expect;
+var Backend = require('../lib/backend');
 var DB = require('../lib/db');
 var BasicQueryableMemoryDB = require('./BasicQueryableMemoryDB');
+var async = require('async');
 
 describe('DB base class', function() {
   it('can call db.close() without callback', function() {
@@ -54,17 +56,83 @@ describe('DB base class', function() {
   });
 });
 
-// Run all the DB-based tests against the BasicQueryableMemoryDB.
-require('./db')({
-  create: function(options, callback) {
-    if (typeof options === 'function') {
-      callback = options;
-      options = null;
+describe('MemoryDB', function() {
+  // Run all the DB-based tests against the BasicQueryableMemoryDB.
+  require('./db')({
+    create: function(options, callback) {
+      if (typeof options === 'function') {
+        callback = options;
+        options = null;
+      }
+      var db = new BasicQueryableMemoryDB(options);
+      callback(null, db);
+    },
+    getQuery: function(options) {
+      return {filter: options.query, sort: options.sort};
     }
-    var db = new BasicQueryableMemoryDB(options);
-    callback(null, db);
-  },
-  getQuery: function(options) {
-    return {filter: options.query, sort: options.sort};
-  }
+  });
+
+  describe('deleteOps', function() {
+    describe('with some ops', function() {
+      var backend;
+      var db;
+      var connection;
+      var doc;
+
+      beforeEach(function(done) {
+        backend = new Backend();
+        db = backend.db;
+        connection = backend.connect();
+        doc = connection.get('dogs', 'fido');
+
+        async.waterfall([
+          doc.create.bind(doc, {name: 'Fido'}),
+          doc.submitOp.bind(doc, [{p: ['tricks'], oi: ['fetch']}]),
+          db.getOps.bind(db, 'dogs', 'fido', null, null, null),
+          function(ops, next) {
+            expect(ops).to.have.length(2);
+            next();
+          }
+        ], done);
+      });
+
+      it('deletes all ops', function(done) {
+        async.waterfall([
+          db.deleteOps.bind(db, 'dogs', 'fido', null, null, null),
+          function(next) {
+            db.getOps('dogs', 'fido', null, null, null, function(error) {
+              expect(error.message).to.equal('Missing ops');
+              next();
+            });
+          }
+        ], done);
+      });
+
+      it('deletes some ops', function(done) {
+        async.waterfall([
+          db.deleteOps.bind(db, 'dogs', 'fido', 0, 1, null),
+          db.getOps.bind(db, 'dogs', 'fido', 1, 2, null),
+          function(ops, next) {
+            expect(ops).to.have.length(1);
+            expect(ops[0].op).to.eql([{p: ['tricks'], oi: ['fetch']}]);
+            db.getOps('dogs', 'fido', 0, 1, null, function(error) {
+              expect(error.message).to.equal('Missing ops');
+              next();
+            });
+          }
+        ], done);
+      });
+
+      it('submits more ops after deleting ops', function(done) {
+        async.series([
+          db.deleteOps.bind(db, 'dogs', 'fido', null, null, null),
+          doc.submitOp.bind(doc, [{p: ['tricks', 1], li: 'sit'}]),
+          function(next) {
+            expect(doc.data.tricks).to.eql(['fetch', 'sit']);
+            next();
+          }
+        ], done);
+      });
+    });
+  });
 });