Hoppa till innehåll

Statisk förgenerering

Statisk förgenerering är en valfri anonym HTMLcache. Ett svar som kan cachas måste vara ett komplett HTMLdokument och kan välja bort cachning med <!-- blockstudio:no-cache -->. Blockstudio kringgår icke-GET-begäranden, frågesträngar, WordPress-admin, REST, Ajax, cron, flöden, sökresultat under sökbasen på webbplatsens hemsökväg (till exempel /search/term/), förhandsgransknings- och canvasrubriker, begäranden med nonce, deklarerade dynamiska sökvägar, lösenords-/kommentarskakor och inloggade begäranden som standard. En sida vars sökväg bara innehåller ett search– eller preview-segment längre ned, till exempel /docs/blocks/preview/, cachas som vilken annan sida som helst.

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

Inloggade användare kan använda en befintlig cacheträff endast när serveLoggedIn är sant; personanpassade svar skapar aldrig cacheposter. Dynamiska sökvägar använder sökvägsgränser, så /account matchar /account/orders men inte /accounting.

När funktionen är inaktiverad skrivs inga filer, ingen drop-in installeras och inga begärande- eller admin-hookar registreras. earlyServe: false registrerar inte heller någon Early Serve-adminåteranropning, och warm.enabled: false registrerar ingen cron-återanropning eller schemaläggning. När någon av funktionerna stängs av tas tidigare ägt tillstånd bort en gång; efterföljande begäranden gör inga kontroller av filsystemet eller cron för rensning.

Stänga av per miljö

Alla värden ovan kan också anges med ett inställningsfilter. Blockstudio startar före det aktiva temat, från ett tillägg eller från temats Composer-autoload, så dess körningsinställningar löses på nytt när temat har laddats och avgör vilka hookar för statisk förgenerering som ska användas vid after_setup_theme. Ett filter som läggs till av ett tillägg eller i temats functions.php får därför effekt:

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

Att stänga av funktionen på det här sättet fungerar som att stänga av den i blockstudio.json: inga begärande-, innehålls-, admin- eller cron-hookar registreras, och en webbplats som tidigare serverades tidigt får sin Early Serve-post borttagen en gång. Ett filter som läggs till senare, till exempel vid init, ändrar inte vilka hookar som registreras.

Signatur- och graf-lägen

Läget signature fyller ett identitetsnycklat svar vid en vanlig cachemiss för anonyma användare. Det passar bra för vanliga WordPress-webbplatser och roteras efter ändringar på webbplatsnivå.

Läget graph är avsett för deterministiska bygg- och distributionsintegreringar. Anropa Static_Prerender_Runtime::build_plan() med de aktiva käll-URL:erna, rendera endast affectedUrls och registrera sedan varje resultat med persist_built_response() eller persist_skipped_response(). Planen jämför delade filer och de exakta beroendehasharna för varje sida. Borttagna URL:er och orefererade HTML tas bort av 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);

Valfria argument för målhost och hemsida skriver om rutter för en distribution utan att använda den första sidans sökväg som webbplatsrot. Batchverktyg kan använda Static_Prerender_Batch_Renderer::render() och stabila N/TOTAL-delmängder; Static_Prerender_Batch_Renderer::parse_shard() och select_shard() ligger till grund för delmängdsalternativet, så en anropare kan beräkna samma partition som renderaren skulle använda. Under ett bygge anger Static_Prerender_Batch_Renderer::is_rendering() om den aktuella begäran är en batchrendering snarare än ett besök, så en mall kan hoppa över arbete som inte ska köras under ett bygge. En transport för internal tillhandahålls av det generiska filtret blockstudio/static_prerender/render_internal; ett valfritt HTTP-reservalternativ använder den vanliga uppvärmningsrubriken.

Vad graf-läget spårar

Med standardtransporten HTTP skickar Static_Prerender_Batch_Renderer::render() en signerad token med varje uppvärmningsbegäran, och begäran rapporterar vilka filer den läste: mallen WordPress som laddades, mallar, mallfiler och resursfiler för varje renderat block av typen Blockstudio, filer som lagts till via blockstudio/render/dependencies och, för en synkroniserad sida, dess definitions-, mall-, innehålls- och layoutfiler. Rapporten skrivs till webbplatsens cachekatalog, som renderaren och webbservern redan delar för de renderade HTML. Vid nästa bygge hashar build_plan() filerna igen och markerar endast de rutter vars filer har ändrats, tillsammans med nya rutter, rutter som passerat sin ttl och alla rutter när en delad fil ändras (blockstudio.json, theme.json, style.css, functions.php, header.php, footer.php, allt under inc/, parts/ och templates/ samt källorna till Blockstudios paketerade UI-resurser). Den delade signaturen hashar källor, aldrig kompilerad utdata, så filerna _dist som det första byggets rendering kompilerar ändrar den inte: artifact_entry() härleder bygg-id:t från samma signatur som build_plan() såg före renderingen.

