Make messages stream breakable automatically #72
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
mcollina
reviewed
Jul 7, 2025
| throw new UserError('Cannot collect messages when the stream is in MANUAL break mode.') | ||
| } | ||
| return Array.fromAsync(this) | ||
| } |
There was a problem hiding this comment.
I'm not sure I would add this. As you noted, a user could just do Array.fromAsync(), which would do the trick. It would be good to document it in the docs.
The place where we should add this would be in the consumer as collectNBatch(), which would be easier.
| @@ -402,6 +413,10 @@ export class MessagesStream<Key, Value, HeaderKey, HeaderValue> extends Readable | |||
| } | |||
|
|
|||
| this.#pushRecords(metadata, topicIds, response, requestedOffsets) | |||
|
|
|||
| if (this.#breakMode === MessagesStreamBreakModes.AFTER_FIRST_BATCH && this.#inflightNodes.size === 0) { | |||
There was a problem hiding this comment.
I think this could be generalized to collecting the first n batches.
ShogunPanda
requested changes
Jul 14, 2025
There was a problem hiding this comment.
I agree with @mcollina to make the method generic for n-batches.
This would imply to accept a numeric option (0 by default) rather than an enum.
Anyway, this PR is fantastic, thanks for your contribution!
| @@ -402,6 +413,10 @@ export class MessagesStream<Key, Value, HeaderKey, HeaderValue> extends Readable | |||
| } | |||
|
|
|||
| this.#pushRecords(metadata, topicIds, response, requestedOffsets) | |||
|
|
|||
| if (this.#breakMode === MessagesStreamBreakModes.AFTER_FIRST_BATCH && this.#inflightNodes.size === 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.
This change introduces an option
breakModeto theMessagesStreamclass and likewise to the options of the consumer'sconsumemethod. This option accepts one of two allowed values:dataevent handler.MessageStreamclass issue only one fetch request per leader of a topic's partition without requeueing more requests. After all issued requests are completed, the stream ends and returns all the collected messages.Additionally, the
MessagesStreamclass gets a new methodcollectwhich returns an array of all the messages that are collectable via 2. This method is only supported if thebreakModeoption is set to 'after-first-batch'.Related: