SOLR-18248 : Migration of Tasks V2 APIs to JAX-RS Constructs

changelog/unreleased/SOLR-18248-list-tasks.yml

@@ -0,0 +1,7 @@
+title: Migrated ListTasks API & TaskStatus API from homegrown @EndPoint to JAX-RS
+type: added
+authors:
+  - name: Jalaz Kumar
+links:
+  - name: SOLR-18248
+    url: https://issues.apache.org/jira/browse/SOLR-18248

solr/api/src/java/org/apache/solr/client/api/endpoint/ListActiveTasksApi.java

@@ -0,0 +1,32 @@
+package org.apache.solr.client.api.endpoint;
+
+import static org.apache.solr.client.api.util.Constants.INDEX_PATH_PREFIX;
+
+import io.swagger.v3.oas.annotations.Operation;
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import org.apache.solr.client.api.model.ListActiveTaskResponse;
+import org.apache.solr.client.api.model.TaskStatusResponse;
+import org.apache.solr.client.api.util.StoreApiParameters;
+
+@Path(INDEX_PATH_PREFIX + "/tasks/list")
+public interface ListActiveTasksApi {
+
+  // Handles: .../tasks/list (Lists all)
+  @GET
+  @StoreApiParameters
+  @Operation(
+      summary = "Lists all the currently running tasks",
+      tags = {"tasks"})
+  ListActiveTaskResponse listAllActiveTasks() throws Exception;
+
+  // Handles: .../tasks/list/slow-task-id (Lists specific)
+  @GET
+  @Path("/{taskUUID}")
+  @StoreApiParameters
+  @Operation(
+      summary = "Status of a specific taskUUID passed as pathParam",
+      tags = {"tasks"})
+  TaskStatusResponse getTaskStatus(@PathParam("taskUUID") String taskUUID) throws Exception;
+}

solr/api/src/java/org/apache/solr/client/api/model/ActiveTaskDetails.java

@@ -0,0 +1,16 @@
+package org.apache.solr.client.api.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class ActiveTaskDetails {
+
+  public ActiveTaskDetails() {}
+
+  public ActiveTaskDetails(String taskUUID, String taskQuery) {
+    this.taskUUID = taskUUID;
+    this.taskQuery = taskQuery;
+  }
+
+  @JsonProperty public String taskUUID;
+  @JsonProperty public String taskQuery;
+}

solr/api/src/java/org/apache/solr/client/api/model/ListActiveTaskResponse.java

@@ -0,0 +1,8 @@
+package org.apache.solr.client.api.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.List;
+
+public class ListActiveTaskResponse extends SolrJerseyResponse {
+  @JsonProperty public List<ActiveTaskDetails> taskList;
+}

solr/api/src/java/org/apache/solr/client/api/model/TaskStatusResponse.java

@@ -0,0 +1,7 @@
+package org.apache.solr.client.api.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class TaskStatusResponse extends SolrJerseyResponse {
+  @JsonProperty public boolean taskStatus;
+}

solr/core/src/java/org/apache/solr/handler/admin/api/ListActiveTasks.java

@@ -0,0 +1,60 @@
+package org.apache.solr.handler.admin.api;
+
+import static org.apache.solr.security.PermissionNameProvider.Name.READ_PERM;
+
+import jakarta.inject.Inject;
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import org.apache.solr.api.JerseyResource;
+import org.apache.solr.client.api.endpoint.ListActiveTasksApi;
+import org.apache.solr.client.api.model.ActiveTaskDetails;
+import org.apache.solr.client.api.model.ListActiveTaskResponse;
+import org.apache.solr.client.api.model.TaskStatusResponse;
+import org.apache.solr.jersey.PermissionName;
+import org.apache.solr.request.SolrQueryRequest;
+
+public class ListActiveTasks extends JerseyResource implements ListActiveTasksApi {
+
+  private final SolrQueryRequest solrQueryRequest;
+
+  @Inject
+  public ListActiveTasks(SolrQueryRequest solrQueryRequest) {
+    this.solrQueryRequest = solrQueryRequest;
+  }
+
+  @Override
+  @PermissionName(READ_PERM)
+  public ListActiveTaskResponse listAllActiveTasks() throws Exception {
+    final ListActiveTaskResponse response = instantiateJerseyResponse(ListActiveTaskResponse.class);
+
+    response.taskList = extractActiveTaskLists();
+
+    return response;
+  }
+
+  @Override
+  @PermissionName(READ_PERM)
+  public TaskStatusResponse getTaskStatus(String taskUUID) throws Exception {
+    final TaskStatusResponse response = instantiateJerseyResponse(TaskStatusResponse.class);
+
+    response.taskStatus =
+        solrQueryRequest.getCore().getCancellableQueryTracker().isQueryIdActive(taskUUID);
+
+    return response;
+  }
+
+  private List<ActiveTaskDetails> extractActiveTaskLists() {
+    Iterator<Map.Entry<String, String>> iterator =
+        solrQueryRequest.getCore().getCancellableQueryTracker().getActiveQueriesGenerated();
+
+    List<ActiveTaskDetails> activeTaskDetails = new ArrayList<>();
+    while (iterator.hasNext()) {
+      Map.Entry<String, String> entry = iterator.next();
+      activeTaskDetails.add(new ActiveTaskDetails(entry.getKey(), entry.getValue()));
+    }
+
+    return activeTaskDetails;
+  }
+}

