Към съдържанието

Статично предварително визуализиране

Статичното предварително визуализиране е кеш за анонимни HTML, който се включва по избор. Кешируемият отговор трябва да е пълен документ HTML и може да се изключи с <!-- blockstudio:no-cache -->. Blockstudio пропуска заявки, различни от GET, низове за заявка, администраторската част на WordPress, REST, Ajax, cron, емисии, резултати от търсене извън основния път за търсене на началната страница на сайта (например /search/term/), заглавки за предварителен преглед и платно, заявки с nonce, декларирани динамични пътища, бисквитки за пароли/коментари и заявки от влезли потребители по подразбиране. Страница, чийто път съдържа search или preview само в по-дълбок сегмент, например /docs/blocks/preview/, се кешира като всяка друга страница.

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

Влезлите потребители могат да използват съществуващ кеширан отговор само когато serveLoggedIn е true; персонализираните отговори никога не създават записи в кеша. Динамичните пътища използват граници на пътя, така че /account съвпада с /account/orders, но не и с /accounting.

Докато функцията е изключена, тя не записва файлове, не инсталира drop-in и не регистрира куки за заявки или администраторската част. earlyServe: false също не регистрира администраторски callback за ранно обслужване, а warm.enabled: false не регистрира callback cron или график. Изключването на която и да е от функциите премахва веднъж състоянието, което тя притежава; следващите заявки не правят проверки за почистване на файловата система или cron.

Изключване за всяка среда

Всяка стойност по-горе може да се зададе и с филтър за настройки. Blockstudio се стартира преди активната тема, от плъгин или чрез автозареждането Composer на темата, затова след зареждането на темата отново разрешава настройките си по време на изпълнение и определя куките за статично предварително визуализиране при after_setup_theme. Следователно филтър, добавен от плъгин или във файла functions.php на темата, влиза в сила:

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

Изключването на функцията по този начин работи като изключването ѝ в blockstudio.json: не се регистрират куки за заявки, съдържание, администраторската част или cron, а записът за ранно обслужване на сайт, който преди е бил обслужван рано, се премахва веднъж. Филтър, добавен по-късно, например при init, не променя кои куки се регистрират.

Режими за подпис и граф

Режимът signature попълва отговор с ключ по идентичност при обикновено кеширане на анонимна заявка. Той е удобен за стандартни сайтове WordPress и се завърта след промени на ниво сайт.

Режимът graph е предназначен за детерминистични интеграции за компилация/внедряване. Извикайте Static_Prerender_Runtime::build_plan() с URL адресите на източниците в реална среда, визуализирайте само affectedUrls, след което запишете всеки резултат чрез persist_built_response() или persist_skipped_response(). Планът сравнява споделените файлове и хешовете на точните зависимости за всяка страница. Изтритите URL адреси и HTML, към които няма препратки, се премахват от 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);

Незадължителните аргументи за целеви хост/начална страница пренаписват маршрутите за внедряване, без пътят на първата страница да се използва като корен на сайта. Пакетните инструменти могат да използват Static_Prerender_Batch_Renderer::render() и стабилни части N/TOTAL; опцията за части използва Static_Prerender_Batch_Renderer::parse_shard() и select_shard(), така че извикващият код може да изчисли същото разпределение, което би направил визуализаторът. По време на компилация Static_Prerender_Batch_Renderer::is_rendering() показва дали текущата заявка е пакетно визуализиране, а не заявка от посетител, за да може шаблонът да пропусне работа, която не трябва да се изпълнява по време на компилация. Транспорт internal се предоставя чрез общия филтър blockstudio/static_prerender/render_internal; незадължителният резервен вариант HTTP използва стандартната заглавка за подгряване.

Какво следи режимът на графа

При транспорт по подразбиране HTTP, Static_Prerender_Batch_Renderer::render() изпраща подписан токен с всяка заявка за подгряване, а заявката отчита прочетените файлове: заредения шаблон WordPress, шаблона, файловете с шаблони и файловете с ресурси на всеки визуализиран блок Blockstudio, файловете, добавени чрез blockstudio/render/dependencies, а за синхронизирана страница — файловете с дефиниция, шаблон, съдържание и оформление. Отчетът се записва в директорията за кеш на сайта, която визуализаторът и уеб сървърът вече споделят за визуализираното HTML. При следващата компилация build_plan() отново изчислява хешовете на тези файлове и маркира само маршрутите, чиито файлове са променени, заедно с новите маршрути, маршрутите с изтекъл срок ttl и всички маршрути при промяна на споделен файл (blockstudio.json, theme.json, style.css, functions.php, header.php, footer.php, всичко в inc/, parts/ и templates/, както и източниците на пакетните ресурси UI на Blockstudio). Споделеният хеш на подписа обхваща източниците, а не компилирания резултат, така че файловете _dist, компилирани при първото визуализиране на компилацията, не го променят: artifact_entry() извежда идентификатора на компилацията от същия подпис, който build_plan() е видял преди визуализирането.

