このページは Cloud Translation API によって翻訳されました。

AngularFire ウェブ Codelab

1. 概要

この Codelab では、Firebase のプロダクトとサービスを使用してチャットクライアントを実装、デプロイし、AngularFire を使用してウェブアプリケーションを作成する方法を学びます。

ユーザーが Firebase について話し合っているチャットアプリ

学習内容

Angular と Firebase を使用してウェブアプリを作成します。
Cloud Firestore と Cloud Storage for Firebase を使用してデータを同期する。
Firebase Authentication を使用してユーザーを認証します。
Firebase App Hosting にウェブアプリをデプロイします。
Firebase Cloud Messaging を使用して通知を送信する。
ウェブアプリのパフォーマンスデータを収集します。

必要なもの

GitHub アカウント
Firebase プロジェクトを Blaze 料金プランにアップグレードできる
任意の IDE またはテキストエディタ（WebStorm、Sublime、VS Code など）
パッケージマネージャーの npm（通常は Node.js に付属）
ターミナル/コンソール
任意のブラウザ（Chrome など）
Codelab のサンプルコード（コードを取得する方法については、Codelab の次のステップをご覧ください）

2. サンプルコードを取得する

GitHub リポジトリを作成する

Codelab のソースは https://github.com/firebase/codelab-friendlychat-web にあります。リポジトリには、複数のプラットフォーム用のサンプルプロジェクトが含まれています。ただし、この Codelab では angularfire-start ディレクトリのみを使用します。

angularfire-start フォルダを独自のリポジトリにコピーします。

ターミナルを使用して、パソコンに新しいフォルダを作成し、新しいディレクトリに移動します。
```
mkdir codelab-friendlyeats-web

cd codelab-friendlyeats-web
```
giget npm パッケージを使用して、angularfire-start フォルダのみを取得します。
```
npx giget@latest gh:firebase/codelab-friendlychat-web/angularfire-start#master . --install
```

git を使用してローカルで変更を追跡します。

git init

git add .

git commit -m "codelab starting point"

git branch -M main

新しい GitHub リポジトリ（https://github.com/new）を作成します。任意の名前を付けます。
1. GitHub に https://github.com/[user-name]/[repository-name].git または git@github.com:[user-name]/[repository-name].git のような新しいリポジトリ URL が表示されます。この URL をコピーします。
ローカルの変更を新しい GitHub リポジトリに push します。次のコマンドを実行します。your-repository-url プレースホルダはリポジトリ URL に置き換えます。
```
git remote add origin your-repository-url

git push -u origin main
```
GitHub リポジトリにスターターコードが表示されます。

3. Firebase プロジェクトを作成して設定する

Firebase プロジェクトを作成する

Firebase コンソールにログインします。
Firebase コンソールで [プロジェクトを追加] をクリックし、Firebase プロジェクトに「FriendlyChat」という名前を付けます。Firebase プロジェクトのプロジェクト ID を覚えておいてください。
[このプロジェクトで Google アナリティクスを有効にする] チェックボックスをオフにします。
[プロジェクトを作成] をクリックします。

これから構築するアプリケーションは、ウェブアプリで利用可能な Firebase プロダクトを使用します。

ユーザーがアプリに簡単にログインできるようにする Firebase Authentication。
構造化されたデータをクラウドに保存し、データが変更されたときに即座に通知を受け取る Cloud Firestore。
ファイルをクラウドに保存する Cloud Storage for Firebase。
Firebase App Hosting: アプリを構築、ホスト、提供します。
プッシュ通知を送信し、ブラウザのポップアップ通知を表示する Firebase Cloud Messaging。
Firebase Performance Monitoring: アプリのユーザーパフォーマンスデータを収集します。

これらのプロダクトの一部は、特別な構成が必要な場合や、Firebase コンソールを使用して有効にする必要があります。

Firebase のお支払いプランをアップグレードする

App Hosting を使用するには、Firebase プロジェクトが Blaze 料金プランを利用している（つまり、Cloud 請求先アカウントに関連付けられている）必要があります。

Cloud 請求先アカウントには、クレジットカードなどのお支払い方法が必要です。
Firebase と Google Cloud を初めて使用する場合は、$300 分のクレジットと無料トライアルの Cloud 請求先アカウントの対象かどうかを確認してください。

プロジェクトを Blaze プランにアップグレードする手順は次のとおりです。

Firebase コンソールで、プランのアップグレードを選択します。
ダイアログで Blaze プランを選択し、画面上の手順に沿ってプロジェクトを Cloud 請求先アカウントに関連付けます。
Cloud 請求先アカウントを作成する必要がある場合は、Firebase コンソールのアップグレードフローに戻ってアップグレードを完了する必要があります。

プロジェクトに Firebase ウェブアプリを追加する

ウェブアイコンをクリックして、新しい Firebase ウェブアプリを作成します。
「Friendly Chat」というニックネームでアプリを登録します。[このアプリの Firebase Hosting も設定します] の横にあるチェックボックスをオンにしないでください。[アプリを登録] をクリックします。
次のステップでは、構成オブジェクトが表示されます。現時点では必要ありません。[コンソールに進む] をクリックします。

