Gestione delle sessioni con Firestore

Molte app richiedono la gestione delle sessioni per l'autenticazione e le preferenze utente. Il framework Node.js Express include un'implementazione basata sulla memoria per eseguire questa funzione. Tuttavia, questa implementazione non è adatta a un'app che può essere pubblicata da più istanze, perché la sessione registrata in un'istanza potrebbe differire da altre istanze. Questo tutorial mostra come gestire le sessioni su App Engine.

Obiettivi

• Scrivi l'app.
• Esegui l'app localmente.
• Eseguire il deployment dell'app su App Engine.

Costi

In questo documento vengono utilizzati i seguenti componenti fatturabili di Google Cloud:

• App Engine
• Firestore

Per generare una stima dei costi in base all'utilizzo previsto, utilizza il Calcolatore prezzi.

I nuovi utenti di Google Cloud potrebbero avere diritto a una prova senza costi.

Al termine delle attività descritte in questo documento, puoi evitare l'addebito di ulteriori costi eliminando le risorse che hai creato. Per saperne di più, consulta Esegui la pulizia.

Prima di iniziare

Accedi al tuo account Google Cloud . Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti senza costi per l'esecuzione, il test e il deployment dei carichi di lavoro.

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, if it is not already enabled.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the API

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

To initialize the gcloud CLI, run the following command:

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, if it is not already enabled.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the API

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

To initialize the gcloud CLI, run the following command:

gcloud init

Configurazione del progetto

1. Nella finestra del terminale, inizia in una directory di tua scelta e crea una nuova directory denominata sessions. Tutto il codice per questo tutorial si trova all'interno della directory sessions.

2. Passa alla directory sessions:

   cd sessions
   

3. Inizializza il file package.json:

   npm init .
   

4. Installa le dipendenze:

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

Al termine di questo tutorial, la struttura finale dei file sarà simile alla seguente:

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

Scrivere l'app web

Questa app mostra saluti in lingue diverse per ogni utente. Gli utenti di ritorno vengono sempre accolti nella stessa lingua.

Prima che l'app possa memorizzare le preferenze di un utente, devi trovare un modo per archiviare le informazioni sull'utente corrente in una sessione. Questa app di esempio utilizza Firestore per archiviare i dati di sessione.

Puoi utilizzare connect-firestore, un archivio di sessioni compatibile con express-session.

• Nella finestra del terminale, crea un file denominato index.js con il seguente contenuto:

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

Il seguente diagramma illustra come Firestore gestisce le sessioni per l'app App Engine.

Dopo aver impostato app.use(session), ogni richiesta ha una proprietà req.session che puoi utilizzare per identificare gli utenti ricorrenti. I dati della sessione vengono archiviati in Firestore.

Nota: express-session, il middleware di sessione fornito da Express, supporta varie opzioni per l'archiviazione delle sessioni. Per saperne di più, consulta la pagina express-session. un database transazionale distribuito e persistente. Spesso è più appropriato scegliere una soluzione di archiviazione diversa per le sessioni, ad esempio Memcache o Redis, la cui progettazione potrebbe comportare un'operazione più rapida in questo caso d'uso.

Eliminazione delle sessioni

Connect-firestore non elimina le sessioni vecchie o scadute. Puoi eliminare i dati della sessione nella consoleGoogle Cloud o implementare una strategia di eliminazione automatica. Se utilizzi soluzioni di archiviazione per le sessioni come Memcache o Redis, le sessioni scadute vengono eliminate automaticamente.

Esecuzione in locale

1. Nella finestra del terminale, installa le dipendenze per il progetto Google Cloud :

   npm install
   

2. Avvia il server HTTP:

   npm start
   

3. Visualizza l'app nel browser web:

   Cloud Shell

   Nella barra degli strumenti di Cloud Shell, fai clic su Anteprima web e seleziona Anteprima sulla porta 8080.

   Macchina locale

   Nel browser, vai a http://localhost:8080

   Viene visualizzato uno dei cinque saluti: "Hello World", "Hallo Welt", "Hola mundo", "Salut le Monde" o "Ciao Mondo". La lingua cambia se apri la pagina in un browser diverso o in modalità Incognito. Puoi visualizzare e modificare i dati della sessione nella consoleGoogle Cloud .

   

