Service Worker のライフサイクル

サービス ワーカーのライフサイクルは、最も複雑な部分です。何のために、どのようなメリットがあるのかを理解していないと、まるで自分と戦っているかのように感じることがあります。しかし、その仕組みを理解すれば、ウェブとネイティブのパターンの長所を組み合わせて、シームレスで目立たないアップデートをユーザーに提供できます。

このドキュメントは特集ですが、各セクションの冒頭にある箇条書きに、知っておくべきことのほとんどが記載されています。

インテント

ライフサイクルの目的は次のとおりです。

  • オフライン ファーストを可能にする。
  • 現在のサービス ワーカーを中断することなく、新しいサービス ワーカーを準備できるようにします。
  • スコープ内のページが、全体を通して同じ Service Worker(または Service Worker なし)によって制御されるようにします。
  • 一度に実行されるサイトのバージョンが 1 つだけであることを確認します。

最後の点は非常に重要です。サービス ワーカーを使用しない場合、ユーザーはサイトのタブを 1 つ読み込み、後で別のタブを開くことができます。これにより、2 つのバージョンのサイトが同時に実行される可能性があります。これが問題にならない場合もありますが、ストレージを扱う場合、共有ストレージの管理方法について 2 つのタブで意見が大きく異なることが簡単に起こり得ます。これにより、エラーが発生したり、最悪の場合、データ損失が発生したりする可能性があります。

最初の Service Worker

概要:

  • install イベントは、サービス ワーカーが最初に受け取るイベントであり、1 回だけ発生します。
  • installEvent.waitUntil() に渡される Promise は、インストールの期間と成功または失敗を示します。
  • サービス ワーカーは、インストールが正常に完了して「アクティブ」になるまで、fetch や push などのイベントを受信しません。
  • デフォルトでは、ページ リクエスト自体が Service Worker を経由しない限り、ページのフェッチは Service Worker を経由しません。そのため、サービス ワーカーの効果を確認するには、ページを更新する必要があります。
  • clients.claim() はこのデフォルトをオーバーライドして、制御されていないページを制御できます。

次の HTML を例に説明します。

<!DOCTYPE html>
An image will appear here in 3 seconds:
<script>
  navigator.serviceWorker.register('/sw.js')
    .then(reg => console.log('SW registered!', reg))
    .catch(err => console.log('Boo!', err));

  setTimeout(() => {
    const img = new Image();
    img.src = '/dog.svg';
    document.body.appendChild(img);
  }, 3000);
</script>

サービス ワーカーを登録し、3 秒後に犬の画像を追加します。

以下は、そのサービス ワーカー sw.js です。

self.addEventListener('install', event => {
  console.log('V1 installing…');

  // cache a cat SVG
  event.waitUntil(
    caches.open('static-v1').then(cache => cache.add('/cat.svg'))
  );
});

self.addEventListener('activate', event => {
  console.log('V1 now ready to handle fetches!');
});

self.addEventListener('fetch', event => {
  const url = new URL(event.request.url);

  // serve the cat SVG from the cache if the request is
  // same-origin and the path is '/dog.svg'
  if (url.origin == location.origin && url.pathname == '/dog.svg') {
    event.respondWith(caches.match('/cat.svg'));
  }
});

猫の画像をキャッシュに保存し、/dog.svg のリクエストがあるたびにその画像を提供します。ただし、上記の例を実行すると、ページを最初に読み込んだときに犬が表示されます。更新すると、猫が表示されます。

範囲と制御

サービス ワーカー登録のデフォルトのスコープは、スクリプト URL を基準とした ./ です。つまり、//example.com/foo/bar.js で Service Worker を登録すると、デフォルトのスコープは //example.com/foo/ になります。

ページ、ワーカー、共有ワーカーを clients と呼びます。サービス ワーカーは、スコープ内のクライアントのみを制御できます。クライアントが「制御」されると、そのフェッチはスコープ内の Service Worker を経由します。クライアントが navigator.serviceWorker.controller を介して制御されているかどうかを検出できます。これは null またはサービス ワーカー インスタンスになります。

ダウンロード、解析、実行

最初の Service Worker は、.register() を呼び出すときにダウンロードされます。スクリプトのダウンロード、解析、または最初の実行でエラーが発生した場合、登録プロミスは拒否され、サービス ワーカーは破棄されます。

Chrome の DevTools では、コンソールと [Application] タブの [Service Workers] セクションにエラーが表示されます。

DevTools の [Service Worker] タブに表示されるエラー

インストール

