Preskočiť na obsah

Statické predgenerovanie

Statické predgenerovanie je voliteľná anonymná vyrovnávacia pamäť HTML. Odpoveď, ktorú možno uložiť do vyrovnávacej pamäte, musí byť úplným dokumentom HTML a môže sa z tohto ukladania vylúčiť pomocou <!-- blockstudio:no-cache -->. Blockstudio obchádza požiadavky, ktoré nie sú GET, reťazce dopytu, administráciu WordPress, REST, Ajax, cron, kanály, výsledky vyhľadávania mimo základnej cesty vyhľadávania na domovskej ceste webu (napríklad /search/term/), hlavičky náhľadu a plátna, požiadavky s nonce, deklarované dynamické cesty, súbory cookie pre heslo alebo komentáre a prihlásené požiadavky. Stránka, ktorej cesta obsahuje segment search alebo preview až hlbšie v ceste, napríklad /docs/blocks/preview/, sa ukladá rovnako ako každá iná stránka.

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"
      }
    }
  }
}

Prihlásení používatelia môžu načítať existujúci záznam iba vtedy, ak je serveLoggedIn pravdivé; personalizované odpovede nikdy nevytvárajú záznamy vo vyrovnávacej pamäti. Dynamické cesty používajú hranice segmentov, takže /account zodpovedá /account/orders, ale nie /accounting.

Keď je funkcia vypnutá, nezapisuje žiadne súbory, neinštaluje žiadny doplnkový súbor a neregistruje žiadne háky požiadaviek ani administrácie. earlyServe: false takisto neregistruje administratívne spätné volanie pre skoré poskytovanie a warm.enabled: false neregistruje žiadne spätné volanie cron ani plán. Vypnutím ktorejkoľvek funkcie sa raz odstráni predtým spravovaný stav; pri ďalších požiadavkách sa už nekontroluje čistenie súborového systému ani cron.

Vypnutie v konkrétnom prostredí

Každú z vyššie uvedených hodnôt možno nastaviť aj filtrom nastavení. Blockstudio sa spúšťa pred aktívnou témou, a to z pluginu alebo z automatického načítania Composer témy. Po načítaní témy preto znova vyhodnotí nastavenia prostredia a o hákoch statického predgenerovania rozhodne v after_setup_theme. Filter pridaný pluginom alebo do súboru functions.php témy sa teda uplatní:

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

Vypnutie funkcie týmto spôsobom funguje rovnako ako jej vypnutie v blockstudio.json: neregistrujú sa žiadne háky požiadaviek, obsahu, administrácie ani cron a záznam pre skoré poskytovanie, ktorý sa na stránke predtým používal, sa raz odstráni. Filter pridaný neskôr, napríklad pri init, nemení zaregistrované háky.

Režimy podpisu a grafu

Režim signature vytvára odpoveď s kľúčom identity pri bežnom výpadku anonymnej požiadavky. Je vhodný pre bežné weby WordPress a po zmenách na úrovni webu sa obnoví.

Režim graph je určený na deterministické integrácie zostavenia a nasadenia. Zavolajte Static_Prerender_Runtime::build_plan() so zdrojovými URL adresami, vykreslite iba affectedUrls a potom zaznamenajte každý výsledok pomocou persist_built_response() alebo persist_skipped_response(). Plán porovnáva zdieľané súbory a presné hodnoty hashov závislostí každej stránky. Odstránené URL adresy a nepoužívané HTML odstráni 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);

Voliteľné argumenty cieľového hostiteľa a domovskej cesty upravujú trasy pre nasadenie bez toho, aby sa cesta prvej stránky použila ako koreň webu. Dávkové nástroje môžu používať Static_Prerender_Batch_Renderer::render() a stabilné časti N/TOTAL; možnosť rozdelenia na časti využíva Static_Prerender_Batch_Renderer::parse_shard() a select_shard(), takže volajúci môže vypočítať rovnaké rozdelenie, aké by použilo vykresľovanie. Vo vnútri zostavenia Static_Prerender_Batch_Renderer::is_rendering() určuje, či ide o dávkové vykresľovanie, a nie o návštevu, takže šablóna môže preskočiť úlohy, ktoré sa počas zostavenia nemajú spúšťať. Prenos internal poskytuje všeobecný filter blockstudio/static_prerender/render_internal; voliteľný záložný režim HTTP používa bežnú hlavičku na predohrev.

Čo sleduje režim grafu

