Cloud Functions for Firebaseの始め方

Cloud Functionsの勉強を始めました。
以下、公式サイトとChatGPTを駆使して、ローカル開発環境の構築と簡単なサンプルコードの動作確認をしました。
※記事は、書きたい内容の目次をChatGPTに投げ、GPTからの文章を動作確認しながら、上手く動かない部分は修正・加筆したものになります。

想定読者

・Cloud Functionsをこれから使ってみたい人。
・ある程度は自分で調べならが開発を進められる人。（少し端折っている部分あるため）

Cloud Functions for Firebaseとは？そもそもFirebaseって何？

Firebaseとは、
Googleが提供しているモバイルアプリやウェブアプリを作るためのツールやサービスの集まりです。
ゲームやチャットアプリ、ニュースアプリなど、さまざまなアプリを簡単に、早く作るために必要な機能が詰まっています。

その中の一つが「Cloud Functions for Firebase」です。
これは、プログラムのコードをクラウド上で動かすことができるサービスです。例えば、ユーザーがアプリで何かアクションを起こしたとき（例：メッセージを送る、写真をアップロードする）に、自動でコードが動き出して、必要な処理を行います。

Cloud Functionsで何ができる？

Cloud Functionsを使うと、アプリのバックエンドで行うべき多くの処理を自動でこなすことができます。
例えば、ユーザーが新しい写真をアップロードしたときに、その写真を自動でサイズ変更する、またはメッセージが送られたときに通知を送る、といったことが可能です。

Cloud Functionsを学ぶメリット

Cloud Functionsを学ぶことで、アプリ開発の幅が広がります。
コードを書いてアップロードするだけで、サーバーの管理やセキュリティの心配をせずに済むので、開発に集中できます。
また、使った分だけの料金で済むため、コストも抑えられます。

初心者でも分かるCloud Functionsの始め方

• Firebaseのウェブサイトにアクセスして、Googleアカウントでログインします

• 「プロジェクトを追加」をクリックし、プロジェクト名を入力してプロジェクトを作成します
  
  表示される手順通りに進めて以下のようにプロジェクトを作成します。
  

• コマンドラインを開き（WindowsではコマンドプロンプトやPowerShell、MacではTerminal）、以下のコマンドを入力してFirebase CLIをインストールします

npm install -g firebase-tools

• 以下コマンドをターミナル上で実行し、firebaseにログインできることを確認して下さい。

firebase login

ターミナル上で「✔ Success! Logged in as 自身のメールアドレス」が表示され、
ブラウザに以下画面が表示されたら成功です。

• 

Blazeプラン（従量課金制）にアップデートする。

無料プランのままだと、作成したプロジェクトをFirebaseに
デプロイ（アップロード）する際エラーになります。

そのため事前有料プランに変更します。
先ほど作成したプロジェクトに行き、歯車マーク→「使用料と請求額」に移動します

「詳細と設定」タブに移動し、「プラン変更」を押します

「続行」ボタンを押し、
あとは画面の流れに沿って自分のクレジットカードなど支払いに関する情報に入力していきます。

最終的に「課金予算の設定」が表示されるので、
課金予算をお好みで設定します。

Cloud Functionsでサンプルコード。簡単な動作確認

ここでは、ユーザーがデータベースにデータを追加したときに、自動でメッセージをログに記録する簡単なFunctionを作ります。

まずは、プロジェクトディレクトリを作成し、そのディレクトリ内で firebase init functions コマンドを実行します。

mkdir sample-firebase
cd sample-firebase
firebase init functions

上記コマンドを実行すると、以下のように４つほど、プロジェクトの選択を迫られます。
今回は一番上の「Use an existing project」を選択。

• Use an existing project: ←今回はこちら
  • 既にFirebaseコンソールで作成してあるプロジェクトを選択したい場合はこれを選びます。この選択をすると、Firebase CLIはFirebaseアカウントに紐づいているプロジェクトのリストを表示し、その中からプロジェクトを選択できるようになります。
