Make ILM BranchingStep predicate project-aware (elastic#127804)

This change only makes the predicate inside `BranchingStep`
project-aware, to limit the scope of PRs.

A follow-up PR will target `ClusterStateActionStep` and all its
descendants (including `BranchingStep`).

Author: nielsbauman

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

@@ -12,6 +12,7 @@
 import org.apache.lucene.util.SetOnce;
 import org.elasticsearch.cluster.ClusterState;
 import org.elasticsearch.cluster.metadata.IndexMetadata;
+import org.elasticsearch.cluster.metadata.ProjectMetadata;
 import org.elasticsearch.index.Index;
 
 import java.util.Objects;
@@ -29,7 +30,7 @@ public class BranchingStep extends ClusterStateActionStep {
 
     private final StepKey nextStepKeyOnFalse;
     private final StepKey nextStepKeyOnTrue;
-    private final BiPredicate<Index, ClusterState> predicate;
+    private final BiPredicate<Index, ProjectMetadata> predicate;
     private final SetOnce<Boolean> predicateValue;
 
     /**
@@ -41,7 +42,12 @@ public class BranchingStep extends ClusterStateActionStep {
      * @param nextStepKeyOnTrue  the key of the step to run if predicate returns true
      * @param predicate          the condition to check when deciding which step to run next
      */
-    public BranchingStep(StepKey key, StepKey nextStepKeyOnFalse, StepKey nextStepKeyOnTrue, BiPredicate<Index, ClusterState> predicate) {
+    public BranchingStep(
+        StepKey key,
+        StepKey nextStepKeyOnFalse,
+        StepKey nextStepKeyOnTrue,
+        BiPredicate<Index, ProjectMetadata> predicate
+    ) {
         // super.nextStepKey is set to null since it is not used by this step
         super(key, null);
         this.nextStepKeyOnFalse = nextStepKeyOnFalse;
@@ -63,7 +69,7 @@ public ClusterState performAction(Index index, ClusterState clusterState) {
             logger.debug("[{}] lifecycle action for index [{}] executed but index no longer exists", getKey().action(), index.getName());
             return clusterState;
         }
-        predicateValue.set(predicate.test(index, clusterState));
+        predicateValue.set(predicate.test(index, clusterState.metadata().getProject()));
         return clusterState;
     }
 
@@ -98,7 +104,7 @@ final StepKey getNextStepKeyOnTrue() {
         return nextStepKeyOnTrue;
     }
 
-    public final BiPredicate<Index, ClusterState> getPredicate() {
+    public final BiPredicate<Index, ProjectMetadata> getPredicate() {
         return predicate;
     }
 

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

@@ -157,8 +157,8 @@ public List<Step> toSteps(Client client, String phase, StepKey nextStepKey) {
             timeSeriesIndexCheckBranchKey,
             nextStepKey,
             checkNotWriteIndex,
-            (index, clusterState) -> {
-                IndexMetadata indexMetadata = clusterState.metadata().getProject().index(index);
+            (index, project) -> {
+                IndexMetadata indexMetadata = project.index(index);
                 assert indexMetadata != null : "invalid cluster metadata. index [" + index.getName() + "] metadata not found";
                 if (IndexSettings.MODE.get(indexMetadata.getSettings()) != IndexMode.TIME_SERIES) {
                     return false;
@@ -258,8 +258,8 @@ public List<Step> toSteps(Client client, String phase, StepKey nextStepKey) {
             dataStreamCheckBranchingKey,
             swapAliasesKey,
             replaceDataStreamIndexKey,
-            (index, clusterState) -> {
-                IndexAbstraction indexAbstraction = clusterState.metadata().getProject().getIndicesLookup().get(index.getName());
+            (index, project) -> {
+                IndexAbstraction indexAbstraction = project.getIndicesLookup().get(index.getName());
                 assert indexAbstraction != null : "invalid cluster metadata. index [" + index.getName() + "] was not found";
                 return indexAbstraction.getParentDataStream() != null;
             }

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

@@ -135,8 +135,8 @@ public List<Step> toSteps(Client client, String phase, Step.StepKey nextStepKey)
             preForceMergeBranchingKey,
             checkNotWriteIndexKey,
             nextStepKey,
-            (index, clusterState) -> {
-                IndexMetadata indexMetadata = clusterState.metadata().getProject().index(index);
+            (index, project) -> {
+                IndexMetadata indexMetadata = project.index(index);
                 assert indexMetadata != null : "index " + index.getName() + " must exist in the cluster state";
                 if (indexMetadata.getSettings().get(LifecycleSettings.SNAPSHOT_INDEX_NAME) != null) {
                     String policyName = indexMetadata.getLifecyclePolicyName();

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

@@ -104,8 +104,8 @@ public List<Step> toSteps(Client client, String phase, StepKey nextStepKey) {
                 preMigrateBranchingKey,
                 migrationKey,
                 nextStepKey,
-                (index, clusterState) -> {
-                    IndexMetadata indexMetadata = clusterState.metadata().getProject().index(index);
+                (index, project) -> {
+                    IndexMetadata indexMetadata = project.index(index);
 
                     // partially mounted indices will already have data_frozen, and we don't want to change that if they do
                     if (indexMetadata.isPartialSearchableSnapshot()) {

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

@@ -189,13 +189,13 @@ public List<Step> toSteps(Client client, String phase, StepKey nextStepKey, XPac
             preActionBranchingKey,
             checkNoWriteIndex,
             nextStepKey,
-            (index, clusterState) -> {
+            (index, project) -> {
                 if (SEARCHABLE_SNAPSHOT_FEATURE.checkWithoutTracking(licenseState) == false) {
                     logger.error("[{}] action is not available in the current license", SearchableSnapshotAction.NAME);
                     throw LicenseUtils.newComplianceException("searchable-snapshots");
                 }
 
-                IndexMetadata indexMetadata = clusterState.getMetadata().getProject().index(index);
+                IndexMetadata indexMetadata = project.index(index);
                 assert indexMetadata != null : "index " + index.getName() + " must exist in the cluster state";
                 String policyName = indexMetadata.getLifecyclePolicyName();
                 SearchableSnapshotMetadata searchableSnapshotMetadata = extractSearchableSnapshotFromSettings(indexMetadata);
@@ -278,8 +278,8 @@ public List<Step> toSteps(Client client, String phase, StepKey nextStepKey, XPac
             skipGeneratingSnapshotKey,
             keyForSnapshotGeneration,
             waitForDataTierKey,
-            (index, clusterState) -> {
-                IndexMetadata indexMetadata = clusterState.getMetadata().getProject().index(index);
+            (index, project) -> {
+                IndexMetadata indexMetadata = project.index(index);
                 String policyName = indexMetadata.getLifecyclePolicyName();
                 LifecycleExecutionState lifecycleExecutionState = indexMetadata.getLifecycleExecutionState();
                 SearchableSnapshotMetadata searchableSnapshotMetadata = extractSearchableSnapshotFromSettings(indexMetadata);
@@ -379,8 +379,8 @@ public List<Step> toSteps(Client client, String phase, StepKey nextStepKey, XPac
             dataStreamCheckBranchingKey,
             swapAliasesKey,
             replaceDataStreamIndexKey,
-            (index, clusterState) -> {
-                IndexAbstraction indexAbstraction = clusterState.metadata().getProject().getIndicesLookup().get(index.getName());
+            (index, project) -> {
+                IndexAbstraction indexAbstraction = project.getIndicesLookup().get(index.getName());
                 assert indexAbstraction != null : "invalid cluster metadata. index [" + index.getName() + "] was not found";
                 return indexAbstraction.getParentDataStream() != null;
             }

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

@@ -287,8 +287,8 @@ public List<Step> toSteps(Client client, String phase, Step.StepKey nextStepKey)
             dataStreamCheckBranchingKey,
             aliasKey,
             replaceDataStreamIndexKey,
-            (index, clusterState) -> {
-                IndexAbstraction indexAbstraction = clusterState.metadata().getProject().getIndicesLookup().get(index.getName());
+            (index, project) -> {
+                IndexAbstraction indexAbstraction = project.getIndicesLookup().get(index.getName());
                 assert indexAbstraction != null : "invalid cluster metadata. index [" + index.getName() + "] was not found";
                 return indexAbstraction.getParentDataStream() != null;
             }

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

@@ -53,17 +53,12 @@ public List<Step> toSteps(Client client, String phase, StepKey nextStepKey) {
         StepKey openFollowerIndex = new StepKey(phase, NAME, OPEN_FOLLOWER_INDEX_STEP_NAME);
         StepKey waitForYellowStep = new StepKey(phase, NAME, WaitForIndexColorStep.NAME);
 
-        BranchingStep conditionalSkipUnfollowStep = new BranchingStep(
-            preUnfollowKey,
-            indexingComplete,
-            nextStepKey,
-            (index, clusterState) -> {
-                IndexMetadata followerIndex = clusterState.metadata().getProject().index(index);
-                Map<String, String> customIndexMetadata = followerIndex.getCustomData(CCR_METADATA_KEY);
-                // if the index has no CCR metadata we'll skip the unfollow action completely
-                return customIndexMetadata == null;
-            }
-        );
+        BranchingStep conditionalSkipUnfollowStep = new BranchingStep(preUnfollowKey, indexingComplete, nextStepKey, (index, project) -> {
+            IndexMetadata followerIndex = project.index(index);
+            Map<String, String> customIndexMetadata = followerIndex.getCustomData(CCR_METADATA_KEY);
+            // if the index has no CCR metadata we'll skip the unfollow action completely
+            return customIndexMetadata == null;
+        });
         WaitForIndexingCompleteStep step1 = new WaitForIndexingCompleteStep(indexingComplete, waitForFollowShardTasks);
         WaitForFollowShardTasksStep step2 = new WaitForFollowShardTasksStep(waitForFollowShardTasks, pauseFollowerIndex, client);
         PauseFollowerIndexStep step3 = new PauseFollowerIndexStep(pauseFollowerIndex, closeFollowerIndex, client);

x-pack/plugin/core/src/test/java/org/elasticsearch/xpack/core/ilm/BranchingStepTests.java

@@ -10,47 +10,39 @@
 import org.elasticsearch.cluster.ClusterName;
 import org.elasticsearch.cluster.ClusterState;
 import org.elasticsearch.cluster.metadata.IndexMetadata;
-import org.elasticsearch.cluster.metadata.Metadata;
-import org.elasticsearch.index.Index;
+import org.elasticsearch.cluster.metadata.ProjectId;
+import org.elasticsearch.cluster.metadata.ProjectMetadata;
+import org.elasticsearch.core.FixForMultiProject;
 import org.elasticsearch.index.IndexVersion;
 import org.elasticsearch.xpack.core.ilm.Step.StepKey;
 
-import java.util.function.BiPredicate;
-
 import static org.hamcrest.Matchers.equalTo;
 
 public class BranchingStepTests extends AbstractStepTestCase<BranchingStep> {
 
     public void testPredicateNextStepChange() {
         String indexName = randomAlphaOfLength(5);
-        ClusterState state = ClusterState.builder(ClusterName.DEFAULT)
-            .metadata(
-                Metadata.builder()
-                    .put(IndexMetadata.builder(indexName).settings(settings(IndexVersion.current())).numberOfShards(1).numberOfReplicas(0))
-            )
+        @FixForMultiProject // Use non-default project ID and pass project directly instead of state
+        ProjectMetadata project = ProjectMetadata.builder(ProjectId.DEFAULT)
+            .put(IndexMetadata.builder(indexName).settings(settings(IndexVersion.current())).numberOfShards(1).numberOfReplicas(0))
             .build();
+        ClusterState state = ClusterState.builder(ClusterName.DEFAULT).putProjectMetadata(project).build();
         StepKey stepKey = new StepKey(randomAlphaOfLength(5), randomAlphaOfLength(5), BranchingStep.NAME);
         StepKey nextStepKey = new StepKey(randomAlphaOfLength(6), randomAlphaOfLength(6), BranchingStep.NAME);
         StepKey nextSkipKey = new StepKey(randomAlphaOfLength(7), randomAlphaOfLength(7), BranchingStep.NAME);
         {
             BranchingStep step = new BranchingStep(stepKey, nextStepKey, nextSkipKey, (i, c) -> true);
             expectThrows(IllegalStateException.class, step::getNextStepKey);
-            step.performAction(state.metadata().getProject().index(indexName).getIndex(), state);
+            step.performAction(project.index(indexName).getIndex(), state);
             assertThat(step.getNextStepKey(), equalTo(step.getNextStepKeyOnTrue()));
-            expectThrows(
-                SetOnce.AlreadySetException.class,
-                () -> step.performAction(state.metadata().getProject().index(indexName).getIndex(), state)
-            );
+            expectThrows(SetOnce.AlreadySetException.class, () -> step.performAction(project.index(indexName).getIndex(), state));
         }
         {
             BranchingStep step = new BranchingStep(stepKey, nextStepKey, nextSkipKey, (i, c) -> false);
             expectThrows(IllegalStateException.class, step::getNextStepKey);
-            step.performAction(state.metadata().getProject().index(indexName).getIndex(), state);
+            step.performAction(project.index(indexName).getIndex(), state);
             assertThat(step.getNextStepKey(), equalTo(step.getNextStepKeyOnFalse()));
-            expectThrows(
-                SetOnce.AlreadySetException.class,
-                () -> step.performAction(state.metadata().getProject().index(indexName).getIndex(), state)
-            );
+            expectThrows(SetOnce.AlreadySetException.class, () -> step.performAction(project.index(indexName).getIndex(), state));
         }
     }
 
@@ -67,7 +59,6 @@ public BranchingStep mutateInstance(BranchingStep instance) {
         StepKey key = instance.getKey();
         StepKey nextStepKey = instance.getNextStepKeyOnFalse();
         StepKey nextSkipStepKey = instance.getNextStepKeyOnTrue();
-        BiPredicate<Index, ClusterState> predicate = instance.getPredicate();
 
         switch (between(0, 2)) {
             case 0 -> key = new StepKey(key.phase(), key.action(), key.name() + randomAlphaOfLength(5));
@@ -80,7 +71,7 @@ public BranchingStep mutateInstance(BranchingStep instance) {
             default -> throw new AssertionError("Illegal randomisation branch");
         }
 
-        return new BranchingStep(key, nextStepKey, nextSkipStepKey, predicate);
+        return new BranchingStep(key, nextStepKey, nextSkipStepKey, instance.getPredicate());
     }
 
     @Override