Pri predvolenom prenose HTTP posiela Static_Prerender_Batch_Renderer::render() každej požiadavke na predohrev podpísaný token a požiadavka hlási súbory, ktoré načítala: šablónu WordPress, každý blok Blockstudio, ktorý bol vykreslený, jeho šablónu, súbory šablón a súbory zdrojov, súbory pridané cez blockstudio/render/dependencies a pri synchronizovanej stránke aj jej definičné, šablónové, obsahové a rozložené súbory. Hlásenie sa zapisuje do adresára vyrovnávacej pamäte webu, ktorý už zdieľajú vykresľovacie prostredie a webový server pre vykreslený HTML. Pri ďalšom zostavení build_plan() znova vypočíta hodnoty hashov týchto súborov a označí iba trasy, ktorých súbory sa zmenili, spolu s novými trasami, trasami po uplynutí ich ttl a všetkými trasami pri zmene zdieľaného súboru (blockstudio.json, theme.json, style.css, functions.php, header.php, footer.php, všetko v inc/, parts/, templates/ a zdroje zabalených prostriedkov UI patriacich Blockstudio). Zdieľaný podpis počíta hash zdrojov, nikdy kompilovaného výstupu, takže súbory _dist, ktoré sa skompilujú pri prvom vykreslení zostavenia, ho nemenia: artifact_entry() odvodzuje ID zostavenia z rovnakého podpisu, aký build_plan() zaznamenal pred vykreslením.

Obsah, ktorý existuje iba v databáze, nie je súborom a nesleduje sa: príspevky upravené v administrácii, možnosti, vygenerované riadky ani ceny. Zostavenie, ktoré musí tieto zmeny zachytiť, odovzdá $force funkcii build_plan() alebo samo vykreslí dotknuté URL adresy. Prenos internal zaznamenáva závislosti vrátené jeho filtrom.

Skoré poskytovanie a atómové nasadenie

Keď je zapnuté earlyServe, Blockstudio spravuje malý súbor wp-content/blockstudio-static-prerender-map.php, doplnkový súbor advanced-cache.php a jedno presné vyhlásenie WP_CACHE. Doplnkový súbor načíta mapu trás pre daný web a odošle vhodný záznam ešte pred spustením WordPress, pluginov alebo témy.

Blockstudio nikdy neprepíše cudziu mapu, doplnkový súbor ani vyhlásenie WP_CACHE. Artefakty grafu pred výmenou mapy overia každý odkazovaný súbor HTML; ak overenie zlyhá, predchádzajúci graf zostane aktívny. Položky viacerých webov zdieľajú mapu, ale sú oddelené podľa hostiteľa, domovskej cesty a ID webu. Vypnutím funkcie alebo deaktiváciou Blockstudio sa odstráni iba položka aktuálneho webu a zdieľané artefakty sa odstránia až po zániku poslednej spravovanej položky.

Nástroje na nasadenie môžu atómovo aktivovať úplne vykreslený graf:

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

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

Konfigurácia zostáva rozhodujúca. install_artifact_entry() vráti false, pokiaľ nie sú pravdivé súčasne enabled aj earlyServe, takže nasadenie nikdy nenainštaluje mapu, doplnkový súbor a vyhlásenie WP_CACHE, ktoré by ďalšia administrátorská požiadavka opäť odstránila.

install_artifact_entry() zachováva hodnotu build_id položky, aby ju nasadenie mohlo porovnať s hodnotou, ktorú položka vráti cez installed_map_entries(). Mapa je súbor PHP, ktorý sa číta pomocou include, a každý zápis ho odstráni z vyrovnávacej pamäte operačných kódov, takže čítanie v tom istom procese uvidí novú položku, aj keď je zapnuté opcache.enable_cli.

Pri inštalácii artefaktu sa jeho dokumenty presunú do vyhradeného rozsahu artefaktu, ktorého sa čistenie podľa pravidiel uchovávania nikdy nedotkne. Súbory odkazované mapou sú chránené pred odstránením bez ohľadu na to, kde sa nachádzajú, takže ich aktívna prevádzka vykresľovania nemôže vyradiť z máp trás používaných pri skorom poskytovaní. Kľúč trasy neobsahuje celý obsahový hash, preto môže opätovné vykreslenie zmeniť dokument bez zmeny jeho kľúča. Inštalácia porovná bajty a odlišný dokument artefaktu atómovo nahradí, zhodné dokumenty ponechá bez zmeny a zachová dokument artefaktu, ktorého kópia v úložisku zmizla. Static_Prerender_Early_Serve::last_promotion() uvádza počet trás, ktoré posledná inštalácia presunula, nahradila, preskočila alebo zachovala, takže ho nasadenie môže zaznamenať do protokolu.

