Tianqi-Dotes commented on code in PR #11865: URL: https://github.com/apache/dolphinscheduler/pull/11865#discussion_r973845352
########## dolphinscheduler-task-plugin/dolphinscheduler-task-datasync/src/main/java/org/apache/dolphinscheduler/plugin/task/datasync/DatasyncHook.java: ########## @@ -0,0 +1,256 @@ +/* + * 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.dolphinscheduler.plugin.task.datasync; + +import lombok.Data; +import org.apache.commons.beanutils.BeanUtils; +import org.apache.dolphinscheduler.plugin.task.api.TaskConstants; +import org.apache.dolphinscheduler.spi.utils.PropertyUtils; +import org.apache.dolphinscheduler.spi.utils.StringUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import software.amazon.awssdk.auth.credentials.AwsBasicCredentials; +import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider; +import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider; +import software.amazon.awssdk.regions.Region; +import software.amazon.awssdk.services.datasync.DataSyncClient; +import software.amazon.awssdk.services.datasync.model.CancelTaskExecutionRequest; +import software.amazon.awssdk.services.datasync.model.CancelTaskExecutionResponse; +import software.amazon.awssdk.services.datasync.model.CreateTaskRequest; +import software.amazon.awssdk.services.datasync.model.CreateTaskResponse; +import software.amazon.awssdk.services.datasync.model.DescribeTaskExecutionRequest; +import software.amazon.awssdk.services.datasync.model.DescribeTaskExecutionResponse; +import software.amazon.awssdk.services.datasync.model.DescribeTaskRequest; +import software.amazon.awssdk.services.datasync.model.DescribeTaskResponse; +import software.amazon.awssdk.services.datasync.model.FilterRule; +import software.amazon.awssdk.services.datasync.model.Options; +import software.amazon.awssdk.services.datasync.model.StartTaskExecutionRequest; +import software.amazon.awssdk.services.datasync.model.StartTaskExecutionResponse; +import software.amazon.awssdk.services.datasync.model.TagListEntry; +import software.amazon.awssdk.services.datasync.model.TaskExecutionStatus; +import software.amazon.awssdk.services.datasync.model.TaskSchedule; +import software.amazon.awssdk.services.datasync.model.TaskStatus; + +import java.lang.reflect.InvocationTargetException; +import java.util.Arrays; +import java.util.List; +import java.util.stream.Collectors; + +import static com.fasterxml.jackson.databind.DeserializationFeature.ACCEPT_EMPTY_ARRAY_AS_NULL_OBJECT; +import static com.fasterxml.jackson.databind.DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES; +import static com.fasterxml.jackson.databind.DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_AS_NULL; +import static com.fasterxml.jackson.databind.MapperFeature.REQUIRE_SETTERS_FOR_GETTERS; + +@Data +public class DatasyncHook { + + public static TaskExecutionStatus[] doneStatus = {TaskExecutionStatus.ERROR, TaskExecutionStatus.SUCCESS, TaskExecutionStatus.UNKNOWN_TO_SDK_VERSION}; + public static TaskStatus[] taskFinishFlags = {TaskStatus.UNAVAILABLE, TaskStatus.UNKNOWN_TO_SDK_VERSION}; + protected final Logger logger = LoggerFactory.getLogger(String.format(TaskConstants.TASK_LOG_LOGGER_NAME_FORMAT, getClass())); + private DataSyncClient client; + private String taskArn; + private String taskExecArn; + + public DatasyncHook() { + client = createClient(); + } + + protected static DataSyncClient createClient() { + final String awsAccessKeyId = PropertyUtils.getString(TaskConstants.AWS_ACCESS_KEY_ID); + final String awsSecretAccessKey = PropertyUtils.getString(TaskConstants.AWS_SECRET_ACCESS_KEY); + final String awsRegion = PropertyUtils.getString(TaskConstants.AWS_REGION); + + final AwsBasicCredentials basicAWSCredentials = AwsBasicCredentials.create(awsAccessKeyId, awsSecretAccessKey); + final AwsCredentialsProvider awsCredentialsProvider = StaticCredentialsProvider.create(basicAWSCredentials); + + // create a datasync client + return DataSyncClient.builder().region(Region.of(awsRegion)).credentialsProvider(awsCredentialsProvider).build(); + } + + public Boolean createDatasyncTask(DatasyncParameters parameters) { + logger.info("createDatasyncTask ......"); + CreateTaskRequest.Builder builder = CreateTaskRequest.builder() + .name(parameters.getName()) + .sourceLocationArn(parameters.getSourceLocationArn()) + .destinationLocationArn(parameters.getDestinationLocationArn()); + + String cloudWatchLogGroupArn = parameters.getCloudWatchLogGroupArn(); + if (StringUtils.isNotEmpty(cloudWatchLogGroupArn)) { + builder.cloudWatchLogGroupArn(cloudWatchLogGroupArn); + } + castParamPropertyPackage(parameters, builder); + + CreateTaskResponse task = client.createTask(builder.build()); + if (task.sdkHttpResponse().isSuccessful()) { + taskArn = task.taskArn(); + } + logger.info("finished createDatasyncTask ......"); + return doubleCheckTaskStatus(TaskStatus.AVAILABLE, taskFinishFlags); + } + + public Boolean startDatasyncTask() { + logger.info("startDatasyncTask ......"); + StartTaskExecutionRequest start = StartTaskExecutionRequest.builder().taskArn(taskArn).build(); + StartTaskExecutionResponse response = client.startTaskExecution(start); + if (response.sdkHttpResponse().isSuccessful()) { + taskExecArn = response.taskExecutionArn(); + } + return doubleCheckExecStatus(TaskExecutionStatus.LAUNCHING, doneStatus); + } + + + public Boolean cancelDatasyncTask() { + logger.info("cancelTask ......"); + CancelTaskExecutionRequest cancel = CancelTaskExecutionRequest.builder().taskExecutionArn(taskExecArn).build(); + CancelTaskExecutionResponse response = client.cancelTaskExecution(cancel); + if (response.sdkHttpResponse().isSuccessful()) { + return true; + } + return false; + } + + public TaskStatus queryDatasyncTaskStatus() { + logger.info("queryDatasyncTaskStatus ......"); + + DescribeTaskRequest request = DescribeTaskRequest.builder().taskArn(taskArn).build(); + DescribeTaskResponse describe = client.describeTask(request); + + if (describe.sdkHttpResponse().isSuccessful()) { + logger.info("queryDatasyncTaskStatus ......{}", describe.statusAsString()); + return describe.status(); + } + return null; + } + + public TaskExecutionStatus queryDatasyncTaskExecStatus() { + logger.info("queryDatasyncTaskExecStatus ......"); + DescribeTaskExecutionRequest request = DescribeTaskExecutionRequest.builder().taskExecutionArn(taskExecArn).build(); + DescribeTaskExecutionResponse describe = client.describeTaskExecution(request); + + if (describe.sdkHttpResponse().isSuccessful()) { + logger.info("queryDatasyncTaskExecStatus ......{}", describe.statusAsString()); + return describe.status(); + } + return null; + } + + public Boolean doubleCheckTaskStatus(TaskStatus exceptStatus, TaskStatus[] stopStatus) { + + List<TaskStatus> stopStatusSet = Arrays.asList(stopStatus); + int maxRetry = 5; + while (maxRetry > 0) { + TaskStatus status = queryDatasyncTaskStatus(); + + if (status == null) { + maxRetry--; + continue; + } + + if (exceptStatus.equals(status)) { + logger.info("double check success"); + return true; + } else if (stopStatusSet.contains(status)) { + break; + } + } + logger.warn("double check error"); + return false; + } + + public Boolean doubleCheckExecStatus(TaskExecutionStatus exceptStatus, TaskExecutionStatus[] stopStatus) { Review Comment: this method double check the object status by calling query status API. eg: when you call createTask method, you expect an `AVAILABLE` status, so you call this method to get the task status and compare the expectation -- 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]
