Ga naar de inhoud

Statisch prerenderen

Statisch prerenderen is een optionele anonieme HTML-cache. Een cachebare respons moet een volledig HTML-document zijn en kan zich afmelden met <!-- blockstudio:no-cache -->. Blockstudio slaat standaard niet-GET-aanvragen, querystrings, WordPress-beheer, REST, Ajax, cron, feeds, zoekresultaten onder het zoekbasispad op het homepagepad van de site (zoals /search/term/), preview- en canvasheaders, aanvragen met een nonce, opgegeven dynamische paden, wachtwoord-/reactiecookies en ingelogde aanvragen over. Een pagina waarvan het pad alleen verderop een segment search of preview bevat, zoals /docs/blocks/preview/, wordt net als elke andere pagina gecachet.

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

Ingelogde gebruikers kunnen een bestaande cachehit gebruiken alleen wanneer serveLoggedIn waar is; gepersonaliseerde responses maken nooit cache-items aan. Dynamische paden gebruiken padgrenzen, dus /account komt overeen met /account/orders, maar niet met /accounting.

Wanneer de functie is uitgeschakeld, schrijft deze geen bestanden, installeert geen drop-in en registreert geen aanvraag- of beheerhooks. earlyServe: false registreert evenmin een Early Serve-beheercallback, en warm.enabled: false registreert geen callback of planning voor cron. Wanneer een van beide functies wordt uitgeschakeld, wordt de eerder beheerde status eenmalig verwijderd; volgende aanvragen voeren geen opschooncontroles voor het bestandssysteem of cron uit.

Uitschakelen per omgeving

Elke waarde hierboven kan ook met een instellingenfilter worden ingesteld. Blockstudio wordt gestart voordat het actieve thema wordt geladen, vanuit een plugin of vanuit de autoload van het thema Composer. Daarom worden de runtime-instellingen opnieuw bepaald zodra het thema is geladen en worden de hooks voor statisch prerenderen op after_setup_theme gekozen. Een filter dat door een plugin of in de functions.php van het thema wordt toegevoegd, wordt dus toegepast:

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

De functie op deze manier uitschakelen werkt hetzelfde als uitschakelen in blockstudio.json: er worden geen aanvraag-, content-, beheer- of cron-hooks geregistreerd, en een site die eerder vroeg werd geserveerd, krijgt de Early Serve-vermelding eenmalig verwijderd. Een later toegevoegd filter, bijvoorbeeld op init, verandert niet welke hooks worden geregistreerd.

Handtekening- en grafiekmodi

De modus signature vult een response met een identiteitssleutel bij een normale cachemisser voor een anonieme gebruiker. Deze modus is handig voor gewone WordPress-sites en wordt vernieuwd na wijzigingen op siteniveau.

De modus graph is bedoeld voor deterministische build-/deploy-integraties. Roep Static_Prerender_Runtime::build_plan() aan met de live bron-URL’s, render alleen affectedUrls en registreer vervolgens elk resultaat met persist_built_response() of persist_skipped_response(). Het plan vergelijkt gedeelde bestanden en de exacte afhankelijkheidshashes van elke pagina. Verwijderde URL’s en niet-gerefereerde HTML worden verwijderd door 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);

Optionele argumenten voor de doeldomeinhost en -homepage herschrijven routes voor een deployment zonder het pad van de eerste pagina als sitenaam te gebruiken. Batchtools kunnen Static_Prerender_Batch_Renderer::render() en stabiele N/TOTAL-shards gebruiken; Static_Prerender_Batch_Renderer::parse_shard() en select_shard() ondersteunen de shardoptie, zodat een aanroeper dezelfde partitie kan berekenen als de renderer. Binnen een build geeft Static_Prerender_Batch_Renderer::is_rendering() aan of de huidige aanvraag een batchrender is in plaats van een bezoekersaanvraag, zodat een template werk kan overslaan dat niet tijdens een build hoort te worden uitgevoerd. Een internal-transport wordt geleverd via het algemene filter blockstudio/static_prerender/render_internal; de optionele terugval van HTTP gebruikt de normale warm-header.

Wat de grafiekmodus bijhoudt

