Gestione delle sessioni con Firestore

Molte app richiedono la gestione delle sessioni per l'autenticazione e le preferenze utente. Sinatra 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 su un'istanza potrebbe essere diversa da altre istanze. Questo tutorial mostra come gestire le sessioni su App Engine.

Obiettivi

• Scrivere l'app.
• Eseguire l'app in locale.
• 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 Google Cloud utenti 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 Google Cloud account. 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

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

1. Prepara l'ambiente di sviluppo.

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 di questo tutorial si trova nella directory sessions.

2. Passa alla directory sessions:

   cd sessions
   

3. Inizializza il file Gemfile:

   bundle init
   

4. Aggiungi quanto segue al file Gemfile risultante:

   gem "google-cloud-firestore", "~> 2.0"
   gem "sinatra", "~> 2.0"

   Il file Gemfile elenca tutte le librerie Ruby non standard che App Engine deve caricare per la tua app:

   • google-cloud-firestore è il client Ruby per l'API Firestore.

   • Sinatra è il framework web Ruby utilizzato per l'app.

5. Installa le dipendenze:

   bundle install
   

Scrittura dell'app web

Questa app mostra saluti in lingue diverse per ogni utente. Gli utenti che ritornano vengono sempre salutati nella stessa lingua.

• Con un editor di testo, crea un file denominato app.rb nella directory sessions con il seguente contenuto:

  require "sinatra"
  
  require_relative "firestore_session"
  
  use Rack::Session::FirestoreSession
  
  set :greetings, ["Hello World", "Hallo Welt", "Ciao Mondo", "Salut le Monde", "Hola Mundo"]
  
  get "/" do
    session[:greeting] ||= settings.greetings.sample
    session[:views] ||= 0
    session[:views] += 1
    "<h1>#{session[:views]} views for \"#{session[:greeting]}\"</h1>"
  end

Creazione dell'archivio delle sessioni

Prima che la tua app possa memorizzare le preferenze di un utente, devi avere un modo per memorizzare le informazioni sull'utente corrente in una sessione. Il seguente diagramma illustra come Firestore gestisce le sessioni per l'app App Engine.

Sinatra ha il supporto integrato per il salvataggio dei dati di sessione in un cookie. Per salvare in Firestore, devi definire il tuo oggetto Rack::Session.

• Nella directory sessions, crea un file denominato firestore_session.rb con il seguente contenuto:

  require "google/cloud/firestore"
  require "rack/session/abstract/id"
  
  module Rack
    module Session
      class FirestoreSession < Abstract::Persisted
        def initialize app, options = {}
          super
  
          @firestore = Google::Cloud::Firestore.new
          @col = @firestore.col "sessions"
        end
  
        def find_session _req, session_id
          return [generate_sid, {}] if session_id.nil?
  
          doc = @col.doc session_id
          fields = doc.get.fields || {}
          [session_id, stringify_keys(fields)]
        end
  
        def write_session _req, session_id, new_session, _opts
          doc = @col.doc session_id
          doc.set new_session, merge: true
          session_id
        end
  
        def delete_session _req, session_id, _opts
          doc = @col.doc session_id
          doc.delete
          generate_sid
        end
  
        def stringify_keys hash
          new_hash = {}
          hash.each do |k, v|
            new_hash[k.to_s] =
              if v.is_a? Hash
                stringify_keys v
              else
                v
              end
          end
          new_hash
        end
      end
    end
  end

Nota: Sinatra supporta varie opzioni per l'archiviazione delle sessioni. Firestore è un database transazionale, distribuito e persistente. Spesso è più appropriato scegliere una soluzione di archiviazione diversa per le sessioni, come Memcache o Redis, le cui progettazioni potrebbero comportare un'operazione più rapida per questo caso d'uso.

Eliminazione delle sessioni

Così com'è, questa app non elimina le sessioni vecchie o scadute. Puoi eliminare i dati di sessione nella Google Cloud console, oppure implementare una strategia di eliminazione automatica.

Esecuzione in locale

1. Avvia il server HTTP:

   bundle exec ruby app.rb
   

2. Visualizza l'app nel browser web.

   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 di sessione nella Google Cloud console.

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

Deployment ed esecuzione su App Engine

Puoi utilizzare l' ambiente standard di App Engine per creare ed eseguire il deployment di un'app che viene eseguita in modo affidabile con carichi elevati e 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 incolla quanto segue nel file:

   runtime: ruby25
   entrypoint: bundle exec ruby app.rb

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

   gcloud app deploy
   

3. Visualizza l'app live all'URL seguente, dove PROJECT_ID è il tuo Google Cloud ID progetto:

   https://PROJECT_ID.appspot.com

Il saluto viene ora fornito da un server web in esecuzione su un'istanza di 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 Google Cloud console, vai alla pagina Esplora log.

   Vai alla pagina Esplora log

   1. Nell'elenco a discesa Risorse selezionate di recente, fai clic Applicazione App Engine, quindi su Tutti module_id. Viene visualizzato un elenco di richieste da quando hai visitato l'app. Se non vedi un elenco di richieste, verifica di aver selezionato Tutti module_id dall'elenco a discesa. Se nella Google Cloud console vengono visualizzati messaggi di errore, verifica che il codice dell'app corrisponda a l codice nella sezione relativa alla scrittura dell'app web.

   2. Assicurati che l'API Firestore sia abilitata.

Libera spazio

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 Google Cloud console, 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 e fai clic su Chiudi per eliminare il progetto.

Elimina l'istanza di App Engine

1. Nella Google Cloud console, vai alla pagina Versioni di 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 arrestare 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 di 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.