3.1.0

Added `separator` option.
Updated changelog and readme
cleaned up tests
added tests

Author: ArtskydJ

CHANGELOG.md

@@ -1,7 +1,12 @@
+# 3.1.0
+
+- Added `separator` option.
+
 # 3.0.0
 
 - Added support for `level-spaces@2`
 - The check for whether a key is in a sub level is more thorough.
+- Breaking changes: Keys with '\x00', '\xff', or '~' in their name are not supported.
 
 # 2.0.3
 
@@ -18,6 +23,7 @@
 # 2.0.0
 
 - Added support for `level-spaces@1`.
+- Breaking changes: none.
 
 # 1.1.0
 

README.md

@@ -30,6 +30,7 @@ Also, this respects the locks that [`level-lock`][lock] creates. If `tiny-level-
 - `opts` is an object with the following properties:
 	- `ttl` is a number of milliseconds for how long a key lives in the `db`. Optional; defaults to `3600000`, (1 hour).
 	- `checkInterval` is a number of milliseconds for how long the interval between checking keys is. Optional; defaults to `10000`, (10 seconds).
+	- `separator` can be a string, buffer, or array of strings/buffers. These represent the separator used in the sub-database. For example, `level-spaces` by default has the separator `~`, so if you store the key `bar`, in the space `foo`, the key will be `~foo~bar`. Defaults to `[ '~', '\xff', '\x00' ]`.
 
 # example
 

index.js

@@ -4,44 +4,49 @@ var lock = require('level-lock')
 var spaces = require('level-spaces')
 var defaultOpts = {
 	ttl: 3600000,
-	checkInterval: 10000
+	checkInterval: 10000,
+	separator: [ '~', '\xff', '\x00' ]
 }
 
-// https://github.com/rvagg/level-spaces/issues/2
-function isFromThisSpace(key) {
-	function lacks(char) {
-		return (key.indexOf(char) === -1)
+function isFromThisSpace(key, separator) {
+	if (!Array.isArray(separator)) {
+		separator = [ separator ]
 	}
-	return ( lacks('ÿ') && lacks('~') && lacks('\xff') && lacks('\x00') )
+	return separator.every(function (sep) {
+		return key.indexOf(sep) === -1
+	})
 }
 
-function onCmd(expirer, type, key) {
+function onCmd(expirer, separator, type, key) {
 	var commandResponses = {
 		del: expirer.forget,
 		put: expirer.touch
 	}
-	if (isFromThisSpace(key)) {
+	if (isFromThisSpace(key, separator)) {
 		commandResponses[type](key)
 	}
 }
 
-function makeChildDb(db) {
-	return db.sublevel ? db.sublevel('expirer') : spaces(db, 'expirer')
+function makeChildDb(db, separator) {
+	return db.sublevel ?
+		db.sublevel('expirer') :
+		spaces(db, 'expirer', { separator: separator })
 }
 
 module.exports = function ttl(db, opts) {
 	if (!db) {
 		throw new Error('You must pass a level database to ttl()')
 	}
 	var options = xtend(defaultOpts, opts)
-	var childDb = makeChildDb(db)
+	var separator = options.separator
+	var childDb = makeChildDb(db, separator)
 	var expirer = new Expirer(options.ttl, childDb, options.checkInterval)
 
-	db.on('put', onCmd.bind(null, expirer, 'put'))
-	db.on('del', onCmd.bind(null, expirer, 'del'))
+	db.on('put', onCmd.bind(null, expirer, separator, 'put'))
+	db.on('del', onCmd.bind(null, expirer, separator, 'del'))
 	db.on('batch', function (cmds) {
 		cmds.forEach(function (cmd) {
-			onCmd(expirer, cmd.type, cmd.key)
+			onCmd(expirer, separator, cmd.type, cmd.key)
 		})
 	})
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tiny-level-ttl",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Extension for node-level that enforces a time to live on a database (or sublevel db)",
   "main": "index.js",
   "scripts": {

test/testBasicFunctionality.js

@@ -7,7 +7,7 @@ test('basic functionality', function (t) {
 	t.plan(7)
 	var db = level('hello')
 	var ttlDb = spaces(db, 'ttl-expiration')
-	ttl(db, {ttl: 1000, checkInterval: 50, db: ttlDb})
+	ttl(db, {ttl: 1000, checkInterval: 50})
 	db.put('hi', 'wuzzup', t.notOk.bind(t))
 	setTimeout(function () { //before ttl
 		db.get('hi', function (err, value) {

test/testDelayExpirationWithRefreshTtlCall.js

@@ -6,8 +6,8 @@ test('db inheritance and adding refreshTtl() to new db', function (t) {
 	var db = level('hello')
 	var doesNotReturn = ttl(db, {ttl: 1000, checkInterval: 50})
 
-	t.type(db.refreshTtl, 'function', 'database has refresh ttl function')
-	t.type(doesNotReturn, 'undefined', 'ttl() returns nothing!')
+	t.equal(typeof db.refreshTtl, 'function', 'database has refresh ttl function')
+	t.equal(typeof doesNotReturn, 'undefined', 'ttl() returns nothing!')
 
 	t.end()
 })

test/testSeparators.js

@@ -0,0 +1,86 @@
+var test = require('tap').test
+var level = require('level-mem')
+var spaces = require('level-spaces')
+var ttl = require('../index.js')
+
+test('separators work', function (t) {
+	t.plan(14)
+
+	var db = level('hello')
+	var ttlDb = spaces(db, 'ttl-expiration', { separator: '\xff' })
+
+	ttl(db, {
+		ttl: 1000,
+		checkInterval: 50,
+		separator: '\xff'
+	})
+
+	db.put('hi\x00', 'wuzzup', t.notOk.bind(t))
+	db.put('hello\xff', 'coolness', t.notOk.bind(t))
+
+	setTimeout(function () { //before ttl
+		db.get('hi\x00', function (err, value) {
+			t.notOk(err, 'did not get an error')
+			t.notOk(err && err.notFound, 'did not get a notFound error')
+			t.equal(value, 'wuzzup', 'got back the expected value')
+
+			db.get('hello\xff', function (err, value) {
+				t.notOk(err, 'did not get an error')
+				t.notOk(err && err.notFound, 'did not get a notFound error')
+				t.equal(value, 'coolness', 'got back the expected value')
+			})
+		})
+	}, 900)
+
+	setTimeout(function () { //after ttl
+		db.get('hi\x00', function (err, value) {
+			t.ok(err, 'got an error')
+			t.ok(err && err.notFound, 'got a notFound error')
+			t.notOk(value, 'did not get a value')
+
+			db.get('hello\xff', function (err, value) {
+				t.notOk(err, 'did not get an error')
+				t.notOk(err && err.notFound, 'did not get a notFound error')
+				t.equal(value, 'coolness', 'got back the expected value')
+
+				t.end()
+			})
+		})
+	}, 1100)
+})
+
+test('separators work', function (t) {
+	t.plan(6)
+
+	var db = level('hello')
+	var ttlDb = spaces(db, 'ttl-expiration', { separator: 'x' })
+
+	ttl(db, {
+		ttl: 1000,
+		checkInterval: 50,
+		separator: 'x'
+	})
+
+	db.put('hi', 'wuzzup', t.notOk.bind(t))
+	db.put('hellox', 'coolness', t.notOk.bind(t))
+
+	setTimeout(function () { //before ttl
+		db.get('hi', function (err, value) {
+			t.equal(value, 'wuzzup')
+		})
+		db.get('hellox', function (err, value) {
+			t.equal(value, 'coolness')
+		})
+	}, 900)
+
+	setTimeout(function () { //after ttl
+		db.get('hi\x00', function (err, value) {
+			t.notOk(value)
+			db.get('hellox', function (err, value) {
+				t.equal(value, 'coolness')
+
+				t.end()
+			})
+		})
+	}, 1100)
+})

test/testThrowErrorsForBadDatabases.js

@@ -1,15 +1,8 @@
 var test = require('tap').test
-var level = require('level-mem')
 var ttl = require('../index.js')
 
 test('throw error on bad db', function (t) {
 	t.plan(1)
-	var db = level('hello')
-	try {
-		ttl(null)
-		t.fail('bad db must throw error')
-	} catch (err) {
-		t.equal(err.message, 'You must pass a level database to ttl()', 'correct error message')
-	}
+	t.throws(ttl, 'throws an error')
 	t.end()
 })

test/testWorksInSublevel.js

@@ -44,6 +44,6 @@ test('still works in a sublevel', function (t) {
 				t.end()
 			})
 		})
-		
+
 	}, 1100)
 })