サービス ワーカーが最初に受け取るイベントは install です。ワーカーが実行されるとすぐにトリガーされ、サービス ワーカーごとに 1 回だけ呼び出されます。Service Worker スクリプトを変更すると、ブラウザはそれを別の Service Worker と見なし、独自の install イベントを取得します。更新については後ほど詳しく説明します。

install イベントは、クライアントを制御できるようになる前に、必要なものをすべてキャッシュに保存する機会です。event.waitUntil() に渡す Promise により、インストールが完了したタイミングと、インストールが成功したかどうかがブラウザに通知されます。

Promise が拒否された場合、インストールが失敗したことを示し、ブラウザは Service Worker を破棄します。クライアントを管理することはありません。つまり、fetch イベントでは、cat.svg がキャッシュに存在することを前提にできます。これは依存関係です。

有効化

サービス ワーカーがクライアントを制御し、push や sync などの機能イベントを処理する準備が整うと、activate イベントが発生します。ただし、.register() を呼び出したページが制御されるわけではありません。

デモを初めて読み込むとき、Service Worker が有効になってからかなり時間が経ってから dog.svg がリクエストされても、リクエストは処理されず、犬の画像が表示されます。デフォルトは整合性です。ページが Service Worker なしで読み込まれる場合、そのサブリソースも読み込まれません。デモを 2 回目に読み込む(つまり、ページを更新する)と、制御されます。ページと画像のどちらも fetch イベントを通過し、代わりに猫が表示されます。

clients.claim

サービス ワーカーが有効になったら、サービス ワーカー内で clients.claim() を呼び出すことで、制御されていないクライアントを制御できます。

activate イベントで clients.claim() を呼び出す上記のデモのバリエーションを以下に示します。最初に猫が表示されるはずです。「はず」と言ったのは、タイミングが重要だからです。猫が表示されるのは、サービス ワーカーが有効になり、画像が読み込まれる前に clients.claim() が有効になった場合のみです。

サービス ワーカーを使用して、ネットワーク経由で読み込まれるページとは異なる方法でページを読み込む場合、clients.claim() は問題になる可能性があります。サービス ワーカーは、サービス ワーカーなしで読み込まれた一部のクライアントを制御することになります。

サービス ワーカーの更新

概要:

  • 次のいずれかが発生すると、更新がトリガーされます。
    • スコープ内のページへのナビゲーション。
    • push や sync などの機能イベント(過去 24 時間以内にアップデート チェックが行われていない場合)。
    • .register() を呼び出すのは、Service Worker の URL が変更された場合のみです。ただし、ワーカー URL の変更は避けてください。
  • Chrome 68 以降を含むほとんどのブラウザでは、登録済みの Service Worker スクリプトの更新を確認する際に、デフォルトでキャッシュ ヘッダーが無視されます。importScripts() を介して Service Worker 内に読み込まれたリソースを取得する際、キャッシュ ヘッダーは引き続き適用されます。このデフォルトの動作をオーバーライドするには、サービス ワーカーの登録時に updateViaCache オプションを設定します。
  • サービス ワーカーは、ブラウザにすでに存在するサービス ワーカーとバイト単位で異なる場合に更新されたと見なされます。(インポートされたスクリプトやモジュールも対象となるよう、この機能を拡張しています)。
  • 更新された Service Worker は、既存の Service Worker とともに起動され、独自の install イベントを取得します。
  • 新しいワーカーのステータス コードが OK 以外(404 など)の場合、解析に失敗した場合、実行中にエラーがスローされた場合、インストール中に拒否された場合は、新しいワーカーは破棄されますが、現在のワーカーはアクティブなままになります。
  • 正常にインストールされると、更新されたワーカーは、既存のワーカーが制御するクライアントがゼロになるまで wait します。(更新中にクライアントが重複することに注意してください)。
  • self.skipWaiting() は待機を回避します。つまり、インストールが完了するとすぐに Service Worker が有効になります。

たとえば、猫ではなく馬の画像を返すように Service Worker スクリプトを変更したとします。

const expectedCaches = ['static-v2'];

self.addEventListener('install', event => {
  console.log('V2 installing…');

  // cache a horse SVG into a new cache, static-v2
  event.waitUntil(
    caches.open('static-v2').then(cache => cache.add('/horse.svg'))
  );
});

self.addEventListener('activate', event => {
  // delete any caches that aren't in expectedCaches
  // which will get rid of static-v1
  event.waitUntil(
    caches.keys().then(keys => Promise.all(
      keys.map(key => {
        if (!expectedCaches.includes(key)) {
          return caches.delete(key);
        }
      })
    )).then(() => {
      console.log('V2 now ready to handle fetches!');
    })
  );
});

