サービスワーカー

どのようなものか

サービスワーカーとは、サイトがブラウザーに登録するスクリプトです。ブ
ラウザーはそれをどのページからも独立して実行し、そのワーカーが制御す
るページのネットワークリクエストを、ワーカー経由で処理します。サービ
スワーカーはウェブワーカーの一種で、それぞれ専用のスレッド上で動作
し、ドキュメントもウィンドウも持ちません。ブラウザーは処理すべきもの
があるとワーカーを起動し、なくなれば直ちに停止することもあるため、変
数に保持した値は次のイベントまでに失われる場合があります。

ページは一度の呼び出しでサービスワーカーをインストールでき、仕様はそ
のための条件を三つ定めています。ページはセキュアコンテキストでなけれ
ばなりません。実際にはHTTPSを意味しますが、開発用には`localhost`と
ループバックアドレスも認められています。スクリプトはページ自身のオリ
ジンから取得する必要があり、CDNからコードをインポートすることはでき
ても、スクリプト自体をCDNには置けません。また、登録にはスコープがあ
ります。既定ではスクリプトがあるフォルダーであり、サーバーがスクリプ
トとともに`Service-Worker-Allowed`ヘッダーを送らない限り、それより広
くはできません。

```js
// on the page
navigator.serviceWorker.register("/sw.js");

// in /sw.js
async function answer(request) {
    const copy = await caches.match(request);
    return copy ?? fetch(request);
}

self.addEventListener("fetch", (event) => {
    event.respondWith(answer(event.request));
});
```

このワーカーは、コピーを持っていればそれを使って各リクエストに応答
し、なければネットワークから応答を得ます。コピーを用意するのはライフ
サイクルの役目です。スクリプトを取得すると、ブラウザーは`install`を
発火します。ワーカーが必要とするものをダウンロードして保存する段階で
す。ここで`event.waitUntil()`に渡したPromiseが拒否されると、インス
トールは失敗します。次に`activate`が発火し、以前の版が残したものを片
付けます。その後で初めて、ワーカーは`fetch`イベントを受け取ります。
ページは読み込まれたときにワーカーと対応付けられるので、最初のワー
カーを登録したページは、ワーカーが`clients.claim()`を呼ばない限り、
再読み込みするまでワーカーなしで動き続けます。

コピーは、同じ仕様が定義するCache
Storageに置かれます。リクエストとレスポンスの組を保存する、名前付き
のキャッシュで、ワーカー自身が書き込み、読み取り、削除を行います。ブ
ラウザーのHTTPキャッシュとは別のものです。保存した項目は期限切れにな
らず、自動的には更新されず、ワーカーのスクリプトを更新しても残りま
す。ワーカーが削除するか、ブラウザーがサイトのストレージを消去するま
で保持されます。

なぜ重要なのか

サービスワーカーを使うと、ネットワークがまったく使えない状況でもサイ
トが動作し続ける方法を、サイト側で明示的に制御できます。サービスワー
カーは、サイトが用意したコードに従って、リクエストごとに、ネットワー
クから応答するか、自身が保存したコピーから応答するか、その両方を使う
かを決めます。そのため、インストールしたウェブアプリを船上や地下室で
も使えるようにできます。サイトのページが一つも開かれていないときで
も、プッシュメッセージはサービスワーカーに届きます。

大半のワーカーで中心となるのは、リクエストの種類ごとに戦略を選ぶこと
です。ワーカーを記述するためのライブラリであるWorkboxは、五つの戦略
に名前を付けています。Cache
firstはコピーから応答し、コピーがない場合だけネットワークへアクセス
します。同じ名前のまま内容が変わらないファイルに適しています。
Network
firstはまずネットワークを試し、失敗したらコピーを使うので、ページに
適しています。Stale-while-revalidateはコピーから応答し、バックグラウ
ンドでそのコピーを更新します。両極端に当たるのが、Network
onlyとCache onlyです。

サービスワーカーは、利用者の端末上で、そのスコープ内のすべてのページ
とネットワークの間に立つコードでもあり、訪問が終わった後も残ります。
誤りがあれば、修正したスクリプトで置き換わるまで残り続けます。仕様
は、そのリスクを踏まえて設計されています。ナビゲーションのたびにブラ
ウザーは新しいスクリプトを確認し、それ以外のイベントでも、前回の確認
から1日が過ぎていれば確認します。既定では、メインスクリプトはHTTP
キャッシュから取り出すのではなく、サーバーに問い合わせて再検証するた
め、ワーカーファイルの`max-age`が長くても、壊れた版をそのまま居座ら
せることはできません。インポートしたスクリプトにも、1日が過ぎれば同
じ扱いを適用し、`updateViaCache`が`none`なら常に適用します。ブラウ
ザーは、取得したスクリプトとインストール済みのものをバイト単位で比較
し、違いがある場合だけ更新を開始します。Shiftキーを押しながら再読み
込みすると、その1回のナビゲーションではワーカーを迂回します。そのた
め、開発者の端末だけでは不具合が直ったように見えることがあります。

待機のルールは、この設計のもう半分です。新しい版は古い版と並行してイ
ンストールされ、古い版に依存する開いたページが一つもなくなるまで、使
われずに待機します。これにより、一つのページを二つの版が分担して処理
することを防ぎます。`skipWaiting()`を呼ぶと直ちに引き継げますが、そ
の代わり、古い版が読み込んだページで新しいコードが動くことになりま
す。