ウェブアプリの登録のスクリーンショット

Authentication を設定する

ユーザーが Google アカウントでウェブアプリにログインできるようにするには、Google のログイン方法を使用します。

Firebase コンソールで [認証] に移動します。
[Get started] をクリックします。
[その他のプロバイダ] 列で、[Google] > [有効にする] をクリックします。
[プロジェクトの公開名] テキストボックスに、My Next.js app などの覚えやすい名前を入力します。
[プロジェクトのサポートメール] プルダウンから、メールアドレスを選択します。
[保存] をクリックします。

Cloud Firestore を有効にする

このウェブアプリは、Cloud Firestore を使用してチャットメッセージを保存し、新しいチャットメッセージを受信します。

Cloud Firestore を有効にする必要があります。

Firebase コンソールで Firestore に移動します。
[データベースを作成] > [次へ] > [テストモードで開始] > [次へ] をクリックします。
この Codelab の後半で、データを保護するためのセキュリティルールを追加します。データベースにセキュリティルールを追加せずに、アプリを配布または公開しないでください。
デフォルトの場所を使用するか、任意の場所を選択します。
実際のアプリでは、ユーザーに近い場所を選択します。このロケーションは後で変更できません。これは自動的にデフォルトの Cloud Storage バケットのロケーションになります（次のステップ）。
[完了] をクリックします。

Cloud Storage を有効にする

このウェブアプリは、Cloud Storage for Firebase を使用して画像を保存、アップロード、共有します。

Cloud Storage を有効にする必要があります。

Firebase コンソールで [ストレージ] に移動します。
[開始] > [テストモードで開始] > [次へ] をクリックします。
この Codelab の後半で、データを保護するためのセキュリティルールを追加します。Storage バケットのセキュリティルールを追加せずに、アプリを配布または公開しないでください。
バケットのロケーションはすでに選択されているはずです（前のステップで Firestore を設定したため）。
[完了] をクリックします。

4. Firebase コマンドラインインターフェースをインストールする

Firebase コマンドラインインターフェース（CLI）では、Firebase Hosting を使用してウェブアプリをローカルで提供したり、ウェブアプリを Firebase プロジェクトにデプロイしたりできます。

次の npm コマンドを実行して CLI をインストールします。

npm -g install firebase-tools@latest

次のコマンドを実行して、CLI が正しくインストールされていることを確認します。

firebase --version

Firebase CLI のバージョンが vvv13.9.0 以降であることを確認します。

次のコマンドを実行して、Firebase CLI を承認します。

firebase login

アプリのローカルディレクトリ（Codelab の前半でクローンを作成したリポジトリ）から Firebase Hosting のアプリの構成を pull するように、ウェブアプリテンプレートを設定しました。ただし、構成を pull するには、アプリを Firebase プロジェクトに関連付ける必要があります。

コマンドラインでアプリのローカル angularfire-start ディレクトリにアクセスしていることを確認します。
次のコマンドを実行して、アプリを Firebase プロジェクトに関連付けます。

firebase use --add

プロンプトが表示されたら、プロジェクト ID を選択し、Firebase プロジェクトにエイリアスを指定します。

エイリアスは複数の環境（本番環境、ステージングなど）がある場合に役立ちます。ただし、この Codelab では default のエイリアスのみを使用します。

コマンドラインの残りの手順に沿って操作します。

5. AngularFire をインストールする

プロジェクトを実行する前に、Angular CLI と AngularFire が設定されていることを確認してください。

コンソールで、次のコマンドを実行します。

npm install -g @angular/cli

次に、コンソールで angularfire-start ディレクトリから次の Angular CLI コマンドを実行します。

ng add @angular/fire

これにより、プロジェクトに必要な依存関係がすべてインストールされます。

プロンプトが表示されたら、Space キーを使用して ng deploy -- hosting のチェックボックスをオフにします。矢印キーと Space キーを使用して次の機能を選択します。
- Authentication
- Firestore
- Cloud Messaging
- Cloud Storage
enter を押し、残りのプロンプトに沿って操作します。
「Install AngularFire」という commit メッセージで commit を作成し、GitHub リポジトリに push します。

6. App Hosting バックエンドを作成する

このセクションでは、App Hosting バックエンドを設定して、Git リポジトリのブランチを監視します。

このセクションを終えると、App Hosting バックエンドが GitHub のリポジトリに接続され、main ブランチに新しい commit を push するたびに、アプリの新しいバージョンが自動的に再ビルドされ、ロールアウトされます。

Firebase コンソールの [App Hosting] ページに移動します。

[使ってみる] ボタンがある、ゼロ状態の App Hosting コンソール

[開始] をクリックしてバックエンド作成フローを開始します。バックエンドを次のように構成します。
最初のステップのプロンプトに従って、前に作成した GitHub リポジトリを接続します。
デプロイ設定を行います。
1. ルートディレクトリは / のままにします。
2. live ブランチを main に設定します。
3. 自動ロールアウトを有効にする
バックエンドに friendlychat-codelab という名前を付けます。
[Firebase ウェブアプリの作成または関連付け] で、[既存の Firebase ウェブアプリを選択] プルダウンから、先ほど構成したウェブアプリを選択します。
[Finish and deploy] をクリックします。しばらくすると新しいページが開き、新しい App Hosting バックエンドのステータスが表示されます。
注: コンソールからリンクをたどって、App Hosting バックエンドの基盤となる Google Cloud サービスをモニタリングできます。詳細については、ログと指標を表示するをご覧ください。
公開が完了したら、[ドメイン] で無料のドメインをクリックします。DNS の伝播により、機能し始めるまでに数分かかることがあります。

