feat: introduce KafkaProducerWrapper #228

simPod · 2025-07-22T06:43:23Z

Prefer composition over inheritance. Do not extend RdKafka producer.

Summary by CodeRabbit

New Features
- Introduced a new Kafka producer wrapper class, offering enhanced message production and flushing capabilities.
Deprecation
- Marked the previous Kafka producer class as deprecated and recommended using the new wrapper class instead.
Tests
- Updated tests to use the new Kafka producer wrapper.
- Improved test coverage annotations and adjusted naming conventions for test constants.

coderabbitai · 2025-07-22T06:43:30Z

Warning

Rate limit exceeded

@simPod has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 48 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between a68c30a and 8c73bac.

📒 Files selected for processing (5)

src/Clients/Producer/KafkaProducer.php (1 hunks)
src/Clients/Producer/KafkaProducerWrapper.php (1 hunks)
tests/Clients/Consumer/Fixture/TestProducer.php (1 hunks)
tests/Clients/Consumer/KafkaBatchConsumerTest.php (1 hunks)
tests/Clients/Consumer/KafkaTest.php (1 hunks)

Walkthrough

A deprecation notice was added to the existing KafkaProducer class, recommending a new KafkaProducerWrapper as its replacement. The new wrapper class was implemented with message production and flushing capabilities. Test classes were updated to use the new wrapper, adjust namespaces, and update constant naming and coverage attributes.

Changes

File(s)	Change Summary
src/Clients/Producer/KafkaProducer.php	Added `@deprecated` annotation to `KafkaProducer`, recommending `KafkaProducerWrapper` as replacement.
src/Clients/Producer/KafkaProducerWrapper.php	Introduced new `KafkaProducerWrapper` class with message production and flush logic, using modern PHP features.
tests/Clients/Consumer/Fixture/TestProducer.php	Changed namespace, replaced `KafkaProducer` with `KafkaProducerWrapper`, updated constructor and property types.
tests/Clients/Consumer/KafkaBatchConsumerTest.php	Added coverage attributes, renamed constants to PascalCase, updated usages, and imported new dependencies.
tests/Clients/Consumer/KafkaTest.php	Updated import statement for `TestProducer` to new namespace.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant KafkaProducerWrapper
    participant RdKafkaProducer

    Client->>KafkaProducerWrapper: __construct(config, [exitCallback])
    KafkaProducerWrapper->>RdKafkaProducer: create instance with config

    Client->>KafkaProducerWrapper: produce(topic, partition, value, key, headers, timestamp)
    KafkaProducerWrapper->>RdKafkaProducer: newTopic(topic)
    KafkaProducerWrapper->>RdKafkaProducer: producev(...)
    KafkaProducerWrapper->>RdKafkaProducer: poll(0)

    Client->>KafkaProducerWrapper: flushMessages(timeoutMs)
    loop up to 10 times
        KafkaProducerWrapper->>RdKafkaProducer: flush(timeoutMs)
        alt flush successful
            KafkaProducerWrapper-->>Client: return
        end
    end
    KafkaProducerWrapper-->>Client: throw RuntimeException (if not flushed)

Estimated code review effort

3 (~40 minutes)

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Prefer composition over inheritance. Do not extend RdKafka producer.

codecov · 2025-07-22T06:52:21Z

Codecov Report

Attention: Patch coverage is 83.87097% with 5 lines in your changes missing coverage. Please review.

Project coverage is 70.40%. Comparing base (39535d4) to head (8c73bac).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
src/Clients/Producer/KafkaProducerWrapper.php	83.87%	5 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           master     #228       +/-   ##
===========================================
- Coverage   81.77%   70.40%   -11.37%     
===========================================
  Files           8        9        +1     
  Lines         192      223       +31     
===========================================
  Hits          157      157               
- Misses         35       66       +31

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

simPod force-pushed the wrapper branch from a68c30a to 0b5d015 Compare July 22, 2025 06:47

feat: introduce KafkaProducerWrapper

8c73bac

Prefer composition over inheritance. Do not extend RdKafka producer.

simPod force-pushed the wrapper branch from 0b5d015 to 8c73bac Compare July 22, 2025 06:49

simPod merged commit 5788999 into master Jul 22, 2025
8 of 10 checks passed

simPod deleted the wrapper branch July 22, 2025 06:53

coderabbitai bot mentioned this pull request Jul 22, 2025

feat: drop final from KafkaProducerWrapper #229

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: introduce KafkaProducerWrapper #228

feat: introduce KafkaProducerWrapper #228

Uh oh!

simPod commented Jul 22, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 22, 2025 •

edited

Loading

Rate limit exceeded

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov bot commented Jul 22, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

feat: introduce KafkaProducerWrapper #228

feat: introduce KafkaProducerWrapper #228

Uh oh!

Conversation

simPod commented Jul 22, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

simPod commented Jul 22, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 22, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Jul 22, 2025 •

edited

Loading