Upgrade guide | Laravel Kafka [ Laravel Kafka ](/) Search ⌘K [ Login with GitHub ](https://laravelkafka.com/oauth/github/redirect) Docs for version selected v2.11 v2.10 v2.9 v2.8 v1.13 - - [ Introduction ](/docs/v2.9/introduction) - [ Requirements ](/docs/v2.9/requirements) - [ Installation and Setup ](/docs/v2.9/installation-and-setup) - [ Questions and issues ](/docs/v2.9/questions-and-issues) - [ Changelog ](/docs/v2.9/changelog) - [ Upgrade guide ](/docs/v2.9/upgrade-guide) - [ Example docker-compose file ](/docs/v2.9/example-docker-compose) - Producing messages ------------------ - [ Producing messages ](/docs/v2.9/producing-messages/producing-messages) - [ Configuring your kafka producer ](/docs/v2.9/producing-messages/configuring-producers) - [ Configuring message payload ](/docs/v2.9/producing-messages/configuring-message-payload) - [ Custom serializers ](/docs/v2.9/producing-messages/custom-serializers) - [ Publishing to kafka ](/docs/v2.9/producing-messages/publishing-to-kafka) - Consuming messages ------------------ - [ Creating a kafka consumer ](/docs/v2.9/consuming-messages/creating-consumer) - [ Subscribing to kafka topics ](/docs/v2.9/consuming-messages/subscribing-to-kafka-topics) - [ Using regex to subscribe to kafka topics ](/docs/v2.9/consuming-messages/using-regex-to-subscribe-to-kafka-topics) - [ Assigning consumers to a topic partition ](/docs/v2.9/consuming-messages/assigning-partitions) - [ Consuming messages from specific offsets ](/docs/v2.9/consuming-messages/consuming-from-specific-offsets) - [ Consumer groups ](/docs/v2.9/consuming-messages/consumer-groups) - [ Partition Discovery and Dynamic Assignment ](/docs/v2.9/consuming-messages/partition-discovery) - [ Message handlers ](/docs/v2.9/consuming-messages/message-handlers) - [ Configuring consumer options ](/docs/v2.9/consuming-messages/configuring-consumer-options) - [ Custom deserializers ](/docs/v2.9/consuming-messages/custom-deserializers) - [ Consuming messages ](/docs/v2.9/consuming-messages/consuming-messages) - [ Class structure ](/docs/v2.9/consuming-messages/class-structure) - [ Queueable handlers ](/docs/v2.9/consuming-messages/queueable-handlers) - Advanced usage -------------- - [ Replacing the default serializer/deserializer ](/docs/v2.9/advanced-usage/replacing-default-serializer) - [ Graceful shutdown ](/docs/v2.9/advanced-usage/graceful-shutdown) - [ SASL Authentication ](/docs/v2.9/advanced-usage/sasl-authentication) - [ Custom Committers ](/docs/v2.9/advanced-usage/custom-committers) - [ Manual Commit ](/docs/v2.9/advanced-usage/manual-commit) - [ Middlewares ](/docs/v2.9/advanced-usage/middlewares) - [ Stop consumer after last messages ](/docs/v2.9/advanced-usage/stop-consumer-after-last-message) - [ Stop consumer on demand ](/docs/v2.9/advanced-usage/stopping-a-consumer) - [ Writing custom loggers ](/docs/v2.9/advanced-usage/custom-loggers) - [ Before and after callbacks ](/docs/v2.9/advanced-usage/before-callbacks) - [ Setting global configurations ](/docs/v2.9/advanced-usage/setting-global-configuration) - [ Sending multiple messages with the same producer ](/docs/v2.9/advanced-usage/sending-multiple-messages-with-the-same-producer) - Testing ------- - [ Kafka fake ](/docs/v2.9/testing/fake) - [ Assert Published ](/docs/v2.9/testing/assert-published) - [ Assert published On ](/docs/v2.9/testing/assert-published-on) - [ Assert nothing published ](/docs/v2.9/testing/assert-nothing-published) - [ Assert published times ](/docs/v2.9/testing/assert-published-times) - [ Assert published on times ](/docs/v2.9/testing/assert-published-on-times) - [ Mocking your kafka consumer ](/docs/v2.9/testing/mocking-your-kafka-consumer) Upgrade guide =============== [](#content-upgrade-to-v29-from-v28 "Permalink")Upgrade to v2.9 from v2.8 ------------------------------------------------------------------------- - **BREAKING CHANGE**: Deprecated producer batch messages feature has been removed (`MessageBatch`, `sendBatch`, `produceBatch`). Use `Kafka::asyncPublish()` instead for better performance - **BREAKING CHANGE**: Deprecated consumer batch messages feature has been removed (`enableBatching()`, `withBatchSizeLimit()`, `withBatchReleaseInterval()`). Process messages individually in your consumer handler - Removed classes: `BatchMessageConsumer`, `HandlesBatchConfiguration`, `BatchConfig`, `NullBatchConfig`, `CallableBatchConsumer`, etc. - Removed events: `BatchMessagePublished`, `MessageBatchPublished`, `PublishingMessageBatch` [](#content-upgrade-to-v28-from-v2x "Permalink")Upgrade to v2.8 from v2.x ------------------------------------------------------------------------- The only breaking change in this version was the change in the `Junges\Kafka\Contracts\Handler` contract signature. The `handle` method now requires a second parameter of type `Junges\Kafka\Contracts\MessageConsumer`. Here's the updated signature: ``` class MyHandler implements Handler { - public function __invoke(ConsumerMessage $message): void { + public function __invoke(ConsumerMessage $message, MessageConsumer $consumer): void { // Process message here... } } ``` If you are handling your messages using a closure, no changes are needed as the closure signature already supports the second parameter. [](#content-upgrade-to-v2x-from-v113x "Permalink")Upgrade to v2.x from v1.13.x ------------------------------------------------------------------------------ [](#content-high-impact-changes "Permalink")High impact changes --------------------------------------------------------------- - The `\Junges\Kafka\Contracts\CanProduceMessages` contract was renamed to `\Junges\Kafka\Contracts\MessageProducer` - The `\Junges\Kafka\Contracts\KafkaProducerMessage` contract was renamed to `\Junges\Kafka\Contracts\ProducerMessage` - The `\Junges\Kafka\Contracts\CanConsumeMessages` was renamed to `\Junges\Kafka\Contracts\MessageConsumer` - The `\Junges\Kafka\Contracts\KafkaConsumerMessage` was renamed to `\Junges\Kafka\Contracts\ConsumerMessage` - The `\Junges\Kafka\Contracts\CanPublishMessagesToKafka` contract was removed. - The `\Junges\Kafka\Contracts\CanConsumeMessagesFromKafka` was removed. - The `\Junges\Kafka\Contracts\CanConsumeBatchMessages` contract was renamed to `\Junges\Kafka\Contracts\BatchMessageConsumer` - The `\Junges\Kafka\Contracts\CanConsumeMessages` contract was renamed to `\Junges\Kafka\Contracts\MessageConsumer` - Introduced a new `\Junges\Kafka\Contracts\Manager` used by `\Junges\Kafka\Factory` class ### [](#content-the-withsasl-method-signature-was-changed "Permalink")The `withSasl` method signature was changed. The `withSasl` method now accepts all `SASL` parameters instead of a `Sasl` object. ``` public function withSasl(string $username, string $password, string $mechanisms, string $securityProtocol = 'SASL_PLAINTEXT'); ``` ### [](#content-handler-functions-require-a-second-parameter "Permalink")Handler functions require a second parameter In v2 handler functions and handler classes require a `\Junges\Kafka\Contracts\MessageConsumer` as a second argument. ``` $consumer = Kafka::consumer(['topic']) ->withConsumerGroupId('group') - ->withHandler(function(ConsumerMessage $message) { + ->withHandler(function(ConsumerMessage $message, MessageConsumer $consumer) { // }) ``` ### [](#content-renamed-createconsumer-method "Permalink")Renamed `createConsumer` method The `Kafka::createConsumer` method has been renamed to just `consumer` ### [](#content-renamed-publishon-method "Permalink")Renamed `publishOn` method The `Kafka::publishOn` method has been renamed to `publish`, and it does not accept the `$topics` parameter anymore. Please chain a call to `onTopic` to specify in which topic the message should be published. ``` \Junges\Kafka\Facades\Kafka::publish('broker')->onTopic('topic-name'); ``` ### [](#content-setting-onstopconsuming-callbacks "Permalink")Setting `onStopConsuming` callbacks To set `onStopConsuming` callbacks you need to define them while building the consumer, instead of after calling the `build` method as in `v1.13.x`: ``` $consumer = Kafka::consumer(['topic']) ->withConsumerGroupId('group') ->withHandler(new Handler) + ->onStopConsuming(static function () { + // Do something when the consumer stop consuming messages + }) ->build() - ->onStopConsuming(static function () { - // Do something when the consumer stop consuming messages - }) ``` ### [](#content-updating-dependencies "Permalink")Updating dependencies **PHP 8.2 Required** This package now requires PHP 8.2 or higher. You can use tools such as [ rector ](https://github.com/rectorphp/rector) to upgrade your app to PHP 8.2. Previous [ Changelog ](https://laravelkafka.com/docs/v2.9/changelog) Next [ Example docker-compose file ](https://laravelkafka.com/docs/v2.9/example-docker-compose) Sponsors [ version="1.0" encoding="UTF-8"? EasyCal ](https://easycal.app/) [ Search ⌘ K ](https://typesense.org/)