Treci la conținut

Prerandare statică

Prerandarea statică este un cache anonim HTML care trebuie activat explicit. Un răspuns care poate fi memorat în cache trebuie să fie un document HTML complet și poate renunța la cache prin <!-- blockstudio:no-cache -->. Blockstudio ocolește cererile care nu sunt GET, șirurile de interogare, zona de administrare WordPress, REST, Ajax, cron, fluxurile, rezultatele căutării aflate sub baza de căutare de la calea principală a site-ului (cum ar fi /search/term/), antetele de previzualizare și canvas, cererile cu nonce, căile dinamice declarate, cookie-urile pentru parolă/comentarii și, în mod implicit, cererile utilizatorilor autentificați. O pagină a cărei cale conține doar un segment search sau preview mai adânc, cum ar fi /docs/blocks/preview/, este memorată în cache ca orice altă pagină.

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

Utilizatorii autentificați pot folosi o intrare existentă numai dacă serveLoggedIn este true; răspunsurile personalizate nu creează niciodată intrări în cache. Căile dinamice folosesc limite de segment, astfel încât /account se potrivește cu /account/orders, dar nu cu /accounting.

Cât timp funcția este dezactivată, nu scrie fișiere, nu instalează un drop-in și nu înregistrează hook-uri pentru cereri sau administrare. earlyServe: false nu înregistrează nici callback-ul administrativ Early Serve, iar warm.enabled: false nu înregistrează niciun callback cron sau programare. Dezactivarea oricăreia dintre funcții elimină o singură dată starea deținută anterior; cererile ulterioare nu mai fac verificări de curățare a sistemului de fișiere sau cron.

Dezactivarea în funcție de mediu

Fiecare valoare de mai sus poate fi setată și cu un filtru de configurare. Blockstudio pornește înaintea temei active, dintr-un plugin sau din autoloader-ul Composer al temei, așa că își rezolvă din nou setările de execuție după încărcarea temei și decide la after_setup_theme ce hook-uri pentru prerandarea statică să activeze. Prin urmare, un filtru adăugat de un plugin sau în functions.php al temei intră în vigoare:

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

Dezactivarea funcției în acest mod funcționează ca dezactivarea ei în blockstudio.json: nu se înregistrează hook-uri pentru cereri, conținut, administrare sau cron, iar o intrare Early Serve a unui site servit anterior înainte de pornire este eliminată o singură dată. Un filtru adăugat ulterior, de exemplu la init, nu modifică hook-urile înregistrate.

Modurile de semnătură și graf

Modul signature completează un răspuns identificat prin identitate la o ratare obișnuită, anonimă, din cache. Este convenabil pentru site-urile WordPress obișnuite și se rotește după modificări la nivelul site-ului.

Modul graph este destinat integrărilor deterministe de build/deploy. Apelați Static_Prerender_Runtime::build_plan() cu URL-urile sursă active, randați numai affectedUrls, apoi înregistrați fiecare rezultat cu persist_built_response() sau persist_skipped_response(). Planul compară fișierele partajate și hash-urile exacte ale dependențelor fiecărei pagini. URL-urile șterse și HTML fără referințe sunt eliminate de 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);

Argumentele opționale pentru gazda/direcția principală țintă rescriu rutele pentru o implementare fără a folosi calea primei pagini drept rădăcină a site-ului. Instrumentele batch pot folosi Static_Prerender_Batch_Renderer::render() și fragmente stabile N/TOTAL; opțiunea pentru fragmente se bazează pe Static_Prerender_Batch_Renderer::parse_shard() și select_shard(), astfel încât apelantul să poată calcula aceeași partiție pe care ar folosi-o motorul de randare. Într-un build, Static_Prerender_Batch_Renderer::is_rendering() indică dacă cererea curentă este o randare batch, nu o vizită, astfel încât un șablon să poată omite lucrurile care nu trebuie executate în timpul unui build. Un transport internal este furnizat de filtrul generic blockstudio/static_prerender/render_internal; alternativa opțională HTTP folosește antetul obișnuit de încălzire.