Съдържанието, което съществува само в базата данни, не е файл и не се проследява: публикации, редактирани в администраторската част, опции, генерирани редове или цени. Компилация, която трябва да включи такива промени, подава $force на build_plan() или сама визуализира засегнатите URL адреси. Транспортът internal записва зависимостите, върнати от неговия филтър.

Ранно обслужване и атомарно внедряване

При включен earlyServe, Blockstudio управлява малък wp-content/blockstudio-static-prerender-map.php, drop-in advanced-cache.php и една точна декларация WP_CACHE. Drop-in чете карта на маршрутите за конкретния сайт и предава поточно подходящ кеширан отговор преди стартирането на WordPress, плъгините или темата.

Blockstudio никога не презаписва чужда карта, drop-in или декларация WP_CACHE. Артефактите на графа проверяват всеки посочен файл HTML, преди картата да бъде сменена; ако проверката не успее, предишният граф остава активен. Записите за мултисайт споделят картата, но са изолирани по хост, начален път и идентификатор на сайта. Изключването на функцията или деактивирането на Blockstudio премахва само записа на текущия сайт, а споделените артефакти се премахват едва след изтриването на последния собствен запис.

Инструментите за внедряване могат атомарно да активират напълно визуализиран граф:

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

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

Конфигурацията остава водеща. install_artifact_entry() връща false, освен ако и enabled, и earlyServe не са true, така че внедряването никога не може да инсталира карта, drop-in и декларация WP_CACHE, които следващата администраторска заявка да премахне отново.

install_artifact_entry() запазва build_id на записа, така че внедряването може да го сравни със записа, който installed_map_entries() връща след това. Картата е файл PHP, който се чете с include, а при всяко записване се премахва от кеша на кодовете за операции, така че това прочитане вижда новия запис в същия процес дори когато opcache.enable_cli е включен.

Инсталирането на артефакт прехвърля документите му в обхват, предназначен за артефакти, който изчистването според срока на съхранение никога не засяга. Файловете, посочени от картата, също не подлежат на изтриване, където и да се намират, така че трафикът от визуализиране на живо не може да премахне картографирани маршрути от ранното обслужване. Ключът на маршрута не адресира изцяло съдържанието, затова повторното визуализиране може да промени документ, без да промени ключа му; при инсталиране се сравняват байтовете и различаващият се документ на артефакта се заменя атомарно, идентичните документи остават непроменени, а документ на артефакт се запазва дори ако копието му в хранилището е изчезнало. Static_Prerender_Early_Serve::last_promotion() отчита броя маршрути, прехвърлени, заменени, пропуснати или запазени при последното инсталиране, за да може внедряването да ги запише в дневника.

Съхраненият документ фиксира ресурсите на компилацията, към които сочи чрез URL, а тези файлове имат собствен срок на съхранение, затова единият може да надживее другия. Преди обслужване кешът PHP и drop-in проверяват дали свързаният хеширан по съдържание стилов файл Tailwind все още съществува на диска. Документ, чийто стилов файл липсва, се предава на WordPress вместо да се обслужи без стилове; така стиловият файл и документът се публикуват отново заедно. Същата проверка се извършва преди съхраняването на отговор, така че документ, който не може да бъде обслужен, никога не се записва.

Заявка, чиято заглавка Accept съдържа text/markdown, заобикаля както хранилището PHP, така и разширението, защото съхранените документи са HTML, а страницата може да отговори на заявката с източникMarkdown. Затова предоставените документи изпращат Vary: Accept. При актуализиране на Blockstudio по-старото разширение се презаписва при следващия запис на картата.

Картографираните маршрути на графа винаги използват активирания артефакт. Ако безопасен анонимен маршрут не е в тази карта, но WordPress вече го е визуализирал и запазил, ранното обслужване използва хранилището по идентичност от средата на изпълнение, преди да стартира WordPress. Това поддържа генерирани маршрути или маршрути с малък трафик извън умишлено ограничен граф за внедряване. Резервният вариант използва идентичността на активирания граф и същите правила за нормализиране на хост и път, TTL, бисквитки, заглавки, низове за заявка, динамични пътища и пропускане на емисии като картографираните маршрути; той намира само документи, съхранени от средата на изпълнение, които никога не включват резултати от търсене.

Заглавки на отговора

Съхраненият документ се възпроизвежда без заявката, която го е генерирала, затова заглавка, изпратена от тема или плъгин с header(), би липсвала при всяко зареждане от кеша. Blockstudio съхранява заглавките, посочени в replayHeaders, заедно с всеки документ и ги изпраща отново както от кеша PHP, така и от добавката за ранно обслужване. Настройката по подразбиране ["Link"] обхваща заглавки като алтернативна връзка Markdown за rel="alternate"; type="text/markdown", rel="describedby" или rel="canonical". Имената не различават малки и главни букви, а филтърът на настройката променя списъка както всяка друга стойност:

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

    return $headers;
});

