Začínáme

Instalace

Požadavky

• PHP 8.2 nebo novější a WordPress 6.4 nebo novější
• MySQL 8.0+ nebo MariaDB 10.6+. Pracovní procesy si přebírají úlohy a splatné plány pomocí SELECT ... FOR UPDATE SKIP LOCKED, které starší servery odmítají kvůli syntaktické chybě.
• mysqli nebo pdo_mysql (viz níže)
• WP-CLI na serveru, pokud používáte vyhrazené pracovní procesy s wp queuety work
• Rozšíření pcntl a posix PHP, pokud používáte fondy pracovních procesů s --workers nebo --min-workers/--max-workers

Queuety vyžaduje v běhovém prostředí PHP, které načítá WordPress a WP-CLI, buď mysqli, nebo pdo_mysql. Ovladač vybírá automaticky: v běhových prostředích WordPress upřednostňuje mysqli a pro samostatné či přímé použití ponechává k dispozici pdo_mysql.

Pokud chcete běhové prostředí založené na databázi bez vrstvy pluginu WordPress, podívejte se na Samostatné použití. Využívá stejné připojení a tabulky běhového prostředí, ale neobsahuje mosty hooků WordPress ani registraci WP-CLI.

Z archivu vydání

Každé vydání GitHub obsahuje soubor queuety.zip: plugin s již nainstalovanými závislostmi Composer. Nejnovější verzi nainstalujete pomocí WP-CLI:

wp plugin install https://github.com/inline0/queuety/releases/latest/download/queuety.zip --activate

Nebo stáhněte archiv ZIP a nahrajte jej v části Pluginy > Přidat nový > Nahrát plugin. Pro běžný web WordPress je to nejjednodušší postup.

Pomocí Composer pro Composer spravovaný systém WordPress

composer require queuety/queuety

Poté plugin aktivujte:

wp plugin activate queuety

Typ balíčku je wordpress-plugin. Composer jej umístí do adresáře pluginů pouze tehdy, když projekt vyžaduje composer/installers a přiřadí tento typ k cestě instalace, jako to dělá Bedrock; projekt také musí načíst vlastní vendor/autoload.php (stejně jako Bedrock). Bez composer/installers jej Composer nainstaluje do vendor/queuety/queuety, kde jej WordPress nenajde. Při běžné instalaci WordPress proto použijte archiv ZIP z vydání.

Ze zdrojového kódu během vývoje

Umístěte repozitář do wp-content/plugins/queuety a potom nainstalujte závislosti PHP:

composer install
wp plugin activate queuety

Při aktivaci Queuety vytvoří své databázové tabulky (queuety_jobs, queuety_workflows, queuety_logs, queuety_schedules, queuety_queue_states, queuety_webhooks, queuety_locks, queuety_signals, queuety_workflow_dependencies, queuety_workflow_dispatch_keys, queuety_batches, queuety_chunks, queuety_workflow_events, queuety_artifacts, queuety_state_machines, queuety_state_machine_events), aby pracovní procesy mohly přebírat úlohy přímo z MySQL.

