Update to librdkafka 2.0.2 (#996)

Author: GaryWilber

CONTRIBUTING.md

@@ -207,6 +207,8 @@ Steps to update:
     git checkout 063a9ae7a65cebdf1cc128da9815c05f91a2a996 # for version 1.8.2
     ```
 
+    If you get an error during that checkout command, double check that the submodule was initialized / cloned! You may need to run `git submodule update --init --recursive`
+
 1. Update [`config.d.ts`](https://github.com/Blizzard/node-rdkafka/blob/master/config.d.ts) and [`errors.d.ts`](https://github.com/Blizzard/node-rdkafka/blob/master/errors.d.ts) TypeScript definitions by running:
     ```bash
     node ci/librdkafka-defs-generator.js

README.md

@@ -17,7 +17,7 @@ I am looking for *your* help to make this project even better! If you're interes
 
 The `node-rdkafka` library is a high-performance NodeJS client for [Apache Kafka](http://kafka.apache.org/) that wraps the native  [librdkafka](https://github.com/edenhill/librdkafka) library.  All the complexity of balancing writes across partitions and managing (possibly ever-changing) brokers should be encapsulated in the library.
 
-__This library currently uses `librdkafka` version `1.9.2`.__
+__This library currently uses `librdkafka` version `2.0.2`.__
 
 ## Reference Docs
 
@@ -60,7 +60,7 @@ Using Alpine Linux? Check out the [docs](https://github.com/Blizzard/node-rdkafk
 
 ### Windows
 
-Windows build **is not** compiled from `librdkafka` source but it is rather linked against the appropriate version of [NuGet librdkafka.redist](https://www.nuget.org/packages/librdkafka.redist/) static binary that gets downloaded from `https://globalcdn.nuget.org/packages/librdkafka.redist.1.9.2.nupkg` during installation. This download link can be changed using the environment variable `NODE_RDKAFKA_NUGET_BASE_URL` that defaults to `https://globalcdn.nuget.org/packages/` when it's no set.
+Windows build **is not** compiled from `librdkafka` source but it is rather linked against the appropriate version of [NuGet librdkafka.redist](https://www.nuget.org/packages/librdkafka.redist/) static binary that gets downloaded from `https://globalcdn.nuget.org/packages/librdkafka.redist.2.0.2.nupkg` during installation. This download link can be changed using the environment variable `NODE_RDKAFKA_NUGET_BASE_URL` that defaults to `https://globalcdn.nuget.org/packages/` when it's no set.
 
 Requirements:
  * [node-gyp for Windows](https://github.com/nodejs/node-gyp#on-windows)
@@ -97,7 +97,7 @@ var Kafka = require('node-rdkafka');
 
 ## Configuration
 
-You can pass many configuration options to `librdkafka`.  A full list can be found in `librdkafka`'s [Configuration.md](https://github.com/edenhill/librdkafka/blob/v1.9.2/CONFIGURATION.md)
+You can pass many configuration options to `librdkafka`.  A full list can be found in `librdkafka`'s [Configuration.md](https://github.com/edenhill/librdkafka/blob/v2.0.2/CONFIGURATION.md)
 
 Configuration keys that have the suffix `_cb` are designated as callbacks. Some
 of these keys are informational and you can choose to opt-in (for example, `dr_cb`). Others are callbacks designed to
@@ -132,7 +132,7 @@ You can also get the version of `librdkafka`
 const Kafka = require('node-rdkafka');
 console.log(Kafka.librdkafkaVersion);
 
-// #=> 1.9.2
+// #=> 2.0.2
 ```
 
 ## Sending Messages
@@ -145,7 +145,7 @@ var producer = new Kafka.Producer({
 });
 ```
 
-A `Producer` requires only `metadata.broker.list` (the Kafka brokers) to be created.  The values in this list are separated by commas.  For other configuration options, see the [Configuration.md](https://github.com/edenhill/librdkafka/blob/v1.9.2/CONFIGURATION.md) file described previously.
+A `Producer` requires only `metadata.broker.list` (the Kafka brokers) to be created.  The values in this list are separated by commas.  For other configuration options, see the [Configuration.md](https://github.com/edenhill/librdkafka/blob/v2.0.2/CONFIGURATION.md) file described previously.
 
 The following example illustrates a list with several `librdkafka` options set.
 

config.d.ts

@@ -1,4 +1,4 @@
-// ====== Generated from librdkafka 1.9.2 file CONFIGURATION.md ======
+// ====== Generated from librdkafka 2.0.2 file CONFIGURATION.md ======
 // Code that generated this is a derivative work of the code from Nam Nguyen
 // https://gist.github.com/ntgn81/066c2c8ec5b4238f85d1e9168a04e3fb
 
@@ -306,6 +306,11 @@ export interface GlobalConfig {
      */
     "open_cb"?: any;
 
+    /**
+     * Address resolution callback (set with rd_kafka_conf_set_resolve_cb()).
+     */
+    "resolve_cb"?: any;
+
     /**
      * Application opaque (set with rd_kafka_conf_set_opaque())
      */
@@ -351,6 +356,13 @@ export interface GlobalConfig {
      */
     "broker.version.fallback"?: string;
 
+    /**
+     * Allow automatic topic creation on the broker when subscribing to or assigning non-existent topics. The broker must also be configured with `auto.create.topics.enable=true` for this configuration to take effect. Note: the default value (true) for the producer is different from the default value (false) for the consumer. Further, the consumer default value is different from the Java consumer (true), and this property is not supported by the Java producer. Requires broker version >= 0.11.0.0, for older broker versions only the broker configuration applies.
+     *
+     * @default false
+     */
+    "allow.auto.create.topics"?: boolean;
+
     /**
      * Protocol used to communicate with brokers.
      *
@@ -446,7 +458,12 @@ export interface GlobalConfig {
     "ssl.keystore.password"?: string;
 
     /**
-     * Path to OpenSSL engine library. OpenSSL >= 1.1.0 required.
+     * Comma-separated list of OpenSSL 3.0.x implementation providers. E.g., "default,legacy".
+     */
+    "ssl.providers"?: string;
+
+    /**
+     * **DEPRECATED** Path to OpenSSL engine library. OpenSSL >= 1.1.x required. DEPRECATED: OpenSSL engine support is deprecated and should be replaced by OpenSSL 3 providers.
      */
     "ssl.engine.location"?: string;
 
@@ -472,7 +489,7 @@ export interface GlobalConfig {
     /**
      * Endpoint identification algorithm to validate broker hostname using broker certificate. https - Server (broker) hostname verification as specified in RFC2818. none - No endpoint verification. OpenSSL >= 1.0.2 required.
      *
-     * @default none
+     * @default https
      */
     "ssl.endpoint.identification.algorithm"?: 'none' | 'https';
 
@@ -638,7 +655,7 @@ export interface ProducerGlobalConfig extends GlobalConfig {
     "enable.gapless.guarantee"?: boolean;
 
     /**
-     * Maximum number of messages allowed on the producer queue. This queue is shared by all topics and partitions.
+     * Maximum number of messages allowed on the producer queue. This queue is shared by all topics and partitions. A value of 0 disables this limit.
      *
      * @default 100000
      */
@@ -918,13 +935,6 @@ export interface ConsumerGlobalConfig extends GlobalConfig {
      * @default false
      */
     "check.crcs"?: boolean;
-
-    /**
-     * Allow automatic topic creation on the broker when subscribing to or assigning non-existent topics. The broker must also be configured with `auto.create.topics.enable=true` for this configuraiton to take effect. Note: The default value (false) is different from the Java consumer (true). Requires broker version >= 0.11.0.0, for older broker versions only the broker configuration applies.
-     *
-     * @default false
-     */
-    "allow.auto.create.topics"?: boolean;
 }
 
 export interface TopicConfig {

deps/librdkafka

@@ -2,6 +2,8 @@
 # read librdkafka version from package.json
 import json
 import os
+import glob
+
 with open('../package.json') as f:
     librdkafkaVersion = json.load(f)['librdkafka']
 librdkafkaWinSufix = '7' if librdkafkaVersion == '0.11.5' else '';
@@ -62,15 +64,9 @@ def createdir(dir):
 shutil.copy2(includePath + '/rdkafka.h', depsIncludeDir)
 shutil.copy2(includePath + '/rdkafkacpp.h', depsIncludeDir)
 
-shutil.copy2(dllPath + '/libcrypto-1_1-x64.dll', buildReleaseDir)
-shutil.copy2(dllPath + '/libcurl.dll', buildReleaseDir)
-shutil.copy2(dllPath + '/librdkafka.dll', buildReleaseDir)
-shutil.copy2(dllPath + '/librdkafkacpp.dll', buildReleaseDir)
-shutil.copy2(dllPath + '/libssl-1_1-x64.dll', buildReleaseDir)
-shutil.copy2(dllPath + '/msvcp140.dll', buildReleaseDir)
-shutil.copy2(dllPath + '/vcruntime140.dll', buildReleaseDir)
-shutil.copy2(dllPath + '/zlib1.dll', buildReleaseDir)
-shutil.copy2(dllPath + '/zstd.dll', buildReleaseDir)
+# copy all the required dlls
+for filename in glob.glob(os.path.join(dllPath, '*.dll')):
+  shutil.copy2(filename, buildReleaseDir)
 
 # clean up
 os.remove(outputFile)

deps/windows-install.py

@@ -1,4 +1,4 @@
-// ====== Generated from librdkafka 1.9.2 file src-cpp/rdkafkacpp.h ======
+// ====== Generated from librdkafka 2.0.2 file src-cpp/rdkafkacpp.h ======
 export const CODES: { ERRORS: {
   /* Internal errors to rdkafka: */
   /** Begin internal error codes (**-200**) */

errors.d.ts

@@ -27,7 +27,7 @@ LibrdKafkaError.wrap = errorWrap;
  * @enum {number}
  * @constant
  */
-// ====== Generated from librdkafka 1.9.2 file src-cpp/rdkafkacpp.h ======
+// ====== Generated from librdkafka 2.0.2 file src-cpp/rdkafkacpp.h ======
 LibrdKafkaError.codes = {
 
   /* Internal errors to rdkafka: */

lib/error.js

@@ -1,8 +1,8 @@
 {
   "name": "node-rdkafka",
-  "version": "v2.14.6",
+  "version": "v2.15.0",
   "description": "Node.js bindings for librdkafka",
-  "librdkafka": "1.9.2",
+  "librdkafka": "2.0.2",
   "main": "lib/index.js",
   "scripts": {
     "configure": "node-gyp configure",