コンテンツへスキップ

静的プリレンダリング

静的プリレンダリングは、オプトイン方式の匿名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には一致しません。

この機能が無効な間は、ファイルを書き込まず、ドロップインをインストールせず、リクエストや管理画面のフックも登録しません。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モードは、通常の匿名アクセスでキャッシュが見つからない場合に、IDをキーとするレスポンスを生成します。一般的なWordPressサイトに便利で、サイトレベルの変更後に更新されます。

graphモードは、決定論的なビルド/デプロイ連携向けです。公開中のソースURLを指定してStatic_Prerender_Runtime::build_plan()を呼び出し、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フォールバックを使う場合は、通常のwarmヘッダーを使用します。

グラフモードが追跡する内容

デフォルトの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()は、レンダリング前にbuild_plan()が確認したものと同じシグネチャからビルドIDを導出します。

データベースにのみ存在するコンテンツはファイルではないため、追跡されません。管理画面で編集した投稿、オプション、生成された行、価格などが該当します。こうした変更をビルドに反映するには、$forceをbuild_plan()に渡すか、影響を受けるURLを自分でレンダリングします。internalトランスポートは、フィルターが返す依存関係を記録します。

早期配信とアトミックなデプロイ

earlyServeを有効にすると、Blockstudioは小さなwp-content/blockstudio-static-prerender-map.php、advanced-cache.phpドロップイン、および厳密なWP_CACHE宣言を管理します。ドロップインはサイトごとのルートマップを読み込み、該当するキャッシュがあれば、WordPress、プラグイン、テーマが起動する前にストリーミング配信します。

Blockstudioは、他のものが所有するマップ、ドロップイン、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の場合は例外です。そのため、デプロイでマップ、ドロップイン、WP_CACHE宣言をインストールしても、次の管理画面リクエストで再び削除されることはありません。

install_artifact_entry()はエントリーのbuild_idを保持するため、デプロイ後にinstalled_map_entries()が返すエントリーと比較できます。マップはPHPファイルで、includeを使って読み込まれます。書き込みのたびにオペコードキャッシュから削除されるため、opcache.enable_cliが有効でも同じプロセス内で新しいエントリーを読み取れます。

アーティファクトをインストールすると、そのドキュメントは専用のアーティファクトスコープに移され、保持期間に基づくプルーニングの対象外になります。マップが参照するファイルは、保存場所にかかわらず削除対象にならないため、通常のレンダリング処理でルートが早期配信対象から外れることはありません。ルートキーは完全なコンテンツアドレスではないため、再レンダリングでキーが変わらずにドキュメントが変わる場合があります。インストール時にバイト列を比較し、異なるアーティファクトドキュメントはアトミックに置き換え、同一のドキュメントはそのままにし、ストア側のコピーがなくなったアーティファクトドキュメントも保持します。Static_Prerender_Early_Serve::last_promotion()は、前回のインストールで昇格、置換、スキップ、保持されたルート数を報告するため、デプロイ時にログへ記録できます。

保存されたドキュメントは、URLでリンクするビルドアセットを固定します。それぞれ保持期間が別なので、片方だけが残ることもあります。配信前に、PHPキャッシュとドロップインの両方が、リンクされたコンテンツハッシュ付きTailwindスタイルシートがディスク上に存在するか確認します。スタイルシートがなくなっているドキュメントは、スタイルなしで配信せずWordPressに渡します。これにより、スタイルシートとドキュメントが一緒に再公開されます。同じ確認はレスポンスを保存する前にも行われ、配信できないドキュメントは書き込まれません。

Acceptヘッダーにtext/markdownが含まれるリクエストは、PHPストアとドロップインの両方を迂回します。保存済みドキュメントはHTMLであり、ページがそのリクエストに対してsource Markdownで応答する場合があるためです。配信されるドキュメントはVary: Acceptを送信します。Blockstudioを更新すると、次回のマップ書き込み時に古いドロップインが書き換えられます。

