Skips to next available action on missing step (#32283)

if policy update on index means current step no longer exists

This change only updates the setPolicy for index to add this
functionality. The update policy API will be changed in a follow up PR.

Author: colings86

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/indexlifecycle/AllocateAction.java

@@ -131,6 +131,13 @@ public List<Step> toSteps(Client client, String phase, StepKey nextStepKey) {
         return Arrays.asList(allocateStep, routedCheckStep);
     }
 
+    @Override
+    public List<StepKey> toStepKeys(String phase) {
+        StepKey allocateKey = new StepKey(phase, NAME, NAME);
+        StepKey allocationRoutedKey = new StepKey(phase, NAME, AllocationRoutedStep.NAME);
+        return Arrays.asList(allocateKey, allocationRoutedKey);
+    }
+
     @Override
     public int hashCode() {
         return Objects.hash(include, exclude, require);

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/indexlifecycle/DeleteAction.java

@@ -12,6 +12,7 @@
 import org.elasticsearch.common.xcontent.ObjectParser;
 import org.elasticsearch.common.xcontent.XContentBuilder;
 import org.elasticsearch.common.xcontent.XContentParser;
+import org.elasticsearch.xpack.core.indexlifecycle.Step.StepKey;
 
 import java.io.IOException;
 import java.util.Collections;
@@ -62,6 +63,11 @@ public List<Step> toSteps(Client client, String phase, Step.StepKey nextStepKey)
         return Collections.singletonList(new DeleteStep(deleteStepKey, nextStepKey, client));
     }
 
+    @Override
+    public List<StepKey> toStepKeys(String phase) {
+        return Collections.singletonList(new Step.StepKey(phase, NAME, DeleteStep.NAME));
+    }
+
     @Override
     public int hashCode() {
         return 1;

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

@@ -84,14 +84,20 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
 
     @Override
     public List<Step> toSteps(Client client, String phase, Step.StepKey nextStepKey) {
-        StepKey updateCompressionKey = new StepKey(phase, NAME, "best_compression");
         StepKey forceMergeKey = new StepKey(phase, NAME, ForceMergeStep.NAME);
         StepKey countKey = new StepKey(phase, NAME, SegmentCountStep.NAME);
         ForceMergeStep forceMergeStep = new ForceMergeStep(forceMergeKey, countKey, client, maxNumSegments);
         SegmentCountStep segmentCountStep = new SegmentCountStep(countKey, nextStepKey, client, maxNumSegments);
         return Arrays.asList(forceMergeStep, segmentCountStep);
     }
 
+    @Override
+    public List<StepKey> toStepKeys(String phase) {
+        StepKey forceMergeKey = new StepKey(phase, NAME, ForceMergeStep.NAME);
+        StepKey countKey = new StepKey(phase, NAME, SegmentCountStep.NAME);
+        return Arrays.asList(forceMergeKey, countKey);
+    }
+
     @Override
     public int hashCode() {
         return Objects.hash(maxNumSegments);

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/indexlifecycle/LifecycleAction.java

@@ -9,6 +9,7 @@
 import org.elasticsearch.common.Nullable;
 import org.elasticsearch.common.io.stream.NamedWriteable;
 import org.elasticsearch.common.xcontent.ToXContentObject;
+import org.elasticsearch.xpack.core.indexlifecycle.Step.StepKey;
 
 import java.util.List;
 
@@ -29,6 +30,15 @@ public interface LifecycleAction extends ToXContentObject, NamedWriteable {
      */
     List<Step> toSteps(Client client, String phase, @Nullable Step.StepKey nextStepKey);
 
+    /**
+     * 
+     * @param phase
+     *            the name of the phase this action is being executed within
+     * @return the {@link StepKey}s for the steps which will be executed in this
+     *         action
+     */
+    List<StepKey> toStepKeys(String phase);
+
     /**
      * @return true if this action is considered safe. An action is not safe if
      *         it will produce unwanted side effects or will get stuck when the

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/indexlifecycle/LifecyclePolicy.java

@@ -245,6 +245,82 @@ public boolean isActionSafe(StepKey stepKey) {
         }
     }
 
+    /**
+     * Finds the next valid {@link StepKey} on or after the provided
+     * {@link StepKey}. If the provided {@link StepKey} is valid in this policy
+     * it will be returned. If its not valid the next available {@link StepKey}
+     * will be returned.
+     */
+    public StepKey getNextValidStep(StepKey stepKey) {
+        Phase phase = phases.get(stepKey.getPhase());
+        if (phase == null) {
+            // Phase doesn't exist so find the after step for the previous
+            // available phase
+            return getAfterStepBeforePhase(stepKey.getPhase());
+        } else {
+            // Phase exists so check if the action exists
+            LifecycleAction action = phase.getActions().get(stepKey.getAction());
+            if (action == null) {
+                // if action doesn't exist find the first step in the next
+                // available action
+                return getFirstStepInNextAction(stepKey.getAction(), phase);
+            } else {
+                // if the action exists check if the step itself exists
+                if (action.toStepKeys(phase.getName()).contains(stepKey)) {
+                    // stepKey is valid still so return it
+                    return stepKey;
+                } else {
+                    // stepKey no longer exists in the action so we need to move
+                    // to the first step in the next action since skipping steps
+                    // in an action is not safe
+                    return getFirstStepInNextAction(stepKey.getAction(), phase);
+                }
+            }
+        }
+    }
+    
+    private StepKey getNextAfterStep(String currentPhaseName) {
+        String nextPhaseName = type.getNextPhaseName(currentPhaseName, phases);
+        if (nextPhaseName == null) {
+            // We don't have a next phase after this one so there is no after
+            // step to move to. Instead we need to go to the terminal step as
+            // there are no more steps we should execute
+            return TerminalPolicyStep.KEY;
+        } else {
+            return new StepKey(currentPhaseName, PhaseAfterStep.NAME, PhaseAfterStep.NAME);
+        }
+    }
+
+    private StepKey getAfterStepBeforePhase(String currentPhaseName) {
+        String nextPhaseName = type.getNextPhaseName(currentPhaseName, phases);
+        if (nextPhaseName == null) {
+            // We don't have a next phase after this one so the next step is the
+            // TerminalPolicyStep
+            return TerminalPolicyStep.KEY;
+        } else {
+            String prevPhaseName = type.getPreviousPhaseName(currentPhaseName, phases);
+            if (prevPhaseName == null) {
+                // no previous phase available so go to the
+                // InitializePolicyContextStep
+                return InitializePolicyContextStep.KEY;
+            }
+            return new StepKey(prevPhaseName, PhaseAfterStep.NAME, PhaseAfterStep.NAME);
+        }
+    }
+
+    private StepKey getFirstStepInNextAction(String currentActionName, Phase phase) {
+        String nextActionName = type.getNextActionName(currentActionName, phase);
+        if (nextActionName == null) {
+            // The current action is the last in this phase so we need to find
+            // the next after step
+            return getNextAfterStep(phase.getName());
+        } else {
+            LifecycleAction nextAction = phase.getActions().get(nextActionName);
+            // Return the first stepKey for nextAction
+            return nextAction.toStepKeys(phase.getName()).get(0);
+        }
+    }
+
     @Override
     public int hashCode() {
         return Objects.hash(name, phases);

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/indexlifecycle/LifecycleType.java

@@ -7,6 +7,7 @@
 
 import org.elasticsearch.common.io.stream.NamedWriteable;
 
+import java.security.Policy;
 import java.util.Collection;
 import java.util.List;
 import java.util.Map;
@@ -18,8 +19,47 @@ public interface LifecycleType extends NamedWriteable {
      */
     List<Phase> getOrderedPhases(Map<String, Phase> phases);
 
+    /**
+     * Returns the next phase thats available after
+     * <code>currentPhaseName</code>. Note that <code>currentPhaseName</code>
+     * does not need to exist in <code>phases</code>.
+     * 
+     * If the current {@link Phase} is the last phase in the {@link Policy} this
+     * method will return <code>null</code>.
+     * 
+     * If the phase is not valid for the lifecycle type an
+     * {@link IllegalArgumentException} will be thrown.
+     */
+    String getNextPhaseName(String currentPhaseName, Map<String, Phase> phases);
+
+    /**
+     * Returns the previous phase thats available before
+     * <code>currentPhaseName</code>. Note that <code>currentPhaseName</code>
+     * does not need to exist in <code>phases</code>.
+     * 
+     * If the current {@link Phase} is the first phase in the {@link Policy}
+     * this method will return <code>null</code>.
+     * 
+     * If the phase is not valid for the lifecycle type an
+     * {@link IllegalArgumentException} will be thrown.
+     */
+    String getPreviousPhaseName(String currentPhaseName, Map<String, Phase> phases);
+
     List<LifecycleAction> getOrderedActions(Phase phase);
 
+    /**
+     * Returns the name of the next phase that is available in the phases after
+     * <code>currentActionName</code>. Note that <code>currentActionName</code>
+     * does not need to exist in the {@link Phase}.
+     * 
+     * If the current action is the last action in the phase this method will
+     * return <code>null</code>.
+     * 
+     * If the action is not valid for the phase an
+     * {@link IllegalArgumentException} will be thrown.
+     */
+    String getNextActionName(String currentActionName, Phase phase);
+
 
     /**
      * validates whether the specified <code>phases</code> are valid for this

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/indexlifecycle/ReadOnlyAction.java

@@ -14,6 +14,7 @@
 import org.elasticsearch.common.xcontent.ObjectParser;
 import org.elasticsearch.common.xcontent.XContentBuilder;
 import org.elasticsearch.common.xcontent.XContentParser;
+import org.elasticsearch.xpack.core.indexlifecycle.Step.StepKey;
 
 import java.io.IOException;
 import java.util.Collections;
@@ -65,6 +66,11 @@ public List<Step> toSteps(Client client, String phase, Step.StepKey nextStepKey)
         Settings readOnlySettings = Settings.builder().put(IndexMetaData.SETTING_BLOCKS_WRITE, true).build();
         return Collections.singletonList(new UpdateSettingsStep(key, nextStepKey, client, readOnlySettings));
     }
+    
+    @Override
+    public List<StepKey> toStepKeys(String phase) {
+        return Collections.singletonList(new Step.StepKey(phase, NAME, NAME));
+    }
 
     @Override
     public int hashCode() {

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/indexlifecycle/ReplicasAction.java

@@ -87,6 +87,13 @@ public List<Step> toSteps(Client client, String phase, Step.StepKey nextStepKey)
                 new ReplicasAllocatedStep(enoughKey, nextStepKey));
     }
 
+    @Override
+    public List<StepKey> toStepKeys(String phase) {
+        StepKey updateReplicasKey = new StepKey(phase, NAME, UpdateSettingsStep.NAME);
+        StepKey enoughKey = new StepKey(phase, NAME, ReplicasAllocatedStep.NAME);
+        return Arrays.asList(updateReplicasKey, enoughKey);
+    }
+
     public int getNumberOfReplicas() {
         return numberOfReplicas;
     }

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/indexlifecycle/RolloverAction.java

@@ -139,6 +139,13 @@ public List<Step> toSteps(Client client, String phase, Step.StepKey nextStepKey)
         return Arrays.asList(rolloverStep, updateDateStep);
     }
 
+    @Override
+    public List<StepKey> toStepKeys(String phase) {
+        StepKey rolloverStepKey = new StepKey(phase, NAME, RolloverStep.NAME);
+        StepKey updateDateStepKey = new StepKey(phase, NAME, UpdateRolloverLifecycleDateStep.NAME);
+        return Arrays.asList(rolloverStepKey, updateDateStepKey);
+    }
+
     @Override
     public int hashCode() {
         return Objects.hash(maxSize, maxAge, maxDocs);

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

@@ -97,6 +97,17 @@ public List<Step> toSteps(Client client, String phase, Step.StepKey nextStepKey)
         return Arrays.asList(setSingleNodeStep, allocationStep, shrink, allocated, aliasSwapAndDelete, waitOnShrinkTakeover);
     }
 
+    @Override
+    public List<StepKey> toStepKeys(String phase) {
+        StepKey setSingleNodeKey = new StepKey(phase, NAME, SetSingleNodeAllocateStep.NAME);
+        StepKey allocationRoutedKey = new StepKey(phase, NAME, AllocationRoutedStep.NAME);
+        StepKey shrinkKey = new StepKey(phase, NAME, ShrinkStep.NAME);
+        StepKey enoughShardsKey = new StepKey(phase, NAME, ShrunkShardsAllocatedStep.NAME);
+        StepKey aliasKey = new StepKey(phase, NAME, ShrinkSetAliasStep.NAME);
+        StepKey isShrunkIndexKey = new StepKey(phase, NAME, ShrunkenIndexCheckStep.NAME);
+        return Arrays.asList(setSingleNodeKey, allocationRoutedKey, shrinkKey, enoughShardsKey, aliasKey, isShrunkIndexKey);
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;