Uložený dokument pripína prostriedky zostavenia, na ktoré odkazuje pomocou URL; každý z nich má vlastné pravidlá uchovávania, takže jedno môže prežiť druhé. Pred odoslaním kontrolujú vyrovnávacia pamäť PHP aj doplnkový súbor, či prepojený hárok štýlov Tailwind s hashom obsahu stále existuje na disku. Ak hárok štýlov chýba, dokument sa odovzdá funkcii WordPress namiesto odoslania bez štýlov; tá znovu zverejní hárok aj dokument. Rovnaká kontrola prebehne pred uložením odpovede, takže dokument, ktorý nemožno odoslať, sa nikdy nezapíše.

Požiadavka, ktorej hlavička Accept obsahuje text/markdown, obchádza úložisko PHP aj doplnkový súbor, pretože uložené dokumenty sú HTML a stránka môže na túto požiadavku odpovedať pomocou zdrojaMarkdown. Poskytované dokumenty preto odosielajú Vary: Accept. Aktualizáciou Blockstudio sa pri ďalšom zápise mapy prepíše staršia verzia doplnkového súboru.

Trasy namapovaného grafu vždy používajú aktivovaný artefakt. Ak bezpečná anonymná trasa nie je v tejto mape, ale WordPress ju už vykreslil a uložil, skoré poskytovanie pred spustením WordPress použije záložné úložisko s kľúčom identity. Podporuje to vygenerované trasy alebo menej navštevované trasy mimo zámerne ohraničeného grafu nasadenia. Záložný režim používa identitu aktivovaného grafu a rovnaké pravidlá pre hostiteľa, normalizáciu cesty, TTL, súbory cookie, hlavičky, reťazce dopytu, dynamické cesty a obchádzanie kanálov ako namapované trasy. Nájde iba dokumenty uložené za behu, medzi ktorými nikdy nie sú výsledky vyhľadávania.

Hlavičky odpovede

Uložený dokument sa prehrá bez požiadavky, ktorá ho vykreslila, takže hlavička odoslaná témou alebo doplnkom cez header() by chýbala pri každom načítaní z cache. Blockstudio ukladá hlavičky uvedené v replayHeaders spolu s každým dokumentom a znova ich odosiela z cache PHP aj z doplnku na skoré doručovanie. Predvolený zoznam ["Link"] zahŕňa hlavičky, ako je alternatívna verzia Markdown (rel="alternate"; type="text/markdown"), rel="describedby" alebo rel="canonical". Názvy sa porovnávajú bez ohľadu na veľkosť písmen a filter nastavenia mení zoznam rovnako ako každú inú hodnotu:

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

    return $headers;
});

Ak chcete opätovné prehrávanie hlavičiek vypnúť, nastavte replayHeaders na []. Výslovne zadaný zoznam nahradí predvolený, preto pri pridávaní ďalších názvov hlavičiek zahrňte aj Link, ak chcete naďalej prehrávať hlavičky odkazov.

Hlavičky sa zachytávajú v procese, ktorý vykresľuje stránku: z headers_list() pri uložení po živom minutí cache a zo samotnej požiadavky na zahriatie, keď zostavenie alebo ohrievač vykresľuje cez HTTP. Hlavička, ktorú webový server pridáva samostatne a znova ku každému doručenému dokumentu, sa preto nikdy neuloží. Hlavičky odpovede sa použijú len vtedy, keď vykreslenie HTTP nevytvorí žiadny report. Transport internal ich vo výsledku vracia ako headers a persist_built_response() ich prijíma ako posledný argument, buď vo forme riadkov Name: value, alebo mapy názvov a hodnôt.

Ukladajú sa do <key>.headers.json vedľa dokumentu, sprevádzajú ho pri povýšení artefaktu, zbere odpadu a odstraňovaní starých položiek podľa doby uchovávania a odstránia sa, keď nové vykreslenie neodošle žiadne. Hlavičky súborov cookie, ukladania do cache a transportu sa nikdy neukladajú ani neprehrávajú, ani keď sú uvedené v zozname: Set-Cookie, Cache-Control, Expires, Pragma, Age, ETag, Last-Modified, Vary, Content-Type, Content-Length, Content-Encoding, Transfer-Encoding, Location, Status, Date, ako aj hlavičky typu hop-by-hop a autentifikačné hlavičky. Doručený dokument si nastavuje vlastné Content-Type a Vary.

