aerospike 6.2.0 → 6.3.0

package/README.md

@@ -11,14 +11,14 @@
 
 The Aerospike Node.js client is a Node.js add-on module, written using V8.
 
-The client is compatible with Node.js 23, Node.js 22, (LTS), Node.js 20 (LTS),and 18 (LTS).
+The client is compatible with Node.js 24 (LTS), Node.js 22 (LTS), and Node.js 20 (LTS).
 It supports the following operating systems:
 - RHEL 8/9
 - Debian 11
 - Amazon Linux 2023
-- Ubuntu 20.04/22.04/24.04 (Focal Fossa, Jammy Jellyfish, Noble Numbat)
+- Ubuntu 22.04/24.04 (Focal Fossa, Jammy Jellyfish, Noble Numbat)
 - Many Linux distributions compatible with one of the above OS releases.
-- macOS 12/13/14
+- macOS 13/14/15
 
 The client is compatible with arm64, aarch64, and x86_64 architectures.
 
@@ -46,21 +46,16 @@ by requiring the module by name.
 
 ### npm Registry Installations
 
-To install `aerospike` as a dependency of your project, in your project directory run:
+To install `aerospike` as a dependency in your project:
 
 ```bash
 npm install aerospike
 ```
 
-To add `aerospike` as a dependency in _package.json_, run:
+To import the module in your application:
 
 ```bash
-npm install aerospike --save-dev
-```
-
-To require the module in your application:
-```bash
-const Aerospike = require('aerospike')
+import Aerospike from 'aerospike';
 ```
 
 ## Usage
@@ -69,67 +64,39 @@ The following is very simple example how to create, update, read and remove a
 record using the Aerospike database.
 
 ```js
-const Aerospike = require('aerospike')
+import Aerospike from 'aerospike';
+
+ 
+
+const main = async () => { 
+
+  let client
+
+  try {
+
+    client = await Aerospike.connect({hosts: '127.0.0.1:3000'});
+
+    const key = new Aerospike.Key('test', 'dataset', 123);
+
+    await client.put(key, {foo: "bar", baz: "qux"}, [], null);
+
+    const record = await client.get(key);
+
+    console.info("Record created\nRecord: %o\n", record.bins);
+
+  } catch (e) {
+
+    console.error(e)
+
+  } finally {
+
+    client && client.close();
+
+  }
 
-// INSERT HOSTNAME AND PORT NUMBER OF AEROSPIKE SERVER NODE HERE!
-const config = {
-  hosts: '192.168.33.10:3000',
 }
 
-const key = new Aerospike.Key('test', 'demo', 'demo')
-
-Aerospike.connect(config)
-  .then(client => {
-    const bins = {
-      i: 123,
-      s: 'hello',
-      b: Buffer.from('world'),
-      d: new Aerospike.Double(3.1415),
-      g: Aerospike.GeoJSON.Point(103.913, 1.308),
-      l: [1, 'a', {x: 'y'}],
-      m: {foo: 4, bar: 7}
-    }
-    const meta = { ttl: 10000 }
-    const policy = new Aerospike.WritePolicy({
-      exists: Aerospike.policy.exists.CREATE_OR_REPLACE,
-      // Timeouts disabled, latency dependent on server location. Configure as needed.
-      socketTimeout : 0, 
-      totalTimeout : 0
-    })
-
-    return client.put(key, bins, meta, policy)
-      .then(() => {
-        const ops = [
-          Aerospike.operations.incr('i', 1),
-          Aerospike.operations.read('i'),
-          Aerospike.lists.append('l', 'z'),
-          Aerospike.maps.removeByKey('m', 'bar')
-        ]
-
-        return client.operate(key, ops)
-      })
-      .then(result => {
-        console.log(result.bins) // => { i: 124, l: 4, m: null }
-
-        return client.get(key)
-      })
-      .then(record => {
-        console.log(record.bins) // => { i: 124,
-                                 //      s: 'hello',
-                                 //      b: <Buffer 77 6f 72 6c 64>,
-                                 //      d: 3.1415,
-                                 //      g: '{"type":"Point","coordinates":[103.913,1.308]}',
-                                 //      l: [ 1, 'a', { x: 'y' }, 'z' ],
-                                 //      m: { foo: 4 } }
-      })
-      .then(() => client.close())
-  })
-  .catch(error => {
-    console.error('Error: %s [%i]', error.message, error.code)
-    if (error.client) {
-      error.client.close()
-    }
-  })
+main();
 ```
 ## Prerequisites
 
