Manejar sesiones con Firestore

En muchas apps, se necesita controlar las sesiones para la autenticación y las preferencias del usuario. En Sinatra, se incluye una implementación basada en la memoria para realizar esta función. Sin embargo, esta implementación no es adecuada para las apps que se pueden entregar desde varias instancias, ya que la sesión que se registra en una instancia puede diferir de las que se registran en otras. En este instructivo, se muestra cómo controlar sesiones en App Engine.

Objetivos

• Escribe la aplicación.
• Ejecuta la aplicación de manera local.
• Implementa la aplicación en App Engine.

Costos

En este documento, usarás los siguientes componentes facturables de Google Cloud:

• App Engine
• Firestore

Para generar una estimación de costos en función del uso previsto, usa la calculadora de precios.

Es posible que los usuarios de Google Cloud nuevos cumplan con los requisitos para acceder a una prueba gratuita.

Cuando completes las tareas que se describen en este documento, podrás borrar los recursos que creaste para evitar que se te siga facturando. Para obtener más información, consulta Realiza una limpieza.

Antes de comenzar

Accede a tu cuenta de Google Cloud . Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.

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 el entorno de desarrollo.

Prepara el proyecto

1. En la ventana de tu terminal, comienza en un directorio de tu elección y crea un directorio nuevo llamado sessions. Todo el código para este instructivo está dentro del directorio sessions.

2. Cambia al directorio sessions con el siguiente comando:

   cd sessions
   

3. Inicializa el objeto Gemfile:

   bundle init
   

4. Agrega lo siguiente al Gemfile resultante:

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

   En el Gemfile, se enumeran las bibliotecas de Ruby no estándar que debe cargar App Engine para ejecutar la app:

   • google-cloud-firestore es el cliente de Ruby para la API de Firestore.

   • Sinatra es el framework web de Ruby que se usa para la app.

5. Instala las dependencias

   bundle install
   

Escribe la aplicación web

Esta app muestra saludos en diferentes idiomas para cada usuario. A los usuarios recurrentes se los saluda siempre en el mismo idioma.

• Con un editor de texto, crea un archivo llamado app.rb en el directorio sessions con el siguiente contenido:

  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

Crea el almacén de sesiones

Antes de que se puedan guardar las preferencias de un usuario en tu aplicación, necesitas una forma de almacenar información sobre el usuario actual en una sesión. En el siguiente diagrama, se muestra cómo Firestore controla las sesiones de la aplicación de App Engine.

Sinatra tiene compatibilidad integrada para guardar datos de sesión en una cookie. Para guardar en Firestore, debes definir tu propio objeto Rack::Session.

• En el directorio sessions, crea un archivo llamado firestore_session.rb con el siguiente contenido:

  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 admite varias opciones para el almacenamiento de sesión. Firestore es una base de datos transaccional, distribuida y persistente. A veces, es más conveniente elegir una solución de almacenamiento diferente para las sesiones, como Memcache o Redis, cuyos diseños pueden proporcionar un funcionamiento más rápido en este caso de uso.

Borra sesiones

Tal como está escrita, esta app no borra las sesiones antiguas o vencidas. Puedes borrar los datos de la sesión en la Google Cloud consola o implementar una estrategia de eliminación automática.

Ejecución local

1. Inicia el servidor HTTP:

   bundle exec ruby app.rb
   

2. Visualiza la app en el navegador web.

   Ves uno de los cinco saludos: "Hello World", "Hallo Welt", "Hola mundo", "Salut le Monde" o "Ciao Mondo". El idioma cambia si abres la página en un navegador diferente o en modo incógnito. Puedes ver y editar los datos de la sesión en la consola deGoogle Cloud .

3. Para detener el servidor HTTP, presiona Control+C en la ventana de la terminal.

Implementa y ejecuta en App Engine

Puedes usar el entorno estándar de App Engine para compilar y, también, implementar una app que se ejecute de forma confiable con cargas pesadas y grandes cantidades de datos.

En este instructivo, se usa el entorno estándar de App Engine para implementar el servidor.

1. En tu ventana de la terminal, crea un archivo app.yaml y pega lo siguiente en el archivo:

   runtime: ruby25
   entrypoint: bundle exec ruby app.rb

2. Implementa la app en App Engine con el siguiente comando:

   gcloud app deploy
   

3. Visualiza la app en vivo en la siguiente URL, en la que PROJECT_ID es tu Google Cloud ID del proyecto:

   https://PROJECT_ID.appspot.com

El saludo ahora se entrega en un servidor web que se ejecuta en una instancia de App Engine.

Depura la app

Si no puedes conectarte a la aplicación de App Engine, verifica lo siguiente:

1. Comprueba que los comandos de implementación de gcloud se completaron correctamente y no generaron ningún error. Si hubo errores (por ejemplo, message=Build failed), corrígelos y, luego, intenta implementar la aplicación de App Engine nuevamente.

2. En la consola de Google Cloud , accede a la página Explorador de registros.

   Ir a la página Explorador de registros

   1. En la lista desplegable Recursos seleccionados recientemente, haz clic en Aplicación de App Engine y, luego, haz clic en Todos module_id. Verás una lista de las solicitudes de cuando visitaste tu aplicación. Si no ves una lista de solicitudes, confirma que seleccionaste Todos module_id en la lista desplegable. Si ves mensajes de error impresos en la consola de Google Cloud , comprueba que el código de tu app coincida con el código de la sección sobre cómo escribir la app web.

   2. Asegúrate de que la API de Firestore esté habilitada.

Limpia

Borra el proyecto

Precaución: Borrar un proyecto tiene las siguientes consecuencias:

• Se borra todo su contenido. Si usaste un proyecto existente para las tareas de este documento, cuando lo borres, también se borrará cualquier otro trabajo que hayas realizado en el proyecto.
• Se pierden los IDs personalizados de los proyectos. Cuando creaste este proyecto, es posible que hayas creado un ID personalizado del proyecto que desees utilizar en el futuro. Para conservar las URLs que usan el ID del proyecto, como una URL appspot.com, borra los recursos seleccionados dentro del proyecto, en lugar de todo el proyecto.

Si planeas explorar varios instructivos, arquitecturas o guías de inicio rápido, reutilizar proyectos puede ser útil para no exceder los límites de cuota de los proyectos.

1. En la Google Cloud consola, ve a la página Administrar recursos.

   Ir a Administrar recursos

2. En la lista de proyectos, elige el proyecto que quieres borrar y haz clic en Borrar.
3. En el diálogo, escribe el ID del proyecto y, luego, haz clic en Cerrar para borrar el proyecto.

Borra la instancia de App Engine

1. En la consola de Google Cloud , ve a la página Versiones de App Engine.

   Ir a Versiones

2. Selecciona la casilla de verificación de la versión no predeterminada de la app que deseas borrar.
   Nota: La única forma de borrar la versión predeterminada de tu aplicación de App Engine es borrar tu proyecto. Sin embargo, puedes detener la versión predeterminada en la Google Cloud consola. Esta acción detiene todas las instancias asociadas a la versión. Puedes reiniciar estas instancias más tarde si es necesario.

   En el entorno estándar de App Engine, puedes detener la versión predeterminada si tu aplicación tiene ajuste de escala básico o manual.

3. Para borrar la versión de la app, haz clic en Borrar.

¿Qué sigue?

• Prueba más instructivos sobre Cloud Run Functions.
• Obtén más información sobre App Engine.
• Prueba Cloud Run, que te permite ejecutar contenedores sin estado en un entorno completamente administrado o en tu propio clúster de Google Kubernetes Engine.