最初のウェブアプリがデプロイされました。GitHub リポジトリの main ブランチに新しい commit を push するたびに、Firebase コンソールに新しいビルドとロールアウトが開始され、ロールアウトが完了すると、サイトが自動的に更新されます。

[使ってみる] ボタンがある、ゼロ状態の App Hosting コンソール

FriendlyChat アプリのログイン画面が表示されますが、まだ機能していません。

現時点では何もできませんが、協力すればすぐに利用できるようになります。

次に、リアルタイムチャットアプリを作成します。

7. Firebase をインポートして構成する

Firebase を構成する

使用している Firebase プロジェクトを示すように Firebase SDK を構成する必要があります。

Firebase コンソールの [プロジェクトの設定] に移動します。
[アプリ] カードで、構成オブジェクトが必要なアプリのニックネームを選択します。
Firebase SDK スニペットペインで [Config] を選択します。

環境ファイル /angularfire-start/src/environments/environment.ts が生成されていることがわかります。

config オブジェクトスニペットをコピーして、angularfire-start/src/firebase-config.js に追加します。

`environment.ts`

export const environment = {
  firebase: {
    apiKey: "API_KEY",
    authDomain: "PROJECT_ID.firebaseapp.com",
    projectId: "PROJECT_ID",
    storageBucket: "PROJECT_ID.appspot.com",
    messagingSenderId: "SENDER_ID",
    appId: "APP_ID",
  },
};

AngularFire の設定を表示する

コンソールで選択した機能が /angularfire-start/src/app/app.config.ts ファイルに自動的に追加されていることがわかります。これにより、アプリで Firebase の機能を使用できるようになります。

8. ユーザーログインを設定する

これで AngularFire が app.config.ts でインポートおよび初期化されたため、使用できるようになりました。ここでは、Firebase Authentication を使用してユーザーログインを実装します。

承認済みドメインを追加します

Firebase Authentication では、自身が管理する一連のドメインからのログインのみが許可されます。ドメインのリストに無料の App Hosting ドメインを追加します。

[App Hosting] に移動します。
バックエンドのドメインに対応します。
[Authentication settings] に移動します。
[承認済みドメイン] タブを選択します。
[ドメインを追加] をクリックし、App Hosting バックエンドのドメインを貼り付けます。

アプリでユーザーが [Google でログイン] ボタンをクリックすると、login 関数がトリガーされます。この Codelab では、Firebase が Google を ID プロバイダとして使用することを承認します。ポップアップを使用しますが、Firebase では他にもいくつかの方法を使用できます。

/src/app/services/ サブディレクトリで chat.service.ts を開きます。
login 関数を見つけます。
関数全体を次のコードに置き換えます。

`chat.service.ts`

// Signs-in Friendly Chat.
login() {
    signInWithPopup(this.auth, this.provider).then((result) => {
        const credential = GoogleAuthProvider.credentialFromResult(result);
        this.router.navigate(['/', 'chat']);
        return credential;
    })
}

ユーザーが [Log out] ボタンをクリックすると、logout 関数がトリガーされます。

src/app/services/chat.service.ts ファイルに戻ります。
logout 関数を見つけます。
関数全体を次のコードに置き換えます。

`chat.service.ts`

// Logout of Friendly Chat.
logout() {
    signOut(this.auth).then(() => {
        this.router.navigate(['/', 'login'])
        console.log('signed out');
    }).catch((error) => {
        console.log('sign out error: ' + error);
    })
}

認証状態を追跡する

それに応じて UI を更新するには、ユーザーがログインしているかログアウトしているかを確認する方法が必要です。AngularFire には、認証状態が変化するたびに更新される Observable を取得する関数が用意されています。これはすでに実装されていますが、確認する価値はあります。

src/app/services/chat.service.ts ファイルに戻ります。
変数割り当て user$ を見つけます。

`chat.service.ts`

// observable that is updated when the auth state changes
user$ = user(this.auth);

上記のコードは、監視可能なユーザーを返す AngularFire 関数 user を呼び出します。認証状態が変わるたびに（ユーザーがログインまたはログアウトしたとき）にトリガーされます。FriendlyChat の Angular テンプレートコンポーネントは、この監視可能オブジェクトを使用して UI を更新し、リダイレクト、ヘッダーナビゲーションなどにユーザーを表示します。

アプリへのログインをテストする

「Additional Google Authentication」という commit メッセージを含む commit を作成し、GitHub リポジトリに push します。
Firebase コンソールで App Hosting ページを開き、新しいロールアウトが完了するまで待ちます。
ウェブアプリでページを更新し、ログインボタンと Google アカウントを使用してアプリにログインします。「auth/operation-not-allowed」というエラーメッセージが表示された場合は、Firebase コンソールで Google ログインを認証プロバイダとして有効にしていることを確認します。
ログインすると、プロフィール写真とユーザー名が表示されます（）。

