Skip to content

Remove all usages of Metadata project customs removal methods #129043

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
merged 2 commits into from
Jun 11, 2025
+32 −43
Merged

Remove all usages of Metadata project customs removal methods #129043

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef8f63f
Remove all usages of Metadata customs removal methods
nielsbauman Jun 2, 2025
2be6567
Merge branch 'main' into metadata-builder/remove-custom
nielsbauman Jun 11, 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
9 changes: 7 additions & 2 deletions server/src/internalClusterTest/java/org/elasticsearch/cluster/ClusterStateDiffIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import org.elasticsearch.cluster.metadata.IndexTemplateMetadata;
import org.elasticsearch.cluster.metadata.Metadata;
import org.elasticsearch.cluster.metadata.NodesShutdownMetadata;
import org.elasticsearch.cluster.metadata.ProjectId;
import org.elasticsearch.cluster.node.DiscoveryNode;
import org.elasticsearch.cluster.node.DiscoveryNodeUtils;
import org.elasticsearch.cluster.node.DiscoveryNodes;
Expand All @@ -45,6 +46,7 @@
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.common.util.set.Sets;
import org.elasticsearch.core.FixForMultiProject;
import org.elasticsearch.gateway.GatewayService;
import org.elasticsearch.index.Index;
import org.elasticsearch.index.IndexVersion;
Expand Down Expand Up @@ -706,12 +708,15 @@ public Metadata.Builder put(Metadata.Builder builder, Metadata.ProjectCustom par

@Override
public Metadata.Builder remove(Metadata.Builder builder, String name) {
@FixForMultiProject
final var projectBuilder = builder.getProject(ProjectId.DEFAULT);
if (IndexGraveyard.TYPE.equals(name)) {
// there must always be at least an empty graveyard
return builder.indexGraveyard(IndexGraveyard.builder().build());
projectBuilder.indexGraveyard(IndexGraveyard.builder().build());
} else {
return builder.removeProjectCustom(name);
projectBuilder.removeCustom(name);
}
return builder;
}

@Override
Expand Down
8 changes: 4 additions & 4 deletions server/src/internalClusterTest/java/org/elasticsearch/snapshots/CustomMetadataContextIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,13 @@ public void testShouldRestoreOnlySnapshotMetadata() throws Exception {
assertThat(getSnapshot("test-repo", "test-snapshot").state(), equalTo(SnapshotState.SUCCESS));

logger.info("update custom persistent metadata");
updateClusterState(currentState -> currentState.copyAndUpdateMetadata(metadataBuilder -> {
updateClusterState(currentState -> currentState.copyAndUpdateProject(currentState.metadata().getProject().id(), builder -> {
if (isSnapshotMetadataSet == false || randomBoolean()) {
metadataBuilder.putCustom(SnapshotMetadata.TYPE, new SnapshotMetadata("after_snapshot_s"));
builder.putCustom(SnapshotMetadata.TYPE, new SnapshotMetadata("after_snapshot_s"));
} else {
metadataBuilder.removeProjectCustom(SnapshotMetadata.TYPE);
builder.removeCustom(SnapshotMetadata.TYPE);
}
metadataBuilder.putCustom(ApiMetadata.TYPE, new ApiMetadata("after_snapshot_ns"));
builder.putCustom(ApiMetadata.TYPE, new ApiMetadata("after_snapshot_ns"));
}));

logger.info("restore snapshot");
Expand Down
6 changes: 5 additions & 1 deletion server/src/main/java/org/elasticsearch/cluster/coordination/RemoveCustomsCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
import org.elasticsearch.cli.UserException;
import org.elasticsearch.cluster.ClusterState;
import org.elasticsearch.cluster.metadata.Metadata;
import org.elasticsearch.cluster.metadata.ProjectId;
import org.elasticsearch.cluster.metadata.ProjectMetadata;
import org.elasticsearch.common.regex.Regex;
import org.elasticsearch.core.FixForMultiProject;
import org.elasticsearch.core.Tuple;
Expand Down Expand Up @@ -66,6 +68,8 @@ protected void processDataPaths(Terminal terminal, Path[] dataPaths, OptionSet o
"project scoped custom metadata names: " + oldClusterState.metadata().getProject().customs().keySet()
);
final Metadata.Builder metadataBuilder = Metadata.builder(oldClusterState.metadata());
@FixForMultiProject
final ProjectMetadata.Builder projectBuilder = metadataBuilder.getProject(ProjectId.DEFAULT);
for (String customToRemove : customsToRemove) {
@FixForMultiProject
boolean matched = false;
Expand All @@ -82,7 +86,7 @@ protected void processDataPaths(Terminal terminal, Path[] dataPaths, OptionSet o
}
for (String customKey : oldClusterState.metadata().getProject().customs().keySet()) {
if (Regex.simpleMatch(customToRemove, customKey)) {
metadataBuilder.removeProjectCustom(customKey);
projectBuilder.removeCustom(customKey);
if (matched == false) {
terminal.println("The following customs will be removed:");
}
Expand Down
12 changes: 0 additions & 12 deletions server/src/main/java/org/elasticsearch/cluster/metadata/Metadata.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1743,18 +1743,6 @@ public Builder putProjectCustom(String type, ProjectCustom custom) {
return this;
}

@Deprecated(forRemoval = true)
public Builder removeProjectCustom(String type) {
getSingleProject().removeCustom(type);
return this;
}

@Deprecated(forRemoval = true)
public Builder removeProjectCustomIf(BiPredicate<String, ? super ProjectCustom> p) {
getSingleProject().removeCustomIf(p);
return this;
}

@Deprecated(forRemoval = true)
public Builder projectCustoms(Map<String, ProjectCustom> projectCustoms) {
projectCustoms.forEach((key, value) -> Objects.requireNonNull(value, key));
Expand Down
6 changes: 4 additions & 2 deletions server/src/test/java/org/elasticsearch/cluster/ClusterChangedEventTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -681,10 +681,12 @@ private static ClusterState nextState(
final ClusterState.Builder builder = ClusterState.builder(previousState);
builder.stateUUID(UUIDs.randomBase64UUID());
Metadata.Builder metadataBuilder = Metadata.builder(previousState.metadata());
ProjectMetadata.Builder projectBuilder = ProjectMetadata.builder(previousState.metadata().projects().values().iterator().next());
metadataBuilder.removeCustomIf((ignore, custom) -> custom instanceof TestClusterCustomMetadata);
metadataBuilder.removeProjectCustomIf((ignore, custom) -> custom instanceof TestProjectCustomMetadata);
projectBuilder.removeCustomIf((ignore, custom) -> custom instanceof TestProjectCustomMetadata);
clusterCustoms.forEach(clusterCustom -> metadataBuilder.putCustom(clusterCustom.getWriteableName(), clusterCustom));
projectCustoms.forEach(projectCustom -> metadataBuilder.putCustom(projectCustom.getWriteableName(), projectCustom));
projectCustoms.forEach(projectCustom -> projectBuilder.putCustom(projectCustom.getWriteableName(), projectCustom));
metadataBuilder.put(projectBuilder);
builder.metadata(metadataBuilder);
return builder.build();
}
Expand Down
14 changes: 0 additions & 14 deletions server/src/test/java/org/elasticsearch/cluster/metadata/MetadataTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1391,20 +1391,6 @@ public void testBuilderRemoveClusterCustomIf() {
assertThat(metadata.custom("custom2"), sameInstance(custom2));
}

public void testBuilderRemoveProjectCustomIf() {
var custom1 = new TestProjectCustomMetadata();
var custom2 = new TestProjectCustomMetadata();
var builder = Metadata.builder();
builder.putCustom("custom1", custom1);
builder.putCustom("custom2", custom2);

builder.removeProjectCustomIf((key, value) -> Objects.equals(key, "custom1"));

var metadata = builder.build();
assertThat(metadata.getProject().custom("custom1"), nullValue());
assertThat(metadata.getProject().custom("custom2"), sameInstance(custom2));
}

public void testBuilderRejectsDataStreamThatConflictsWithIndex() {
final String dataStreamName = "my-data-stream";
IndexMetadata idx = createFirstBackingIndex(dataStreamName).build();
Expand Down
6 changes: 5 additions & 1 deletion server/src/test/java/org/elasticsearch/persistent/PersistentTasksClusterServiceTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import org.elasticsearch.cluster.metadata.IndexMetadata;
import org.elasticsearch.cluster.metadata.Metadata;
import org.elasticsearch.cluster.metadata.NodesShutdownMetadata;
import org.elasticsearch.cluster.metadata.ProjectMetadata;
import org.elasticsearch.cluster.metadata.SingleNodeShutdownMetadata;
import org.elasticsearch.cluster.node.DiscoveryNode;
import org.elasticsearch.cluster.node.DiscoveryNodeRole;
Expand Down Expand Up @@ -933,7 +934,10 @@ private ClusterState insignificantChange(ClusterState clusterState) {
if (scope == PersistentTasksExecutor.Scope.CLUSTER) {
metadata = Metadata.builder(clusterState.metadata()).removeCustom(ClusterPersistentTasksCustomMetadata.TYPE);
} else {
metadata = Metadata.builder(clusterState.metadata()).removeProjectCustom(PersistentTasksCustomMetadata.TYPE);
metadata = Metadata.builder(clusterState.metadata())
.put(
ProjectMetadata.builder(clusterState.metadata().getProject()).removeCustom(PersistentTasksCustomMetadata.TYPE)
);
}
return builder.metadata(metadata).build();
}
Expand Down
8 changes: 4 additions & 4 deletions x-pack/plugin/ccr/src/test/java/org/elasticsearch/xpack/CcrIntegTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
import org.elasticsearch.cluster.RestoreInProgress;
import org.elasticsearch.cluster.health.ClusterHealthStatus;
import org.elasticsearch.cluster.metadata.IndexMetadata;
import org.elasticsearch.cluster.metadata.Metadata;
import org.elasticsearch.cluster.metadata.ProjectMetadata;
import org.elasticsearch.cluster.routing.ShardRouting;
import org.elasticsearch.cluster.routing.UnassignedInfo;
import org.elasticsearch.cluster.routing.allocation.DiskThresholdSettings;
Expand Down Expand Up @@ -865,10 +865,10 @@ static void removeCCRRelatedMetadataFromClusterState(ClusterService clusterServi
public ClusterState execute(ClusterState currentState) throws Exception {
AutoFollowMetadata empty = new AutoFollowMetadata(Collections.emptyMap(), Collections.emptyMap(), Collections.emptyMap());
ClusterState.Builder newState = ClusterState.builder(currentState);
newState.metadata(
Metadata.builder(currentState.getMetadata())
newState.putProjectMetadata(
ProjectMetadata.builder(currentState.metadata().getProject())
.putCustom(AutoFollowMetadata.TYPE, empty)
.removeProjectCustom(PersistentTasksCustomMetadata.TYPE)
.removeCustom(PersistentTasksCustomMetadata.TYPE)
.build()
);
return newState.build();
Expand Down
6 changes: 3 additions & 3 deletions ...ugin/migrate/src/main/java/org/elasticsearch/system_indices/task/SystemIndexMigrator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
import org.elasticsearch.cluster.ClusterStateUpdateTask;
import org.elasticsearch.cluster.metadata.IndexMetadata;
import org.elasticsearch.cluster.metadata.IndexTemplateMetadata;
import org.elasticsearch.cluster.metadata.Metadata;
import org.elasticsearch.cluster.metadata.MetadataIndexTemplateService;
import org.elasticsearch.cluster.metadata.ProjectMetadata;
import org.elasticsearch.cluster.service.ClusterService;
Expand Down Expand Up @@ -863,9 +862,10 @@ private static void clearResults(ClusterService clusterService, ActionListener<C
submitUnbatchedTask(clusterService, "clear migration results", new ClusterStateUpdateTask() {
@Override
public ClusterState execute(ClusterState currentState) throws Exception {
if (currentState.metadata().getProject().custom(FeatureMigrationResults.TYPE) != null) {
final var project = currentState.metadata().getProject();
if (project.custom(FeatureMigrationResults.TYPE) != null) {
return ClusterState.builder(currentState)
.metadata(Metadata.builder(currentState.metadata()).removeProjectCustom(FeatureMigrationResults.TYPE))
.putProjectMetadata(ProjectMetadata.builder(project).removeCustom(FeatureMigrationResults.TYPE))
.build();
}
return currentState;
Expand Down