Ce urmărește modul graf

Cu transportul implicit HTTP, Static_Prerender_Batch_Renderer::render() trimite fiecărei cereri de încălzire un token semnat, iar cererea raportează fișierele citite: șablonul de randare WordPress încărcat, șablonul, fișierele de șablon și fișierele de resurse ale fiecărui bloc Blockstudio randat, fișierele adăugate prin blockstudio/render/dependencies și, pentru o pagină sincronizată, fișierele de definiție, șablon, conținut și aspect. Raportul este scris în directorul cache al site-ului, pe care motorul de randare și serverul web îl partajează deja pentru elementele randate HTML. La următorul build, build_plan() calculează din nou hash-urile acelor fișiere și marchează numai rutele ale căror fișiere s-au modificat, împreună cu rutele noi, rutele care au depășit ttl și fiecare rută când se modifică un fișier partajat (blockstudio.json, theme.json, style.css, functions.php, header.php, footer.php, tot ce se află sub inc/, parts/ și templates/, precum și sursele resurselor UI incluse în Blockstudio). Hash-ul semnăturii partajate folosește sursele, niciodată rezultatul compilat, așa că fișierele _dist compilate la prima randare a unui build nu o modifică: artifact_entry() derivă ID-ul build-ului din aceeași semnătură pe care build_plan() a văzut-o înainte de randare.

Conținutul care există doar în baza de date nu este un fișier și nu este urmărit: articolele editate în zona de administrare, opțiunile, rândurile generate sau prețurile. Pentru ca un build să preia astfel de modificări, transmiteți $force către build_plan() sau randați singuri URL-urile afectate. Transportul internal înregistrează dependențele returnate de filtrul său.

Servire timpurie și implementare atomică

Cu earlyServe activat, Blockstudio gestionează un mic wp-content/blockstudio-static-prerender-map.php, un drop-in advanced-cache.php și o singură declarație exactă WP_CACHE. Drop-in-ul citește o hartă de rute per site și transmite un răspuns din cache eligibil înainte ca WordPress, pluginurile sau tema să pornească.

Blockstudio nu suprascrie niciodată o hartă, un drop-in sau o declarație WP_CACHE care aparțin altcuiva. Artefactele grafului validează fiecare fișier HTML menționat înainte ca harta să fie înlocuită; graful anterior rămâne activ dacă validarea eșuează. Intrările multisite partajează harta, dar sunt izolate după gazdă, calea principală și ID-ul site-ului. Dezactivarea funcției sau dezactivarea Blockstudio elimină doar intrarea site-ului curent și elimină artefactele partajate numai după dispariția ultimei intrări gestionate.

Instrumentele de implementare pot activa atomic un graf randat complet:

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

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

Configurația rămâne autoritară. install_artifact_entry() returnează false dacă și numai dacă atât enabled, cât și earlyServe sunt true, astfel încât o implementare nu poate instala o hartă, un drop-in și o declarație WP_CACHE pe care următoarea cerere de administrare le-ar elimina din nou.

install_artifact_entry() păstrează build_id al intrării, astfel încât o implementare să îl poată compara cu intrarea pe care installed_map_entries() o returnează ulterior. Harta este un fișier PHP citit cu include, iar fiecare scriere îl elimină din cache-ul opcode-urilor, astfel încât acea citire să vadă intrarea nouă în același proces, chiar și când opcache.enable_cli este activat.

Instalarea unui artefact promovează documentele sale într-un domeniu de artefacte dedicat, pe care curățarea prin retenție nu îl atinge, iar fișierele la care face referire harta sunt protejate de eliminare oriunde s-ar afla. Astfel, traficul de randare activ nu poate face rutele mapate să iasă din servirea timpurie din cauza vechimii. O cheie de rută nu este adresată complet după conținut, așa că o nouă randare poate modifica un document fără să-i schimbe cheia; instalarea compară octeții și înlocuiește atomic documentele de artefact diferite, lasă neschimbate documentele identice și păstrează documentele de artefact a căror copie din stocare a dispărut. Static_Prerender_Early_Serve::last_promotion() raportează câte rute au fost promovate, înlocuite, omise sau păstrate la ultima instalare, pentru ca implementarea să poată înregistra acest lucru.

