Run TransportGetLifecycleAction on local node (#126002)

This action solely needs the cluster state, it can run on any node.

Relates #101805

Author: nielsbauman

docs/changelog/126002.yaml

@@ -0,0 +1,5 @@
+pr: 126002
+summary: Run `TransportGetLifecycleAction` on local node
+area: ILM+SLM
+type: enhancement
+issues: []

server/src/main/java/org/elasticsearch/action/support/local/LocalClusterStateRequest.java

@@ -11,6 +11,7 @@
 
 import org.elasticsearch.TransportVersions;
 import org.elasticsearch.action.ActionRequest;
+import org.elasticsearch.action.ActionRequestValidationException;
 import org.elasticsearch.action.support.TransportAction;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
@@ -65,6 +66,11 @@ public final void writeTo(StreamOutput out) throws IOException {
         TransportAction.localOnly();
     }
 
+    @Override
+    public ActionRequestValidationException validate() {
+        return null;
+    }
+
     public TimeValue masterTimeout() {
         return masterTimeout;
     }

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

@@ -9,7 +9,7 @@
 
 import org.elasticsearch.action.ActionResponse;
 import org.elasticsearch.action.ActionType;
-import org.elasticsearch.action.support.master.AcknowledgedRequest;
+import org.elasticsearch.action.support.local.LocalClusterStateRequest;
 import org.elasticsearch.cluster.metadata.ItemUsage;
 import org.elasticsearch.common.Strings;
 import org.elasticsearch.common.collect.Iterators;
@@ -18,6 +18,7 @@
 import org.elasticsearch.common.io.stream.Writeable;
 import org.elasticsearch.common.xcontent.ChunkedToXContentObject;
 import org.elasticsearch.core.TimeValue;
+import org.elasticsearch.core.UpdateForV10;
 import org.elasticsearch.tasks.CancellableTask;
 import org.elasticsearch.tasks.Task;
 import org.elasticsearch.tasks.TaskId;
@@ -43,10 +44,6 @@ public static class Response extends ActionResponse implements ChunkedToXContent
 
         private final List<LifecyclePolicyResponseItem> policies;
 
-        public Response(StreamInput in) throws IOException {
-            this.policies = in.readCollectionAsList(LifecyclePolicyResponseItem::new);
-        }
-
         public Response(List<LifecyclePolicyResponseItem> policies) {
             this.policies = policies;
         }
@@ -55,6 +52,11 @@ public List<LifecyclePolicyResponseItem> getPolicies() {
             return policies;
         }
 
+        /**
+         * NB prior to 9.1 this was a TransportMasterNodeAction so for BwC we must remain able to write these responses until
+         * we no longer need to support calling this action remotely.
+         */
+        @UpdateForV10(owner = UpdateForV10.Owner.DATA_MANAGEMENT)
         @Override
         public void writeTo(StreamOutput out) throws IOException {
             out.writeCollection(policies);
@@ -100,19 +102,26 @@ public Iterator<ToXContent> toXContentChunked(ToXContent.Params outerParams) {
         }
     }
 
-    public static class Request extends AcknowledgedRequest<Request> {
+    public static class Request extends LocalClusterStateRequest {
         private final String[] policyNames;
 
-        public Request(TimeValue masterNodeTimeout, TimeValue ackTimeout, String... policyNames) {
-            super(masterNodeTimeout, ackTimeout);
+        public Request(TimeValue masterNodeTimeout, String... policyNames) {
+            super(masterNodeTimeout);
             if (policyNames == null) {
                 throw new IllegalArgumentException("ids cannot be null");
             }
             this.policyNames = policyNames;
         }
 
+        /**
+         * NB prior to 9.1 this was a TransportMasterNodeAction so for BwC we must remain able to read these requests until
+         * we no longer need to support calling this action remotely.
+         */
+        @UpdateForV10(owner = UpdateForV10.Owner.DATA_MANAGEMENT)
         public Request(StreamInput in) throws IOException {
-            super(in);
+            super(in, false);
+            // This used to be an AcknowledgedRequest so we need to read the ack timeout for BwC.
+            in.readTimeValue();
             policyNames = in.readStringArray();
         }
 
@@ -125,12 +134,6 @@ public String[] getPolicyNames() {
             return policyNames;
         }
 
-        @Override
-        public void writeTo(StreamOutput out) throws IOException {
-            super.writeTo(out);
-            out.writeStringArray(policyNames);
-        }
-
         @Override
         public int hashCode() {
             return Arrays.hashCode(policyNames);
@@ -163,13 +166,11 @@ public LifecyclePolicyResponseItem(LifecyclePolicy lifecyclePolicy, long version
             this.usage = usage;
         }
 
-        LifecyclePolicyResponseItem(StreamInput in) throws IOException {
-            this.lifecyclePolicy = new LifecyclePolicy(in);
-            this.version = in.readVLong();
-            this.modifiedDate = in.readString();
-            this.usage = new ItemUsage(in);
-        }
-
+        /**
+         * NB prior to 9.1 this was a TransportMasterNodeAction so for BwC we must remain able to write these responses until
+         * we no longer need to support calling this action remotely.
+         */
+        @UpdateForV10(owner = UpdateForV10.Owner.DATA_MANAGEMENT)
         @Override
         public void writeTo(StreamOutput out) throws IOException {
             lifecyclePolicy.writeTo(out);

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

@@ -9,11 +9,10 @@
 import org.elasticsearch.cluster.metadata.ItemUsage;
 import org.elasticsearch.common.bytes.BytesReference;
 import org.elasticsearch.common.io.stream.NamedWriteableRegistry;
-import org.elasticsearch.common.io.stream.Writeable;
 import org.elasticsearch.common.xcontent.XContentHelper;
 import org.elasticsearch.core.Nullable;
 import org.elasticsearch.test.AbstractChunkedSerializingTestCase;
-import org.elasticsearch.test.AbstractWireSerializingTestCase;
+import org.elasticsearch.test.ESTestCase;
 import org.elasticsearch.xcontent.XContentBuilder;
 import org.elasticsearch.xpack.core.ilm.LifecycleAction;
 import org.elasticsearch.xpack.core.ilm.LifecycleType;
@@ -33,9 +32,8 @@
 import static org.hamcrest.Matchers.is;
 import static org.hamcrest.Matchers.notNullValue;
 
-public class GetLifecycleResponseTests extends AbstractWireSerializingTestCase<Response> {
+public class GetLifecycleResponseTests extends ESTestCase {
 
-    @Override
     protected Response createTestInstance() {
         String randomPrefix = randomAlphaOfLength(5);
         List<LifecyclePolicyResponseItem> responseItems = new ArrayList<>();
@@ -82,11 +80,6 @@ public void testChunkCount() {
         AbstractChunkedSerializingTestCase.assertChunkCount(response, ignored -> 2 + response.getPolicies().size());
     }
 
-    @Override
-    protected Writeable.Reader<Response> instanceReader() {
-        return Response::new;
-    }
-
     protected NamedWriteableRegistry getNamedWriteableRegistry() {
         return new NamedWriteableRegistry(
             List.of(
@@ -96,35 +89,6 @@ protected NamedWriteableRegistry getNamedWriteableRegistry() {
         );
     }
 
-    @Override
-    protected Response mutateInstance(Response response) {
-        List<LifecyclePolicyResponseItem> responseItems = new ArrayList<>(response.getPolicies());
-        if (responseItems.size() > 0) {
-            if (randomBoolean()) {
-                responseItems.add(
-                    new LifecyclePolicyResponseItem(
-                        randomTestLifecyclePolicy(randomAlphaOfLength(5)),
-                        randomNonNegativeLong(),
-                        randomAlphaOfLength(4),
-                        randomUsage()
-                    )
-                );
-            } else {
-                responseItems.remove(0);
-            }
-        } else {
-            responseItems.add(
-                new LifecyclePolicyResponseItem(
-                    randomTestLifecyclePolicy(randomAlphaOfLength(2)),
-                    randomNonNegativeLong(),
-                    randomAlphaOfLength(4),
-                    randomUsage()
-                )
-            );
-        }
-        return new Response(responseItems);
-    }
-
     public static ItemUsage randomUsage() {
         return new ItemUsage(randomStringList(), randomStringList(), randomStringList());
     }

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

@@ -142,15 +142,13 @@ public void testSingleNodeCluster() throws Exception {
         // test get-lifecycle behavior when IndexLifecycleMetadata is null
         GetLifecycleAction.Response getUninitializedLifecycleResponse = client().execute(
             GetLifecycleAction.INSTANCE,
-            new GetLifecycleAction.Request(TEST_REQUEST_TIMEOUT, TEST_REQUEST_TIMEOUT)
+            new GetLifecycleAction.Request(TEST_REQUEST_TIMEOUT)
         ).get();
         assertThat(getUninitializedLifecycleResponse.getPolicies().size(), equalTo(0));
         ExecutionException exception = expectThrows(
             ExecutionException.class,
-            () -> client().execute(
-                GetLifecycleAction.INSTANCE,
-                new GetLifecycleAction.Request(TEST_REQUEST_TIMEOUT, TEST_REQUEST_TIMEOUT, "non-existent-policy")
-            ).get()
+            () -> client().execute(GetLifecycleAction.INSTANCE, new GetLifecycleAction.Request(TEST_REQUEST_TIMEOUT, "non-existent-policy"))
+                .get()
         );
         assertThat(exception.getMessage(), containsString("Lifecycle policy not found: [non-existent-policy]"));
 
@@ -163,7 +161,7 @@ public void testSingleNodeCluster() throws Exception {
         // assert version and modified_date
         GetLifecycleAction.Response getLifecycleResponse = client().execute(
             GetLifecycleAction.INSTANCE,
-            new GetLifecycleAction.Request(TEST_REQUEST_TIMEOUT, TEST_REQUEST_TIMEOUT)
+            new GetLifecycleAction.Request(TEST_REQUEST_TIMEOUT)
         ).get();
         assertThat(getLifecycleResponse.getPolicies().size(), equalTo(1));
         GetLifecycleAction.LifecyclePolicyResponseItem responseItem = getLifecycleResponse.getPolicies().get(0);
@@ -208,7 +206,7 @@ public void testNoOpPolicyUpdates() throws Exception {
 
         GetLifecycleAction.Response getLifecycleResponse = client().execute(
             GetLifecycleAction.INSTANCE,
-            new GetLifecycleAction.Request(TEST_REQUEST_TIMEOUT, TEST_REQUEST_TIMEOUT)
+            new GetLifecycleAction.Request(TEST_REQUEST_TIMEOUT)
         ).get();
         assertThat(getLifecycleResponse.getPolicies().size(), equalTo(1));
         GetLifecycleAction.LifecyclePolicyResponseItem responseItem = getLifecycleResponse.getPolicies().get(0);
@@ -219,10 +217,7 @@ public void testNoOpPolicyUpdates() throws Exception {
         putLifecycleRequest = new PutLifecycleRequest(TEST_REQUEST_TIMEOUT, TEST_REQUEST_TIMEOUT, policy);
         assertAcked(client().execute(ILMActions.PUT, putLifecycleRequest).get());
 
-        getLifecycleResponse = client().execute(
-            GetLifecycleAction.INSTANCE,
-            new GetLifecycleAction.Request(TEST_REQUEST_TIMEOUT, TEST_REQUEST_TIMEOUT)
-        ).get();
+        getLifecycleResponse = client().execute(GetLifecycleAction.INSTANCE, new GetLifecycleAction.Request(TEST_REQUEST_TIMEOUT)).get();
         assertThat(getLifecycleResponse.getPolicies().size(), equalTo(1));
         responseItem = getLifecycleResponse.getPolicies().get(0);
         assertThat(responseItem.getLifecyclePolicy(), equalTo(policy));
@@ -237,10 +232,7 @@ public void testNoOpPolicyUpdates() throws Exception {
         putLifecycleRequest = new PutLifecycleRequest(TEST_REQUEST_TIMEOUT, TEST_REQUEST_TIMEOUT, policy);
         assertAcked(client().execute(ILMActions.PUT, putLifecycleRequest).get());
 
-        getLifecycleResponse = client().execute(
-            GetLifecycleAction.INSTANCE,
-            new GetLifecycleAction.Request(TEST_REQUEST_TIMEOUT, TEST_REQUEST_TIMEOUT)
-        ).get();
+        getLifecycleResponse = client().execute(GetLifecycleAction.INSTANCE, new GetLifecycleAction.Request(TEST_REQUEST_TIMEOUT)).get();
         assertThat(getLifecycleResponse.getPolicies().size(), equalTo(1));
         responseItem = getLifecycleResponse.getPolicies().get(0);
         assertThat(responseItem.getLifecyclePolicy(), equalTo(policy));
@@ -258,7 +250,7 @@ public void testExplainExecution() throws Exception {
 
         GetLifecycleAction.Response getLifecycleResponse = client().execute(
             GetLifecycleAction.INSTANCE,
-            new GetLifecycleAction.Request(TEST_REQUEST_TIMEOUT, TEST_REQUEST_TIMEOUT)
+            new GetLifecycleAction.Request(TEST_REQUEST_TIMEOUT)
         ).get();
         assertThat(getLifecycleResponse.getPolicies().size(), equalTo(1));
         GetLifecycleAction.LifecyclePolicyResponseItem responseItem = getLifecycleResponse.getPolicies().get(0);
@@ -333,7 +325,7 @@ public void testExplainParseOriginationDate() throws Exception {
 
         GetLifecycleAction.Response getLifecycleResponse = client().execute(
             GetLifecycleAction.INSTANCE,
-            new GetLifecycleAction.Request(TEST_REQUEST_TIMEOUT, TEST_REQUEST_TIMEOUT)
+            new GetLifecycleAction.Request(TEST_REQUEST_TIMEOUT)
         ).get();
         assertThat(getLifecycleResponse.getPolicies().size(), equalTo(1));
         GetLifecycleAction.LifecyclePolicyResponseItem responseItem = getLifecycleResponse.getPolicies().get(0);
@@ -466,7 +458,7 @@ public void testCreatePolicyWhenStopped() throws Exception {
         // assert version and modified_date
         GetLifecycleAction.Response getLifecycleResponse = client().execute(
             GetLifecycleAction.INSTANCE,
-            new GetLifecycleAction.Request(TEST_REQUEST_TIMEOUT, TEST_REQUEST_TIMEOUT)
+            new GetLifecycleAction.Request(TEST_REQUEST_TIMEOUT)
         ).get();
         assertThat(getLifecycleResponse.getPolicies().size(), equalTo(1));
         GetLifecycleAction.LifecyclePolicyResponseItem responseItem = getLifecycleResponse.getPolicies().get(0);

x-pack/plugin/ilm/src/internalClusterTest/java/org/elasticsearch/xpack/ilm/IndexLifecycleInitialisationTests.java

@@ -18,7 +18,6 @@
 import java.util.List;
 
 import static org.elasticsearch.rest.RestRequest.Method.GET;
-import static org.elasticsearch.rest.RestUtils.getAckTimeout;
 import static org.elasticsearch.rest.RestUtils.getMasterNodeTimeout;
 
 public class RestGetLifecycleAction extends BaseRestHandler {
@@ -36,11 +35,7 @@ public String getName() {
     @Override
     protected RestChannelConsumer prepareRequest(RestRequest restRequest, NodeClient client) {
         String[] lifecycleNames = Strings.splitStringByCommaToArray(restRequest.param("name"));
-        GetLifecycleAction.Request getLifecycleRequest = new GetLifecycleAction.Request(
-            getMasterNodeTimeout(restRequest),
-            getAckTimeout(restRequest),
-            lifecycleNames
-        );
+        GetLifecycleAction.Request getLifecycleRequest = new GetLifecycleAction.Request(getMasterNodeTimeout(restRequest), lifecycleNames);
 
         return channel -> new RestCancellableNodeClient(client, restRequest.getHttpChannel()).execute(
             GetLifecycleAction.INSTANCE,