ナビゲーション プリロードで Service Worker を高速化する

ナビゲーション プリロードを使用すると、リクエストを並行して行うことで、Service Worker の起動時間を短縮できます。

Browser Support

  • Chrome: 59.
  • Edge: 18.
  • Firefox: 99.
  • Safari: 15.4.

Source

概要

問題

フェッチ イベントを処理するためにサービス ワーカーを使用するサイトに移動すると、ブラウザはサービス ワーカーにレスポンスを要求します。これには、サービス ワーカーの起動(まだ実行されていない場合)と、フェッチ イベントのディスパッチが含まれます。

システム起動時間は、デバイスと条件によって異なります。通常は 50 ミリ秒程度です。モバイルでは 250 ミリ秒ほどです。極端な場合(デバイスが遅い、CPU が過負荷状態)は、500 ミリ秒を超えることがあります。ただし、サービス ワーカーはイベント間でブラウザが決定した時間だけ起動したままになるため、この遅延が発生するのは、ユーザーが新しいタブや別のサイトからサイトに移動した場合など、まれにしか発生しません。

キャッシュから応答する場合は、ネットワークをスキップするメリットが起動の遅延を上回るため、起動時間は問題になりません。しかし、ネットワークを使用して応答する場合は…

ソフトウェアの起動
ナビゲーション リクエスト

ネットワーク リクエストは、Service Worker の起動によって遅延します。

Google は、V8 でのコード キャッシュの使用、フェッチ イベントのない Service Worker のスキップ、Service Worker の投機的起動、その他の最適化により、起動時間の短縮を継続しています。ただし、システム起動時間は常に 0 より大きくなります。

Facebook は、この問題の影響に注目し、ナビゲーション リクエストを並行して実行する方法を求めていました。

ソフトウェアの起動
ナビゲーション リクエスト

ナビゲーション プリロードによる解決

ナビゲーション プリロードは、「ユーザーが GET ナビゲーション リクエストを送信したときに、サービス ワーカーの起動中にネットワーク リクエストを開始する」という機能です。

起動の遅延は依然として存在しますが、ネットワーク リクエストをブロックしないため、ユーザーはコンテンツをより早く取得できます。

以下は、while ループを使用して Service Worker に意図的に 500 ミリ秒の起動遅延を与えた場合の動作を示す動画です。

デモはこちらです。ナビゲーション プリロードのメリットを得るには、ナビゲーション プリロードをサポートするブラウザが必要です。

ナビゲーション プリロードを有効にする

addEventListener('activate',> event = {
  event.waitUntil(async function() {
    // Feature-detect
    if (self.registration.navigationPreload) {
      // Enable navigation preloads!
      await self.registration.navigationPreload.enable();
    }
  }());
});

navigationPreload.enable() はいつでも呼び出すことができます。また、navigationPreload.disable() で無効にすることもできます。ただし、fetch イベントでこれを利用する必要があるため、Service Worker の activate イベントで有効または無効にすることをおすすめします。

プリロードされたレスポンスの使用

これで、ブラウザはナビゲーションのプリロードを実行するようになりますが、レスポンスを使用する必要があります。

addEventListener('fetch',> event = {
  event.respondWith(async function() {
    // Respond from the cache if we can
    const cachedResponse = await caches.match(event.request);
    if (cachedResponse) return cachedResponse;

    // Else, use the preloaded response, if it's there
    const response = await event.preloadResponse;
    if (response) return response;

    // Else try the network.
    return fetch(event.request);
  }());
});

event.preloadResponse は、次の場合にレスポンスで解決される Promise です。

  • ナビゲーション プリロードが有効になっている。
  • リクエストは GET リクエストです。
  • リクエストがナビゲーション リクエストである(ブラウザが iframe を含むページを読み込むときに生成するリクエスト)。

それ以外の場合、event.preloadResponse は引き続き存在しますが、undefined で解決されます。

ページがネットワークからデータを必要とする場合、最も迅速な方法は、サービス ワーカーでリクエストし、キャッシュからの部分とネットワークからの部分を含む単一のストリーミング レスポンスを作成することです。

たとえば、記事を表示するとします。

addEventListener('fetch',> event = {
  const url = new URL(event.request.url);
  const includeURL = new URL(url);
  includeURL.pathname += 'include';

  if (isArticleURL(url)) {
    event.respondWith(async function() {
      // We're going to build a single request from multiple parts.
      const parts = [
        // The top of the page.
        caches.match('/article-top.include'),
        // The primary content
        fetch(includeURL)
          // A fallback if the network >fails.
          .catch(() = caches.match('/article-offline.include')),
        // The bottom of the page
        caches.match('/article-bottom.include')
      ];

      // Merge them all together.
      const {done, response} = await mergeResponses(parts);

      // Wait until the stream is complete.
      event.waitUntil(done);

      // Return the merged response.
      return response;
    }());
  }
});

上記の mergeResponses は、各リクエストのストリームをマージする小さな関数です。これにより、ネットワーク コンテンツがストリーミングされている間に、キャッシュに保存されたヘッダーを表示できます。

ネットワーク リクエストがページ リクエストとともに行われ、大規模なハックなしでコンテンツをストリーミングできるため、これは「アプリケーション シェル」モデルよりも高速です。

ただし、includeURL のリクエストは、Service Worker の起動時間によって遅延します。この問題もナビゲーション プリロードを使用して解決できますが、この場合はページ全体をプリロードするのではなく、インクルードをプリロードする必要があります。

これをサポートするために、すべてのプリロード リクエストでヘッダーが送信されます。

Service-Worker-Navigation-Preload: true

サーバーはこれを使用して、通常のナビゲーション リクエストとは異なるコンテンツをナビゲーション プリロード リクエストに送信できます。Vary: Service-Worker-Navigation-Preload ヘッダーを追加して、レスポンスが異なることをキャッシュに知らせるようにしてください。

これで、プリロード リクエストを使用できるようになりました。

// Try to use the preload
const networkContent = Promise.resolve(event.preloadResponse)
  // Else do a normal fetch
  .then(r => r || fetch(includeURL))
  // A fallback if the network fails.
  .catch(() => caches.match('/article-offline.include'));

const parts = [
  caches.match('/article-top.include'),
  networkContent,
  caches.match('/article-bottom')
];

ヘッダーを変更する

デフォルトでは、Service-Worker-Navigation-Preload ヘッダーの値は true ですが、任意の値に設定できます。

navigator.serviceWorker.ready.then(registration => {
  return registration.navigationPreload.setHeaderValue(newValue);
}).then(() => {
  console.log('Done!';);
});

たとえば、ローカルにキャッシュ保存した最後の投稿の ID に設定すると、サーバーは新しいデータのみを返します。

状態の取得

ナビゲーション プリロードの状態は、getState を使用して確認できます。

navigator.serviceWorker.ready.then(registration => {
  return registration.navigationPreload.getState();
}).then(state => {
  console.log(state.enabled); // boolean
  console.log(state.headerValue); // string
});

この機能の開発とこの記事の執筆に協力してくれた Matt Falkenhagen と Tsuyoshi Horo に心から感謝します。標準化の取り組みに関わったすべての方々に心から感謝いたします。