Laravel Workflow Laravel Package

Technical Evaluation

Architecture Fit

• Laravel 13 Support: The package now officially supports Laravel 13, aligning with PHP 8.3+ features (e.g., random extension functions, read-only properties). This enables:
  • Performance optimizations (e.g., random_int() for workflow transition IDs).
  • Type safety (e.g., readonly properties in workflow models).
• Symfony Workflow v6.3+: Retains place-based transitions, guards, and event-driven extensibility, but now includes:
  • Improved transition validation (e.g., stricter type hints for from/to places).
  • Better integration with Symfony Messenger (if using async workflows).
• Decoupled Design: Still leverages Laravel’s service container and events, but now with Laravel 13’s enhanced dependency injection (e.g., bindWhen() for context-aware workflow resolution).
• ORM Agnostic: Continues to work with Eloquent, but Laravel 13’s query builder improvements (e.g., whereIn optimizations) may reduce overhead for workflow state queries.

Integration Feasibility

• Laravel 13 Ecosystem Synergy:
  • First-class support for Laravel 13’s new features:
    • Model observers (replacing events for simpler workflow triggers).
    • Enhanced validation (e.g., guard constraints can now use Laravel 13’s rule objects).
  • Bootloader compatibility: Workflows can now be registered via Laravel 13’s bootloader (e.g., WorkflowServiceProvider::boot()).
• Configuration Over Convention:
  • YAML/array config remains, but Laravel 13’s spatie/laravel-config-array can now be used for runtime overrides without caching issues.
  • Example (Laravel 13-compatible config):

    // config/workflows.php
    return [
        'order_workflow' => [
            'supports' => [\App\Models\Order::class],
            'places' => ['draft', 'submitted', 'approved', 'cancelled'],
            'transitions' => [
                'submit' => [
                    'from' => 'draft',
                    'to' => 'submitted',
                    'guard' => \App\Guards\OrderSubmissionGuard::class,
                ],
            ],
        ],
    ];
    

• Event-Driven Extensibility:
  • Laravel 13’s event system now supports async listeners out of the box, enabling:
    • Queue-based workflow transitions (e.g., WorkflowTransitionEvent dispatched to queue:work).
    • Real-time updates via Laravel Echo/Pusher for frontend reactivity.

Technical Risk

                      public function check(Order $order, string $transition): bool {
                          return $order->user->can('submit_orders');
                      }
                      ``` |

| Performance with PHP 8.3 | Benchmark workflow state lookups in PHP 8.3 (JIT optimizations may reduce overhead). Monitor memory usage for high-concurrency workflows. | | Async Transition Complexity | If using Symfony Messenger, test transactional boundaries (e.g., DB::transaction() + bus->dispatch()). | | Deprecated Features | Check for removed Symfony Workflow v6.2 features (e.g., action-based transitions are now discouraged). |

Key Questions

1. Laravel 13 Migration Readiness:
   • Are you already on Laravel 13, or does this package adoption block your upgrade? If the latter, plan a parallel branch for testing.
2. Async Workflow Strategy:
   • Will transitions be synchronous (default) or async (via Messenger)? Async requires:
     • Queue workers (e.g., queue:work).
     • Retry logic for failed transitions.
3. Guard Type Safety:
   • Do existing guards need PHP 8.3 strict types? Example:

     public function check(Order $order, string $transition): bool { ... }
     

4. Workflow State Storage:
   • With Laravel 13’s improved caching, should workflow states use:
     • Database column (default, atomic).
     • Redis (low-latency, but requires cache invalidation).
5. Testing Strategy Update:
   • Laravel 13 introduces Pest 2.0. Should workflow tests migrate to:

     it('transitions from draft to submitted')->expectsEvents(WorkflowTransitionEvent::class)
         ->toTransition($order, 'submit');
     

Integration Approach

Stack Fit

• Laravel Versions:
  • Primary: Laravel 13 (PHP 8.3+).
  • Legacy: Laravel 10/11/12 (use v6.2.x of the package).
  • New Features:
    • Model observers (replace retrieved/saved events).
    • Enhanced validation (e.g., Rule::active() for guard constraints).
• Dependencies:
  • Symfony Workflow v6.3: Requires symfony/messenger for async transitions (optional).
  • Laravel 13 Tools:
    • Artisan commands: Use php artisan workflow:list (hypothetical) to inspect workflows.
    • Laravel Telescope: Monitor workflow events in the Events tab.
• Database:
  • Transactions: Workflows now support Laravel 13’s DB::transaction() for atomic transitions.
  • Schema: If using custom state columns, leverage Laravel 13’s schema builder (e.g., string('tiny') for place storage).

Migration Path

1. Pre-Migration Steps:
   • Audit Laravel 13 compatibility:
     • Replace HasEvents with observers for workflow-triggered logic.
     • Update validation rules (e.g., Rule::exists() syntax).
   • Test Symfony Workflow v6.3 guards with strict types:

     // Before (v6.2)
     public function check(Order $order, $transition) { ... }
     
     // After (v6.3)
     public function check(Order $order, string $transition): bool { ... }
     

2. Pilot Implementation:
   • Phase 1: Migrate one workflow (e.g., OrderWorkflow) to Laravel 13 + v6.3.
   • Phase 2: Add async transitions (if needed) using Symfony Messenger:

     use Symfony\Component\Messenger\MessageBusInterface;
     
     $bus->dispatch(new TransitionOrderMessage($order, 'submit'));
     

3. Configuration Update:
   • Laravel 13 config caching: Disable caching for workflows.php if using runtime overrides:

     // config/cache.php
     'stores' => [
         'array' => [
             'exclude' => ['workflows'],
         ],
     ],
     

4. Testing Strategy:
   • Pest 2.0: Use expectsEvents for workflow transitions:

     it('fails transition without guard')->expectsEvents(WorkflowTransitionFailed::class)
         ->cannotTransition($order, 'approve');
     

   • Async Tests: Mock MessageBusInterface for transition messages.

Compatibility

• With Laravel 13 Packages:
  • Laravel Nova 5: Extend workflows via custom actions (now supports Laravel 13’s new UI components).
  • Laravel Fortify: Integrate workflows into auth flows (e.g., "pending approval" user states).
  • Laravel Scout: Index workflow-aware models with Laravel 13’s improved search syntax.
• With Symfony Components:
  • Messenger + Workflow: Use Symfony’s AsyncTransport for background transitions.
  • Workflow + UX: Pair with Laravel Livewire 3 for reactive frontend state updates.

Sequencing

1. Phase 1: Laravel 13 + Package v6.3 (3–4