push イベント

ここまでの手順で、ユーザーの登録とプッシュ メッセージの送信について説明しました。次のステップでは、このプッシュ メッセージをユーザーのデバイスで受信し、通知を表示します(必要に応じて他の作業も行います)。

push イベント

メッセージを受信すると、サービス ワーカーで push イベントがディスパッチされます。

push イベント リスナーを設定するコードは、JavaScript で記述する他のイベント リスナーとよく似ています。

self.addEventListener('push', function(event) {
    if (event.data) {
    console.log('This push event has data: ', event.data.text());
    } else {
    console.log('This push event has no data.');
    }
});

Service Worker を初めて使用するほとんどのデベロッパーにとって、このコードの最も奇妙な部分は self 変数です。self は、Service Worker であるウェブワーカーでよく使用されます。self は、ウェブページの window のようなグローバル スコープを指します。しかし、ウェブワーカーとサービス ワーカーの場合、self はワーカー自体を指します。

上記の例では、self.addEventListener() はサービス ワーカー自体にイベント リスナーを追加していると考えることができます。

push イベントの例では、データがあるかどうかを確認し、コンソールに何かを出力します。

push イベントからデータを解析する方法は他にもあります。

// Returns string
event.data.text()

// Parses data as JSON string and returns an Object
event.data.json()

// Returns blob of data
event.data.blob()

// Returns an arrayBuffer
event.data.arrayBuffer()

ほとんどのユーザーは、アプリケーションに期待する内容に応じて json() または text() を使用します。

この例では、push イベント リスナーを追加する方法とデータにアクセスする方法を示していますが、2 つの非常に重要な機能が欠けています。通知は表示されず、event.waitUntil() も使用されていません。

次の時間まで待機

サービス ワーカーについて理解しておくべきことの一つは、サービス ワーカー コードがいつ実行されるかをほとんど制御できないということです。ブラウザは、いつ起動し、いつ終了するかを決定します。ブラウザに「重要な処理で非常に忙しい」ことを伝える唯一の方法は、event.waitUntil() メソッドに Promise を渡すことです。これにより、渡された Promise が解決されるまで、ブラウザは Service Worker を実行し続けます。

push イベントでは、渡された Promise が解決される前に通知を表示する必要があるという追加の要件があります。

通知を表示する基本的な例を次に示します。

self.addEventListener('push', function(event) {
    const promiseChain = self.registration.showNotification('Hello, World.');

    event.waitUntil(promiseChain);
});

self.registration.showNotification() を呼び出すと、ユーザーに通知が表示されます。このメソッドは、通知が表示されると解決される Promise を返します。

この例をできるだけわかりやすくするために、この Promise を promiseChain という変数に割り当てています。これは event.waitUntil() に渡されます。非常に冗長な説明ですが、waitUntil() に渡すべき内容の誤解や、Promise チェーンの破損が原因で、多くの問題が発生しています。

ネットワーク リクエストでデータを取得し、アナリティクスで push イベントをトラッキングする、より複雑な例を以下に示します。

self.addEventListener('push', function(event) {
    const analyticsPromise = pushReceivedTracking();
    const pushInfoPromise = fetch('/api/get-more-data')
    .then(function(response) {
        return response.json();
    })
    .then(function(response) {
        const title = response.data.userName + ' says...';
        const message = response.data.message;

        return self.registration.showNotification(title, {
        body: message
        });
    });

    const promiseChain = Promise.all([
    analyticsPromise,
    pushInfoPromise
    ]);

    event.waitUntil(promiseChain);
});

ここでは、Promise pushReceivedTracking() を返す関数を呼び出しています。この例では、この関数がアナリティクス プロバイダにネットワーク リクエストを送信すると仮定します。また、ネットワーク リクエストを行い、レスポンスを取得して、レスポンス データを使用して通知のタイトルとメッセージを表示しています。

これらの Promise を Promise.all() と組み合わせることで、両方のタスクが完了するまで Service Worker を維持できます。結果の Promise は event.waitUntil() に渡されます。つまり、ブラウザは、通知が表示されたことを確認して Service Worker を終了する前に、両方の Promise が完了するまで待機します。

waitUntil() とその使用方法を気にする必要があるのは、デベロッパーが直面する最も一般的な問題の一つが、Promise チェーンが正しくない / 壊れている場合に、Chrome がこの「デフォルト」の通知を表示することだからです。

Chrome のデフォルトの通知の画像

Chrome で「このサイトはバックグラウンドで更新されました」という通知が表示されるのは、プッシュ メッセージが受信され、event.waitUntil() に渡された Promise が終了した後に、サービス ワーカーのプッシュ イベントで通知が表示されない場合のみです。

デベロッパーがこの問題に遭遇する主な理由は、コードが self.registration.showNotification() を呼び出すことがよくあるものの、返される Promise に対して何もしていないことです。これにより、デフォルトの通知が断続的に表示されます。たとえば、上記の例で self.registration.showNotification() の戻り値を削除すると、この通知が表示されるリスクがあります。

self.addEventListener('push', function(event) {
    const analyticsPromise = pushReceivedTracking();
    const pushInfoPromise = fetch('/api/get-more-data')
    .then(function(response) {
        return response.json();
    })
    .then(function(response) {
        const title = response.data.userName + ' says...';
        const message = response.data.message;

        self.registration.showNotification(title, {
        body: message
        });
    });

    const promiseChain = Promise.all([
    analyticsPromise,
    pushInfoPromise
    ]);

    event.waitUntil(promiseChain);
});

見落としやすいことがわかります。

この通知が表示された場合は、プロミス チェーンと event.waitUntil() を確認してください。

次のセクションでは、通知のスタイル設定と表示可能なコンテンツについて説明します。

次のステップ

Codelab