sharedb 5.2.2 → 6.0.0

package/lib/backend.js

@@ -881,29 +881,38 @@ 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) {
+  // Always fetch the current snapshot first. We request its metadata so that we
+  // can read its mtime, which lets us serve the current snapshot directly when
+  // the requested timestamp is after it. This avoids replaying ops when they
+  // aren't needed, and - crucially - still works when older ops have been
+  // deleted/TTLed and the current version can no longer be rebuilt from ops.
+  db.getSnapshot(collection, id, null, {metadata: true}, function(error, currentSnapshot) {
     if (error) return callback(error);
-    milestoneSnapshot = snapshot;
-    if (snapshot) from = snapshot.v;
 
-    milestoneDb.getMilestoneSnapshotAtOrAfterTime(collection, id, timestamp, function(error, snapshot) {
+    var mtime = currentSnapshot.m && currentSnapshot.m.mtime;
+    var shouldGetLatestSnapshot = timestamp === null || (mtime != null && timestamp > mtime);
+    if (shouldGetLatestSnapshot) {
+      // Strip the metadata that we only fetched in order to compare the mtime,
+      // so that the returned snapshot is consistent with the op-replayed path.
+      currentSnapshot.m = null;
+      return callback(null, currentSnapshot);
+    }
+
+    milestoneDb.getMilestoneSnapshotAtOrBeforeTime(collection, id, timestamp, function(error, snapshot) {
       if (error) return callback(error);
-      if (snapshot) to = snapshot.v;
+      milestoneSnapshot = snapshot;
+      if (snapshot) from = snapshot.v;
 
-      var options = {metadata: true};
-      db.getOps(collection, id, from, to, options, function(error, ops) {
+      milestoneDb.getMilestoneSnapshotAtOrAfterTime(collection, id, timestamp, function(error, snapshot) {
         if (error) return callback(error);
-        filterOpsInPlaceBeforeTimestamp(ops, timestamp);
-        backend._buildSnapshotFromOps(id, milestoneSnapshot, ops, callback);
+        if (snapshot) to = snapshot.v;
+
+        var options = {metadata: true};
+        db.getOps(collection, id, from, to, options, function(error, ops) {
+          if (error) return callback(error);
+          filterOpsInPlaceBeforeTimestamp(ops, timestamp);
+          backend._buildSnapshotFromOps(id, milestoneSnapshot, ops, callback);
+        });
       });
     });
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sharedb",
-  "version": "5.2.2",
+  "version": "6.0.0",
   "description": "JSON OT database backend",
   "main": "lib/index.js",
   "dependencies": {
@@ -11,18 +11,18 @@
     "ot-json0": "^1.1.0"
   },
   "devDependencies": {
-    "chai": "^4.3.7",
-    "coveralls": "^3.1.1",
-    "eslint": "^8.47.0",
+    "@eslint/js": "^10.0.1",
+    "chai": "^6.2.2",
+    "eslint": "^10.1.0",
     "eslint-config-google": "^0.14.0",
-    "mocha": "^10.2.0",
-    "nyc": "^15.1.0",
+    "mocha": "^11.7.5",
+    "nyc": "^18.0.0",
     "ot-json0-v2": "https://github.com/ottypes/json0#90a3ae26364c4fa3b19b6df34dad46707a704421",
     "ot-json1": "^1.0.2",
     "rich-text": "^4.1.0",
     "sharedb-legacy": "npm:sharedb@1.1.0",
-    "sinon": "^15.2.0",
-    "sinon-chai": "^3.7.0"
+    "sinon": "^21.0.3",
+    "sinon-chai": "^4.0.1"
   },
   "files": [
     "lib/",
@@ -34,8 +34,8 @@
     "docs:start": "cd docs && bundle exec jekyll serve --livereload",
     "test": "mocha",
     "test-cover": "nyc --temp-dir=coverage -r text -r lcov npm test",
-    "lint": "./node_modules/.bin/eslint --ignore-path .gitignore '**/*.js'",
-    "lint:fix": "npm run lint -- --fix"
+    "lint": "eslint",
+    "lint:fix": "eslint --fix"
   },
   "repository": {
     "type": "git",

package/test/client/query-subscribe.js

@@ -13,6 +13,9 @@ module.exports = function(options) {
     });
 
     afterEach(function() {
+      if (sinon.clock) {
+        sinon.clock.uninstall();
+      }
       sinon.restore();
     });
 
@@ -517,7 +520,7 @@ function commonTests(options) {
   });
 
   it('pollDebounce option reduces subsequent poll interval', function(done) {
-    var clock = sinon.useFakeTimers();
+    var clock = util.useFakeTimers();
     var connection = this.backend.connect();
     this.backend.db.canPollDoc = function() {
       return false;
@@ -539,7 +542,7 @@ function commonTests(options) {
           connection.get('items', i.toString()).on('error', done).create({}, function(err) {
             if (err) return done(err);
             counter++;
-            if (counter === 9) clock.tickAsync(10000);
+            if (counter === 9) clock.tick(10000);
           });
         }
       }
@@ -561,12 +564,12 @@ function commonTests(options) {
     // event firing the first time, while sharedb is definitely
     // debouncing
     connection.get('items', '0').on('error', done).create({}, function() {
-      clock.tickAsync(3000);
+      clock.tick(3000);
     });
   });
 
   it('db.pollDebounce option reduces subsequent poll interval', function(done) {
-    var clock = sinon.useFakeTimers();
+    var clock = util.useFakeTimers();
     var connection = this.backend.connect();
     this.backend.db.canPollDoc = function() {
       return false;
@@ -589,7 +592,7 @@ function commonTests(options) {
           connection.get('items', i.toString()).on('error', done).create({}, function(err) {
             if (err) return done(err);
             counter++;
-            if (counter === 9) clock.tickAsync(10000);
+            if (counter === 9) clock.tick(10000);
           });
         }
       }
@@ -611,12 +614,12 @@ function commonTests(options) {
     // event firing the first time, while sharedb is definitely
     // debouncing
     connection.get('items', '0').on('error', done).create({}, function() {
-      clock.tickAsync(3000);
+      clock.tick(3000);
     });
   });
 
   it('pollInterval updates a subscribed query after an unpublished create', function(done) {
-    var clock = sinon.useFakeTimers();
+    var clock = util.useFakeTimers();
     var connection = this.backend.connect();
     this.backend.suppressPublish = true;
     var query = connection.createSubscribeQuery(
@@ -626,7 +629,7 @@ function commonTests(options) {
       function(err) {
         if (err) return done(err);
         connection.get('dogs', 'fido').on('error', done).create({}, function() {
-          clock.tickAsync(51);
+          clock.tick(51);
         });
       }
     );
@@ -638,7 +641,7 @@ function commonTests(options) {
   });
 
   it('db.pollInterval updates a subscribed query after an unpublished create', function(done) {
-    var clock = sinon.useFakeTimers();
+    var clock = util.useFakeTimers();
     var connection = this.backend.connect();
     this.backend.suppressPublish = true;
     this.backend.db.pollDebounce = 0;
@@ -646,7 +649,7 @@ function commonTests(options) {
     var query = connection.createSubscribeQuery('dogs', this.matchAllDbQuery, null, function(err) {
       if (err) return done(err);
       connection.get('dogs', 'fido').on('error', done).create({}, function() {
-        clock.tickAsync(51);
+        clock.tick(51);
       });
     });
     query.on('error', done);
@@ -657,7 +660,7 @@ function commonTests(options) {
   });
 
   it('pollInterval captures additional unpublished creates', function(done) {
-    var clock = sinon.useFakeTimers();
+    var clock = util.useFakeTimers();
     var connection = this.backend.connect();
     this.backend.suppressPublish = true;
     var count = 0;
@@ -667,7 +670,7 @@ function commonTests(options) {
       var doc = connection.get('dogs', count.toString()).on('error', done);
       doc.create({}, function(e) {
         if (e) return done(e);
-        clock.tickAsync(2000);
+        clock.tick(2000);
       });
     });
     query.on('error', done);
@@ -677,10 +680,10 @@ function commonTests(options) {
       var doc = connection.get('dogs', count.toString()).on('error', done);
       doc.create({}, function(e) {
         if (e) return done(e);
-        clock.tickAsync(10000);
+        clock.tick(10000);
       });
     });
-    clock.tickAsync(1);
+    clock.tick(1);
   });
 
   it('query extra is returned to client', function(done) {

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

@@ -2,6 +2,7 @@ var Backend = require('../../lib/backend');
 var expect = require('chai').expect;
 var MemoryDb = require('../../lib/db/memory');
 var MemoryMilestoneDb = require('../../lib/milestone-db/memory');
+var util = require('../util');
 var sinon = require('sinon');
 var async = require('async');
 
@@ -17,12 +18,12 @@ describe('SnapshotTimestampRequest', function() {
   var ONE_DAY = 1000 * 60 * 60 * 24;
 
   beforeEach(function() {
-    clock = sinon.useFakeTimers(day1);
+    clock = util.useFakeTimers(day1);
     backend = new Backend();
   });
 
   afterEach(function(done) {
-    clock.uninstall();
+    sinon.restore();
     backend.close(done);
   });
 
@@ -138,6 +139,21 @@ describe('SnapshotTimestampRequest', function() {
       ], done);
     });
 
+    it('fetches the current snapshot when ops are missing and the timestamp is after the latest op', function(done) {
+      var connection = backend.connect();
+      async.series([
+        // Simulate ops having been deleted/TTLed so the snapshot can't be rebuilt from ops.
+        backend.db.deleteOps.bind(backend.db, 'books', 'time-machine', null, null, null),
+        function(next) {
+          connection.fetchSnapshotByTimestamp('books', 'time-machine', day4, function(error, snapshot) {
+            if (error) return next(error);
+            expect(snapshot).to.eql(v3);
+            next();
+          });
+        }
+      ], done);
+    });
+
     it('fetches the most recent version when not specifying a timestamp', function(done) {
       var connection = backend.connect();
       async.waterfall([

package/test/setup.js

@@ -3,7 +3,7 @@ var sinon = require('sinon');
 var sinonChai = require('sinon-chai');
 var chai = require('chai');
 
-chai.use(sinonChai);
+chai.use(sinonChai.default);
 
 if (process.env.LOGGING !== 'true') {
   // Silence the logger for tests by setting all its methods to no-ops
@@ -15,5 +15,8 @@ if (process.env.LOGGING !== 'true') {
 }
 
 afterEach(function() {
+  if (sinon.clock) {
+    sinon.clock.uninstall();
+  }
   sinon.restore();
 });

package/test/util.js

@@ -1,3 +1,4 @@
+var sinon = require('sinon');
 
 exports.sortById = function(docs) {
   return docs.slice().sort(function(a, b) {
@@ -15,6 +16,25 @@ exports.pluck = function(docs, key) {
   return values;
 };
 
+/**
+ * @param {Parameters<typeof sinon.useFakeTimers>[0]} config
+ * @see {@link sinon.useFakeTimers}
+ * @see {@link https://github.com/sinonjs/fake-timers#clocksettickmodemode}
+ */
+exports.useFakeTimers = function(config) {
+  if (config == null) {
+    config = {};
+  } else if (typeof config !== 'object') {
+    // Number or Date
+    config = {now: config};
+  }
+  if (config.toFake == null) {
+    config.toFake = ['setTimeout', 'clearTimeout', 'setInterval', 'clearInterval', 'Date'];
+  }
+  var clock = sinon.useFakeTimers(config);
+  return clock;
+};
+
 // Wrap a done function to call back only after a specified number of calls.
 // For example, `var callbackAfter = callAfter(1, callback)` means that if
 // `callbackAfter` is called once, it won't call back. If it is called twice

package/test/.jshintrc

@@ -1,22 +0,0 @@
-{
-  "node": true,
-  "laxcomma": true,
-  "eqnull": true,
-  "eqeqeq": true,
-  "indent": 2,
-  "newcap": true,
-  "quotmark": "single",
-  "undef": true,
-  "trailing": true,
-  "shadow": true,
-  "expr": true,
-  "boss": true,
-  "globals": {
-    "describe": false,
-    "it": false,
-    "before": false,
-    "after": false,
-    "beforeEach": false,
-    "afterEach": false
-  }
-}