Skip to content

Fix test race condition in file settings monitoring #137965

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix test race condition in file settings monitoring #137965

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53d470f
Fix test race condition in file settings monitoring
rjernst Nov 12, 2025
1d61d09
Merge branch 'main' into file_settings/test_robustness2
rjernst Nov 12, 2025
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
27 changes: 19 additions & 8 deletions ...ternalClusterTest/java/org/elasticsearch/reservedstate/service/FileSettingsServiceIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import org.elasticsearch.action.admin.cluster.state.ClusterStateRequest;
import org.elasticsearch.action.admin.cluster.state.ClusterStateResponse;
import org.elasticsearch.cluster.ClusterChangedEvent;
import org.elasticsearch.cluster.ClusterState;
import org.elasticsearch.cluster.ClusterStateListener;
import org.elasticsearch.cluster.metadata.ReservedStateErrorMetadata;
import org.elasticsearch.cluster.metadata.ReservedStateHandlerMetadata;
Expand All @@ -39,6 +40,7 @@
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicLong;
import java.util.function.Function;
import java.util.stream.Stream;

import static org.elasticsearch.cluster.metadata.ReservedStateMetadata.EMPTY_VERSION;
Expand Down Expand Up @@ -194,22 +196,31 @@ private Tuple<CountDownLatch, AtomicLong> setupClusterStateListener(String node,
ClusterService clusterService = internalCluster().clusterService(node);
CountDownLatch savedClusterState = new CountDownLatch(1);
AtomicLong metadataVersion = new AtomicLong(-1);
clusterService.addListener(new ClusterStateListener() {
@Override
public void clusterChanged(ClusterChangedEvent event) {
ReservedStateMetadata reservedState = event.state().metadata().reservedStateMetadata().get(FileSettingsService.NAMESPACE);
Function<ClusterState, Boolean> clusterStateProcessor = clusterState -> {
synchronized (savedClusterState) {
ReservedStateMetadata reservedState = clusterState.metadata().reservedStateMetadata().get(FileSettingsService.NAMESPACE);
if (reservedState != null && reservedState.version() == fileSettingsVersion) {
clusterService.removeListener(this);
metadataVersion.set(event.state().metadata().version());
metadataVersion.set(clusterState.metadata().version());
Copy link
Contributor

@prdoyle prdoyle Nov 12, 2025

Choose a reason for hiding this comment

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

Do I understand this correctly? If the reserved state version is the one we're expecting, we infer that the metadata version must also be the one we're expecting, on the assumption that the latest metadata update was the one that updated the reserved state. This seems ok in these particular tests where there are very few metadata updates, even though it wouldn't be correct in general.

Am I close?

Did you manage to induce this logic path with sleeps in the tests that call this method?

Copy link
Member Author

@rjernst rjernst Nov 12, 2025

Choose a reason for hiding this comment

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

We don't assert anything about the metadata version, this captures the metadata version once we see the file settings version we expect.

And yes I reproduced with a sleep just before creating the state listener.

savedClusterState.countDown();
logger.info(
"done waiting for file settings [version: {}, metadata version: {}]",
event.state().version(),
event.state().metadata().version()
clusterState.version(),
clusterState.metadata().version()
);
return true;
}
return false;
}
};
clusterService.addListener(new ClusterStateListener() {
@Override
public void clusterChanged(ClusterChangedEvent event) {
if (clusterStateProcessor.apply(event.state())) {
clusterService.removeListener(this);
}
}
});
clusterStateProcessor.apply(clusterService.state());

return new Tuple<>(savedClusterState, metadataVersion);
}
Expand Down