Manejar sesiones con Firestore

En este instructivo, se muestra cómo manejar sesiones en App Engine.

En muchas aplicaciones, se necesita manejar sesiones para la autenticación y las preferencias del usuario. En PHP, se incluye 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.

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

Instala Google Cloud CLI.

Si usas un proveedor de identidad externo (IdP), primero debes acceder a la gcloud CLI con tu identidad federada.

Para inicializar gcloud CLI, ejecuta el siguiente 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

Instala Google Cloud CLI.

Si usas un proveedor de identidad externo (IdP), primero debes acceder a la gcloud CLI con tu identidad federada.

Para inicializar gcloud CLI, ejecuta el siguiente comando:

gcloud init

1. Configura gcloud CLI para usar tu proyecto Google Cloud nuevo:

   # Configure gcloud for your project
   gcloud config set project PROJECT_ID

   Reemplaza PROJECT_ID por el Google Cloud ID del proyecto que creaste o seleccionaste anteriormente.

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 comando siguiente:

   cd sessions
   

3. Instala las dependencias con el comando siguiente:

   composer require google/cloud-firestore
   

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

sessions
├── app.yaml
└── composer.json
├── index.php

Escribe la aplicación

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

  <?php
  /*
   * 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.
   */
  
  require_once __DIR__ . '/vendor/autoload.php';
  
  use Google\Cloud\Firestore\FirestoreClient;
  
  $projectId = getenv('GOOGLE_CLOUD_PROJECT');
  // Instantiate the Firestore Client for your project ID.
  $firestore = new FirestoreClient([
      'projectId' => $projectId,
  ]);
  
  $handler = $firestore->sessionHandler(['gcLimit' => 500]);
  
  // Configure PHP to use the the Firebase session handler.
  session_set_save_handler($handler, true);
  session_save_path('sessions');
  session_start();
  
  $colors = ['red', 'blue', 'green', 'yellow', 'pink'];
  /**
   * This is an example of a front controller for a flat file PHP site. Using a
   * Static list provides security against URL injection by default.
   */
  switch (@parse_url($_SERVER['REQUEST_URI'])['path']) {
      case '/':
          if (!isset($_SESSION['views'])) {
              $_SESSION['views'] = 0;
              $_SESSION['color'] = $colors[rand(0, 4)];
          }
          printf(
              '<body bgcolor="%s">Views: %s</body>',
              $_SESSION['color'],
              $_SESSION['views']++
          );
          break;
      default:
          http_response_code(404);
          exit('Not Found');
  }
  

Esta app muestra saludos en diferentes idiomas para cada usuario. A los usuarios que regresan siempre se los recibe en el mismo idioma.

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 esta app de muestra se usa Firestore para almacenar los datos de las sesiones.

Puedes usar Firestore session handler a fin de usar Firestore para almacenar sesiones de PHP.

En el siguiente diagrama se muestra cómo Firestore controla las sesiones de la aplicación de App Engine.

Después de configurar session_set_save_handler, cada solicitud tiene una variable global $_SESSION que puedes usar para acceder a la sesión. Los datos de la sesión se almacenan en Firestore.

Ejecución local

1. Inicia el servidor web de PHP integrado con el comando siguiente:

   php -S localhost:8080
   

2. Visualiza la aplicación en el navegador web de la manera siguiente:

   Cloud Shell

   En la barra de herramientas de Cloud Shell, haz clic en 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 otro navegador 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 la ventana de la terminal, crea un archivo app.yaml y copia lo siguiente:

   runtime: php73
   

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

   gcloud app deploy
   

3. Para ver la app publicada, ingresa la siguiente URL:

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

   Reemplaza lo siguiente:

   • PROJECT_ID: ID de tu proyecto de Google Cloud
   • REGION_ID: Un código que App Engine asigna a la app

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

Borra sesiones

En PHP, se realiza la recolección de elementos no utilizados (GC) de sesión, la cual quita sesiones antiguas y vencidas en función de tu configuración en php.ini. El controlador de sesiones de Firestore no limpia las sesiones de forma predeterminada, pero, si quieres configurarlo para que lo haga, puedes pasar una opción gcLimit cuando crees el controlador de sesiones:

$handler = $firestore->sessionHandler(['gcLimit' => 500]);

Las sesiones se quitan mediante la GC de sesión probabilística, o cuando se llama de manera explícita a la función session_gc.

Depura la aplicación

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?

• Obtén más información sobre App Engine.
• Agrega procesamiento en segundo plano con Pub/Sub y Cloud Run.
• Implementa una app en Compute Engine.
• Implementa una app en Google Kubernetes Engine.
• Autentica usuarios con IAP.