self.addEventListener('fetch', event => {
  const url = new URL(event.request.url);

  // serve the horse SVG from the cache if the request is
  // same-origin and the path is '/dog.svg'
  if (url.origin == location.origin && url.pathname == '/dog.svg') {
    event.respondWith(caches.match('/horse.svg'));
  }
});

上記のデモをご覧ください。猫の画像が表示されます。その理由は次のとおりです。

インストール

キャッシュ名を static-v1 から static-v2 に変更しています。つまり、古い Service Worker がまだ使用している現在のキャッシュを上書きすることなく、新しいキャッシュを設定できます。

このパターンでは、ネイティブ アプリが実行可能ファイルにバンドルするアセットと同様に、バージョン固有のキャッシュが作成されます。avatars など、バージョン固有ではないキャッシュが存在する場合もあります。

待機中

正常にインストールされると、更新された Service Worker は、既存の Service Worker がクライアントを制御しなくなるまで、アクティブ化を遅らせます。この状態は「待機中」と呼ばれ、ブラウザが一度に 1 つのバージョンの Service Worker のみを実行するようにします。

更新されたデモを実行した場合、V2 ワーカーがまだ有効になっていないため、猫の写真が表示されます。DevTools の [Application] タブで、新しい Service Worker が待機していることを確認できます。

新しい Service Worker が待機中であることを示す DevTools

デモのタブを 1 つしか開いていない場合でも、ページを更新するだけでは新しいバージョンに切り替わりません。これは、ブラウザのナビゲーションの仕組みによるものです。ナビゲーションを行うと、レスポンス ヘッダーが受信されるまで現在のページは消えません。レスポンスに Content-Disposition ヘッダーが含まれている場合は、現在のページがそのまま表示されることもあります。この重複により、更新中は常に現在の Service Worker がクライアントを制御します。

更新を取得するには、現在の Service Worker を使用しているすべてのタブを閉じるか、別のタブに移動します。その後、デモに再度移動すると、馬が表示されます。

このパターンは Chrome の更新方法に似ています。Chrome のアップデートはバックグラウンドでダウンロードされますが、Chrome を再起動するまで適用されません。それまでの間は、現在のバージョンを引き続きご利用いただけます。ただし、これは開発中に面倒な作業になりますが、DevTools にはこれを簡単にする方法があります。これについては、この記事の後半で説明します。

有効化

これは、古い Service Worker がなくなり、新しい Service Worker がクライアントを制御できるようになると、1 回だけ呼び出されます。このタイミングは、古いワーカーがまだ使用されている間はできなかったこと(データベースの移行やキャッシュのクリアなど)を行うのに最適です。

上記のデモでは、想定されるキャッシュのリストを保持し、activate イベントでそれ以外のキャッシュを削除しています。これにより、古い static-v1 キャッシュが削除されます。

event.waitUntil() に Promise を渡すと、Promise が解決されるまで機能イベント(fetch、push、sync など)がバッファされます。そのため、fetch イベントが発生すると、有効化は完全に完了します。

待機フェーズをスキップする

待機フェーズは、一度に 1 つのバージョンのサイトのみを実行することを意味しますが、その機能が不要な場合は、self.skipWaiting() を呼び出すことで、新しい Service Worker をより早く有効にできます。

これにより、サービス ワーカーは、待機フェーズに入るとすぐに(またはすでに待機フェーズにある場合はすぐに)、現在のアクティブなワーカーを追い出し、自身をアクティブにします。これにより、ワーカーはインストールをスキップするのではなく、待機するようになります。

skipWaiting() を呼び出すタイミングは、待機中または待機前であれば、特に問題ありません。install イベントで呼び出すのが一般的です。

self.addEventListener('install', event => {
  self.skipWaiting();

  event.waitUntil(
    // caching etc
  );
});

ただし、Service Worker への postMessage() の結果として呼び出すこともできます。たとえば、ユーザー操作の後に skipWaiting() を行う場合です。

skipWaiting() を使用したデモを以下に示します。ページを移動しなくても、牛の画像が表示されます。clients.claim() と同様に、これは競合状態です。ページが画像を読み込もうとする前に、新しい Service Worker がフェッチ、インストール、有効化された場合にのみ、牛が表示されます。

手動アップデート

