Първи стъпки

Инсталиране

Изисквания

• PHP 8.2 или по-нова версия и WordPress 6.4 или по-нова версия
• MySQL 8.0+ или MariaDB 10.6+. Работниците заемат задачи и графици с настъпил срок чрез SELECT ... FOR UPDATE SKIP LOCKED, което по-старите сървъри отхвърлят със синтактична грешка.
• mysqli или pdo_mysql (вижте по-долу)
• WP-CLI на сървъра, ако използвате специализирани работници с wp queuety work
• Разширенията pcntl и posix PHP, ако използвате пулове от работници с --workers или --min-workers/--max-workers

Queuety изисква или mysqli, или pdo_mysql в средата за изпълнение PHP, която зарежда WordPress и WP-CLI. Автоматично избира драйвера, като предпочита mysqli за среди за изпълнение WordPress и запазва pdo_mysql за самостоятелно или директно използване на средата за изпълнение.

Ако искате среда за изпълнение, която използва базата данни, без слоя на плъгина WordPress, вижте Самостоятелно използване. Този подход използва същата връзка и таблици на средата за изпълнение, но не включва мостовете за хукове WordPress или регистрацията WP-CLI.

От ZIP архива на изданието

Всяко издание на GitHub съдържа ресурс queuety.zip: плъгина с вече инсталирани зависимости Composer. Инсталирайте най-новата версия с WP-CLI:

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

Можете също да изтеглите ZIP архива и да го качите от Разширения > Добавяне на ново > Качване на разширение. Това е най-лесният начин за стандартен сайт WordPress.

Чрез Composer за Composer, управлявано с WordPress

composer require queuety/queuety

След това активирайте плъгина:

wp plugin activate queuety

Типът на пакета е wordpress-plugin. Composer го поставя в директорията с плъгини само когато проектът изисква composer/installers и съпоставя този тип с път за инсталиране, както прави Bedrock, а проектът трябва да зареди собствен vendor/autoload.php (Bedrock също го прави). Без composer/installers, Composer го инсталира в vendor/queuety/queuety, където WordPress не го намира, затова при обикновена инсталация на WordPress използвайте ZIP архива на изданието.

От изходния код по време на разработка

Поставете хранилището в wp-content/plugins/queuety, след което инсталирайте зависимостите PHP:

composer install
wp plugin activate queuety

При активиране Queuety създава таблиците си в базата данни (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), така че работниците да могат директно да заемат задачи от MySQL.

По подразбиране плъгинът също насрочва еднократен работник чрез WordPress cron всяка минута за опашката default. Така получавате базова обработка без команден ред за задачи и работни процеси, които остават в default, стига WordPress cron да се задейства. Всяко изпълнение обработва най-много една задача и не задейства повтарящи се графици, не възстановява остарели задачи и не проверява крайни срокове на работни процеси; тези действия се извършват само в дълго работещ процес wp queuety work (#14). За персонализирани опашки, повтарящи се графици, по-ниска латентност или по-голямо натоварване преминете към специализирани процеси wp queuety work.

Конфигурация

Всички константи не са задължителни. Дефинирайте ги в wp-config.php, преди да се зареди плъгинът, или преди стартирането на Queuety при вградена инсталация в стил тема:

Константите за допускане на ресурси и адаптивни пулове (QUEUETY_RESOURCE_*, QUEUETY_WORKER_POOL_*) са посочени на страницата Работници.

QUEUETY_TABLE_PREFIX променя само частта Queuety от имената на таблиците. Префиксът на базата данни WordPress все още се добавя към резултата, така че $wpdb->prefix = 'wp_' и QUEUETY_TABLE_PREFIX = 'themequeue_' създават таблици като wp_themequeue_jobs. Изрично зададените константи QUEUETY_TABLE_* все така имат предимство за отделните таблици.

За самостоятелните връзки можете също да зададете префикса на таблиците Queuety за всяка връзка:

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

Така префиксът на базата данни WordPress остава непокътнат и се променя само сегментът на таблицата Queuety.

Първата ви задача

Създайте клас за обработка, който имплементира интерфейса 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,
        ];
    }
}

Регистрирайте го и разпределете задачата:

use Queuety\Queuety;

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

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

Или използвайте съвременния клас на задача за разпределяне:

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!' );

Първият ви работен процес

Дефинирайте обработчици за стъпките, които имплементират интерфейса 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 [];
    }
}

Разпределете работния процес:

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

Стартиране на работник

wp queuety work

Работникът проверява за чакащи задачи, изпълнява ги, придвижва работните процеси напред и изчаква, когато опашката е празна. Натиснете Ctrl+C, за да го спрете; процесът се прекратява незабавно, дори ако дадена задача е по средата на изпълнение (вижте Работници).

Задачите от горния SendEmailHandler се изпращат към опашката emails чрез config(), затова работник, който следи default, няма да ги поеме. Посочете всички опашки, които използвате:

wp queuety work --queue=emails,default

Ако не стартирате специализиран работник, Queuety все пак разполага с описания по-горе резервен механизъм WordPress cron, който се задейства веднъж в минута и е ограничен до опашката default и една задача на изпълнение. Специализираният работник осигурява по-голяма пропускателна способност и по-ниска латентност.

За продукционна среда стартирайте няколко работници:

wp queuety work --workers=4

Обработвайте няколко опашки с подредба по приоритет:

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

Какво следва

• Задачи за пълното ръководство за разпределяне и обработчици
• Работни процеси за вериги, паралелни стъпки, условно разклоняване и изпълнение на работни процеси
• Междинен софтуер за ограничаване на честотата, регулиране на натоварването и персонализирана логика на конвейера
• Пакетна обработка за разпределяне на групи задачи с обратни извиквания
• Поточни стъпки за запазване на поточните данни на части
• Планиране за повтарящи се задачи
• Кеширане за разширяемия слой на кеша
• Тестване за QueueFake и твърденията при тестване
• Справочник CLI за всички налични команди
• PHP API за програмен достъп