Un document stocat fixează resursele build-ului la care face legătura prin URL, iar aceste fișiere au propria politică de retenție, astfel încât unul poate supraviețui celuilalt. Înainte de servire, atât cache-ul PHP, cât și drop-in-ul verifică dacă foaia de stil Tailwind cu hash de conținut la care se face legătura există încă pe disc. Un document a cărui foaie de stil lipsește este trimis către WordPress în loc să fie servit fără stil, ceea ce republică împreună foaia de stil și documentul. Aceeași verificare se execută înainte de stocarea unui răspuns, așadar un document care nu ar putea fi servit nu este niciodată scris.

O cerere al cărei antet Accept conține text/markdown ocolește atât stocarea PHP, cât și drop-in-ul, deoarece documentele stocate sunt HTML, iar o pagină poate răspunde acelei cereri cu sursa Markdown. Prin urmare, documentele servite trimit Vary: Accept. Actualizarea Blockstudio rescrie un drop-in mai vechi la următoarea scriere a hărții.

Rutele grafului mapate folosesc întotdeauna artefactul activat. Dacă o rută anonimă sigură nu se află în acea hartă, dar WordPress a randat-o și a păstrat-o între timp, Early Serve folosește stocarea de execuție identificată prin identitate înainte de pornirea WordPress. Astfel sunt acceptate rutele generate sau cele de nișă, din afara grafului de implementare delimitat intenționat. Alternativa folosește identitatea grafului activat și aceleași reguli pentru gazdă, normalizarea căii, TTL, cookie-uri, antete, șiruri de interogare, căi dinamice și ocolirea fluxurilor ca rutele mapate; găsește doar documentele păstrate în stocarea de execuție, care nu includ niciodată rezultatele căutării.

Antete de răspuns

Un document stocat este redat fără solicitarea care l-a generat, așa că un antet trimis de o temă sau de un plugin prin header() ar lipsi de la fiecare accesare. Blockstudio stochează pentru fiecare document antetele specificate în replayHeaders și le trimite din nou atât din cache-ul PHP, cât și din componenta drop-in de servire timpurie. Valoarea implicită, ["Link"], include antete precum o alternativă Markdown (rel="alternate"; type="text/markdown"), rel="describedby" sau rel="canonical". Numele sunt potrivite fără a ține cont de majuscule, iar filtrul setării modifică lista ca orice altă valoare:

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

    return $headers;
});

Setați replayHeaders la [] pentru a dezactiva redarea din nou a antetelor. O listă explicită înlocuiește valorile implicite, așa că includeți Link când adăugați alte nume de antete, dacă doriți în continuare redarea antetelor de link.

Antetele sunt capturate în procesul care redă pagina: din headers_list() când este stocată o ratare în timp real și din solicitarea de încălzire însăși când o compilare sau componenta de încălzire redă peste HTTP, astfel că un antet adăugat de serverul web și adăugat din nou la fiecare document servit nu este stocat niciodată. Numai când o redare HTTP nu scrie niciun raport sunt folosite antetele răspunsului său. Transportul internal le returnează ca headers în rezultat, iar persist_built_response() le primește ca ultim argument, fie sub formă de linii Name: value, fie ca mapare de la nume la valoare.

Acestea sunt scrise în <key>.headers.json alături de document, îl urmează în timpul promovării artefactelor, al colectării gunoiului și al curățării elementelor expirate și sunt eliminate când o nouă redare nu trimite niciunul. Antetele pentru cookie-uri, cache și transport nu sunt niciodată stocate sau redate, chiar dacă sunt enumerate: Set-Cookie, Cache-Control, Expires, Pragma, Age, ETag, Last-Modified, Vary, Content-Type, Content-Length, Content-Encoding, Transfer-Encoding, Location, Status, Date, precum și antetele hop-by-hop și de autentificare. Un document servit își setează propriile Content-Type și Vary.

