Firestore でのセッション処理

多くのアプリには、認証設定とユーザー設定用のセッション処理が必要です。Flask フレームワークには、この機能を実行するためのメモリベースの実装が付属しています。ただし、記録されるセッションがインスタンス間で異なる場合があるため、この実装は複数のインスタンスから提供できるアプリには適していません。このチュートリアルでは、App Engine でセッションを処理する方法を示します。

目標

アプリを作成する。
アプリをローカルで実行する。
App Engine にアプリをデプロイする。

費用

このドキュメントでは、課金対象である次の Google Cloudコンポーネントを使用します。

料金計算ツールを使うと、予想使用量に基づいて費用の見積もりを生成できます。

新規の Google Cloud ユーザーは無料トライアルをご利用いただける場合があります。

このドキュメントに記載されているタスクの完了後、作成したリソースを削除すると、それ以上の請求は発生しません。詳細については、クリーンアップをご覧ください。

始める前に

Google Cloud アカウントにログインします。 Google Cloudを初めて使用する場合は、アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Firestore API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Google Cloud CLI をインストールします。

外部 ID プロバイダ（IdP）を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。

gcloud CLI を初期化するには、次のコマンドを実行します。

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Firestore API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Google Cloud CLI をインストールします。

外部 ID プロバイダ（IdP）を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。

gcloud CLI を初期化するには、次のコマンドを実行します。

gcloud init

Python、pip、virtualenv をシステムにインストールします。手順については、 Google Cloud用の Python 開発環境の設定をご覧ください。

プロジェクトの設定

ターミナルウィンドウで、選択したディレクトリに移動し、sessions という名前の新しいディレクトリを作成します。このチュートリアルのコードはすべて、sessions ディレクトリ内にあります。
sessions ディレクトリに移動します。
```
cd sessions
```
次の内容で requirements.txt を作成します。
```
google-cloud-firestore==2.11.1
flask==2.2.5
```
依存関係をインストールします。
```
pip install  -r requirements.txt
```

このチュートリアルの最後では、最終的なファイル構造が次のようになります。

sessions
├── app.yaml
├── main.py
└── requirements.txt

ウェブアプリの作成

このアプリは、ユーザーごとに異なる言語で挨拶を表示します。リピーターは常に同じ言語で挨拶されます。

さまざまな言語で挨拶が表示されている複数のアプリウィンドウ。

アプリでユーザーの設定を保存するには、現在のユーザーに関する情報をセッションに保存する方法が必要です。このサンプルアプリは Cookie と Firestore を使用して、セッションデータを保存します。

ターミナルウィンドウで、次の内容の main.py という名前のファイルを作成します。

import random
from uuid import uuid4

from flask import Flask, make_response, request
from google.cloud import firestore


app = Flask(__name__)
db = firestore.Client()
sessions = db.collection('sessions')
greetings = [
    'Hello World',
    'Hallo Welt',
    'Ciao Mondo',
    'Salut le Monde',
    'Hola Mundo',
]


@firestore.transactional
def get_session_data(transaction, session_id):
    """ Looks up (or creates) the session with the given session_id.
        Creates a random session_id if none is provided. Increments
        the number of views in this session. Updates are done in a
        transaction to make sure no saved increments are overwritten.
    """
    if session_id is None:
        session_id = str(uuid4())   # Random, unique identifier

    doc_ref = sessions.document(document_id=session_id)
    doc = doc_ref.get(transaction=transaction)
    if doc.exists:
        session = doc.to_dict()
    else:
        session = {
            'greeting': random.choice(greetings),
            'views': 0
        }

    session['views'] += 1   # This counts as a view
    transaction.set(doc_ref, session)

    session['session_id'] = session_id
    return session


@app.route('/', methods=['GET'])
def home():
    template = '<body>{} views for "{}"</body>'

    transaction = db.transaction()
    session = get_session_data(transaction, request.cookies.get('session_id'))

    resp = make_response(template.format(
        session['views'],
        session['greeting']
        )
    )
    resp.set_cookie('session_id', session['session_id'], httponly=True)
    return resp


if __name__ == '__main__':
    app.run(host='127.0.0.1', port=8080)

次の図は、Firestore が App Engine アプリ用のセッションを処理する方法を示しています。

セッションの削除

セッションデータを削除するか、自動削除戦略を実装できます。セッションに、Memcache や Redis などのストレージソリューションを使用すると、期限切れのセッションが自動的に削除されます。

ローカルでの実行

ターミナルウィンドウで、Gunicorn HTTP サーバーをインストールします。
```
pip install gunicorn
```
Gunicorn HTTP サーバーを実行します。
```
gunicorn -b :8080 main:app
```
ウェブブラウザでアプリを表示します。

Cloud Shell