Задайте replayHeaders на [], за да изключите повторното изпращане на заглавките. Изрично зададеният списък заменя стойностите по подразбиране, затова включете Link, когато добавяте други имена на заглавки, ако все още искате да изпращате заглавките за връзки повторно.

Заглавките се улавят в процеса, който генерира страницата: от headers_list() при съхраняване след пропуск в кеша на живо и от самата заявка за загряване, когато компилация или инструментът за загряване генерира съдържание върху HTTP. Затова заглавка, която уеб сървърът добавя сам и добавя отново към всеки обслужван документ, никога не се съхранява. Заглавките на отговора се използват само когато генериране с HTTP не запише отчет. Транспортът internal ги връща като headers в резултата си, а persist_built_response() ги приема като последен аргумент — или като редове Name: value, или като съпоставяне на имена със стойности.

Те се записват в <key>.headers.json до документа, придружават го при промотирането на артефакти, събирането на боклука и изчистването на изтеклите данни и се премахват, когато повторното генериране не изпрати такива. Заглавките за бисквитки, кеширане и транспорт никога не се съхраняват или изпращат повторно, дори когато са в списъка: Set-Cookie, Cache-Control, Expires, Pragma, Age, ETag, Last-Modified, Vary, Content-Type, Content-Length, Content-Encoding, Transfer-Encoding, Location, Status, Date, както и заглавките за предаване по веригата и удостоверяване. Обслужваният документ задава свои Content-Type и Vary.

Съхранените заглавки отново се проверяват спрямо списъка при изпращането им. Кешът PHP използва текущата настройка; добавката за ранно обслужване чете копието в записа на картата на сайта, което се обновява при следващото инсталиране на артефакт или синхронизиране на картата. Документите, съхранени преди надстройка, нямат файл със заглавки и се обслужват както преди, докато не бъдат генерирани отново.

Подгряване, поддръжка и наблюдение

Опашката за подгряване е устойчива, обединяваща URL, допуска само една активна задача и възстановява изтекли резервирания. Промените в съдържанието и сайта налагат заместваща задача дори когато текущият подпис не се е променил; периодичните цикли добавят само остаряла работа. Всеки цикъл, планиран или чрез wp bs prerender warm, визуализира до warm.concurrency задачи. Режимът graph изключва подгряването по URL, защото артефактите на графа се компилират и активират като едно цяло.

Обвивка
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 отчита активната идентичност, файловете, байтовете, записите в графа, състоянието на опашката, отчета за картата за ранно обслужване и броячите за попадения/пропуски/компилации/грешки за всеки обхват.

Картата за ранно обслужване се споделя от всички сайтове в инсталацията. map status (и Static_Prerender_Early_Serve::map_report()) показва записите, които ранното обслужване вече не може да използва: записи orphaned за сайтове, които вече не съществуват, и записи dead, чиято директория липсва, както и броя на документите за маршрути missing в останалите записи. map prune (Static_Prerender_Early_Serve::prune_map()) премахва осиротелите и невалидните записи под заключване на картата и отчита причината за всеки; --dry-run само ги отчита. Премахването на последния запис премахва картата, drop-in и декларацията WP_CACHE. Изтриването на сайт от мултисайт мрежа незабавно премахва записите му, а почистването на кеша никога не събира пространството от имена, от което се обслужва активиран артефакт, затова записите стават невалидни само ако файловете им бъдат премахнати по друг начин.

Следете резултатите от отделните отговори чрез blockstudio/static_prerender/outcome, а резултатите от всички споделени кешове — чрез blockstudio/cache/outcome.

Премахване

Инсталации без кука за деактивиране на плъгин, например конфигурации, пакетирани с Composer, могат да премахнат всичко, което функцията управлява, с една команда:

Обвивка
wp bs teardown

Тя премахва събитията cron и състоянието за статично предварително визуализиране, притежавано от инсталацията: записа в картата на текущия сайт, както и споделения drop-in и декларацията WP_CACHE след премахването на последния собствен запис. Конфигурационните файлове остават непокътнати, така че повторното включване на функцията започва без остатъчно състояние.

Внедряване в продукционна среда

Подходящ ред за внедряване:

  1. Задайте performance.profile на speed, след което проверете изхода в head, емисиите и всички плъгини, които разчитат на oEmbed или XML-RPC.
  2. Генерирайте assets/media.json, преместете шаблоните в bs_media_image(), след което включете performance.media.lazy.
  3. Включете performance.staticPrerender при изключено earlyServe, проверете попаденията с wp bs prerender status, след което включете earlyServe.

Връщането назад се извършва за всяка функция поотделно: задаването на staticPrerender.enabled на false премахва веднъж състоянието за ранно обслужване и графиците за подгряване, притежавани от Blockstudio, след което средата за предварително визуализиране остава нерегистрирана. Връщането на performance.profile към compat отменя профила. Всяка промяна запазва останалите слоеве.

Производителност

Профилите, профайлърът и базовите техники за визуализиране.

Кеширане

Единствената директория за кеш, в която се съхранява всеки генериран артефакт.