Firestore でのセッション処理

---

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

目標

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

料金

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

• App Engine
• Firestore

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

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

準備

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

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

   注: この手順で作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの終了後にそのプロジェクトを削除すれば、プロジェクトに関連するすべてのリソースを削除できます。

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

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

4. Firestore API を有効にします。

   API を有効にする

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

6. gcloud CLI を初期化するには:

   gcloud init

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

   注: この手順で作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの終了後にそのプロジェクトを削除すれば、プロジェクトに関連するすべてのリソースを削除できます。

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

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

9. Firestore API を有効にします。

   API を有効にする

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

11. gcloud CLI を初期化するには:

    gcloud init

プロジェクトの設定

1. ターミナル ウィンドウで、選択したディレクトリに移動し、sessions という名前の新しいディレクトリを作成します。このチュートリアルのコードはすべて、sessions ディレクトリ内にあります。

2. sessions ディレクトリに移動します。

   cd sessions
   

3. package.json ファイルを初期化します。

   npm init .
   

4. 依存関係をインストールします。

   npm install \
    --save @google-cloud/connect-firestore @google-cloud/firestore express express-session
   

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

sessions
├── app.yaml
├── index.js
└── package.json

ウェブアプリの作成

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

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

express-session と互換性のあるセッション ストア、connect-firestore を使用できます。

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

  sessions/index.js

  GitHub で表示

  // Copyright 2019, Google LLC.
  // Licensed under the Apache License, Version 2.0 (the "License");
  // you may not use this file except in compliance with the License.
  // You may obtain a copy of the License at
  //
  //    http://www.apache.org/licenses/LICENSE-2.0
  //
  // Unless required by applicable law or agreed to in writing, software
  // distributed under the License is distributed on an "AS IS" BASIS,
  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  // See the License for the specific language governing permissions and
  // limitations under the License.
  
  const {Firestore} = require('@google-cloud/firestore');
  const express = require('express');
  const session = require('express-session');
  
  const app = express();
  const {FirestoreStore} = require('@google-cloud/connect-firestore');
  
  app.use(
    session({
      store: new FirestoreStore({
        dataset: new Firestore(),
        kind: 'express-sessions',
      }),
      secret: 'my-secret',
      resave: false,
      saveUninitialized: true,
    })
  );
  
  const greetings = [
    'Hello World',
    'Hallo Welt',
    'Ciao Mondo',
    'Salut le Monde',
    'Hola Mundo',
  ];
  
  app.get('/', (req, res) => {
    if (!req.session.views) {
      req.session.views = 0;
      req.session.greeting =
        greetings[Math.floor(Math.random() * greetings.length)];
    }
    const views = req.session.views++;
    res.send(`${views} views for ${req.session.greeting}`);
  });
  
  const port = process.env.PORT || 8080;
  app.listen(port, () => {
    console.log(`Example app listening on port ${port}!`);
  });
  
  module.exports = app;
  

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

app.use(session) を設定すると、すべてのリクエストが req.session プロパティを持つようになり、このプロパティを使用してリピーターを特定できます。セッション データは Firestore に保存されます。

注: Express によって提供されるセッション ミドルウェアの express-session は、セッション ストレージのさまざまなオプションをサポートしています。詳細については、express-session ページ をご覧ください。Firestore は永続的な分散型トランザクション データベースです。通常は、セッションには別のストレージ ソリューションを選択する方が適切です。たとえば、Memcache や Redis では、設計内容によりこのユースケースでより高速な動作結果が得られる可能性があります。

セッションの削除

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

ローカルでの実行

1. ターミナル ウィンドウで、Google Cloud プロジェクトの依存関係をインストールします。

   npm install
   

2. HTTP サーバーを起動します。

   npm start
   

3. ウェブブラウザでアプリを表示します。

   Cloud Shell

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

   ローカルマシン

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

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

   

4. HTTP サーバーを停止するには、ターミナル ウィンドウで Control+C を押します。

App Engine でのデプロイと実行

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

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

1. ターミナル ウィンドウで app.yaml ファイルを作成し、以下をコピーします。

   sessions/app.yaml

   GitHub で表示

   runtime: nodejs10

2. App Engine にアプリをデプロイします。

   gcloud app deploy
   

3. 次の URL を入力して、ライブアプリを表示します。

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

   以下を置き換えます。

   • PROJECT_ID: Google Cloud プロジェクト ID
   • REGION_ID: App Engine がアプリに割り当てるコード

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

アプリのデバッグ

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

1. gcloud デプロイ コマンドが正常に終了して、エラーを出力しなかったことを確認します。エラー（message=Build failed など）が発生した場合は、それらを修正してから、もう一度、App Engine アプリのデプロイを試みます。

2. Google Cloud コンソールで、[ログ エクスプローラ] ページに移動します。

   [ログ エクスプローラ] ページに移動

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

   2. Firestore API が有効になっていることを確認します。

クリーンアップ

プロジェクトの削除

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

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

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

1. Google Cloud コンソールで、[リソースの管理] ページに移動します。

   [リソースの管理] に移動

2. プロジェクト リストで、削除するプロジェクトを選択し、[削除] をクリックします。
3. ダイアログでプロジェクト ID を入力し、[シャットダウン] をクリックしてプロジェクトを削除します。

App Engine インスタンスの削除

1. Google Cloud コンソールで、App Engine の [バージョン] ページに移動します。

   [バージョン] に移動

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

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

3. アプリのバージョンを削除するには、[削除] をクリックします。

次のステップ

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