feat: add ProduceResult with encoded request size metadata
#276
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
Signed-off-by: WenyXu <[email protected]>
WenyXu
force-pushed
the
feat/produce_result
branch
from
39d93c0 to
bc582e9
Compare
crepererum
requested changes
Aug 13, 2025
There was a problem hiding this comment.
I think the end2end test should assert this new field as well.
|
|
||
| /// The result of the produce call. | ||
| #[derive(Debug, Default)] | ||
| pub struct ProduceResult { |
There was a problem hiding this comment.
Suggested change
| pub struct ProduceResult { | |
| #[non_exhaustive] | |
| pub struct ProduceResult { |
makes it easier to extend this later w/o introducing breaking changes.
src/messenger.rs
Outdated
| self.version_ranges = ranges; | ||
| } | ||
|
|
||
| pub async fn request<R>(&self, msg: R) -> Result<R::ResponseBody, RequestError> |
There was a problem hiding this comment.
While this method is technically public, I doubt that anybody really uses it. So I think request should just return the metadata as well, in the same way that request_with_version_ranges does. This keeps the API kinda lean and avoids having all sorts of permutations.
src/protocol/messages/mod.rs
Outdated
| } | ||
| } | ||
|
|
||
| /// A response body with metadata about the request. |
There was a problem hiding this comment.
Suggested change
| /// A response body with metadata about the request. | |
| /// A response body with metadata about the request & response. |
I think we can make this a bit more generic for future additions.
src/client/producer.rs
Outdated
| } | ||
| } | ||
|
|
||
| /// The result of the produce call. |
There was a problem hiding this comment.
Suggested change
| /// The result of the produce call. | |
| /// The result of the [produce](ProducerClient::produce) call. |
This makes it clearer which API you're referencing here.
Signed-off-by: WenyXu <[email protected]>
WenyXu
force-pushed
the
feat/produce_result
branch
from
b1b5c99 to
a12992f
Compare
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.
Closes #275
This PR introduces a new
ProduceResultstruct that provides enhanced information about produce operations, including both the offsets of produced records and the encoded request size in bytes.New Types
ProduceResult: A new struct containing:offsets: Vec<i64>: The offsets of the produced recordsencoded_request_size: usize: The size of the request encoded in bytesResponseBodyWithMetadata<R>: A generic wrapper for response bodies that includes metadata about the encoded request sizeAPI Changes
produce()method to returnProduceResultinstead of just VecProduceResultwith request size informationrequest_with_metadata()method that returns response with size metadata