Alpha version

Author: Richard McDaniel

.env.example

@@ -0,0 +1,14 @@
+APP_KEY=base64:i3g6f+dV8FfsIkcxqd7gbiPn2oXk5r00sTmdD6V5utI=
+
+DB_CONNECTION=mysql
+DB_DATABASE=testbench
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_USERNAME=root
+DB_PASSWORD=password
+
+QUEUE_CONNECTION=redis
+
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=
+REDIS_PORT=6379

.github/workflows/php.yml

@@ -0,0 +1,61 @@
+name: PHP Composer
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    services:
+      mysql:
+        image: mysql
+        env:
+          MYSQL_ROOT_PASSWORD: password
+        ports:
+        - 3306:3306
+
+      redis:
+        image: redis
+        ports:
+        - 6379:6379
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Validate composer.json and composer.lock
+      run: composer validate --strict
+
+    - name: Cache Composer packages
+      id: composer-cache
+      uses: actions/cache@v2
+      with:
+        path: vendor
+        key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-php-
+
+    - name: Install dependencies
+      run: composer install --prefer-dist --no-progress
+
+    - name: Create database
+      run: mysql -e 'CREATE DATABASE testbench' -h127.0.0.1 -uroot -ppassword -P ${{ job.services.mysql.ports[3306] }}
+
+    - name: Run test suite
+      run: composer run-script test
+      env:
+        APP_KEY: base64:i3g6f+dV8FfsIkcxqd7gbiPn2oXk5r00sTmdD6V5utI=
+        DB_CONNECTION: mysql
+        DB_DATABASE: testbench
+        DB_HOST: 127.0.0.1
+        DB_PORT: 3306
+        DB_USERNAME: root
+        DB_PASSWORD: password
+        QUEUE_CONNECTION: redis
+        REDIS_HOST: 127.0.0.1
+        REDIS_PASSWORD:
+        REDIS_PORT: 6379

.gitignore

@@ -0,0 +1,8 @@
+build
+composer.lock
+vendor
+coverage
+.env
+.phpunit.result.cache
+.php_cs.cache
+.php-cs-fixer.cache

README.md

@@ -0,0 +1,74 @@
+# Laravel Workflow [![PHP Composer](https://github.com/laravel-workflow/laravel-workflow/actions/workflows/php.yml/badge.svg)](https://github.com/laravel-workflow/laravel-workflow/actions/workflows/php.yml)
+
+Durable workflow engine that allows users to write long running persistent distributed workflows (orchestrations) in PHP powered by [Laravel queues](https://laravel.com/docs/9.x/queues).
+
+## Installation
+
+This library is installable via [Composer](https://getcomposer.org).
+
+```bash
+composer require laravel-workflow/laravel-workflow
+```
+
+## Requirements
+
+You can use any queue driver that Laravel supports but this is heavily tested against Redis.
+
+## Usage
+
+**1. Create a workflow.**
+```php
+class MyWorkflow extends Workflow
+{
+    public function execute()
+    {
+        $result = yield ActivityStub::make(MyActivity::class);
+        return $result;
+    }
+}
+```
+
+**2. Create an activity.**
+```php
+class MyActivity extends Activity
+{
+    public function execute()
+    {
+        return 'activity';
+    }
+}
+```
+
+**3. Run the workflow.**
+```php
+$workflow = WorkflowStub::make(MyWorkflow::class);
+$workflow->start();
+while ($workflow->running());
+$workflow->output();
+=> 'activity'
+```
+
+## Failed Workflows
+
+If a workflow fails or crashes at any point then it can be resumed from that point. Any activities that were successfully completed during the previous execution of the workflow will not be ran again.
+
+```php
+$workflow = WorkflowStub::load(1);
+$workflow->reset();
+$workflow->start();
+while ($workflow->running());
+$workflow->output();
+=> 'activity'
+```
+
+## Retries
+
+A workflow will only fail when the retries on the workflow or a failing activity have been exhausted.
+
+Workflows and activies are based on Laravel jobs so you can use any options you normally would.
+
+```php
+public $tries = 3;
+
+public $maxExceptions = 3;
+```

artisan

@@ -0,0 +1,55 @@
+#!/usr/bin/env php
+<?php
+
+define('LARAVEL_START', microtime(true));
+
+/*
+|--------------------------------------------------------------------------
+| Register The Auto Loader
+|--------------------------------------------------------------------------
+|
+| Composer provides a convenient, automatically generated class loader
+| for our application. We just need to utilize it! We'll require it
+| into the script here so that we do not have to worry about the
+| loading of any of our classes manually. It's great to relax.
+|
+*/
+
+require __DIR__.'/vendor/autoload.php';
+
+Dotenv\Dotenv::createImmutable(__DIR__)->safeLoad();
+
+$app = require_once __DIR__.'/vendor/orchestra/testbench-core/laravel/bootstrap/app.php';
+
+/*
+|--------------------------------------------------------------------------
+| Run The Artisan Application
+|--------------------------------------------------------------------------
+|
+| When we run the console application, the current CLI command will be
+| executed in this console and the response sent back to a terminal
+| or another output device for the developers. Here goes nothing!
+|
+*/
+
+$kernel = $app->make(Illuminate\Contracts\Console\Kernel::class);
+
+$status = $kernel->handle(
+    $input = new Symfony\Component\Console\Input\ArgvInput,
+    new Symfony\Component\Console\Output\ConsoleOutput
+);
+
+/*
+|--------------------------------------------------------------------------
+| Shutdown The Application
+|--------------------------------------------------------------------------
+|
+| Once Artisan has finished running, we will fire off the shutdown events
+| so that any final work may be done by the application before we shut
+| down the process. This is the last thing to happen to the request.
+|
+*/
+
+$kernel->terminate($input, $status);
+
+exit($status);

composer.json

@@ -0,0 +1,38 @@
+{
+    "name": "laravel-workflow/laravel-workflow",
+    "description": "Durable workflow engine that allows users to write long running persistent distributed workflows (orchestrations) in PHP powered by Laravel queues.",
+    "type": "library",
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "Workflow\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/"
+        }
+    },
+    "scripts": {
+        "test": "phpunit"
+    },
+    "authors": [
+        {
+            "name": "Richard McDaniel",
+            "email": "richard.lee.mcdaniel@gmail.com"
+        }
+    ],
+    "require": {
+        "spatie/laravel-model-states": "^2.1"
+    },
+    "require-dev": {
+        "orchestra/testbench": "^7.1"
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Workflow\\WorkflowServiceProvider"
+            ]
+        }
+    }
+}