Cloud Shell ツールバーの [ウェブでプレビュー] アイコンをクリックし、[ポート 8080 でプレビュー] を選択します。

ローカルマシン

ブラウザで、http://localhost:8080 にアクセスします。

「Hello World」、「Hallo Welt」、「Hola mundo」、「Salut le Monde」、「Ciao Mondo」の 5 つの挨拶のいずれかが表示されます。別のブラウザまたはシークレットモードでページを開くと、別の言語で表示されます。セッションデータは Google Cloud コンソールで表示して編集できます。
HTTP サーバーを停止するには、ターミナルウィンドウで Control+C を押します。

App Engine でのデプロイと実行

App Engine スタンダード環境を使用すると、高い負荷の下で大量のデータを使用して正常に動作するアプリをビルドしてデプロイできます。

このチュートリアルでは、App Engine スタンダード環境を使用してサーバーをデプロイします。

ターミナルウィンドウで app.yaml ファイルを作成し、以下をコピーします。
```
runtime: python37
```
App Engine にアプリをデプロイします。
```
gcloud app deploy
```
https://your-project-id.appspot.com で公開されているライブアプリを表示します。
```
gcloud app browse
```
ここで、your-project-id は Google Cloud プロジェクト ID です。

これで、App Engine インスタンスで実行しているウェブサーバーから挨拶が配信されます。

アプリのデバッグ

App Engine アプリに接続できない場合は、次の点を確認してください。

gcloud デプロイコマンドが正常に終了して、エラーを出力しなかったことを確認します。エラー（message=Build failed など）が発生した場合は、それらを修正してから、もう一度、App Engine アプリのデプロイを試みます。
Google Cloud コンソールで、[ログエクスプローラ] ページに移動します。

[ログエクスプローラ] ページに移動
1. [最近選択したリソース] プルダウンリストで、[App Engine アプリケーション] をクリックしてから、[All module_id] をクリックします。アプリにアクセスした以降のリクエストのリストが表示されます。リクエストのリストが表示されない場合は、プルダウンリストで [All module_id ] が選択されていることを確認します。エラーメッセージが Google Cloud コンソールに出力された場合は、アプリのコードがウェブアプリの作成に関するセクション内のコードと一致することを確認します。
2. Firestore API が有効になっていることを確認します。

クリーンアップ

プロジェクトを削除する

注意: プロジェクトを削除すると、次のような影響があります。

プロジェクト内のすべてのものが削除されます。既存のプロジェクトを使用してこのドキュメントのタスクを行った場合、そのプロジェクトを削除すると、プロジェクト内で行った他の作業もすべて削除されます。
カスタムプロジェクト ID が失われます。このプロジェクトを作成したときに、将来使用するカスタムプロジェクト ID を作成した可能性があります。そのプロジェクト ID を使用した URL（例: appspot.com）を保持するには、プロジェクト全体ではなく、プロジェクト内の選択したリソースだけを削除します。

複数のアーキテクチャ、チュートリアル、クイックスタートを実施する予定がある場合は、プロジェクトを再利用すると、プロジェクトの割り当て上限を超えないようにすることができます。

Google Cloud コンソールで [リソースの管理] ページに移動します。
[リソースの管理] に移動
プロジェクトリストで、削除するプロジェクトを選択し、[削除] をクリックします。
ダイアログでプロジェクト ID を入力し、[シャットダウン] をクリックしてプロジェクトを削除します。

App Engine インスタンスの削除

Google Cloud コンソールで、App Engine の [バージョン] ページに移動します。
[バージョン] に移動
デフォルト以外で削除するアプリのバージョンのチェックボックスをオンにします。
注: App Engine アプリのデフォルトバージョンを削除する唯一の方法は、プロジェクトを削除することです。ただし、 Google Cloud コンソールでデフォルトバージョンを停止することもできます。このアクションによって、バージョンに関連付けられているすべてのインスタンスがシャットダウンします。これらのインスタンスは、必要に応じてあとで再起動できます。

App Engine スタンダード環境では、お使いのアプリに手動スケーリングまたは基本スケーリングがある場合、デフォルトバージョンを停止させることができます。
アプリのバージョンを削除するには、[削除] をクリックします。

次のステップ

その他の Cloud Run 関数のチュートリアルを試す。
App Engine の詳細を確認する
Cloud Run を使用してみる（フルマネージド環境や独自の Google Kubernetes Engine クラスタでステートレスコンテナを実行できます）。

Firestore でのセッション処理 コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

目標

費用

始める前に

プロジェクトの設定

ウェブアプリの作成

セッションの削除

ローカルでの実行

Cloud Shell

ローカルマシン

App Engine でのデプロイと実行

アプリのデバッグ

クリーンアップ

プロジェクトを削除する

App Engine インスタンスの削除

次のステップ

Firestore でのセッション処理