Met het standaardtransport HTTP stuurt Static_Prerender_Batch_Renderer::render() elke warm-aanvraag een ondertekend token, waarna de aanvraag de gelezen bestanden rapporteert: de template WordPress die is geladen, de template, templatebestanden en assetbestanden van elk gerenderd blok Blockstudio, bestanden die zijn toegevoegd via blockstudio/render/dependencies en, voor een gesynchroniseerde pagina, de definitie-, template-, content- en layoutbestanden. Het rapport wordt weggeschreven naar de cachemap van de site, die de renderer en de webserver al delen voor de gerenderde HTML. Bij de volgende build berekent build_plan() opnieuw hashes van die bestanden en markeert alleen de routes waarvan de bestanden zijn gewijzigd, samen met nieuwe routes, routes waarvan de ttl is verstreken en alle routes wanneer een gedeeld bestand verandert (blockstudio.json, theme.json, style.css, functions.php, header.php, footer.php, alles onder inc/, parts/ en templates/, plus de bronnen van de gebundelde assets UI van Blockstudio). De gedeelde handtekening hasht bronnen, nooit gecompileerde uitvoer, zodat de bestanden _dist die de eerste render van een build compileert de handtekening niet wijzigen: artifact_entry() leidt de build-id af van dezelfde handtekening die build_plan() vóór het renderen heeft gezien.

Content die alleen in de database staat, is geen bestand en wordt niet bijgehouden: berichten die in het beheer zijn bewerkt, opties, gegenereerde rijen of prijzen. Een build die dergelijke wijzigingen moet meenemen, geeft $force door aan build_plan() of rendert de betreffende URL’s zelf. Het transport internal registreert de afhankelijkheden die het filter retourneert.

Vroeg serveren en atomische deployment

Wanneer earlyServe is ingeschakeld, beheert Blockstudio een kleine wp-content/blockstudio-static-prerender-map.php, een advanced-cache.php-drop-in en één exacte WP_CACHE-declaratie. De drop-in leest een routemap per site en streamt een geschikte hit voordat WordPress, plugins of het thema worden gestart.

Blockstudio overschrijft nooit een map, drop-in of WP_CACHE-declaratie van een ander. Grafiekartefacten valideren elk bestand HTML waarnaar wordt verwezen voordat de map wordt omgewisseld; als de validatie mislukt, blijft de vorige grafiek actief. Multisite-vermeldingen delen de map, maar zijn geïsoleerd op basis van host, homepagepad en site-ID. Wanneer de functie wordt uitgeschakeld of Blockstudio wordt gedeactiveerd, wordt alleen de vermelding van de huidige site verwijderd; gedeelde artefacten worden pas verwijderd nadat de laatste beheerde vermelding is verdwenen.

Deploymenttools kunnen een volledig gerenderde grafiek atomisch activeren:

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

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

De configuratie blijft leidend. install_artifact_entry() retourneert false tenzij zowel enabled als earlyServe waar zijn, zodat een deployment nooit een map, drop-in en WP_CACHE-declaratie kan installeren die de volgende beheeraanvraag weer zou verwijderen.

install_artifact_entry() behoudt de build_id van de vermelding, zodat een deployment deze kan vergelijken met de vermelding die installed_map_entries() daarna retourneert. De map is een PHP-bestand dat met include wordt gelezen. Bij elke schrijfactie wordt het uit de opcodecache verwijderd, zodat die uitlezing in hetzelfde proces de nieuwe vermelding ziet, ook wanneer opcache.enable_cli is ingeschakeld.

Door een artefact te installeren, worden de documenten ervan overgezet naar een speciale artefactscope die nooit door het opschonen op basis van bewaartermijnen wordt aangeraakt. Bestanden waarnaar de map verwijst, zijn ongeacht hun locatie beschermd tegen verwijdering, zodat live renderverkeer routes in de map niet kan laten verouderen en uit vroeg serveren kan verwijderen. Een rout sleutel is niet volledig op content geadresseerd, dus een nieuwe render kan een document wijzigen zonder de sleutel te wijzigen. Bij de installatie worden bytes vergeleken en wordt een afwijkend artefactdocument atomisch vervangen; identieke documenten blijven ongewijzigd en een artefactdocument waarvan de opgeslagen kopie is verdwenen, blijft behouden. Static_Prerender_Early_Serve::last_promotion() rapporteert hoeveel routes bij de laatste installatie zijn overgezet, vervangen, overgeslagen of behouden, zodat een deployment dit kan loggen.

