confluentinc · milindl · Sep 25, 2024 · Sep 24, 2024
@@ -28,7 +28,7 @@ global_job_config:
       - git submodule update --init --recursive
       - cd deps/librdkafka
       - git fetch origin
-      - git pull origin master
+      - git checkout v2.5.3
       - cd ../../
       - cache clear
 

@@ -1,3 +1,11 @@
+# confluent-kafka-javascript v0.2.0
+
+v0.2.0 is a limited availability release. It is supported for all usage.
+
+## Features
+1. Switch to using `librdkafka` on the latest released tag `v2.5.3` instead of `master`.
+
+
 # confluent-kafka-javascript v0.1.17-devel
 
 v0.1.17-devel is a pre-production, early-access release.

@@ -41,12 +41,9 @@ library's core.
 
 ### Pull Requests
 
-NOTE: Pull requests while the library in EA are discouraged, as we are still
-working on the API and may make breaking changes.
-
 * Include new test cases (either end-to-end or unit tests) with your change.
 * Follow our style guides.
-* Make sure all tests are still passing and the `linter` does not report any issues.
+* Make sure all tests are still passing and the linter does not report any issues.
 * End files with a new line.
 * Document the new code in the comments (if it is JavaScript) so the
   documentation generator can update the reference documentation.
@@ -231,7 +228,7 @@ Steps to update:
 
 ## Releasing
 
-1. Increment the `version` in `package.json`. Change the version in `client.js` and `README.md`.
+1. Increment the `version` in `package.json`. Change the version in `client.js` and `README.md`. Change the librdkafka version in `semaphore.yml` and in `package.json`.
 
 1. Run `npm install` to update the `package-lock.json` file.
 

@@ -2,42 +2,49 @@ Confluent's Javascript Client for Apache Kafka<sup>TM</sup>
 =====================================================
 
 **confluent-kafka-javascript** is Confluent's JavaScript client for [Apache Kafka](http://kafka.apache.org/) and the
