SOLR-18248: Migration of CancelTask V2 API to JAX-RS construct

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

@@ -0,0 +1,9 @@
+title:
+  Migration of CancelTask V2 API to JAX-RS construct
+type: changed
+authors:
+  - name: Jalaz Kumar
+  - name: Eric Pugh
+links:
+  - name: SOLR-18248
+    url: https://issues.apache.org/jira/browse/SOLR-18248

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

@@ -20,9 +20,11 @@
 import static org.apache.solr.client.api.util.Constants.INDEX_PATH_PREFIX;
 
 import io.swagger.v3.oas.annotations.Operation;
+import jakarta.ws.rs.DELETE;
 import jakarta.ws.rs.GET;
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.PathParam;
+import org.apache.solr.client.api.model.CancelTaskResponse;
 import org.apache.solr.client.api.model.ListActiveTaskResponse;
 import org.apache.solr.client.api.model.TaskStatusResponse;
 import org.apache.solr.client.api.util.StoreApiParameters;
@@ -48,4 +50,14 @@ interface Status {
         tags = {"tasks"})
     TaskStatusResponse getTaskStatus(@PathParam("taskID") String taskID) throws Exception;
   }
+
+  @Path(INDEX_PATH_PREFIX + "/tasks/{taskID}")
+  interface Cancel {
+    @DELETE
+    @StoreApiParameters
+    @Operation(
+        summary = "Cancel any specific task",
+        tags = {"tasks"})
+    CancelTaskResponse cancelRunningTask(@PathParam("taskID") String taskID) throws Exception;
+  }
 }

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

@@ -0,0 +1,31 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.solr.client.api.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/** Response body returned after a task cancellation request. */
+public class CancelTaskResponse extends SolrJerseyResponse {
+
+  public enum CancellationStatus {
+    SUCCESS,
+    NOT_FOUND
+  }
+
+  @JsonProperty public CancelTaskResponse.CancellationStatus status;
+}

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

@@ -0,0 +1,68 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.solr.handler.admin.api;
+
+import static org.apache.solr.security.PermissionNameProvider.Name.READ_PERM;
+
+import jakarta.inject.Inject;
+import org.apache.solr.api.JerseyResource;
+import org.apache.solr.client.api.endpoint.TasksApi;
+import org.apache.solr.client.api.model.CancelTaskResponse;
+import org.apache.solr.common.SolrException;
+import org.apache.solr.handler.component.ActiveTaskQuerySupport;
+import org.apache.solr.jersey.PermissionName;
+import org.apache.solr.request.SolrQueryRequest;
+import org.apache.solr.search.CancellableCollector;
+
+/** V2 API implementation for cancelling an active task. */
+public class CancelTask extends JerseyResource implements TasksApi.Cancel {
+
+  private final SolrQueryRequest solrQueryRequest;
+
+  @Inject
+  public CancelTask(SolrQueryRequest solrQueryRequest) {
+    this.solrQueryRequest = solrQueryRequest;
+  }
+
+  @Override
+  @PermissionName(READ_PERM)
+  public CancelTaskResponse cancelRunningTask(String taskID) throws Exception {
+    final CancelTaskResponse response = instantiateJerseyResponse(CancelTaskResponse.class);
+
+    boolean isTaskCancelled = ActiveTaskQuerySupport.cancelTask(solrQueryRequest, taskID);
+
+    if (isTaskCancelled) {
+      response.status = CancelTaskResponse.CancellationStatus.SUCCESS;
+      return response;
+    }
+    response.status = CancelTaskResponse.CancellationStatus.NOT_FOUND;
+    throw new SolrException(
+        SolrException.ErrorCode.NOT_FOUND, "Task with ID '" + taskID + "' not found");
+  }
+
+  public static boolean cancelTaskActiveOnThisShard(
+      SolrQueryRequest solrQueryRequest, String taskId) {
+    CancellableCollector cancellableTask =
+        solrQueryRequest.getCore().getCancellableQueryTracker().getCancellableTask(taskId);
+    if (cancellableTask != null) {
+      cancellableTask.cancel();
+      return true;
+    }
+    return false;
+  }
+}

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

@@ -18,6 +18,7 @@
 
 import static org.apache.solr.common.params.CommonParams.DISTRIB;
 import static org.apache.solr.common.params.CommonParams.QT;
+import static org.apache.solr.common.params.CommonParams.QUERY_UUID;
 import static org.apache.solr.common.params.CommonParams.TASK_CHECK_UUID;
 
 import java.util.ArrayList;
@@ -29,39 +30,51 @@
 import org.apache.solr.common.params.ModifiableSolrParams;
 import org.apache.solr.common.util.NamedList;
 import org.apache.solr.core.CoreContainer;