@@ -222,44 +189,6 @@ We recommend using brew to install OpenSSL:
 brew install openssl
 ```
 
-For a Mac using ARM architecture, OpenSSL should be linked as shown below:
-
-```bash
-# When building from source before version 5.6 with openssl@3
-sudo ln -s /opt/homebrew/opt/openssl@3/ /usr/local/opt/openssl;
-# link here if before version 5.6.0
-sudo ln -s /opt/homebrew/opt/openssl@3/ /usr/local/opt/openssl@3;
-
-# When building from source with openssl@1.1
-sudo ln -s /opt/homebrew/opt/openssl@1.1/ /usr/local/opt/openssl;
-# link here if before version 5.6.0 with openssl@1.1
-sudo ln -s /opt/homebrew/opt/openssl@1.1/ /usr/local/opt/openssl@1.1;
-```
-
-For a Mac using X86 architecture, OpenSSL should be linked as shown below:
-
-```bash
-# When building from source before version 5.6 with openssl@1.1
-sudo ln -s /opt/homebrew/opt/openssl@1.1/ /usr/local/opt/openssl;
-# link here if before version 5.6.0 with openssl@1.1
-sudo ln -s /opt/homebrew/opt/openssl@1.1/ /usr/local/opt/openssl@1.1;
-```
-
-Before version 5.6.0, you may need to some add some variables to your profile for OpenSSL to be found.
-
-```bash
-export PATH="/usr/local/bin/:/usr/local/opt/openssl/bin:$PATH"
-export LDFLAGS="-L/usr/local/opt/openssl/lib"
-export CPPFLAGS="-I/usr/local/opt/openssl/include"  
-export EXT_CFLAGS="-I/usr/local/opt/openssl/include"
-# Make sure to source the changes to your shell profile
-source ~/.bashrc
-source ~/.profile
-source ~/.zshrc
-```
-
-For 4x client support, install OpenSSL&#64;1.1 version.
-
 **LIBUV Library**
 
 Libuv is needed to build the Aerospike C Client. If downloading from NPM at version 5.6.0 or later, you will not need to 
@@ -274,11 +203,6 @@ brew install libuv
 
 For a Mac using ARM architecture, Libuv should be linked as shown below:
 
-```bash
-# When building from source before version 5.6
-sudo ln -s /opt/homebrew/opt/libuv/ /usr/local/opt/libuv;
-```
-
 ### Git Repository Installations
 
 When using a cloned repository, install `aerospike` as a dependency of your application. Instead of referencing the module by name, you reference it by path.
@@ -296,24 +220,24 @@ Run the following commands to build the C client:
   ./scripts/build-c-client.sh
 ```
 
-#### Building and installing Node.js client
+#### Building and installing the C++ addon for the Node.js client
 
-To install the module as a dependency of your application, run the following in the application directory:
+To build and install the module as a dependency of your application:
 
 ```bash
 npm install --unsafe-perm --build-from-source
 ```
 
-To require it in the application:
+To import the module in your application:
 
 ```bash
-const Aerospike = require('aerospike')
+import Aerospike from 'aerospike';
 ```
 
 ## Documentation
 
 Access the client API documentation at:
-[https://docs.aerospike.com/apidocs/nodejs](https://docs.aerospike.com/apidocs/nodejs).
+[https://docs.aerospike.com/apidocs/nodejs](https://docs.aerospike.com/apidocs/nodejs/).
 This documentation is built from the client's source using [JSDocs
 v4](https://www.npmjs.com/package/jsdoc) for every release.
 
@@ -340,8 +264,8 @@ second and third version number, are always backwards compatible.
 
 ## Tests
 
-The client includes a comprehensive test suite using
-[Mocha](http://mochajs.org). The tests can be found in the repository under test directory.
+The client includes a comprehensive typescript test suite using
+[Mocha](http://mochajs.org). The tests can be found in the repository under ts-test directory.
 
 Before running the tests, you need to update the dependencies:
 
@@ -355,6 +279,12 @@ To run a specific tests, use:
 
     npm test --testfile=filename.js
 
+Various options can be provided, such as host, port, and password information
+
+    npm run test --testfile=metrics.js    --   -h localhost --port 3000 -t 60000 -U superuser -P superuser
+
+To see the options, see `ts-test/test/util/options.ts` for a full list.
+
 Note: make sure your server has TTL enabled for the `test` namespace ([Namespace Retention Configuration](https://docs.aerospike.com/server/operations/configure/namespace/retention)) to allow all tests to run correctly.
 
 To run the tests and also report on test coverage:
@@ -372,4 +302,4 @@ License, Version 2, as stated in the LICENSE file.
 
 Individual files may be made available under their own specific license, all
 compatible with Apache License, Version 2. Refer to individual files for
-details.
+details.

package/aerospike-client-c.ini

@@ -1,3 +1,3 @@
 
 # Version number of the dependencies package for C client (Windows only)
-AEROSPIKE_C_DEPS_VERSION=1.0.2
+AEROSPIKE_C_DEPS_VERSION=1.0.3

package/aerospike-client-c.sha256

@@ -1 +1 @@
-BB7AEB63571E63FD6C9CD042DC1810743DF9C8F122C91EAFB705C2E08B87733A  aerospike-client-c-dependencies.1.0.2.zip
+4804B9B02688FEEE73C95ACAE87DCC839831155EE1E101B5126E7CD317644CFB  aerospike-client-c-dependencies.1.0.3.zip

package/binding.gyp

@@ -55,7 +55,7 @@
                     '-NodeLibFile', "<(node_root_dir)/<(target_arch)/node.lib"
               ]
             }
-          ]
+          ],
         }],
       ]
     },
@@ -129,10 +129,12 @@
         'src/main/commands/scan_background.cc',
         'src/main/commands/scan_pages.cc',
         'src/main/commands/select_async.cc',
+        'src/main/commands/set_password.cc',
         'src/main/commands/transaction_abort.cc',
         'src/main/commands/transaction_commit.cc',
         'src/main/commands/truncate.cc',
         'src/main/commands/user_create.cc',
+        'src/main/commands/user_create_pki.cc',
         'src/main/commands/user_drop.cc',
         'src/main/commands/udf_register.cc',
         'src/main/commands/udf_remove.cc',