• Create a new project:
  • Firebaseにまだプロジェクトを作成していない場合、この選択肢を選んで新しいプロジェクトを作成できます。ただし、CLIから直接新しいプロジェクトを作成するにはFirebaseプラットフォームでの設定が必要になることがありますので、初心者の方はFirebaseのウェブサイトからプロジェクトを先に作成しておくことをおすすめします。
• Add Firebase to an existing Google Cloud Platform project:
  • 既にGoogle Cloud Platform（GCP）でプロジェクトを持っていて、それをFirebaseプロジェクトとして使用したい場合に選びます。
• Don't set up a default project:
  • 現時点で特定のプロジェクトをセットアップしたくない場合に選択します。このオプションは、一般的なFunctionsの設定を行うだけで、特定のプロジェクトに紐付けずに作業を進めたい場合に便利です。

プロジェクトを選択したら、次に使用する言語の選択になります。
今回はJavaScriptを選びます。

言語を選択すると「Do you want to use ESLint to catch probable bugs and enforce style? (y/N) 」のように尋ねられます。

• ESLintとは？

  • ESLintは、JavaScript（またはTypeScript）のコードを静的解析するためのツールで、コードに潜在的なエラーやバグがないかチェックし、一貫したコーディングスタイルを維持するのに役立ちます。開発者が独自のルールを設定することもできるため、チームプロジェクトにおいてコード品質を一定に保つのに非常に有効です。

  • 質問の意味
    この質問でFirebase CLIは、プロジェクトにESLintを導入して、コードの品質管理を行うかどうかを聞いています。具体的には以下のようなメリットがあります：

    • 潜在的なバグの検出: 未使用の変数、無効な型の代入、構文エラーなど、コード内の問題を事前に検出できます。
    • コーディングスタイルの統一: インデントやセミコロンの使用、変数名の命名規則など、コーディングスタイルを統一するルールを設定できます。

今回は「y」を選びました。
※ESLintは結構うるさいやつなので、エラーでつまづきたくなく、早く動作確認したい人は「N」を選ぶのもいいかもしれません。実際にサービスを作ったりチーム開発する予定がある人は「y」を選びましょう。

• 続いて「? Do you want to install dependencies with npm now? (Y/n) 」と尋ねられます。
  
  npm（Node Package Manager）を使って今すぐに必要な依存関係（ライブラリやパッケージなど）をインストールするかどうかを尋ねています。

  • npmとは？
    npmは、JavaScriptのためのパッケージマネージャーで、Node.jsのパッケージを管理するためのツールです。
    npmを使用することで、開発に必要な外部ライブラリやツールを簡単にインストールし、プロジェクトに追加することができます。

  • 依存関係（Dependencies）とは？
    依存関係とは、プロジェクトが正しく動作するために必要な外部のコードやライブラリのことです。
    たとえば、データベースとのやりとりを簡単にするライブラリや、データを形式化するためのツールなどがあります。

「n」を押すと自分で「npm install」で必要なものをインストールする必要があるため、
今回は「Y」を選択しましょう。

「✔ Firebase initialization complete!」と表示されたら成功です。

続いてプロジェクト配下にある「functions/index.js」ファイルを開き、すべてのコードを削除した後、以下コードを記載します。

index.js

// 必要なFirebase FunctionsとAdmin SDKをインポートします
const functions = require("firebase-functions");
const admin = require("firebase-admin");
// Firebaseの管理機能を実際に使えるようになります。この行がないと、次の行でデータベースにアクセスしたり、何か操作をしたりすることができません。
admin.initializeApp();
/* この行は、Firestore内のmessagesという場所に新しい情報（ドキュメント）が追加されたときに、自動で動き出すプログラム（Function）を設定しています。
{messageId}は追加される各メッセージのユニークなIDを表しており、それによって特定のメッセージを識別できます。*/
exports.logNewMessage = functions.firestore
    .document("messages/{messageId}")
    .onCreate((snap, context) => {
      // 新しく追加されたメッセージの内容を取り出しています。snapは追加されたメッセージの情報を含んでいるオブジェクトで、.data()メソッドを使うことでその内容を取得できます。
      const newValue = snap.data();

      // メッセージ内容をコンソール（コンピューターの画面）に表示します
      console.log("New message added:", newValue);

      // このFunctionは情報を取得してログに表示するだけで、特に外部に何かを送り返す必要はありません。そのため、nullを返してFunctionの終了を示しています
      return null;
    });

