caishunfeng commented on code in PR #16327: URL: https://github.com/apache/dolphinscheduler/pull/16327#discussion_r1728735590
########## dolphinscheduler-master/src/main/java/org/apache/dolphinscheduler/server/master/engine/WorkflowEventBusFireWorker.java: ########## @@ -0,0 +1,140 @@ +/* + * 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.server.master.engine; + +import static com.google.common.base.Preconditions.checkArgument; +import static com.google.common.base.Preconditions.checkState; + +import org.apache.dolphinscheduler.dao.entity.ProcessInstance; +import org.apache.dolphinscheduler.plugin.task.api.utils.LogUtils; +import org.apache.dolphinscheduler.server.master.engine.exceptions.WorkflowEventFireException; +import org.apache.dolphinscheduler.server.master.engine.workflow.runnable.IWorkflowExecutionRunnable; +import org.apache.dolphinscheduler.server.master.runner.IWorkflowExecuteContext; +import org.apache.dolphinscheduler.server.master.utils.ExceptionUtils; + +import org.apache.commons.collections4.CollectionUtils; +import org.apache.commons.collections4.MapUtils; + +import java.util.Collections; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.concurrent.ConcurrentHashMap; +import java.util.stream.Collectors; + +import lombok.extern.slf4j.Slf4j; + +@Slf4j +@SuppressWarnings({"rawtypes", "unchecked"}) +public class WorkflowEventBusFireWorker { + + private final Map<Integer, IWorkflowExecutionRunnable> registeredWorkflowExecuteRunnableMap = + new ConcurrentHashMap<>(); + + private final Map<ILifecycleEventType, ILifecycleEventHandler> eventHandlerMap = new ConcurrentHashMap<>(); + + public void registerEventHandler(ILifecycleEventHandler eventHandler) { + checkArgument(eventHandler != null, "event handler cannot be null"); + checkArgument(eventHandler.matchEventType() != null, "event type cannot be null"); + eventHandlerMap.put(eventHandler.matchEventType(), eventHandler); + } + + public void registerWorkflowEventBus(IWorkflowExecutionRunnable workflowExecutionRunnable) { + final IWorkflowExecuteContext workflowExecuteContext = workflowExecutionRunnable.getWorkflowExecuteContext(); + final ProcessInstance workflowInstance = workflowExecuteContext.getWorkflowInstance(); + final Integer workflowInstanceId = workflowInstance.getId(); + final String workflowInstanceName = workflowInstance.getName(); + checkState(!registeredWorkflowExecuteRunnableMap.containsKey(workflowInstanceId), + "WorkflowExecuteRunnable(%s/%s already registered at WorkflowEventBusFireWorker", workflowInstanceId, + workflowInstanceName); + registeredWorkflowExecuteRunnableMap.put(workflowInstanceId, workflowExecutionRunnable); + } + + public void unRegisterWorkflowEventBus(IWorkflowExecutionRunnable workflowExecutionRunnable) { + final IWorkflowExecuteContext workflowExecuteContext = workflowExecutionRunnable.getWorkflowExecuteContext(); + final ProcessInstance workflowInstance = workflowExecuteContext.getWorkflowInstance(); + final Integer workflowInstanceId = workflowInstance.getId(); + registeredWorkflowExecuteRunnableMap.remove(workflowInstanceId, workflowExecutionRunnable); + } + + public void fireAllRegisteredEvent() { + final List<IWorkflowExecutionRunnable> workflowExecutionRunnables = getWaitingFireWorkflowExecutionRunnables(); + if (CollectionUtils.isEmpty(workflowExecutionRunnables)) { + return; + } + for (IWorkflowExecutionRunnable workflowExecutionRunnable : workflowExecutionRunnables) { + final Integer workflowInstanceId = workflowExecutionRunnable.getId(); + final String workflowInstanceName = workflowExecutionRunnable.getName(); + try { + LogUtils.setWorkflowInstanceIdMDC(workflowInstanceId); + doFireSingleWorkflowEventBus(workflowExecutionRunnable); + } catch (Exception ex) { + log.error("Fire event failed for WorkflowExecuteRunnable: {}", workflowInstanceName, ex); + } finally { + LogUtils.removeWorkflowInstanceIdMDC(); + } + } + } + + private List<IWorkflowExecutionRunnable> getWaitingFireWorkflowExecutionRunnables() { + if (MapUtils.isEmpty(registeredWorkflowExecuteRunnableMap)) { + return Collections.emptyList(); + } + return registeredWorkflowExecuteRunnableMap.values() + .stream() + .filter(workflowExecuteRunnable -> !workflowExecuteRunnable.getWorkflowEventBus().isEmpty()) + .collect(Collectors.toList()); + } + + private void doFireSingleWorkflowEventBus(final IWorkflowExecutionRunnable workflowExecutionRunnable) { + final WorkflowEventBus workflowEventBus = workflowExecutionRunnable.getWorkflowEventBus(); + while (!workflowEventBus.isEmpty()) { + Optional<AbstractLifecycleEvent> eventOptional = workflowEventBus.poll(); + if (!eventOptional.isPresent()) { + return; + } + final AbstractLifecycleEvent lifecycleEvent = eventOptional.get(); + try { + // Since we will print the event count at FinalizeEventHandler + // So we increase the event count before the event fired then we can get the correct event count + // And if the event handle failed we will decrease the success event count + workflowEventBus.getWorkflowEventBusSummary().increaseFireSuccessEventCount(); + doFireSingleEvent(workflowExecutionRunnable, lifecycleEvent); + } catch (Exception ex) { + // If the database connection is failed, do not remove the event from the event bus + // so that the event can be fired again when the database connection is recovered + if (ExceptionUtils.isDatabaseConnectedFailedException(ex)) { + workflowEventBus.publish(lifecycleEvent); Review Comment: Should return here? Better to sleep when db connect fail. ########## dolphinscheduler-master/src/main/java/org/apache/dolphinscheduler/server/master/engine/graph/AbstractSuccessorParser.java: ########## @@ -15,19 +15,23 @@ * limitations under the License. */ -package org.apache.dolphinscheduler.server.master.event; +package org.apache.dolphinscheduler.server.master.engine.graph; -/** - * This exception represent the exception can not recover, this happens when the event is broken. - * And when we get this exception, we will drop the event. - */ -public class StateEventHandleError extends Exception { +import org.apache.dolphinscheduler.dao.entity.TaskInstance; + +public abstract class AbstractSuccessorParser implements ISuccessorParser { Review Comment: Can you add some comments for the concept of `Successor Parser`? ########## dolphinscheduler-master/src/main/java/org/apache/dolphinscheduler/server/master/engine/WorkflowRepository.java: ########## @@ -32,47 +32,44 @@ import com.google.common.collect.ImmutableList; -/** - * cache of process instance id and WorkflowExecuteThread - */ @Component -public class ProcessInstanceExecCacheManagerImpl implements ProcessInstanceExecCacheManager { +public class WorkflowRepository implements IWorkflowRepository { Review Comment: I think we should keep the cache concept because it's not a real dao repository. ```suggestion public class WorkflowCacheRepository implements IWorkflowRepository { ``` ########## dolphinscheduler-master/src/main/java/org/apache/dolphinscheduler/server/master/engine/command/handler/ReRunWorkflowCommandHandler.java: ########## @@ -0,0 +1,102 @@ +/* + * 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.server.master.engine.command.handler; + +import org.apache.dolphinscheduler.common.enums.CommandType; +import org.apache.dolphinscheduler.common.enums.WorkflowExecutionStatus; +import org.apache.dolphinscheduler.dao.entity.Command; +import org.apache.dolphinscheduler.dao.entity.ProcessInstance; +import org.apache.dolphinscheduler.dao.entity.TaskInstance; +import org.apache.dolphinscheduler.dao.repository.ProcessInstanceDao; +import org.apache.dolphinscheduler.dao.repository.TaskInstanceDao; +import org.apache.dolphinscheduler.server.master.runner.WorkflowExecuteContext.WorkflowExecuteContextBuilder; + +import java.util.Date; +import java.util.List; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.context.ApplicationContext; +import org.springframework.stereotype.Component; + +/** + * This handler used to handle {@link CommandType#REPEAT_RUNNING} which will rerun the workflow instance. + */ +@Component +public class ReRunWorkflowCommandHandler extends RunWorkflowCommandHandler { + + @Autowired + private ProcessInstanceDao workflowInstanceDao; + + @Autowired + private TaskInstanceDao taskInstanceDao; + + @Autowired + private ApplicationContext applicationContext; + + /** + * Generate the repeat running workflow instance. + * <p> Will use the origin workflow instance, but will update the following fields. Need to note we cannot not + * update the command params here, since this will make the origin command params lost. + * <ul> + * <li>state</li> + * <li>command type</li> + * <li>start time</li> + * <li>restart time</li> + * <li>end time</li> + * <li>run times</li> + * </ul> + */ + @Override + protected void assembleWorkflowInstance(final WorkflowExecuteContextBuilder workflowExecuteContextBuilder) { + final Command command = workflowExecuteContextBuilder.getCommand(); + final int workflowInstanceId = command.getProcessInstanceId(); + final ProcessInstance workflowInstance = workflowInstanceDao.queryOptionalById(workflowInstanceId) + .orElseThrow(() -> new IllegalArgumentException("Cannot find WorkflowInstance:" + workflowInstanceId)); + workflowInstance.setVarPool(null); + workflowInstance.setStateWithDesc(WorkflowExecutionStatus.RUNNING_EXECUTION, command.getCommandType().name()); + workflowInstance.setCommandType(command.getCommandType()); + workflowInstance.setStartTime(new Date()); Review Comment: should not update start time when repeat running? ########## dolphinscheduler-master/src/main/java/org/apache/dolphinscheduler/server/master/engine/command/handler/RecoverFailureTaskCommandHandler.java: ########## @@ -0,0 +1,218 @@ +/* + * 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.server.master.engine.command.handler; + +import org.apache.dolphinscheduler.common.enums.CommandType; +import org.apache.dolphinscheduler.common.enums.WorkflowExecutionStatus; +import org.apache.dolphinscheduler.dao.entity.Command; +import org.apache.dolphinscheduler.dao.entity.ProcessInstance; +import org.apache.dolphinscheduler.dao.entity.TaskInstance; +import org.apache.dolphinscheduler.dao.repository.ProcessInstanceDao; +import org.apache.dolphinscheduler.dao.repository.TaskInstanceDao; +import org.apache.dolphinscheduler.plugin.task.api.enums.TaskExecutionStatus; +import org.apache.dolphinscheduler.server.master.engine.TaskGroupCoordinator; +import org.apache.dolphinscheduler.server.master.engine.graph.IWorkflowGraph; +import org.apache.dolphinscheduler.server.master.engine.graph.WorkflowExecutionGraph; +import org.apache.dolphinscheduler.server.master.engine.graph.WorkflowGraphBfsVisitor; +import org.apache.dolphinscheduler.server.master.engine.task.runnable.TaskExecutionRunnable; +import org.apache.dolphinscheduler.server.master.engine.task.runnable.TaskExecutionRunnableBuilder; +import org.apache.dolphinscheduler.server.master.runner.TaskExecutionContextFactory; +import org.apache.dolphinscheduler.server.master.runner.WorkflowExecuteContext.WorkflowExecuteContextBuilder; + +import java.util.ArrayList; +import java.util.Date; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.function.BiConsumer; +import java.util.function.Function; +import java.util.stream.Collectors; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.context.ApplicationContext; +import org.springframework.stereotype.Component; + +import com.google.common.collect.Lists; + +/** + * This handler used to handle {@link CommandType#START_FAILURE_TASK_PROCESS}. + * <p> Will start the failure/pause/killed and other task instance which is behind success tasks instance but not been triggered. + */ +@Component +public class RecoverFailureTaskCommandHandler extends AbstractCommandHandler { + + @Autowired + private ProcessInstanceDao workflowInstanceDao; + + @Autowired + private TaskInstanceDao taskInstanceDao; + + @Autowired + private TaskExecutionContextFactory taskExecutionContextFactory; + + @Autowired + private TaskGroupCoordinator taskGroupCoordinator; + + @Autowired + private ApplicationContext applicationContext; + + /** + * Generate the recover workflow instance. + * <p> Will use the origin workflow instance, but will update the following fields. Need to note we cannot not + * update the command params here, since this will make the origin command params lost. + * <ul> + * <li>state</li> + * <li>command type</li> + * <li>start time</li> + * <li>restart time</li> + * <li>end time</li> + * <li>run times</li> + * </ul> + */ + @Override + protected void assembleWorkflowInstance( + final WorkflowExecuteContextBuilder workflowExecuteContextBuilder) { + final Command command = workflowExecuteContextBuilder.getCommand(); + final int workflowInstanceId = command.getProcessInstanceId(); + final ProcessInstance workflowInstance = workflowInstanceDao.queryOptionalById(workflowInstanceId) + .orElseThrow(() -> new IllegalArgumentException("Cannot find WorkflowInstance:" + workflowInstanceId)); + workflowInstance.setVarPool(null); + workflowInstance.setStateWithDesc(WorkflowExecutionStatus.RUNNING_EXECUTION, command.getCommandType().name()); + workflowInstance.setCommandType(command.getCommandType()); + workflowInstance.setStartTime(new Date()); + workflowInstance.setRestartTime(new Date()); + workflowInstance.setEndTime(null); + workflowInstance.setRunTimes(workflowInstance.getRunTimes() + 1); + workflowInstanceDao.updateById(workflowInstance); + + workflowExecuteContextBuilder.setWorkflowInstance(workflowInstance); + } + + /** + * Generate the workflow execution graph. + * <p> Will clear the history failure/killed task. + * <p> If the task's predecessors exist failure/killed, will also mark the task as failure/killed. + */ + @Override + protected void assembleWorkflowExecutionGraph(final WorkflowExecuteContextBuilder workflowExecuteContextBuilder) { + final Map<String, TaskInstance> taskInstanceMap = dealWithHistoryTaskInstances(workflowExecuteContextBuilder) + .stream() + .collect(Collectors.toMap(TaskInstance::getName, Function.identity())); + + final IWorkflowGraph workflowGraph = workflowExecuteContextBuilder.getWorkflowGraph(); + final WorkflowExecutionGraph workflowExecutionGraph = new WorkflowExecutionGraph(); + + final BiConsumer<String, Set<String>> taskExecutionRunnableCreator = (task, successors) -> { + final TaskExecutionRunnableBuilder taskExecutionRunnableBuilder = + TaskExecutionRunnableBuilder + .builder() + .workflowExecutionGraph(workflowExecutionGraph) + .workflowDefinition(workflowExecuteContextBuilder.getWorkflowDefinition()) + .workflowInstance(workflowExecuteContextBuilder.getWorkflowInstance()) + .taskDefinition(workflowGraph.getTaskNodeByName(task)) + .taskInstance(taskInstanceMap.get(task)) + .workflowEventBus(workflowExecuteContextBuilder.getWorkflowEventBus()) + .applicationContext(applicationContext) + .build(); + workflowExecutionGraph.addNode(new TaskExecutionRunnable(taskExecutionRunnableBuilder)); + workflowExecutionGraph.addEdge(task, successors); + }; + + final WorkflowGraphBfsVisitor workflowGraphBfsVisitor = WorkflowGraphBfsVisitor.builder() + .taskDependType(workflowExecuteContextBuilder.getWorkflowInstance().getTaskDependType()) + .onWorkflowGraph(workflowGraph) + .fromTask(parseStartNodesFromWorkflowInstance(workflowExecuteContextBuilder)) + .doVisitFunction(taskExecutionRunnableCreator) + .build(); + workflowGraphBfsVisitor.visit(); + + workflowExecuteContextBuilder.setWorkflowExecutionGraph(workflowExecutionGraph); + } + + /** + * Return the valid task instance which should not be recovered. + * <p> Will mark the failure/killed task instance as invalid. + */ + private List<TaskInstance> dealWithHistoryTaskInstances( + final WorkflowExecuteContextBuilder workflowExecuteContextBuilder) { + final ProcessInstance workflowInstance = workflowExecuteContextBuilder.getWorkflowInstance(); + final Map<String, TaskInstance> taskInstanceMap = super.getValidTaskInstance(workflowInstance) + .stream() + .collect(Collectors.toMap(TaskInstance::getName, Function.identity())); + + final Set<String> needRecreateTasks = taskInstanceMap.values() + .stream() + .filter(this::isTaskNeedRecreate) + .map(TaskInstance::getName) + .collect(Collectors.toSet()); + + final IWorkflowGraph workflowGraph = workflowExecuteContextBuilder.getWorkflowGraph(); + final BiConsumer<String, Set<String>> historyTaskInstanceMarker = (task, successors) -> { + boolean isTaskNeedRecreate = needRecreateTasks.contains(task) || workflowGraph.getPredecessors(task) + .stream() + .anyMatch(needRecreateTasks::contains); + // If the task instance need to be recreated, then will mark the task instance invalid. + // and the TaskExecutionRunnable will not contain the task instance. + if (isTaskNeedRecreate) { + needRecreateTasks.add(task); + if (taskInstanceMap.containsKey(task)) { + taskInstanceDao.markTaskInstanceInvalid(Lists.newArrayList(taskInstanceMap.get(task))); + taskInstanceMap.remove(task); + } + } + // If the task instance need to be recovered, then will mark the task instance to submit. + // and the TaskExecutionRunnable will contain the task instance and pass the creation step. + if (isTaskNeedRecover(taskInstanceMap.get(task))) { + final TaskInstance taskInstance = taskInstanceMap.get(task); + taskInstance.setState(TaskExecutionStatus.SUBMITTED_SUCCESS); + taskInstanceDao.upsertTaskInstance(taskInstance); + } + }; + + final WorkflowGraphBfsVisitor workflowGraphBfsVisitor = WorkflowGraphBfsVisitor.builder() + .onWorkflowGraph(workflowGraph) + .taskDependType(workflowInstance.getTaskDependType()) + .fromTask(parseStartNodesFromWorkflowInstance(workflowExecuteContextBuilder)) + .doVisitFunction(historyTaskInstanceMarker) + .build(); + workflowGraphBfsVisitor.visit(); + return new ArrayList<>(taskInstanceMap.values()); + } + + /** + * Whether the task need to be recreated. + * <p> If the task state is FAILURE and KILL, then will mark the task invalid and recreate the task. + */ + private boolean isTaskNeedRecreate(final TaskInstance taskInstance) { + return taskInstance.getState() == TaskExecutionStatus.FAILURE Review Comment: Need to check task retry -- 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]
