Skip to content

MINOR: Prohibit setting StreamsConfig commit.interval.ms to a negative value #5809

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mjsax merged 4 commits into from
Oct 23, 2018
Merged

MINOR: Prohibit setting StreamsConfig commit.interval.ms to a negative value #5809

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d16a0f5
MINOR: Prohibit setting StreamsConfig commit.interval.ms to a negativ…
occho Oct 17, 2018
627a938
(fixup) Remove the check interval >= 0
occho Oct 18, 2018
eb7f2cd
(fixup) Add a test
occho Oct 19, 2018
35e51dc
(fixup) Remove StateConsumer spec when setting flushInterval to a neg…
occho Oct 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,6 +582,7 @@ public class StreamsConfig extends AbstractConfig {
.define(COMMIT_INTERVAL_MS_CONFIG,
Type.LONG,
DEFAULT_COMMIT_INTERVAL_MS,
atLeast(0),
Importance.LOW,
COMMIT_INTERVAL_MS_DOC)
.define(CONNECTIONS_MAX_IDLE_MS_CONFIG,
Expand Down
2 changes: 1 addition & 1 deletion streams/src/main/java/org/apache/kafka/streams/processor/internals/GlobalStreamThread.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ void pollAndUpdate() {
stateMaintainer.update(record);
}
final long now = time.milliseconds();
if (flushInterval >= 0 && now >= lastFlush + flushInterval) {
if (now >= lastFlush + flushInterval) {
stateMaintainer.flushState();
lastFlush = now;
}
Expand Down
2 changes: 1 addition & 1 deletion streams/src/main/java/org/apache/kafka/streams/processor/internals/StreamThread.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1020,7 +1020,7 @@ private boolean maybePunctuate() {
boolean maybeCommit() {
int committed = 0;

if (commitTimeMs >= 0 && now - lastCommitMs > commitTimeMs) {
if (now - lastCommitMs > commitTimeMs) {
if (log.isTraceEnabled()) {
log.trace("Committing all active tasks {} and standby tasks {} since {}ms has elapsed (commit interval is {}ms)",
taskManager.activeTaskIds(), taskManager.standbyTaskIds(), now - lastCommitMs, commitTimeMs);
Expand Down
12 changes: 12 additions & 0 deletions streams/src/test/java/org/apache/kafka/streams/StreamsConfigTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -521,6 +521,18 @@ public void shouldNotOverrideUserConfigCommitIntervalMsIfExactlyOnceEnabled() {
assertThat(streamsConfig.getLong(StreamsConfig.COMMIT_INTERVAL_MS_CONFIG), equalTo(commitIntervalMs));
}

@Test
public void shouldThrowExceptionIfCommitIntervalMsIsNegative() {
final long commitIntervalMs = -1;
props.put(StreamsConfig.COMMIT_INTERVAL_MS_CONFIG, commitIntervalMs);
try {
new StreamsConfig(props);
fail("Should throw ConfigException when commitIntervalMs is set to a negative value");
} catch (final ConfigException e) {
assertEquals("Invalid value -1 for configuration commit.interval.ms: Value must be at least 0", e.getMessage());
}
}

@Test
public void shouldUseNewConfigsWhenPresent() {
final Properties props = getStreamsConfig();
Expand Down
2 changes: 1 addition & 1 deletion streams/src/test/java/org/apache/kafka/streams/integration/EosIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -677,7 +677,7 @@ public void close() { }
{
put(StreamsConfig.PROCESSING_GUARANTEE_CONFIG, StreamsConfig.EXACTLY_ONCE);
put(StreamsConfig.NUM_STREAM_THREADS_CONFIG, numberOfStreamsThreads);
put(StreamsConfig.COMMIT_INTERVAL_MS_CONFIG, -1);
put(StreamsConfig.COMMIT_INTERVAL_MS_CONFIG, Long.MAX_VALUE);
put(StreamsConfig.consumerPrefix(ConsumerConfig.METADATA_MAX_AGE_CONFIG), "1000");
put(StreamsConfig.consumerPrefix(ConsumerConfig.AUTO_OFFSET_RESET_CONFIG), "earliest");
put(StreamsConfig.consumerPrefix(ConsumerConfig.REQUEST_TIMEOUT_MS_CONFIG), 5 * 1000);
Expand Down
9 changes: 0 additions & 9 deletions streams/src/test/java/org/apache/kafka/streams/processor/internals/StateConsumerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,15 +108,6 @@ public void shouldNotFlushOffsetsWhenFlushIntervalHasNotLapsed() {
assertFalse(stateMaintainer.flushed);
}

@Test
public void shouldNotFlushWhenFlushIntervalIsZero() {
stateConsumer = new GlobalStreamThread.StateConsumer(logContext, consumer, stateMaintainer, time, Duration.ofMillis(10L), -1);

@bbejeck bbejeck Oct 19, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: maybe keep this test but pass in 0 instead?

@occho occho Oct 21, 2018 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From my understanding, the test name is wrong and should be like shouldNotFlushWhenFlushIntervalIsNegative.
The code that shouldNotFlushWhenFlushIntervalIsZero tests is about this line:

kafka/streams/src/main/java/org/apache/kafka/streams/processor/internals/GlobalStreamThread.java

Line 244 in 74f686d

if (flushInterval >= 0 && now >= lastFlush + flushInterval) {

With the code on trunk, when flushInterval is set to negative, stateMaintainer.flushState() is not called.
But, since this spec is removed, I think it is okay to remove the test.

WDYT?

@bbejeck bbejeck Oct 21, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ack, thanks for the explanation. Sounds good to me.

stateConsumer.initialize();
time.sleep(100);
stateConsumer.pollAndUpdate();
assertFalse(stateMaintainer.flushed);
}

@Test
public void shouldCloseConsumer() throws IOException {
stateConsumer.close();
Expand Down