stale-while-revalidate で最新の状態を維持する

ウェブアプリを提供する際に、即時性と鮮度のバランスを取るのに役立つ追加ツール。

リリースされた機能

stale-while-revalidate を使用すると、デベロッパーは即時性(キャッシュに保存されたコンテンツをすぐに読み込む)と鮮度(キャッシュに保存されたコンテンツの更新が将来使用されるようにする)のバランスを取ることができます。定期的なスケジュールで更新されるサードパーティのウェブサービスやライブラリを管理している場合や、ファーストパーティのアセットの有効期間が短い傾向がある場合は、既存のキャッシュ ポリシーに stale-while-revalidate を追加すると便利です。

Cache-Control レスポンス ヘッダーで max-age とともに stale-while-revalidate を設定する機能は、Chrome 75 と Firefox 68 で利用できます。

stale-while-revalidate をサポートしていないブラウザでは、この設定値は無視され、max-age が使用されます。これについては、後ほど説明します。

どういう意味?

stale-while-revalidate を、キャッシュに保存されたレスポンスが古い可能性があるという考えと、再検証のプロセスの 2 つの部分に分けて見てみましょう。

まず、キャッシュに保存されたレスポンスが「古い」かどうかをブラウザはどのようにして判断するのでしょうか。stale-while-revalidate を含む Cache-Control レスポンス ヘッダーには max-age も含まれている必要があります。max-age で指定された秒数によって、古さが決まります。max-age より新しいキャッシュに保存されたレスポンスは最新と見なされ、古いキャッシュに保存されたレスポンスは古いと見なされます。

ローカルにキャッシュされたレスポンスがまだ新しい場合は、ブラウザのリクエストを満たすためにそのまま使用できます。stale-while-revalidate の観点から、このシナリオでは何もする必要はありません。

ただし、キャッシュに保存されたレスポンスが古い場合は、別の経過時間ベースのチェックが実行されます。キャッシュに保存されたレスポンスの経過時間は、stale-while-revalidate 設定で指定された追加の時間枠内ですか?

古いレスポンスの経過時間がこのウィンドウに該当する場合、ブラウザのリクエストを満たすために使用されます。同時に、キャッシュに保存されたレスポンスの使用を遅らせない方法で、ネットワークに対して「再検証」リクエストが行われます。返されるレスポンスには、以前にキャッシュに保存されたレスポンスと同じ情報が含まれている場合もあれば、異なる場合もあります。いずれの場合も、ネットワーク レスポンスはローカルに保存され、以前にキャッシュされたものが置き換えられます。また、将来の max-age 比較で使用される「鮮度」タイマーがリセットされます。

ただし、古いキャッシュ レスポンスが stale-while-revalidate の期間外になるほど古い場合、ブラウザのリクエストは処理されません。代わりに、ブラウザはネットワークからレスポンスを取得し、それを使用して最初のリクエストを処理するとともに、新しいレスポンスをローカル キャッシュに保存します。

実際の例

以下は、現在の時刻(具体的には、現在の時刻の分)を返す HTTP API の簡単な例です。

このシナリオでは、ウェブサーバーは HTTP レスポンスで次の Cache-Control ヘッダーを使用します。

Cache-Control: max-age=1, stale-while-revalidate=59

この設定は、時刻のリクエストが次の 1 秒以内に繰り返された場合、以前にキャッシュに保存された値がまだ最新であり、再検証なしでそのまま使用されることを意味します。

1 ~ 60 秒後にリクエストが繰り返されると、キャッシュに保存された値は古くなりますが、API リクエストの処理に使用されます。同時に、「バックグラウンド」で再検証リクエストが行われ、将来の使用に備えてキャッシュに新しい値が入力されます。

60 秒以上経過してからリクエストが繰り返されると、古いレスポンスはまったく使用されず、ブラウザのリクエストの処理とキャッシュの再検証の両方が、ネットワークからレスポンスが返されることに依存します。

この 3 つの状態と、それぞれの状態が適用される期間を以下に示します。

前のセクションの情報を図で示しています。

一般的なユースケース

上記の「1 時間あたりの分数」API サービスの例は不自然ですが、想定されるユースケースを示しています。つまり、更新が必要な情報を提供するサービスですが、ある程度の古さは許容されます。

より現実的な例としては、現在の気象条件や、過去 1 時間に作成されたトップニュースの見出しを取得する API などがあります。

一般に、既知の間隔で更新され、複数回リクエストされる可能性が高く、その間隔内では静的なレスポンスは、max-age による短期キャッシュの適切な候補です。max-age に加えて stale-while-revalidate を使用すると、ネットワーク レスポンスをブロックすることなく、より新しいコンテンツでキャッシュから将来のリクエストを処理できる可能性が高くなります。

Service Worker とどのように連携するのか。

stale-while-revalidate について聞いたことがある場合は、Service Worker 内で使用されるレシピのコンテキストで聞いたことがあるでしょう。

Cache-Control ヘッダーを介して stale-while-revalidate を使用することは、Service Worker での使用と類似点があり、鮮度のトレードオフと最大有効期間に関する同じ考慮事項の多くが適用されます。ただし、Service Worker ベースのアプローチを実装するか、Cache-Control ヘッダー構成に依存するかを決定する際に考慮すべき点がいくつかあります。

次のような場合は、サービス ワーカーのアプローチを使用します。

  • ウェブアプリですでにサービス ワーカーを使用している。
  • キャッシュの内容をきめ細かく制御する必要があり、最近使用されていない有効期限ポリシーなどを実装したい。Workbox のキャッシュ有効期限モジュールがこれに役立ちます。
  • 再検証ステップ中にバックグラウンドで古いレスポンスが変更されたときに通知を受け取る。Workbox のブロードキャスト キャッシュ更新モジュールが、この処理に役立ちます。
  • すべての最新のブラウザでこの stale-while-revalidate の動作が必要である。

Cache-Control アプローチを使用する場合

  • ウェブアプリの Service Worker のデプロイとメンテナンスのオーバーヘッドを回避したい。
  • ブラウザの自動キャッシュ管理により、ローカル キャッシュが大きくなりすぎないようにする。
  • 現時点ですべての最新のブラウザでサポートされていないアプローチでも問題ない(2019 年 7 月現在。今後サポートが拡大する可能性があります)。

サービス ワーカーを使用していて、Cache-Control ヘッダーを介して一部のレスポンスで stale-while-revalidate が有効になっている場合、通常、サービス ワーカーはリクエストへのレスポンスを「最初に試行」します。サービス ワーカーが応答しないと判断した場合、または応答の生成プロセスで fetch() を使用してネットワーク リクエストを行う場合、Cache-Control ヘッダーで構成された動作が有効になります。

詳細