Make ILM ClusterStateActionStep project-aware

server/src/main/java/org/elasticsearch/cluster/ProjectState.java

@@ -13,6 +13,7 @@
 import org.elasticsearch.cluster.metadata.ProjectId;
 import org.elasticsearch.cluster.metadata.ProjectMetadata;
 import org.elasticsearch.cluster.routing.RoutingTable;
+import org.elasticsearch.common.Strings;
 
 import java.util.Objects;
 import java.util.function.Consumer;
@@ -74,4 +75,24 @@ public ClusterState updatedState(Consumer<ProjectMetadata.Builder> projectBuilde
         projectBuilderConsumer.accept(projectBuilder);
         return ClusterState.builder(cluster).putProjectMetadata(projectBuilder).build();
     }
+
+    /**
+     * Build a new {@link ProjectState} with the updated {@code project}.
+     */
+    public ProjectState withProject(ProjectMetadata updatedProject) {
+        // No need to build a new object if the project is unchanged.
+        if (metadata() == updatedProject) {
+            return this;
+        }
+        if (project.equals(updatedProject.id()) == false) {
+            throw new IllegalArgumentException(
+                Strings.format(
+                    "Unable to update project state with project ID [%s] because updated project has ID [%s]",
+                    project,
+                    updatedProject.id()
+                )
+            );
+        }
+        return new ProjectState(ClusterState.builder(cluster).putProjectMetadata(updatedProject).build(), project);
+    }
 }

test/framework/src/main/java/org/elasticsearch/test/ESTestCase.java

@@ -57,9 +57,13 @@
 import org.elasticsearch.client.internal.ElasticsearchClient;
 import org.elasticsearch.client.internal.Requests;
 import org.elasticsearch.cluster.ClusterModule;
+import org.elasticsearch.cluster.ClusterName;
+import org.elasticsearch.cluster.ClusterState;
+import org.elasticsearch.cluster.ProjectState;
 import org.elasticsearch.cluster.metadata.IndexMetadata;
 import org.elasticsearch.cluster.metadata.Metadata;
 import org.elasticsearch.cluster.metadata.ProjectId;
+import org.elasticsearch.cluster.metadata.ProjectMetadata;
 import org.elasticsearch.common.CheckedSupplier;
 import org.elasticsearch.common.UUIDs;
 import org.elasticsearch.common.breaker.CircuitBreaker;
@@ -2818,4 +2822,11 @@ public static IndexSearcher newSearcher(IndexReader r, boolean maybeWrap, boolea
         }
         return newSearcher(r, maybeWrap, wrapWithAssertions, Concurrency.NONE);
     }
+
+    /**
+     * Constructs a {@link ProjectState} for the given {@link ProjectMetadata.Builder}.
+     */
+    public static ProjectState projectStateFromProject(ProjectMetadata.Builder project) {
+        return ClusterState.builder(ClusterName.DEFAULT).putProjectMetadata(project).build().projectState(project.getId());
+    }
 }

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/ilm/BranchingStep.java

@@ -10,7 +10,7 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.apache.lucene.util.SetOnce;
-import org.elasticsearch.cluster.ClusterState;
+import org.elasticsearch.cluster.ProjectState;
 import org.elasticsearch.cluster.metadata.IndexMetadata;
 import org.elasticsearch.cluster.metadata.ProjectMetadata;
 import org.elasticsearch.index.Index;
@@ -62,15 +62,15 @@ public boolean isRetryable() {
     }
 
     @Override
