Remove persistent tasks that failed to initialize from cluster state (#71462)

Author: fcofdez

server/src/internalClusterTest/java/org/elasticsearch/persistent/PersistentTaskInitializationFailureIT.java

@@ -0,0 +1,143 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+package org.elasticsearch.persistent;
+
+import org.elasticsearch.Version;
+import org.elasticsearch.action.support.PlainActionFuture;
+import org.elasticsearch.client.Client;
+import org.elasticsearch.cluster.metadata.IndexNameExpressionResolver;
+import org.elasticsearch.cluster.service.ClusterService;
+import org.elasticsearch.common.UUIDs;
+import org.elasticsearch.common.io.stream.NamedWriteableRegistry;
+import org.elasticsearch.common.io.stream.StreamInput;
+import org.elasticsearch.common.io.stream.StreamOutput;
+import org.elasticsearch.common.settings.Settings;
+import org.elasticsearch.common.settings.SettingsModule;
+import org.elasticsearch.common.xcontent.XContentBuilder;
+import org.elasticsearch.plugins.PersistentTaskPlugin;
+import org.elasticsearch.plugins.Plugin;
+import org.elasticsearch.tasks.TaskId;
+import org.elasticsearch.tasks.TaskManager;
+import org.elasticsearch.test.ESIntegTestCase;
+import org.elasticsearch.threadpool.ThreadPool;
+
+import java.io.IOException;
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+
+import static org.hamcrest.Matchers.empty;
+
+public class PersistentTaskInitializationFailureIT extends ESIntegTestCase {
+    @Override
+    protected Collection<Class<? extends Plugin>> nodePlugins() {
+        return List.of(FailingInitializationPersistentTasksPlugin.class);
+    }
+
+    public void testPersistentTasksThatFailDuringInitializationAreRemovedFromClusterState() throws Exception {
+        PersistentTasksService persistentTasksService = internalCluster().getInstance(PersistentTasksService.class);
+        PlainActionFuture<PersistentTasksCustomMetadata.PersistentTask<FailingInitializationTaskParams>> startPersistentTaskFuture =
+            new PlainActionFuture<>();
+        persistentTasksService.sendStartRequest(UUIDs.base64UUID(),
+            FailingInitializationPersistentTaskExecutor.TASK_NAME,
+            new FailingInitializationTaskParams(),
+            startPersistentTaskFuture
+        );
+        startPersistentTaskFuture.actionGet();
+
+        assertBusy(() -> {
+            final ClusterService clusterService = internalCluster().getMasterNodeInstance(ClusterService.class);
+            final PersistentTasksCustomMetadata persistentTasks =
+                clusterService.state().metadata().custom(PersistentTasksCustomMetadata.TYPE);
+            assertThat(persistentTasks.tasks().toString(), persistentTasks.tasks(), empty());
+        });
+    }
+
+    public static class FailingInitializationPersistentTasksPlugin extends Plugin implements PersistentTaskPlugin {
+        public FailingInitializationPersistentTasksPlugin(Settings settings) {}
+
+        @Override
+        public List<PersistentTasksExecutor<?>> getPersistentTasksExecutor(ClusterService clusterService,
+                                                                           ThreadPool threadPool,
+                                                                           Client client,
+                                                                           SettingsModule settingsModule,
+                                                                           IndexNameExpressionResolver expressionResolver) {
+            return List.of(new FailingInitializationPersistentTaskExecutor());
+        }
+
+        @Override
+        public List<NamedWriteableRegistry.Entry> getNamedWriteables() {
+            return List.of(
+                new NamedWriteableRegistry.Entry(PersistentTaskParams.class,
+                    FailingInitializationPersistentTaskExecutor.TASK_NAME,
+                    FailingInitializationTaskParams::new
+                )
+            );
+        }
+    }
+
+    public static class FailingInitializationTaskParams implements PersistentTaskParams {
+        public FailingInitializationTaskParams() { }
+
+        public FailingInitializationTaskParams(StreamInput in) throws IOException { }
+
+        @Override
+        public String getWriteableName() {
+            return FailingInitializationPersistentTaskExecutor.TASK_NAME;
+        }
+
+        @Override
+        public Version getMinimalSupportedVersion() {
+            return Version.CURRENT;
+        }
+
+        @Override
+        public void writeTo(StreamOutput out) throws IOException { }
+
+        @Override
+        public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
+            builder.startObject();
+            builder.endObject();
+            return builder;
+        }
+    }
+
+    static class FailingInitializationPersistentTaskExecutor extends PersistentTasksExecutor<FailingInitializationTaskParams> {
+        static final String TASK_NAME = "cluster:admin/persistent/test_init_failure";
+        static final String EXECUTOR_NAME = "failing_executor";
+
+        FailingInitializationPersistentTaskExecutor() {
+            super(TASK_NAME, EXECUTOR_NAME);
+        }
+
+        @Override
+        protected AllocatedPersistentTask createTask(long id,
+                                                     String type,
+                                                     String action,
+                                                     TaskId parentTaskId,
+                                                     PersistentTasksCustomMetadata.PersistentTask<
+                                                         FailingInitializationTaskParams> taskInProgress,
+                                                     Map<String, String> headers) {
+            return new AllocatedPersistentTask(id, type, action, "", parentTaskId, headers) {
+                @Override
+                protected void init(PersistentTasksService persistentTasksService,
+                                    TaskManager taskManager,
+                                    String persistentTaskId,
+                                    long allocationId) {
+                    throw new RuntimeException("BOOM");
+                }
+            };
+        }
+
+        @Override
+        protected void nodeOperation(AllocatedPersistentTask task, FailingInitializationTaskParams params, PersistentTaskState state) {
+            assert false : "Unexpected call";
+        }
+    }
+}

server/src/main/java/org/elasticsearch/persistent/PersistentTasksNodeService.java

@@ -171,10 +171,11 @@ public Task createTask(long id, String type, String action, TaskId parentTaskId,
         }
 
         boolean processed = false;
+        Exception initializationException = null;
         try {
             task.init(persistentTasksService, taskManager, taskInProgress.getId(), taskInProgress.getAllocationId());
             logger.trace("Persistent task [{}] with id [{}] and allocation id [{}] was created", task.getAction(),
-                    task.getPersistentTaskId(), task.getAllocationId());
+                task.getPersistentTaskId(), task.getAllocationId());
             try {
                 runningTasks.put(taskInProgress.getAllocationId(), task);
                 nodePersistentTasksExecutor.executeTask(taskInProgress.getParams(), taskInProgress.getState(), task, executor);
@@ -183,12 +184,17 @@ public Task createTask(long id, String type, String action, TaskId parentTaskId,
                 task.markAsFailed(e);
             }
             processed = true;
+        } catch (Exception e) {
+            initializationException = e;
         } finally {
             if (processed == false) {
                 // something went wrong - unregistering task
                 logger.warn("Persistent task [{}] with id [{}] and allocation id [{}] failed to create", task.getAction(),
-                        task.getPersistentTaskId(), task.getAllocationId());
+                    task.getPersistentTaskId(), task.getAllocationId());
                 taskManager.unregister(task);
+                if (initializationException != null) {
+                    notifyMasterOfFailedTask(taskInProgress, initializationException);
+                }
             }
         }
     }