オフラインでも動かす — PWAとService Worker

PWAとService Worker。スマートフォンのWebページと保存箱、オフラインを示す通信アイコン。

ネットが切れた瞬間、ブラウザの中で何が起きているのか。自分で書けるプロキシとしてService Workerを置き、オフラインでも動く状態にします。

前回: curlで取ると中身が空 — SSRとNext.js 作業場所はVMの中(Ubuntu)、確認はホストの Windows のブラウザです。VMの ~/web/ と nginx をそのまま使います。この記事はVMのネットワーク設定には一切触りません(触ると危ないので、触らない方法を選びます)。

電車がトンネルに入った瞬間に、こうなったことがあります。

さっきまで読んでいたページが、真っ白になりました。

戻るを押しても白い。リロードすると「インターネットに接続されていません」の恐竜が出る。ついさっき、目の前に全部表示されていたのに、です。

同じときに、スマホのメモアプリは普通に開きました。書いたメモも全部読めました。保存も出来ました。

ここが、Webとアプリの一番はっきりした差です。

アプリは「手元に入っている」。Webは「毎回もらいに行く」。 だからもらいに行けなくなった瞬間、Webには何も残らない。

キャッシュの回で、ブラウザキャッシュをやりました。あれがあるじゃないか、と思うかもしれません。

でも、あれでは足りません。理由は1つです。

ブラウザキャッシュは「使うかどうか」をブラウザが決めます。こちらは Cache-Control でお願いすることしか出来ません。

「ネットが無いときはこれを出して」とは書けないのです。書ける場所がありませんでした。

今日、その場所を手に入れます。 それが Service Worker です。

そして先に言っておきます。この記事で一番時間を使うのは、オフラインで動かすところではありません。 一度入れた Service Worker が居座って、更新が届かなくなるところです。キャッシュの回と、まったく同じ結論に戻ってきます。

対象レベル: 初級 / 区分: 必修

目次

この記事でわかること

  • Service Worker は「オフライン機能」ではなく、ページとネットワークの間に立つ、自分で書けるプロキシだということ
  • キャッシュの5箇所目であること。前回の4箇所より、さらに手前に入ること。つまりさらに消しにくいこと
  • https か localhost でしか動かないこと。これは制限ではなく、そうしないと乗っ取りが成立してしまうこと
  • 置き場所がそのまま権限の範囲(スコープ)になること。/js/sw.js に置くと、サイト全体を見られないこと
  • 別スレッドなので DOM を触れないこと。document も alert も無いこと
  • 一番の事故は「古い Service Worker が居座る」こと。更新が永久に届かなくなる。しかも自分のPCでだけ再現しない
  • キャッシュ戦略は3つ覚えれば足りること。どれを選ぶかは「古くて困るか」だけで決まること
  • PWA は Service Worker だけではないこと。ホーム画面に入るにはマニフェストが要ること
  • 手で書くのは学習のためであること。実務では Workbox を使うし、このサイトには入れないこと

この記事でやること

  1. VMの nginx を、ホストから http://localhost:8080 として見えるようにする(SSHポート転送。制約①への対処)
  2. sw.js を書いて登録する。 install と fetch を、1行ずつ読む
  3. 開発者ツールでネットを切って、それでもページが出ることを確かめる(山場)
  4. わざと事故を起こす。 sw.js を書き換えて、更新が届かないのを再現し、3つの方法で直す
  5. マニフェストを足して、ホーム画面に追加できる状態にする
  6. Service Worker を登録解除して、元に戻す(後片づけ。必ずやります)

先に知る言葉

この記事で初めて出てくる言葉です。 基本的な言葉は用語集にもまとめてあります。

言葉意味
Service Workerページとネットワークの間に立つ、自分で書ける小さなプログラム。 ページを閉じても残る。この記事の主役
PWAProgressive Web App。Webサイトを、アプリのように使えるようにしたもの。中身は「Service Worker + マニフェスト」
プロキシ間に立って代わりに通信する係。 nginx のリバースプロキシの回でやったものと、役割は同じ
スコープその Service Worker が面倒を見る URL の範囲。 / なら全体、/app/ なら /app/ 以下だけ
セキュアコンテキストhttps か localhost であること。 危険な機能はここでしか使えない、というブラウザの決まり
Cache APIService Worker から使える保存場所。 HTTPの応答をそのまま名前を付けて置いておける。Cache-Control とは別物
install / activate / fetchService Worker が受け取るイベント。入るとき / 交代するとき / 通信が起きるとき
マニフェストアプリ名・アイコン・起動時の見た目を書いたJSONファイル。 ホーム画面に追加するのに要る
waiting新しい Service Worker が「順番待ち」している状態。 この記事の事故は、全部ここから起きます
WorkboxGoogle が出している Service Worker 用のライブラリ。実務ではこれを使う

Service Worker の「Worker」は「別スレッドで動くもの」という意味です。ページとは別の場所で動いています。 ここが後で効いてきます。


ネットが切れた瞬間、ブラウザの中で何が起きているか

「真っ白になる」を、もう少し正確に見ます。

ページを開くとき、ブラウザは最低でもこれだけ取りに行きます。

GET /            → index.html
GET /assets/index-C2u9Kx1p.js
GET /assets/index-a83Bf0Qd.css
GET /api/tasks   → JSON

ネットが切れると、この4本が全部失敗します。 そして重要なのは順番です。

一番最初の GET / が失敗した時点で、他の3本は始まってすらいません。

だから真っ白なのです。 CSSが無いから崩れる、ではありません。土台のHTMLが無いので、描くものが1つも無いのです。

では、なぜブラウザキャッシュでは足りないのか

キャッシュの回で、index.html にはこう付けました。

Cache-Control: no-cache

「保存はするが、毎回サーバーに確認しろ」でした。ネットが切れていると、この「確認」が出来ません。 確認できない以上、ブラウザは使わないと判断します。