Antetele stocate sunt verificate din nou în raport cu lista când sunt trimise. Cache-ul PHP citește setarea curentă; componenta drop-in citește copia din intrarea hărții site-ului, pe care următoarea instalare de artefact sau sincronizare a hărții o actualizează. Documentele stocate înainte de o actualizare nu au fișier de antete și sunt servite exact ca înainte, până când sunt redate din nou.

Încălzire, întreținere și observabilitate

Coada de încălzire este persistentă, comasează după URL, permite o singură execuție simultană și recuperează revendicările expirate. Modificările de conținut și de site impun o sarcină de înlocuire chiar dacă semnătura curentă nu s-a modificat; trecerile periodice pun în coadă doar lucrările învechite. Fiecare trecere, programată sau prin wp bs prerender warm, randează până la warm.concurrency de sarcini. Modul graph dezactivează încălzitorul per URL, deoarece artefactele grafului sunt construite și activate ca o singură unitate.

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 raportează identitatea activă, fișierele, octeții, înregistrările grafului, starea cozii, raportul hărții de servire timpurie și contoarele de accesare/ratări/build-uri/eșecuri pentru fiecare domeniu.

Harta de servire timpurie este partajată de toate site-urile unei instalări. map status (și Static_Prerender_Early_Serve::map_report()) enumeră intrările pe care servirea timpurie nu le mai poate folosi: intrările orphaned al căror site nu mai există și intrările dead al căror director a dispărut, precum și numărul de documente de rută missing din intrările rămase. map prune (Static_Prerender_Early_Serve::prune_map()) elimină intrările orfane și inactive sub blocarea hărții și raportează motivul fiecăreia; --dry-run doar le raportează. Eliminarea ultimei intrări șterge harta, drop-in-ul și declarația WP_CACHE. Ștergerea unui site dintr-o rețea multisite îi elimină imediat intrările, iar curățarea cache-ului nu colectează niciodată spațiul de nume din care este servit un artefact activat, astfel că intrările devin inactive doar când fișierele lor sunt eliminate prin alte mijloace.

Urmăriți rezultatele fiecărui răspuns cu blockstudio/static_prerender/outcome și toate rezultatele cache-ului partajat cu blockstudio/cache/outcome.

Dezinstalare

Instalările fără un hook de dezactivare a pluginului, cum ar fi configurările incluse în Composer, pot elimina tot ce gestionează funcția printr-o singură comandă:

Shell
wp bs teardown

Elimină evenimentele cron și starea de prerandare statică gestionată de instalare: intrarea din harta site-ului curent și drop-in-ul partajat, precum și declarația WP_CACHE după dispariția ultimei intrări gestionate. Fișierele de configurare rămân intacte, astfel încât reactivarea funcției pornește curat.

Adoptarea în producție

O ordine rezonabilă de adoptare:

  1. Setați performance.profile la speed, apoi verificați ieșirea head, fluxurile și orice plugin care se bazează pe oEmbed sau pe XML-RPC.
  2. Generați assets/media.json, mutați șabloanele în bs_media_image(), apoi activați performance.media.lazy.
  3. Activați performance.staticPrerender cu earlyServe dezactivat, verificați accesările din cache cu wp bs prerender status, apoi activați earlyServe.

Revenirea se face pentru fiecare funcție: setarea staticPrerender.enabled la false elimină o singură dată starea Early Serve gestionată de Blockstudio și programările de încălzire, apoi lasă motorul de prerandare neînregistrat. Setarea performance.profile înapoi la compat anulează profilul. Fiecare lasă celelalte straturi intacte.

Performanță

Profilurile, profilerul și tehnicile de randare care stau la bază.

Cache

Singurul director cache în care se află toate artefactele generate.