Codelab: プッシュ通知サーバーを構築する

Kate Jeffreys
Kate Jeffreys
Kayce Basques

この Codelab では、プッシュ通知サーバーの構築方法を順を追って説明します。この Codelab の最後には、次の機能を備えたサーバーが完成します。

  • プッシュ通知の定期購入を追跡します（クライアントがプッシュ通知を有効にすると、サーバーは新しいデータベース レコードを作成し、クライアントがプッシュ通知を無効にすると、既存のデータベース レコードを削除します）。
  • 単一のクライアントにプッシュ通知を送信する
  • 登録済みのすべてのクライアントにプッシュ通知を送信します。

この Codelab は、実践による学習を支援することに重点を置いており、コンセプトについてはあまり説明しません。プッシュ通知のコンセプトについては、プッシュ通知の仕組みをご覧ください。

この Codelab のクライアント コードはすでに完成しています。この Codelab では、サーバーのみを実装します。プッシュ通知クライアントを実装する方法については、Codelab: プッシュ通知クライアントを作成するをご覧ください。

コード全体を確認するには、push-notifications-server-codelab-complete（ソース）をご覧ください。

ブラウザの互換性

この Codelab は、次のオペレーティング システムとブラウザの組み合わせで動作することが確認されています。

  • Windows: Chrome、Edge
  • macOS: Chrome、Firefox
  • Android: Chrome、Firefox

この Codelab は、以下のオペレーティング システム（またはオペレーティング システムとブラウザの組み合わせ）では動作しないことが確認されています。

  • macOS: Brave、Edge、Safari
  • iOS

アプリケーション スタック

  • サーバーは Express.js 上に構築されています。
  • web-push Node.js ライブラリが、すべてのプッシュ通知ロジックを処理します。
  • 定期購入データは、lowdb を使用して JSON ファイルに書き込まれます。

プッシュ通知を実装するために、これらのテクノロジーのいずれかを使用する必要はありません。これらのテクノロジーを選んだのは、信頼性の高い Codelab のエクスペリエンスを提供できるからです。

セットアップ

コードの編集可能なコピーを取得する

この手順の右側に表示されるコードエディタは、この Codelab では Glitch UI と呼ばれます。

  1. [Remix to Edit] をクリックして、プロジェクトを編集可能にします。

認証を設定する

プッシュ通知を機能させるには、認証鍵を使用してサーバーおよびクライアントを設定する必要があります。その理由については、ウェブの push プロトコル リクエストに署名するをご覧ください。

  1. [Tools]、[Terminal] の順にクリックして、Glitch ターミナルを開きます。
  2. ターミナルで npx web-push generate-vapid-keys を実行します。秘密鍵と公開鍵の値をコピーします。
  3. .env を開き、VAPID_PUBLIC_KEY と VAPID_PRIVATE_KEY を更新します。VAPID_SUBJECT を mailto:test@test.test に設定します。これらの値はすべて二重引用符で囲む必要があります。更新後、.env ファイルは次のようになります。
VAPID_PUBLIC_KEY="BKiwTvD9HA…"
VAPID_PRIVATE_KEY="4mXG9jBUaU…"
VAPID_SUBJECT="mailto:test@test.test"
  1. Glitch ターミナルを閉じます。
  1. public/index.js を開きます。
  2. VAPID_PUBLIC_KEY_VALUE_HERE は、公開鍵の値に置き換えます。

サブスクリプションを管理

サブスクリプション プロセスの大部分はクライアントが処理します。サーバー側で行う必要がある主な処理は、新しいプッシュ通知の登録の保存と古い登録の削除です。これらのサブスクリプションにより、今後クライアントにメッセージをプッシュできます。購読プロセスの詳細については、クライアントをプッシュ通知に登録するをご覧ください。

新しい定期購入情報を保存する

  1. サイトをプレビューするには、[View App] を押してから、[Fullscreen] 全画面表示 を押します。
  1. アプリのタブで [Register Service Worker] をクリックします。ステータス ボックスに次のようなメッセージが表示されます。
Service worker registered. Scope: https://desert-cactus-sunset.glitch.me/
  1. アプリのタブで [Subscribe to push] をクリックします。ブラウザまたはオペレーティング システムから、ウェブサイトによるプッシュ通知の送信を許可するかどうかを尋ねられることがあります。[Allow]（またはブラウザや OS で使用されている同等のフレーズ）をクリックします。ステータス ボックスに次のようなメッセージが表示されます。