4. Per arrestare il server HTTP, premi Control+C nella finestra del terminale.

Deployment ed esecuzione su App Engine

Puoi utilizzare l'ambiente standard di App Engine per creare ed eseguire il deployment di un'app che funziona in modo affidabile anche se sottoposta a un carico elevato e con grandi quantità di dati.

Questo tutorial utilizza l'ambiente standard App Engine per eseguire il deployment del server.

1. Nella finestra del terminale, crea un file app.yaml e copia quanto segue:

   runtime: nodejs10

2. Esegui il deployment dell'app su App Engine:

   gcloud app deploy
   

3. Visualizza l'app live inserendo il seguente URL:

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

   Sostituisci quanto segue:

   • PROJECT_ID: il tuo ID progetto Google Cloud
   • REGION_ID: un codice che App Engine assegna alla tua app

Il saluto viene ora fornito da un server web in esecuzione su un'istanza App Engine.

Eseguire il debug dell'app

Se non riesci a connetterti alla tua app App Engine, controlla quanto segue:

1. Verifica che i comandi di deployment gcloud siano stati completati correttamente e non abbiano generato errori. Se si sono verificati errori (ad esempio, message=Build failed), correggili e prova a eseguire di nuovo il deployment dell'app App Engine.

2. Nella console Google Cloud , vai alla pagina Esplora log.

   Vai alla pagina Esplora log

   1. Nell'elenco a discesa Risorse selezionate di recente, fai clic su Applicazione App Engine, quindi fai clic su Tutti i module_id. Viene visualizzato un elenco di richieste relative alle tue visite all'app. Se non vedi un elenco di richieste, verifica di aver selezionato Tutti gli ID modulo dall'elenco a discesa. Se visualizzi messaggi di errore stampati nella console Google Cloud , verifica che il codice della tua app corrisponda al codice nella sezione relativa alla scrittura dell'app web.

   2. Assicurati che l'API Firestore sia abilitata.

Esegui la pulizia

Elimina il progetto

Attenzione: l'eliminazione di un progetto ha i seguenti effetti:

• L'intero contenuto del progetto viene eliminato. Se hai utilizzato un progetto esistente per, le attività descritte in questo documento, eliminerai anche tutto il lavoro che hai svolto nel progetto.
• Gli ID progetto personalizzati non sono più disponibili. Quando hai creato questo progetto, potresti aver creato un ID progetto personalizzato che vuoi utilizzare in futuro. Per conservare gli URL che utilizzano l'ID progetto, ad esempio un URL appspot.com, elimina le risorse selezionate all'interno del progetto anziché eliminare l'intero progetto.

Se intendi esplorare più architetture, tutorial o guide rapide, puoi riutilizzare i progetti ed evitare così di superare i limiti di quota.

1. Nella console Google Cloud , vai alla pagina Gestisci risorse.

   Vai a Gestisci risorse

2. Nell'elenco dei progetti, seleziona il progetto che vuoi eliminare, quindi fai clic su Elimina.
3. Nella finestra di dialogo, digita l'ID progetto, quindi fai clic su Chiudi per eliminare il progetto.

Elimina l'istanza App Engine

1. Nella console Google Cloud , vai alla pagina Versioni per App Engine.

   Vai a Versioni

2. Seleziona la casella di controllo per la versione dell'app non predefinita da eliminare.
   Nota:L'unico modo per eliminare la versione predefinita dell'app App Engine è eliminare il progetto. Tuttavia, puoi interrompere la versione predefinita nella Google Cloud console. Questa azione arresta tutte le istanze associate alla versione. Se necessario, puoi riavviare queste istanze in un secondo momento.

   Nell'ambiente standard App Engine, puoi arrestare la versione predefinita solo se la tua app ha scalabilità manuale o di base.

3. Per eliminare la versione dell'app, fai clic su Elimina.

Passaggi successivi

• Prova altri tutorial su Cloud Run Functions.
• Scopri di più su App Engine.
• Prova Cloud Run, che ti consente di eseguire container stateless in un ambiente completamente gestito o nel tuo cluster Google Kubernetes Engine.