では max-age を長くすればいいのか。 そうするとキャッシュの回でわざと起こした事故——更新が反映されなくなる——がそのまま起きます。

つまり、こういう板挟みです。

やりたいことCache-Control だけで出来るか
ネットがあるときは、必ず新しいものを出す⭕ no-cache
ネットが無いときだけ、古いものでいいから出す❌ 書く場所が無い

「〜のときは」という条件が書けない。 これが Cache-Control の限界です。あれはお願いであって、プログラムではないからです。

Service Worker は、ここにプログラムを置ける仕組みです。


Service Worker とは何か — 自分で書けるプロキシ

一文で言うとこうです。

ページと、ネットワークの間に立つ。ページが出す通信を全部いったん受け取って、何を返すかを自分で決める。

図にすると、こうです。

【いままで】
  ページ  ──────────────→  ネットワーク

【Service Worker を入れた後】
  ページ  →  Service Worker  →  ネットワーク
                    ↓
              Cache(手元の保存場所)

ページから見ると、何も変わっていません。 fetch() も <img> も、書き方は同じです。ただ、その通信が届く先が Service Worker になるだけです。

nginx のリバースプロキシの回で、こう書きました。

間に1枚挟むと、そこで判断できるようになる。

まったく同じ話です。 違うのは置き場所だけです。

リバースプロキシ(nginx)Service Worker
どこで動くか自分のサーバーの中読者のブラウザの中
誰が書くか自分自分
何を判断できるかどのアプリに回すか、キャッシュを返すか同じこと
消せるか⭕ 自分のサーバーなので消せる❌ 読者のPCの中。消せない

最後の行が、この記事で一番怖いところです。 後半でここに戻ってきます。

キャッシュの5箇所目 — 前回の地図に足す

キャッシュの回で、こう並べました。

[ブラウザ] → [CDN] → [nginx] → [アプリ] → [Redis] → [MySQL]
     ①          ②         ③                  ④

Service Worker は、この①よりさらに手前に入ります。

[ページ] → [Service Worker] → [ブラウザキャッシュ] → [CDN] → [nginx] → [アプリ] → [Redis]
                  ⓪                    ①              ②         ③                  ④
#場所誰の持ち物かこちらから消せるか
⓪Service Worker + Cache API読者のPCの中❌ 消せない。しかも自分でプログラムを置いている
①ブラウザキャッシュ読者のPCの中❌ 消せない
②CDN事業者△ パージを頼めば消える
③nginx自分のサーバー⭕ ファイルを消すだけ
④Redis自分のサーバー⭕ DEL 一発

前回の一文が、そのまま効いてきます。

手前にあるキャッシュほど速く、手前にあるキャッシュほど消せません。

⓪は、その最上位です。 ①より速く、①より消せません。

そして①には無かった、もっと厄介な性質があります。

①は「データ」でした。⓪は「プログラム」です。 データが古いのは、いつか期限が切れて直ります。プログラムが古いと、そのプログラムが「新しいものを取りに行かない」と決めている限り、永久に直りません。

これが、この記事の後半で実際に起こす事故です。


先に、最初にハマる3つの制約

コードを書く前に、ここを読んでください。 この3つを知らずに書き始めると、「何も起きない」で30分溶けます(溶かしました)。

制約1: https か localhost でしか動かない

http://192.168.11.20/ では、Service Worker は登録できません。 エラーも派手には出ません。コンソールに1行出るだけです。

なぜそこまで厳しいのか。 ここは納得しておく価値があります。

Service Worker は、一度入ると、そのサイトの通信の全部の前に立ちます。 そしてページを閉じても消えません。

もし http で許すと、こうなります。

  1. カフェのWi-Fiで、誰かが通信に割り込む(httpは中身が見えるし、書き換えられる)
  2. 本物のサイトの応答に、悪意のある sw.js を混ぜて返す
  3. 以後、そのブラウザでそのサイトを開くたびに、そいつのプログラムが最初に動く
  4. カフェを出ても、家に帰っても、動き続ける

「一瞬の割り込み」が「永続的な乗っ取り」に化けます。

https強制の回で「httpは中身が見える」をやりました。その延長線上に、この制約があります。 制限ではなく、そうしないと成立しない機能です。

localhost と 127.0.0.1 だけが例外です。自分のPCの中なので、そもそも割り込む余地が無いからです。

そこで、この記事では SSH のポート転送を使います。 VMの nginx を、ホストのWindowsから見て localhost に見えるようにします。

chrome://flags/#unsafely-treat-insecure-origin-as-secure で例外のIPを登録する手もあります。 ただしブラウザの安全装置を外す設定で、外し忘れると危険なので、この記事では使いません。

制約2: 置いた場所が、そのまま権限の範囲になる(スコープ)

sw.js をどこに置くかで、見られる範囲が変わります。

sw.js の置き場所面倒を見られる範囲(スコープ)
/sw.js/ 以下すべて ← 普通はこれ
/js/sw.js/js/ 以下だけ。 トップページは見られない
/app/sw.js/app/ 以下だけ

「JSだから js/ に入れておこう」で、動かなくなります。 これが2番目にハマるところです。

理由も一貫しています。 共有サーバーで example.com/~yamada/ を借りている人が、example.com 全体を乗っ取れたら困るからです。自分が置ける場所より上は、見られない。

どうしても場所を変えたいときは、サーバーが Service-Worker-Allowed ヘッダを返せば広げられます。 ただしサーバー側の許可が要る、という形になっています。置き場所を変えないのが一番簡単です。

制約3: 別スレッドなので、DOM を触れない

Service Worker の中には、document も window も alert もありません。

// sw.js の中では、これは全部エラーになります
document.querySelector('h1');   // ReferenceError: document is not defined
alert('動いた');                 // ReferenceError: alert is not defined

