[Offline Nodes] Adds new library for offline tasks

CHANGELOG.md

@@ -8,6 +8,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Add latency metrics for instrumenting critical clusterManager code paths ([#12333](https://github.com/opensearch-project/OpenSearch/pull/12333))
 - Add support for Azure Managed Identity in repository-azure ([#12423](https://github.com/opensearch-project/OpenSearch/issues/12423))
 - Add useCompoundFile index setting ([#13478](https://github.com/opensearch-project/OpenSearch/pull/13478))
+- [Offline Nodes] Adds offline-tasks library containing various interfaces to be used for Offline Background Tasks. ([#13574](https://github.com/opensearch-project/OpenSearch/pull/13574))
 - Make outbound side of transport protocol dependent ([#13293](https://github.com/opensearch-project/OpenSearch/pull/13293))
 
 ### Dependencies

libs/offline-tasks/build.gradle

@@ -0,0 +1,25 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+dependencies {
+  api project(':libs:opensearch-common')
+
+  testImplementation "com.carrotsearch.randomizedtesting:randomizedtesting-runner:${versions.randomizedrunner}"
+  testImplementation "junit:junit:${versions.junit}"
+  testImplementation "org.hamcrest:hamcrest:${versions.hamcrest}"
+  testImplementation(project(":test:framework")) {
+    exclude group: 'org.opensearch', module: 'opensearch-offline-tasks'
+  }
+}
+
+tasks.named('forbiddenApisMain').configure {
+  replaceSignatureFiles 'jdk-signatures'
+}

libs/offline-tasks/src/main/java/org/opensearch/offline_tasks/client/TaskClient.java

@@ -0,0 +1,86 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.offline_tasks.client;
+
+import org.opensearch.common.annotation.ExperimentalApi;
+import org.opensearch.offline_tasks.task.Task;
+import org.opensearch.offline_tasks.task.TaskId;
+import org.opensearch.offline_tasks.task.TaskStatus;
+
+import java.util.List;
+
+/**
+ * Client used to interact with Task Store/Queue
+ *
+ * @opensearch.experimental
+ */
+@ExperimentalApi
+public interface TaskClient {
+
+    /**
+     * Submit a new task to TaskStore/Queue
+     *
+     * @param task Task to be submitted for execution on offline nodes
+     */
+    void submitTask(Task task);
+
+    /**
+     * Claim task from TaskStore/Queue. This ensures no 2 Offline Nodes work on the same task.
+     *
+     * @param taskId TaskId of the task to be claimed
+     * @return true if task is claimed successfully, false otherwise
+     */
+    boolean claimTask(TaskId taskId);
+
+    /**
+     * Get task from TaskStore/Queue
+     *
+     * @param taskId TaskId of the task to be retrieved
+     * @return Task corresponding to TaskId
+     */
+    Task getTask(TaskId taskId);
+
+    /**
+     * Update task in TaskStore/Queue
+     *
+     * @param task Task to be updated
+     */
+    void updateTask(Task task);
+
+    /**
+     * Mark task as cancelled.
+     * Ongoing Tasks can be cancelled as well if the corresponding worker supports cancellation
+     *
+     * @param taskId TaskId of the task to be cancelled
+     */
+    void cancelTask(TaskId taskId);
+
+    /**
+     * List all tasks with a particular {@param taskStatus} considering {@param listTaskStatus}
+     * @param taskStatus status of the tasks to be listed
+     * @param taskListQueryParams params to filter the tasks to be listed
+     * @return list of all the task matching the taskStatus
+     */
+    List<Task> getTasks(TaskStatus taskStatus, TaskListQueryParams taskListQueryParams);
+
+    /**
+     * List all tasks considering {@param listTaskStatus}
+     * @param taskListQueryParams params to filter the tasks to be listed
+     * @return list of all the task matching the taskStatus
+     */
+    List<Task> getTasks(TaskListQueryParams taskListQueryParams);
+
+    /**
+     * Sends task heart beat to Task Store/Queue
+     *
+     * @param taskId TaskId of Task to send heartbeat for
+     * @param timestamp timestamp of heartbeat to be recorded in TaskStore/Queue
+     */
+    void sendTaskHeartbeat(TaskId taskId, long timestamp);
+}

libs/offline-tasks/src/main/java/org/opensearch/offline_tasks/client/TaskListQueryParams.java

@@ -0,0 +1,94 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.offline_tasks.client;
+
+import org.opensearch.common.annotation.ExperimentalApi;
+import org.opensearch.offline_tasks.task.TaskStatus;
+
+/**
+ * Holder interface for various params different implementations might add for list calls
+ * A typical example would be pagination related params
+ *
+ * Since Each implementation of this abstraction can host multiple different params,
+ * it is recommended to use Builder Pattern for construction of the objects
+ */
+@ExperimentalApi
+public abstract class TaskListQueryParams {
+
+    /**
+     * Depicts the start page number for the list call.
+     *
+     * @see TaskClient#getTasks(TaskStatus, TaskListQueryParams)
+     */
+    private final int startPageNumber;
+
+    /**
+     * Depicts the page size for the list call.
+     *
+     * @see TaskClient#getTasks(TaskStatus, TaskListQueryParams)
+     */
+    private final int pageSize;
+
+    /**
+     * Constructor for ListTaskParams
+     * @param startPageNumber start page number for the list call
+     * @param pageSize page size for the list call
+     */
+    private TaskListQueryParams(int startPageNumber, int pageSize) {
+        this.startPageNumber = startPageNumber;
+        this.pageSize = pageSize;
+    }
+
+    /**
+     * Get pageSize
+     * @return pageSize for the list call
+     */
+    public int getPageSize() {
+        return pageSize;
+    }
+
+    /**
+     * Get startPageNumber
+     * @return startPageNumber for the list call
+     */
+    public int getStartPageNumber() {
+        return startPageNumber;
+    }
+
+    /**
+     * Builder class for ListTaskParams. Since this class can grow and host multiple params
+     */
+    public abstract static class Builder {
+        /**
+         * Depicts the start page number for the list call.
+         *
+         * @see TaskClient#getTasks(TaskStatus, TaskListQueryParams)
+         */
+        private int startPageNumber = 1;
+
+        /**
+         * Depicts the page size for the list call.
+         *
+         * @see TaskClient#getTasks(TaskStatus, TaskListQueryParams)
+         */
+        private int pageSize = 50;
+
+        public abstract TaskListQueryParams build();
+
+        public Builder setStartPageNumber(int startPageNumber) {
+            this.startPageNumber = startPageNumber;
+            return this;
+        }
+
+        public Builder setPageSize(int pageSize){
+            this.pageSize = pageSize;
+            return this;
+        }
+    }
+}

libs/offline-tasks/src/main/java/org/opensearch/offline_tasks/client/package-info.java

@@ -0,0 +1,12 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/**
+ * Contains task client related classes
+ */
+package org.opensearch.offline_tasks.client;

libs/offline-tasks/src/main/java/org/opensearch/offline_tasks/package-info.java

@@ -0,0 +1,12 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/**
+ * Contains offline tasks related classes
+ */
+package org.opensearch.offline_tasks;

libs/offline-tasks/src/main/java/org/opensearch/offline_tasks/task/Task.java

@@ -0,0 +1,85 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.offline_tasks.task;
+
+import org.opensearch.common.annotation.ExperimentalApi;
+
+/**
+ * A Background Task to be run on Offline Node.
+ */
+@ExperimentalApi
+public class Task {
+
+    /**
+     * Task identifier used to uniquely identify a Task
+     */
+    private final TaskId taskId;
+
+    /**
+     * Depicts latest state of the Task
+     */
+    private final TaskStatus taskStatus;
+
+    /**
+     * Various params to used for Task execution
+     */
+    private final TaskParams params;
+
+    /**
+     * Type/Category of the Task
+     */
+    private final TaskType taskType;
+
+    /**
+     * Constructor for Task
+     *
+     * @param taskId Task identifier
+     * @param taskStatus Task status
+     * @param params Task Params
+     * @param taskType Task Type
+     */
+    public Task(TaskId taskId, TaskStatus taskStatus, TaskParams params, TaskType taskType) {
+        this.taskId = taskId;
+        this.taskStatus = taskStatus;
+        this.params = params;
+        this.taskType = taskType;
+    }
+
+    /**
+     * Get TaskId
+     * @return TaskId
+     */
+    public TaskId getTaskId() {
+        return taskId;
+    }
+
+    /**
+     * Get TaskStatus
+     * @return TaskStatus
+     */
+    public TaskStatus getTaskStatus() {
+        return taskStatus;
+    }
+
+    /**
+     * Get TaskParams
+     * @return TaskParams
+     */
+    public TaskParams getParams() {
+        return params;
+    }
+
+    /**
+     * Get TaskType
+     * @return TaskType
+     */
+    public TaskType getTaskType() {
+        return taskType;
+    }
+}

libs/offline-tasks/src/main/java/org/opensearch/offline_tasks/task/TaskId.java

@@ -0,0 +1,39 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.offline_tasks.task;
+
+import org.opensearch.common.annotation.ExperimentalApi;
+
+/**
+ * Class encapsulating Task identifier
+ */
+@ExperimentalApi
+public class TaskId {
+
+    /**
+     * Identified of the Task
+     */
+    private final String id;
+
+    /**
+     * Constructor to initialize TaskId
+     * @param id String value of Task id
+     */
+    public TaskId(String id) {
+        this.id = id;
+    }
+
+    /**
+     * Get id value
+     * @return id
+     */
+    public String getValue() {
+        return id;
+    }
+}

libs/offline-tasks/src/main/java/org/opensearch/offline_tasks/task/TaskParams.java

@@ -0,0 +1,23 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.offline_tasks.task;
+
+import org.opensearch.common.annotation.ExperimentalApi;
+
+/**
+ * Base class for all TaskParams implementation of various TaskTypes
+ */
+@ExperimentalApi
+public abstract class TaskParams {
+
+    /**
+     * Default constructor
+     */
+    public TaskParams() {}
+}