-
-
Notifications
You must be signed in to change notification settings - Fork 91
feat(preferred): add kafkajs replacement #827
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mcollina
wants to merge
1
commit into
e18e:main
Choose a base branch
from
mcollina:feat/add-kafkajs-replacement
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| --- | ||
| description: Modern alternatives to the kafkajs package | ||
| --- | ||
|
|
||
| # Replacements for `kafkajs` | ||
|
|
||
| `kafkajs` is [no longer maintained](https://github.com/tulios/kafkajs/issues/1603). Both replacements below are actively maintained [Kafka](https://kafka.apache.org/) clients; choose based on your runtime and migration requirements. | ||
|
|
||
| ## `@platformatic/kafka` | ||
|
|
||
| [`@platformatic/kafka`](https://github.com/platformatic/kafka) is a modern, pure TypeScript/JavaScript Kafka client with no native addon. It uses separate producer, consumer, and admin clients, and provides type-safe APIs, serializers, and stream-based consumers. | ||
|
|
||
| Example: | ||
|
|
||
| <!-- prettier-ignore --> | ||
| ```js | ||
| const { Kafka } = require('kafkajs') // [!code --] | ||
| const { Producer, stringSerializers } = require('@platformatic/kafka') // [!code ++] | ||
|
|
||
| const kafka = new Kafka({ // [!code --] | ||
| clientId: 'my-app', // [!code --] | ||
| brokers: ['localhost:9092'] // [!code --] | ||
| }) // [!code --] | ||
| const producer = kafka.producer() // [!code --] | ||
| const producer = new Producer({ // [!code ++] | ||
| clientId: 'my-app', // [!code ++] | ||
| bootstrapBrokers: ['localhost:9092'], // [!code ++] | ||
| serializers: stringSerializers // [!code ++] | ||
| }) // [!code ++] | ||
|
|
||
| await producer.connect() // [!code --] | ||
| await producer.send({ | ||
| topic: 'events', // [!code --] | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this is removed in migration but doesn't seem to be introduced anywhere else. whats the equivalent of this in the replacement libraries? |
||
| messages: [{ key: 'event-1', value: 'created' }] | ||
| }) | ||
|
|
||
| await producer.disconnect() // [!code --] | ||
| await producer.close() // [!code ++] | ||
| ``` | ||
|
|
||
| ## `@confluentinc/kafka-javascript` | ||
|
|
||
| [`@confluentinc/kafka-javascript`](https://github.com/confluentinc/confluent-kafka-javascript) is Confluent's client, backed by the native `librdkafka` library. Confluent was founded by [Kafka's](https://kafka.apache.org/) creators and is a major contributor to the Kafka project. Its KafkaJS-compatible API can make it a good choice for incremental migrations, but it has native binaries. | ||
|
|
||
| Example: | ||
|
|
||
| <!-- prettier-ignore --> | ||
| ```js | ||
| const { Kafka } = require('kafkajs') // [!code --] | ||
| const { Kafka } = require('@confluentinc/kafka-javascript').KafkaJS // [!code ++] | ||
|
|
||
| const kafka = new Kafka({ | ||
| clientId: 'my-app', // [!code --] | ||
| brokers: ['localhost:9092'] // [!code --] | ||
| kafkaJS: { // [!code ++] | ||
| clientId: 'my-app', // [!code ++] | ||
| brokers: ['localhost:9092'] // [!code ++] | ||
| } // [!code ++] | ||
| }) | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we really should be using ESM in the examples i think