Adds Kaffe.MessageHandler behaviour #154
Open
+107
−51
Conversation
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
This fixes some hex formatting, removes outdated documentation, and fixes what I think is the last of the duplicated `@doc` warnings
This should make implementation easier, and also makes the contract a little more clear. It will also give better warnings in implementing code if (as an example) the wrong return type is possible.
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new Kaffe.MessageHandler behaviour module to centralize documentation and provide better type specs for Kafka message handling. The change improves developer experience by consolidating scattered documentation and enabling better compiler warnings for library consumers.
- Adds
Kaffe.MessageHandlerbehaviour with centralized documentation and type specs - Updates documentation to reference the new behaviour instead of inline explanations
- Reorganizes documentation in producer module by moving inline docs to function definitions
Reviewed Changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| mix.exs | Bumps version to 1.28.0 and adds CHANGELOG.md to documentation |
| lib/kaffe/message_handler.ex | New behaviour module defining handle_messages/1 callback with comprehensive documentation |
| lib/kaffe/consumer_group/worker/worker.ex | Updates worker documentation to reference new MessageHandler behaviour |
| lib/kaffe/consumer.ex | Adds message() type definition for better type safety |
| lib/kaffe/producer.ex | Refactors documentation by moving inline docs to function definitions |
| README.md | Updates usage examples to show MessageHandler behaviour implementation |
| CHANGELOG.md | Documents the new feature in version 1.28.0 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 are a lot of places in the docs where we were explaining the return typing and input for the
handle_messages/1callback from kafka consumption.This behaviour module
@specso library consumers get better warnings