最後の負担はストレージです。Cache Storageは、サイトが利用者の端末に
保持するデータの使用量に含まれます。Storage
Standardでは、そのストレージは既定でベストエフォート扱いです。サイト
が永続ストレージを要求し、許可を得た場合を除き、端末の空き容量が不足
すると、ブラウザーが消去することがあります。

実際の活用例

サービスワーカーを使う理由が最も明確になるのは、通信環境が悪い場所で
す。船員や現場スタッフ向けに構築したプログレッシブウェブアプリの利用
者は、オフラインや接続不良に直面することがよくあります。サービスワー
カーはnext-pwaプラグインで設定し、Workboxのランタイムキャッシュは、
リクエストごとには変わらないフォント、画像、音声、動画、CDNのアセッ
トにCache
firstを適用します。HTTPのキャッシュ制御ヘッダーも併用します。サービ
スワーカーの挙動を実際に確かめるにはHTTPSが必要なため、オフライン動
作とインストール動作を実機でHTTPS経由で検証しました。繰り返しの読み
込みは、ネットワークではなくキャッシュから返されます。

このサイトは逆の選択をし、そのことを明記しています。Cookieのページ
は、サービスワーカー、IndexedDB、Cache
Storageを使っていないと説明しています。利用者がサイトを開く前や閉じ
た後に、このサイトの何かがバックグラウンドで動くことはありません。
ページには実行可能なJavaScriptを含めていません。検索コードは保持して
いますが無効になっており、ワーカーを登録しません。

インストールのページでは、サイトをホーム画面に追加する利用者にとって
何が変わるのかを説明しています。インストールすると専用のウィンドウで
開けるようになりますが、管理されたオフライン用のコピーが作られるわけ
ではありません。このサイトはサービスワーカーも、スクリプトで管理する
オフラインストレージも配信しないため、インストールしたアプリも通常の
利用には接続が必要です。

ワーカーの登録には実行可能なスクリプトを使いますが、このサイトの
Content-Security-Policyは現在、すべてのページの`script-src
'none'`でそれを禁止しています。JSON-LDは実行されないデータのままで
す。以前のheadテンプレートのコメントには、793文書のうち550文書が
`'none'`、243文書が`'self'`を指定したビルドの記録があり、当時リスト
フィルターを持っていたページと一致します。これらの数字は、スクリプト
が有効だった以前のビルドを示しており、現在のポリシーではありません。

問題が起きるところ

デプロイ後も古い版が応答し続ける。
新しいワーカーはインストール後、開いているタブのいずれかが古い版を使
う間は待機します。そのため、タブを閉じない利用者は古いコードを使い続
けます。古い版が読み込んだページでも新しい版が安全に動く場合は
`skipWaiting()`を呼ぶか、更新通知を表示し、ページから待機中のワー
カーへメッセージを送り、それを呼び出させてください。

ページが何週間も古い版のままになる。 HTMLにCache firstを適用すると、
すべてのナビゲーションにCache
Storageから応答します。その項目は期限切れにならず、サーバーのキャッ
シュヘッダーも参照しません。Cache
firstは、内容が変わると名前も変わるファイルに使い、ページにはNetwork
firstを使ってください。

インストールが失敗し、古いワーカーが残る。
インストール段階の一覧にある一つのアドレスがエラーを返すと、
`cache.addAll()`が拒否され、`waitUntil()`に渡したPromiseも拒否される
ため、新しい版は破棄されます。実在するファイルから一覧を作り、必須で
はないファイルはインストール時ではなく後から取得してください。

ワーカーがサイトの大半に作用しない。
`/js/sw.js`から配信されるスクリプトは、既定のスコープも最大のスコー
プも`/js/`になるため、そのフォルダー外のページはワーカーなしで読み込
まれます。スクリプトをサイトのルートから配信するか、
`Service-Worker-Allowed:
/`を付けて送信してください。

リリースのたびに端末のストレージ使用量が増える。
ワーカーのスクリプトを更新してもキャッシュは残るため、各版が新しい名
前のキャッシュを開くと、前の版のものが残ります。すべてのキャッシュ名
にバージョンを入れ、`activate`ハンドラーで、現在の版が使わないキャッ
シュを一つずつ削除してください。

参考資料

  * Service Workers — 登録、スコープ、更新確認、ライフサイクル、
Cache Storageを定めています。

  * Secure Contexts —
`localhost`とループバックアドレスを含め、潜在的に信頼できると見なす
オリジンを定めています。

  * Fetch Standard —
`Request`と`Response`のオブジェクト、`fetch`ハンドラーがリクエストを
受け取ってレスポンスを返す仕組み、サービスワーカーへリクエストを引き
渡す方法を定めています。

  * Storage Standard — Cache
Storageを収めるストレージバケット、使用量の上限の見積もり、サイトが
永続ストレージを要求する方法を定めています。

  * Workbox：workbox-strategies —
五つのキャッシュ戦略と、それぞれに適したリクエストの種類を説明してい
ます。

hこのページのウェブ版	URL:https://engineer.company/ja/glossary/service-worker/	engineer.company	70
