@nxtedition/rocksdb 15.2.6 → 15.4.0

package/.claude/settings.local.json

@@ -28,7 +28,8 @@
       "Bash(git rm:*)",
       "WebFetch(domain:raw.githubusercontent.com)",
       "Bash(git log:*)",
-      "WebFetch(domain:github.com)"
+      "WebFetch(domain:github.com)",
+      "Bash(npm run rebuild:*)"
     ]
   }
 }

package/binding.cc

@@ -812,7 +812,7 @@ static void FinalizeDatabase(napi_env env, void* data, void* hint) {
 }
 
 NAPI_METHOD(db_init) {
-  NAPI_ARGV(1);
+  NAPI_ARGV(2);
 
   Database* database = nullptr;
 
@@ -1024,7 +1024,35 @@ napi_status InitOptions(napi_env env, T& columnOptions, const U& options) {
   tableOptions.decouple_partitioned_filters = true;
 
   std::shared_ptr<rocksdb::Cache> cache;
+
   {
+    napi_value cacheValue;
+    NAPI_STATUS_RETURN(napi_get_named_property(env, options, "cache", &cacheValue));
+
+    napi_valuetype cacheType;
+    NAPI_STATUS_RETURN(napi_typeof(env, cacheValue, &cacheType));
+
+    if (cacheType == napi_object) {
+      napi_value handleValue;
+      NAPI_STATUS_RETURN(napi_get_named_property(env, cacheValue, "handle", &handleValue));
+
+      bool lossless;
+      int64_t ptr;
+      NAPI_STATUS_RETURN(napi_get_value_bigint_int64(env, handleValue, &ptr, &lossless));
+
+      cache = *reinterpret_cast<std::shared_ptr<rocksdb::Cache>*>(ptr);
+    } else if (cacheType == napi_bigint) {
+      bool lossless;
+      int64_t ptr;
+      NAPI_STATUS_RETURN(napi_get_value_bigint_int64(env, cacheValue, &ptr, &lossless));
+
+      cache = *reinterpret_cast<std::shared_ptr<rocksdb::Cache>*>(ptr);
+    } else if (cacheType != napi_undefined && cacheType != napi_null) {
+      return napi_invalid_arg;
+    }
+  }
+
+  if (!cache) {
     uint32_t cacheSize = 8 << 20;
     double compressedRatio = 0.0;
 
@@ -1032,7 +1060,7 @@ napi_status InitOptions(napi_env env, T& columnOptions, const U& options) {
     NAPI_STATUS_RETURN(GetProperty(env, options, "cacheCompressedRatio", compressedRatio));
 
     if (cacheSize == 0) {
-      cache = nullptr;
+      // Do nothing...
     } else if (compressedRatio > 0.0) {
       rocksdb::TieredCacheOptions options;
       options.cache_type = rocksdb::PrimaryCacheType::kCacheTypeHCC;
@@ -1960,7 +1988,6 @@ NAPI_METHOD(batch_write) {
 
   rocksdb::WriteBatch* batch;
   NAPI_STATUS_THROWS(napi_get_value_external(env, argv[1], reinterpret_cast<void**>(&batch)));
-
   bool sync = false;
   NAPI_STATUS_THROWS(GetProperty(env, argv[2], "sync", sync));
 
@@ -2249,6 +2276,32 @@ NAPI_METHOD(db_compact_range) {
   return 0;
 }
 
+NAPI_METHOD(cache_init) {
+  NAPI_ARGV(1);
+
+  size_t capacity = 32 * 1024 * 1024;  // 32 MiB
+  NAPI_STATUS_THROWS(GetProperty(env, argv[0], "capacity", capacity));
+
+  auto cache = new std::shared_ptr<rocksdb::Cache>(rocksdb::HyperClockCacheOptions(capacity, 0).MakeSharedCache());
+
+  napi_value result;
+  NAPI_STATUS_THROWS(napi_create_external(env, cache, Finalize<std::shared_ptr<rocksdb::Cache>>, cache, &result));
+
+  return result;
+}
+
+NAPI_METHOD(cache_get_handle) {
+  NAPI_ARGV(1);
+
+  std::shared_ptr<rocksdb::Cache>* cache;
+  NAPI_STATUS_THROWS(napi_get_value_external(env, argv[0], reinterpret_cast<void**>(&cache)));
+
+  napi_value result;
+  NAPI_STATUS_THROWS(napi_create_bigint_int64(env, reinterpret_cast<intptr_t>(cache), &result));
+
+  return result;
+}
+
 NAPI_INIT() {
   NAPI_EXPORT_FUNCTION(db_init);
   NAPI_EXPORT_FUNCTION(db_open);
@@ -2287,4 +2340,7 @@ NAPI_INIT() {
   NAPI_EXPORT_FUNCTION(batch_merge);
   NAPI_EXPORT_FUNCTION(batch_count);
   NAPI_EXPORT_FUNCTION(batch_iterate);
+
+  NAPI_EXPORT_FUNCTION(cache_init);
+  NAPI_EXPORT_FUNCTION(cache_get_handle);
 }

package/cache.js

@@ -0,0 +1,17 @@
+'use strict'
+
+const binding = require('./binding')
+
+const kCacheContext = Symbol('cacheContext')
+
+class RocksCache {
+  constructor(optionsOrHandle = {}) {
+    this[kCacheContext] = binding.cache_init(optionsOrHandle)
+  }
+
+  get handle () {
+    return binding.cache_get_handle(this[kCacheContext])
+  }
+}
+
+exports.RocksCache = RocksCache

package/chained-batch.js

@@ -1,12 +1,17 @@
 'use strict'
 
+const { fromCallback } = require('catering')
 const { AbstractChainedBatch } = require('abstract-level')
-const binding = require('./binding')
 const ModuleError = require('module-error')
 const assert = require('node:assert')
 
+const binding = require('./binding')
+
+const kPromise = Symbol('promise')
 const kBatchContext = Symbol('batchContext')
 const kDbContext = Symbol('dbContext')
+const kBusy = Symbol('busy')
+
 const EMPTY = {}
 
 class ChainedBatch extends AbstractChainedBatch {
@@ -15,10 +20,18 @@ class ChainedBatch extends AbstractChainedBatch {
 
     this[kDbContext] = context
     this[kBatchContext] = binding.batch_init()
+    this[kBusy] = false
+  }
+
+  get length () {
+    assert(this[kBatchContext])
+
+    return binding.batch_count(this[kBatchContext])
   }
 
   _put (key, value, options) {
     assert(this[kBatchContext])
+    assert(!this[kBusy])
 
     if (key === null || key === undefined) {
       throw new ModuleError('Key cannot be null or undefined', {
@@ -40,6 +53,7 @@ class ChainedBatch extends AbstractChainedBatch {
 
   _putLogData (blob) {
     assert(this[kBatchContext])
+    assert(!this[kBusy])
 
     if (blob === null || blob === undefined) {
       throw new ModuleError('Blob cannot be null or undefined', {
@@ -54,6 +68,7 @@ class ChainedBatch extends AbstractChainedBatch {
 
   _del (key, options) {
     assert(this[kBatchContext])
+    assert(!this[kBusy])
 
     if (key === null || key === undefined) {
       throw new ModuleError('Key cannot be null or undefined', {
@@ -68,24 +83,43 @@ class ChainedBatch extends AbstractChainedBatch {
 
   _clear () {
     assert(this[kBatchContext])
+    assert(!this[kBusy])
 
     binding.batch_clear(this[kBatchContext])
   }
 
   _write (options, callback) {
     assert(this[kBatchContext])
+    assert(!this[kBusy])
 
-    binding.batch_write(this[kDbContext], this[kBatchContext], options ?? EMPTY, callback)
+    return this._writeAsync(options, callback)
   }
 
   _writeSync (options) {
     assert(this[kBatchContext])
+    assert(!this[kBusy])
 
     binding.batch_write_sync(this[kDbContext], this[kBatchContext], options ?? EMPTY)
   }
 
+  _writeAsync (options, callback) {
+    assert(this[kBatchContext])
+    assert(!this[kBusy])
+
+    callback = fromCallback(callback, kPromise)
+
+    this[kBusy] = true
+    binding.batch_write(this[kDbContext], this[kBatchContext], options ?? EMPTY, (err) => {
+      this[kBusy] = false
+      callback(err)
+    })
+
+    return callback[kPromise]
+  }
+
   _close (callback) {
     assert(this[kBatchContext])
+    assert(!this[kBusy])
 
     try {
       this._closeSync()
@@ -96,20 +130,16 @@ class ChainedBatch extends AbstractChainedBatch {
   }
 
   _closeSync () {
-    if (this[kBatchContext]) {
-      binding.batch_clear(this[kBatchContext])
-      this[kBatchContext] = null
-    }
-  }
-
-  get length () {
     assert(this[kBatchContext])
+    assert(!this[kBusy])
 
-    return binding.batch_count(this[kBatchContext])
+    binding.batch_clear(this[kBatchContext])
+    this[kBatchContext] = null
   }
 
   _merge (key, value, options) {
     assert(this[kBatchContext])
+    assert(!this[kBusy])
 
     if (key === null || key === undefined) {
       throw new ModuleError('Key cannot be null or undefined', {

package/index.js

@@ -5,6 +5,7 @@ const { AbstractLevel } = require('abstract-level')
 const ModuleError = require('module-error')
 const binding = require('./binding')
 const { ChainedBatch } = require('./chained-batch')
+const { RocksCache } = require('./cache')
 const { Iterator } = require('./iterator')
 const fs = require('node:fs')
 const assert = require('node:assert')
@@ -20,7 +21,7 @@ const { kRef, kUnref } = require('./util')
 const kEmpty = {}
 
 class RocksLevel extends AbstractLevel {
-  constructor (locationOrHandle, options) {
+  constructor (locationOrHandle, { ...options } = {}) {
     super({
       encodings: {
         buffer: true,
@@ -339,3 +340,4 @@ class RocksLevel extends AbstractLevel {
 }
 
 exports.RocksLevel = RocksLevel
+exports.RocksCache = RocksCache

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/rocksdb",
-  "version": "15.2.6",
+  "version": "15.4.0",
   "description": "A low-level Node.js RocksDB binding",
   "license": "MIT",
   "main": "index.js",