@nxtedition/rocksdb 10.0.20 → 10.1.2

package/.tap/test-results/test/segfault-test.js.tap

@@ -0,0 +1,76 @@
+TAP version 13
+# close() waits for pending get()
+ok 1 no error from open()
+ok 2 no error from put()
+ok 3 no error from operation
+ok 4 no error from close()
+ok 5 operation(s) finished before close
+# close() waits for pending put()
+ok 6 no error from open()
+ok 7 no error from put()
+ok 8 no error from operation
+ok 9 no error from close()
+ok 10 operation(s) finished before close
+# close() waits for pending put() with { sync }
+ok 11 no error from open()
+ok 12 no error from put()
+ok 13 no error from operation
+ok 14 no error from close()
+ok 15 operation(s) finished before close
+# close() waits for pending del()
+ok 16 no error from open()
+ok 17 no error from put()
+ok 18 no error from operation
+ok 19 no error from close()
+ok 20 operation(s) finished before close
+# close() waits for pending del() with { sync }
+ok 21 no error from open()
+ok 22 no error from put()
+ok 23 no error from operation
+ok 24 no error from close()
+ok 25 operation(s) finished before close
+# close() waits for pending batch([])
+ok 26 no error from open()
+ok 27 no error from put()
+ok 28 no error from operation
+ok 29 no error from close()
+ok 30 operation(s) finished before close
+# close() waits for pending batch([]) with { sync }
+ok 31 no error from open()
+ok 32 no error from put()
+ok 33 no error from operation
+ok 34 no error from close()
+ok 35 operation(s) finished before close
+# close() waits for pending batch()
+ok 36 no error from open()
+ok 37 no error from put()
+ok 38 no error from operation
+ok 39 no error from close()
+ok 40 operation(s) finished before close
+# close() waits for pending batch() with { sync }
+ok 41 no error from open()
+ok 42 no error from put()
+ok 43 no error from operation
+ok 44 no error from close()
+ok 45 operation(s) finished before close
+# close() waits for pending operations
+ok 46 no error from open()
+ok 47 no error from put()
+ok 48 no error from operation
+ok 49 no error from operation
+ok 50 no error from operation
+ok 51 no error from operation
+ok 52 no error from operation
+ok 53 no error from operation
+ok 54 no error from operation
+ok 55 no error from operation
+ok 56 no error from operation
+ok 57 no error from close()
+ok 58 operation(s) finished before close
+
+1..58
+# tests 58
+# pass  58
+
+# ok
+

package/benchmarks/rocks-vs-map.mjs

@@ -0,0 +1,68 @@
+import { bench, run } from 'mitata'
+import { RocksLevel } from '../index.js'
+import { LRUCache } from 'lru-cache'
+
+const values = []
+for (let x = 0; x < 1e3; x++) {
+  values.push(Buffer.from(Math.random().toString(36).repeat(4)))
+}
+
+const db = new RocksLevel('./tmp', {
+  keyEncoding: 'buffer',
+  valueEncoding: 'buffer',
+  parallelism: 4,
+  pipelinedWrite: false,
+  // unorderedWrite: true,
+  columns: {
+    default: {
+      cacheSize: 128e6,
+      memtableMemoryBudget: 128e6,
+      compaction: 'level'
+      // optimize: 'point-lookup',
+    }
+  }
+})
+await db.open()
+
+const map = new Map()
+const lru = new LRUCache({ max: 10e3 })
+
+for (const value of values) {
+  await db.put(value, value)
+  map.set(value.toString(), value.toString())
+  lru.set(value.toString(), value)
+}
+
+let x = 0
+
+const getOpts = {
+  keyEncoding: 'buffer',
+  valueEncoding: 'buffer',
+  fillCache: true
+}
+
+x = db._getMany(values, getOpts).length
+
+bench('rocks async', async () => {
+  x += (await db._getMany(values, getOpts)).length
+})
+
+bench('rocks sync', async () => {
+  x += db._getManySync(values, getOpts).length
+})
+
+bench('map', () => {
+  for (const value of values) {
+    x += map.get(value.toString()).length
+  }
+})
+
+bench('lru', () => {
+  for (const value of values) {
+    x += lru.get(value.toString()).length
+  }
+})
+
+await run()
+
+console.log(x)

package/binding.cc

