Aloitus

Asennus

Vaatimukset

• PHP 8.2 tai uudempi ja WordPress 6.4 tai uudempi
• MySQL 8.0+ tai MariaDB 10.6+. Työntekijät varaavat työt ja erääntyneet ajastukset käyttämällä SELECT ... FOR UPDATE SKIP LOCKED-toimintoa, jonka vanhemmat palvelimet hylkäävät syntaksivirheellä.
• mysqli tai pdo_mysql (katso alla)
• Palvelimella on oltava WP-CLI, jos suoritat erillisiä työntekijöitä komennolla wp queuety work
• pcntl- ja posix-laajennusten PHP on oltava käytössä, jos suoritat työntekijäpooleja asetuksilla --workers tai --min-workers/--max-workers

Queuety tarvitsee joko mysqli- tai pdo_mysql-ajurin PHP-suoritusympäristössä, joka lataa WordPressn ja WP-CLIn. Se valitsee ajurin automaattisesti: WordPress-suoritusympäristöissä suositaan mysqlita, kun taas pdo_mysql säilyy käytettävissä itsenäiseen tai suoraan suoritusympäristön käyttöön.

Jos haluat tietokantapohjaisen suoritusympäristön ilman WordPress-lisäosakerrosta, katso kohta Itsenäinen käyttö. Tässä ratkaisussa käytetään samoja yhteys- ja suoritusympäristötauluja, mutta se ei sisällä WordPress-koukkusiltoja tai WP-CLI-rekisteröintiä.

Julkaisuarkistosta

Jokaisessa GitHubn julkaisussa on queuety.zip-paketti: lisäosa, jonka Composer-riippuvuudet on jo asennettu. Asenna uusin versio komennolla WP-CLI:

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

Voit myös ladata zip-tiedoston ja lähettää sen kohdassa Plugins > Add New > Upload Plugin. Tämä on yksinkertaisin vaihtoehto tavalliselle WordPress-sivustolle.

Composern kautta Composer-hallittuihin WordPress-ympäristöihin

composer require queuety/queuety

Aktivoi sitten lisäosa:

wp plugin activate queuety

Pakettityyppi on wordpress-plugin. Composer sijoittaa sen lisäosahakemistoon vain, jos projekti edellyttää composer/installersa ja määrittää tämän pakettityypin asennuspolkuun, kuten Bedrock tekee. Projektin on myös ladattava oma vendor/autoload.phpnsa, minkä Bedrockkin tekee. Ilman composer/installersta Composer asentaa paketin kohteeseen vendor/queuety/queuety, josta WordPress ei löydä sitä, joten käytä julkaisuarkiston zip-tiedostoa tavallisessa WordPress-asennuksessa.

Lähdekoodista kehityksen aikana

Sijoita repositorio kohteeseen wp-content/plugins/queuety ja asenna sitten PHP-riippuvuudet:

composer install
wp plugin activate queuety

Aktivoinnin yhteydessä Queuety luo tietokantataulunsa (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), jotta työntekijät voivat varata töitä suoraan kohteesta MySQL.

Oletusarvoisesti lisäosa ajastaa myös kertaluonteisen työntekijän suorituksen joka minuutti käyttämällä WordPressn cron-toimintoa jonolle default. Näin saat komentoriviä käyttämättömän perustason töille ja työnkuluille, jotka toimivat kohteessa default, kunhan WordPressn cron toimii. Kukin suoritus käsittelee enintään yhden työn. Se ei suorita toistuvia ajastuksia, palauta vanhentuneita töitä tai tarkista työnkulkujen määräaikoja; nämä tehtävät suoritetaan vain pitkään käynnissä olevassa wp queuety work-prosessissa (#14). Siirry erillisiin wp queuety work-prosesseihin, jos käytät mukautettuja jonoja tai toistuvia ajastuksia, tarvitset pienemmän viiveen tai käsittelet raskaita työkuormia.

Määritykset

Kaikki vakiot ovat valinnaisia. Määritä ne kohteessa wp-config.php ennen lisäosan lataamista tai ennen kuin Queuety käynnistyy upotetussa teematyyppisessä asennuksessa:

Resurssien hyväksyntään ja mukautuvaan pooliin liittyvät vakiot (QUEUETY_RESOURCE_*, QUEUETY_WORKER_POOL_*) on lueteltu Workers-sivulla.

QUEUETY_TABLE_PREFIX muuttaa vain taulujen nimien Queuety-osaa. WordPress-tietokannan etuliite ympäröi tuloksen edelleen, joten $wpdb->prefix = 'wp_' ja QUEUETY_TABLE_PREFIX = 'themequeue_' tuottavat esimerkiksi tauluja kuten wp_themequeue_jobs. Yksittäisten taulujen eksplisiittiset QUEUETY_TABLE_*-vakiot ovat silti etusijalla.

Myös erilliset yhteydet voivat määrittää taulujen Queuety-etuliitteen yhteyskohtaisesti:

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

Näin WordPress-tietokannan etuliite säilyy ennallaan ja vain taulun Queuety-osa muuttuu.

Ensimmäinen työsi

Luo käsittelijäluokka, joka toteuttaa Handler-rajapinnan:

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,
        ];
    }
}

Rekisteröi se ja lähetä työ suoritettavaksi:

use Queuety\Queuety;

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

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

Tai käytä nykyaikaista lähetettävää työluokkaa:

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

Ensimmäinen työnkulkusi

Määritä vaihekäsittelijät, jotka toteuttavat Step-rajapinnan:

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 [];
    }
}

Lähetä työnkulku suoritettavaksi:

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

Käynnistä työntekijä

wp queuety work

Työntekijä hakee odottavia töitä, suorittaa ne, vie työnkulkuja eteenpäin ja odottaa, kun jono on tyhjä. Pysäytä painamalla Ctrl+C; tämä päättää prosessin heti, myös kesken työn (katso Workers).

Edellä kuvattu SendEmailHandler lähettää työnsä emails-jonoon käyttäen config(), joten jonossa default toimiva työntekijä ei poimi niitä. Nimeä kaikki käyttämäsi jonot:

wp queuety work --queue=emails,default

Jos et suorita erillistä työntekijää, Queuety käyttää silti edellä kuvattua oletusarvoista kerran minuutissa toimivaa WordPress cron -vararatkaisua, joka on rajattu default-jonoon ja yhteen työhön suorituskertaa kohden. Erillinen työntekijä tarjoaa suuremman läpimenon ja pienemmän viiveen.

Suorita tuotantoympäristössä useita työntekijöitä:

wp queuety work --workers=4

Käsittele useita jonoja prioriteettijärjestyksessä:

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

Seuraavaksi

• Työt: täydellinen opas töiden lähettämiseen ja käsittelijöihin
• Työnkulut: ketjut, rinnakkaiset vaiheet, ehdollinen haarautuminen ja työnkulkujen suorittaminen
• Väliohjelmistot: nopeusrajoitus, rajoittaminen ja mukautettu putkilogiikka
• Eräkäsittely: työryhmien lähettäminen takaisinkutsujen kanssa
• Suoratoistovaiheet: suoratoistettujen tietojen tallentaminen pala palalta
• Aikataulutus: toistuvat työt
• Välimuistitus: liitettävä välimuistikerros
• Testaus: QueueFake ja testiväittämät
• CLI Viite: kaikki käytettävissä olevat komennot
• PHP API: ohjelmallinen käyttö