Skip to content

KAFKA-20232: Fix WakeupException in awaitMetadataUpdate() #21592

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

Open
Baisang wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

KAFKA-20232: Fix WakeupException in awaitMetadataUpdate() #21592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion clients/src/main/java/org/apache/kafka/clients/consumer/internals/AbstractCoordinator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ private synchronized boolean ensureCoordinatorReady(final Timer timer, boolean d
if (future.isRetriable()) {
log.debug("Coordinator discovery failed, refreshing metadata", future.exception());
timer.sleep(retryBackoff.backoff(attempts++));
client.awaitMetadataUpdate(timer);
client.awaitMetadataUpdate(timer, disableWakeup);
} else {
fatalException = future.exception();
log.info("FindCoordinator request hit fatal exception", fatalException);
Expand Down
13 changes: 12 additions & 1 deletion clients/src/main/java/org/apache/kafka/clients/consumer/internals/ConsumerNetworkClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,20 @@ public boolean hasReadyNodes(long now) {
* @return true if update succeeded, false otherwise.
*/
public boolean awaitMetadataUpdate(Timer timer) {

@lianetm lianetm Jun 15, 2026

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.

here too, probably worth clarifying that this one "throws WakeUp"

(consistent with the java doc of the poll in this same file btw)

return awaitMetadataUpdate(timer, false);
}

/**
* Block waiting on the metadata refresh with a timeout.
*
* @param timer Timer bounding how long this method can block
* @param disableWakeup true if we should not check for wakeups, false otherwise
* @return true if update succeeded, false otherwise.
*/
public boolean awaitMetadataUpdate(Timer timer, boolean disableWakeup) {

@lianetm lianetm Jun 15, 2026

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.

could we add the "throws WakeUp" java doc?

int version = this.metadata.requestUpdate(false);
do {
poll(timer);
poll(timer, null, disableWakeup);
} while (this.metadata.updateVersion() == version && timer.notExpired());
return this.metadata.updateVersion() > version;
}
Expand Down
15 changes: 15 additions & 0 deletions ...ts/src/test/java/org/apache/kafka/clients/consumer/internals/AbstractCoordinatorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,21 @@ public void testWakeupFromEnsureCoordinatorReady() {
);
}

@Test
public void testNoWakeupFromAsyncCoordinatorReadyOnRetriableError() {
setupCoordinator();
mockClient.prepareResponse(groupCoordinatorResponse(node, Errors.COORDINATOR_NOT_AVAILABLE));
consumerClient.wakeup();
// The async variation should not throw WakeupException
coordinator.ensureCoordinatorReadyAsync();

consumerClient.wakeup();
mockClient.prepareResponse(groupCoordinatorResponse(node, Errors.COORDINATOR_NOT_AVAILABLE));
assertThrows(WakeupException.class, () ->
coordinator.ensureCoordinatorReady(mockTime.timer(0))
);
}

@Test
public void testTimeoutAndRetryJoinGroupIfNeeded() throws Exception {
setupCoordinator();
Expand Down
Loading