Innehåll som bara finns i databasen är inte en fil och spåras inte: inlägg som redigerats i admin, alternativ, genererade rader eller priser. Ett bygge som måste fånga upp sådana ändringar skickar $force till build_plan() eller renderar de berörda URL:erna självt. Transporten internal registrerar de beroenden som dess filter returnerar.

Tidig servering och atomisk distribution

När earlyServe är aktiverat hanterar Blockstudio en liten wp-content/blockstudio-static-prerender-map.php, en drop-in för advanced-cache.php och en exakt WP_CACHE-deklaration. Drop-in-funktionen läser en ruttkarta per webbplats och strömmar en kvalificerad cacheträff innan WordPress, tillägg eller temat startar.

Blockstudio skriver aldrig över en främmande karta, drop-in eller WP_CACHE-deklaration. Grafartefakter validerar varje refererad fil av typen HTML innan kartan byts ut; den föregående grafen förblir aktiv om valideringen misslyckas. Poster i en multisite-installation delar kartan men isoleras efter host, hemsökväg och webbplats-ID. Om funktionen inaktiveras eller Blockstudio avaktiveras tas endast den aktuella webbplatsens post bort, och delade artefakter tas bort först när den sista ägda posten har försvunnit.

Distributionsverktyg kan aktivera en fullständigt renderad graf atomiskt:

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

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

Konfigurationen är fortsatt styrande. install_artifact_entry() returnerar false om inte både enabled och earlyServe är sanna, så en distribution kan aldrig installera en karta, drop-in och WP_CACHE-deklaration som nästa adminbegäran skulle ta bort igen.

install_artifact_entry() behåller postens build_id, så en distribution kan jämföra den med posten som installed_map_entries() returnerar efteråt. Kartan är en PHP-fil som läses med include, och varje skrivning tar bort den från opkodscachen, så läsningen ser den nya posten i samma process även när opcache.enable_cli är aktiverat.

När en artefakt installeras flyttas dess dokument till ett särskilt artefaktomfång som aldrig berörs av rensning efter lagringstid, och filerna som kartan refererar till kan inte rensas ut oavsett var de finns. Därför kan aktiv rendertrafik inte göra att mappade rutter försvinner från tidig servering. En ruttnyckel är inte fullständigt innehållsadresserad, så en omrendering kan ändra ett dokument utan att ändra dess nyckel. Installationen jämför byte och ersätter ett avvikande artefaktdokument atomiskt, lämnar identiska dokument orörda och behåller ett artefaktdokument vars lagrade kopia har försvunnit. Static_Prerender_Early_Serve::last_promotion() rapporterar hur många rutter som flyttades, ersattes, hoppades över eller behölls vid den senaste installationen, så en distribution kan logga det.

Ett lagrat dokument låser de byggresurser det länkar till via URL, och dessa filer har sin egen lagringstid, så den ena kan finnas kvar längre än den andra. Innan dokumentet serveras kontrollerar både cachen PHP och drop-in-funktionen att en länkad innehållshashad stilmall av typen Tailwind fortfarande finns på disken. Om dokumentets stilmall saknas skickas det till WordPress i stället för att serveras utan formatering, vilket publicerar både stilmallen och dokumentet på nytt. Samma kontroll görs innan ett svar lagras, så ett dokument som inte kunde serveras aldrig skrivs till disk.

En begäran vars Accept-rubrik innehåller text/markdown kringgår både lagret PHP och drop-in-funktionen, eftersom lagrade dokument är HTML och en sida kan besvara den begäran med sin källMarkdown. Serverade dokument skickar därför Vary: Accept. Om Blockstudio uppdateras skrivs en äldre drop-in om vid nästa kartskrivning.

Mappade grafrutter använder alltid den aktiverade artefakten. Om en säker anonym rutt inte finns i kartan men WordPress sedan dess har renderat och sparat den, använder Early Serve det identitetsnycklade körningslagret innan WordPress startar. Detta stöder genererade rutter eller rutter med låg trafik som ligger utanför en avsiktligt begränsad distributionsgraf. Reservalternativet använder den aktiverade grafidentiteten och samma regler för host, sökvägsnormalisering, TTL, kakor, rubriker, frågesträngar, dynamiska sökvägar och kringgående av flöden som mappade rutter. Det hittar endast dokument som har lagrats under körning, vilket aldrig omfattar sökresultat.

Svarshuvuden

Ett lagrat dokument spelas upp utan begäran som renderade det, så ett huvud som ett tema eller tillägg skickar med header() skulle saknas vid varje träff. Blockstudio lagrar huvudena som anges i replayHeaders tillsammans med varje dokument och skickar dem igen från både PHP-cachen och drop-in-komponenten för tidig leverans. Standardvärdet, ["Link"], omfattar huvuden som ett alternativt Markdown (rel="alternate"; type="text/markdown"), rel="describedby" eller rel="canonical". Namn matchas oberoende av skiftläge, och inställningsfiltret ändrar listan som vilket annat värde som helst:

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

    return $headers;
});