9. Cloud Firestore にメッセージを書き込む

このセクションでは、アプリの UI にデータを入力できるように、Cloud Firestore にデータを書き込みます。これは Firebase コンソールを使用して手動で行うことができますが、アプリ自体を使用して、基本的な Cloud Firestore の書き込みのデモを行います。

データモデル

Cloud Firestore のデータは、コレクション、ドキュメント、フィールド、サブコレクションに分割されます。チャットの各メッセージを、messages というトップレベルのコレクションにドキュメントとして保存します。

Cloud Firestore にメッセージを追加する

ユーザーが作成したチャットメッセージを保存するには、Cloud Firestore を使用します。

このセクションでは、ユーザーがデータベースに新しいメッセージを書き込む機能を追加します。ユーザーが [送信] ボタンをクリックすると、以下のコードスニペットがトリガーされます。メッセージフィールドの内容を含むメッセージオブジェクトが、messages コレクション内の Cloud Firestore インスタンスに追加されます。add() メソッドは、自動生成された ID を持つ新しいドキュメントをコレクションに追加します。

src/app/services/chat.service.ts ファイルに戻ります。
addMessage 関数を見つけます。
関数全体を次のコードに置き換えます。

`chat.service.ts`

// Adds a text or image message to Cloud Firestore.
addMessage = async (
  textMessage: string | null,
  imageUrl: string | null,
): Promise<void | DocumentReference<DocumentData>> => {
  // ignore empty messages
  if (!textMessage && !imageUrl) {
    console.log(
      "addMessage was called without a message",
      textMessage,
      imageUrl,
    );
    return;
  }

  if (this.currentUser === null) {
    console.log("addMessage requires a signed-in user");
    return;
  }

  const message: ChatMessage = {
    name: this.currentUser.displayName,
    profilePicUrl: this.currentUser.photoURL,
    timestamp: serverTimestamp(),
    uid: this.currentUser?.uid,
  };

  textMessage && (message.text = textMessage);
  imageUrl && (message.imageUrl = imageUrl);

  try {
    const newMessageRef = await addDoc(
      collection(this.firestore, "messages"),
      message,
    );
    return newMessageRef;
  } catch (error) {
    console.error("Error writing new message to Firebase Database", error);
    return;
  }
};

メッセージの送信をテストする

「Post new chats to Firestore」という commit メッセージで commit を作成し、GitHub リポジトリに push します。
Firebase コンソールで App Hosting ページを開き、新しいロールアウトが完了するまで待ちます。
FriendlyChat を更新します。ログインしたら、「こんにちは」などのメッセージを入力し、[送信] をクリックします。これにより、メッセージが Cloud Firestore に書き込まれます。ただし、データの取得を実装する必要があるため、実際のウェブアプリではまだデータを確認できません（Codelab の次のセクション）。
Firebase コンソールで新しく追加されたメッセージを確認できます。Emulator Suite UI を開きます。[Build] セクションで [Firestore Database]（またはこちらをクリックすると、新しく追加したメッセージを含む messages コレクションが表示されます）をクリックします。

10. メッセージを読む

メッセージを同期する

アプリでメッセージを読み取るには、データが変更されたときにトリガーされるオブザーバブルを追加してから、新しいメッセージを表示する UI 要素を作成する必要があります。

アプリから新しく追加されたメッセージをリッスンするコードを追加します。このコードでは、messages コレクションのスナップショットを取得します。読み込み時に非常に長い履歴が表示されないようにするため、チャットの直近 12 件のメッセージのみが表示されます。

src/app/services/chat.service.ts ファイルに戻ります。
loadMessages 関数を見つけます。
関数全体を次のコードに置き換えます。

`chat.service.ts`

// Loads chat message history and listens for upcoming ones.
loadMessages = () => {
  // Create the query to load the last 12 messages and listen for new ones.
  const recentMessagesQuery = query(collection(this.firestore, 'messages'), orderBy('timestamp', 'desc'), limit(12));
  // Start listening to the query.
  return collectionData(recentMessagesQuery);
}

データベース内のメッセージをリッスンするには、collection 関数を使用してコレクションに対するクエリを作成し、リッスンするデータが含まれるコレクションを指定します。上記のコードでは、チャットメッセージが保存されている messages コレクション内の変更をリッスンしています。また、limit(12) を使用して直近の 12 件のメッセージのみをリッスンし、orderBy('timestamp', 'desc') を使用してメッセージを日付順に並べ替え、最新の 12 件のメッセージを取得するという制限も適用します。

collectionData 関数は、内部でスナップショットを使用します。クエリに一致するドキュメントに変更があると、コールバック関数がトリガーされます。これは、メッセージが削除、変更、または追加された場合などです。詳細については、Cloud Firestore のドキュメントをご覧ください。

メッセージの同期をテストする

