Gestione delle sessioni con Firestore

Molte app richiedono la gestione delle sessioni per l'autenticazione e le preferenze utente. Il framework Flask 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 dalle altre istanze. Questo tutorial mostra come gestire le sessioni su App Engine.

Obiettivi

• Scrivi l'app.
• Esegui l'app localmente.
• Esegui 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 workload.

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

Installa Google Cloud CLI.

Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

Per inizializzare gcloud CLI, esegui questo comando:

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

Installa Google Cloud CLI.

Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

Per inizializzare gcloud CLI, esegui questo comando:

gcloud init

1. Installa Python, pip e virtualenv sul tuo sistema. Per istruzioni, vedi Configurazione di un ambiente di sviluppo Python per Google Cloud.

Configurazione del progetto

1. Nella finestra del terminale, inizia in una directory a 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. Crea il file requirements.txt con i seguenti contenuti:

   google-cloud-firestore==2.11.1
   flask==2.2.5
   

4. Installa le dipendenze:

   pip install  -r requirements.txt
   

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

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

Scrittura dell'app web

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

Prima che la tua app possa memorizzare le preferenze di un utente, devi disporre di un modo per memorizzare le informazioni sull'utente corrente in una sessione. Questa app di esempio utilizza i cookie e Firestore per archiviare i dati della sessione.

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

  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)

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

  

Eliminazione delle sessioni

Puoi eliminare i dati della sessione 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 il server HTTP di Gunicorn:

   pip install gunicorn
   

2. Esegui il Gunicorn HTTP server:

   gunicorn -b :8080 main:app
   

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à di navigazione in 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 di App Engine per eseguire il deployment del server.

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

   runtime: python37

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

   gcloud app deploy
   

3. Visualizza l'app live all'indirizzo https://your-project-id.appspot.com:

   gcloud app browse
   

   Dove your-project-id è l'ID progetto Google Cloud .

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

Esecuzione del 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 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 i module_id dall'elenco a discesa. Se visualizzi messaggi di errore stampati nella console Google Cloud , verifica che il codice dell'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 quello che vuoi eliminare, quindi fai clic su Elimina.
3. Nella finestra di dialogo, digita l'ID del progetto e 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 che vuoi eliminare.
   Nota: L'unico modo per eliminare la versione predefinita dell'app App Engine è eliminare il progetto. Tuttavia, puoi interrompere la versione predefinita nella console Google Cloud . Questa azione arresta tutte le istanze associate alla versione. Se necessario, puoi riavviare queste istanze in un secondo momento.

   Nell'ambiente standard di App Engine, puoi arrestare la versione predefinita solo se la tua app ha una 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.