DOM操作の回でやったことは、ここでは1つも使えません。

自分自身を指すのは self です。

self.addEventListener('fetch', (event) => { /* ... */ });

そして、もう1つ大事な性質があります。

Service Worker は常駐しません。 イベントが来たら起きて、仕事が終わると寝ます(終了します)。

つまり、グローバル変数に状態を溜めても、次に起きたときには消えています。

let count = 0;                       // ❌ これは当てにならない
self.addEventListener('fetch', () => {
  count++;                           // 次に起きたら 0 に戻っている
});

残したいものは Cache API か IndexedDB に入れます。 ここは「別のプログラムだ」と割り切るのが早いです。


準備 — VMの nginx を localhost として見る

制約1への対処です。ホストのWindowsで PowerShell を開きます。

PowerShell
PS> ssh -L 8080:localhost:80 ユーザー名@VMのIPアドレス

-L 8080:localhost:80 は、「Windows の 8080 番に来たものを、SSHの向こう側(VM)の 80 番に流す」という意味です。VS Code のリモート接続の回で使ったのと同じSSHです。

このウィンドウは開いたままにします。 閉じると転送も終わります。

ホストのブラウザで、次を開きます。

http://localhost:8080/

nginx の画面(か、置いてあるページ)が出れば成功です。 そしてこのURLは localhost なので、Service Worker が使えます。

http://192.168.…:8080 ではなく、必ず http://localhost:8080 と打ってください。 同じ場所に届きますが、ブラウザにとっては別のサイトです。IPで開くと Service Worker は動きません。

[スクリーンショット: 01_ポート転送.png] PowerShell で ssh -L 8080:localhost:80 … を実行し、VMにログインできている画面を撮ってください。IPアドレスとユーザー名は隠して構いません。

配るファイルを置く

ここからはVMの中です。~/web/ に、確認用の小さなページを作ります。

bash
$ mkdir -p ~/web
$ cd ~/web

index.html を作ります(VS Code から編集しても、nano でも構いません)。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>オフライン確認</title>
    <link rel="stylesheet" href="/style.css">
  </head>
  <body>
    <h1>バージョン 1</h1>
    <p id="status">読み込み中…</p>
    <script src="/app.js"></script>
  </body>
</html>

style.css:

body { font-family: system-ui, sans-serif; margin: 3rem; }
h1 { color: #0b5fff; }

app.js:

document.querySelector('#status').textContent =
  navigator.onLine ? 'オンラインです' : 'オフラインです';

nginx に配らせます。

bash
$ sudo cp -r /var/www/html /var/www/html.bak
$ sudo rm -rf /var/www/html/*
$ sudo cp ~/web/index.html ~/web/style.css ~/web/app.js /var/www/html/

戻したくなったら、これで戻ります。

bash
$ sudo rm -rf /var/www/html
$ sudo mv /var/www/html.bak /var/www/html

ホストのブラウザで http://localhost:8080/ を開いて、「バージョン 1」と出れば準備完了です。


最小の Service Worker を書く

ここから本題です。書くのは2ファイルだけです。

まず、登録する

app.js の末尾に、これを足します。

if ('serviceWorker' in navigator) {
  window.addEventListener('load', () => {
    navigator.serviceWorker
      .register('/sw.js')
      .then((reg) => console.log('登録できた。スコープ:', reg.scope))
      .catch((err) => console.error('登録に失敗:', err));
  });
}

1行ずつ読みます。

行何をしているか
if ('serviceWorker' in navigator)対応していないブラウザで落ちないようにする。 無い機能を呼ぶとエラーになるので先に確かめる
window.addEventListener('load', …)ページの読み込みが全部終わってから登録する。 登録は通信を伴うので、表示の邪魔をさせない
.register('/sw.js')/sw.js を Service Worker として登録して、と頼む。 このパスがスコープを決める(制約2)
.then((reg) => …)登録はすぐには終わらない。非同期の回でやった Promise が返る
.catch((err) => …)これを書かないと、失敗しても画面上は何も起きません。 最初のハマりはほぼここ

.catch は必ず書いてください。 sw.js が404だったときのエラーも、ここにしか出ません。 (http の IP アドレスで開いたときは、そもそも if の中に入らないので、ここにも出ません。)

sw.js を書く

VMの ~/web/sw.js を新しく作ります。

const CACHE_NAME = 'offline-demo-v1';

const PRECACHE = [
  '/',
  '/index.html',
  '/style.css',
  '/app.js',
];

self.addEventListener('install', (event) => {
  event.waitUntil(
    caches.open(CACHE_NAME).then((cache) => cache.addAll(PRECACHE))
  );
});

self.addEventListener('fetch', (event) => {
  event.respondWith(
    caches.match(event.request).then((cached) => cached || fetch(event.request))
  );
});

これだけです。 1行ずつ読みます。

install の側

行何をしているか
const CACHE_NAME = 'offline-demo-v1'保存場所に付ける名前。 この v1 が、後半の事故の主役になります
PRECACHE = [...]先に取っておくファイルの一覧。 オフラインで必要なものを、入るときにまとめて取る
self.addEventListener('install', …)install は、この Service Worker が初めてブラウザに入るときに1回だけ来る
event.waitUntil(…)「この処理が終わるまで、installを完了扱いにしないで」という宣言。これが無いと、取り終わる前に寝てしまう
caches.open(CACHE_NAME)その名前の保存場所を開く(無ければ作る)
cache.addAll(PRECACHE)一覧のURLを全部取りに行って、応答をそのまま保存する

addAll は、1つでも失敗すると全部失敗します。 一覧に404のファイルが1つ混じっているだけで、install ごと失敗して、Service Worker は入りません。 これが3番目にハマるところです。

fetch の側

行何をしているか
self.addEventListener('fetch', …)ページが通信をするたびに、ここに来る。 画像もCSSもAPIも全部
event.respondWith(…)「返事はこっちで作る」と宣言する。 これを呼ばないと、いつも通りネットに行くだけ(=何も起きない)
caches.match(event.request)保存してあるものの中に、同じリクエストがあるか探す
cached || fetch(event.request)あればそれを返す。無ければ、いつも通りネットに取りに行く

この cached || fetch(...) の1行が、後で出てくる「cache-first」戦略そのものです。

配って、登録されたことを確かめる

bash
$ sudo cp ~/web/app.js ~/web/sw.js /var/www/html/

ホストのブラウザで http://localhost:8080/ を開いて、F12 を押します。開発者ツールの回で使ったものです。

Console に 登録できた。スコープ: http://localhost:8080/ と出ていれば成功です。

Application タブ(見当たらないときは >> の中)→ Service Workers を開きます。sw.js が activated and is running と出ていれば、動いています。

同じ Application タブの Cache Storage を開くと、offline-demo-v1 という保存場所ができていて、4つのファイルが入っています。

[スクリーンショット: 02_service_worker登録済み.png] 開発者ツールの Application → Service Workers で、sw.js が activated になっている画面を撮ってください。

[スクリーンショット: 03_cache_storage.png] Application → Cache Storage → offline-demo-v1 を開いて、/, /index.html, /style.css, /app.js が並んでいる画面を撮ってください。


ネットを切って、それでも出ることを確かめる

ここが今日の目的です。

やってはいけない切り方

VMの中でネットワークを落とすのは、やめてください。

bash
$ sudo ip link set ens33 down

これを打つと、こうなります。

  • いま繋いでいるSSHが、その瞬間に切れます
  • 切れたので、戻すコマンドを打つ手段がありません
  • VMware のコンソールを直接開いて手で戻すことになります(戻せますが、完全に無駄な回り道です)

そもそも、確かめたいのは「VMが止まったとき」ではありません。 「読者のブラウザがネットから切り離されたとき」です。切るべきなのは、ブラウザの側です。

正しい切り方 — 開発者ツールで切る

開発者ツールの Network タブを開いて、上のほうにある Throttling(「No throttling」と書いてあるプルダウン)を Offline にします。

版によっては Application → Service Workers の中に Offline のチェックボックスがあります。 どちらでも同じです。Network 側で切ると、そのタブの通信が全部止まります。

そのまま、リロード(F5)します。

何が起きるか

「バージョン 1」が、そのまま出ます。

ネットは切れています。 VMの nginx には、1本もリクエストが届いていません。それでもページが出ています。

比較のために、Service Worker を入れる前の状態を思い出してください。 同じことを前回のページでやると、恐竜が出ます。その差が、sw.js の10数行です。

Network タブを見ると、リクエストの Size の欄が (ServiceWorker) になっています。これが「Service Worker が返事を作った」という印です。

[スクリーンショット: 04_offline表示.png] Network を Offline にした状態でリロードし、ページが表示されたままで、Size 欄に (ServiceWorker) と出ている画面を撮ってください。

いま何が起きたのか、もう一度

  1. リロードで、ブラウザが GET / を出した
  2. その通信が、ネットに出る前に sw.js の fetch に届いた
  3. caches.match() が、install のときに保存した / を見つけた
  4. それをそのまま返した。ネットは1回も使っていない

「ネットが無いときは、これを出して」が、初めて書けたわけです。 記事の最初に書いた「Cache-Control には書く場所が無かった」の答えが、ここです。

確認が終わったら、Throttling を No throttling に戻してください。 戻し忘れると、次の作業が全部おかしく見えます(やりました)。


一番の事故 — 古い Service Worker が居座る

ここからが本番です。 オフライン表示より、こちらのほうが100倍ハマります。

実際に起こす

VMの ~/web/index.html の「バージョン 1」を「バージョン 2」に書き換えて、配り直します。

bash
$ sudo cp ~/web/index.html /var/www/html/

ホストのブラウザでリロードします。

「バージョン 1」のままです。

もう一度リロードしても、バージョン 1。 (Ctrl+F5 の強制再読み込みだけは Service Worker を素通りするので新しい版が出ますが、普通のリロードに戻すとまたバージョン 1 です。) キャッシュを削除しても、バージョン 1。

サーバーのファイルは、確実に書き換わっています。 curl で確かめれば分かります。VMの中で:

bash
$ curl -s http://localhost/ | grep バージョン

サーバーは「バージョン 2」を返しています。 それなのに、ブラウザには届きません。

なぜこうなるのか

sw.js の fetch に、こう書いたからです。

cached || fetch(event.request)

「キャッシュにあれば、それを返す」。 /index.html はキャッシュにあります。だから、ネットには一生行きません。

これは Service Worker の不具合ではありません。書いたとおりに動いています。 こちらが「ネットを見るな」と書いたのです。

そして、ここからが本当に厄介なところです。

sw.js 自体を直せば済む、と思うはずです。 CACHE_NAME を v2 にして配り直してみます。

bash
$ sudo cp ~/web/sw.js /var/www/html/

リロードします。……まだバージョン 1 です。

Application → Service Workers を見ると、こうなっています。

#1 activated and is running        ← 古いほう。いま動いている
#2 waiting to activate             ← 新しいほう。順番待ち

新しい sw.js は、ちゃんとダウンロードされています。 そして「待って」います。

なぜ待つのか

これも、わざとそうなっています。

いま開いているページは、古い Service Worker を前提に動いています。 途中で担当者が入れ替わると、前半と後半で違うルールが適用されて、壊れます。

だからブラウザは、そのサイトのタブが全部閉じられるまで、新しいほうを待たせます。

そして、ここが一番の落とし穴です。

リロードでは、タブは閉じられていません。 古いページが終わる前に新しいページが始まるので、「全部閉じた」瞬間が来ません。 だから、何回リロードしても永久に交代しません。

これが「更新が永久に届かない」の正体です。

[スクリーンショット: 05_waiting状態.png] Application → Service Workers で、#1 activated と #2 waiting to activate が並んでいる画面を撮ってください。

直し方1: skipWaiting() を書く(本番の答え)

sw.js に2つ足します。

self.addEventListener('install', (event) => {
  self.skipWaiting();
  event.waitUntil(
    caches.open(CACHE_NAME).then((cache) => cache.addAll(PRECACHE))
  );
});

self.addEventListener('activate', (event) => {
  event.waitUntil(
    caches
      .keys()
      .then((keys) =>
        Promise.all(keys.filter((k) => k !== CACHE_NAME).map((k) => caches.delete(k)))
      )
      .then(() => self.clients.claim())
  );
});
行何をしているか
self.skipWaiting()「順番待ちをしない。すぐ交代する」という宣言。待ち続ける問題が消える
activate イベント交代が成立したときに1回来る。 古い後片づけをする場所
caches.keys()保存場所の名前を全部並べる(offline-demo-v1, offline-demo-v2 …)
.filter((k) => k !== CACHE_NAME)いまの名前以外を選ぶ=古いもの
caches.delete(k)古い保存場所を消す。 これを書かないと、古いキャッシュが読者のPCに永久に残ります
self.clients.claim()すでに開いているタブも、今すぐ自分の担当にする。 これが無いと、次に開いたときからになる

skipWaiting() はタダではありません。 表示中のページの途中で担当者が変わります。 中身の作りが大きく変わったときは、それ自体が事故になり得ます。 丁寧にやるなら、waiting を検知してページ側に「新しい版があります。再読み込みしますか」と出すのが正解です。この記事では、まず動きを見るために skipWaiting() を使います。

CACHE_NAME を offline-demo-v2 に変えて、配り直します。

bash
$ sudo cp ~/web/sw.js /var/www/html/

リロードすると、「バージョン 2」になります。

なお、いま既に居座っている古い Service Worker の中身は関係ありません。 新しい sw.js 自身が skipWaiting() を呼ぶので、届きさえすれば待たずに入れ替わります。だから、届け方が大事になります。

新しい sw.js を配るときに、そのファイル自身が長くキャッシュされていると、詰みに近づきます。 sw.js には必ず Cache-Control: no-cache を付けてください。 キャッシュの回で index.html に付けたのと同じ理由です。新しい名前のファイルを教えてくれる本人が古いと、全部が古いまま固定されます。 nginx なら、こう書きます。

location = /sw.js {
    add_header Cache-Control "no-cache";
}

直し方2: 登録を解除する(手元をきれいにする)

Application → Service Workers の Unregister を押します。 それから Application → Storage → Clear site data を押して、Cache Storage も消します。

コードでやるなら、Console にこれを貼ります。

navigator.serviceWorker.getRegistrations().then((rs) => rs.forEach((r) => r.unregister()));
caches.keys().then((ks) => ks.forEach((k) => caches.delete(k)));

そのあとリロードすると、素の状態から始まります。

これは「自分のPCで」しか出来ません。 読者のPCの Unregister ボタンは、押せません。 ここが①のブラウザキャッシュより悪いところです。

直し方3: 開発中は Update on reload を入れておく

Application → Service Workers の上のほうに、チェックボックスが3つあります。

チェック意味
Update on reloadリロードのたびに sw.js を取り直して、待たせずに交代させる。 ⭐ 開発中はこれを入れる
Bypass for networkService Worker を素通しして、必ずネットに行く。 一時的に無効化したいとき
Offlineオフラインにする(版によってはここにあります)

Update on reload を入れておけば、この記事の事故は開発中は起きません。 キャッシュの回で Disable cache を入れっぱなしにしたのと、同じ扱いです。

[スクリーンショット: 06_update_on_reload.png] Application → Service Workers の Update on reload にチェックを入れた画面を撮ってください。

結論は、キャッシュの回と同じ

入れるのは簡単。消すのが難しい。 そして Service Worker は、キャッシュより一段悪い。「消しに行くためのプログラム」自体が、消せない側にあるから。

だから、入れる前に決めておくことが1つだけあります。

「間違えて配ったときに、どうやって全員から外すか」を、入れる前に決める。

最低限の保険として、「何もしない sw.js」を配れる状態にしておきます。

self.addEventListener('install', () => self.skipWaiting());
self.addEventListener('activate', (event) => {
  event.waitUntil(
    self.registration.unregister().then(() => self.clients.claim())
  );
});

これを sw.js として配ると、次に来た人から順に、自分で自分を消して外れます。 これが用意できないなら、Service Worker はまだ入れないほうがいいです。


キャッシュ戦略は、3つだけ覚える

Service Worker の記事には10個くらい戦略が並んでいることがありますが、最初は3つで足ります。

戦略動きいつ使うか
cache-first(キャッシュ優先)あればキャッシュを返す。無いときだけネット中身が絶対に変わらないもの。 ハッシュ付きの index-C2u9Kx1p.js、アイコン、フォント
network-first(ネット優先)まずネット。失敗したらキャッシュ古いと困るもの。 HTML、APIの応答。ネットがあるときは必ず最新
stale-while-revalidateキャッシュを即返す。同時に裏で取り直して、次回に備える1回分古くても実害が無いもの。 アバター画像、記事の一覧

選び方は、たった1つの問いで決まります。

「1回分古いものが表示されて、困るか」 困らない → cache-first。困る → network-first。少しだけ困る → stale-while-revalidate。

キャッシュの回の「これが別の人に返っても平気か」と、同じ形の問いです。

コードにすると、それぞれこうなります。

// cache-first
event.respondWith(
  caches.match(event.request).then((cached) => cached || fetch(event.request))
);
// network-first(オフラインならキャッシュ)
event.respondWith(
  fetch(event.request).catch(() => caches.match(event.request))
);
// stale-while-revalidate
event.respondWith(
  caches.open(CACHE_NAME).then((cache) =>
    cache.match(event.request).then((cached) => {
      const fresh = fetch(event.request).then((res) => {
        cache.put(event.request, res.clone());
        return res;
      });
      return cached || fresh;
    })
  )
);

res.clone() の clone() を忘れると動きません。 応答の中身は1回しか読めないからです。キャッシュに入れる用と、ページに返す用で、2つ要ります。 非同期の回で res.json() を2回呼べなかったのと、同じ理由です。

実際には、1つに決めずに振り分ける

現実のサイトは、URLごとに戦略を変えます。

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

  // APIは network-first(古いデータを見せたくない)
  if (url.pathname.startsWith('/api/')) {
    event.respondWith(fetch(event.request).catch(() => caches.match(event.request)));
    return;
  }

  // それ以外は cache-first
  event.respondWith(
    caches.match(event.request).then((cached) => cached || fetch(event.request))
  );
});

そして、絶対に cache-first にしてはいけないものがあります。

種類理由
ログイン後のページ、個人情報を含む応答別の人のブラウザに残る話ではないが、共有PCで次の人に見えます
POST / PUT / DELETEそもそもキャッシュしてはいけない。 event.request.method !== 'GET' で先に弾く
認証トークン言うまでもなく

判断基準は、キャッシュの回とまったく同じです。


PWA の残り半分 — マニフェストとホーム画面

Service Worker だけでは、まだ「アプリのように」なりません。 ホーム画面に追加できるようにするには、マニフェストが要ります。

マニフェストを書く

VMで ~/web/manifest.webmanifest を作ります。

{
  "name": "オフライン確認用ページ",
  "short_name": "オフライン確認",
  "start_url": "/",
  "scope": "/",
  "display": "standalone",
  "background_color": "#ffffff",
  "theme_color": "#0b5fff",
  "icons": [
    { "src": "/icons/icon-192.png", "sizes": "192x192", "type": "image/png" },
    { "src": "/icons/icon-512.png", "sizes": "512x512", "type": "image/png" },
    { "src": "/icons/icon-512-maskable.png", "sizes": "512x512", "type": "image/png", "purpose": "maskable" }
  ]
}

主なところだけ読みます。

キー意味
name / short_nameインストール画面に出る名前 / ホーム画面のアイコンの下に出る短い名前
start_urlアイコンから起動したときに開くURL
display見た目のモード。 下の表を参照
theme_color上部のバーの色
iconsホーム画面に置くアイコン。 下の注意を参照

display の選択肢は、実質この3つです。

値見た目いつ使うか
browser普通のブラウザ。何も変わらない実質、インストールしない
standaloneアドレスバーが消える。アプリに見える⭐ 迷ったらこれ
fullscreen画面全部。時計も消えるゲームなど

standalone にすると、アドレスバーと「戻る」ボタンが消えます。 サイト内の移動を自分で用意していないと、読者は行き止まりになります。 見た目だけで選ばないでください。

アイコンを用意する

192×192 と 512×512 の PNG が要ります。 手元に画像が無ければ、VMで作れます。

bash
$ sudo apt install -y imagemagick
$ mkdir -p ~/web/icons
$ convert -size 512x512 xc:'#0b5fff' ~/web/icons/icon-512.png
$ convert -size 512x512 xc:'#0b5fff' ~/web/icons/icon-512-maskable.png
$ convert -size 192x192 xc:'#0b5fff' ~/web/icons/icon-192.png

convert が見つからないと言われたら、magick に読み替えてください。 ImageMagick のバージョンでコマンド名が違います。

purpose: "maskable" の1枚は、何なのか。 Android はアイコンを円や角丸に切り抜きます。切り抜かれる前提で、周りに余白を持たせた版が maskable です。用意しないと、ロゴの端が切れます。

HTML から読ませる

index.html の <head> に1行足します。

<link rel="manifest" href="/manifest.webmanifest">

配ります。

bash
$ sudo cp ~/web/manifest.webmanifest ~/web/index.html /var/www/html/
$ sudo mkdir -p /var/www/html/icons
$ sudo cp ~/web/icons/*.png /var/www/html/icons/

確認する

開発者ツールの Application → Manifest を開きます。名前・色・アイコンが読めていれば成功です。エラーがあると、その場で赤字で出ます。

[スクリーンショット: 07_manifest.png] Application → Manifest で、アプリ名とアイコンが読み込まれている画面を撮ってください。

.webmanifest が「MIMEタイプが違う」と怒られたら、nginx が拡張子を知らないせいです。nginx の設定に足します。

types {
    application/manifest+json  webmanifest;
}

面倒なら、ファイル名を manifest.json にしてしまうのも有効です(application/json で通ります)。

ホーム画面に追加されるのに要るもの

ブラウザが「インストールできます」と判断する条件は、だいたいこれです。

  1. https(か localhost)で配られている
  2. マニフェストがあり、name / icons(192以上と512)/ start_url / display が揃っている
  3. Service Worker が登録されていて、fetch を扱っている(以前の Chrome の条件。いまの Chrome はこれを求めていません)

3は、以前の Chrome がインストールの条件にしていたものです。 「オフラインで何かは出せる」ことを求め、開いても真っ白なものを、ホーム画面に置かせない、という設計でした。いまの Chrome はメニューからのインストールにこの条件を求めていません(Android 108・デスクトップ 112 以降)が、オフラインで真っ白にしないことの価値は変わりません。

localhost でも、Chrome のアドレスバーの右にインストールのアイコンが出ます。 押すと、独立したウィンドウで開きます。実機のスマホで確かめるには https が要るので、そこは今回は見送ります。


やりすぎない — 手で書いたのは、学習のため

ここまで手で書いてきましたが、実務でこれを手書きすることは、ほぼありません。

理由は、この記事で全部出てきました。

  • addAll が1つ失敗すると全部失敗する
  • skipWaiting() を入れるかどうかで、事故の種類が変わる
  • 古いキャッシュの掃除を書き忘れると、読者のPCに残り続ける
  • clone() を忘れると動かない
  • sw.js に no-cache を付け忘れると、詰みに近づく
  • ビルドで名前が変わるファイルを、PRECACHE に手で書けない

最後のが決定打です。 ビルドツールの回で見たとおり、dist/ のファイル名はビルドのたびに変わります。 手書きの一覧は、ビルドした瞬間に嘘になります。

だから、実務ではライブラリに任せます。

道具何をしてくれるか
Workbox戦略を名前で選べる。 古いキャッシュの掃除も、skipWaiting の扱いも面倒を見る
vite-plugin-pwaビルドの成果物から PRECACHE の一覧を自動生成する。 Vite を使っているならこれ
Next.js のPWAプラグイン同じことを Next.js でやる

では、手で書いた意味は何だったのか。

Workbox が壊れたときに、何が起きているか分かるようにするためです。 waiting の意味を知らずに Workbox を使うと、「更新が反映されない」で丸一日溶かします。

ビルドツールの回と同じ理屈です。中で何が起きているか分からないまま使うと、壊れたときに何も出来ません。

このサイトには入れません

obmes.com には Service Worker を入れません。 理由は3つです。

  1. オフラインで読めて嬉しい種類のサイトではない。 記事は読むときにネットがあります
  2. 更新が届かない事故のリスクが、得られるものに見合わない。 記事の修正が読者に届かないのは、致命的です
  3. 速さは Cache-Control で足りている。 キャッシュの回でやったところで、必要な分は出ています

CDNのときと同じ判断です。

仕組みが分かることと、自分のサイトに入れることは、別の話です。


つまずいたところ

遠回りした順に書きます。

1. IPアドレスで開いていて、30分「何も起きなかった」

http://192.168.11.20/ で開いて、register() を書いて、リロードして、何も起きませんでした。 エラーも見当たりません。

.catch() を書いても、何も出ませんでした。 http:// の IP アドレスで開いたページは「安全な文脈」ではないので、navigator.serviceWorker そのものがありません。 if ('serviceWorker' in navigator) が偽になり、登録の処理ごと飛ばされていたのです。 Console で確かめると、こう出ます。

> 'serviceWorker' in navigator
false

制約1です。 SSHのポート転送で http://localhost:8080/ にしたら、その場で動きました。

教訓: 何も起きないときは、まず 'serviceWorker' in navigator を確かめる。 Service Worker の失敗は、画面に何も出ません。

2. sw.js を js/ に入れて、トップページが対象外になった

登録は成功しました。 コンソールにも 登録できた と出ました。なのに、オフラインにすると恐竜が出ます。

スコープを見たら、こうなっていました。

登録できた。スコープ: http://localhost:8080/js/

制約2です。 /js/sw.js は /js/ 以下しか見られません。トップページ(/)は範囲外なので、素通しになっていました。

教訓: register() のログに出るスコープを、必ず読む。

3. install が失敗し続けた(原因は404が1つ)

PRECACHE に /favicon.ico を入れていました。置いていないファイルでした。

Application → Service Workers には、こう出ます。

#1 trying to install

永久に installing のままです。 addAll は1つでも失敗すると全部失敗するので、Service Worker が入れません。

教訓: PRECACHE の一覧は、1つずつ実在を確かめる。 迷ったらまず / と /index.html の2つだけから始めます。

4. オフラインにしたのに、白いページが出た(/ と /index.html は別物)

PRECACHE に /index.html だけ書いて、/ を書いていませんでした。

ブラウザが http://localhost:8080/ を開くときに出すリクエストは / です。 caches.match() はURLが一致するものを探すので、/index.html は見つかりません。

教訓: / と /index.html は、キャッシュの中では別のURL。 両方入れておくのが手っ取り早いです。

5. VMのネットワークを落として、自分のSSHを切った

山場のところに書いたやつを、実際にやりました。

bash
$ sudo ip link set ens33 down

その瞬間にSSHが切れて、戻すコマンドを打てなくなりました。 VMware のコンソールを開いて、直接ログインして戻しました。

教訓: 確かめたいのは「ブラウザから見たオフライン」。 ブラウザ側で切れば済む話でした。

6. 「バージョン 2」に直したのに、3回配り直しても反映されなかった

この記事の後半そのものです。 サーバー側を疑って、nginx を再起動して、curl で確かめて、それでも変わらず、最後に開発者ツールを見たら waiting to activate が居ました。

教訓: Service Worker を入れたあとの「反映されない」は、まず Application タブを見る。 サーバーを疑うのは、そのあとです。


後片づけ

Service Worker は、ページを閉じても消えません。 この記事の作業をしたブラウザには、まだ居ます。 必ず外してください。

1. Service Worker と Cache を消す

ホストのブラウザで http://localhost:8080/ を開き、F12 → Console で、これを実行します。

navigator.serviceWorker.getRegistrations().then((rs) => rs.forEach((r) => r.unregister()));
caches.keys().then((ks) => ks.forEach((k) => caches.delete(k)));

そのあと、Application → Storage → Clear site data も押しておきます。

Application → Service Workers が空になっていれば、外れています。

[スクリーンショット: 08_登録解除後.png] Application → Service Workers に何も表示されなくなった画面を撮ってください。

2. 開発者ツールの設定を戻す

  • Network の Throttling を No throttling に戻す
  • Application → Service Workers の Update on reload のチェックを外す(入れっぱなしでも害はありませんが、開発中だけのものです)

3. nginx を元に戻す

VMの中で実行します。

bash
$ sudo rm -rf /var/www/html
$ sudo mv /var/www/html.bak /var/www/html
$ ls -la /var/www/html/

4. SSHのポート転送を閉じる

PowerShell のウィンドウで exit を打つか、ウィンドウを閉じます。

PowerShell
PS> exit

これで http://localhost:8080/ は繋がらなくなります。 それが正しい状態です。


まとめ

  • ネットが切れると Webが真っ白になるのは、一番最初の GET / が失敗するから。 CSSの問題ではない
  • Cache-Control には「ネットが無いときは」が書けない。 あれはお願いであって、プログラムではない
  • Service Worker は、ページとネットワークの間に立つ、自分で書けるプロキシ。 nginx のリバースプロキシと役割は同じで、置き場所が読者のブラウザの中
  • キャッシュの5箇所目(⓪)。 ブラウザキャッシュ(①)より、さらに手前。さらに消せない
  • ①は「データ」、⓪は「プログラム」。 データは期限で直る。プログラムは「取りに行かない」と決めている限り、永久に直らない
  • https か localhost でしか動かない。 制限ではなく、そうしないと「一瞬の割り込み」が「永続的な乗っ取り」になるから
  • VMを http で見るなら、SSHのポート転送で localhost にする。 IPで開いたら動かない。同じ場所でも別のサイト扱い
  • 置いた場所が、そのままスコープになる。 /js/sw.js はトップページを見られない
  • document も alert も無い。 自分を指すのは self。常駐せず、仕事が終わると寝るので、グローバル変数は当てにならない
  • register() に .catch() を必ず書く。 失敗しても画面には何も出ない
  • install は入るとき1回。 event.waitUntil() が無いと、取り終わる前に寝る
  • addAll は1つでも404だと全部失敗する。 install ごと失敗して、Service Worker は入らない
  • event.respondWith() を呼ばないと、何も起きない(普通にネットに行くだけ)
  • / と /index.html は、キャッシュの中では別のURL
  • オフラインの確認は、開発者ツールの Network → Offline で。 VMで ip link set … down を打つと、自分のSSHが切れて戻せなくなる
  • 一番の事故は waiting to activate。 リロードではタブが閉じたことにならないので、永久に交代しない
  • 直し方は3つ。 skipWaiting() + clients.claim() / Unregister / 開発中は Update on reload
  • skipWaiting() はタダではない。 表示中に担当者が変わる。丁寧にやるならページ側に「再読み込みしますか」を出す
  • sw.js には Cache-Control: no-cache を付ける。 index.html に付けたのと同じ理由
  • activate で古いキャッシュを消さないと、読者のPCに残り続ける
  • 入れる前に「全員から外す方法」を決める。 自分を unregister() する sw.js を配れる状態にしておく
  • 戦略は3つ。 cache-first(変わらないもの) / network-first(古いと困るもの) / stale-while-revalidate(少しだけ困るもの)
  • 選び方は「1回分古くて困るか」だけ。 キャッシュの回の「別の人に返っても平気か」と同じ形
  • res.clone() を忘れると動かない。 応答は1回しか読めない
  • PWA の残り半分はマニフェスト。 name / icons(192と512) / start_url / display が要る
  • display: standalone はアドレスバーと戻るを消す。 移動手段を自分で用意していないと行き止まりになる
  • maskable のアイコンは、切り抜かれる前提で余白を持たせた版。 無いとロゴの端が切れる
  • 以前の Chrome は、インストールの条件に「Service Worker が fetch を扱っていること」を入れていた(いまは外れている)。 開いて真っ白なものは置かせないという設計だった
  • 実務では Workbox / vite-plugin-pwa。 ビルドで名前が変わるファイルを、PRECACHE に手で書けない
  • 手で書いたのは、Workbox が壊れたときに読めるようにするため
  • このサイトには入れない。 記事の修正が読者に届かないリスクが、得られるものに見合わない

参考リンク


この段階の確認

【第4段階】フロントエンド は、ここで終わりです。 次に進む前に、答えを見ずに試してください。

読み終えた直後は、たいてい「分かった気」になっています。 手が動くかどうかは別です。

説明できますか

  1. なぜ手でDOMを書き換えるのをやめたのか。 フレームワークが代わりにやっていることは何か
  2. useEffect の多くが要らないのはなぜか
  3. テストが通っていても、何も守られていないことがある。 どう見分けますか

手が動きますか

  • 状態を1つ決めて、画面はそこから毎回作り直す形で書く
  • 複数の画面をルーティングで繋ぎ、リロードしても同じ画面が出るようにする
  • 機能を1行わざと壊し、テストが落ちることを確かめてから戻す
  • TypeScript を後から入れて、型が実行時には消えていることを確かめる

1つでも詰まったら、飛ばした回があります。 そこへ戻ってください。戻るのは後退ではありません。 戻り先の目安: コンポーネントの回 / 状態管理の回 / テストの回 / AIのテストの回

全部答えられたなら、次の段階へ進んでください。


次に読む

この記事は 【第4段階】フロントエンド の 15 / 15 本目です。

記事
← 前の記事curlで取ると中身が空 — SSRとNext.js
→ 次の記事サーバーとは待ち続けるプログラム — 手で書いて確かめる

上から順に読めば積み上がるように並べています。 飛ばしても構いませんが、詰まったら前の回に戻ってください。

全体の順路は はじめに にあります。

roadmap.sh のどこをやっているか

Frontend›Progressive Web Apps
  • Service Workers(ページとネットワークの間に立つプロキシ)
  • PWA — オフラインでも動かす

この記事は、上の項目を実際に手を動かして確かめる回です。

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

コメント

コメントする

目次