@nxtedition/rocksdb 7.1.34 → 8.0.0

package/BUILDING.md

@@ -10,9 +10,9 @@
   - Copy `libfolly.a` to `/usr/lib/x86_64-linux-gnu`.
   - Copy headers to `/usr/lib/x86_64-linux-gnu/include`.
   - Copy boost headers from folly scratchpad to `/usr/lib/x86_64-linux-gnu/include`.
-- `npx prebuildify -t -t 17.8.0 --napi --strip --arch x64`
+- `npx prebuildify -t 18.11.0 --napi --strip --arch x64`
 
 # OSX
 
 - `brew install zstd`
-- `npx prebuildify -t -t 17.8.0 --napi --strip --arch x64`
+- `npx prebuildify -t 18.11.0 --napi --strip --arch arm64`

package/binding.cc

@@ -38,7 +38,6 @@ class NullLogger : public rocksdb::Logger {
 
 struct Database;
 struct Iterator;
-struct Updates;
 
 struct ColumnFamily {
   napi_ref ref;
@@ -254,48 +253,6 @@ struct BatchIterator : public rocksdb::WriteBatch::Handler {
   std::vector<BatchEntry> cache_;
 };
 
-struct Updates : public BatchIterator, public Closable {
-  Updates(Database* database,
-          const int64_t seqNumber,
-          const bool keys,
-          const bool values,
-          const bool data,
-          const rocksdb::ColumnFamilyHandle* column,
-          const Encoding keyEncoding,
-          const Encoding valueEncoding)
-      : BatchIterator(database, keys, values, data, column, keyEncoding, valueEncoding),
-        database_(database),
-        start_(seqNumber) {}
-
-  virtual ~Updates() { assert(!iterator_); }
-
-  rocksdb::Status Close() override {
-    iterator_.reset();
-    return rocksdb::Status::OK();
-  }
-
-  napi_status Attach(napi_env env, napi_value context) {
-    NAPI_STATUS_RETURN(napi_create_reference(env, context, 1, &ref_));
-    database_->closables.insert(this);
-    return napi_ok;
-  }
-
-  napi_status Detach(napi_env env) {
-    database_->closables.erase(this);
-    if (ref_) {
-      NAPI_STATUS_RETURN(napi_delete_reference(env, ref_));
-    }
-    return napi_ok;
-  }
-
-  Database* database_;
-  int64_t start_;
-  std::unique_ptr<rocksdb::TransactionLogIterator> iterator_;
-
- private:
-  napi_ref ref_ = nullptr;
-};
-
 struct BaseIterator : public Closable {
   BaseIterator(Database* database,
                rocksdb::ColumnFamilyHandle* column,
@@ -850,106 +807,6 @@ NAPI_METHOD(db_close) {
   return 0;
 }
 
-NAPI_METHOD(updates_init) {
-  NAPI_ARGV(2);
-
-  Database* database;
-  NAPI_STATUS_THROWS(napi_get_value_external(env, argv[0], reinterpret_cast<void**>(&database)));
-
-  const auto options = argv[1];
-
-  int64_t since = 0;
-  NAPI_STATUS_THROWS(GetProperty(env, options, "since", since));
-
-  bool keys = true;
-  NAPI_STATUS_THROWS(GetProperty(env, options, "keys", keys));
-
-  bool values = true;
-  NAPI_STATUS_THROWS(GetProperty(env, options, "values", values));
-
-  bool data = true;
-  NAPI_STATUS_THROWS(GetProperty(env, options, "data", data));
-
-  Encoding keyEncoding = Encoding::String;
-  NAPI_STATUS_THROWS(GetProperty(env, options, "keyEncoding", keyEncoding));
-
-  Encoding valueEncoding = Encoding::String;
-  NAPI_STATUS_THROWS(GetProperty(env, options, "valueEncoding", valueEncoding));
-
-  rocksdb::ColumnFamilyHandle* column = nullptr;
-  NAPI_STATUS_THROWS(GetProperty(env, options, "column", column));
-
-  auto updates =
-      std::unique_ptr<Updates>(new Updates(database, since, keys, values, data, column, keyEncoding, valueEncoding));
-
-  napi_value result;
-  NAPI_STATUS_THROWS(napi_create_external(env, updates.get(), Finalize<Updates>, updates.get(), &result));
-
-  // Prevent GC of JS object before the iterator is closed (explicitly or on
-  // db close) and keep track of non-closed iterators to end them on db close.
-  NAPI_STATUS_THROWS(updates.release()->Attach(env, result));
-
-  return result;
-}
-
-NAPI_METHOD(updates_next) {
-  NAPI_ARGV(2);
-
-  Updates* updates;
-  NAPI_STATUS_THROWS(napi_get_value_external(env, argv[0], reinterpret_cast<void**>(&updates)));
-
-  auto callback = argv[1];
-
-  runAsync<rocksdb::BatchResult>(
-      "leveldown.updates.next", env, callback,
-      [=](auto& batchResult) {
-        if (!updates->iterator_) {
-          rocksdb::TransactionLogIterator::ReadOptions options;
-          const auto status = updates->database_->db->GetUpdatesSince(updates->start_, &updates->iterator_, options);
-          if (!status.ok()) {
-            return status;
-          }
-        } else if (updates->iterator_->Valid()) {
-          updates->iterator_->Next();
-        }
-
-        if (!updates->iterator_->Valid() || !updates->iterator_->status().ok()) {
-          return updates->iterator_->status();
-        }
-
-        batchResult = updates->iterator_->GetBatch();
-
-        return rocksdb::Status::OK();
-      },
-      [=](auto& batchResult, auto env, auto& argv) {
-        if (!batchResult.writeBatchPtr) {
-          return napi_ok;
-        }
-
-        argv.resize(5);
-        NAPI_STATUS_RETURN(updates->Iterate(env, *batchResult.writeBatchPtr, &argv[1]));
-        NAPI_STATUS_RETURN(napi_create_int64(env, batchResult.sequence, &argv[2]));
-        NAPI_STATUS_RETURN(napi_create_int64(env, batchResult.writeBatchPtr->Count(), &argv[3]));
-        NAPI_STATUS_RETURN(napi_create_int64(env, updates->start_, &argv[4]));
-
-        return napi_ok;
-      });
-
-  return 0;
-}
-
-NAPI_METHOD(updates_close) {
-  NAPI_ARGV(1);
-
-  Updates* updates;
-  NAPI_STATUS_THROWS(napi_get_value_external(env, argv[0], reinterpret_cast<void**>(&updates)));
-
-  ROCKS_STATUS_THROWS_NAPI(updates->Close());
-  NAPI_STATUS_THROWS(updates->Detach(env));
-
-  return 0;
-}
-
 NAPI_METHOD(db_get_many) {
   NAPI_ARGV(4);
 
@@ -1731,10 +1588,6 @@ NAPI_INIT() {
   NAPI_EXPORT_FUNCTION(iterator_nextv);
   NAPI_EXPORT_FUNCTION(iterator_get_sequence);
 
-  NAPI_EXPORT_FUNCTION(updates_init);
-  NAPI_EXPORT_FUNCTION(updates_close);
-  NAPI_EXPORT_FUNCTION(updates_next);
-
   NAPI_EXPORT_FUNCTION(batch_do);
   NAPI_EXPORT_FUNCTION(batch_init);
   NAPI_EXPORT_FUNCTION(batch_put);

package/index.js

@@ -1,22 +1,18 @@
 '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 kUpdates = Symbol('updates')
 const kRef = Symbol('ref')
 const kUnref = Symbol('unref')
 const kRefs = Symbol('refs')
@@ -206,11 +202,6 @@ class RocksLevel extends AbstractLevel {
         this[kRef]()
         binding.batch_write(this[kContext], context, options, (err, sequence) => {
           this[kUnref]()
-
-          if (!err) {
-            this.emit('update', { batch, sequence })
-          }
-
           callback(err)
         })
       } catch (err) {
@@ -226,12 +217,6 @@ class RocksLevel extends AbstractLevel {
       this[kRef]()
       binding.batch_do(this[kContext], operations, options ?? EMPTY, (err, sequence) => {
         this[kUnref]()
-
-        // TODO (fix)
-        // if (!err) {
-        //   this.emit('update', { batch, sequence })
-        // }
-
         callback(err)
       })
     } catch (err) {
@@ -292,183 +277,6 @@ 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'
-      })
-    }
-
-    options = {
-      since: options?.since ?? 0,
-      keys: options?.keys ?? true,
-      keyEncoding: options?.keyEncoding,
-      values: options?.values ?? true,
-      valueEncoding: options?.valueEncoding,
-      data: options?.data ?? true,
-      live: options?.live ?? false,
-      column: options?.column ?? null,
-      signal: options?.signal ?? null
-    }
-
-    if (typeof options.since !== 'number') {
-      throw new TypeError("'since' must be nully or a number")
-    }
-
-    if (typeof options.keys !== 'boolean') {
-      throw new TypeError("'keys' must be nully or a boolean")
-    }
-
-    if (typeof options.values !== 'boolean') {
-      throw new TypeError("'values' must be nully or a boolean")
-    }
-
-    if (typeof options.data !== 'boolean') {
-      throw new TypeError("'data' must be nully or a boolean")
-    }
-
-    if (options.column !== undefined && typeof options.column !== 'object') {
-      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)
-    this.on('closing', onAbort)
-
-    const db = this
-
-    try {
-      let since = (options.since ?? 0) + 1
-      while (true) {
-        const buffer = new Readable({
-          signal: ac.signal,
-          objectMode: true,
-          readableHighWaterMark: 8192,
-          construct (callback) {
-            this._next = ({ batch, sequence }) => {
-              const update = {
-                rows: batch.toArray(options),
-                count: batch.length,
-                sequence
-              }
-
-              if (!this.push(update)) {
-                this.push(null)
-                db.off('update', this._next)
-              }
-            }
-            db.on('update', this._next)
-            callback()
-          },
-          read () {},
-          destroy (err, callback) {
-            db.off('update', this._next)
-            callback(err)
-          }
-        })
-
-        if (ac.signal.aborted) {
-          throw new AbortError()
-        }
-
-        try {
-          if (since <= db.sequence) {
-            let first = true
-            for await (const update of db[kUpdates]({
-              ...options,
-              signal: ac.signal,
-              since: Math.max(0, options.since - 8192) // TODO (fix): https://github.com/facebook/rocksdb/issues/10476
-            })) {
-              if (first) {
-                if (update.sequence > since) {
-                  db.emit('warning', `Invalid updates sequence ${update.sequence} > ${options.since}.`)
-                }
-                first = false
-              }
-
-              // TODO (Fix): What if since > sequence && since < sequence + count
-              if (update.sequence + update.count > since) {
-                yield update
-              }
-
-              since = update.sequence + update.count
-            }
-          }
-        } catch (err) {
-          if (err.code !== 'LEVEL_TRYAGAIN') {
-            throw err
-          }
-        }
-
-        if (!options.live) {
-          return
-        }
-
-        let first = true
-        for await (const update of buffer) {
-          if (first) {
-            if (update.sequence > since) {
-              db.emit('warning', `Invalid batch sequence ${update.sequence} > ${options.since}.`)
-            }
-            first = false
-          }
-
-          // TODO (Fix): What if since > sequence && since < sequence + count
-          if (update.sequence + update.count > since) {
-            yield update
-          }
-
-          since = update.sequence + update.count
-        }
-      }
-    } finally {
-      this.off('closing', onAbort)
-      options.signal?.removeEventListener('abort', onAbort)
-    }
-  }
-
-  async * [kUpdates] ({ signal, ...options }) {
-    const context = binding.updates_init(this[kContext], options)
-    this[kRef]()
-    try {
-      while (true) {
-        if (signal?.aborted) {
-          throw new AbortError()
-        }
-
-        const entry = await new Promise((resolve, reject) => binding.updates_next(context, (err, rows, sequence, count) => {
-          if (err) {
-            reject(err)
-          } else {
-            resolve({ rows, sequence, count })
-          }
-        }))
-
-        if (!entry.rows) {
-          return
-        }
-
-        yield entry
-      }
-    } finally {
-      binding.updates_close(context)
-      this[kUnref]()
-    }
-  }
-
   async flushWal (options) {
     return new Promise((resolve, reject) => {
       binding.db_flush_wal(this[kContext], options ?? {}, (err, val) => err ? reject(err) : resolve(val))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/rocksdb",
-  "version": "7.1.34",
+  "version": "8.0.0",
   "description": "A low-level Node.js RocksDB binding",
   "license": "MIT",
   "main": "index.js",
@@ -11,13 +11,11 @@
     "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.5.0",
-    "readable-stream": "^4.2.0"
+    "node-gyp-build": "^4.5.0"
   },
   "devDependencies": {
     "@types/node": "^18.11.3",

package/common.js

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