yifan-c commented on code in PR #139: URL: https://github.com/apache/cassandra-sidecar/pull/139#discussion_r1882773509
########## server/src/main/java/org/apache/cassandra/sidecar/routes/OperationalJobHandler.java: ########## @@ -0,0 +1,120 @@ +/* + * 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.cassandra.sidecar.routes; + +import java.util.UUID; +import javax.inject.Inject; + +import io.netty.handler.codec.http.HttpResponseStatus; +import io.vertx.core.http.HttpServerRequest; +import io.vertx.core.net.SocketAddress; +import io.vertx.ext.web.RoutingContext; +import org.apache.cassandra.sidecar.common.data.OperationalJobStatus; +import org.apache.cassandra.sidecar.common.response.OperationalJobResponse; +import org.apache.cassandra.sidecar.concurrent.ExecutorPools; +import org.apache.cassandra.sidecar.job.OperationalJob; +import org.apache.cassandra.sidecar.job.OperationalJobManager; +import org.apache.cassandra.sidecar.utils.CassandraInputValidator; +import org.apache.cassandra.sidecar.utils.InstanceMetadataFetcher; + +import static org.apache.cassandra.sidecar.common.ApiEndpointsV1.OPERATIONAL_JOB_ID_PATH_PARAM; +import static org.apache.cassandra.sidecar.common.data.OperationalJobStatus.FAILED; +import static org.apache.cassandra.sidecar.utils.HttpExceptions.wrapHttpException; + +/** + * Handler for retrieving the status of async operational jobs running on the sidecar + */ +public class OperationalJobHandler extends AbstractHandler<Void> +{ + private final OperationalJobManager jobManager; + + @Inject + public OperationalJobHandler(InstanceMetadataFetcher metadataFetcher, + ExecutorPools executorPools, + CassandraInputValidator validator, + OperationalJobManager jobManager) + { + super(metadataFetcher, executorPools, validator); + this.jobManager = jobManager; + } + + @Override + protected Void extractParamsOrThrow(RoutingContext context) + { + return null; + } + + @Override + public void handleInternal(RoutingContext context, HttpServerRequest httpRequest, String host, SocketAddress remoteAddress, Void request) + { + UUID jobId = validateJobIdParam(context); + executorPools.service() + .executeBlocking(() -> { + OperationalJob job = jobManager.getJobIfExists(jobId); + if (job == null) + { + logger.info("No operational job found with the jobId. jobId={}", jobId); + throw wrapHttpException(HttpResponseStatus.NOT_FOUND, + String.format("Unknown job with ID: %s. Please retry the operation.", jobId)); + } + return job; + }) + .onFailure(cause -> processFailure(cause, context, host, remoteAddress, request)) + .onSuccess(job -> sendStatusBasedResponse(context, jobId, job)); + } + + private UUID validateJobIdParam(RoutingContext context) + { + String requestJobId = context.pathParam(OPERATIONAL_JOB_ID_PATH_PARAM.substring(1)); + if (requestJobId == null) + { + throw wrapHttpException(HttpResponseStatus.BAD_REQUEST, + OPERATIONAL_JOB_ID_PATH_PARAM + " is required but not supplied"); + } + + UUID jobId; + try + { + jobId = UUID.fromString(requestJobId); + } + catch (IllegalArgumentException e) + { + logger.info("Invalid jobId. jobId={}", requestJobId); + throw wrapHttpException(HttpResponseStatus.BAD_REQUEST, String.format("Invalid job ID provided :%s.", requestJobId)); + } + return jobId; + } + + public void sendStatusBasedResponse(RoutingContext context, UUID jobId, OperationalJob job) + { + OperationalJobStatus status = job.status(); + String reason = null; + switch(status) + { + case SUCCEEDED: + context.response().setStatusCode(HttpResponseStatus.OK.code()); break; + case CREATED: + case RUNNING: + context.response().setStatusCode(HttpResponseStatus.ACCEPTED.code()); break; + case FAILED: + reason = job.asyncResult().cause().getMessage(); Review Comment: yep. 200 to indicate the request is successful. The status of the job is expressed in the response body. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
