Gérer les sessions avec Firestore

De nombreuses applications requièrent une fonctionnalité de gestion de session pour l'authentification et le stockage des préférences utilisateur. Le framework Node.js Express intègre une mise en œuvre basée sur la mémoire pour assurer cette gestion. Cette mise en œuvre n'est toutefois pas adaptée à une application pouvant être diffusée depuis plusieurs instances. En effet, la session enregistrée dans une instance peut différer des autres instances. Ce tutoriel explique comment gérer des sessions sur App Engine.

Objectifs

• Écrire l'application
• Exécuter l'application en local
• Déployer l'application sur App Engine

Coûts

Dans ce document, vous utilisez les composants facturables suivants de Google Cloud:

• App Engine
• Firestore

Obtenez une estimation des coûts en fonction de votre utilisation prévue, utilisez le simulateur de coût.

Les nouveaux utilisateurs de peuvent bénéficier d'un essai sans frais. Google Cloud

Une fois que vous avez terminé les tâches décrites dans ce document, supprimez les ressources que vous avez créées pour éviter que des frais vous soient facturés. Pour en savoir plus, consultez la section Effectuer un nettoyage.

Avant de commencer

Connectez-vous à votre Google Cloud compte. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $de crédits sans frais pour exécuter, tester et déployer des charges de travail.

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

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

Installez la Google Cloud CLI.

Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

Pour initialiser la gcloud CLI, exécutez la commande suivante :

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

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

Installez la Google Cloud CLI.

Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

Pour initialiser la gcloud CLI, exécutez la commande suivante :

gcloud init

Mettre en place le projet

1. Dans votre fenêtre de terminal, accédez au répertoire de votre choix et créez-y un répertoire nommé sessions. L'ensemble du code de ce tutoriel se base sur une exécution dans le répertoire sessions.

2. Accédez donc à ce répertoire sessions :

   cd sessions
   

3. Initialisez le fichier package.json :

   npm init .
   

4. Installez les dépendances :

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

À la fin de ce tutoriel, la structure de fichiers finale ressemble à ce qui suit :

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

Écrire l'application Web

L'application affiche des messages d'accueil dans différentes langues pour chaque utilisateur. Les utilisateurs connus reçoivent toujours les messages d'accueil dans la même langue.

Pour que votre application puisse stocker les préférences d'un utilisateur, vous devez mettre en œuvre une méthode permettant de stocker les informations sur l'utilisateur actuel dans une session. Dans cet exemple d'application, les données de session sont stockées à l'aide de Firestore.

Vous pouvez utiliser connect-firestore, un magasin de sessions compatible avec express-session.

• Dans votre fenêtre de terminal, créez un fichier nommé index.js contenant le code suivant :

  // 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;
  

Le schéma suivant décrit la façon dont Firestore gère les sessions pour l'application App Engine.

Une fois que vous avez défini app.use(session), chaque requête est associée à une propriété req.session permettant d'identifier les utilisateurs récurrents. Les données de session sont stockées dans Firestore.

Remarque : express-session, le middleware de session fourni par Express, propose différentes options de stockage de session. Pour en savoir plus, consultez la page concernant express-session. Firestore est une base de données transactionnelle distribuée et persistante. Il est souvent plus judicieux de choisir une autre solution de stockage pour des sessions telles que Memcache ou Redis, dont la conception pourrait permettre une opération plus rapide dans ce cas d'utilisation.

Supprimer des sessions

Connect-firestore ne supprime pas les sessions anciennes ou expirées. Vous pouvez supprimer les données de session dans la Google Cloud console ou mettre en œuvre une stratégie de suppression automatique. Si vous utilisez des solutions de stockage pour des sessions telles que Memcache ou Redis, les sessions expirées sont automatiquement supprimées.

Exécution locale

1. Dans la fenêtre de terminal, installez les dépendances pour le Google Cloud projet :

   npm install
   

2. Démarrez le serveur HTTP :

   npm start
   

3. Affichez l'application dans votre navigateur Web :

   Cloud Shell

   Dans la barre d'outils Cloud Shell, cliquez sur Aperçu sur le Web et sélectionnez Prévisualiser sur le port 8080.

   Machine locale

   Dans votre navigateur, accédez à http://localhost:8080

   L'un des cinq messages d'accueil suivants s'affiche : "Hello World", "Hallo Welt", "Hola mundo", "Salut le Monde" ou "Ciao Mondo". La langue change si vous ouvrez la page dans un autre navigateur ou en mode navigation privée. Vous pouvez consulter et modifier les données de session dans la Google Cloud console.

   

