laravel-workflow/laravel-workflow

Durable workflow engine that allows users to write long running persistent distributed workflows (orchestrations) in PHP powered by Laravel queues.

1.0.25 2024-05-19 10:16 UTC

README

logo

GitHub Workflow Status Scrutinizer code quality (GitHub/Bitbucket) Scrutinizer coverage (GitHub/BitBucket) Packagist Downloads (custom server) Docs Packagist License

Laravel Workflow is a package for the Laravel web framework that provides tools for defining and managing workflows and activities. A workflow is a series of interconnected activities that are executed in a specific order to achieve a desired result. Activities are individual tasks or pieces of logic that are executed as part of a workflow.

Laravel Workflow can be used to automate and manage complex processes, such as financial transactions, data analysis, data pipelines, microservices, job tracking, user signup flows, sagas and other business processes. By using Laravel Workflow, developers can break down large, complex processes into smaller, modular units that can be easily maintained and updated.

Some key features and benefits of Laravel Workflow include:

  • Support for defining workflows and activities using simple, declarative PHP classes.
  • Tools for starting, monitoring, and managing workflows, including support for queuing and parallel execution.
  • Built-in support for handling errors and retries, ensuring that workflows are executed reliably and consistently.
  • Integration with Laravel's queue and event systems, allowing workflows to be executed asynchronously on worker servers.
  • Extensive documentation and a growing community of developers who use and contribute to Laravel Workflow.

Documentation

Documentation for Laravel Workflow can be found on the Laravel Workflow website.

Community

You can find us in the GitHub discussions and also on our Discord channel.

Sample App

There's also a sample application that you can run directly from GitHub in your browser.

Usage

1. Create a workflow.

use Workflow\ActivityStub;
use Workflow\Workflow;

class MyWorkflow extends Workflow
{
    public function execute($name)
    {
        $result = yield ActivityStub::make(MyActivity::class, $name);
        return $result;
    }
}

2. Create an activity.

use Workflow\Activity;

class MyActivity extends Activity
{
    public function execute($name)
    {
        return "Hello, {$name}!";
    }
}

3. Run the workflow.

use Workflow\WorkflowStub;

$workflow = WorkflowStub::make(MyWorkflow::class);
$workflow->start('world');
while ($workflow->running());
$workflow->output();
=> 'Hello, world!'

Monitoring

Waterline is a separate UI that works nicely alongside Horizon. Think of Waterline as being to workflows what Horizon is to queues.

Dashboard View

waterline_dashboard

Workflow View

workflow

Refer to https://github.com/laravel-workflow/waterline for installation and configuration instructions.

"Laravel" is a registered trademark of Taylor Otwell. This project is not affiliated, associated, endorsed, or sponsored by Taylor Otwell, nor has it been reviewed, tested, or certified by Taylor Otwell. The use of the trademark "Laravel" is for informational and descriptive purposes only. Laravel Workflow is not officially related to the Laravel trademark or Taylor Otwell.