Se usó la API de Cloud Translation para traducir esta página.
Switch to English

Manejar sesiones con Firestore

En muchas apps, se necesita controlar las sesiones para la autenticación y las preferencias del usuario. El framework de Flask viene con una implementación basada en la memoria para realizar esta función. Sin embargo, esta implementación no es adecuada para una aplicación que se puede entregar desde varias instancias, ya que la sesión que se registra en una instancia puede diferir de 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 instructivo, se usan los siguientes componentes facturables de Google Cloud:

Para generar una estimación de costos en función del uso previsto, usa la calculadora de precios. Es posible que los usuarios nuevos de Google Cloud sean aptos para obtener una prueba gratuita.

Cuando finalices este instructivo, podrás borrar los recursos creados para evitar que se te siga facturando. Para obtener más información, consulta cómo hacer una limpieza.

Antes de comenzar

  1. Accede a tu Cuenta de Google.

    Si todavía no tienes una cuenta, regístrate para obtener una nueva.

  2. En la página del selector de proyectos de Google Cloud Console, selecciona o crea un proyecto de Google Cloud.

    Ir a la página del selector de proyectos

  3. Asegúrate de que la facturación esté habilitada para tu proyecto de Cloud. Descubre cómo confirmar que tienes habilitada la facturación en un proyecto.

  4. Habilita la API Firestore.

    Habilita la API

  5. Instala e inicializa el SDK de Cloud.
  6. Instala Python, pip y virtualenv en tu sistema. Para obtener instrucciones, consulta Configurar un entorno de desarrollo de Python para Google Cloud.

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. Crea el requirements.txt con el siguiente contenido:

    google-cloud-firestore==2.0.1
    flask==1.1.2
    
  4. Instala las dependencias

    pip install  -r requirements.txt
    

Al término de este instructivo, la estructura final del archivo es similar a la siguiente:

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

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.

Varias ventanas de la app en las que se muestra un saludo en diferentes idiomas

Antes de que se puedan guardar las preferencias de un usuario en tu app, debes tener un medio para almacenar información sobre el usuario actual en una sesión. Esta app de muestra usa cookies y Firestore para almacenar los datos de las sesiones.

  • En la ventana de tu terminal, crea un archivo llamado main.py con el contenido siguiente:

    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)
  • En el siguiente diagrama, se muestra cómo Firestore controla las sesiones de la app de App Engine.

    Diagrama de arquitectura: usuario, App Engine, Firestore

Borra sesiones

Puedes borrar los datos de la sesión o implementar una estrategia de eliminación automática. Cuando usas soluciones de almacenamiento para sesiones, como Memcache o Redis, las sesiones vencidas se borran de forma automática.

Ejecución local

  1. En la ventana de la terminal, instala el servidor HTTP de Gunicorn:

    pip install gunicorn
    
  2. Ejecuta el servidor HTTP de Gunicorn:

    gunicorn -b :8080 main:app
    
  3. Visualiza la app en el navegador web:

    Cloud Shell

    En la barra de herramientas de Cloud Shell, haz clic en Vista previa en la Web Vista previa en la Web y selecciona Vista previa en el puerto 8080.

    Máquina local

    En tu navegador, ve a http://localhost:8080.

    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 Google Cloud Console.

    Sesiones de Firestore en Cloud Console

  4. 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 aplicación que se ejecute de manera 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 la ventana de la terminal, crea un archivo app.yaml y copia lo siguiente:

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

    gcloud app deploy
    
  3. Mira la aplicación en vivo en https://your-project-id.appspot.com:

    gcloud app browse
    

    En el ejemplo anterior, your-project-id es el ID del proyecto de Google Cloud.

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 Cloud Console, ve a la página Visor de registros.

    Ir a la página Visor 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 Cloud Console, comprueba que el código de tu aplicación coincida con el código de la sección sobre escritura de la aplicación web.

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

Limpieza

Borra el proyecto

  1. En Cloud Console, 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 Cloud Console, ve a la página Versiones de App Engine.

    Ir a la página Versiones

  2. Selecciona la casilla de verificación de la versión no predeterminada de la app que deseas borrar.
  3. Haz clic en Borrar para borrar la versión de la app.

¿Qué sigue?