変更を保存したら、以下コマンドでFirebaseにデプロイ（クラウド上に反映）します。

firebase deploy --only functions

「✔ Deploy complete!」と表示されたら完了です。

「Project Console: 」の後に表示されるURL先にアクセスしましょう。

アクセスしたら、「Firesotre Database」画面に移動。「データベースの作成」をクリック

ロケーションを「asia-northeast1(Tokyo)」を選択

テストモードは初期状態でインターネット上の誰からでもアクセスできるようなので、
「本番環境モード」を選択します。

• テストモード
  • アクセス許可:
    テストモードでは、デフォルトでインターネット上の誰でも作成したデータベースにアクセスして、読み書きが可能になります。これにより、開発の初期段階でアプリケーションの構築とテストを簡単に行えます。
  • 使用目的:
    主に開発の早い段階や、プロトタイピング、テストのために使用します。
    このモードでは、アプリケーションが正しく動作することを素早く確認できます。
  • リスク:
    セキュリティルールが緩いため、悪意のあるユーザーがデータを読んだり変更したりするリスクがあります。
    そのため、短期間のみ使用し、公開前には本番環境モードに切り替えることが推奨されます。
• 本番環境モード
  • アクセス許可:
    本番環境モードでは、デフォルトで全ての外部アクセスが禁止され、明示的に許可されたリクエストのみがデータベースの読み書きを行えるようになります。
    セキュリティルールを通じて、アクセスを厳格に管理します。
  • 使用目的:
    アプリケーションを公開し、実際のユーザーに使用してもらう際に適しています。
    データの安全性を確保し、不正アクセスから保護するためのルールを設定できます。
  • 設定必要性:
    本番環境で使用する前に、適切なセキュリティルールを設定する必要があります。
    これには、誰がデータにアクセスできるか、どのようなデータ操作が許可されるかを定義する作業が含まれます。

データベースが作成されるので、以下画面で「コレクションを開始」をクリック!

コレクションIDを入力（任意の値）

フィールド名text、値にHello, Firebase!を設定（任意の値）

コレクションが作成されるのを確認

続いて、ログが出力されるのを確認します。
サイドバーのFiresotre Databaseをクリック

「ログビュー」をクリック

ログ　エクスプローラ画面で
「New message added: { text: 'Hello Firebase!' }」と表示されたら成功です。

まとめ

・Firebaseとその中のサービスであるCloud Functions for Firebaseについて学んだ
・Firebaseはアプリ開発を簡単に早く進めるためのツールやサービスの集まりであり、Cloud Functionsはその中でプログラムのコードをクラウド上で動かすことができる便利なサービス
・Cloud Functionsを使うことで、アプリのバックエンド処理を簡単に自動化でき、開発の効率を大きく上げることが可能になる

今回の記事作成を通じて、Cloud Functionsの基本的な使い方と簡単な動作確認を行うことができました。今後より使いこなせるよう勉強を続けたいと思います。

また、私自身Cloud Functionsの学習1日目の初学者であるため、当該記事には荒が目立つかもしれません。（勉強しながら記事を書いた）
学習を続け、今後はもっと質の高い記事を書けたらと思います。

参考文献

Firebase公式サイト: https://firebase.google.com/?hl=ja
Firebaseのドキュメント: https://firebase.google.com/docs?hl=ja
Cloud Functions for Firebaseのガイド: https://firebase.google.com/docs/functions?hl=ja