phpunit.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" backupStaticAttributes="false" colors="true" verbose="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage>
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="Workflow Test Suite">
+      <directory>./tests/Feature</directory>
+    </testsuite>
+  </testsuites>
+  <php>
+    <ini name="memory_limit" value="-1"/>
+  </php>
+</phpunit>

src/Activity.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace Workflow;
+
+use BadMethodCallException;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldBeEncrypted;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use Throwable;
+use Workflow\Middleware\WorkflowMiddleware;
+use Workflow\Models\StoredWorkflow;
+
+class Activity implements ShouldBeEncrypted, ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+    
+    public $tries = 3;
+
+    public $maxExceptions = 3;
+
+    public $arguments;
+
+    public $index;
+
+    public $model;
+
+    public function __construct(int $index, StoredWorkflow $model, ...$arguments)
+    {
+        $this->index = $index;
+        $this->model = $model;
+        $this->arguments = $arguments;
+    }
+
+    public function handle()
+    {
+        if (! method_exists($this, 'execute')) {
+            throw new BadMethodCallException('Execute method mot implemented.');
+        }
+
+        return $this->{'execute'}(...$this->arguments);
+    }
+
+    public function middleware()
+    {
+        return [new WorkflowMiddleware()];
+    }
+
+    public function failed(Throwable $exception)
+    {
+        $this->model->toWorkflow()->fail($exception);
+    }
+}

src/ActivityStub.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Workflow;
+
+class ActivityStub
+{
+    protected $activity;
+
+    protected $arguments;
+
+    private function __construct($activity, ...$arguments)
+    {
+        $this->activity = $activity;
+        $this->arguments = $arguments;
+    }
+
+    public static function make($activity, ...$arguments)
+    {
+        return new static($activity, ...$arguments);
+    }
+
+    public function activity()
+    {
+        return $this->activity;
+    }
+
+    public function arguments()
+    {
+        return $this->arguments;
+    }
+}

src/Exceptions/WorkflowFailedException.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Workflow\Exceptions;
+
+use Exception;
+
+class WorkflowFailedException extends Exception
+{
+    public function __construct($message = 'Workflow Failed.')
+    {
+        parent::__construct($message);
+    }
+}