+import org.apache.solr.handler.admin.api.CancelTask;
 import org.apache.solr.handler.admin.api.ListActiveTasks;
 import org.apache.solr.request.SolrQueryRequest;
 import org.apache.solr.response.SolrQueryResponse;
 
 public class ActiveTaskQuerySupport {
   private static final String ACTIVE_TASK_LIST_HANDLER_PATH = "/tasks/list";
+  private static final String CANCEL_TASK_HANDLER_PATH = "/tasks/cancel";
 
   private ActiveTaskQuerySupport() {}
 
   public static List<ActiveTaskDetails> listActiveTasks(SolrQueryRequest req) throws Exception {
-    return execute(req, null).taskList;
+    return execute(req, null, false).taskList;
   }
 
   public static boolean isTaskActive(SolrQueryRequest req, String taskId) throws Exception {
-    return execute(req, taskId).taskActive;
+    return execute(req, taskId, false).taskActive;
   }
 
-  private static TaskQueryResult execute(SolrQueryRequest req, String taskId) throws Exception {
+  public static boolean cancelTask(SolrQueryRequest req, String taskId) throws Exception {
+    return execute(req, taskId, true).taskCancelled;
+  }
+
+  private static TaskQueryResult execute(
+      SolrQueryRequest req, String taskId, boolean isCancellationRequest) throws Exception {
     if (!shouldDistributed(req)) {
-      return localResult(req, taskId);
+      return localResult(req, taskId, isCancellationRequest);
     }
-    return distributedResult(req, taskId);
+    return distributedResult(req, taskId, isCancellationRequest);
   }
 
-  private static TaskQueryResult localResult(SolrQueryRequest req, String taskId) {
+  private static TaskQueryResult localResult(
+      SolrQueryRequest req, String taskId, boolean isCancellationRequest) {
     if (taskId != null) {
-      return new TaskQueryResult(List.of(), ListActiveTasks.isTaskActiveOnThisShard(req, taskId));
+      return (isCancellationRequest)
+          ? new TaskQueryResult(
+              List.of(), false, CancelTask.cancelTaskActiveOnThisShard(req, taskId))
+          : new TaskQueryResult(
+              List.of(), ListActiveTasks.isTaskActiveOnThisShard(req, taskId), false);
     }
-    return new TaskQueryResult(ListActiveTasks.getActiveTasksOnThisShard(req), false);
+    return new TaskQueryResult(ListActiveTasks.getActiveTasksOnThisShard(req), false, false);
   }
 
-  private static TaskQueryResult distributedResult(SolrQueryRequest req, String taskId)
-      throws Exception {
+  private static TaskQueryResult distributedResult(
+      SolrQueryRequest req, String taskId, boolean isCancellationRequest) {
     final ShardHandler shardHandler =
         req.getCoreContainer().getShardHandlerFactory().getShardHandler();
     final ResponseBuilder responseBuilder =
@@ -71,7 +84,7 @@ private static TaskQueryResult distributedResult(SolrQueryRequest req, String ta
     if (!responseBuilder.isDistrib
         || responseBuilder.shards == null
         || responseBuilder.shards.length == 0) {
-      return localResult(req, taskId);
+      return localResult(req, taskId, isCancellationRequest);
     }
 
     final ShardRequest shardRequest = new ShardRequest();
@@ -81,9 +94,17 @@ private static TaskQueryResult distributedResult(SolrQueryRequest req, String ta
 
     for (String shard : shardRequest.actualShards) {
       ModifiableSolrParams params = new ModifiableSolrParams();
-      params.set(QT, ACTIVE_TASK_LIST_HANDLER_PATH);
+      if (isCancellationRequest) {
+        params.set(QT, CANCEL_TASK_HANDLER_PATH);
+      } else {
+        params.set(QT, ACTIVE_TASK_LIST_HANDLER_PATH);
+      }
       if (taskId != null) {
-        params.set(TASK_CHECK_UUID, taskId);
+        if (isCancellationRequest) {
+          params.set(QUERY_UUID, taskId);
+        } else {
+          params.set(TASK_CHECK_UUID, taskId);
+        }
       }
       ShardHandler.setShardAttributesToParams(params, shardRequest.purpose);
       shardHandler.submit(shardRequest, shard, params);
@@ -101,9 +122,11 @@ private static TaskQueryResult distributedResult(SolrQueryRequest req, String ta
     }
 
     if (taskId != null) {
-      return new TaskQueryResult(List.of(), mergeTaskStatus(shardRequest.responses));
+      return (isCancellationRequest)
+          ? new TaskQueryResult(List.of(), false, mergeCancellationStatus(shardRequest.responses))
+          : new TaskQueryResult(List.of(), mergeTaskStatus(shardRequest.responses), false);
     }
-    return new TaskQueryResult(mergeTaskList(shardRequest.responses), false);
+    return new TaskQueryResult(mergeTaskList(shardRequest.responses), false, false);
   }
 
   private static boolean shouldDistributed(SolrQueryRequest req) {
@@ -128,6 +151,25 @@ private static boolean mergeTaskStatus(List<ShardResponse> responses) {
     return false;
   }
 
+  // FRAGILE: matches TaskCancellationHandler's human-readable "status" message by substring, for
+  // both V1 and V2 (CancelTask calls this same method). Kept as-is since changing the V1 wire
+  // format is out of scope; see the matching FRAGILE note in
+  // TaskCancellationHandler.handleRequestBody().
+  private static boolean mergeCancellationStatus(List<ShardResponse> responses) {
+    for (ShardResponse shardResponse : responses) {
+      Object cancellationStatus = shardResponse.getSolrResponse().getResponse().get("status");
+      if (cancellationStatus instanceof Boolean && (Boolean) cancellationStatus) {
+        return true;
+      }
+
+      if (cancellationStatus instanceof String
+          && ((String) cancellationStatus).contains("cancelled successfully")) {
+        return true;
+      }
+    }
+    return false;
+  }
+
   @SuppressWarnings("unchecked")
   private static List<ActiveTaskDetails> mergeTaskList(List<ShardResponse> responses) {
     Map<String, String> mergedTasks = new LinkedHashMap<>();
@@ -156,10 +198,13 @@ private static List<ActiveTaskDetails> mergeTaskList(List<ShardResponse> respons
   private static final class TaskQueryResult {
     private final List<ActiveTaskDetails> taskList;
     private final boolean taskActive;
+    private final boolean taskCancelled;
 
-    private TaskQueryResult(List<ActiveTaskDetails> taskList, boolean taskActive) {
+    private TaskQueryResult(
+        List<ActiveTaskDetails> taskList, boolean taskActive, boolean taskCancelled) {
       this.taskList = taskList;
       this.taskActive = taskActive;
+      this.taskCancelled = taskCancelled;
     }
   }
 }