「Show new chat in the UI」という commit メッセージで commit を作成し、GitHub リポジトリに push します。
Firebase コンソールで App Hosting ページを開き、新しいロールアウトが完了するまで待ちます。
FriendlyChat を更新します。先ほどデータベースで作成したメッセージが FriendlyChat UI（以下を参照）に表示されます。新しいメッセージを自由に書き込んでください。すぐに表示されるはずです。
（省略可）Emulator スイートの [Firestore] セクションで、メッセージを手動で削除、変更、追加してみてください。変更内容は UI に反映されます。

開店おめでとうございます。アプリで Cloud Firestore ドキュメントを読み取っています。

11. AI 機能を追加する

Google AI を使用して、チャットアプリに便利な支援機能を追加します。

Google AI API キーを取得する

Google AI Studio に移動し、[API キーを作成] をクリックします。
この Codelab 用に作成した Firebase プロジェクトを選択します。プロンプトは Google Cloud プロジェクトに対するものですが、すべての Firebase プロジェクトは Google Cloud プロジェクトです。
[既存のプロジェクトで API キーを作成] をクリックします。
生成された API キーをコピーする

拡張機能をインストールする

この拡張機能は、Firestore の messages コレクションに新しいドキュメントが追加されるたびにトリガーされる Cloud Functions の関数をデプロイします。この関数は Gemini を呼び出し、そのレスポンスをドキュメントの response フィールドに書き戻します。

[Gemini API を使用して chatbot を構築する] 拡張機能のページで、[Firebase コンソールでインストール] をクリックします。
画面の指示に従います。[拡張機能を構成する] ステップに進んだら、次のパラメータ値を設定します。
- Gemini API プロバイダ: Google AI
- Google AI API キー: 先ほど作成したキーを貼り付け、[シークレットを作成] をクリックします。
- Firestore コレクションのパス: messages
- プロンプトフィールド: text
- レスポンスフィールド: response
- 注文フィールド: timestamp
- コンテキスト: Keep your answers short, informal, and helpful. Use emojis when possible.
[拡張機能をインストール] をクリックします。
拡張機能のインストールが完了するまでお待ちください

AI 機能のテスト

FriendlyChat には、AI 拡張機能からのレスポンスを読み取るコードがすでに存在します。新しいチャットメッセージを送信するだけで、この機能を試すことができます。

FriendlyChat を開いてメッセージを送信します。
しばらくすると、メッセージの横に返信がポップアップ表示されます。実際のユーザーではなく、生成 AI で作成されたことを明確にするために、最後に ✨ ai generated というメモが付いています。

12. 画像を送信する

次に、画像を共有する機能を追加します。

Cloud Firestore は構造化データを保存するのに適していますが、Cloud Storage はファイルを保存するのに適しています。Cloud Storage for Firebase はファイル/blob ストレージサービスであり、ユーザーがアプリを使用して共有する画像を保存するために使用します。

画像を Cloud Storage に保存する

この Codelab には、ファイル選択ツールダイアログをトリガーするボタンがすでに追加されています。ファイルを選択すると、saveImageMessage 関数が呼び出され、選択したファイルへの参照を取得できます。saveImageMessage 関数は次の処理を行います。

チャットフィードに「プレースホルダ」のチャットメッセージが作成され、画像のアップロード中にユーザーに「読み込み中」のアニメーションが表示されます。
画像ファイルを Cloud Storage のパス /<uid>/<file_name> にアップロードします。
画像ファイルの公開 URL を生成します。
一時的に読み込む画像の代わりに、新しくアップロードされた画像ファイルの URL でチャットメッセージを更新します。

次に、画像を送信する機能を追加します。

src/chat.service.ts ファイルに戻ります。
saveImageMessage 関数を見つけます。
関数全体を次のコードに置き換えます。

chat.service.ts

// Saves a new message containing an image in Firestore.
// This first saves the image in Firebase storage.
saveImageMessage = async(file: any) => {
  try {
    // 1 - Add a message with a loading icon that will get updated with the shared image.
    const messageRef = await this.addMessage(null, this.LOADING_IMAGE_URL);

    // 2 - Upload the image to Cloud Storage.
    const filePath = `${this.auth.currentUser?.uid}/${file.name}`;
    const newImageRef = ref(this.storage, filePath);
    const fileSnapshot = await uploadBytesResumable(newImageRef, file);

    // 3 - Generate a public URL for the file.
    const publicImageUrl = await getDownloadURL(newImageRef);

    // 4 - Update the chat message placeholder with the image's URL.
    messageRef ?
    await updateDoc(messageRef, {
      imageUrl: publicImageUrl,
      storageUri: fileSnapshot.metadata.fullPath
    }): null;
  } catch (error) {
    console.error('There was an error uploading a file to Cloud Storage:', error);
  }
}

画像の送信をテストする

「Add the capability to post images」という commit メッセージで commit を作成し、GitHub リポジトリに push します。
Firebase コンソールで App Hosting ページを開き、新しいロールアウトが完了するまで待ちます。
FriendlyChat を更新します。ログインしたら、左下の画像アップロードボタンをクリックし、ファイル選択ツールを使用して画像ファイルを選択します。画像をお探しの場合は、こちらのコーヒーカップの素敵な写真をご利用ください。
選択した画像とともに、アプリの UI に新しいメッセージが表示されます。