Een opgeslagen document houdt de buildassets vast waarnaar het verwijst via URL; die bestanden hebben hun eigen bewaartermijn, waardoor de een langer kan bestaan dan de ander. Voordat een document wordt geserveerd, controleren zowel de cache PHP als de drop-in of een gekoppeld contentgehasht Tailwind-stylesheet nog op de schijf staat. Als het stylesheet van een document ontbreekt, wordt het naar WordPress doorgestuurd in plaats van ongestyled te worden geserveerd; zo worden het stylesheet en document samen opnieuw gepubliceerd. Dezelfde controle wordt uitgevoerd voordat een response wordt opgeslagen, zodat een document dat niet kon worden geserveerd nooit wordt weggeschreven.

Een aanvraag waarvan de Accept-header text/markdown bevat, omzeilt zowel de PHP-opslag als de drop-in, omdat opgeslagen documenten HTML zijn en een pagina die aanvraag kan beantwoorden met haar bron Markdown. Geserveerde documenten sturen daarom Vary: Accept. Door Blockstudio bij te werken, wordt een oudere drop-in bij de volgende mapupdate herschreven.

Routes uit de grafiekmap gebruiken altijd het geactiveerde artefact. Staat een veilige anonieme route niet in die map, maar heeft WordPress deze inmiddels gerenderd en opgeslagen, dan valt Early Serve terug op de runtimeopslag met identiteitssleutel voordat WordPress wordt gestart. Dit ondersteunt gegenereerde of minder bezochte routes buiten een bewust begrensde deploymentgrafiek. De terugval gebruikt de identiteit van de geactiveerde grafiek en dezelfde regels voor host, padnormalisatie, TTL, cookies, headers, querystrings, dynamische paden en het overslaan van feeds als de routes in de map. De terugval vindt alleen documenten die tijdens runtime zijn opgeslagen; zoekresultaten zijn daar nooit bij.

Reactieheaders

Een opgeslagen document wordt opnieuw weergegeven zonder het verzoek waarmee het is gerenderd. Daardoor zou een header die een thema of plugin met header() verstuurt, bij elke hit ontbreken. Blockstudio slaat de headers op die in replayHeaders worden genoemd, bij elk document en verstuurt ze opnieuw vanuit zowel de PHP-cache als de drop-in voor vroeg serveren. De standaardwaarde, ["Link"], omvat headers zoals een alternatief voor Markdown (rel="alternate"; type="text/markdown"), rel="describedby" of rel="canonical". Namen worden hoofdletterongevoelig vergeleken en het filter voor de instelling wijzigt de lijst net als elke andere waarde:

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

    return $headers;
});

Stel replayHeaders in op [] om het opnieuw versturen van headers uit te schakelen. Een expliciete lijst vervangt de standaardlijst. Neem dus Link op wanneer je andere headernamen toevoegt, als je linkheaders opnieuw wilt versturen.

Headers worden vastgelegd in het proces dat de pagina rendert: vanuit headers_list() wanneer een live cache-misser wordt opgeslagen, en vanuit het opwarmverzoek zelf wanneer een build of de warmer rendert over HTTP. Een header die de webserver zelf toevoegt en opnieuw toevoegt aan elk geserveerd document, wordt dus nooit opgeslagen. Alleen wanneer een render van HTTP geen rapport oplevert, worden de headers van dat antwoord gebruikt. Het transport van internal retourneert ze als headers in het resultaat, en persist_built_response() neemt ze als laatste argument aan, als Name: value-regels of als een toewijzing van namen aan waarden.

Ze worden opgeslagen in <key>.headers.json naast het document, blijven erbij tijdens het promoveren van artefacten, het opruimen van ongebruikte bestanden en het opschonen volgens het bewaarbeleid, en worden verwijderd wanneer een nieuwe render geen headers verstuurt. Cookie-, cache- en transportheaders worden nooit opgeslagen of opnieuw verstuurd, zelfs niet als ze zijn vermeld: Set-Cookie, Cache-Control, Expires, Pragma, Age, ETag, Last-Modified, Vary, Content-Type, Content-Length, Content-Encoding, Transfer-Encoding, Location, Status, Date, plus de hop-by-hop- en authenticatieheaders. Een geserveerd document stelt zijn eigen Content-Type en Vary in.