前述のように、ブラウザはナビゲーションや機能イベントの後に自動的に更新をチェックしますが、手動でトリガーすることもできます。

navigator.serviceWorker.register('/sw.js').then(reg => {
  // sometime later…
  reg.update();
});

ユーザーがサイトを再読み込みせずに長時間使用することが予想される場合は、update() を一定の間隔(1 時間ごとなど)で呼び出すことをおすすめします。

サービス ワーカー スクリプトの URL を変更しない

キャッシュ保存のベスト プラクティスに関する投稿を読んだことがある場合は、サービス ワーカーの各バージョンに一意の URL を割り当てることを検討するかもしれません。すべきでないことこれは通常、Service Worker の不適切なプラクティスです。現在の場所でスクリプトを更新するだけです。

これにより、次のような問題が発生する可能性があります。

  1. index.html は sw-v1.js をサービス ワーカーとして登録します。
  2. sw-v1.js は index.html をキャッシュに保存して提供するため、オフライン ファーストで動作します。
  3. index.html を更新して、新しい sw-v2.js を登録します。

上記のようにすると、sw-v1.js はキャッシュから古いバージョンの index.html を提供するため、ユーザーは sw-v2.js を取得できません。サービス ワーカーを更新するためにサービス ワーカーを更新する必要があるという状況に陥っています。おえっ

ただし、上記のデモでは、サービス ワーカーの URL を変更しています。これは、デモのためにバージョンを切り替えることができるようにするためです。本番環境では行わない作業です。

開発を容易にする

サービス ワーカーのライフサイクルはユーザーを念頭に置いて構築されていますが、開発中は少し面倒です。ありがたいことに、次のような便利なツールがいくつかあります。

再読み込み時に更新

これが私のお気に入りです。

「再読み込み時に更新」が表示されている DevTools

これにより、ライフサイクルがデベロッパーにとって使いやすいものになります。各ナビゲーションは次のようになります。

  1. サービス ワーカーを再取得します。
  2. バイト単位で同一であっても、新しいバージョンとしてインストールします。つまり、install イベントが実行され、キャッシュが更新されます。
  3. 待機フェーズをスキップして、新しい Service Worker を有効にします。
  4. ページを操作します。

これにより、2 回リロードしたり、タブを閉じたりすることなく、各ナビゲーション(更新を含む)で更新を取得できます。

待機をスキップ

「skip waiting」が表示されている DevTools

待機中のワーカーがある場合は、DevTools で [skip waiting] をクリックすると、すぐに「active」に昇格できます。

Shift キーを押しながら再読み込み

ページを強制的に再読み込み(Shift キーを押しながら再読み込み)すると、Service Worker が完全にバイパスされます。制御不能になる。この機能は仕様に含まれているため、Service Worker をサポートする他のブラウザでも動作します。

アップデートの処理

サービス ワーカーは、拡張可能なウェブの一部として設計されました。ブラウザ デベロッパーである私たちは、ウェブ デベロッパーよりもウェブ開発に精通しているわけではないことを認識しています。そのため、Google が好むパターンを使用して特定の問題を解決する、狭い範囲の高レベル API を提供するのではなく、ブラウザの内部にアクセスできるようにして、デベロッパーのユーザーにとって最適な方法で、デベロッパーが望む方法で実行できるようにする必要があります。

そのため、できるだけ多くのパターンを有効にするために、更新サイクル全体を監視できるようになっています。

navigator.serviceWorker.register('/sw.js').then(reg => {
  reg.installing; // the installing worker, or undefined
  reg.waiting; // the waiting worker, or undefined
  reg.active; // the active worker, or undefined

  reg.addEventListener('updatefound', () => {
    // A wild service worker has appeared in reg.installing!
    const newWorker = reg.installing;

    newWorker.state;
    // "installing" - the install event has fired, but not yet complete
    // "installed"  - install complete
    // "activating" - the activate event has fired, but not yet complete
    // "activated"  - fully active
    // "redundant"  - discarded. Either failed install, or it's been
    //                replaced by a newer version

    newWorker.addEventListener('statechange', () => {
      // newWorker.state has changed
    });
  });
});

navigator.serviceWorker.addEventListener('controllerchange', () => {
  // This fires when the service worker controlling this page
  // changes, eg a new worker has skipped waiting and become
  // the new active worker.
});

ライフサイクルは続く

このように、Service Worker のライフサイクルを理解することは有益です。理解することで、Service Worker の動作がより論理的になり、謎が少なくなります。この知識があれば、Service Worker をデプロイして更新する際の信頼性が高まります。