ログインしていない状態で画像を追加しようとすると、画像を追加するにはログインする必要があることを示すエラーが表示されます。

13. 通知を表示する

次に、ブラウザの通知のサポートを追加します。チャットに新しいメッセージが投稿されると、アプリからユーザーに通知が届きます。Firebase Cloud Messaging（FCM）は、メッセージや通知を無料で確実に配信するためのクロスプラットフォームメッセージングソリューションです。

FCM Service Worker を追加する

ウェブアプリには、ウェブ通知を受信して表示する Service Worker が必要です。

AngularFire が追加されたときに、メッセージングプロバイダがすでに設定されているはずです。/angularfire-start/src/app/app.module.ts のインポートセクションに次のコードが存在することを確認してください。

provideMessaging(() => {
    return getMessaging();
}),

`app/app.module.ts`

Service Worker は Firebase Cloud Messaging SDK を読み込んで初期化するだけで済みます。SDK が通知の表示を処理します。

FCM デバイストークンを取得する

デバイスまたはブラウザで通知が有効になっている場合、デバイストークンが付与されます。このデバイストークンは、通知を特定のデバイスまたは特定のブラウザに送信するために使用します。

ユーザーがログインしたら、saveMessagingDeviceToken 関数を呼び出します。そこで、ブラウザから FCM デバイストークンを取得して Cloud Firestore に保存します。

`chat.service.ts`

saveMessagingDeviceToken 関数を見つけます。
関数全体を次のコードに置き換えます。

`chat.service.ts`

// Saves the messaging device token to Cloud Firestore.
saveMessagingDeviceToken= async () => {
    try {
      const currentToken = await getToken(this.messaging);
      if (currentToken) {
        console.log('Got FCM device token:', currentToken);
        // Saving the Device Token to Cloud Firestore.
        const tokenRef = doc(this.firestore, 'fcmTokens', currentToken);
        await setDoc(tokenRef, { uid: this.auth.currentUser?.uid });
 
        // This will fire when a message is received while the app is in the foreground.
        // When the app is in the background, firebase-messaging-sw.js will receive the message instead.
        onMessage(this.messaging, (message) => {
          console.log(
            'New foreground notification from Firebase Messaging!',
            message.notification
          );
        });
      } else {
        // Need to request permissions to show notifications.
        this.requestNotificationsPermissions();
      }
    } catch(error) {
      console.error('Unable to get messaging token.', error);
    };
}

ただし、このコードは最初は動作しません。アプリがデバイストークンを取得できるようにするには、ユーザーがアプリに通知を表示する権限を付与する必要があります（この Codelab の次のステップ）。

通知を表示する権限をリクエストする

ユーザーがアプリに通知を表示する権限をまだ付与していない場合、デバイストークンは提供されません。この場合、requestPermission() メソッドを呼び出します。これにより、サポートされているブラウザで、この権限を要求するブラウザダイアログが表示されます。

src/app/services/chat.service.ts ファイルに戻ります。
requestNotificationsPermissions 関数を見つけます。
関数全体を次のコードに置き換えます。

`chat.service.ts`

// Requests permissions to show notifications.
requestNotificationsPermissions = async () => {
    console.log('Requesting notifications permission...');
    const permission = await Notification.requestPermission();
    
    if (permission === 'granted') {
      console.log('Notification permission granted.');
      // Notification permission granted.
      await this.saveMessagingDeviceToken();
    } else {
      console.log('Unable to get permission to notify.');
    }
}

デバイストークンを取得する

「Add the capability to post images」という commit メッセージで commit を作成し、GitHub リポジトリに push します。
Firebase コンソールで App Hosting ページを開き、新しいロールアウトが完了するまで待ちます。
FriendlyChat を更新します。ログインすると、通知権限ダイアログが表示されます。
[許可] をクリックします。
ブラウザの JavaScript コンソールを開きます。「Got FCM device token: cWL6w:APA91bHP...4jDPL_A-wPP06GJp1OuekTaTZI5K2Tu」というメッセージが表示されます。
デバイストークンをコピーします。これは、Codelab の次のステージで必要になります。

デバイスに通知を送信する

デバイストークンを取得したら、通知を送信できます。

Firebase コンソールの [Cloud Messaging] タブを開きます。
[新しい通知] をクリックします
通知のタイトルと通知テキストを入力します。
画面の右側にある [テストメッセージを送信] をクリックします。
ブラウザの JavaScript コンソールからコピーしたデバイストークンを入力し、プラス記号（+）をクリックします。
[テスト] をクリックします

アプリがフォアグラウンドにある場合、JavaScript コンソールに通知が表示されます。

アプリがバックグラウンドで動作している場合は、次の例のようにブラウザに通知が表示されます。

14. Cloud Firestore セキュリティルール

データベースのセキュリティルールを表示する

Cloud Firestore は特定のルール言語を使用して、アクセス権、セキュリティ、データの検証を定義します。

この Codelab の冒頭で Firebase プロジェクトを設定するときに、データストアへのアクセスを制限しないように、デフォルトのセキュリティルールとして「テストモード」を選択しました。Firebase コンソールの [データベース] セクションの [ルール] タブで、これらのルールを表示、変更できます。