-[Confluent Platform](https://www.confluent.io/product/compare/). This is an **early access** library. The goal is to provide an highly performant, reliable and easy to use JavaScript client that is based on [node-rdkafka](https://github.com/Blizzard/node-rdkafka) yet also API compatible with [KafkaJS](https://github.com/tulios/kafkajs) to provide flexibility to users and streamline migrations from other clients.
+[Confluent Platform](https://www.confluent.io/product/compare/). This is an **limited availability** library. The goal is to provide an highly performant, reliable and easy to use JavaScript client that is based on [node-rdkafka](https://github.com/Blizzard/node-rdkafka) yet also API compatible with [KafkaJS](https://github.com/tulios/kafkajs) to provide flexibility to users and streamline migrations from other clients.
 
-This library leverages the work and concepts from two popular Apache Kafka JavaScript clients: [node-rdkafka](https://github.com/Blizzard/node-rdkafka) and [KafkaJS](https://github.com/tulios/kafkajs). The core is heavily based on the node-rdkafka library, which uses our own [librdkafka](https://github.com/confluentinc/librdkafka/tree/v2.3.0) library for core client functionality. However, we leverage a promisified API and a more idiomatic interface, similar to the one in KafkaJS, making it easy for developers to migrate and adopt this client depending on the patterns and interface they prefer.
-__This library currently uses `librdkafka` based off of the master branch.__
+Features:
 
-## This library is currently in early access and not meant for production use
+- **High performance** - confluent-kafka-javascript is a lightweight wrapper around
+[librdkafka](https://github.com/confluentinc/librdkafka), a finely tuned C
+client.
 
-**This library is in active development, pre-1.0.0, and it is likely to have many breaking changes.**
+- **Reliability** - There are a lot of details to get right when writing an Apache Kafka
+client. We get them right in one place (librdkafka) and leverage this work
+across all of our clients.
 
-For this early-access release, we aim to get feedback from JavaScript developers within the Apache Kafka community to help meet your needs. Some areas of feedback we are looking for include:
-- Usability of the API compared to other clients
-- Migration experience from the node-rdkafka and KafkaJs
-- Overall quality and reliability
+- **Supported** - Commercial support is offered by [Confluent](https://confluent.io/).
 
-We invite you to raise issues to highlight any feedback you may have.
+- **Future proof** - Confluent, founded by the
+creators of Kafka, is building a [streaming platform](https://www.confluent.io/product/)
+with Apache Kafka at its core. It's high priority for us that client features keep
+pace with core Apache Kafka and components of the [Confluent Platform](https://www.confluent.io/product/).
 
-Within the early-access, only **basic produce and consume functionality** as well as the ability to **create and delete topics** are supported. All other admin client functionality is coming in future releases. See [INTRODUCTION.md](INTRODUCTION.md) for more details on what is supported.
+This library leverages the work and concepts from two popular Apache Kafka JavaScript clients: [node-rdkafka](https://github.com/Blizzard/node-rdkafka) and [KafkaJS](https://github.com/tulios/kafkajs). The core is heavily based on the node-rdkafka library, which uses our own [librdkafka](https://github.com/confluentinc/librdkafka) library for core client functionality. However, we leverage a promisified API and a more idiomatic interface, similar to the one in KafkaJS, making it easy for developers to migrate and adopt this client depending on the patterns and interface they prefer. We're very happy to have been able to leverage the excellent work of the many authors of these libraries!
 
-To use **Schema Registry**, use the existing [kafkajs/confluent-schema-registry](https://github.com/kafkajs/confluent-schema-registry) library that is compatible with this library. For a simple schema registry example, see [sr.js](https://github.com/confluentinc/confluent-kafka-javascript/blob/dev_early_access_development_branch/examples/kafkajs/sr.js). **DISCLAIMER:** Although it is compatible with **confluent-kafka-javascript**, Confluent does not own or maintain kafkajs/confluent-schema-registry, and the use and functionality of the library should be considered "as is".
+### This library is currently in limited-availability - it is supported for all usage but for the schema-registry client.
+
+To use **Schema Registry**, use the existing [kafkajs/confluent-schema-registry](https://github.com/kafkajs/confluent-schema-registry) library that is compatible with this library. For a simple schema registry example, see [sr.js](https://github.com/confluentinc/confluent-kafka-javascript/blob/dev_early_access_development_branch/examples/kafkajs/sr.js).
+
+**DISCLAIMER:** Although it is compatible with **confluent-kafka-javascript**, Confluent does not own or maintain kafkajs/confluent-schema-registry, and the use and functionality of the library should be considered "as is".
 
 
 ## Requirements
 
-The following configurations are supported for this early access preview:
+The following configurations are supported:
 
 * Any supported version of Node.js (The two LTS versions, 18 and 20, and the latest versions, 21 and 22).
 * Linux (x64 and arm64) - both glibc and musl/alpine.
 * macOS - arm64/m1.
-* Windows - x64 (experimentally available in EA).
+* Windows - x64.
 
 Installation on any of these platforms is meant to be seamless, without any C/C++ compilation required.
 
 In case your system configuration is not within the supported ones, [a supported version of Python](https://devguide.python.org/versions/) must be available on the system for the installation process. [This is required for the `node-gyp` build tool.](https://github.com/nodejs/node-gyp?tab=readme-ov-file#configuring-python-dependency).
 
 ```bash
-$ npm install @confluentinc/kafka-javascript
+npm install @confluentinc/kafka-javascript
 ```
 
 Yarn and pnpm support is experimental.
@@ -97,5 +104,5 @@ An in-depth reference may be found at [INTRODUCTION.md](INTRODUCTION.md).
 
 ## Contributing
 
-Bug reports and early-access feedback is appreciated in the form of Github Issues.
+Bug reports and feedback is appreciated in the form of Github Issues.
 For guidelines on contributing please see [CONTRIBUTING.md](CONTRIBUTING.md)
@@ -52,4 +52,4 @@ util.dictToStringList = function (mapOrObject) {
   return list;
 };
 
-util.bindingVersion = 'v0.1.17-devel';
+util.bindingVersion = 'v0.2.0';
@@ -1,8 +1,8 @@
 {
   "name": "@confluentinc/kafka-javascript",
-  "version": "v0.1.17-devel",
+  "version": "v0.2.0",
   "description": "Node.js bindings for librdkafka",
-  "librdkafka": "master",
+  "librdkafka": "2.5.3",
   "librdkafka_win": "2.5.3",
   "main": "lib/index.js",
   "types": "types/index.d.ts",
+6 −0		.semaphore/semaphore.yml
+29 −0		CHANGELOG.md
+10 −0		packaging/tools/build-configurations-checks.sh
+1 −1		src-cpp/rdkafkacpp.h
+1 −1		src/rdkafka.h
+1 −0		src/rdkafka_op.h
+21 −15		src/rdkafka_telemetry.c
+4 −0		src/rdkafka_telemetry_encode.c
+15 −0		tests/0133-ssl_keys.c
+8 −4		tests/0150-telemetry_mock.c
+1 −1		vcpkg.json