Statické předvykreslování
Statické předvykreslování je volitelná anonymní mezipaměť HTML. Odpověď vhodná k uložení do mezipaměti musí být úplný dokument HTML a může ukládání vyloučit pomocí <!-- blockstudio:no-cache -->. Blockstudio obchází požadavky, které nejsou GET, řetězce dotazu, administraci WordPress, REST, Ajax, cron, kanály, výsledky hledání mimo základní cestu vyhledávání na domovské stránce webu (například /search/term/), hlavičky náhledu a plátna, požadavky obsahující nonce, deklarované dynamické cesty, soubory cookie pro heslo/komentáře a ve výchozím nastavení také požadavky přihlášených uživatelů. Stránka, jejíž cesta obsahuje segment search nebo preview až hlouběji, například /docs/blocks/preview/, se ukládá stejně jako jakákoli jiná stránka.
{
"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"
}
}
}
}
Přihlášení uživatelé mohou využít existující zásah do mezipaměti pouze tehdy, když platí serveLoggedIn; personalizované odpovědi nikdy nevytvářejí položky mezipaměti. Dynamické cesty rozlišují hranice segmentů, takže /account odpovídá /account/orders, ale ne /accounting.
Když je tato funkce vypnutá, nezapisuje žádné soubory, neinstaluje drop-in a neregistruje žádné hooky požadavků ani administrace. earlyServe: false rovněž neregistruje žádné administrační callbacky Early Serve a warm.enabled: false neregistruje callback cron ani plán. Vypnutí kterékoli z těchto funkcí jednou odstraní dříve vytvořený stav; následné požadavky neprovádějí žádné kontroly souborového systému ani úklidu cron.
Vypnutí v jednotlivých prostředích
Každou výše uvedenou hodnotu lze nastavit také pomocí filtru nastavení. Blockstudio se spouští před aktivním motivem, a to z pluginu nebo z automatického načítání Composer motivu, takže po načtení motivu znovu načte běhová nastavení a o hookách statického předvykreslování rozhodne až v after_setup_theme. Filtr přidaný pluginem nebo v souboru functions.php motivu se proto uplatní:
add_filter('blockstudio/settings/performance/staticPrerender/enabled', function ($enabled) {
return 'local' === wp_get_environment_type() ? false : $enabled;
});
Vypnutí funkce tímto způsobem funguje stejně jako její vypnutí v blockstudio.json: neregistrují se žádné hooky požadavků, obsahu, administrace ani cron a položka Early Serve webu, který se dříve poskytoval včas, se jednou odstraní. Později přidaný filtr, například při init, už nemění zaregistrované hooky.
Režimy podpisu a grafu
Režim signature naplní odpověď s identitou při běžném chybění v anonymní mezipaměti. Hodí se pro běžné weby WordPress a po změnách na úrovni webu obnoví identitu.
Režim graph je určen pro deterministické integrace sestavení a nasazení. Zavolejte Static_Prerender_Runtime::build_plan() s aktivními zdrojovými adresami URL, vykreslete pouze affectedUrls a pak zaznamenejte každý výsledek pomocí persist_built_response() nebo persist_skipped_response(). Plán porovnává sdílené soubory a přesné kontrolní součty závislostí každé stránky. Smazané adresy URL a nepoužívané HTML odstraní garbage_collect().
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);
Volitelné argumenty cílového hostitele a domovské cesty přepisují trasy pro nasazení, aniž by se cesta první stránky použila jako kořen webu. Dávkové nástroje mohou použít Static_Prerender_Batch_Renderer::render() a stabilní části N/TOTAL; možnost rozdělení do částí využívají Static_Prerender_Batch_Renderer::parse_shard() a select_shard(), takže volající může vypočítat stejné rozdělení jako vykreslovač. Během sestavení určuje Static_Prerender_Batch_Renderer::is_rendering(), zda jde o dávkové vykreslování, nebo o návštěvníka, takže šablona může přeskočit práci, která se během sestavení nemá provádět. Transport internal poskytuje obecný filtr blockstudio/static_prerender/render_internal; volitelná záloha HTTP používá běžnou hlavičku pro zahřátí.
Co režim grafu sleduje
Při použití výchozího transportu HTTP posílá Static_Prerender_Batch_Renderer::render() každému zahřívacímu požadavku podepsaný token a požadavek hlásí soubory, které načetl: šablonu WordPress, každý vykreslený blok Blockstudio, jeho šablonu, soubory šablon a soubory prostředků, soubory přidané přes blockstudio/render/dependencies a u synchronizované stránky také její definiční soubor, šablonu, obsah a soubory rozvržení. Hlášení se zapisuje do adresáře mezipaměti webu, který vykreslovač i webový server už sdílejí pro vykreslené HTML. Při dalším sestavení build_plan() tyto soubory znovu opatří kontrolními součty a označí pouze trasy, jejichž soubory se změnily, spolu s novými trasami, trasami po uplynutí jejich ttl a všemi trasami při změně sdíleného souboru (blockstudio.json, theme.json, style.css, functions.php, header.php, footer.php, vše pod inc/, parts/ a templates/ a zdroje prostředků UI zabalených v Blockstudio). Sdílený podpis počítá kontrolní součty zdrojů, nikdy zkompilovaného výstupu, takže soubory _dist, které zkompiluje první vykreslení sestavení, ho nezmění: artifact_entry() odvodí ID sestavení ze stejného podpisu, jaký build_plan() zaznamenalo před vykreslením.
Obsah, který existuje pouze v databázi, není soubor a nesleduje se: příspěvky upravené v administraci, nastavení, generované řádky nebo ceny. Sestavení, které musí tyto změny zachytit, předá $force funkci build_plan(), nebo dotčené adresy URL vykreslí samo. Transport internal zaznamenává závislosti vrácené jeho filtrem.
Včasné poskytování a atomické nasazení
Když je povoleno earlyServe, Blockstudio spravuje malý wp-content/blockstudio-static-prerender-map.php, drop-in advanced-cache.php a jednu přesnou deklaraci WP_CACHE. Drop-in načte mapu tras pro daný web a odešle vhodnou položku ještě před spuštěním WordPress, pluginů nebo motivu.
Blockstudio nikdy nepřepisuje cizí mapu, drop-in ani deklaraci WP_CACHE. Před výměnou mapy artefakty grafu ověří každý odkazovaný soubor HTML; pokud ověření selže, zůstane aktivní předchozí graf. Položky na více webech sdílejí mapu, ale jsou odděleny podle hostitele, domovské cesty a ID webu. Vypnutí funkce nebo deaktivace Blockstudio odstraní pouze položku aktuálního webu a sdílené artefakty odstraní až po zmizení poslední spravované položky.
Nástroje pro nasazení mohou atomicky aktivovat plně vykreslený graf:
$entry = Static_Prerender_Runtime::artifact_entry($targetUrls);
Blockstudio\Static_Prerender_Early_Serve::install_artifact_entry(
$entry,
Static_Prerender_Runtime::cache_root_path()
);
Konfigurace zůstává rozhodující. install_artifact_entry() vrací false, pokud nejsou současně splněny podmínky enabled a earlyServe. Nasazení tak nikdy nemůže nainstalovat mapu, drop-in a deklaraci WP_CACHE, které by další požadavek administrace znovu odstranil.
install_artifact_entry() zachovává hodnotu build_id dané položky, takže ji nasazení může porovnat s hodnotou, kterou následně vrátí installed_map_entries(). Mapa je soubor PHP načítaný pomocí include a každý zápis ho vyřadí z mezipaměti operačních kódů, takže načtení ve stejném procesu uvidí novou položku, i když je zapnuté opcache.enable_cli.
Při instalaci se dokumenty povýší do vyhrazeného rozsahu artefaktů, na který se nikdy nevztahuje prořezávání podle retenční doby. Soubory odkazované mapou jsou chráněné před vyřazením bez ohledu na umístění, takže provoz živého vykreslování nemůže způsobit, že mapované trasy přestanou být dostupné při včasném poskytování. Klíč trasy není plně odvozený od obsahu, takže se dokument může při novém vykreslení změnit, aniž by se změnil jeho klíč. Instalace porovnává bajty a rozdílný dokument artefaktu atomicky nahradí, shodné dokumenty ponechá beze změny a zachová dokument artefaktu, jehož kopie v úložišti zmizela. Static_Prerender_Early_Serve::last_promotion() uvádí počet tras povýšených, nahrazených, přeskočených nebo zachovaných při poslední instalaci, takže jej lze zaznamenat do protokolu nasazení.
Uložený dokument připíná prostředky sestavení, na které odkazuje přes URL, přičemž každý z nich má vlastní retenční dobu, takže jeden může přežít druhý. Před odesláním kontrolují jak mezipaměť PHP, tak drop-in, zda odkazovaná šablona Tailwind s hashem obsahu stále existuje na disku. Pokud stylopis dokumentu chybí, dokument se místo neformátovaného odeslání předá do WordPress, které znovu publikuje stylopis i dokument společně. Stejná kontrola proběhne před uložením odpovědi, takže dokument, který by nešlo odeslat, se nikdy nezapíše.
Požadavek, jehož hlavička Accept obsahuje text/markdown, obchází úložiště PHP i drop-in, protože uložené dokumenty jsou HTML a stránka může na tento požadavek odpovědět svým zdrojovým Markdown. Odeslané dokumenty proto posílají Vary: Accept. Aktualizace Blockstudio při příštím zápisu mapy přepíše starší drop-in.
Mapované trasy grafu vždy používají aktivovaný artefakt. Pokud bezpečná anonymní trasa v mapě není, ale WordPress ji mezitím vykreslilo a uložilo, Early Serve před spuštěním WordPress použije záložní úložiště běhových dat s klíčem podle identity. Podporuje tak generované trasy nebo méně obvyklé trasy mimo záměrně omezený graf nasazení. Záložní úložiště používá identitu aktivovaného grafu a stejná pravidla pro normalizaci hostitele a cesty, TTL, soubory cookie, hlavičky, řetězce dotazu, dynamické cesty a obcházení kanálů jako mapované trasy. Najde pouze dokumenty uložené za běhu, které nikdy nezahrnují výsledky hledání.
Hlavičky odpovědi
Uložený dokument se znovu přehraje bez požadavku, který jej vykreslil, takže
hlavička, kterou téma nebo plugin odešle s header(), by chyběla při každém
zásahu. Blockstudio ukládá hlavičky uvedené v replayHeaders spolu s každým dokumentem
a znovu je odesílá z mezipaměti PHP i z doplňku pro včasné podávání. Výchozí
nastavení ["Link"] pokrývá hlavičky, jako je alternativní hlavička Markdown
(rel="alternate"; type="text/markdown"), rel="describedby" nebo
rel="canonical". Názvy se porovnávají bez ohledu na velikost písmen a filtr nastavení
mění seznam stejně jako jakoukoli jinou hodnotu:
add_filter('blockstudio/settings/performance/staticPrerender/replayHeaders', function (array $headers): array {
$headers[] = 'X-Robots-Tag';
return $headers;
});
Nastavte replayHeaders na [], chcete-li opakované odesílání hlaviček vypnout. Výslovně
uvedený seznam nahrazuje výchozí, proto při přidávání dalších názvů hlaviček
zahrňte Link, pokud chcete hlavičky odkazů dál znovu odesílat.
Hlavičky se zachycují v procesu, který stránku vykresluje: z headers_list() při
uložení po živém minutí mezipaměti a ze samotného zahřívacího požadavku,
když sestavení nebo nástroj pro zahřívání vykresluje přes HTTP. Hlavička,
kterou webový server přidává sám a znovu přidává ke každému podávanému
dokumentu, se tedy nikdy neukládá. Pouze pokud vykreslení HTTP nezapíše
žádný přehled, použijí se hlavičky jeho odpovědi. Přenos internal je vrací jako
headers ve výsledku a persist_built_response() je přijímá jako poslední argument, buď
v podobě řádků Name: value, nebo jako mapu názvů a hodnot.
Zapisují se do <key>.headers.json vedle dokumentu, přecházejí s ním při povýšení
artefaktů, sběru odpadu a prořezávání uchovávaných dat a odstraní se, když
nové vykreslení žádné neodešle. Hlavičky souborů cookie, mezipaměti a přenosu
se nikdy neukládají ani znovu neodesílají, ani když jsou uvedeny v seznamu:
Set-Cookie, Cache-Control, Expires, Pragma, Age, ETag, Last-Modified, Vary, Content-Type,
Content-Length, Content-Encoding, Transfer-Encoding, Location, Status, Date, a také hlavičky
hop-by-hop a ověřovací hlavičky. Podávaný dokument nastavuje vlastní
Content-Type a Vary.
Uložené hlavičky se při odesílání znovu kontrolují podle seznamu. Mezipaměť PHP čte aktuální nastavení; doplněk čte kopii v položce mapy webu, kterou obnoví další instalace artefaktu nebo synchronizace mapy. Dokumenty uložené před aktualizací nemají soubor s hlavičkami a podávají se jako dříve, dokud nejsou znovu vykresleny.
Zahřívání, údržba a sledování
Fronta zahřívání je trvalá, slučuje duplicitní požadavky URL, spouští každý úkol pouze jednou a obnovuje nároky, jejichž časový limit vypršel. Změny obsahu a webu vždy vynutí náhradní úlohu, i když se aktuální podpis nezměnil; průchody v intervalech přidávají do fronty pouze zastaralou práci. Každý průchod, naplánovaný nebo spuštěný přes wp bs prerender warm, vykreslí až warm.concurrency úloh. Režim graph vypne zahřívání pro každý jednotlivý URL, protože artefakty grafu se sestavují a aktivují jako jeden celek.
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ádí aktivní identitu, soubory, bajty, záznamy grafu, stav fronty, přehled mapy Early Serve a počty zásahů, minutí, sestavení a selhání podle rozsahu.
Mapu Early Serve sdílejí všechny weby instalace. map status (a Static_Prerender_Early_Serve::map_report()) vypisuje položky, které už nelze použít pro včasné poskytování: položky orphaned, jejichž web už neexistuje, a položky dead, jejichž adresář chybí, spolu s počtem dokumentů tras missing ve zbývajících položkách. map prune (Static_Prerender_Early_Serve::prune_map()) pod zámkem mapy odstraní osiřelé a nefunkční položky a u každé uvede důvod; --dry-run pouze vypíše přehled. Po odstranění poslední položky se odstraní mapa, drop-in i deklarace WP_CACHE. Smazání webu ze sítě s více weby odstraní jeho položky okamžitě a čištění mezipaměti nikdy nesbírá jmenný prostor, ze kterého se obsluhuje aktivovaný artefakt. Položky proto přestanou fungovat pouze tehdy, když jsou jejich soubory odstraněny jiným způsobem.
Sledujte jednotlivé výsledky odpovědí pomocí blockstudio/static_prerender/outcome a všechny výsledky sdílené mezipaměti pomocí blockstudio/cache/outcome.
Odstranění
Instalace bez hooku pro deaktivaci pluginu, například nastavení dodávaná společně s Composer, mohou jediným příkazem odstranit vše, co funkce spravuje:
wp bs teardown
Odstraní události cron a stav statického předvykreslování spravovaný instalací: položku mapy aktuálního webu a sdílený drop-in a deklaraci WP_CACHE, jakmile zmizí poslední spravovaná položka. Konfiguračních souborů se nedotkne, takže po opětovném zapnutí funkce začne fungovat čistě.
Nasazení do produkce
Rozumné pořadí zavádění:
- Nastavte
performance.profilenaspeeda pak zkontrolujte výstup hlavičky stránky, kanály a všechny pluginy závislé na oEmbed nebo XML-RPC. - Vygenerujte
assets/media.json, přesuňte šablony dobs_media_image()a pak zapněteperformance.media.lazy. - Povolte
performance.staticPrerenders vypnutýmearlyServe, ověřte zásahy pomocíwp bs prerender statusa pak zapněteearlyServe.
Vrácení změn se provádí pro každou funkci zvlášť: nastavením staticPrerender.enabled na false se jednou odstraní stav Early Serve a plány zahřívání spravované Blockstudio a běhová část předvykreslování se pak odregistruje. Nastavením performance.profile zpět na compat se vrátí profil. Ostatní vrstvy zůstávají zachovány.
Profily, profiler a navazující techniky vykreslování.
Jediný adresář mezipaměti, v němž se nachází všechny generované artefakty.