aerospike 4.0.4 → 5.0.2

package/README.md

@@ -9,26 +9,8 @@
 [downloads-image]: https://img.shields.io/npm/dm/aerospike.svg
 [downloads-url]: http://npm-stat.com/charts.html?package=aerospike
 
-An Aerospike add-on module for Node.js.
+The Aerospike Node.js client is a Node.js add-on module, written using V8.
 
-The client is compatible with Node.js 10, 12 (LTS), 14 (LTS), and 16 (LTS). It
-supports the following operating systems: CentOS/RHEL 7/8, Debian 8/9/10,
-Ubuntu 18.04/20.04, as well as many Linux distributions compatible with one of
-these OS releases. macOS is also supported. The client port to Windows is a
-community supported project and suitable for application prototyping and
-development.
-
-- [Usage](#Usage)
-- [Prerequisites](#Prerequisites)
-- [Installation](#Installation)
-  - [Primer on Node.js Modules](#Primer-on-Node.js-Modules)
-  - [Installing via npm Registry](#Installing-via-npm-Registry)
-  - [Installing via Git Repository](#Installing-via-Git-Repository)
-- [Documentation](#Documentation)
-- [Tests](#Tests)
-- [Benchmarks](#Benchmarks)
-
-<a name="Usage"></a>
 ## Usage
 
 The following is very simple example how to create, update, read and remove a
@@ -93,62 +75,92 @@ Aerospike.connect(config)
   })
 ```
 
-<a name="Prerequisites"></a>
 ## Prerequisites
 
+The client is compatible with Node.js 10, 12 (LTS), 14 (LTS), 16 (LTS) and 18 (LTS). It
+supports the following operating systems: CentOS/RHEL 7/8, Debian 8/9/10/11,
+Ubuntu 18.04/20.04, as well as many Linux distributions compatible with one of
+these OS releases. macOS is also supported. The client port to Windows is a
+community supported project and suitable for application prototyping and
+development.
+
 The Aerospike Node.js client supports all Node.js [LTS
 releases](https://github.com/nodejs/Release#release-schedule). To download and
 install the latest stable version of Node.js, visit
 [nodejs.org](http://nodejs.org/) or use the version that comes bundled with
 your operating system.
 
-The package includes a native add-on. `gcc`/`g++` v4.8 or newer or
-`clang`/`clang++` v3.4 or newer are required to build the add-on.
+Install the necessary "development tools" and other libraries to build the client software.
+
+Reference various docker files in the repository under the docker / directory for more information.
+
+#### CentOS/RHEL
+
+To install library prerequisites using `yum`:
 
-The package has the following compile time/run time dependencies:
+```bash
+sudo yum group install "Development Tools" 
+sudo yum install openssl openssl-devel
+sudo yum install python3 python3-devel
+```
 
-| Library Name | Description |
-| --- | --- |
-| libssl | |
-| libcrypto | Required for RIPEMD160 hash function. |
-| libz | Required for (optional) command compression. |
+#### Alpine Linux
 
-### CentOS/RHEL
+```bash
+apk add build-base \
+    linux-headers \
+    bash \
+    libuv-dev \
+    openssl-dev \
+    lua5.1-dev \
+    zlib-dev \
+    git \
+    python3
+```
 
-To install library prerequisites via `yum`:
+#### Amazon Linux
 
 ```bash
-sudo yum install gcc-c++ openssl-devel zlib-devel
+yum groupinstall "Development Tools"
+yum install openssl openssl-devel
+yum install python3 python3-devel
 ```
 
-### Debian
+#### Debian
 
-To install library prerequisites via `apt-get`:
+To install library prerequisites using `apt-get`:
 
 ```bash
-sudo apt-get install g++ libssl1.0.0 libssl-dev libz-dev
+sudo apt -y install software-properties-common
+sudo apt -y install build-essential
+sudo apt -y install libssl-dev
+sudo apt -y install libarchive-dev cmake rsync curl libcurl4-openssl-dev zip
+sudo apt -y install python3 python3-dev python3-pip
+sudo apt install zlib1g-dev libncurses5-dev libgdbm-dev libnss3-dev \
+    libsqlite3-dev libreadline-dev libffi-dev libbz2-dev -y
+sudo apt -y install wget libtool m4 automake
 ```
 
-### Ubuntu
+#### Ubuntu
 
-To install library prerequisites via `apt-get`:
+To install library prerequisites using `apt`:
 
 ```bash
-sudo apt-get install g++ libssl1.0.0 libssl-dev zlib1g-dev
+sudo apt install g++ libssl libssl-dev zlib1g-dev
 ```
 
-### Mac OS X (Intel)
+### macOS (Intel)
 
-Before starting with the Aerospike Nodejs Client, please make sure the following prerequisites are met:
+Before starting with the Aerospike Nodejs Client, verify that you have the following prerequisites:
 
-- Mac OS X 10.8 or greater.
+- macOS 10.8 or greater.
 - Xcode 5 or greater.
 
-### Mac OS X (M1 Chip)
+### macOS (M1 Chip)
 
-Currently C library does not support M1, so you can't install Aerospike Nodejs Client directly on your mac, see [Issue](https://github.com/aerospike/aerospike-client-nodejs/issues/430).
-As a workaround, you can build your app inside of Docker with using `--platform` [option](https://docs.docker.com/engine/reference/commandline/build/).
-Example of working docker-compose.yaml file will look like this:
+Currently the C library does not support M1, so you cannot install Aerospike Nodejs Client directly on your mac, see [Issue](https://github.com/aerospike/aerospike-client-nodejs/issues/430).
+As a workaround, you can build your app inside of Docker before using `--platform` [option](https://docs.docker.com/engine/reference/commandline/build/).
+Example of a working docker-compose.yaml file looks similar to this:
 ```
 version: '2.4'
 services:
@@ -157,135 +169,98 @@ services:
     platform: linux/amd64
 ```
 
-#### Openssl library installation in Mac OS X.
+**Openssl Library**
+
+The below example shows how to install the Openssl library.
 
 ```bash
-$ brew install openssl@1.1
-$ brew link openssl@1.1 --force
+$ brew install openssl
+$ brew link openssl --force
 $ unlink /usr/local/opt/openssl
-$ ln -s /usr/local/Cellar/openssl@1.1/1.1.1o/ /usr/local/opt/openssl
+$ # Change the below linking based on openssl version and installation path
+$ ln -s /usr/local/Cellar/openssl@x/y.z/ /usr/local/opt/openssl
 ```
+For 4x client support, install openssl&#64;1.1 version.
 
-### Windows
+**LIBUV Library**
 
-See [Prerequisites for Aerospike Node.js Client on Windows](https://github.com/aerospike/aerospike-client-nodejs/blob/master/README_WINDOWS.md).
+The example below shows how to install the LIBUV library.
+
+```bash
+$ brew install libuv
+$ brew link libuv --force
+$ unlink /usr/local/opt/libuv
+$ # Change the below linking based on libuv version and installation path
+$ ln -s /usr/local/Cellar/libuv/1.44.1_1/ /usr/local/opt/libuv
+```
 
-<a name="Installation"></a>
 ## Installation
 
-The Aerospike Node.js client is a Node.js add-on module utilizing the Aerospike
-C client. The installation will attempt to install the pre-built binaries.
+The Aerospike Node.js client is an add-on module that uses the Aerospike C client. The installation will attempt to install the pre-built binaries including dependent C client.
 
-The Aerospike Node.js client can be installed like any other Node.js module, however
-we provided the following information for those not so familiar with Node.js modules.
+You can install the Aerospike Node.js client like any other Node.js module.
 
-<a name="Primer-on-Node.js-Modules"></a>
 ### Primer on Node.js Modules
 
 Node.js modules are containers of JavaScript code and a `package.json`, which defines
 the module, its dependencies and requirements. Modules are usually installed as
-dependencies of others Node.js application or module. The modules are installed in
+dependencies of other Node.js applications or modules. The modules are installed in
 the application's `node_modules` directory, and can be utilized within the program
 by requiring the module by name.
 
-A module may be installed in global location via the `-g` flag. The global location
-is usually reserved for modules that are not directly depended on by an application,
-but may have executables which you want to be able to call regardless of the
-application. This is usually the case for tools like tools like `npm` and `mocha`.
-
-<a name="Installing-via-npm-Registry"></a>
-### Installing via npm Registry
-
-Installing via npm Registry is pretty simple and most common install method, as
-it only involves a single step.
+### npm Registry Installations
 
-Although the module may be installed globally or locally, we recommend performing
-local installs.
+To install `aerospike` as a dependency of your project, in your project directory run:
 
-To install the module as a dependency of your application, run the following
-from your application's directory:
-
-	$ npm install aerospike
+```bash
+$ npm install aerospike
+```
 
-In most cases, an application should specify `aerospike` as a dependency in
-its `package.json`.
+To add `aerospike` as a dependency in _package.json_, run:
 
-Once installed, the module can be required in the application:
+```bash
+$ npm install aerospike --save-dev
+```
 
-	const Aerospike = require('aerospike')
+To require the module in your application:
+```bash
+const Aerospike = require('aerospike')
+```
 
-<a name="Installing-via-Git-Repository"></a>
-### Installing via Git Repository
+### Git Repository Installations
 
-The following is relevant for users who have cloned the repository, and want
-to install it as a dependency of their application.
+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.
 
 To clone the repository use the following command:
 
 	$ git clone --recursive git@github.com:aerospike/aerospike-client-nodejs.git
 
-Installing via Git Repository is slightly different from installing via npm
-registry, in that you will be referencing the module by path, rather than name.
-
-Although the module may be installed globally or locally, we recommend performing
-local installs.
-
-#### Building dependancy c client
+#### Building dependancy C client
 
-Make sure to build c client before doing npm install variants
-Run the following commands to build c-client:
+Make sure to build the C client before doing npm install variants
+Run the following commands to build the C client:
 
 	$ ./scripts/build-c-client.sh
 
-#### Installing Globally
-
-This option required root permissions. This will download the Aerospike C client
-only once, which will improve the experience of using the module for many users.
-However, you will need to first install the package globally using root permissions.
-
-Run the following as a user with root permission or using the sudo command:
-
-	$ npm install -g <PATH> --unsafe-perm --build-from-source
-
-Where `<PATH>` is the path to the Aerospike Node.js client's Git respository is
-located. This will install the module in a globally accessible location.
-
-To install the module as a dependency of your application, run the following
-from your application's directory:
-
-	$ npm link aerospike
+#### Building and installing Node.js client
 
-Linking to the module does not require root permission.
+To install the module as a dependency of your application, run the following in the application directory:
 
-Once linked, the module can be required in the application:
-
-	const Aerospike = require('aerospike')
-
-#### Installing Locally
-
-This option does not require root permissions to install the module as a
-dependency of an application. However, it will require resolving the Aerospike
-C client each time you install the dependency, as it will need to exist local
-to the application.
-
-To install the module as a dependency of your application, run the following
-from your application's directory:
-
-	$ npm install <PATH> --unsafe-perm --build-from-source
-
-Where `<PATH>` is the path to the Aerospike Node.js client's Git respository is
-located.
+```bash
+$ npm install --unsafe-perm --build-from-source
+```
 
-Once installed, the module can be required in the application:
+To require it in the application:
 
-	const Aerospike = require('aerospike')
+```bash
+const Aerospike = require('aerospike')
+```
 
-<a name="Documentation"></a>
 ## Documentation
 
-Detailed documentation of the client's API can be found at
-[http://www.aerospike.com/apidocs/nodejs](https://www.aerospike.com/apidocs/nodejs).
-This documentation is build from the client's source using [JSDocs
+Access the client API documentation at:
+[https://docs.aerospike.com/apidocs/nodejs](https://docs.aerospike.com/apidocs/nodejs).
+This documentation is built from the client's source using [JSDocs
 v3](http://usejsdoc.org/index.html) for every release.
 
 The API docs also contain a few basic tutorials:
@@ -297,23 +272,22 @@ The API docs also contain a few basic tutorials:
 A variety of additional example applications are provided in the
 [`examples`](examples) directory of this repository.
 
-Backward incompatible API changes by release are documented at
-https://www.aerospike.com/docs/client/nodejs/usage/incompatible.html.
+Access backward incompatible API changes by a release at:
+https://developer.aerospike.com/client/nodejs/usage/incompatible.
 
 ### API Versioning
 
 The Aerospike Node.js client library follows [semantic versioning](http://semver.org/).
-Changes which break backwards compatibility will be indicated by an increase in
-the major version number. Minor and patch releases, which increment only the
-second and third version number, will always be backwards compatible.
+By Aerospike versioning guidelines, changes which may break backwards compatibility are
+indicated by an increase in the major version number.
+Minor, or patch releases, which are incremented only the
+second and third version number, are always backwards compatible.
 
 
-<a name="Tests"></a>
 ## Tests
 
 The client includes a comprehensive test suite using
-[Mocha](http://mochajs.org). The tests can be found in the ['test'](test)
-directory.
+[Mocha](http://mochajs.org). The tests can be found in the repository under test directory.
 
 Before running the tests, you need to update the dependencies:
 
@@ -323,22 +297,21 @@ To run all the test cases:
 
     $ npm test
 
+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:
 
     $ npm run coverage
 
-<a name="Benchmarks"></a>
 ## Benchmarks
 
-Benchmark utilies are provided in the [`benchmarks`](benchmarks) directory.
-See the [`benchmarks/README.md`](benchmarks/README.md) for details.
-
+Benchmark utilities are provided in the repository under benchmarks directory. See the benchmarks/README.md for details.
 
 ## License
 
 The Aerospike Node.js Client is made available under the terms of the Apache
-License, Version 2, as stated in the file `LICENSE`.
+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. Please see individual files for
+compatible with Apache License, Version 2. Refer to individual files for
 details.

package/binding.gyp

@@ -71,7 +71,6 @@
         'src/main/query.cc',
         'src/main/scan.cc',
         'src/main/expressions.cc',
-        'src/main/predexp.cc',
         'src/main/async.cc',
         'src/main/command.cc',
         'src/main/commands/apply_async.cc',
@@ -79,6 +78,9 @@
         'src/main/commands/batch_get.cc',
         'src/main/commands/batch_select.cc',
         'src/main/commands/batch_read_async.cc',
+        'src/main/commands/batch_remove.cc',
+        'src/main/commands/batch_apply.cc',
+        'src/main/commands/batch_write_async.cc',
         'src/main/commands/exists_async.cc',
         'src/main/commands/get_async.cc',
         'src/main/commands/info_any.cc',
@@ -114,8 +116,10 @@
         'src/main/enums/ttl.cc',
         'src/main/enums/config_enum.cc',
         'src/main/enums/exp_enum.cc',
+        'src/main/enums/batch_type.cc',
         'src/main/stats.cc',
         'src/main/util/conversions.cc',
+        'src/main/util/conversions_batch.cc',
         'src/main/util/log.cc'
       ],
       'configurations': {

package/docker/Dockerfile.alpine

@@ -0,0 +1,47 @@
+# This Dockerfile demonstrates how to build the Aerospike Node.js client on
+# Alpine Linux. Since there is no pre-build package for the Aerospike C Client
+# SDK for Alpine Linux, this Dockerfile first builds the C Client SDK from source
+# (a submodule for the Node.js client), then builds the Node.js client using it.
+# Stage 2 install the Node.js client into the final Docker image, to keep the size of
+# that image minimal (i.e. no build dependencies).
+#
+# Note: The AS_NODEJS_VERSION must use version 4.0.3 and up since this is where the
+# C client submodule was introduced.
+
+# Stage 1: Build Aerospike C client and Node.js client
+FROM node:lts-alpine as as-node-builder
+WORKDIR /src
+
+ENV AS_NODEJS_VERSION v5.0.1
+
+RUN apk update
+RUN apk add --no-cache \
+    build-base \
+    linux-headers \
+    bash \
+    libuv-dev \
+    openssl-dev \
+    lua5.1-dev \
+    zlib-dev \
+    git \
+    python3
+
+RUN git clone --branch ${AS_NODEJS_VERSION} --recursive https://github.com/aerospike/aerospike-client-nodejs
+# TODO: build-command.sh might be broken for alpine in some versions, use latest version when it's in git
+COPY build-commands.sh /src/aerospike-client-nodejs/scripts/build-commands.sh
+
+RUN cd /src/aerospike-client-nodejs \
+    && /src/aerospike-client-nodejs/scripts/build-c-client.sh \
+    && npm install /src/aerospike-client-nodejs --unsafe-perm --build-from-source
+
+# Stage 2: Deploy Aerospike Node.js Runtime only
+FROM node:lts-alpine
+WORKDIR /src
+
+RUN apk add --no-cache \
+      zlib \
+      openssl
+
+COPY --from=as-node-builder /src/aerospike-client-nodejs/ aerospike-client-nodejs/
+
+RUN  npm install /src/aerospike-client-nodejs

package/docker/Dockerfile.bullseye-slim

@@ -0,0 +1,18 @@
+# This Dockerfile demonstrates how to use the Aerospike Node.js client on
+# bullseye-slim (Debian 11) using the pre-built package and minimal prerequirements.
+#
+# Note: The AS_NODEJS_VERSION must use version 4.0.3 and up since this is where
+# the C client submodule was introduced.
+
+# Stage 1: Install Node.js Client Dependencies
+FROM node:lts-bullseye-slim as installer
+WORKDIR /src
+
+ENV AS_NODEJS_VERSION v5.0.1
+
+RUN apt update -y
+RUN apt install -y \
+    openssl \
+    zlib1g
+
+RUN npm install aerospike@${AS_NODEJS_VERSION}

package/docker/Dockerfile.lambda

@@ -0,0 +1,44 @@
+# This Dockerfile demonstrates how to build the Aerospike Node.js client on
+# Amazon Linux 2 for AWS Lambda. Since there is no pre-built package for the
+# Aerospike C Client SDK for Amazon Linux 2, this Dockerfile uses a multi-stage
+# approach to building the client to minimize the final image size.
+#
+# Note: The AS_NODEJS_VERSION must use version 4.0.3 and up since this is where
+# the C client submodule was introduced.
+
+# Stage 1: Build Aerospike C Client & Node.js Client
+FROM public.ecr.aws/lambda/nodejs:16 as builder
+WORKDIR /src
+
+ENV AS_NODEJS_VERSION v5.0.1
+
+RUN yum update -y
+RUN yum install -y \
+    gcc-c++ \
+    linux-headers \
+    libuv-devel \
+    lua5.1-devel \
+    openssl11-devel \
+    zlib-devel \
+    python3 \
+    make \
+    wget \
+    tar \
+    git
+
+RUN git clone --branch ${AS_NODEJS_VERSION} --recursive https://github.com/aerospike/aerospike-client-nodejs aerospike
+RUN cd /src/aerospike \
+    && /src/aerospike/scripts/build-c-client.sh \
+    && npm install /src/aerospike --unsafe-perm --build-from-source
+
+# Stage 2: Install Node.js Client Dependencies
+FROM public.ecr.aws/lambda/nodejs:16 as installer
+WORKDIR /src
+
+COPY --from=builder /src/aerospike ./aerospike
+
+RUN yum update -y
+RUN yum install -y \
+    openssl11 \
+    zlib
+RUN npm install /src/aerospike

package/docker/Dockerfile.ubuntu22.04

@@ -0,0 +1,45 @@
+# This Dockerfile demonstrates how to build the Aerospike Node.js client on
+# Ubuntu 22.04. Since there is no pre-built package for the Aerospike C Client SDK 
+# for Ubuntu 22.04 yet, this Dockerfile uses a multi-stage approach to building the 
+# client to minimize the final image size.
+#
+# Note: The AS_NODEJS_VERSION must use version 4.0.3 and up since this is where
+# the C client submodule was introduced.
+
+# Stage 1: Build Aerospike C Client & Node.js Client
+FROM sitespeedio/node:ubuntu-22.04-nodejs-16.15.0 as builder
+WORKDIR /src
+
+ENV AS_NODEJS_VERSION v5.0.1
+
+RUN apt update -y
+RUN apt install -y \
+                libc6-dev \
+                libssl-dev \
+                autoconf \
+                automake \
+                libtool \
+                g++ \
+                zlib1g-dev \
+                liblua5.1-0-dev \
+                ncurses-dev \
+                python3 \
+                wget \
+                git \
+                make
+
+RUN git clone --branch ${AS_NODEJS_VERSION} --recursive https://github.com/aerospike/aerospike-client-nodejs aerospike
+RUN cd /src/aerospike \
+    && /src/aerospike/scripts/build-c-client.sh \
+    && npm install /src/aerospike --unsafe-perm --build-from-source
+
+# Stage 2: Install Node.js Client Dependencies
+FROM  sitespeedio/node:ubuntu-22.04-nodejs-16.15.0 as installer
+WORKDIR /src
+
+COPY --from=builder /src/aerospike ./aerospike
+
+RUN apt update -y
+RUN apt install -y \
+    zlib1g
+RUN npm install /src/aerospike

package/examples/batch.js

@@ -28,7 +28,7 @@ async function batchRead (client, argv) {
     if (argv.bins) {
       request.bins = argv.bins
     } else {
-      request.read_all_bins = true
+      request.readAllBins = true
     }
     return request
   })

package/examples/put.js

@@ -52,7 +52,7 @@ function buildPolicy (argv) {
 }
 
 exports.command = 'put <key> <bins...>'
-exports.describe = 'Write a record to the database.'
+exports.describe = 'Write a record to the database.\n bins format is a key value pair as "<bin_name>=<bin_value>"'
 exports.handler = shared.run(put)
 exports.builder = {
   'time-to-live': {

package/examples/shared/cli.js

@@ -23,7 +23,7 @@ function str2num (value) {
 // @param { String[] } binStrs - list of "<name>=<value>" pairs
 exports.parseBins = function (binStrs) {
   return binStrs.reduce((bins, current) => {
-    const [name, value] = current.split('=')
+    const [name, value] = current.toString().split('=')
     bins[name] = str2num(value)
     return bins
   }, {})