sharedb 2.2.3 → 3.0.0

package/lib/backend.js

@@ -772,6 +772,16 @@ Backend.prototype._fetchSnapshot = function(collection, id, version, callback) {
   var db = this.db;
   var backend = this;
 
+  var shouldGetLatestSnapshot = version === null;
+  if (shouldGetLatestSnapshot) {
+    return backend.db.getSnapshot(collection, id, null, null, function(error, snapshot) {
+      if (error) return callback(error);
+
+      callback(null, snapshot);
+    });
+  }
+
+
   this.milestoneDb.getMilestoneSnapshot(collection, id, version, function(error, milestoneSnapshot) {
     if (error) return callback(error);
 
@@ -833,6 +843,15 @@ Backend.prototype._fetchSnapshotByTimestamp = function(collection, id, timestamp
   var from = 0;
   var to = null;
 
+  var shouldGetLatestSnapshot = timestamp === null;
+  if (shouldGetLatestSnapshot) {
+    return backend.db.getSnapshot(collection, id, null, null, function(error, snapshot) {
+      if (error) return callback(error);
+
+      callback(null, snapshot);
+    });
+  }
+
   milestoneDb.getMilestoneSnapshotAtOrBeforeTime(collection, id, timestamp, function(error, snapshot) {
     if (error) return callback(error);
     milestoneSnapshot = snapshot;
@@ -883,10 +902,6 @@ function pluckIds(snapshots) {
 }
 
 function filterOpsInPlaceBeforeTimestamp(ops, timestamp) {
-  if (timestamp === null) {
-    return;
-  }
-
   for (var i = 0; i < ops.length; i++) {
     var op = ops[i];
     var opTimestamp = op.m && op.m.ts;

package/lib/client/doc.js

@@ -624,6 +624,8 @@ Doc.prototype._otApply = function(op, source) {
       for (var i = 0; i < op.op.length; i++) {
         var component = op.op[i];
         var componentOp = {op: [component]};
+        // Apply the individual op component
+        this.emit('before op', componentOp.op, source, op.src);
         // Transform componentOp against any ops that have been submitted
         // sychronously inside of an op event handler since we began apply of
         // our operation
@@ -631,8 +633,6 @@ Doc.prototype._otApply = function(op, source) {
           var transformErr = transformX(this.applyStack[j], componentOp);
           if (transformErr) return this._hardRollback(transformErr);
         }
-        // Apply the individual op component
-        this.emit('before op', componentOp.op, source, op.src);
         this._setData(this.type.apply(this.data, componentOp.op));
         this.emit('op', componentOp.op, source, op.src);
       }

package/package.json

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

package/test/client/doc.js

@@ -214,6 +214,36 @@ describe('Doc', function() {
       });
     });
 
+    it('remote ops are transformed by ops submitted in `before op` event handlers', function(done) {
+      var doc = this.doc;
+      var doc2 = this.doc2;
+      var doc3 = this.doc3;
+      function beforeOpHandler(op, source) {
+        if (source) {
+          return;
+        }
+        doc.off('before op', beforeOpHandler);
+        doc.submitOp({p: ['list', 0], li: 2}, {source: true});
+      }
+      function opHandler(op, source) {
+        if (source) {
+          return;
+        }
+        doc.off('op', opHandler);
+        doc.submitOp({p: ['list', 0], li: 3}, {source: true});
+      }
+      doc2.submitOp({p: ['list'], oi: []}, function() {
+        doc.fetch(function() {
+          doc.on('before op', beforeOpHandler);
+          doc.on('op', opHandler);
+          doc2.submitOp([{p: ['list', 0], li: 1}, {p: ['list', 1], li: 42}], function() {
+            doc.fetch();
+            verifyConsistency(doc, doc2, doc3, [], done);
+          });
+        });
+      });
+    });
+
     it('remote multi component ops are transformed by ops submitted in `op` event handlers', function(done) {
       var doc = this.doc;
       var doc2 = this.doc2;

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

@@ -490,6 +490,54 @@ describe('SnapshotTimestampRequest', function() {
             done();
           });
       });
+
+      describe('when timestamp is null', function() {
+        it('fetches latest snapshot', function(done) {
+          sinon.spy(milestoneDb, 'getMilestoneSnapshotAtOrBeforeTime');
+          sinon.spy(milestoneDb, 'getMilestoneSnapshotAtOrAfterTime');
+          sinon.spy(db, 'getOps');
+
+          backendWithMilestones.connect()
+            .fetchSnapshotByTimestamp('books', 'mocking-bird', null, function(error, snapshot) {
+              if (error) return done(error);
+
+              expect(milestoneDb.getMilestoneSnapshotAtOrBeforeTime.called).to.be.false;
+              expect(milestoneDb.getMilestoneSnapshotAtOrAfterTime.called).to.be.false;
+              expect(db.getOps.called).to.be.false;
+
+              expect(snapshot.v).to.equal(5);
+              expect(snapshot.data).to.eql({
+                title: 'To Kill a Mocking Bird',
+                author: 'Harper Lee',
+                year: 1960
+              });
+
+              done();
+            });
+        });
+
+        it('returns error if getSnapshot fails', function(done) {
+          sinon.spy(milestoneDb, 'getMilestoneSnapshotAtOrBeforeTime');
+          sinon.spy(milestoneDb, 'getMilestoneSnapshotAtOrAfterTime');
+          sinon.spy(db, 'getOps');
+
+          sinon.stub(db, 'getSnapshot').callsFake(function(_collection, _id, _fields, _options, callback) {
+            callback(new Error('TEST_ERROR'));
+          });
+
+          backendWithMilestones.connect()
+            .fetchSnapshotByTimestamp('books', 'mocking-bird', null, function(error) {
+              expect(error.message).to.be.equal('TEST_ERROR');
+
+              expect(milestoneDb.getMilestoneSnapshotAtOrBeforeTime.called).to.be.false;
+              expect(milestoneDb.getMilestoneSnapshotAtOrAfterTime.called).to.be.false;
+              expect(db.getOps.called).to.be.false;
+              expect(db.getSnapshot.called).to.be.true;
+
+              done();
+            });
+        });
+      });
     });
   });
 });

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

@@ -439,6 +439,60 @@ describe('SnapshotVersionRequest', function() {
         }
       ], done);
     });