Opgeslagen headers worden bij het versturen opnieuw gecontroleerd aan de hand van de lijst. De PHP-cache leest de huidige instelling; de drop-in leest de kopie in de mapvermelding van de site, die bij de volgende artefactinstallatie of mapsynchronisatie wordt bijgewerkt. Documenten die vóór een upgrade zijn opgeslagen, hebben geen headerbestand en worden precies zoals voorheen geserveerd totdat ze opnieuw worden gerenderd.

Opwarmen, onderhoud en observeerbaarheid

De warm-queue is duurzaam, coalesceert op basis van URL, verwerkt één taak tegelijk en herstelt verlopen claims. Wijzigingen in content en de site dwingen een vervangende taak af, ook wanneer de huidige handtekening ongewijzigd is; periodieke runs voegen alleen verouderd werk toe. Elke run rendert, gepland of via wp bs prerender warm, maximaal warm.concurrency taken. De modus graph schakelt de warmer per URL uit, omdat grafiekartefacten als één geheel worden gebouwd en geactiveerd.

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 rapporteert de actieve identiteit, bestanden, bytes, grafiekrecords, wachtrijstatus, het rapport van de Early Serve-map en tellers voor hits, missers, builds en fouten per scope.

De Early Serve-map wordt gedeeld door alle sites van een installatie. map status (en Static_Prerender_Early_Serve::map_report()) vermeldt items die vroeg serveren niet meer kan gebruiken: orphaned-items waarvan de site niet meer bestaat en dead-items waarvan de map is verdwenen, plus het aantal missing-routedocumenten in de resterende items. map prune (Static_Prerender_Early_Serve::prune_map()) verwijdert verweesde en inactieve items onder de mapvergrendeling en vermeldt de reden voor elk item; --dry-run geeft alleen een rapport. Door de laatste vermelding te verwijderen, worden de map, de drop-in en de declaratie WP_CACHE verwijderd. Als een site uit een multisite-netwerk wordt verwijderd, worden de vermeldingen ervan direct verwijderd. Het opschonen van de cache verzamelt nooit de naamruimte waaruit een geactiveerd artefact wordt geserveerd, zodat vermeldingen alleen inactief worden wanneer hun bestanden op een andere manier worden verwijderd.

Bekijk afzonderlijke response-uitkomsten met blockstudio/static_prerender/outcome en alle uitkomsten van gedeelde caches met blockstudio/cache/outcome.

Verwijderen

Installaties zonder een plugin-deactivatiehook, zoals installaties gebundeld met Composer, kunnen in één opdracht alles verwijderen wat de functie beheert:

Shell
wp bs teardown

Hiermee worden de cron-gebeurtenissen en de status voor statisch prerenderen verwijderd die een installatie beheert: de mapvermelding van de huidige site, en de gedeelde drop-in en declaratie WP_CACHE zodra de laatste beheerde vermelding is verdwenen. Configuratiebestanden blijven onaangeroerd, zodat u de functie weer schoon kunt inschakelen.

In gebruik nemen in productie

Een logische volgorde voor invoering:

  1. Stel performance.profile in op speed en controleer daarna de head-uitvoer, feeds en plugins die afhankelijk zijn van oEmbed of XML-RPC.
  2. Genereer assets/media.json, verplaats templates naar bs_media_image() en schakel daarna performance.media.lazy in.
  3. Schakel performance.staticPrerender in met earlyServe uitgeschakeld. Controleer de hits met wp bs prerender status en schakel daarna earlyServe in.

Terugdraaien gebeurt per functie: door staticPrerender.enabled in te stellen op false worden de door Blockstudio beheerde Early Serve-status en warm-planningen eenmalig verwijderd; daarna blijft de prerender-runtime niet geregistreerd. Door performance.profile weer in te stellen op compat wordt het profiel teruggedraaid. Beide laten de andere lagen intact.

Prestaties

De profielen, profiler en onderliggende rendermethoden.

Caching

De enige cachemap waarin alle gegenereerde artefacten staan.