How convert a CommandTask with execution_state 'errored' into a FailedTask to trigger TaskFailedEvent?

[ranferi]

Hi, I'm working with Symfony 5.4 and SchedulerBundle 0.10.2, and I'm trying to do some logic when my command fails. I connected an EventSubscriber to listen to the TaskFailedEvent and send some payload to an endpoint with information of the issue.

But I found out that if something wrong happens in your command (or task) doesn't mean that that will cause a "TaskFailedEvent".
So how convert a CommandTask with execution_state 'errored' into a FailedTask so that can trigger TaskFailedEvent? There's way to convert inside the command itself? Meaning to throw some exception or flagged it to be consider it as a possible FailedTask?

For example say that my command is:

class ImportCommand extends Command
{
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        throw new \Exception('some error');
    }
}

If I run bin/console scheduler:consume, inside a WorkerSleepingEvent listener I found that the task is in the events array of the TaskEventList object and that is part of the TaskExecutedEvent. Inside of the task I can see that execution_state is errored.

I checked the code and found that if anything goes wrong in my command will be catch by Application:

      // vendor/symfony/console/Application.php line 1056, inside doRunCommand()
       try {
            $this->dispatcher->dispatch($event, ConsoleEvents::COMMAND);

            if ($event->commandShouldRun()) {
                $exitCode = $command->run($input, $output);
            } else {
                $exitCode = ConsoleCommandEvent::RETURN_CODE_DISABLED;
            }
        } catch (\Throwable $e) {
            $event = new ConsoleErrorEvent($input, $output, $e, $command);
            $this->dispatcher->dispatch($event, ConsoleEvents::ERROR);
            $e = $event->getError();

            if (0 === $exitCode = $event->getExitCode()) {
                $e = null;
            }
        }

when this code returns to vendor/symfony/framework-bundle/Console/Application.php and then to vendor/guikingone/scheduler-bundle/src/Runner/CommandTaskRunner.php the code only returns an Output object:

    // vendor/guikingone/scheduler-bundle/src/Runner/CommandTaskRunner.php line 34
    public function run(TaskInterface $task, WorkerInterface $worker): Output
    {
        // other code before
        try {
            $statusCode = $this->application->run($input, $bufferedOutput);
            if (Command::FAILURE === $statusCode) {
                return new Output($task, $bufferedOutput->fetch(), Output::ERROR);
            }
        } catch (Throwable) {
            return new Output($task, $bufferedOutput->fetch(), Output::ERROR);
        }

        return new Output($task, $bufferedOutput->fetch());
    }

In Worker class if there's an error with the Runner (no the command) will create a $failedTask and dispatch a TaskFailedEvent

     //  vendor/guikingone/scheduler-bundle/src/Worker/Worker.php line 314 handleTask()
      catch (Throwable $throwable) {
            $failedTask = new FailedTask(task: $task, reason: $throwable->getMessage());
            $this->getFailedTasks()->add(task: $failedTask);
            $this->eventDispatcher->dispatch(event: new TaskFailedEvent(task: $failedTask));
        } 

After all that investigation, I decide to do this in my command:

class ImportEmployeesCommand extends Command
{
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        try {
            $output = $this->somethingWrong(); // this throws an Exception
        } catch (\Excetion $e){
            $failedTask = new FailedTask(new CommandTask(name: "import", command: "import"), reason: $e->getMessage());
            $failedTaskEvent = new TaskFailedEvent($failedTask);
            $this->dispatcher->dispatch($failedTaskEvent);
        }
    }
}

But the problem is that the command is no the same as the one that failed and I will no get the datetime values to, for example, calculate how much it took to execute the command.

So how can I convert the task to FailedTask? There's something in the package that can help me with that? The behavior that I (kinda) described is the expected one?

Thank you!

[ranferi]

I think one solution will be, for example, inside the WorkerStoppedEvent to get the task and crate a FailedTask and then dispatch the TaskFailedEvent. I haven't test it but possible can work. But there's another way to trigger the TaskFailedEvent if my command fails (meaning an exception it's thrown)?