Перейти до вмісту

Статичний попередній рендеринг

Статичний попередній рендеринг — це кеш для анонімних користувачів, який потрібно ввімкнути явно HTML. Відповідь, яку можна кешувати, має бути повним документом HTML, і для неї можна відмовитися від кешування за допомогою <!-- blockstudio:no-cache -->. Blockstudio оминає запити, що не використовують GET, рядки запиту, адміністративну частину WordPress, REST, Ajax, cron, стрічки, результати пошуку нижче базового шляху пошуку на головному шляху сайту (наприклад, /search/term/), заголовки попереднього перегляду й полотна, запити з nonce, оголошені динамічні шляхи, файли cookie пароля/коментарів і запити авторизованих користувачів за замовчуванням. Сторінка, шлях якої містить сегмент 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 також не реєструє адміністративний зворотний виклик Early Serve, а warm.enabled: false не реєструє зворотний виклик 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 не реєструються, а запис Early Serve для сайту, який раніше обслуговувався завчасно, видаляється одноразово. Фільтр, доданий пізніше, наприклад у 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/, а також джерела об’єднаних ресурсів Blockstudio UI). Спільний підпис хешує джерела, а не скомпільований результат, тому файли _dist, які компілює перший рендеринг збірки, не змінюють його: artifact_entry() формує ID збірки з того самого підпису, який 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, на який вона посилається; якщо перевірка не пройде, попередній граф залишиться активним. Записи багатосайтової мережі спільно використовують карту, але ізольовані за хостом, головним шляхом і ID сайту. Якщо вимкнути функцію або деактивувати 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, і 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". Назви зіставляються без урахування регістру, а фільтр налаштування змінює список, як і будь-яке інше значення:

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 поруч із документом; вони проходять разом із ним через просування артефактів, збирання сміття та очищення за строком зберігання й видаляються, якщо під час повторної генерації не надіслано жодного заголовка. Заголовки файлів 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. Видалення сайту з багатосайтової мережі одразу прибирає його записи, а очищення кешу ніколи не збирає простір імен, з якого обслуговується активований артефакт, тож записи стають неактивними лише коли їхні файли видаляють іншим способом.

Переглядайте результати окремих відповідей за допомогою 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, після чого стан Early Serve і розклади прогрівання, якими керує Blockstudio, видаляються одноразово, а середовище статичного попереднього рендерингу більше не реєструється. Зміна performance.profile на compat скасовує профіль. Решта рівнів залишаються активними.

Продуктивність

Профілі, профайлер і базові методи рендерингу.

Кешування

Єдиний каталог кешу, у якому зберігаються всі згенеровані артефакти.