今度は、データストアへのアクセスを制限しないデフォルトルールが表示されます。つまり、どのユーザーもデータストア内のあらゆるコレクションに対して読み取りと書き込みを行うことができます。

rules_version = '2';

service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow read, write;
    }
  }
}

以下のルールを使用して制限対象のルールを更新します。

firestore.rules

rules_version = '2';

service cloud.firestore {
  match /databases/{database}/documents {
    // Messages:
    //   - Anyone can read.
    //   - Authenticated users can add and edit messages.
    //   - Validation: Check name is same as auth token and text length below 300 char or that imageUrl is a URL.
    //   - Deletes are not allowed.
    match /messages/{messageId} {
      allow read;
      allow create, update: if request.auth != null
                    && request.resource.data.name == request.auth.token.name
                    && (request.resource.data.text is string
                      && request.resource.data.text.size() <= 300
                      || request.resource.data.imageUrl is string
                      && request.resource.data.imageUrl.matches('https?://.*'));
      allow delete: if false;
    }
    // FCM Tokens:
    //   - Anyone can write their token.
    //   - Reading list of tokens is not allowed.
    match /fcmTokens/{token} {
      allow read: if false;
      allow write;
    }
  }
}

セキュリティルールはエミュレータスイートで自動的に更新されます。

Cloud Storage セキュリティルールを表示する

Cloud Storage for Firebase は、特定のルール言語を使用してアクセス権、セキュリティ、データ検証を定義します。

この Codelab の冒頭で Firebase プロジェクトを設定したときに、認証されたユーザーにのみ Cloud Storage の使用を許可するデフォルトの Cloud Storage セキュリティルールを使用することを選択しました。Firebase コンソールの [Storage] セクションの [ルール] タブで、ルールを表示、変更できます。ログインしているすべてのユーザーにストレージバケット内のファイルの読み取りと書き込みを許可するデフォルトのルールが表示されます。

rules_version = '2';

service firebase.storage {
  match /b/{bucket}/o {
    match /{allPaths=**} {
      allow read, write: if request.auth != null;
    }
  }
}

ルールを次のように更新します。

各ユーザーに自身の特定のフォルダのみへの書き込みを許可する
すべてのユーザーに Cloud Storage からの読み取りを許可する
アップロードするファイルが画像であることを確認してください
アップロードできる画像のサイズを最大 5 MB に制限する

これは、次のルールを使用して実装できます。

storage.rules

rules_version = '2';

// Returns true if the uploaded file is an image and its size is below the given number of MB.
function isImageBelowMaxSize(maxSizeMB) {
  return request.resource.size < maxSizeMB * 1024 * 1024
      && request.resource.contentType.matches('image/.*');
}

service firebase.storage {
  match /b/{bucket}/o {
    match /{userId}/{messageId}/{fileName} {
      allow write: if request.auth != null && request.auth.uid == userId && isImageBelowMaxSize(5);
      allow read;
    }
  }
}

15. お疲れさまでした

Firebase を使用してリアルタイムチャットウェブアプリケーションを構築することができました。

学習した内容

Firebase App Hosting
Firebase Authentication
Cloud Firestore
Firebase SDK for Cloud Storage
Firebase Cloud Messaging
Firebase Performance Monitoring

次のステップ

詳細

firebase.google.com をご参照ください。

16. （省略可）App Check で適用する

Firebase App Check は、不要なトラフィックからサービスを保護し、バックエンドを不正行為から保護するのに役立ちます。このステップでは、認証情報の検証を追加し、App Check と reCAPTCHA Enterprise を使用して未承認のクライアントをブロックします。

まず、App Check と reCAPTCHA を有効にする必要があります。

reCAPTCHA Enterprise の有効化

Cloud コンソールの [セキュリティ] で、[reCaptcha Enterprise] を見つけて選択します。
プロンプトが表示されたらサービスを有効にし、[キーを作成] をクリックします。
指示に従って表示名を入力し、プラットフォームタイプとして [ウェブサイト] を選択します。
デプロイした URL を [ドメインリスト] に追加し、[チェックボックスによる本人確認を使用する] オプションがオフになっていることを確認します。
[鍵を作成] をクリックし、生成された鍵を安全な場所に保存します。これはこのステップの後半で必要になります。

App Check を有効にする

Firebase コンソールで、左側のパネルにある [ビルド] セクションを見つけます。
[App Check] をクリックし、[ログイン方法] タブをクリックして [App Check] に移動します。
[登録] をクリックし、画面の指示に従って reCaptcha Enterprise キーを入力し、[保存] をクリックします。
API ビューで [ストレージ] を選択し、[適用] をクリックします。Cloud Firestore についても同じことを行います。

これで、App Check が適用されるようになりました。アプリを更新し、チャットメッセージを表示または送信してみます。次のエラーメッセージが表示されます。

Uncaught Error in snapshot listener: FirebaseError: [code=permission-denied]: Missing or insufficient permissions.

App Check はデフォルトで、未検証のリクエストをブロックします。次に、アプリに検証を追加します。

environment.ts ファイルに移動し、reCAPTCHAEnterpriseKey を environment オブジェクトに追加します。