@@ -180,7 +182,8 @@
         ['OS=="linux"',{
           'libraries': [
             '../aerospike-client-c/target/Linux-<(build_arch)/lib/libaerospike.a',
-            '-lz'
+            '-lz',
+            '-lyaml'
           ],
           'defines': [
             'AS_USE_LIBUV'
@@ -196,7 +199,8 @@
         ['OS=="mac"',{
           'libraries': [
             '../aerospike-client-c/target/Darwin-<(build_arch)/lib/libaerospike.a',
-            '-lz'
+            '-lz',
+            '-lyaml'
           ],
           'defines': [
             'AS_USE_LIBUV'

package/examples/README.md

@@ -64,7 +64,10 @@ The following are the included examples:
     performing aggregation using UDFs
   - scan - Run a scan on an entire namespace or set
   - sindex - Manage secondary indexes (create/remove index)
+  - Connect- Connect to aerospike
   - udf - Manage User-Defined Functions (create/remove module)
+  - metrics - Enable metrics with custom settings.
+  - dynamicConfig - Connect with a dynamic configuration.
 - **Complex Examples**
   - geospatialMonteCarlo - Performs a Monte Carlo simulation to approximate PI
     using Aerospike's geospatial indexing and query functionality

package/examples/connect.js

@@ -0,0 +1,52 @@
+#!/usr/bin/env node
+// *****************************************************************************
+// Copyright 2025 Aerospike, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License")
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// *****************************************************************************
+//
+const Aerospike = require('aerospike')
+const shared = require('./shared')
+
+shared.runner()
+
+async function connect (client, argv) {
+  const config = {
+    hosts: [
+      { addr: argv.hosts, port: argv.port }
+    ]
+  }
+  if (argv.user) {
+    config.user = argv.user
+  }
+
+  if (argv.password) {
+    config.password = argv.password
+  }
+  let cli = null
+  try {
+    cli = await Aerospike.connect(config)
+    console.log('Connected!')
+  } catch (error) {
+    console.log('Failed with: ' + error)
+  } finally {
+    if (client) {
+      await cli.close()
+    }
+  }
+}
+
+exports.command = 'connect'
+exports.describe = 'Connect to the database'
+exports.handler = shared.run(connect)
+exports.builder = {}

package/examples/dynamicConfig.js

@@ -0,0 +1,64 @@
+#!/usr/bin/env node
+// *****************************************************************************
+// Copyright 2025 Aerospike, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License")
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// *****************************************************************************
+//
+const Aerospike = require('aerospike')
+const shared = require('./shared')
+
+shared.runner()
+
+async function dynamicConfig (client, argv) {
+  const config = {
+    hosts: [
+      { addr: argv.hosts, port: argv.port }
+    ],
+    configProvider: {
+      path: argv.dcp,
+      interval: 1
+    }
+  }
+  if (argv.user) {
+    config.user = argv.user
+  }
+
+  if (argv.password) {
+    config.password = argv.password
+  }
+  let cli = null
+  try {
+    console.log('Connecting...')
+    cli = await Aerospike.connect(config)
+    console.log('Connected!')
+  } catch (error) {
+    console.log('Failed with: ' + error)
+  } finally {
+    if (client) {
+      await cli.close()
+    }
+  }
+}
+
+exports.command = 'dynamicConfig'
+exports.describe = 'Dynamic Config'
+exports.handler = shared.run(dynamicConfig)
+exports.builder = {
+  dynamic_config_path: {
+    alias: 'dcp',
+    describe: 'Path of dynamic config',
+    type: 'string',
+    default: './example_config/config.yml'
+  }
+}

package/examples/example_config/config.yml

@@ -0,0 +1,13 @@
+metadata:
+  app_name: configurationExample
+  generation: 2
+  version: 0.0.1
+static:
+  client:
+    config_interval: 2
+dynamic:
+  write:
+    send_key: false
+static:
+  client:
+    config_interval: 1

package/examples/metrics.js

@@ -0,0 +1,129 @@
+#!/usr/bin/env node
+// *****************************************************************************
+// Copyright 2013-2024 Aerospike, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License")
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// *****************************************************************************
+
+const Aerospike = require('aerospike')
+const shared = require('./shared')
+
+shared.runner()
+
+async function metrics (client, argv) {
+  const policy = {}
+  if (argv.customListeners) {
+    const listeners = new Aerospike.MetricsListeners(
+      {
+        enableListener,
+        disableListener,
+        nodeCloseListener,
+        snapshotListener
+      }
+    )
+    policy.metricsListeners = listeners
+  }
+  if (argv.reportDir) {
+    policy.reportDir = argv.reportDir
+  }
+  if (argv.reportSizeLimit) {
+    policy.reportSizeLimit = argv.reportSizeLimit
+  }
+  if (argv.interval) {
+    policy.interval = argv.interval
+  }
+  if (argv.latencyColumns) {
+    policy.latencyColumns = argv.latencyColumns
+  }
+  if (argv.latencyShift) {
+    policy.latencyShift = argv.latencyShift
+  }
+  if (argv.labels) {
+    policy.labels = argv.labels
+  }
+  if (argv.appId) {
+    policy.appId = argv.appId
+  }
+  console.log('Enabling Metrics with the following policy:')
+  console.log(policy)
+  await client.enableMetrics(policy)
+  await new Promise(resolve => setTimeout(resolve, 5000))
+  await client.disableMetrics()
+  await new Promise(resolve => setTimeout(resolve, 0)) // Let the event loop cycle and allows disable listener to fire.
+}
+
+function enableListener () {
+  console.log('Enable listener called.')
+}
+
+function snapshotListener (cluster) {
+  console.log('Snapshot listener called')
+  console.log(cluster)
+}
+
+function nodeCloseListener (node) {
+  console.log('Node Close listener called')
+  console.log(node)
+}
+
+function disableListener (cluster) {
+  console.log('Disabled listener called')
+  console.log(cluster)
+}
+
+exports.command = 'metrics'
+exports.describe = 'Enable Client metrics'
+exports.handler = shared.run(metrics)
+exports.builder = {
+  customListeners: {
+    describe: 'Use custom listener callbacks defined with nodejs functions',
+    type: 'boolean',
+    default: false
+  },
+  reportDir: {
+    describe: 'Directory in which metrics reports will be placed',
+    type: 'string',
+    default: '.'
+  },
+  reportSizeLimit: {
+    describe: 'Metrics file size soft limit in bytes for listeners that write logs.',
+    type: 'number',
+    default: 1000000
+  },
+  interval: {
+    describe: 'Number of cluster tend iterations between metrics notification events.',
+    type: 'number',
+    default: 2
+  },
+  latencyColumns: {
+    describe: 'Number of elapsed time range buckets in latency histograms.',
+    type: 'number',
+    default: 7
+  },
+  latencyShift: {
+    describe: 'Power of 2 multiple between each range bucket in latency histograms starting at column 3.',
+    type: 'number',
+    default: 1
+  },
+  labels: {
+    describe: 'List of name/value labels that is applied when exporting metrics.',
+    type: 'array',
+    default: []
+  },
+  appId: {
+    describe: 'Application identifier that is applied when exporting metrics.',
+    type: 'string',
+    default: '.'
+  }
+
+}

package/examples/package-lock.json

@@ -15,7 +15,8 @@
       }
     },
     "..": {
-      "version": "5.6.0",
+      "name": "aerospike",
+      "version": "6.2.0",
       "cpu": [
         "x64",
         "arm64"
@@ -28,28 +29,36 @@
         "win32"
       ],
       "dependencies": {
-        "@mapbox/node-pre-gyp": "^1.0.11",
+        "ansi-colors": "^4.1.3",
         "bindings": "^1.5.0",
         "minimatch": "^3.1.2",
-        "nan": "^2.17.0",
-        "node-gyp": "^8.4.1"
+        "nan": "^2.22.0",
+        "node-gyp": "^10.1.0",
+        "npm-run-all": "^4.1.5"
       },
       "devDependencies": {
-        "@types/node": "^17.0.45",
-        "chai": "^4.3.7",
+        "@eslint/js": "^9.12.0",
+        "@mapbox/node-pre-gyp": "^1.0.11",
+        "@types/node": "^22.7.4",
+        "chai": "^4.4.1",
         "choma": "^1.2.1",
         "codecov": "^3.8.3",
         "deep-eql": "^4.1.3",
-        "dirty-chai": "^2.0.1",
-        "husky": "^7.0.4",
-        "mocha": "^9.2.2",
+        "eslint": "^8.57.1",
+        "globals": "^15.11.0",
+        "husky": "^9.0.11",
+        "mocha": "^10.4.0",
         "mocha-clean": "^1.0.0",
         "nyc": "^15.1.0",
         "p-throttle": "^3.1.0",
-        "semver": "^7.5.4",
-        "standard": "^16.0.4",
-        "tmp": "^0.1.0",
-        "yargs": "^15.4.1"
+        "semver": "^7.6.0",
+        "standard": "^17.1.0",
+        "tmp": "^0.2.3",
+        "typedoc": "^0.26.7",
+        "typedoc-plugin-rename-defaults": "^0.7.1",
+        "typescript": "^5.6.2",
+        "typescript-eslint": "^8.8.1",
+        "yargs": "^17.7.2"
       },
       "engines": {
         "node": ">=4"

package/examples/run.js

@@ -24,10 +24,13 @@ const commands = [
   'append',
   'apply',
   'batch',
+  'connect',
+  'dynamicConfig',
   'exists',
   'geospatialMonteCarlo',
   'get',
   'info',
+  'metrics',
   'mrtAbort',
   'mrtCommit',
   'operate',