Ve výchozím nastavení plugin také každou minutu plánuje jednorázový pracovní proces přes WordPress cron pro frontu default. Získáte tak základní řešení bez shellu pro úlohy a pracovní postupy běžící na default, pokud se spouští WordPress cron. Každé spuštění zpracuje nejvýše jednu úlohu a nespouští opakované plány, neobnovuje zastaralé úlohy ani nekontroluje termíny pracovních postupů; tyto činnosti probíhají pouze v dlouho běžícím procesu wp queuety work (#14). U vlastních front, opakovaných plánů, nižší latence nebo větší zátěže přejděte na vyhrazené procesy wp queuety work.

Konfigurace

Všechny konstanty jsou nepovinné. Definujte je v wp-config.php před načtením pluginu, případně před spuštěním Queuety při instalaci vložené do šablony:

Konstanty pro přijímání úloh podle dostupných zdrojů a adaptivní fondy (QUEUETY_RESOURCE_*, QUEUETY_WORKER_POOL_*) najdete na stránce Pracovní procesy.

QUEUETY_TABLE_PREFIX mění pouze část názvů tabulek Queuety. Databázový prefix WordPress se k výsledku stále připojí, takže $wpdb->prefix = 'wp_' a QUEUETY_TABLE_PREFIX = 'themequeue_' vytvoří tabulky, například wp_themequeue_jobs. Pro jednotlivé tabulky mají přednost explicitní konstanty QUEUETY_TABLE_*.

Samostatná připojení mohou také nastavit prefix tabulek Queuety pro každé připojení:

$conn = new Connection(
    host: '127.0.0.1:3306',
    dbname: 'wordpress',
    user: 'root',
    password: 'secret',
    prefix: 'wp_',
    table_prefix: 'themequeue_',
);

Tím zůstane databázový prefix WordPress zachován a změní se pouze část názvu tabulky Queuety.

Vaše první úloha

Vytvořte třídu obslužné rutiny, která implementuje rozhraní Handler:

use Queuety\Handler;

class SendEmailHandler implements Handler {
    public function handle( array $payload ): void {
        wp_mail( $payload['to'], $payload['subject'], $payload['body'] );
    }

    public function config(): array {
        return [
            'queue'           => 'emails',
            'max_attempts'    => 5,
        ];
    }
}

Zaregistrujte ji a odešlete úlohu:

use Queuety\Queuety;

Queuety::register( 'send_email', SendEmailHandler::class );

Queuety::dispatch( 'send_email', [
    'to'      => 'user@example.com',
    'subject' => 'Welcome',
    'body'    => 'Hello from Queuety!',
] );

Nebo použijte moderní třídu úlohy, kterou lze odesílat:

use Queuety\Contracts\Job;
use Queuety\Dispatchable;

readonly class SendEmailJob implements Job {
    use Dispatchable;

    public function __construct(
        public string $to,
        public string $subject,
        public string $body,
    ) {}

    public function handle(): void {
        wp_mail( $this->to, $this->subject, $this->body );
    }
}

SendEmailJob::dispatch( 'user@example.com', 'Welcome', 'Hello from Queuety!' );

Váš první pracovní postup

Definujte obslužné rutiny kroků, které implementují rozhraní Step:

use Queuety\Step;

class FetchDataHandler implements Step {
    public function handle( array $state ): array {
        $user = get_user_by( 'ID', $state['user_id'] );
        return [ 'user_name' => $user->display_name ];
    }

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

class CallLLMHandler implements Step {
    public function handle( array $state ): array {
        $response = wp_remote_post( 'https://api.openai.com/v1/chat/completions', [
            'body' => json_encode( [ 'prompt' => "Generate report for {$state['user_name']}" ] ),
        ] );
        return [ 'llm_response' => wp_remote_retrieve_body( $response ) ];
    }

    public function config(): array {
        return [ 'max_attempts' => 5 ];
    }
}

class FormatOutputHandler implements Step {
    public function handle( array $state ): array {
        $url = save_report( $state['user_name'], $state['llm_response'] );
        return [ 'report_url' => $url ];
    }

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

Odešlete pracovní postup:

$workflow_id = Queuety::workflow( 'generate_report' )
    ->then( FetchDataHandler::class )
    ->then( CallLLMHandler::class )
    ->then( FormatOutputHandler::class )
    ->dispatch( [ 'user_id' => 42 ] );

Spuštění pracovního procesu

wp queuety work

Pracovní proces vyhledává čekající úlohy, spouští je, posouvá pracovní postupy dál a při prázdné frontě čeká. Zastavíte jej stisknutím Ctrl+C; proces se ukončí okamžitě, i uprostřed úlohy (viz Pracovní procesy).

Výše uvedená úloha SendEmailHandler se pomocí config() odesílá do fronty emails, takže ji pracovní proces naslouchající na default nepřevezme. Uveďte název každé používané fronty:

wp queuety work --queue=emails,default

Pokud nespustíte vyhrazený pracovní proces, Queuety stále nabízí výše popsané záložní řešení WordPress cron, které se ve výchozím nastavení spouští jednou za minutu. Je omezeno na frontu default a jednu úlohu na spuštění. Vyhrazený pracovní proces nabízí vyšší propustnost a nižší latenci.

Pro produkční prostředí spusťte více pracovních procesů:

wp queuety work --workers=4

Zpracovávejte více front v pořadí podle priority:

wp queuety work --queue=high,default,low

Další kroky

• Úlohy – kompletní průvodce odesíláním úloh a obslužnými rutinami
• Pracovní postupy – řetězce, paralelní kroky, podmíněné větvení a spouštění pracovních postupů
• Middleware – omezování rychlosti, throttling a vlastní logika zpracování
• Dávkové zpracování – odesílání skupin úloh se zpětnými voláními
• Streamované kroky – trvalé ukládání streamovaných dat po jednotlivých blocích
• Plánování – opakované úlohy
• Ukládání do mezipaměti – připojitelná vrstva mezipaměti
• Testování – QueueFake a aserce v testech
• Referenční příručka CLI – všechny dostupné příkazy
• PHP API – programový přístup