-    public ClusterState performAction(Index index, ClusterState clusterState) {
-        IndexMetadata indexMetadata = clusterState.metadata().getProject().index(index);
+    public ProjectState performAction(Index index, ProjectState projectState) {
+        IndexMetadata indexMetadata = projectState.metadata().index(index);
         if (indexMetadata == null) {
             // Index must have been since deleted, ignore it
             logger.debug("[{}] lifecycle action for index [{}] executed but index no longer exists", getKey().action(), index.getName());
-            return clusterState;
+            return projectState;
         }
-        predicateValue.set(predicate.test(index, clusterState.metadata().getProject()));
-        return clusterState;
+        predicateValue.set(predicate.test(index, projectState.metadata()));
+        return projectState;
     }
 
     /**

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/ilm/ClusterStateActionStep.java

@@ -6,7 +6,7 @@
  */
 package org.elasticsearch.xpack.core.ilm;
 
-import org.elasticsearch.cluster.ClusterState;
+import org.elasticsearch.cluster.ProjectState;
 import org.elasticsearch.core.Tuple;
 import org.elasticsearch.index.Index;
 
@@ -19,7 +19,7 @@ public ClusterStateActionStep(StepKey key, StepKey nextStepKey) {
         super(key, nextStepKey);
     }
 
-    public abstract ClusterState performAction(Index index, ClusterState clusterState);
+    public abstract ProjectState performAction(Index index, ProjectState projectState);
 
     /**
      * Returns a tuple of index name to step key for an index *other* than the

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/ilm/CopyExecutionStateStep.java

@@ -10,7 +10,7 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.apache.lucene.util.SetOnce;
-import org.elasticsearch.cluster.ClusterState;
+import org.elasticsearch.cluster.ProjectState;
 import org.elasticsearch.cluster.metadata.IndexMetadata;
 import org.elasticsearch.cluster.metadata.LifecycleExecutionState;
 import org.elasticsearch.core.Tuple;
@@ -66,18 +66,18 @@ public Tuple<String, StepKey> indexForAsyncInvocation() {
     }
 
     @Override
-    public ClusterState performAction(Index index, ClusterState clusterState) {
-        IndexMetadata indexMetadata = clusterState.metadata().getProject().index(index);
+    public ProjectState performAction(Index index, ProjectState projectState) {
+        IndexMetadata indexMetadata = projectState.metadata().index(index);
         if (indexMetadata == null) {
             // Index must have been since deleted, ignore it
             logger.debug("[{}] lifecycle action for index [{}] executed but index no longer exists", getKey().action(), index.getName());
-            return clusterState;
+            return projectState;
         }
         // get target index
         LifecycleExecutionState lifecycleState = indexMetadata.getLifecycleExecutionState();
         String targetIndexName = targetIndexNameSupplier.apply(index.getName(), lifecycleState);
         calculatedTargetIndexName.set(targetIndexName);
-        IndexMetadata targetIndexMetadata = clusterState.metadata().getProject().index(targetIndexName);
+        IndexMetadata targetIndexMetadata = projectState.metadata().index(targetIndexName);
 
         if (targetIndexMetadata == null) {
             logger.warn(
@@ -101,10 +101,8 @@ public ClusterState performAction(Index index, ClusterState clusterState) {
         newLifecycleState.setAction(action);
         newLifecycleState.setStep(step);
 
-        return LifecycleExecutionStateUtils.newClusterStateWithLifecycleState(
-            clusterState,
-            targetIndexMetadata.getIndex(),
-            newLifecycleState.build()
+        return projectState.withProject(
+            projectState.metadata().withLifecycleState(targetIndexMetadata.getIndex(), newLifecycleState.build())
         );
     }
 

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/ilm/CopySettingsStep.java

@@ -8,7 +8,7 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
-import org.elasticsearch.cluster.ClusterState;
+import org.elasticsearch.cluster.ProjectState;
 import org.elasticsearch.cluster.metadata.IndexMetadata;
 import org.elasticsearch.cluster.metadata.LifecycleExecutionState;
 import org.elasticsearch.cluster.metadata.ProjectMetadata;
@@ -62,21 +62,21 @@ BiFunction<String, LifecycleExecutionState, String> getTargetIndexNameSupplier()
     }
 
     @Override
-    public ClusterState performAction(Index index, ClusterState clusterState) {
+    public ProjectState performAction(Index index, ProjectState projectState) {
         String sourceIndexName = index.getName();
-        IndexMetadata sourceIndexMetadata = clusterState.metadata().getProject().index(sourceIndexName);
+        IndexMetadata sourceIndexMetadata = projectState.metadata().index(sourceIndexName);
         if (sourceIndexMetadata == null) {
             // Index must have been since deleted, ignore it
             logger.debug("[{}] lifecycle action for index [{}] executed but index no longer exists", getKey().action(), sourceIndexName);
-            return clusterState;
+            return projectState;
         }
 
         if (settingsKeys == null || settingsKeys.length == 0) {
-            return clusterState;
+            return projectState;
         }
 
         String targetIndexName = targetIndexNameSupplier.apply(sourceIndexName, sourceIndexMetadata.getLifecycleExecutionState());
-        IndexMetadata targetIndexMetadata = clusterState.metadata().getProject().index(targetIndexName);
+        IndexMetadata targetIndexMetadata = projectState.metadata().index(targetIndexName);
         if (targetIndexMetadata == null) {
             String errorMessage = Strings.format(
                 "index [%s] is being referenced by ILM action [%s] on step [%s] but it doesn't exist",
@@ -94,11 +94,10 @@ public ClusterState performAction(Index index, ClusterState clusterState) {
             settings.put(key, value);
         }
 
-        ProjectMetadata.Builder newProject = ProjectMetadata.builder(clusterState.getMetadata().getProject())
-            .put(
-                IndexMetadata.builder(targetIndexMetadata).settingsVersion(targetIndexMetadata.getSettingsVersion() + 1).settings(settings)
-            );
-        return ClusterState.builder(clusterState).putProjectMetadata(newProject).build();
+        IndexMetadata.Builder updatedIndex = IndexMetadata.builder(targetIndexMetadata)
+            .settingsVersion(targetIndexMetadata.getSettingsVersion() + 1)
+            .settings(settings);
+        return projectState.withProject(ProjectMetadata.builder(projectState.metadata()).put(updatedIndex).build());
     }
 
     @Override

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/ilm/DownsamplePrepareLifeCycleStateStep.java

@@ -9,7 +9,7 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
-import org.elasticsearch.cluster.ClusterState;
+import org.elasticsearch.cluster.ProjectState;
 import org.elasticsearch.cluster.metadata.IndexMetadata;
 import org.elasticsearch.cluster.metadata.LifecycleExecutionState;
 import org.elasticsearch.index.Index;
@@ -35,12 +35,12 @@ public DownsamplePrepareLifeCycleStateStep(StepKey key, StepKey nextStepKey, Dat
     }
 
     @Override
-    public ClusterState performAction(Index index, ClusterState clusterState) {
-        IndexMetadata indexMetadata = clusterState.metadata().getProject().index(index);
+    public ProjectState performAction(Index index, ProjectState projectState) {
+        IndexMetadata indexMetadata = projectState.metadata().index(index);
         if (indexMetadata == null) {
             // Index must have been since deleted, ignore it
             LOGGER.debug("[{}] lifecycle action for index [{}] executed but index no longer exists", getKey().action(), index.getName());
-            return clusterState;
+            return projectState;
         }
 
         LifecycleExecutionState lifecycleState = indexMetadata.getLifecycleExecutionState();
@@ -49,11 +49,7 @@ public ClusterState performAction(Index index, ClusterState clusterState) {
         final String downsampleIndexName = generateDownsampleIndexName(DOWNSAMPLED_INDEX_PREFIX, indexMetadata, fixedInterval);
         newLifecycleState.setDownsampleIndexName(downsampleIndexName);
 
-        return LifecycleExecutionStateUtils.newClusterStateWithLifecycleState(
-            clusterState,
-            indexMetadata.getIndex(),
-            newLifecycleState.build()
-        );
+        return projectState.withProject(projectState.metadata().withLifecycleState(indexMetadata.getIndex(), newLifecycleState.build()));
     }
 
     @Override

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/ilm/GenerateSnapshotNameStep.java

@@ -9,7 +9,7 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.elasticsearch.action.ActionRequestValidationException;
-import org.elasticsearch.cluster.ClusterState;
+import org.elasticsearch.cluster.ProjectState;
 import org.elasticsearch.cluster.metadata.IndexMetadata;
 import org.elasticsearch.cluster.metadata.IndexNameExpressionResolver;
 import org.elasticsearch.cluster.metadata.LifecycleExecutionState;
@@ -46,12 +46,12 @@ public String getSnapshotRepository() {
     }
 
     @Override
-    public ClusterState performAction(Index index, ClusterState clusterState) {
-        IndexMetadata indexMetadata = clusterState.metadata().getProject().index(index);
+    public ProjectState performAction(Index index, ProjectState projectState) {
+        IndexMetadata indexMetadata = projectState.metadata().index(index);
         if (indexMetadata == null) {
             // Index must have been since deleted, ignore it
             logger.debug("[{}] lifecycle action for index [{}] executed but index no longer exists", getKey().action(), index.getName());
-            return clusterState;
+            return projectState;
         }
 
         String policyName = indexMetadata.getLifecyclePolicyName();
@@ -60,7 +60,7 @@ public ClusterState performAction(Index index, ClusterState clusterState) {
         // validate that the snapshot repository exists -- because policies are refreshed on later retries, and because
         // this fails prior to the snapshot repository being recorded in the ilm metadata, the policy can just be corrected
         // and everything will pass on the subsequent retry
-        if (RepositoriesMetadata.get(clusterState).repository(snapshotRepository) == null) {
+        if (RepositoriesMetadata.get(projectState.metadata()).repository(snapshotRepository) == null) {
             throw new IllegalStateException(
                 "repository ["
                     + snapshotRepository
@@ -95,11 +95,7 @@ public ClusterState performAction(Index index, ClusterState clusterState) {
             newLifecycleState.setSnapshotName(snapshotName);
         }
 
-        return LifecycleExecutionStateUtils.newClusterStateWithLifecycleState(
-            clusterState,
-            indexMetadata.getIndex(),
-            newLifecycleState.build()
-        );
+        return projectState.withProject(projectState.metadata().withLifecycleState(indexMetadata.getIndex(), newLifecycleState.build()));
     }
 
     @Override

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/ilm/GenerateUniqueIndexNameStep.java

@@ -9,7 +9,7 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.elasticsearch.action.ActionRequestValidationException;
-import org.elasticsearch.cluster.ClusterState;
+import org.elasticsearch.cluster.ProjectState;
 import org.elasticsearch.cluster.metadata.IndexMetadata;
 import org.elasticsearch.cluster.metadata.LifecycleExecutionState;
 import org.elasticsearch.cluster.metadata.LifecycleExecutionState.Builder;
@@ -61,20 +61,20 @@ BiFunction<String, Builder, Builder> lifecycleStateSetter() {
     }
 
     @Override
-    public ClusterState performAction(Index index, ClusterState clusterState) {
-        IndexMetadata indexMetadata = clusterState.metadata().getProject().index(index);
+    public ProjectState performAction(Index index, ProjectState projectState) {
+        IndexMetadata indexMetadata = projectState.metadata().index(index);
         if (indexMetadata == null) {
             // Index must have been since deleted, ignore it
             logger.debug("[{}] lifecycle action for index [{}] executed but index no longer exists", getKey().action(), index.getName());
-            return clusterState;
+            return projectState;
         }
 
         LifecycleExecutionState lifecycleState = indexMetadata.getLifecycleExecutionState();
 
         Builder newLifecycleState = LifecycleExecutionState.builder(lifecycleState);
         String policyName = indexMetadata.getLifecyclePolicyName();
         String generatedIndexName = generateIndexName(prefix, index.getName());
-        ActionRequestValidationException validationException = validateGeneratedIndexName(generatedIndexName, clusterState.projectState());
+        ActionRequestValidationException validationException = validateGeneratedIndexName(generatedIndexName, projectState);
         if (validationException != null) {
             logger.warn(
                 "unable to generate a valid index name as part of policy [{}] for index [{}] due to [{}]",
@@ -86,11 +86,7 @@ public ClusterState performAction(Index index, ClusterState clusterState) {
         }
         lifecycleStateSetter.apply(generatedIndexName, newLifecycleState);
 
-        return LifecycleExecutionStateUtils.newClusterStateWithLifecycleState(
-            clusterState,
-            indexMetadata.getIndex(),
-            newLifecycleState.build()
-        );
+        return projectState.withProject(projectState.metadata().withLifecycleState(indexMetadata.getIndex(), newLifecycleState.build()));
     }
 
     @Override

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/ilm/InitializePolicyContextStep.java

@@ -8,7 +8,7 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
-import org.elasticsearch.cluster.ClusterState;
+import org.elasticsearch.cluster.ProjectState;
 import org.elasticsearch.cluster.metadata.IndexMetadata;
 import org.elasticsearch.cluster.metadata.LifecycleExecutionState;
 import org.elasticsearch.cluster.metadata.ProjectMetadata;
@@ -33,17 +33,17 @@ public final class InitializePolicyContextStep extends ClusterStateActionStep {
     }
 
     @Override
-    public ClusterState performAction(Index index, ClusterState clusterState) {
-        IndexMetadata indexMetadata = clusterState.getMetadata().getProject().index(index);
+    public ProjectState performAction(Index index, ProjectState projectState) {
+        IndexMetadata indexMetadata = projectState.metadata().index(index);
         if (indexMetadata == null) {
             logger.debug("[{}] lifecycle action for index [{}] executed but index no longer exists", getKey().action(), index.getName());
             // Index must have been since deleted, ignore it
-            return clusterState;
+            return projectState;
         }
 
         LifecycleExecutionState lifecycleState = indexMetadata.getLifecycleExecutionState();
         if (lifecycleState.lifecycleDate() != null) {
-            return clusterState;
+            return projectState;
         }
 
         LifecycleExecutionState newLifecycleState = LifecycleExecutionState.builder(lifecycleState)
@@ -63,11 +63,7 @@ public ClusterState performAction(Index index, ClusterState clusterState) {
 
         if (parsedOriginationDate == null) {
             // we don't need to update the LifecycleSettings.LIFECYCLE_ORIGINATION_DATE, so we can use the fast path
-            return LifecycleExecutionStateUtils.newClusterStateWithLifecycleState(
-                clusterState,
-                indexMetadata.getIndex(),
-                newLifecycleState
-            );
+            return projectState.withProject(projectState.metadata().withLifecycleState(indexMetadata.getIndex(), newLifecycleState));
         } else {
             // we do need to update the LifecycleSettings.LIFECYCLE_ORIGINATION_DATE, so we can't use the fast path
             IndexMetadata.Builder builder = IndexMetadata.builder(indexMetadata);
@@ -79,9 +75,7 @@ public ClusterState performAction(Index index, ClusterState clusterState) {
                         .build()
                 );
             builder.putCustom(ILM_CUSTOM_METADATA_KEY, newLifecycleState.asMap());
-            return ClusterState.builder(clusterState)
-                .putProjectMetadata(ProjectMetadata.builder(clusterState.metadata().getProject()).put(builder).build())
-                .build();
+            return projectState.withProject(ProjectMetadata.builder(projectState.metadata()).put(builder).build());
         }
     }