Przejdź do treści

Uruchamianie workflow

Wyświetl jako Markdown Edytuj w GitHub Dokumentacja: 2cc7b2b

Workflow może uruchomić workflow potomny jako jeden ze swoich kroków. Nadrzędny workflow wstrzymuje się do zakończenia uruchomionego workflow, a następnie łączy końcowy stan potomnego ze swoim stanem.

Metoda ->run_workflow()

PHP
use Queuety\Queuety;

$enrichment = Queuety::workflow( 'enrich_user' )
    ->then( FetchSocialHandler::class )
    ->then( FetchCreditScoreHandler::class );

Queuety::workflow( 'onboarding' )
    ->then( CreateAccountHandler::class )
    ->run_workflow( 'enrich_user', $enrichment )
    ->then( SendWelcomeEmailHandler::class )
    ->dispatch( [ 'email' => 'user@example.com' ] );

Metoda run_workflow() przyjmuje dwa argumenty:

  1. Nazwę uruchamianego workflow
  2. Instancję WorkflowBuilder definiującą kroki uruchamianego workflow

Jak to działa

Gdy nadrzędny workflow dojdzie do kroku run_workflow:

  1. Uruchamiany workflow zostaje wysłany jako niezależny workflow z własnym identyfikatorem
  2. Nadrzędny workflow zostaje wstrzymany
  3. Uruchamiany workflow wykonuje kolejne kroki w zwykły sposób
  4. Po zakończeniu uruchamianego workflow jego końcowy stan zostaje połączony ze stanem nadrzędnego workflow
  5. Nadrzędny workflow wznawia działanie od następnego kroku

Stan nadrzędnego i potomnego workflow

Uruchamiany workflow otrzymuje bieżący skumulowany stan nadrzędnego workflow jako początkowe dane. Dzięki temu kroki potomne mogą uzyskać dostęp do danych utworzonych przez wcześniejsze kroki nadrzędnego workflow:

PHP
class CreateAccountHandler implements Step {
    public function handle( array $state ): array {
        $user_id = wp_create_user( $state['email'], wp_generate_password() );
        return [ 'user_id' => $user_id ];
    }

    public function config(): array {
        return [];
    }
}

// This run-workflow step can access 'user_id' from the parent
class FetchSocialHandler implements Step {
    public function handle( array $state ): array {
        $profile = fetch_social_profile( $state['user_id'] );
        return [ 'social_data' => $profile ];
    }

    public function config(): array {
        return [];
    }
}

Scalanie stanu

Po zakończeniu uruchamianego workflow jego końcowy stan (z wyłączeniem kluczy wewnętrznych, takich jak _steps, _queue, _priority, _max_attempts) zostaje połączony ze stanem nadrzędnego workflow. Następny krok nadrzędnego workflow widzi wszystkie dane z wcześniejszych kroków nadrzędnych oraz uruchamianego workflow:

PHP
class SendWelcomeEmailHandler implements Step {
    public function handle( array $state ): array {
        // Has access to:
        // - $state['email'] (from initial dispatch)
        // - $state['user_id'] (from CreateAccountHandler)
        // - $state['social_data'] (from run-workflow's FetchSocialHandler)
        // - $state['credit_score'] (from run-workflow's FetchCreditScoreHandler)

        send_welcome_email( $state['email'], $state['social_data'] );
        return [ 'welcome_sent' => true ];
    }

    public function config(): array {
        return [];
    }
}

Opcje uruchamianego workflow

on_queue(), with_priority() i max_attempts() konstruktora uruchamianego workflow dotyczą workflow potomnego. Pozostałe opcje na poziomie workflow w konstruktorze potomnym, takie jak on_cancel(), prune_state_after(), must_complete_within(), version(), idempotency_key(), budżety max_*() i compensate_on_failure(), nie są przenoszone:

PHP
$sub = Queuety::workflow( 'heavy_processing' )
    ->on_queue( 'background' )
    ->with_priority( Priority::Normal )
    ->max_attempts( 5 )
    ->then( StepA::class )
    ->then( StepB::class );

Queuety::workflow( 'parent' )
    ->run_workflow( 'heavy', $sub )
    ->then( FinalStep::class )
    ->dispatch( $payload );

Zagnieżdżone uruchamiane workflow

Uruchamiane workflow mogą same zawierać kolejne uruchamiane workflow, co pozwala na dowolne zagnieżdżanie:

PHP
$inner = Queuety::workflow( 'inner' )
    ->then( InnerStepA::class )
    ->then( InnerStepB::class );

$middle = Queuety::workflow( 'middle' )
    ->then( MiddleStepA::class )
    ->run_workflow( 'inner', $inner )
    ->then( MiddleStepB::class );

Queuety::workflow( 'outer' )
    ->then( OuterStepA::class )
    ->run_workflow( 'middle', $middle )
    ->then( OuterStepB::class )
    ->dispatch( $payload );