Flag to return messages received so far when maxWait is reached #313
Conversation
This file contains 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
The current behavior, to panic on deadline is problematic, since there are a number of scenarios where you simply do not know how many messages there are to consume or when they are produced. For example, a load test may produce messages in bursts with jitter for a burn-in test, to try to provoke i data races in the test subject. This commit introduces a flag ExpectTimeout which will return message received so far. The commit also adds a test to verify that we panic if Close() is called while we are consuming. Given the nature of the problem xk6-kafka is trying to solve, this sounds like an errar condition.
|
Hm, how do I update the api-docs? They look auto-generated? |
|
@bittrance Update index.d.ts and then run the following in sequence, considering you have node, yarn and node_modules installed: yarn run validate-d-ts
yarn run generate-docs
yarn run prettify |
bittrance
force-pushed
the
consume-returns-on-deadline
branch
from
8e2b8ee
to
3417e6d
Compare
|
mostafa
approved these changes
Dec 4, 2024
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.
The current behavior, to panic on deadline is problematic, since there are a number of scenarios where you simply do not know how many messages there are to consume or when they are produced. For example, a load test may produce messages in bursts with jitter for a burn-in test, to try to provoke i data races in the test subject.
This commit introduces a flag ExpectTimeout which will return message received so far.
The commit also adds a test to verify that we panic if Close() is called while we are consuming. Given the nature of the problem xk6-kafka is trying to solve, this sounds like an error condition.
Fixes #311.