Pri odosielaní sa uložené hlavičky znova porovnávajú so zoznamom. Cache PHP načíta aktuálne nastavenie; doplnok na skoré doručovanie načíta kópiu v položke mapy webu, ktorú obnoví ďalšia inštalácia artefaktu alebo synchronizácia mapy. Dokumenty uložené pred aktualizáciou nemajú súbor hlavičiek a doručujú sa presne ako predtým, kým sa znova nevykreslia.

Predohrev, údržba a prehľad o prevádzke

Front predohrevu je trvalý, zlučuje URL duplicitné úlohy, spracúva vždy iba jednu úlohu a obnovuje nároky po vypršaní časového limitu. Zmeny obsahu a webu vynútia náhradnú úlohu, aj keď sa aktuálny podpis nezmenil; pravidelné kontroly zaraďujú iba zastarané úlohy. Pri každej kontrole, naplánovanej alebo spustenej cez wp bs prerender warm, sa vykreslí až warm.concurrency úloh. Režim graph vypína predohrev jednotlivých URL, pretože artefakty grafu sa zostavujú a aktivujú ako jeden celok.

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 uvádza aktívnu identitu, súbory, bajty, záznamy grafu, stav frontu, hlásenie mapy pre skoré poskytovanie a počty zásahov, minutí, zostavení a zlyhaní pre každý rozsah.

Mapu pre skoré poskytovanie zdieľajú všetky weby jednej inštalácie. map status (a Static_Prerender_Early_Serve::map_report()) uvádza položky, ktoré sa už nedajú použiť na skoré poskytovanie: položky orphaned, ktorých web už neexistuje, a položky dead, ktorých adresár chýba, spolu s počtom dokumentov trás missing v zostávajúcich položkách. map prune (Static_Prerender_Early_Serve::prune_map()) odstráni osirelé a neaktívne položky pod zámkom mapy a pri každej uvedie dôvod; --dry-run iba vypíše hlásenie. Odstránením poslednej položky sa odstráni mapa, doplnkový súbor aj vyhlásenie WP_CACHE. Odstránením webu zo siete viacerých webov sa jeho položky vymažú okamžite. Čistenie vyrovnávacej pamäte nikdy neodstráni priestor názvov, z ktorého sa poskytuje aktivovaný artefakt, preto položky prestanú fungovať iba vtedy, keď sa ich súbory odstránia iným spôsobom.

Jednotlivé výsledky odpovedí sledujte pomocou blockstudio/static_prerender/outcome a všetky výsledky zdieľanej vyrovnávacej pamäte pomocou blockstudio/cache/outcome.

Odstránenie

Inštalácie bez háku na deaktiváciu pluginu, napríklad nastavenia s Composer v balíku, môžu jedným príkazom odstrániť všetko, čo funkcia spravuje:

Shell
wp bs teardown

Odstráni udalosti cron a stav statického predgenerovania spravovaný inštaláciou: položku mapy aktuálneho webu a zdieľaný doplnkový súbor aj vyhlásenie WP_CACHE po zániku poslednej spravovanej položky. Konfiguračné súbory zostanú nedotknuté, takže opätovné zapnutie funkcie prebehne bez problémov.

Nasadenie do produkcie

Odporúčaný postup zavádzania:

  1. Nastavte performance.profile na speed a potom skontrolujte výstup v hlavičke stránky, kanály a všetky pluginy závislé od oEmbed alebo XML-RPC.
  2. Vygenerujte assets/media.json, presuňte šablóny do bs_media_image() a potom zapnite performance.media.lazy.
  3. Zapnite performance.staticPrerender s vypnutým earlyServe, overte zásahy pomocou wp bs prerender status a potom zapnite earlyServe.

Vrátenie zmien sa vykonáva pre každú funkciu samostatne: nastavením staticPrerender.enabled na false sa raz odstráni stav skorého poskytovania a plány predohrevu spravované Blockstudio a prostredie predgenerovania sa prestane registrovať. Nastavením performance.profile späť na compat sa zruší profil. Ostatné vrstvy zostanú zachované.

Výkon

Profily, profiler a súvisiace techniky vykresľovania.

Ukladanie do vyrovnávacej pamäte

Jeden adresár vyrovnávacej pamäte, v ktorom sa nachádza každý vygenerovaný artefakt.