+
+    describe('with version null', function() {
+      it('fetches a latest version', function(done) {
+        var doc = backendWithMilestones.connect().get('books', 'mocking-bird');
+
+        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'}),
+          function(next) {
+            sinon.spy(milestoneDb, 'getMilestoneSnapshot');
+            sinon.spy(db, 'getOps');
+            backendWithMilestones.connect().fetchSnapshot('books', 'mocking-bird', null, next);
+          },
+          function(snapshot, next) {
+            expect(milestoneDb.getMilestoneSnapshot.called).to.be.false;
+            expect(db.getOps.called).to.be.false;
+            expect(snapshot.v).to.equal(3);
+            expect(snapshot.data).to.eql({
+              title: 'To Kill a Mocking Bird',
+              author: 'Harper Lee'
+            });
+            next();
+          }
+        ], done);
+      });
+
+      it('return error if getSnapshot fails', function(done) {
+        var doc = backendWithMilestones.connect().get('books', 'mocking-bird');
+
+        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'}),
+          function(next) {
+            sinon.spy(milestoneDb, 'getMilestoneSnapshot');
+            sinon.spy(db, 'getOps');
+            sinon.stub(db, 'getSnapshot').callsFake(function(_collection, _id, _fields, _options, callback) {
+              callback(new Error('TEST_ERROR'));
+            });
+            backendWithMilestones.connect().fetchSnapshot('books', 'mocking-bird', null, function(error) {
+              expect(error.message).to.be.equal('TEST_ERROR');
+              next(null, null);
+            });
+          },
+          function(snapshot, next) {
+            expect(milestoneDb.getMilestoneSnapshot.called).to.be.false;
+            expect(db.getOps.called).to.be.false;
+            expect(db.getSnapshot.called).to.be.true;
+            next();
+          }
+        ], done);
+      });
+    });
   });
 
   describe('invalid json0v2 path', function() {

package/test/ot.js

@@ -373,118 +373,250 @@ describe('ot', function() {
   });
 
   describe('applyOps', function() {
-    it('applies an op to a snapshot', function() {
-      var snapshot = {
-        type: 'json0',
-        data: {title: 'Wee Free Men'}
-      };
+    describe('with normalization turned on', function() {
+      it('applies an op to a snapshot', function() {
+        var snapshot = {
+          type: 'http://sharejs.org/types/JSONv0',
+          data: {title: 'Wee Free Men'}
+        };
+
+        var ops = [
+          {
+            v: 1,
+            op: [{p: ['title', 0], si: 'The '}]
+          }
+        ];
+
+        var error = ot.applyOps(snapshot, ops, {
+          _normalizeLegacyJson0Ops: true
+        });
+        expect(error).to.be.undefined;
+        expect(snapshot.data).to.eql({title: 'The Wee Free Men'});
+        expect(snapshot.v).to.equal(2);
+      });
 
-      var ops = [
-        {
-          v: 1,
-          op: [{p: ['title', 0], si: 'The '}]
-        }
-      ];
+      it('applies multiple ops', function() {
+        var snapshot = {
+          type: 'http://sharejs.org/types/JSONv0',
+          data: {title: 'Wee Free Men'}
+        };
+
+        var ops = [
+          {
+            v: 1,
+            op: [{p: ['title', 0], si: 'The '}]
+          },
+          {
+            v: 2,
+            op: [{p: ['author'], oi: 'Terry Pratchett'}]
+          }
+        ];
+
+        ot.applyOps(snapshot, ops, {
+          _normalizeLegacyJson0Ops: true
+        });
+        expect(snapshot.data).to.eql({
+          author: 'Terry Pratchett',
+          title: 'The Wee Free Men'
+        });
+        expect(snapshot.v).to.equal(3);
+      });
 
-      var error = ot.applyOps(snapshot, ops);
-      expect(error).to.be.undefined;
-      expect(snapshot.data).to.eql({title: 'The Wee Free Men'});
-      expect(snapshot.v).to.equal(2);
-    });
+      it('applies a del to a snapshot', function() {
+        var snapshot = {
+          type: 'http://sharejs.org/types/JSONv0',
+          data: {title: 'Wee Free Men'}
+        };
 
-    it('applies multiple ops', function() {
-      var snapshot = {
-        type: 'json0',
-        data: {title: 'Wee Free Men'}
-      };
+        var ops = [{v: 1, del: true}];
 
-      var ops = [
-        {
-          v: 1,
-          op: [{p: ['title', 0], si: 'The '}]
-        },
-        {
-          v: 2,
-          op: [{p: ['author'], oi: 'Terry Pratchett'}]
-        }
-      ];
-
-      ot.applyOps(snapshot, ops);
-      expect(snapshot.data).to.eql({
-        author: 'Terry Pratchett',
-        title: 'The Wee Free Men'
+        ot.applyOps(snapshot, ops, {
+          _normalizeLegacyJson0Ops: true
+        });
+        expect(snapshot.data).to.be.undefined;
       });
-      expect(snapshot.v).to.equal(3);
-    });
 
-    it('applies a del to a snapshot', function() {
-      var snapshot = {
-        type: 'json0',
-        data: {title: 'Wee Free Men'}
-      };
+      it('applies a create to a snapshot', function() {
+        var snapshot = {};
+        var ops = [
+          {
+            v: 1,
+            create: {
+              type: 'http://sharejs.org/types/JSONv0',
+              data: {title: 'Wee Free Men'}
+            }
+          }
+        ];
 
-      var ops = [{v: 1, del: true}];
+        ot.applyOps(snapshot, ops, {
+          _normalizeLegacyJson0Ops: true
+        });
+        expect(snapshot.data).to.eql({title: 'Wee Free Men'});
+      });
 
-      ot.applyOps(snapshot, ops);
-      expect(snapshot.data).to.be.undefined;
-    });
+      it('returns an error if the snapshot has an unknown type', function() {
+        var snapshot = {type: 'unknown-type', data: {}};
+        var ops = [
+          {
+            v: 1,
+            op: [{p: ['title'], oi: 'Title'}]
+          }
+        ];
+        var error = ot.applyOps(snapshot, ops, {
+          _normalizeLegacyJson0Ops: true
+        });
+        expect(error.code).to.equal(ERROR_CODE.ERR_DOC_TYPE_NOT_RECOGNIZED);
+      });
 
-    it('applies a create to a snapshot', function() {
-      var snapshot = {};
-      var ops = [
-        {
-          v: 1,
-          create: {
-            type: 'json0',
-            data: {title: 'Wee Free Men'}
+      it('returns an error if a create op has an unknown type', function() {
+        var snapshot = {};
+        var ops = [
+          {
+            v: 1,
+            create: {
+              type: 'unknown-type',
+              data: {}
+            }
           }
-        }
-      ];
+        ];
+        var error = ot.applyOps(snapshot, ops, {
+          _normalizeLegacyJson0Ops: true
+        });
+        expect(error.code).to.equal(ERROR_CODE.ERR_DOC_TYPE_NOT_RECOGNIZED);
+      });
 
-      ot.applyOps(snapshot, ops);
-      expect(snapshot.data).to.eql({title: 'Wee Free Men'});
-    });
+      it('catches and returns an error thrown by type.apply', function() {
+        var snapshot = {
+          type: 'http://sharejs.org/types/JSONv0',
+          data: {title: 'Wee Free Men'}
+        };
 
-    it('returns an error if the snapshot has an unknown type', function() {
-      var snapshot = {type: 'unknown-type', data: {}};
-      var ops = [
-        {
+        var ops = [{
           v: 1,
-          op: [{p: ['title'], oi: 'Title'}]
-        }
-      ];
-      var error = ot.applyOps(snapshot, ops);
-      expect(error.code).to.equal(ERROR_CODE.ERR_DOC_TYPE_NOT_RECOGNIZED);
+          op: [{p: ['title'], li: 'not a list'}]
+        }];
+
+        var error = ot.applyOps(snapshot, ops, {
+          _normalizeLegacyJson0Ops: true
+        });
+        expect(error.code).to.equal(ERROR_CODE.ERR_OT_OP_NOT_APPLIED);
+      });
     });
 
-    it('returns an error if a create op has an unknown type', function() {
-      var snapshot = {};
-      var ops = [
-        {
-          v: 1,
-          create: {
-            type: 'unknown-type',
-            data: {}
+    describe('with normalization turned off', function() {
+      it('applies an op to a snapshot', function() {
+        var snapshot = {
+          type: 'json0',
+          data: {title: 'Wee Free Men'}
+        };
+
+        var ops = [
+          {
+            v: 1,
+            op: [{p: ['title', 0], si: 'The '}]
           }
-        }
-      ];
-      var error = ot.applyOps(snapshot, ops);
-      expect(error.code).to.equal(ERROR_CODE.ERR_DOC_TYPE_NOT_RECOGNIZED);
-    });
+        ];
 
-    it('catches and returns an error thrown by type.apply', function() {
-      var snapshot = {
-        type: 'json0',
-        data: {title: 'Wee Free Men'}
-      };
+        var error = ot.applyOps(snapshot, ops);
+        expect(error).to.be.undefined;
+        expect(snapshot.data).to.eql({title: 'The Wee Free Men'});
+        expect(snapshot.v).to.equal(2);
+      });
+
+      it('applies multiple ops', function() {
+        var snapshot = {
+          type: 'json0',
+          data: {title: 'Wee Free Men'}
+        };
+
+        var ops = [
+          {
+            v: 1,
+            op: [{p: ['title', 0], si: 'The '}]
+          },
+          {
+            v: 2,
+            op: [{p: ['author'], oi: 'Terry Pratchett'}]
+          }
+        ];
+
+        ot.applyOps(snapshot, ops);
+        expect(snapshot.data).to.eql({
+          author: 'Terry Pratchett',
+          title: 'The Wee Free Men'
+        });
+        expect(snapshot.v).to.equal(3);
+      });
 
-      var ops = [{
-        v: 1,
-        op: [{p: ['title'], li: 'not a list'}]
-      }];
+      it('applies a del to a snapshot', function() {
+        var snapshot = {
+          type: 'json0',
+          data: {title: 'Wee Free Men'}
+        };
 
-      var error = ot.applyOps(snapshot, ops);
-      expect(error.code).to.equal(ERROR_CODE.ERR_OT_OP_NOT_APPLIED);
+        var ops = [{v: 1, del: true}];
+
+        ot.applyOps(snapshot, ops);
+        expect(snapshot.data).to.be.undefined;
+      });
+
+      it('applies a create to a snapshot', function() {
+        var snapshot = {};
+        var ops = [
+          {
+            v: 1,
+            create: {
+              type: 'json0',
+              data: {title: 'Wee Free Men'}
+            }
+          }
+        ];
+
+        ot.applyOps(snapshot, ops);
+        expect(snapshot.data).to.eql({title: 'Wee Free Men'});
+      });
+
+      it('returns an error if the snapshot has an unknown type', function() {
+        var snapshot = {type: 'unknown-type', data: {}};
+        var ops = [
+          {
+            v: 1,
+            op: [{p: ['title'], oi: 'Title'}]
+          }
+        ];
+        var error = ot.applyOps(snapshot, ops);
+        expect(error.code).to.equal(ERROR_CODE.ERR_DOC_TYPE_NOT_RECOGNIZED);
+      });
+
+      it('returns an error if a create op has an unknown type', function() {
+        var snapshot = {};
+        var ops = [
+          {
+            v: 1,
+            create: {
+              type: 'unknown-type',
+              data: {}
+            }
+          }
+        ];
+        var error = ot.applyOps(snapshot, ops);
+        expect(error.code).to.equal(ERROR_CODE.ERR_DOC_TYPE_NOT_RECOGNIZED);
+      });
+
+      it('catches and returns an error thrown by type.apply', function() {
+        var snapshot = {
+          type: 'json0',
+          data: {title: 'Wee Free Men'}
+        };
+
+        var ops = [{
+          v: 1,
+          op: [{p: ['title'], li: 'not a list'}]
+        }];
+
+        var error = ot.applyOps(snapshot, ops);
+        expect(error.code).to.equal(ERROR_CODE.ERR_OT_OP_NOT_APPLIED);
+      });
     });
   });
 });