export const environment = {
  firebase: {
    apiKey: 'API_KEY',
    authDomain: 'PROJECT_ID.firebaseapp.com',
    databaseURL: 'https://PROJECT_ID.firebaseio.com',
    projectId: 'PROJECT_ID',
    storageBucket: 'PROJECT_ID.appspot.com',
    messagingSenderId: 'SENDER_ID',
    appId: 'APP_ID',
    measurementId: 'G-MEASUREMENT_ID',
  },
  reCAPTCHAEnterpriseKey: {
    key: "Replace with your recaptcha enterprise site key"
  },
};

key の値は、reCaptcha Enterprise トークンに置き換えます。

次に、app.module.ts ファイルに移動し、次のインポートを追加します。

import { getApp } from '@angular/fire/app';
import {
  ReCaptchaEnterpriseProvider,
  initializeAppCheck,
  provideAppCheck,
} from '@angular/fire/app-check';

同じ app.module.ts ファイルに、次のグローバル変数宣言を追加します。

declare global {
  var FIREBASE_APPCHECK_DEBUG_TOKEN: boolean;
}

@NgModule({ ...

インポートで、ReCaptchaEnterpriseProvider を使用して App Check の初期化を追加し、isTokenAutoRefreshEnabled を true に設定してトークンの自動更新を許可します。

imports: [
BrowserModule,
AppRoutingModule,
CommonModule,
FormsModule,
provideFirebaseApp(() => initializeApp(environment.firebase)),
provideAppCheck(() => {
const appCheck = initializeAppCheck(getApp(), {
  provider: new ReCaptchaEnterpriseProvider(
  environment.reCAPTCHAEnterpriseKey.key
  ),
  isTokenAutoRefreshEnabled: true,
  });
  if (location.hostname === 'localhost') {
    self.FIREBASE_APPCHECK_DEBUG_TOKEN = true;
  }
  return appCheck;
}),

ローカルテストを許可するには、self.FIREBASE_APPCHECK_DEBUG_TOKEN を true に設定します。localhost でアプリを更新すると、コンソールに次のようなデバッグトークンがログに記録されます。

App Check debug token: CEFC0C76-7891-494B-B764-349BDFD00D00. You will need to add it to your app's App Check settings in the Firebase console for it to work.

Firebase コンソールで App Check の [アプリビュー] に移動します。

オーバーフローメニューをクリックして、[デバッグトークンを管理] を選択します。

次に、[デバッグトークンを追加] をクリックし、プロンプトに従ってコンソールからデバッグトークンを貼り付けます。

chat.service.ts ファイルに移動し、次のインポートを追加します。

import { AppCheck } from '@angular/fire/app-check';

同じ chat.service.ts ファイルで、他の Firebase サービスとともに App Check を挿入します。

export class ChatService {
appCheck: AppCheck = inject(AppCheck);
...

「App Check で未承認のクライアントをブロックする」という commit メッセージを含む commit を作成し、GitHub リポジトリに push します。
Firebase コンソールで App Hosting ページを開き、新しいロールアウトが完了するまで待ちます。

開店おめでとうございます。これで、アプリで App Check が機能するようになりました。

AngularFire ウェブ Codelab

1. 概要

学習内容

必要なもの

2. サンプルコードを取得する

GitHub リポジトリを作成する

3. Firebase プロジェクトを作成して設定する

Firebase プロジェクトを作成する

Firebase のお支払いプランをアップグレードする

プロジェクトに Firebase ウェブアプリを追加する

Authentication を設定する

Cloud Firestore を有効にする

Cloud Storage を有効にする

4. Firebase コマンドライン インターフェースをインストールする

5. AngularFire をインストールする

6. App Hosting バックエンドを作成する

7. Firebase をインポートして構成する

Firebase を構成する

AngularFire の設定を表示する

8. ユーザー ログインを設定する

承認済みドメインを追加します

Google ログインでユーザーを認証する

認証状態を追跡する

アプリへのログインをテストする

9. Cloud Firestore にメッセージを書き込む

データモデル

Cloud Firestore にメッセージを追加する

メッセージの送信をテストする

10. メッセージを読む

メッセージを同期する

メッセージの同期をテストする

11. AI 機能を追加する

Google AI API キーを取得する

拡張機能をインストールする

AI 機能のテスト

12. 画像を送信する

画像を Cloud Storage に保存する

画像の送信をテストする

13. 通知を表示する

FCM Service Worker を追加する

FCM デバイス トークンを取得する

通知を表示する権限をリクエストする

デバイス トークンを取得する

デバイスに通知を送信する

14. Cloud Firestore セキュリティ ルール

データベースのセキュリティ ルールを表示する

Cloud Storage セキュリティ ルールを表示する

15. お疲れさまでした

学習した内容

次のステップ

詳細

16. （省略可）App Check で適用する

4. Firebase コマンドラインインターフェースをインストールする

8. ユーザーログインを設定する

FCM デバイストークンを取得する

デバイストークンを取得する

14. Cloud Firestore セキュリティルール

データベースのセキュリティルールを表示する

Cloud Storage セキュリティルールを表示する