マップに登録されたグラフルートは、常に有効化されたアーティファクトを使用します。安全な匿名ルートがマップにない場合でも、WordPressがその後レンダリングして保存していれば、Early ServeはWordPressを起動する前にIDをキーとする実行時ストアへフォールバックします。これにより、意図的に範囲を限定したデプロイグラフの対象外にある、生成ルートやロングテールルートにも対応できます。フォールバックでは有効化されたグラフIDを使い、マップルートと同じホスト、パス正規化、TTL、Cookie、ヘッダー、クエリ文字列、動的パス、フィードの迂回ルールを適用します。また、実行時に保存されたドキュメントのみが対象となり、検索結果が含まれることはありません。

レスポンスヘッダー

保存されたドキュメントは、それを生成したリクエストなしで再利用されるため、テーマやプラグインが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に書き込まれ、アーティファクトの昇格、ガベージコレクション、保持期間の整理を通じてドキュメントとともに移動します。再レンダリングでヘッダーが送信されなければ削除されます。リストに含まれていても、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キャッシュは現在の設定を読み込みます。ドロップインはサイトのマップエントリーにあるコピーを読み込み、次回のアーティファクトのインストールまたはマップの同期時に更新されます。アップグレード前に保存されたドキュメントにはヘッダーファイルがないため、再レンダリングされるまでは従来どおりに配信されます。

ウォームアップ、メンテナンス、可観測性

ウォームキューは永続的で、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は、アクティブなID、ファイル、バイト数、グラフレコード、キューの状態、早期配信マップのレポート、およびスコープごとのヒット/ミス/ビルド/失敗カウンターを報告します。

早期配信マップは、インストール内のすべてのサイトで共有されます。map status(およびStatic_Prerender_Early_Serve::map_report())では、早期配信で使用できなくなったエントリーを一覧できます。対象は、サイトが存在しなくなったorphanedエントリー、ディレクトリがなくなったdeadエントリー、および残っているエントリー内のmissingルートドキュメント数です。map prune(Static_Prerender_Early_Serve::prune_map())は、マップロック中に孤立したエントリーと無効なエントリーを削除し、それぞれの理由を報告します。--dry-runは報告のみを行います。最後のエントリーを削除すると、マップ、ドロップイン、WP_CACHE宣言も削除されます。マルチサイトネットワークからサイトを削除すると、そのエントリーも直ちに削除されます。また、キャッシュのクリーンアップで有効化済みアーティファクトの配信元ネームスペースが収集されることはないため、ファイルが他の手段で削除された場合にのみエントリーが無効になります。

blockstudio/static_prerender/outcomeで個々のレスポンス結果を、blockstudio/cache/outcomeですべての共有キャッシュ結果を確認できます。

アンインストール

Composerにバンドルされた環境など、プラグインの無効化フックがないインストールでは、機能が管理するすべてのものを1つのコマンドで削除できます。

シェル
wp bs teardown

インストールが所有するcronイベントと静的プリレンダリング状態を削除します。対象は現在のサイトのマップエントリーと、最後の所有エントリーがなくなった後の共有ドロップインおよびWP_CACHE宣言です。設定ファイルはそのまま残るため、機能を再度有効にするとクリーンな状態で開始できます。

本番環境への導入

導入は次の順序がおすすめです。

  1. performance.profileをspeedに設定し、headの出力、フィード、oEmbedまたはXML-RPCに依存するプラグインを確認します。
  2. assets/media.jsonを生成し、テンプレートをbs_media_image()に移してから、performance.media.lazyを有効にします。
  3. earlyServeをオフにしたままperformance.staticPrerenderを有効にし、wp bs prerender statusでヒットを確認してから、earlyServeを有効にします。

ロールバックは機能ごとに行います。staticPrerender.enabledをfalseに設定すると、Blockstudioが所有するEarly Serveの状態とウォームスケジュールが一度削除され、その後プリレンダリングランタイムが登録解除されます。performance.profileをcompatに戻すと、プロファイルが元に戻ります。それぞれ、他のレイヤーは維持されます。

パフォーマンス

プロファイル、プロファイラー、およびその基盤となるレンダリング手法。

キャッシュ

生成されたすべてのアーティファクトが保存される唯一のキャッシュディレクトリ。