Firestore でのセッション処理

このチュートリアルでは、App Engine でセッションを処理する方法を示します。

多くのアプリには、認証設定とユーザー設定用のセッション処理が必要です。 Gorilla ウェブツールキット sessions パッケージには、この機能を実行するためのファイルシステムベースの実装が付属しています。ただし、記録されるセッションがインスタンス間で異なる場合があるため、この実装は複数のインスタンスから提供できるアプリには適していません。gorilla/sessions パッケージには、Cookie ベースの実装も付属しています。ただし、この実装では、セッション ID だけでなく、Cookie を暗号化してセッション全体をクライアントに保存する必要があるため、一部のアプリでは大きすぎる場合があります。

目標

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

料金

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

料金計算ツールを使うと、予想使用量に基づいて費用の見積もりを生成できます。新しい Google Cloud ユーザーは無料トライアルをご利用いただける場合があります。

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

始める前に

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

Google Cloud Console の [プロジェクトセレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

プロジェクトセレクタに移動

Google Cloud プロジェクトで課金が有効になっていることを確認します。

Firestore API を有効にします。

API を有効にする

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

gcloud CLI を初期化するには:

gcloud init

Google Cloud Console の [プロジェクトセレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

プロジェクトセレクタに移動

Google Cloud プロジェクトで課金が有効になっていることを確認します。

Firestore API を有効にします。

API を有効にする

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

gcloud CLI を初期化するには:

gcloud init

gcloud コンポーネントを更新します。
```
gcloud components update
```
開発環境を準備します。

プロジェクトの設定

ターミナルウィンドウで、サンプルアプリリポジトリのクローンをローカルマシンに作成します。
```
git clone https://github.com/GoogleCloudPlatform/golang-samples.git
```
サンプルコードが入っているディレクトリに移動します。
```
cd golang-samples/getting-started/sessions
```

ウェブアプリについて理解する

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

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

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

gorilla/sessions と互換性のあるセッションストア、firestoregorilla を使用できます。

アプリは、依存関係をインポートし、sessions.Store と HTML テンプレートを保持するための app 関数を定義して、挨拶の一覧を定義することにより起動します。


// Command sessions starts an HTTP server that uses session state.
package main

import (
	"context"
	"fmt"
	"html/template"
	"log"
	"math/rand"
	"net/http"
	"os"

	"cloud.google.com/go/firestore"
	firestoregorilla "github.com/GoogleCloudPlatform/firestore-gorilla-sessions"
	"github.com/gorilla/sessions"
)

// app stores a sessions.Store. Create a new app with newApp.
type app struct {
	store sessions.Store
	tmpl  *template.Template
}

// greetings are the random greetings that will be assigned to sessions.
var greetings = []string{
	"Hello World",
	"Hallo Welt",
	"Ciao Mondo",
	"Salut le Monde",
	"Hola Mundo",
}

次に、アプリが main 関数を定義します。この関数は、新しい app インスタンスを作成し、インデックスハンドラを登録して、HTTP サーバーを起動します。newApp 関数は、firestoregorilla.New 関数を使用して sessions.Store を初期化することにより、app インスタンスを作成します。


func main() {
	port := os.Getenv("PORT")
	if port == "" {
		port = "8080"
	}
	projectID := os.Getenv("GOOGLE_CLOUD_PROJECT")
	if projectID == "" {
		log.Fatal("GOOGLE_CLOUD_PROJECT must be set")
	}

	a, err := newApp(projectID)
	if err != nil {
		log.Fatalf("newApp: %v", err)
	}

	http.HandleFunc("/", a.index)

	log.Printf("Listening on port %s", port)
	if err := http.ListenAndServe(":"+port, nil); err != nil {
		log.Fatal(err)
	}
}

// newApp creates a new app.
func newApp(projectID string) (*app, error) {
	ctx := context.Background()
	client, err := firestore.NewClient(ctx, projectID)
	if err != nil {
		log.Fatalf("firestore.NewClient: %v", err)
	}
	store, err := firestoregorilla.New(ctx, client)
	if err != nil {
		log.Fatalf("firestoregorilla.New: %v", err)
	}

	tmpl, err := template.New("Index").Parse(`<body>{{.views}} {{if eq .views 1.0}}view{{else}}views{{end}} for "{{.greeting}}"</body>`)
	if err != nil {
		return nil, fmt.Errorf("template.New: %w", err)
	}

	return &app{
		store: store,
		tmpl:  tmpl,
	}, nil
}

インデックスハンドラは、ユーザーのセッションを取得し、必要に応じてセッションを作成します。新しいセッションには、ランダムな言語とビューカウント「0」が割り当てられます。次に、ビューカウントが 1 増加し、セッションが保存され、HTML テンプレートにより応答が書き込まれます。


// index uses sessions to assign users a random greeting and keep track of
// views.
func (a *app) index(w http.ResponseWriter, r *http.Request) {
	if r.RequestURI != "/" {
		return
	}

	// name is a non-empty identifier for this app's sessions. Set it to
	// something descriptive for your app. It is used as the Firestore
	// collection name that stores the sessions.
	name := "hello-views"
	session, err := a.store.Get(r, name)
	if err != nil {
		// Could not get the session. Log an error and continue, saving a new
		// session.
		log.Printf("store.Get: %v", err)
	}

	if session.IsNew {
		// firestoregorilla uses JSON, which unmarshals numbers as float64s.
		session.Values["views"] = float64(0)
		session.Values["greeting"] = greetings[rand.Intn(len(greetings))]
	}
	session.Values["views"] = session.Values["views"].(float64) + 1
	if err := session.Save(r, w); err != nil {
		log.Printf("Save: %v", err)
		// Don't return early so the user still gets a response.
	}

	if err := a.tmpl.Execute(w, session.Values); err != nil {
		log.Printf("Execute: %v", err)
	}
}

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

アーキテクチャの図: ユーザー、App Engine、Firestore。

セッションの削除

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

ローカルでの実行

ターミナルウィンドウで、sessions バイナリをビルドします。
```
go build
```
HTTP サーバーを起動します。
```
./sessions
```
ウェブブラウザでアプリを表示します。

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 ファイルには、App Engine スタンダード環境の構成が含まれています。

runtime: go112

App Engine にアプリをデプロイします。
```
gcloud app deploy
```
ブラウザに次の URL を入力します。

https://PROJECT_ID.REGION_ID.r.appspot.com

以下を置き換えます。
- PROJECT_ID: Google Cloud プロジェクト ID
- REGION_ID: App Engine がアプリに割り当てるコード

これで、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）を保持するには、プロジェクト全体ではなくプロジェクト内の選択したリソースだけを削除します。

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

In the Google Cloud console, go to the Manage resources page.
Go to Manage resources
In the project list, select the project that you want to delete, and then click Delete.
In the dialog, type the project ID, and then click Shut down to delete the project.

App Engine インスタンスの削除

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

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

次のステップ

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

Firestore でのセッション処理

目標

料金

始める前に

プロジェクトの設定

ウェブアプリについて理解する

セッションの削除

ローカルでの実行

Cloud Shell

ローカルマシン

App Engine でのデプロイと実行

アプリのデバッグ

クリーンアップ

プロジェクトの削除

App Engine インスタンスの削除

次のステップ