4. Dans votre fenêtre de terminal, appuyez sur Control+C pour arrêter le serveur HTTP.

Déployer et exécuter l'application sur App Engine

Vous pouvez utiliser l' environnement standard App Engine pour créer et déployer une application qui s'exécute de manière fiable, même lorsqu'elle est soumise à une charge importante et doit gérer de grandes quantités de données.

Dans ce tutoriel, le serveur est déployé dans l'environnement standard App Engine.

1. Dans votre fenêtre de terminal, créez un fichier app.yaml et copiez le contenu suivant :

   runtime: nodejs10

2. Déployez l'application sur App Engine :

   gcloud app deploy
   

3. Affichez l'application en direct en saisissant l'URL suivante :

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

   Remplacez les éléments suivants :

   • PROJECT_ID: ID de votre Google Cloud projet
   • REGION_ID : code attribué par App Engine à votre application

Le message d'accueil est désormais diffusé par un serveur Web exécuté sur une instance App Engine.

Déboguer l'application

Si vous ne parvenez pas à vous connecter à votre application App Engine, vérifiez les éléments suivants :

1. Vérifiez que les commandes de déploiement gcloud ont bien abouti et n'ont généré aucune erreur. Si des erreurs se sont produites (par exemple, message=Build failed), corrigez-les, puis essayez de redéployer l'application App Engine à nouveau.

2. Dans la Google Cloud console, accédez à la page Explorateur de journaux.

   Accéder à la page "Explorateur de journaux"

   1. Dans la liste déroulante Ressources sélectionnées récemment, cliquez sur Application App Engine, puis sur Tous les ID de module. La liste des requêtes correspondant à votre accès à l'application s'affiche. Si cette liste n'apparaît pas, vérifiez que vous avez bien sélectionné Tous les ID de module dans la liste déroulante. Si des messages d'erreur s'affichent dans la Google Cloud console, vérifiez que le code de votre application correspond au code décrit dans la section sur l'écriture de l'application Web.

   2. Assurez-vous que l'API Firestore est activée.

Effectuer un nettoyage

Supprimer le projet

Attention : La suppression d'un projet aura les effets suivants :

• Tout le contenu du projet est supprimé. Si vous avez utilisé un projet existant pour les tâches décrites dans ce document et que vous le supprimez, vous supprimerez également tout autre travail effectué dans le projet.
• Les ID de projets personnalisés sont perdus. Lorsque vous avez créé ce projet, vous avez peut-être créé un ID de projet personnalisé que vous souhaitez utiliser à l'avenir. Pour conserver les URL qui utilisent l'ID de projet, telle qu'une URL appspot.com, supprimez les ressources sélectionnées dans le projet au lieu de supprimer l'ensemble du projet.

Si vous envisagez d'explorer plusieurs architectures, tutoriels et guides de démarrage rapide, réutiliser des projets peut vous aider à ne pas dépasser les limites de quotas des projets.

1. Dans la Google Cloud console, accédez à la page Gérer les ressources.

   Accéder à la page "Gérer les ressources"

2. Dans la liste des projets, sélectionnez le projet que vous souhaitez supprimer, puis cliquez sur Supprimer.
3. Dans la boîte de dialogue, saisissez l'ID du projet, puis cliquez Arrêter pour supprimer le projet.

Supprimer l'instance App Engine

1. Dans la Google Cloud console, accédez à la page Versions pour App Engine.

   Accéder à la page "Versions"

2. Cochez la case correspondant à la version de l'application autre que celle par défaut que vous souhaitez supprimer.
   Remarque : Le seul moyen de supprimer la version par défaut de votre application App Engine consiste à supprimer votre projet. Vous pouvez toutefois arrêter la version par défaut dans la Google Cloud console. Cette opération a pour effet d'arrêter toutes les instances associées à la version. Vous pourrez redémarrer ces instances ultérieurement si nécessaire.

   Dans l'environnement standard App Engine, vous ne pouvez arrêter la version par défaut que si vous avez spécifié le scaling manuel ou de base pour votre application.

3. Pour supprimer la version de l'application, cliquez sur Supprimer.

Étape suivante

• Découvrez d'autres tutoraires sur les fonctions Cloud Run.
• Obtenez plus d'informations sur App Engine.
• Essayez Cloud Run, qui vous permet d'exécuter des conteneurs sans état dans un environnement entièrement géré ou dans votre propre cluster Google Kubernetes Engine.