Liigu sisu juurde

Töövoo signaalid

Vaata Markdownina Muuda teenuses GitHub Dokumentatsioon: 2cc7b2b

Töövood saavad signaalide abil peatuda ja välist sisendit oodata. Koostaja meetodid wait_for_signal() ja wait_for_signals() lisavad samme, mis peatavad töövoo, kuni teie rakendus, operaator või muu süsteem saadab oodatud signaali Queuety::signal() kaudu.

Inimese osalusega töövoogude jaoks pakub Queuety ka järgmist:

  • wait_for_approval() nimeruumiga kinnituse andmete jaoks
  • wait_for_input() struktureeritud inimeste sisendi jaoks
  • wait_for_decision() selgesõnaliste kinnitamise või tagasilükkamise tulemuste jaoks

Suurema tervikliku näite jaoks, mis ühendab agendikäivitused inimeste kontrollpunktidega, vaadake Agentide orkestreerimine.

Meetod ->wait_for_signal()

Lisage töövoole signaali ootamise samm:

PHP
use Queuety\Queuety;

$workflow_id = Queuety::workflow( 'content_approval' )
    ->then( DraftContentHandler::class )
    ->wait_for_signal( 'approved' )
    ->then( PublishContentHandler::class )
    ->dispatch( [ 'post_id' => 99 ] );

Kui töövoog jõuab sammuni wait_for_signal, seab see olekuks waiting_for_signal ja peatub. Ootamise ajal töid ei käivitata ega ressursse tarbita.

Vaikimisi liidetakse ühe signaali andmed töövoo ülataseme olekuga. Kui soovite andmed selle asemel nimeruumi paigutada, edastage result_key:

PHP
$workflow_id = Queuety::workflow( 'content_approval' )
    ->then( DraftContentHandler::class )
    ->wait_for_signal( 'approved', 'approval' )
    ->then( PublishContentHandler::class )
    ->dispatch( [ 'post_id' => 99 ] );

Pärast signaali saabumist sisaldab $state['approval'] signaaliandmete massiivi.

Mitme signaali ootamine

Kasutage wait_for_signals()-i, kui töövoog peaks jätkuma mitme võimaliku signaali peale või kui enne jätkamist tuleb koguda kõik nõutud signaalid.

PHP
use Queuety\Enums\WaitMode;

$workflow_id = Queuety::workflow( 'moderation_gate' )
    ->then( SubmitForReviewHandler::class )
    ->wait_for_signals(
        [ 'editor_approved', 'legal_approved' ],
        WaitMode::All,
        'approvals'
    )
    ->then( PublishContentHandler::class )
    ->dispatch();
  • WaitMode::All ootab, kuni kõik seadistatud signaalid on salvestatud.
  • WaitMode::Any jätkab kohe, kui saabub esimene seadistatud signaal.

result_key-i korral salvestab mitme signaali ootamine assotsiatiivse massiivi, mille võtmeteks on signaalide nimed:

PHP
[
    'editor_approved' => [ 'by' => 'editor@example.com' ],
    'legal_approved' => [ 'by' => 'legal@example.com' ],
]

Ilma result_key-ita liidetakse sobitatud signaalide andmed ülataseme olekuga samas järjekorras, milles samm seadistati.

Sobitamine ja korrelatsioon

Signaali ootamine saab eirata mitteseotud sündmusi, sobitades andmete sisu või korreleerides ühise võtme alusel.

PHP
$workflow_id = Queuety::workflow( 'review_gate' )
    ->wait_for_signal(
        name: 'review_ready',
        result_key: 'review',
        match_payload: [ 'source' => 'editorial' ],
        correlation_key: 'task_id',
    )
    ->dispatch( [ 'task_id' => 'task-42' ] );

Selles näites jätkub ootamine ainult siis, kui:

  • signaali nimi on review_ready
  • andmed sisaldavad source: editorial
  • andmete task_id vastab väärtusele $state['task_id']

See on kasulik, kui mitu välist süsteemi või agenti avaldab sama nimega sündmusi, kuid ainult ühe andmed kuuluvad praeguse töövoo käivituse juurde.

Inimese kinnituse ja sisendi abimeetodid

wait_for_approval() ja wait_for_input() on signaali ootamise mugavusümbrised. Need toimivad nagu wait_for_signal(), kuid kasutavad vaikimisi nimeruumiga tulemi võtit.

PHP
$workflow_id = Queuety::workflow( 'blog_review' )
    ->then( GenerateDraftHandler::class )
    ->wait_for_approval()
    ->wait_for_input()
    ->then( HandleDecisionHandler::class )
    ->dispatch();

Pärast signaali approval sisaldab $state['approval'] kinnituse andmeid. Pärast signaali input sisaldab $state['input'] sisendi andmeid.

Kasutage wait_for_decision()-i, kui soovite, et üks samm jätkuks nii kinnitamise kui ka tagasilükkamise korral:

PHP
$workflow_id = Queuety::workflow( 'legal_review' )
    ->then( DraftContractHandler::class )
    ->wait_for_decision( result_key: 'review' )
    ->then( HandleReviewDecisionHandler::class )
    ->dispatch();

Pärast signaali saabumist sisaldab $state['review'] järgmist:

PHP
[
    'outcome' => 'approved', // or 'rejected'
    'signal'  => 'approved', // or 'rejected'
    'data'    => [ 'reviewer' => 'ops@example.com' ],
]

Signaali saatmine

Saatke töövoole signaal, kasutades Queuety::signal()-i:

PHP
Queuety::signal( $workflow_id, 'approved' );

