@nxtedition/rocksdb 7.0.45 → 7.0.48

package/chained-batch.js

@@ -3,11 +3,13 @@
 const { AbstractChainedBatch } = require('abstract-level')
 const binding = require('./binding')
 const ModuleError = require('module-error')
+const { fromCallback } = require('catering')
+
 const kWrite = Symbol('write')
 const kBatchContext = Symbol('batchContext')
 const kDbContext = Symbol('dbContext')
+const kPromise = Symbol('promise')
 
-const NOOP = () => {}
 const EMPTY = {}
 
 class ChainedBatch extends AbstractChainedBatch {
@@ -50,7 +52,11 @@ class ChainedBatch extends AbstractChainedBatch {
   }
 
   _write (options, callback) {
-    this[kWrite](this, this[kBatchContext], options ?? EMPTY, callback ?? NOOP)
+    callback = fromCallback(callback, kPromise)
+
+    this[kWrite](this, this[kBatchContext], options ?? EMPTY, callback)
+
+    return callback[kPromise]
   }
 
   _close (callback) {

package/common.js

@@ -0,0 +1,7 @@
+module.exports.AbortError = class AbortError extends Error {
+  constructor () {
+    super('The operation was aborted')
+    this.code = 'ABORT_ERR'
+    this.name = 'AbortError'
+  }
+}

package/index.js

@@ -1,16 +1,23 @@
 'use strict'
 
+const { fromCallback } = require('catering')
+const { AbortError } = require('./common')
 const { AbstractLevel } = require('abstract-level')
 const ModuleError = require('module-error')
 const fs = require('fs')
 const binding = require('./binding')
 const { ChainedBatch } = require('./chained-batch')
 const { Iterator } = require('./iterator')
+const { Readable } = require('readable-stream')
 const os = require('os')
+const AbortController = require('abort-controller')
 
 const kContext = Symbol('context')
 const kColumns = Symbol('columns')
 const kLocation = Symbol('location')
+const kPromise = Symbol('promise')
+
+const EMPTY = {}
 
 class RocksLevel extends AbstractLevel {
   constructor (location, options, _) {
@@ -95,17 +102,21 @@ class RocksLevel extends AbstractLevel {
   }
 
   _put (key, value, options, callback) {
+    callback = fromCallback(callback, kPromise)
+
     try {
       const batch = this.batch()
-      batch.put(key, value, options)
+      batch.put(key, value, options ?? EMPTY)
       batch.write(callback)
     } catch (err) {
       process.nextTick(callback, err)
     }
+
+    return callback[kPromise]
   }
 
   _get (key, options, callback) {
-    this._getMany([key], options, (err, val) => {
+    this._getMany([key], options ?? EMPTY, (err, val) => {
       if (err) {
         callback(err)
       } else if (val[0] === undefined) {
@@ -119,31 +130,43 @@ class RocksLevel extends AbstractLevel {
   }
 
   _getMany (keys, options, callback) {
+    callback = fromCallback(callback, kPromise)
+
     try {
-      binding.db_get_many(this[kContext], keys, options, callback)
+      binding.db_get_many(this[kContext], keys, options ?? EMPTY, callback)
     } catch (err) {
       process.nextTick(callback, err)
     }
+
+    return callback[kPromise]
   }
 
   _del (key, options, callback) {
+    callback = fromCallback(callback, kPromise)
+
     try {
       const batch = this.batch()
-      batch.del(key, options)
+      batch.del(key, options ?? EMPTY)
       batch.write(callback)
     } catch (err) {
       process.nextTick(callback, err)
     }
+
+    return callback[kPromise]
   }
 
   _clear (options, callback) {
+    callback = fromCallback(callback, kPromise)
+
     try {
       // TODO (fix): Use batch + DeleteRange...
-      binding.db_clear(this[kContext], options)
+      binding.db_clear(this[kContext], options ?? EMPTY)
       process.nextTick(callback, null)
     } catch (err) {
       process.nextTick(callback, err)
     }
+
+    return callback[kPromise]
   }
 
   _chainedBatch () {
@@ -160,16 +183,20 @@ class RocksLevel extends AbstractLevel {
   }
 
   _batch (operations, options, callback) {
+    callback = fromCallback(callback, kPromise)
+
     try {
-      binding.batch_do(this[kContext], operations, options)
+      binding.batch_do(this[kContext], operations, options ?? EMPTY)
       process.nextTick(callback, null)
     } catch (err) {
       process.nextTick(callback, err)
     }
+
+    return callback[kPromise]
   }
 
   _iterator (options) {
-    return new Iterator(this, this[kContext], options)
+    return new Iterator(this, this[kContext], options ?? EMPTY)
   }
 
   getProperty (property) {
@@ -257,6 +284,11 @@ class RocksLevel extends AbstractLevel {
   }
 
   async * updates (options) {
+    // TODO (fix): Ensure open status etc...?
+    if (this.status !== 'open') {
+      throw new Error('Database is not open')
+    }
+
     if (this.status !== 'open') {
       throw new ModuleError('Database is not open', {
         code: 'LEVEL_DATABASE_NOT_OPEN'
@@ -268,12 +300,14 @@ class RocksLevel extends AbstractLevel {
       keys: options?.keys ?? true,
       values: options?.values ?? true,
       data: options?.data ?? true,
-      column: options?.column ?? null
+      live: options?.live ?? false,
+      column: options?.column ?? null,
+      signal: options?.signal ?? null
     }
 
     // HACK: We don't properly check for nully column in binding.
-    if (!options.column) {
-      delete options.column
+    if (options.column) {
+      throw new TypeError("'column' not supported")
     }
 
     if (typeof options.since !== 'number') {
@@ -296,6 +330,85 @@ class RocksLevel extends AbstractLevel {
       throw new TypeError("'column' must be nully or a object")
     }
 
+    if (typeof options.live !== 'boolean') {
+      throw new TypeError("'live' must be nully or a boolean")
+    }
+
+    const ac = new AbortController()
+    const onAbort = () => {
+      ac.abort()
+    }
+
+    options.signal?.addEventListener('abort', onAbort)
+
+    try {
+      let since = options.since
+
+      const db = this
+      while (true) {
+        const buffer = new Readable({
+          signal: ac.signal,
+          objectMode: true,
+          readableHighWaterMark: 1024,
+          construct (callback) {
+            this._next = (batch, sequence) => {
+              const rows = []
+              for (const { type, key, value } of batch) {
+                rows.push(type, key, value, null)
+              }
+              if (!this.push({ rows, sequence, count: batch.length })) {
+                this.push(null)
+                db.off('write', this._next)
+              }
+            }
+            db.on('write', this._next)
+            callback()
+          },
+          read () {},
+          destroy (err, callback) {
+            db.off('write', this._next)
+            callback(err)
+          }
+        })
+
+        if (ac.signal.aborted) {
+          throw new AbortError()
+        }
+
+        try {
+          if (since <= this.sequence) {
+            for await (const update of this._updates(options)) {
+              if (ac.signal.aborted) {
+                throw new AbortError()
+              }
+
+              yield update
+              since = update.sequence + update.count
+            }
+          }
+        } catch (err) {
+          if (err.code !== 'LEVEL_TRYAGAIN') {
+            throw err
+          }
+        }
+
+        if (!options.live) {
+          return
+        }
+
+        for await (const update of buffer) {
+          if (update.sequence >= since) {
+            yield update
+            since = update.sequence + update.count
+          }
+        }
+      }
+    } finally {
+      options.signal?.removeventListener('abort', onAbort)
+    }
+  }
+
+  async * _updates (options) {
     class Updates {
       constructor (db, options) {
         this.context = binding.updates_init(db[kContext], options)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/rocksdb",
-  "version": "7.0.45",
+  "version": "7.0.48",
   "description": "A low-level Node.js RocksDB binding",
   "license": "MIT",
   "main": "index.js",
@@ -11,10 +11,13 @@
     "rebuild": "npm run install --build-from-source"
   },
   "dependencies": {
+    "abort-controller": "^3.0.0",
     "abstract-level": "^1.0.2",
+    "catering": "^2.1.1",
     "module-error": "^1.0.2",
     "napi-macros": "~2.0.0",
-    "node-gyp-build": "^4.3.0"
+    "node-gyp-build": "^4.3.0",
+    "readable-stream": "^4.1.0"
   },
   "devDependencies": {
     "@types/node": "^17.0.16",