solr/core/src/java/org/apache/solr/handler/component/ActiveTasksListHandler.java

@@ -22,46 +22,50 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import org.apache.solr.api.AnnotatedApi;
 import org.apache.solr.api.Api;
-import org.apache.solr.handler.admin.api.ListActiveTasksAPI;
+import org.apache.solr.api.JerseyResource;
+import org.apache.solr.client.api.model.ActiveTaskDetails;
+import org.apache.solr.handler.admin.api.ListActiveTasks;
+import org.apache.solr.handler.api.V2ApiUtils;
 import org.apache.solr.request.SolrQueryRequest;
 import org.apache.solr.request.SolrRequestHandler;
 import org.apache.solr.response.SolrQueryResponse;
 import org.apache.solr.security.AuthorizationContext;
 import org.apache.solr.security.PermissionNameProvider;
 
-/** Handles request for listing all active cancellable tasks */
+/**
+ * Handles request for listing all active cancellable tasks All active tasks logic lives in the v2
+ * {@link ListActiveTasks}; this handler is a thin v1 bridge that extracts request parameters and
+ * delegates.
+ */
 public class ActiveTasksListHandler extends TaskManagementHandler {
   // This can be a parent level member but we keep it here to allow future handlers to have
   // a custom list of components
-  private List<SearchComponent> components;
 
   @Override
   public void handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp) throws Exception {
-    Map<String, String> extraParams = null;
-    ResponseBuilder rb = buildResponseBuilder(req, rsp, getComponentsList());
-
-    rb.setIsTaskListRequest(true);
-
     String taskStatusCheckUUID = req.getParams().get(TASK_CHECK_UUID, null);
 
     if (taskStatusCheckUUID != null) {
-      if (rb.isDistrib) {
-        extraParams = new HashMap<>();
-
-        extraParams.put(TASK_CHECK_UUID, taskStatusCheckUUID);
+      V2ApiUtils.squashIntoSolrResponseWithoutHeader(
+          rsp, new ListActiveTasks(req).getTaskStatus(taskStatusCheckUUID));
+    } else {
+      Map<String, String> mapTasks = new HashMap<>();
+      List<ActiveTaskDetails> taskList = new ListActiveTasks(req).listAllActiveTasks().taskList;
+      if (taskList != null) {
+        for (ActiveTaskDetails task : taskList) {
+          mapTasks.put(task.taskUUID, task.taskQuery);
+        }
       }
-
-      rb.setTaskStatusCheckUUID(taskStatusCheckUUID);
+      rsp.add("taskList", mapTasks);
     }
-
-    processRequest(req, rb, extraParams);
   }
 
+  // ////////////////////// SolrInfoMBeans methods //////////////////////
+
   @Override
   public String getDescription() {
-    return "activetaskslist";
+    return "Active Tasks List";
   }
 
   @Override
@@ -79,7 +83,6 @@ public SolrRequestHandler getSubHandler(String path) {
     if (path.startsWith("/tasks/list")) {
       return this;
     }
-
     return null;
   }
 
@@ -90,14 +93,11 @@ public Boolean registerV2() {
 
   @Override
   public Collection<Api> getApis() {
-    return AnnotatedApi.getApis(new ListActiveTasksAPI(this));
+    return List.of();
   }
 
-  private List<SearchComponent> getComponentsList() {
-    if (components == null) {
-      components = buildComponentsList();
-    }
-
-    return components;
+  @Override
+  public Collection<Class<? extends JerseyResource>> getJerseyResources() {
+    return List.of(ListActiveTasks.class);
   }
 }

solr/core/src/java/org/apache/solr/handler/component/TaskManagementHandler.java

@@ -115,9 +115,6 @@ public static List<SearchComponent> buildComponentsList() {
     QueryCancellationComponent component = new QueryCancellationComponent();
     components.add(component);
 
-    ActiveTasksListComponent activeTasksListComponent = new ActiveTasksListComponent();
-    components.add(activeTasksListComponent);
-
     return components;
   }