Liigu sisu juurde

Staatiline eeltöötlemine

Staatiline eeltöötlemine on vabatahtlik anonüümne HTML-puhver. Puhverdatav vastus peab olema täielik HTML-dokument ja sellest saab loobuda <!-- blockstudio:no-cache --> abil. Blockstudio jätab vaikimisi vahele mitteloetud päringud, päringustringid, WordPress haldusvaated, REST, Ajaxi, cron, vood, otsingutulemused, mis jäävad saidi avalehe otsingu põhitee alt välja (näiteks /search/term/), eelvaate- ja lõuendipäised, nonce’i sisaldavad päringud, määratud dünaamilised rajad, parooli/kommentaari küpsised ning sisselogitud päringud. Leht, mille tee sisaldab ainult sügavamal search või preview segmenti, näiteks /docs/blocks/preview/, puhverdatakse nagu iga teine leht.

JSON
{
  "performance": {
    "staticPrerender": {
      "enabled": true,
      "ttl": 3600,
      "invalidate": "graph",
      "earlyServe": true,
      "serveLoggedIn": false,
      "dynamicPaths": ["/account", "/checkout"],
      "replayHeaders": ["Link"],
      "warm": {
        "enabled": true,
        "interval": 900,
        "concurrency": 4,
        "transport": "http"
      }
    }
  }
}

Sisselogitud kasutajad saavad olemasolevat puhvervastust kasutada ainult siis, kui serveLoggedIn on tõene; isikupärastatud vastuseid ei salvestata kunagi puhvrisse. Dünaamiliste radade puhul arvestatakse teepiire, seega /account sobib /account/orders-ga, kuid mitte /accounting-ga.

Kui funktsioon on välja lülitatud, ei kirjuta see faile, paigalda lisakomponenti ega registreeri päringu- või halduskäitlejaid. earlyServe: false ei registreeri samuti Early Serve’i halduse tagasihelistamist ning warm.enabled: false ei registreeri cron tagasihelistamist ega ajastust. Kummagi funktsiooni väljalülitamisel eemaldatakse varem hallatud olek ühe korra; järgmistel päringutel ei tehta failisüsteemi ega cron puhastuskontrolle.

Keskkonnapõhine väljalülitamine

Kõiki ülaltoodud väärtusi saab määrata ka seadete filtri abil. Blockstudio käivitub enne aktiivset kujundust plugina või kujunduse Composer automaatlaaduri kaudu, mistõttu loeb see käitusaja seaded pärast kujunduse laadimist uuesti ning otsustab staatilise eeltöötlemise käitlejad registreerida alles etapis after_setup_theme. Seega rakendub plugina või kujunduse functions.php lisatud filter:

PHP
add_filter('blockstudio/settings/performance/staticPrerender/enabled', function ($enabled) {
    return 'local' === wp_get_environment_type() ? false : $enabled;
});

Funktsiooni sellisel viisil väljalülitamine toimib samamoodi nagu selle väljalülitamine blockstudio.json kaudu: päringu-, sisu-, haldus- ega cron käitlejaid ei registreerita ning varem varakult esitatud saidi Early Serve’i kirje eemaldatakse ühe korra. Hiljem lisatud filter, näiteks init ajal, ei muuda registreeritud käitlejaid.

Allkirja- ja graafirežiimid

Režiim signature täidab tavalisel anonüümsel puuduvasul identiteedipõhise vastuse. See sobib tavalistele WordPress-saitidele ja pöördub saidi taseme muudatuste järel.

Režiim graph on mõeldud deterministlike ehituse ja juurutuse integratsioonide jaoks. Kutsu Static_Prerender_Runtime::build_plan() välja aktiivsete lähte-URL-idega, renderda ainult affectedUrls ja salvesta iga tulemus funktsiooniga persist_built_response() või persist_skipped_response(). Plaan võrdleb jagatud faile ja iga lehe täpseid sõltuvuste räsi väärtusi. Kustutatud URL-id ja viitamata HTML eemaldab garbage_collect().

PHP
use Blockstudio\Static_Prerender_Runtime;

$plan = Static_Prerender_Runtime::build_plan($sourceUrls);

foreach ($plan['affectedUrls'] as $url) {
    $result = render_with_dependencies($url);

    Static_Prerender_Runtime::persist_built_response(
        $url,
        $result['html'],
        $result['files'],
        $result['virtualHashes']
    );
}

$targets = array_keys($plan['live']);
Static_Prerender_Runtime::garbage_collect($targets);

Valikulised sihtmasina ja avalehe argumendid kirjutavad juurutuse marsruudid ümber, kasutamata esimese lehe teed saidi juurena. Pakktööriistad saavad kasutada Static_Prerender_Batch_Renderer::render() ja püsivaid N/TOTAL jaotisi; jaotise valikut toetavad Static_Prerender_Batch_Renderer::parse_shard() ja select_shard(), et kutsuja saaks arvutada sama jaotuse, mida renderdaja kasutaks. Ehituse ajal näitab Static_Prerender_Batch_Renderer::is_rendering(), kas praegune päring on pakktöötlus, mitte külastaja päring, nii et mall saab ehituse ajal mittevajaliku töö vahele jätta. internal transpordi pakub üldine filter blockstudio/static_prerender/render_internal; valikuline HTTP tagavara kasutab tavalist soojenduspäist.

Mida graafirežiim jälgib

Vaikimisi transpordiga HTTP saadab Static_Prerender_Batch_Renderer::render() igale soojenduspäringule allkirjastatud loa ning päring teatab loetud failid: laaditud mall WordPress, iga renderdatud Blockstudio ploki mall, mallifailid ja varafailid, funktsiooniga blockstudio/render/dependencies lisatud failid ning sünkroonitud lehe korral selle määratlus-, malli-, sisu- ja paigutusfailid. Aruanne kirjutatakse saidi puhverkataloogi, mida renderdaja ja veebiserver juba jagavad renderdatud HTML jaoks. Järgmisel ehituskorral räsib build_plan() need failid uuesti ja märgib ainult nende failide muutumise tõttu muutunud marsruudid, uued marsruudid, ttl möödunud marsruudid ning kõik marsruudid, kui muutub jagatud fail (blockstudio.json, theme.json, style.css, functions.php, header.php, footer.php, kõik kaustas inc/, parts/ ja templates/ ning Blockstudio pakitud UI varade lähtefailid). Jagatud allkiri räsib lähtefaile, mitte kompileeritud väljundit, nii et _dist failid, mille ehituse esimene renderdus kompileerib, seda ei muuda: artifact_entry() tuletab ehituse ID samast allkirjast, mida build_plan() nägi enne renderdamist.

Ainult andmebaasis olev sisu ei ole fail ja seda ei jälgita: halduses muudetud postitused, suvandid, loodud read või hinnad. Kui ehitus peab sellised muudatused arvesse võtma, anna $force funktsioonile build_plan() või renderda mõjutatud URL-id ise. Transport internal salvestab sõltuvused, mille selle filter tagastab.

Varajane esitamine ja aatomiline juurutus

Kui earlyServe on lubatud, haldab Blockstudio väikest wp-content/blockstudio-static-prerender-map.php-i, advanced-cache.php lisakomponenti ja üht täpset WP_CACHE deklaratsiooni. Lisakomponent loeb saidipõhist marsruudikaarti ja voogedastab sobiva vaste enne WordPress, pluginate või kujunduse käivitamist.

Blockstudio ei kirjuta kunagi üle võõrast kaarti, lisakomponenti ega WP_CACHE deklaratsiooni. Graafi artefaktid kontrollivad enne kaardi vahetamist iga viidatud HTML faili. Kui kontroll ebaõnnestub, jääb aktiivseks eelmine graaf. Multisaidi kirjed jagavad kaarti, kuid on eraldatud hosti, avalehe tee ja saidi ID järgi. Funktsiooni väljalülitamisel või Blockstudio deaktiveerimisel eemaldatakse ainult praeguse saidi kirje; jagatud artefaktid eemaldatakse alles siis, kui viimane hallatud kirje on kadunud.

Juurutustööriistad saavad aktiveerida täielikult renderdatud graafi aatomiliselt:

PHP
$entry = Static_Prerender_Runtime::artifact_entry($targetUrls);

Blockstudio\Static_Prerender_Early_Serve::install_artifact_entry(
    $entry,
    Static_Prerender_Runtime::cache_root_path()
);

Seadistus jääb määravaks. install_artifact_entry() tagastab false, välja arvatud juhul, kui nii enabled kui ka earlyServe on tõesed. Nii ei saa juurutus paigaldada kaarti, lisakomponenti ega WP_CACHE deklaratsiooni, mille järgmine halduspäring uuesti eemaldaks.

install_artifact_entry() säilitab kirje build_id, et juurutus saaks seda võrrelda väärtusega, mille installed_map_entries() kirje hiljem tagastab. Kaart on PHP fail, mida loetakse funktsiooniga include, ja iga kirjutamise järel eemaldatakse see käskude vahemälust. Nii näeb lugemine uue kirje samas protsessis ka siis, kui opcache.enable_cli on sisse lülitatud.

Artefakti paigaldamine tõstab selle dokumendid spetsiaalsesse artefakti ulatusse, mida säilituspuhastus ei puuduta. Kaardil viidatud failid on väljatõstmise eest kaitstud olenemata nende asukohast, nii et renderduste liiklus ei saa aktiivseid marsruute varajasest esitamisest eemaldada. Marsruudi võti ei hõlma täielikult sisu räsi, mistõttu võib uuesti renderdamine dokumenti muuta ilma selle võtit muutmata. Paigaldamisel võrreldakse baite ja erinev artefaktdokument asendatakse aatomiliselt; identsed dokumendid jäetakse muutmata ning artefaktdokument säilitatakse ka siis, kui selle poe koopia on kadunud. Static_Prerender_Early_Serve::last_promotion() teatab, mitu marsruuti viimase paigalduse käigus esile tõsteti, asendati, vahele jäeti või alles hoiti, et juurutus saaks selle logida.

Salvestatud dokument fikseerib funktsiooniga URL lingitud ehitusvarad ning nendel failidel on eraldi säilituspoliitika, nii et üks võib teisest kauem alles olla. Enne esitamist kontrollivad nii PHP puhver kui ka lisakomponent, kas lingitud sisuräsiga Tailwind laaditabel on kettal alles. Kui laaditabel on kadunud, saadetakse dokument funktsioonile WordPress, selle asemel et esitada see kujunduseta; nii avaldatakse laaditabel ja dokument koos. Sama kontroll tehakse enne vastuse salvestamist, seega dokumenti, mida ei saa esitada, ei kirjutata kunagi kettale.

Päring, mille päis Accept sisaldab väärtust text/markdown, jätab vahele nii poe PHP kui ka lisakomponendi, sest salvestatud dokumendid on HTML ning leht võib vastata sellele päringule oma lähtega Markdown. Seega saadavad esitatud dokumendid päise Vary: Accept. Funktsiooni Blockstudio uuendamisel kirjutatakse vanem lisakomponent järgmisel kaardi kirjutamisel ümber.

Kaardistatud graafimarsruutide puhul kasutatakse alati aktiveeritud artefakti. Kui turvalist anonüümset marsruuti kaardil pole, kuid WordPress on selle vahepeal renderdanud ja püsivalt salvestanud, kasutab Early Serve enne WordPress käivitamist tagavarana identiteedipõhist käitusaja poodi. See toetab loodud või harva külastatavaid marsruute, mis jäävad teadlikult piiratud juurutusgraafist välja. Tagavara kasutab aktiveeritud graafi identiteeti ning samu hosti, tee normaliseerimise, TTL-i, küpsise, päise, päringustringi, dünaamilise tee ja voo vahelejätmise reegleid mis kaardistatud marsruudid. See leiab ainult käitusajal salvestatud dokumente, kuhu otsingutulemused kunagi ei kuulu.

Vastuse päised

Salvestatud dokumenti esitatakse uuesti ilma päringuta, mille tulemusel see renderdati, seega puuduks iga päringu vastusest päis, mille teema või plugin saadab koos header()-ga. Blockstudio salvestab koos iga dokumendiga päised, mille nimed on määratud replayHeaders-s, ning saadab need uuesti nii PHP vahemälust kui ka varajase esituse lisandmoodulist. Vaikimisi ["Link"] hõlmab selliseid päiseid nagu Markdown alternatiiv (rel="alternate"; type="text/markdown"), rel="describedby" või rel="canonical". Nimesid võrreldakse tõstutundetult ning seadistuse filter muudab loendit nagu iga muudki väärtust:

PHP
add_filter('blockstudio/settings/performance/staticPrerender/replayHeaders', function (array $headers): array {
    $headers[] = 'X-Robots-Tag';

    return $headers;
});

Päiste uuesti esitamise keelamiseks määra replayHeaders väärtuseks []. Selgesõnaline loend asendab vaikeväärtuse, seega lisa teiste päisenimede lisamisel ka Link, kui soovid lingipäiseid endiselt uuesti esitada.

Päised kogutakse lehte renderdavas protsessis: headers_list()-st siis, kui salvestatakse vahemälust puuduv reaalajas päring, ja soojenduspäringust endast siis, kui järk või soojendaja renderdab üle HTTP, nii et veebiserveri iseseisvalt lisatud päist, mille ta lisab uuesti igale esitatavale dokumendile, ei salvestata kunagi. Ainult siis, kui HTTP renderdamine aruannet ei kirjuta, kasutatakse selle vastuse päiseid. internal transport tagastab need tulemuses kujul headers ning persist_built_response() võtab need viimase argumendina kas Name: value ridadena või nime ja väärtuse vastendusena.

Need kirjutatakse dokumendi kõrvale faili <key>.headers.json, liiguvad koos sellega artefakti kasutuselevõtul, prügikoristusel ja säilitusaja kärpimisel ning eemaldatakse, kui uuel renderdamisel neid ei saadeta. Küpsise-, vahemälu- ja transpordipäiseid ei salvestata ega esitata kunagi uuesti, isegi kui need on loendis: Set-Cookie, Cache-Control, Expires, Pragma, Age, ETag, Last-Modified, Vary, Content-Type, Content-Length, Content-Encoding, Transfer-Encoding, Location, Status, Date ning hüppeliselt edastatavad ja autentimispäised. Esitatav dokument määrab ise oma Content-Type ja Vary.

