Refactor stop()

Author: vweevers

level-ttl.js

@@ -26,7 +26,7 @@ function buildQuery (db) {
   }
 }
 
-function startTtl (db, checkFrequency) {
+function startTtl (db, checkFrequency, setInterval) {
   db._ttl.intervalId = setInterval(function () {
     if (db._ttl._checkInProgress) return
 
@@ -80,15 +80,7 @@ function startTtl (db, checkFrequency) {
       if (err) db.emit('error', err)
 
       db._ttl._checkInProgress = false
-
-      // Exposed for unit tests
-      // TODO: also use this for _stopAfterCheck
       db.emit('ttl:sweep')
-
-      if (db._ttl._stopAfterCheck) {
-        stopTtl(db, db._ttl._stopAfterCheck)
-        db._ttl._stopAfterCheck = null
-      }
     }
   }, checkFrequency)
 
@@ -98,15 +90,15 @@ function startTtl (db, checkFrequency) {
 }
 
 function stopTtl (db, callback) {
+  db._ttl.options.clearInterval.call(null, db._ttl.intervalId)
+
   // can't close a db while an interator is in progress
   // so if one is, defer
   if (db._ttl._checkInProgress) {
-    db._ttl._stopAfterCheck = callback
-    // TODO do we really need to return the callback here?
-    return db._ttl._stopAfterCheck
+    db.once('ttl:sweep', callback)
+  } else {
+    process.nextTick(callback)
   }
-  clearInterval(db._ttl.intervalId)
-  callback()
 }
 
 function ttlon (db, keys, ttl, callback) {
@@ -268,6 +260,7 @@ function close (db, callback) {
   }
 
   stopTtl(db, function () {
+    // TODO: when/why is db._ttl not defined?
     if (db._ttl && typeof db._ttl.close === 'function') {
       return db._ttl.close.call(db, callback)
     }
@@ -286,6 +279,8 @@ function setup (db, options) {
     expiryNamespace: 'x',
     separator: '!',
     checkFrequency: 10000,
+    setInterval: global.setInterval,
+    clearInterval: global.clearInterval,
     defaultTTL: 0
   }, options)
 
@@ -312,7 +307,7 @@ function setup (db, options) {
   // we must intercept close()
   db.close = close.bind(null, db)
 
-  startTtl(db, options.checkFrequency)
+  startTtl(db, options.checkFrequency, options.setInterval)
 
   return db
 }

test.js

@@ -517,57 +517,38 @@ test.skip('del removes both key and its ttl meta data (custom ttlEncoding)', fun
   }, { valueEncoding: 'utf8' })
 }, { keyEncoding: 'utf8', valueEncoding: 'json', ttlEncoding: bytewise })
 
-// TODO: rewrite to be less sensitive and more a unit test
-// eslint-disable-next-line no-unused-vars
-function wrappedTest () {
-  var intervals = 0
-  var _setInterval = global.setInterval
-  var _clearInterval = global.clearInterval
-
-  global.setInterval = function () {
-    intervals++
-    return _setInterval.apply(global, arguments)
-  }
-
-  global.clearInterval = function () {
-    intervals--
-    return _clearInterval.apply(global, arguments)
-  }
+{
+  let intervals = 0
 
-  test('test stop() method stops interval and doesn\'t hold process up', function (t, db) {
+  test('test stop() method stops interval', function (t, db) {
     t.equals(intervals, 1, '1 interval timer')
-    db.put('foo', 'bar1', { ttl: 25 })
 
-    setTimeout(function () {
-      db.get('foo', function (err, value) {
-        t.notOk(err, 'no error')
-        t.equal('bar1', value)
-      })
-    }, 40)
+    db.put('foo', 'bar1', { ttl: 25 }, function (err) {
+      t.ifError(err, 'no put error')
 
-    setTimeout(function () {
-      db.get('foo', function (err, value) {
-        t.ok(err && err.notFound, 'not found error')
-        t.notOk(value, 'no value')
-      })
-    }, 80)
+      waitForSweep(db, function () {
+        db.get('foo', function (err) {
+          t.ok(err && err.notFound, 'not found error')
 
-    setTimeout(function () {
-      db.stop(function () {
-        db._ttl.close(function () {
-          global.setInterval = _setInterval
-          global.clearInterval = _clearInterval
-          t.equals(0, intervals, 'all interval timers cleared')
-          t.end()
+          db.stop(function () {
+            t.equals(0, intervals, 'all interval timers cleared')
+            db._ttl.close(t.end.bind(t))
+          })
         })
       })
-    }, 120)
+    })
+  }, {
+    setInterval: function () {
+      intervals++
+      return setInterval.apply(null, arguments)
+    },
+    clearInterval: function () {
+      intervals--
+      return clearInterval.apply(null, arguments)
+    }
   })
 }
 
-// TODO: restore
-// wrappedTest()
-
 // TODO: rewrite to be less sensitive and more a unit test
 function put (timeout, opts) {
   return function (t, db) {