Sätt replayHeaders till [] för att inaktivera återuppspelning av huvuden. En uttrycklig lista ersätter standardvärdet, så ta med Link när du lägger till andra huvudnamn om du fortfarande vill återspela länkhuvuden.

Huvuden fångas i processen som renderar sidan: från headers_list() när en cachemiss i realtid lagras och från själva uppvärmningsbegäran när ett bygge eller uppvärmaren renderar över HTTP. Därför lagras aldrig ett huvud som webbservern lägger till på egen hand och lägger till igen i varje serverat dokument. Endast när en HTTP-rendering inte skriver någon rapport används huvudena från svaret. Transporten internal returnerar dem som headers i resultatet, och persist_built_response() tar emot dem som sitt sista argument, antingen som rader med Name: value eller som en mappning från namn till värde.

De skrivs till <key>.headers.json bredvid dokumentet, följer med det vid befordran av artefakter, skräpsamling och gallring enligt lagringstiden, och tas bort när en omrendering inte skickar några. Cookie-, cache- och transporthuvuden lagras eller återspelas aldrig, även om de finns med i listan: Set-Cookie, Cache-Control, Expires, Pragma, Age, ETag, Last-Modified, Vary, Content-Type, Content-Length, Content-Encoding, Transfer-Encoding, Location, Status, Date samt hop-by-hop- och autentiseringshuvuden. Ett serverat dokument anger sina egna Content-Type och Vary.

Lagrede huvuden kontrolleras åter mot listan när de skickas. Cachen PHP läser den aktuella inställningen; drop-in-komponenten läser kopian i webbplatsens kartpost, som uppdateras vid nästa artefaktinstallation eller kartsynkronisering. Dokument som lagrades före en uppgradering saknar huvudfil och serveras precis som tidigare tills de renderas igen.

Uppvärmning, underhåll och observerbarhet

Uppvärmningskön är beständig, slår ihop URL, hanterar bara en instans åt gången och återställer tidsgränsöverskridna anspråk. Innehålls- och webbplatsändringar tvingar fram ett ersättningsjobb även när den aktuella signaturen är oförändrad; intervallkörningar köar endast inaktuellt arbete. Varje schemalagd körning eller körning via wp bs prerender warm renderar upp till warm.concurrency jobb. Läget graph stänger av uppvärmning per URL, eftersom grafartefakter byggs och aktiveras som en enhet.

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 rapporterar den aktiva identiteten, filer, byte, grafposter, köstatus, rapporten för Early Serve-kartan och räknare för cacheträffar, cachemissar, byggen och fel per omfång.

Early Serve-kartan delas av alla webbplatser i en installation. map status (och Static_Prerender_Early_Serve::map_report()) listar poster som tidig servering inte längre kan använda: orphaned-poster vars webbplats inte längre finns och dead-poster vars katalog saknas, samt antalet missing-ruttdokument i de återstående posterna. map prune (Static_Prerender_Early_Serve::prune_map()) tar bort övergivna och inaktuella poster under kartlåset och rapporterar var och en med orsaken; --dry-run rapporterar endast. När den sista posten tas bort försvinner kartan, drop-in-funktionen och WP_CACHE-deklarationen. Om en webbplats tas bort från ett multisite-nätverk försvinner dess poster omedelbart, och cacherensningen samlar aldrig in namnrymden som en aktiverad artefakt serveras från, så poster blir inaktuella endast när deras filer tas bort på annat sätt.

Följ enskilda svar med blockstudio/static_prerender/outcome och alla delade cacheutfall med blockstudio/cache/outcome.

Avinstallation

Installationer utan en hook för avaktivering av tillägg, till exempel installationer som levereras med Composer, kan ta bort allt som funktionen äger med ett enda kommando:

Shell
wp bs teardown

Det tar bort händelserna cron och det tillstånd för statisk förgenerering som installationen äger: den aktuella webbplatsens kartpost samt den delade drop-in-funktionen och WP_CACHE-deklarationen när den sista ägda posten har försvunnit. Konfigurationsfiler lämnas orörda, så funktionen kan aktiveras på nytt utan problem.

Ta den i bruk i produktion

En rimlig ordning för införandet:

  1. Sätt performance.profile till speed och kontrollera sedan head-utdata, flöden och eventuella tillägg som förlitar sig på oEmbed eller XML-RPC.
  2. Skapa assets/media.json, flytta mallar till bs_media_image() och aktivera sedan performance.media.lazy.
  3. Aktivera performance.staticPrerender med earlyServe avstängt, verifiera cacheträffar med wp bs prerender status och aktivera sedan earlyServe.

Återställning sker per funktion: om staticPrerender.enabled sätts till false tas Blockstudio-ägt Early Serve-tillstånd och uppvärmningsscheman bort en gång, varefter körningsmiljön för förgenerering lämnas oregistrerad. Om performance.profile sätts tillbaka till compat återställs profilen. De andra lagren lämnas kvar.

Prestanda

Profilerna, profileraren och renderingsmetoderna bakom dem.

Cachning

Den enda cachekatalog där alla genererade artefakter lagras.