Salvestatud päiseid kontrollitakse saatmisel uuesti loendi alusel. Vahemälu PHP loeb kehtiva seadistuse; lisandmoodul loeb koopiat saidi kaardikirjest, mida värskendatakse järgmise artefakti paigalduse või kaardi sünkroonimise käigus. Enne uuendust salvestatud dokumentidel pole päisefaili ja neid esitatakse täpselt nagu varem, kuni need uuesti renderdatakse.

Soojendamine, hooldus ja jälgitavus

Soe järjekord on püsiv, URL-koondav ja ühe päringuga ning taastab aegunud nõuded. Sisu- ja saidimuudatused käivitavad asendustöö ka siis, kui praegune allkiri ei muutu; intervallkäivitused lisavad järjekorda ainult aegunud tööd. Iga ajastatud või wp bs prerender warm kaudu käivitatud tsükkel renderdab kuni warm.concurrency tööd. Režiim graph lülitab iga URL soojendaja välja, sest graafi artefaktid luuakse ja aktiveeritakse ühe tervikuna.

Shell
wp bs prerender warm
wp bs prerender status
wp bs prerender purge
wp bs prerender map status
wp bs prerender map prune --dry-run

status teatab aktiivse identiteedi, failid, baidid, graafikirjed, järjekorra oleku, Early Serve’i kaardiaruande ning ulatusepõhised vaste-, möödalasu-, ehitus- ja tõrkeloendurid.

Early Serve’i kaart on paigalduse kõigi saitide vahel ühine. map status (ja Static_Prerender_Early_Serve::map_report()) loetleb kirjed, mida varajane esitamine enam kasutada ei saa: orphaned kirjed, mille saiti pole enam olemas, ning dead kirjed, mille kataloog on kadunud, samuti allesjäänud kirjete missing marsruudidokumentide arvu. map prune (Static_Prerender_Early_Serve::prune_map()) eemaldab kaardiluku all orvuks jäänud ja surnud kirjed ning esitab iga eemaldamise põhjuse; --dry-run üksnes kuvab aruande. Viimase kirje eemaldamisel kustutatakse kaart, lisakomponent ja WP_CACHE deklaratsioon. Multisaidivõrgustikust saidi kustutamisel eemaldatakse selle kirjed kohe. Puhvri puhastus ei kogu aktiveeritud artefakti nimeruumi, kust seda esitatakse, mistõttu muutuvad kirjed kasutuskõlbmatuks ainult siis, kui failid muul viisil eemaldatakse.

Üksikute vastuste tulemuste jälgimiseks kasutage blockstudio/static_prerender/outcome ning kõigi jagatud puhvritulemuste jälgimiseks blockstudio/cache/outcome.

Eemaldamine

Paigaldustes, kus pole plugina deaktiveerimiskäitlejat, näiteks paketiga Composer komplekteeritud seadistustes, saab kõik funktsiooni hallatavad osad ühe käsuga eemaldada:

Shell
wp bs teardown

See eemaldab cron sündmused ja paigalduse hallatava staatilise eeltöötlemise oleku: praeguse saidi kaardikirje ning jagatud lisakomponendi ja WP_CACHE deklaratsiooni, kui viimane hallatud kirje on kadunud. Seadistusfailid jäetakse puutumata, nii et funktsiooni saab puhtalt uuesti lubada.

Kasutuselevõtt tootmiskeskkonnas

Mõistlik kasutuselevõtu järjekord:

  1. Määra performance.profile väärtuseks speed, seejärel kontrolli päise väljundit, vooge ning kõiki pluginaid, mis kasutavad oEmbedi või XML-RPC.
  2. Loo assets/media.json, teisalda mallid asukohta bs_media_image() ja lülita seejärel sisse performance.media.lazy.
  3. Luba performance.staticPrerender, kui earlyServe on välja lülitatud; kontrolli vasteid funktsiooniga wp bs prerender status ja lülita siis sisse earlyServe.

Tagasipööramine käib funktsioonide kaupa: kui määrad staticPrerender.enabled väärtuseks false, eemaldatakse Blockstudio hallatavad Early Serve’i olek ja soojendusgraafikud ühe korra ning eeltöötlemise käituskeskkond jääb registreerimata. Kui määrad performance.profile uuesti väärtuseks compat, tühistatakse profiil. Kumbki jätab teised kihid alles.

Jõudlus

Profiilid, profileerija ja nende aluseks olevad renderdustehnikad.

Puhverdamine

Üks puhverkataloog kõigi loodud artefaktide jaoks.