Service worker subscribed to push.  Endpoint: https://fcm.googleapis.com/fcm/send/…
  1. Glitch UI で [ソースを表示] をクリックして、コードに戻ります。
  2. [ツール]、[ログ] の順にクリックして、Glitch ログを開きます。/add-subscription の後にデータが表示されます。/add-subscription は、クライアントがプッシュ通知を定期購読するときに POST リクエストを送信する URL です。続くデータは、保存する必要があるクライアントの定期購入情報です。
  3. server.js を開きます。
  4. /add-subscription ルート ハンドラのロジックを次のコードで更新します。
app.post('/add-subscription', (request, response) => {
  console.log('/add-subscription');
  console.log(request.body);
  console.log(`Subscribing ${request.body.endpoint}`);
  db.get('subscriptions')
    .push(request.body)
    .write();
  response.sendStatus(200);
});

古い定期購入情報を削除する

  1. アプリタブに戻ります。
  2. [push の配信解除] をクリックします。
  3. グリッチログをもう一度確認します。/remove-subscription の後にクライアントの定期購入情報が表示されます。
  4. /remove-subscription ルート ハンドラのロジックを次のコードで更新します。
app.post('/remove-subscription', (request, response) => {
  console.log('/remove-subscription');
  console.log(request.body);
  console.log(`Unsubscribing ${request.body.endpoint}`);
  db.get('subscriptions')
    .remove({endpoint: request.body.endpoint})
    .write();
  response.sendStatus(200);
});

通知を送信する

プッシュ メッセージを送信するで説明したように、サーバーは実際にはプッシュ メッセージをクライアントに直接送信しません。代わりに、プッシュ サービスに依存します。サーバーは基本的に、ユーザーが使用するブラウザ ベンダーが所有するウェブサービス（push サービス）に対してウェブサービス リクエスト（ウェブ push プロトコル リクエスト）を行うことによって、クライアントにメッセージを push するプロセスを開始します。

  1. /notify-me ルート ハンドラのロジックを次のコードで更新します。
app.post('/notify-me', (request, response) => {
  console.log('/notify-me');
  console.log(request.body);
  console.log(`Notifying ${request.body.endpoint}`);
  const subscription = 
      db.get('subscriptions').find({endpoint: request.body.endpoint}).value();
  sendNotifications([subscription]);
  response.sendStatus(200);
});
  1. sendNotifications() 関数を次のように更新します。
function sendNotifications(subscriptions) {
  // TODO
  // Create the notification content.
  const notification = JSON.stringify({
    title: "Hello, Notifications!",
    options: {
      body: `ID: ${Math.floor(Math.random() * 100)}`
    }
  });
  // Customize how the push service should attempt to deliver the push message.
  // And provide authentication information.
  const options = {
    TTL: 10000,
    vapidDetails: vapidDetails
  };
  // Send a push message to each client specified in the subscriptions array.
  subscriptions.forEach(subscription => {
    const endpoint = subscription.endpoint;
    const id = endpoint.substr((endpoint.length - 8), endpoint.length);
    webpush.sendNotification(subscription, notification, options)
      .then(result => {
        console.log(`Endpoint ID: ${id}`);
        console.log(`Result: ${result.statusCode}`);
      })
      .catch(error => {
        console.log(`Endpoint ID: ${id}`);
        console.log(`Error: ${error} `);
      });
  });
}
  1. /notify-all ルート ハンドラのロジックを次のコードで更新します。
app.post('/notify-all', (request, response) => {
  console.log('/notify-all');
  response.sendStatus(200);
  console.log('Notifying all subscribers');
  const subscriptions =
      db.get('subscriptions').cloneDeep().value();
  if (subscriptions.length > 0) {
    sendNotifications(subscriptions);
    response.sendStatus(200);
  } else {
    response.sendStatus(409);
  }
});
  1. アプリのタブに戻ります。
  2. [プッシュ配信を停止] をクリックし、もう一度 [プッシュ配信を登録] をクリックします。これは、前述のように、Glitch がコードを編集するたびにプロジェクトを再起動し、起動時にデータベースを削除するようにプロジェクトが構成されているため必要です。
  3. [通知を受け取る] をクリックします。プッシュ通知が届きます。タイトルは Hello, Notifications!、本文は ID: <ID> にする必要があります。ここで、<ID> は乱数です。
  4. 他のブラウザまたはデバイスでアプリを開き、プッシュ通知を登録して [すべて通知] ボタンをクリックしてみてください。登録したすべてのデバイスで同じ通知を受け取る必要があります（つまり、プッシュ通知の本文の ID が同じである必要があります）。

次のステップ

  • プッシュ通知の仕組みを詳しく理解するには、プッシュ通知の概要をご覧ください。
  • Codelab: プッシュ通知クライアントを作成するで、通知権限をリクエストし、デバイスを登録してプッシュ通知を受信し、サービス ワーカーを使用してプッシュ メッセージを受信して通知として表示するクライアントを作成する方法を確認する。