@@ -958,67 +958,6 @@ NAPI_METHOD(db_close) {
   return 0;
 }
 
-NAPI_METHOD(db_get_many_sync) {
-  NAPI_ARGV(4);
-
-  Database* database;
-  NAPI_STATUS_THROWS(napi_get_value_external(env, argv[0], reinterpret_cast<void**>(&database)));
-
-  uint32_t size;
-  NAPI_STATUS_THROWS(napi_get_array_length(env, argv[1], &size));
-
-  const auto options = argv[2];
-
-  bool fillCache = true;
-  NAPI_STATUS_THROWS(GetProperty(env, options, "fillCache", fillCache));
-
-  bool ignoreRangeDeletions = false;
-  NAPI_STATUS_THROWS(GetProperty(env, options, "ignoreRangeDeletions", ignoreRangeDeletions));
-
-  rocksdb::ColumnFamilyHandle* column = database->db->DefaultColumnFamily();
-  NAPI_STATUS_THROWS(GetProperty(env, options, "column", column));
-
-  auto callback = argv[3];
-
-  std::vector<rocksdb::Slice> keys{size};
-  std::vector<rocksdb::Status> statuses{size};
-  std::vector<rocksdb::PinnableSlice> values{size};
-
-  for (uint32_t n = 0; n < size; n++) {
-    napi_value element;
-    char* buf;
-    size_t length;
-    NAPI_STATUS_THROWS(napi_get_element(env, argv[1], n, &element));
-    NAPI_STATUS_THROWS(napi_get_buffer_info(env, element, reinterpret_cast<void**>(&buf), &length));
-    keys[n] = rocksdb::Slice{ buf, length };
-  }
-
-  rocksdb::ReadOptions readOptions;
-  readOptions.fill_cache = fillCache;
-  readOptions.ignore_range_deletions = ignoreRangeDeletions;
-
-  database->db->MultiGet(readOptions, column, size, keys.data(), values.data(), statuses.data());
-
-  napi_value ret;
-  NAPI_STATUS_THROWS(napi_create_array_with_length(env, values.size(), &ret));
-
-  for (size_t idx = 0; idx < values.size(); idx++) {
-    const auto& status = statuses[idx];
-    const auto& value = values[idx];
-
-    napi_value element;
-    if (status.IsNotFound()) {
-      NAPI_STATUS_THROWS(napi_get_undefined(env, &element));
-    } else {
-      ROCKS_STATUS_THROWS_NAPI(status);
-      NAPI_STATUS_THROWS(napi_create_buffer_copy(env, value.size(), value.data(), nullptr, &element));
-    }
-    NAPI_STATUS_THROWS(napi_set_element(env, argv[1], static_cast<uint32_t>(idx), element));
-  }
-
-  return ret;
-}
-
 NAPI_METHOD(db_get_many) {
   NAPI_ARGV(4);
 
@@ -1081,9 +1020,9 @@ NAPI_METHOD(db_get_many) {
       [=](auto& state, auto env, auto& argv) {
         argv.resize(2);
 
-        NAPI_STATUS_RETURN(napi_create_array_with_length(env, state.values.size(), &argv[1]));
+        NAPI_STATUS_RETURN(napi_create_array_with_length(env, size, &argv[1]));
 
-        for (size_t idx = 0; idx < state.values.size(); idx++) {
+        for (uint32_t idx = 0; idx < size; idx++) {
           const auto& status = state.statuses[idx];
           const auto& value = state.values[idx];
 
@@ -1094,7 +1033,7 @@ NAPI_METHOD(db_get_many) {
             ROCKS_STATUS_RETURN_NAPI(status);
             NAPI_STATUS_RETURN(napi_create_buffer_copy(env, value.size(), value.data(), nullptr, &element));
           }
-          NAPI_STATUS_RETURN(napi_set_element(env, argv[1], static_cast<uint32_t>(idx), element));
+          NAPI_STATUS_RETURN(napi_set_element(env, argv[1], idx, element));
         }
 
         return napi_ok;
@@ -1616,35 +1555,22 @@ NAPI_METHOD(batch_write) {
   bool lowPriority = false;
   NAPI_STATUS_THROWS(GetProperty(env, options, "lowPriority", lowPriority));
 
-  rocksdb::WriteOptions writeOptions;
-  writeOptions.sync = sync;
-  writeOptions.low_pri = lowPriority;
-  writeOptions.no_slowdown = true;
-
-  const auto status = database->db->Write(writeOptions, batch);
+  // TODO (fix): This ref can leak on error...
+  napi_ref batchRef;
+  NAPI_STATUS_THROWS(napi_create_reference(env, argv[1], 1, &batchRef));
 
-  if (status == rocksdb::Status::Incomplete()) {
-    napi_ref batchRef;
-    NAPI_STATUS_THROWS(napi_create_reference(env, argv[1], 1, &batchRef));
-
-    runAsync<int64_t>(
-        "leveldown.batch.write", env, callback,
-        [=](int64_t& seq) {
-          rocksdb::WriteOptions writeOptions;
-          writeOptions.sync = sync;
-          writeOptions.low_pri = lowPriority;
-          return database->db->Write(writeOptions, batch);
-        },
-        [=](int64_t& seq, auto env, auto& argv) {
-          NAPI_STATUS_RETURN(napi_delete_reference(env, batchRef));
-          return napi_ok;
-        });
-
-    NAPI_STATUS_THROWS(napi_get_boolean(env, false, &result));
-  } else {
-    ROCKS_STATUS_THROWS_NAPI(status);
-    NAPI_STATUS_THROWS(napi_get_boolean(env, true, &result));
-  }
+  runAsync<int64_t>(
+      "leveldown.batch.write", env, callback,
+      [=](int64_t& seq) {
+        rocksdb::WriteOptions writeOptions;
+        writeOptions.sync = sync;
+        writeOptions.low_pri = lowPriority;
+        return database->db->Write(writeOptions, batch);
+      },
+      [=](int64_t& seq, auto env, auto& argv) {
+        NAPI_STATUS_RETURN(napi_delete_reference(env, batchRef));
+        return napi_ok;
+      });
 
   return result;
 }
@@ -1706,7 +1632,6 @@ NAPI_INIT() {
   NAPI_EXPORT_FUNCTION(db_get_location);
   NAPI_EXPORT_FUNCTION(db_close);
   NAPI_EXPORT_FUNCTION(db_get_many);
-  NAPI_EXPORT_FUNCTION(db_get_many_sync);
   NAPI_EXPORT_FUNCTION(db_clear);
   NAPI_EXPORT_FUNCTION(db_get_property);
   NAPI_EXPORT_FUNCTION(db_get_latest_sequence);

package/deps/rocksdb/rocksdb/README.md

@@ -0,0 +1,29 @@
+## RocksDB: A Persistent Key-Value Store for Flash and RAM Storage
+
+[![CircleCI Status](https://circleci.com/gh/facebook/rocksdb.svg?style=svg)](https://circleci.com/gh/facebook/rocksdb)
+
+RocksDB is developed and maintained by Facebook Database Engineering Team.
+It is built on earlier work on [LevelDB](https://github.com/google/leveldb) by Sanjay Ghemawat (sanjay@google.com)
+and Jeff Dean (jeff@google.com)
+
+This code is a library that forms the core building block for a fast
+key-value server, especially suited for storing data on flash drives.
+It has a Log-Structured-Merge-Database (LSM) design with flexible tradeoffs
+between Write-Amplification-Factor (WAF), Read-Amplification-Factor (RAF)
+and Space-Amplification-Factor (SAF). It has multi-threaded compactions,
+making it especially suitable for storing multiple terabytes of data in a
+single database.
+
+Start with example usage here: https://github.com/facebook/rocksdb/tree/main/examples
+
+See the [github wiki](https://github.com/facebook/rocksdb/wiki) for more explanation.
+
+The public interface is in `include/`.  Callers should not include or
+rely on the details of any other header files in this package.  Those
+internal APIs may be changed without warning.
+
+Questions and discussions are welcome on the [RocksDB Developers Public](https://www.facebook.com/groups/rocksdb.dev/) Facebook group and [email list](https://groups.google.com/g/rocksdb) on Google Groups.
+
+## License
+
+RocksDB is dual-licensed under both the GPLv2 (found in the COPYING file in the root directory) and Apache 2.0 License (found in the LICENSE.Apache file in the root directory).  You may select, at your option, one of the above-listed licenses.

package/deps/rocksdb/rocksdb/microbench/README.md

@@ -0,0 +1,60 @@
+# RocksDB Micro-Benchmark
+
+## Overview
+
+RocksDB micro-benchmark is a set of tests for benchmarking a single component or simple DB operations. The test artificially generates input data and executes the same operation with it to collect and report performance metrics. As it's focusing on testing a single, well-defined operation, the result is more precise and reproducible, which also has its limitation of not representing a real production use case. The test author needs to carefully design the microbench to represent its true purpose.
+
+The tests are based on [Google Benchmark](https://github.com/google/benchmark) library, which provides a standard framework for writing benchmarks.
+
+## How to Run
+### Prerequisite
+Install the [Google Benchmark](https://github.com/google/benchmark) version `1.6.0` or above.
+
+*Note: Google Benchmark `1.6.x` is incompatible with previous versions like `1.5.x`, please make sure you're using the newer version.*
+
+### Build and Run
+With `Makefile`:
+```bash
+$ DEBUG_LEVEL=0 make run_microbench
+```
+Or with cmake:
+```bash
+$ mkdir build && cd build && cmake .. -DCMAKE_BUILD_TYPE=Release -DWITH_BENCHMARK
+$ make run_microbench
+```
+
+*Note: Please run the benchmark code in release build.*
+### Run Single Test
+Example:
+```bash
+$ make db_basic_bench
+$ ./db_basic_bench --benchmark_filter=<TEST_NAME>
+```
+
+## Best Practices
+#### * Use the Same Test Directory Setting as Unittest
+Most of the Micro-benchmark tests use the same test directory setup as unittest, so it could be overridden by:
+```bash
+$ TEST_TMPDIR=/mydata/tmp/ ./db_basic_bench --benchmark_filter=<TEST_NAME>
+```
+Please also follow that when designing new tests.
+
+#### * Avoid Using Debug API
+Even though micro-benchmark is a test, avoid using internal Debug API like TEST_WaitForRun() which is designed for unittest. As benchmark tests are designed for release build, don't use any of that.
+
+#### * Pay Attention to Local Optimization
+As a micro-benchmark is focusing on a single component or area, make sure it is a key part for impacting the overall application performance.
+
+The compiler might be able to optimize the code that not the same way as the whole application, and if the test data input is simple and small, it may be able to all cached in CPU memory, which is leading to a wrong metric. Take these into consideration when designing the tests.
+
+#### * Names of user-defined counters/metrics has to be `[A-Za-z0-9_]`
+It's a restriction of the metrics collecting and reporting system RocksDB is using internally. It will also help integrate with more systems.
+
+#### * Minimize the Metrics Variation
+Try reducing the test result variation, one way to check that is running the test multiple times and check the CV (Coefficient of Variation) reported by gbenchmark.
+```bash
+$ ./db_basic_bench --benchmark_filter=<TEST_NAME> --benchmark_repetitions=10
+...
+<TEST_NAME>_cv    3.2%
+```
+RocksDB has background compaction jobs which may cause the test result to vary a lot. If the micro-benchmark is not purposely testing the operation while compaction is in progress, it should wait for the compaction to finish (`db_impl->WaitForCompact()`) or disable auto-compaction.

package/deps/rocksdb/rocksdb/plugin/README.md

@@ -0,0 +1,43 @@
+## Building external plugins together with RocksDB
+
+RocksDB offers several plugin interfaces for developers to customize its behavior. One difficulty developers face is how to make their plugin available to end users. The approach discussed here involves building the external code together with the RocksDB code into a single binary. Note another approach we plan to support involves loading plugins dynamically from shared libraries.
+
+### Discovery
+
+We hope developers will mention their work in "PLUGINS.md" so users can easily discover and reuse solutions for customizing RocksDB.
+
+### Directory organization
+
+External plugins will be linked according to their name into a subdirectory of "plugin/". For example, a plugin called "dedupfs" would be linked into "plugin/dedupfs/".
+
+### Build standard
+
+Currently the only supported build system are make and cmake.
+
+For make, files in the plugin directory ending in the .mk extension can define the following variables.
+
+* `$(PLUGIN_NAME)_SOURCES`: these files will be compiled and linked with RocksDB. They can access RocksDB public header files.
+* `$(PLUGIN_NAME)_HEADERS`: these files will be installed in the RocksDB header directory. Their paths will be prefixed by "rocksdb/plugin/$(PLUGIN_NAME)/".
+* `$(PLUGIN_NAME)_LDFLAGS`: these flags will be passed to the final link step. For example, library dependencies can be propagated here, or symbols can be forcibly included, e.g., for static registration.
+* `$(PLUGIN_NAME)_CXXFLAGS`: these flags will be passed to the compiler. For example, they can specify locations of header files in non-standard locations.
+
+Users will run the usual make commands from the RocksDB directory, specifying the plugins to include in a space-separated list in the variable `ROCKSDB_PLUGINS`.
+
+For CMake, the CMakeLists.txt file in the plugin directory can define the following variables.
+
+* `${PLUGIN_NAME}_SOURCES`: these files will be compiled and linked with RocksDB. They can access RocksDB public header files.
+* `${PLUGIN_NAME}_COMPILE_FLAGS`: these flags will be passed to the compiler. For example, they can specify locations of header files in non-standard locations.
+* `${PLUGIN_NAME}_INCLUDE_PATHS`: paths to directories to search for plugin-specific header files during compilation.
+* `${PLUGIN_NAME}_LIBS`: list of library names required to build the plugin, e.g. `dl`, `java`, `jvm`, `rados`, etc. CMake will generate proper flags for linking.
+* `${PLUGIN_NAME}_LINK_PATHS`: list of paths for the linker to search for required libraries in additional to standard locations.
+* `${PLUGIN_NAME}_CMAKE_SHARED_LINKER_FLAGS` additional linker flags used to generate shared libraries. For example, symbols can be forcibly included, e.g., for static registration.
+* `${PLUGIN_NAME}_CMAKE_EXE_LINKER_FLAGS`: additional linker flags used to generate executables. For example, symbols can be forcibly included, e.g., for static registration.
+
+Users will run the usual cmake commands, specifying the plugins to include in a space-separated list in the command line variable `ROCKSDB_PLUGINS` when invoking cmake.
+```
+cmake .. -DROCKSDB_PLUGINS="dedupfs hdfs rados"
+```
+
+### Example
+
+For a working example, see [Dedupfs](https://github.com/ajkr/dedupfs).

package/deps/rocksdb/rocksdb/port/README

@@ -0,0 +1,10 @@
+This directory contains interfaces and implementations that isolate the
+rest of the package from platform details.
+
+Code in the rest of the package includes "port.h" from this directory.
+"port.h" in turn includes a platform specific "port_<platform>.h" file
+that provides the platform specific implementation.
+
+See port_posix.h for an example of what must be provided in a platform
+specific header file.
+

package/deps/rocksdb/rocksdb/utilities/transactions/lock/range/range_tree/lib/README

@@ -0,0 +1,13 @@
+The files in this directory originally come from
+https://github.com/percona/PerconaFT/.
+
+This directory only includes the "locktree" part of PerconaFT, and its
+dependencies.
+
+The following modifications were made:
+- Make locktree usable outside of PerconaFT library
+- Add shared read-only lock support
+
+The files named *_subst.* are substitutes of the PerconaFT's files, they
+contain replacements of PerconaFT's functionality.
+

package/index.js

@@ -171,10 +171,6 @@ class RocksLevel extends AbstractLevel {
     return callback[kPromise]
   }
 
-  _getManySync (keys, options) {
-    return binding.db_get_many_sync(this[kContext], keys, options ?? EMPTY)
-  }
-
   _getMergeOperands (key, options, callback) {
     callback = fromCallback(callback, kPromise)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/rocksdb",
-  "version": "10.0.20",
+  "version": "10.1.2",
   "description": "A low-level Node.js RocksDB binding",
   "license": "MIT",
   "main": "index.js",
@@ -27,6 +27,8 @@
     "du": "^1.0.0",
     "faucet": "^0.0.3",
     "glob": "^8.0.3",
+    "lru-cache": "^11.0.0",
+    "mitata": "^0.1.11",
     "mkfiletree": "^2.0.0",
     "node-gyp": "^9.3.0",
     "nyc": "^15.0.0",

package/tmp/CURRENT

@@ -0,0 +1 @@
+MANIFEST-000104

package/tmp/IDENTITY

@@ -0,0 +1 @@
+6d5096a1-16eb-423d-8e1e-c703b4fdbc14