Skip to content

Commit 7f2718a

Browse files
committed
Merge from Blizzard/node-rdkafka master
1 parent f69c81b commit 7f2718a

File tree

9 files changed

+133
-98
lines changed

9 files changed

+133
-98
lines changed

.github/workflows/test.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ jobs:
1010
build:
1111
strategy:
1212
matrix:
13-
node: [10, 12, 14, 16, 18, 19]
13+
node: [10, 12, 14, 16, 18, 20]
1414
os: [ubuntu-22.04]
1515
include:
1616
# single mac test due to minute multipliers
1717
# https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions
18-
- node: 18
18+
- node: 20
1919
os: macos-12
2020
# single windows test due to node.js 14 node-gyp / vs 2022 issues
21-
- node: 18
21+
- node: 20
2222
os: windows-2022
2323
runs-on: ${{ matrix.os }}
2424
steps:

CONTRIBUTING.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -215,12 +215,10 @@ Steps to update:
215215
```
216216
Note: This is ran automatically during CI flows but it's good to run it during the version upgrade pull request.
217217
218-
1. Run `npm install` to build with the new version and fix any build errors that occur.
218+
1. Run `npm install --lockfile-version 2` to build with the new version and fix any build errors that occur.
219219
220220
1. Run unit tests: `npm run test`
221221
222-
1. Run end to end tests: `npm run test:e2e`. This requires running kafka & zookeeper locally.
223-
224222
1. Update the version numbers referenced in the [`README.md`](https://github.com/Blizzard/node-rdkafka/blob/master/README.md) file to the new version.
225223
226224
## Publishing new npm version

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ I am looking for *your* help to make this project even better! If you're interes
1717

1818
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.
1919

20-
__This library currently uses `librdkafka` version `2.2.0`.__
20+
__This library currently uses `librdkafka` version `2.3.0`.__
2121

2222
## Reference Docs
2323

@@ -60,7 +60,7 @@ Using Alpine Linux? Check out the [docs](https://github.com/Blizzard/node-rdkafk
6060

6161
### Windows
6262

63-
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.2.0.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.
63+
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.3.0.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.
6464

6565
Requirements:
6666
* [node-gyp for Windows](https://github.com/nodejs/node-gyp#on-windows)
@@ -97,7 +97,7 @@ const Kafka = require('node-rdkafka');
9797

9898
## Configuration
9999

100-
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.2.0/CONFIGURATION.md)
100+
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.3.0/CONFIGURATION.md)
101101

102102
Configuration keys that have the suffix `_cb` are designated as callbacks. Some
103103
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`
132132
const Kafka = require('node-rdkafka');
133133
console.log(Kafka.librdkafkaVersion);
134134

135-
// #=> 2.2.0
135+
// #=> 2.3.0
136136
```
137137

138138
## Sending Messages
@@ -145,7 +145,7 @@ const producer = new Kafka.Producer({
145145
});
146146
```
147147

148-
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.2.0/CONFIGURATION.md) file described previously.
148+
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.3.0/CONFIGURATION.md) file described previously.
149149

150150
The following example illustrates a list with several `librdkafka` options set.
151151

deps/librdkafka

lib/error.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ LibrdKafkaError.wrap = errorWrap;
2727
* @enum {number}
2828
* @constant
2929
*/
30-
// ====== Generated from librdkafka 2.2.0 file src-cpp/rdkafkacpp.h ======
30+
// ====== Generated from librdkafka 2.3.0 file src-cpp/rdkafkacpp.h ======
3131
LibrdKafkaError.codes = {
3232

3333
/* Internal errors to rdkafka: */
@@ -158,10 +158,8 @@ LibrdKafkaError.codes = {
158158
ERR__AUTO_OFFSET_RESET: -140,
159159
/** Partition log truncation detected */
160160
ERR__LOG_TRUNCATION: -139,
161-
162161
/** End internal error codes */
163162
ERR__END: -100,
164-
165163
/* Kafka broker errors: */
166164
/** Unknown broker error */
167165
ERR_UNKNOWN: -1,

0 commit comments

Comments
 (0)