Kui signaal vastab sellele, mida töövoog ootab, jätkub töövoog ja liigub järgmise sammuni.

Inimese osalusega töövoogude jaoks pakub fassaad ka semantilisi abimeetodeid:

PHP
Queuety::approve_workflow( $workflow_id, [ 'reviewer' => 'editor@example.com' ] );
Queuety::reject_workflow( $workflow_id, [ 'reason' => 'needs citations' ] );
Queuety::submit_workflow_input( $workflow_id, [ 'notes' => 'Ship after copy edit' ] );

Signaaliandmed

Saate koos signaaliga edastada andmemassiivi. Andmed liidetakse töövoo olekuga ja tehakse järgmistele sammudele kättesaadavaks:

PHP
Queuety::signal( $workflow_id, 'approved', [
    'approved_by' => 'admin@example.com',
    'approved_at' => time(),
] );

Järgmises sammus:

PHP
class PublishContentHandler implements Step {
    public function handle( array $state ): array {
        // $state['approved_by'] is 'admin@example.com'
        // $state['approved_at'] is the timestamp
        // $state['post_id'] is 99
        wp_update_post( [
            'ID'          => $state['post_id'],
            'post_status' => 'publish',
        ] );
        return [ 'published' => true ];
    }

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

Alakriipsuga _ algavad võtmed on reserveeritud sisekasutuseks ning neid olekuga ei liideta.

Olemasolevad signaalid

Signaale saab saata enne, kui töövoog jõuab ootamise sammuni. Signaali saabumisel salvestatakse see tabelisse queuety_signals sõltumata töövoo praegusest olekust. Kui töövoog jõuab hiljem sammuni wait_for_signal, otsib see juba olemasolevaid signaale ja jätkub kohe, kui leiab sobiva.

See tähendab, et järjekord pole oluline:

PHP
// Dispatch workflow
$workflow_id = Queuety::workflow( 'order_fulfillment' )
    ->then( PrepareOrderHandler::class )
    ->wait_for_signal( 'payment_confirmed' )
    ->then( ShipOrderHandler::class )
    ->dispatch( [ 'order_id' => 123 ] );

// Signal arrives before the workflow reaches the wait step
Queuety::signal( $workflow_id, 'payment_confirmed', [ 'transaction_id' => 'txn_abc' ] );

// When the workflow finishes PrepareOrderHandler and reaches the wait step,
// it sees the pre-existing signal and continues immediately.

Töövoo olek signaali ootamise ajal

Signaali ootamise ajal on töövoo olek WorkflowStatus::WaitingForSignal (waiting_for_signal):

PHP
$state = Queuety::workflow_status( $workflow_id );
echo $state->status->value; // 'waiting_for_signal'
echo $state->wait_type;     // 'signal'
echo $state->wait_mode;     // 'all' or 'any'
print_r( $state->waiting_for ); // ['approved']
print_r( $state->wait_details ); // matched/remaining, correlation info, result key, ...

Kasutusjuht: inimese kinnitus

Koostage kinnituse töövoog, milles inimülevaataja peab sisu enne avaldamist kinnitama:

PHP
$workflow_id = Queuety::workflow( 'blog_review' )
    ->then( GenerateDraftHandler::class )
    ->then( NotifyReviewerHandler::class )
    ->wait_for_decision( result_key: 'review' )
    ->then( HandleDecisionHandler::class )
    ->dispatch( [ 'topic' => 'PHP middleware patterns' ] );

NotifyReviewerHandler saadab meili või Slack sõnumi, milles on kinnitamise või tagasilükkamise lingid. Need lingid kutsuvad välja teie kontrolleri, mis saadab signaali:

PHP
// In your approval controller
Queuety::approve_workflow(
    $workflow_id,
    [
        'reviewer'    => $current_user->user_email,
        'reviewed_at' => time(),
    ],
    'approved'
);

Samm HandleDecisionHandler loeb väärtust $state['review']['outcome'] ja kas avaldab mustandi või arhiveerib selle.

Kasutusjuht: välise API tagasikutse

Oodake välise teenuse veebikonksu:

PHP
$workflow_id = Queuety::workflow( 'generate_video' )
    ->then( SubmitToRenderServiceHandler::class )
    ->wait_for_signal( 'render_complete' )
    ->then( DownloadVideoHandler::class )
    ->then( NotifyUserHandler::class )
    ->dispatch( [ 'template_id' => 'promo_v2', 'user_id' => 42 ] );

Kui väline teenus saadab päringu teie veebikonksu lõpp-punkti:

PHP
// In your webhook handler
$payload = json_decode( file_get_contents( 'php://input' ), true );
$workflow_id = (int) $payload['metadata']['workflow_id'];

Queuety::signal( $workflow_id, 'render_complete', [
    'video_url'  => $payload['output_url'],
    'duration'   => $payload['duration_seconds'],
] );

Mitu signaalikontrollpunkti ühes töövoos

Töövoog saab signaale oodata mitmes kohas:

PHP
Queuety::workflow( 'multi_approval' )
    ->then( CreateProposalHandler::class )
    ->wait_for_signal( 'manager_approval' )
    ->then( EscalateToDirectorHandler::class )
    ->wait_for_signal( 'director_approval' )
    ->then( ExecuteProposalHandler::class )
    ->dispatch( [ 'proposal_id' => 7 ] );

Iga signaali ootamise samm on sõltumatu. Samas töövoos saate kombineerida wait_for_signal(), wait_for_signals(), wait_for_approval(), wait_for_input() ja wait_for_decision().