Dealing with errors #

To explain how failed jobs affect a workflow, let's take a look at the following example:

In the workflow above, JobB failed to execute successfully. This will prevent all jobs in that subtree of the workflow from running. In this case JobB failing will prevent JobC, JobD and JobE from executing, since each of them either has a direct dependency or transitive dependency on it.

It will, however, not affect the execution of JobF and JobG because neither of them have any dependency on JobB.

This is a powerful property of workflows as it makes them more robust and less all-or-nothing. Just because you failed to notify your subscribers about a new podcast does not mean that the job to generate a transcription should not be run.

If you do want a workflow to stop executing any further jobs, check the section below about cancelling a workflow.

Cancelling a workflow #

You can mark a workflow as cancelled by calling its cancel method. This is usually going to happen inside the workflow's catch callback, but there's nothing stopping you from fetching a workflow from the database and calling its cancel function there. This can be useful if you want to display a Cancel Workflow button in your UI for example.

$this->define('Register Podcast')
    ->addJob(...)
    ->catch(function (Workflow $workflow, WorkflowJobInterface $job, Throwable $e) {
        $workflow->cancel();
    });

A cancelled workflow will not execute any further jobs. It does not affect jobs that have already run or jobs that were already processing when the workflow was cancelled.