Статический пререндеринг
Статический пререндеринг — это анонимный кэш HTML, включаемый по желанию. Кэшируемый ответ должен быть полным документом HTML; от кэширования можно отказаться с помощью <!-- blockstudio:no-cache -->. Blockstudio пропускает запросы не типа GET, строки запроса, админку WordPress, REST, Ajax, cron, ленты, результаты поиска за пределами базового пути поиска на главной странице сайта (например, /search/term/), заголовки предварительного просмотра и холста, запросы с nonce, объявленные динамические пути, cookie пароля или комментария, а также по умолчанию запросы авторизованных пользователей. Страница, в пути которой сегмент search или preview встречается только глубже, например /docs/blocks/preview/, кэшируется как любая другая страница.
{
"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; персонализированные ответы никогда не создают записи кэша. Для динамических путей учитываются границы сегментов: /account соответствует /account/orders, но не /accounting.
Пока функция отключена, она не записывает файлы, не устанавливает drop-in и не регистрирует хуки запросов или админки. earlyServe: false также не регистрирует административный callback Early Serve, а warm.enabled: false не регистрирует callback cron или расписание. При отключении любой из функций принадлежащее ей состояние удаляется один раз; последующие запросы не выполняют проверку файловой системы или очистки cron.
Отключение для конкретного окружения
Каждое значение выше также можно задать с помощью фильтра настроек. Blockstudio загружается до активной темы — из плагина или автозагрузчика Composer темы, — поэтому после загрузки темы он заново определяет настройки среды выполнения и решает, регистрировать ли хуки статического пререндеринга на этапе after_setup_theme. Поэтому фильтр, добавленный плагином или в файле functions.php темы, начинает действовать:
add_filter('blockstudio/settings/performance/staticPrerender/enabled', function ($enabled) {
return 'local' === wp_get_environment_type() ? false : $enabled;
});
Отключение функции таким способом работает так же, как отключение в blockstudio.json: хуки запросов, содержимого, админки и cron не регистрируются, а запись Early Serve для сайта, ранее обслуживавшегося на раннем этапе, удаляется один раз. Фильтр, добавленный позднее, например на init, не меняет набор зарегистрированных хуков.
Режимы подписи и графа
Режим signature заполняет ответ с ключом идентичности при обычном промахе кэша для анонимного пользователя. Он удобен для обычных сайтов WordPress и обновляется после изменений на уровне сайта.
Режим graph предназначен для детерминированной интеграции со сборкой и развёртыванием. Вызовите Static_Prerender_Runtime::build_plan() с исходными URL сайта, отрендерьте только affectedUrls, затем сохраните каждый результат с помощью persist_built_response() или persist_skipped_response(). План сравнивает общие файлы и точные хеши зависимостей каждой страницы. Удалённые URL и неиспользуемые файлы HTML удаляет 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);
Необязательные аргументы целевого хоста и главной страницы позволяют переписать маршруты для развёртывания, не используя путь первой страницы в качестве корня сайта. Пакетные инструменты могут использовать 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; при ошибке проверки предыдущий граф остаётся активным. В Multisite-записях используется общая карта, но они изолированы по хосту, пути главной страницы и ID сайта. При отключении функции или деактивации Blockstudio удаляется только запись текущего сайта, а общие артефакты — лишь после удаления последней принадлежащей системе записи.
Инструменты развёртывания могут атомарно активировать полностью отрендеренный граф:
$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, поэтому развёртывание не установит карту, 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, и drop-in, поскольку сохранённые документы являются HTML, а страница может ответить на такой запрос своим источником Markdown. Поэтому обслуживаемые документы отправляют Vary: Accept. При обновлении Blockstudio старая версия drop-in будет перезаписана при следующей записи карты.
Маршруты графа, указанные в карте, всегда используют активированный артефакт. Если безопасного анонимного маршрута нет в карте, но WordPress уже отрендерил и сохранил его, Early Serve перед запуском WordPress обращается к резервному хранилищу среды выполнения с ключом идентичности. Это позволяет обслуживать сгенерированные маршруты и маршруты с редкими посещениями, не включённые в намеренно ограниченный граф развёртывания. Резервный вариант использует идентификатор активированного графа и те же правила обхода для хоста, нормализации пути, TTL, cookie, заголовка, строки запроса, динамического пути и ленты, что и маршруты из карты; при этом он находит только документы, сохранённые средой выполнения, а в них никогда нет результатов поиска.
Заголовки ответа
Сохранённый документ воспроизводится без запроса, при обработке которого он был создан, поэтому заголовок, отправляемый темой или плагином вместе с header(), отсутствовал бы при каждом обращении. Blockstudio сохраняет заголовки, указанные в replayHeaders, вместе с каждым документом и отправляет их снова как из кэша PHP, так и из drop-in для ранней отдачи. Значение по умолчанию, ["Link"], включает такие заголовки, как альтернативный Markdown для rel="alternate"; type="text/markdown", rel="describedby" или rel="canonical". Имена сравниваются без учёта регистра, а фильтр настройки изменяет список так же, как и любое другое значение:
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 рядом с документом, перемещаются вместе с ним при продвижении артефактов, сборке мусора и очистке по сроку хранения и удаляются, если при повторном формировании заголовки не отправляются. Заголовки cookie, кэширования и транспорта никогда не сохраняются и не воспроизводятся, даже если они указаны в списке: 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 использует текущую настройку; drop-in использует её копию из записи карты сайта, которую обновляет следующая установка артефакта или синхронизация карты. У документов, сохранённых до обновления, нет файла заголовков, и они отдаются как прежде, пока не будут сформированы заново.
Прогрев, обслуживание и мониторинг
Очередь прогрева надёжна, объединяет дубликаты по 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. Удаление сайта из сети Multisite сразу убирает его записи; очистка кэша никогда не затрагивает пространство имён, из которого обслуживаются активированные артефакты, поэтому записи становятся недействительными только при удалении их файлов другим способом.
Отслеживайте результаты отдельных ответов с помощью blockstudio/static_prerender/outcome, а все результаты общего кэша — с помощью blockstudio/cache/outcome.
Удаление
Установки без хука деактивации плагина, например конфигурации со встроенным Composer, могут удалить всё принадлежащее функции одной командой:
wp bs teardown
Команда удаляет события cron и состояние статического пререндеринга, принадлежащее установке: запись карты текущего сайта, а также общий drop-in и директиву WP_CACHE после удаления последней принадлежащей системе записи. Файлы конфигурации остаются нетронутыми, поэтому функцию можно снова включить с чистого состояния.
Внедрение в рабочую среду
Разумная последовательность внедрения:
- Задайте для
performance.profileзначениеspeed, затем проверьте вывод в head, ленты и все плагины, зависящие от oEmbed или XML-RPC. - Создайте
assets/media.json, переместите шаблоны вbs_media_image(), затем включитеperformance.media.lazy. - Включите
performance.staticPrerender, оставивearlyServeвыключенным, проверьте попадания с помощьюwp bs prerender status, затем включитеearlyServe.
Откат выполняется отдельно для каждой функции: установка для staticPrerender.enabled значения false один раз удаляет состояние Early Serve и расписания прогрева, принадлежащие Blockstudio, после чего среда выполнения пререндеринга перестаёт регистрироваться. Возврат performance.profile к значению compat отменяет профиль. Остальные уровни при этом сохраняются.
Профили, профилировщик и применяемые методы рендеринга.
Единственный каталог кэша для всех созданных артефактов.