feat: use ZooKeeper C Client v3.8.2 (#330)

* wip: use zookeeper-c-client v3.8.2

* fix: eslint import order

* fix(ci): skip CMake on CI

* Add prebuild for Windows and C Client v3.8.2

* fix(windows): build with extra CMAKE flags

* fix(windows): apply patches is still needed

* remove unused client version env

* fix(patch): not needed

* feat(mac os x): add prebuild for node 18 and C Client v3.8.2

* docs(prebuildify): update node version

* feat(mac os x M1): add prebuild for node 18 and C Client v3.8.2

* bump version to 6.0.0

* docs: add changelog

.circleci/config.yml

@@ -41,7 +41,6 @@ jobs:
   run-on-windows:
     executor: win/default
     steps:
-      - run: choco install cmake -y --installargs 'ADD_CMAKE_TO_PATH=System'
       - checkout
       - nvminstall
       - deps

CHANGELOG.md

@@ -1,3 +1,10 @@
+#### v 6.0.0 (2023-08-07)
+* feat: use ZooKeeper C Client v3.8.2 and add prebuilds for Node.js v.18 (Mac OS X intel and M1, and Windows)
+
+  Drop support for Node.js 16 prebuilds.
+
+  Pull request [330](https://github.com/yfinkelstein/node-zookeeper/pull/330) by @davidvujic
+
 #### v 5.6.0 (2022-11-03)
 * feat: add prebuilds for Node.js v.18 (Mac OS X intel and M1, and Windows)
 

deps/README.md

@@ -1,10 +1,11 @@
 ### Developer: updating the ZooKeeper Client C source code
 
 This guide is extracted from the [official docs](https://github.com/apache/zookeeper/blob/master/zookeeper-client/zookeeper-client-c/README)
+and the as of today unresolved issue about outdated docs: https://issues.apache.org/jira/browse/ZOOKEEPER-4621
 
-1 Download the source code
-2 Navigate to the `zookeeper-jute` folder and run `mvn compile`
-3 Navigate to the zookeeper-client-c folder: run autoreconf -if
-4 compress the entire zookeeper-client-c folder and name it `zookeeper-client-c.tar.gz`
+1. Download the source code
+2. Navigate to the `zookeeper-jute` folder and run `mvn compile`
+3. Navigate to the zookeeper-client-c folder: run autoreconf -if
+4. compress the entire zookeeper-client-c folder and name it `zookeeper-client-c.tar.gz`
    * On Mac OS X: `COPYFILE_DISABLE=1 tar -czvf zookeeper-client-c.tar.gz zookeeper-client-c`
-5 replace the existing compressed file in the deps folder
+5. replace the existing compressed file in the deps folder

lib/zookeeper.js

@@ -1,9 +1,9 @@
 // needed to not break the interface
 /* eslint-disable camelcase */
-const { apply, waterfall } = require('async');
+const util = require('util');
 const { EventEmitter } = require('events');
 const { join, posix } = require('path');
-const util = require('util');
+const { apply, waterfall } = require('async');
 const NativeZk = require('node-gyp-build')(join(__dirname, '..')).ZooKeeper;
 const { isString, isFunction } = require('./helper');
 

package.json

@@ -1,7 +1,7 @@
 {
     "name": "zookeeper",
     "description": "apache zookeeper client (zookeeper async API v3.5.x - v3.8.x)",
-    "version": "5.6.0",
+    "version": "6.0.0",
     "author": "Yuri Finkelstein <[email protected]>",
     "license": "MIT",
     "contributors": [

prebuilds/README.md

@@ -8,16 +8,16 @@ Each platform has prebuilds for Node.js 12 and 14.
 Create prebuilds for Mac OS X:
 
 ```bash
-npx prebuildify --arch x64 --platform darwin --target 16.17.0
+npx prebuildify --arch x64 --platform darwin --target 18.17.0
 ```
 
 Prebuilds for Mac OS X with the M1 processor:
 ```bash
-npx prebuildify --arch arm64 --platform darwin --target 16.17.0
+npx prebuildify --arch arm64 --platform darwin --target 18.17.0
 ```
 
 Create prebuilds for Windows 10:
 
 ```bash
-npx prebuildify --arch x64 --platform win32 --target 16.17.0
+npx prebuildify --arch x64 --platform win32 --target 18.17.0
 ```

scripts/build.js

@@ -16,7 +16,7 @@ shell.cd(`${env.sourceFolder}`);
 
 if (env.isWindows) {
     const output = env.isVerbose ? '' : ' > NUL';
-    exec(`cmake -DWANT_SYNCAPI=OFF -DCMAKE_GENERATOR_PLATFORM=${process.arch} .${output}`);
+    exec(`cmake -DWANT_SYNCAPI=OFF -DCMAKE_GENERATOR_PLATFORM=${process.arch} .${output} -DWITH_OPENSSL=OFF -DWITH_CYRUS_SASL=OFF`);
     exec(`cmake --build .${output}`);
 } else {
     const flags = '-w';

scripts/env.js

@@ -21,15 +21,13 @@ function checkIfAlreadyBuilt(env) {
 const isWindows = process.platform.toLowerCase().includes('win32');
 const rootFolder = setRoot({ isWindows });
 
-const zookeeperVersion = '3.5.8';
 const downloadedFolderName = 'zookeeper-client-c';
 const downloadedFileName = 'zookeeper-client-c.tar.gz';
 
 const variables = {
     rootFolder,
     workFolder: `${rootFolder}/deps`,
     buildFolder: `${rootFolder}/build/zk`,
-    zookeeperVersion,
     downloadedFolderName,
     sourceFolder: `${rootFolder}/deps/zookeeper-client-c`,
     downloadedFileName,

scripts/prepublish.js

@@ -18,10 +18,6 @@ function applyPatches() {
         shell.sed('-i', '#include "zookeeper_log.h"', '#include "zookeeper_log.h"\n#include "winport.h"\n', `${destination}/zk_log.c`);
         shell.sed('-i', '#include "zookeeper.h"', '#include "winport.h"\n#include "zookeeper.h"\n', `${destination}/zk_adaptor.h`);
         shell.sed('-i', '#include "zk_adaptor.h"', '#include "zk_adaptor.h"\n#include "winport.h"\n', `${destination}/zookeeper.c`);
-        shell.sed('-i', /(FIPS_mode\(\) == 0)/, '0 == 0', `${destination}/zookeeper.c`);
-        shell.sed('-i', /(FIPS mode is OFF)/, 'Disabled the FIPS check', `${destination}/zookeeper.c`);
-    } else {
-        shell.exec(`patch -d ${env.rootFolder} -p0 --forward < ${env.workFolder}/no-fipsmode.patch`);
     }
 }
 

tests/unit/zookeeper/exportedconstantstest.js

@@ -1,5 +1,5 @@
-const test = require('ava');
 const { join } = require('path');
+const test = require('ava');
 const NativeZk = require('node-gyp-build')(join(__dirname, '../../../')).ZooKeeper;
 const constants = require('../../../lib/constants');
 const ZooKeeper = require('../../../lib/zookeeper');

tests/unit/zookeeper/nativeobjecttest.js

@@ -1,5 +1,5 @@
-const test = require('ava');
 const { join } = require('path');
+const test = require('ava');
 const NativeZk = require('node-gyp-build')(join(__dirname, '../../../')).ZooKeeper;
 const ZooKeeper = require('../../../lib/zookeeper');