Como gerenciar sessões com o Firestore

---

Veja neste tutorial como gerenciar sessões no App Engine.

Muitos aplicativos precisam gerenciar sessões de autenticação e preferências do usuário. O PHP tem uma implementação baseada em memória para executar essa função. No entanto, essa implementação não é adequada para um aplicativo que pode ser veiculado de várias instâncias, porque a sessão gravada em uma instância pode ser diferente nas outras.

Objetivos

• Gravar o aplicativo.
• Executar o aplicativo localmente.
• Implantar o aplicativo no App Engine.

Custos

Neste documento, você usará os seguintes componentes faturáveis do Google Cloud:

• App Engine
• Firestore

Para gerar uma estimativa de custo baseada na projeção de uso deste tutorial, use a calculadora de preços. Novos usuários do Google Cloud podem estar qualificados para uma avaliação gratuita.

Ao concluir as tarefas descritas neste documento, é possível evitar o faturamento contínuo excluindo os recursos criados. Saiba mais em Limpeza.

Antes de começar

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   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

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Firestore API.

   Enable the API

5. Install the Google Cloud CLI.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   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

8. Make sure that billing is enabled for your Google Cloud project.

9. Enable the Firestore API.

   Enable the API

10. Install the Google Cloud CLI.

11. To initialize the gcloud CLI, run the following command:

    gcloud init

12. Configure a CLI gcloud para usar seu novo projeto do Google Cloud:

    # Configure gcloud for your project
    gcloud config set project PROJECT_ID

    Substitua PROJECT_ID pelo ID do projeto do Google Cloud que você criou ou selecionou anteriormente.

Como configurar o projeto

1. Na janela de terminal, inicie em um diretório de sua escolha e crie um novo diretório chamado sessions. Todo o código deste tutorial está dentro do diretório sessions.

2. Mude para o diretório sessions:

   cd sessions
   

3. Instale as dependências:

   composer require google/cloud-firestore
   

No final deste tutorial, a estrutura final do arquivo é semelhante à seguinte:

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

Como gravar o aplicativo

• Na janela de terminal, crie um arquivo chamado index.php com o seguinte conteúdo:

  sessions/index.php

  Ver no GitHub

  <?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');
  }
  

Esse aplicativo exibe saudações em idiomas diferentes para cada usuário. Usuários recorrentes são sempre recebidos no mesmo idioma.

Para que o app possa armazenar as preferências de um usuário, você precisa de uma maneira de armazenar informações sobre o usuário atual em uma sessão. Este app de amostra usa o Firestore para armazenar esses dados.

Você pode usar o Firestore session handler para usar o Firestore em sessões do PHP.

Veja no diagrama a seguir como o Firestore gerencia as sessões do aplicativo do App Engine.

Depois que você definir session_set_save_handler, cada solicitação terá uma variável global $_SESSION que pode ser usada para acessar a sessão. Os dados da sessão são armazenados no Firestore.

Como executar no local

1. Inicie o servidor da Web PHP integrado:

   php -S localhost:8080
   

2. Veja seu app no navegador da Web:

   Cloud Shell

   Na barra de ferramentas do Cloud Shell, clique em Visualização da Web e selecione Visualizar na porta 8080.

   Máquina local

   No navegador, acesse http://localhost:8080.

   Você verá uma das cinco saudações: "Hello World"," "Hallo Welt", "Hola mundo", "Salut le Monde" ou "Ciao Mondo". O idioma será alterado se você abrir a página em um navegador diferente ou no modo de navegação anônima. Veja e edite os dados da sessão no Console do Google Cloud.

   

3. Para interromper o servidor HTTP, pressione Control+C na janela do terminal.

Como implantar e executar no App Engine

Use o ambiente padrão do App Engine para criar e implantar um aplicativo que seja executado de forma confiável sob carga pesada e com grandes quantidades de dados.

Neste tutorial, o ambiente padrão do App Engine é usado para implantar o servidor.

1. Na janela de terminal, crie um arquivo app.yaml e copie o seguinte:

   sessions/app.yaml

   Ver no GitHub

   runtime: php73
   

2. Implante o aplicativo no App Engine:

   gcloud app deploy
   

3. Para visualizar o aplicativo ativo, insira o seguinte URL:

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

   Substitua:

   • PROJECT_ID: é o ID do projeto do Google Cloud.
   • REGION_ID: um código que o App Engine atribui ao seu app.

A saudação agora é entregue por um servidor da Web executado em uma instância do App Engine.

Como excluir sessões

O PHP executa a sessão coleta de lixo (GC, na sigla em inglês) (link em inglês), que remove sessões antigas e expiradas de acordo com a configuração php.ini. O gerenciador de sessão do Firestore não limpa sessões por padrão, mas você pode configurá-lo para fazer isso ao transmitir uma opção gcLimit durante a criação do gerenciador de sessão:

sessions/index.php

Ver no GitHub

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

As sessões são removidas usando a GC com base em probabilidade ou quando você chama a função session_gc explicitamente.

Como depurar o aplicativo

Se você não conseguir se conectar ao aplicativo do App Engine, verifique o seguinte:

1. Verifique se os comandos de implantação gcloud foram concluídos com êxito e não geraram erros. Se houver erros (por exemplo, message=Build failed), corrija-os e tente implantar o aplicativo do App Engine novamente.

2. No console do Google Cloud, acesse a página do Explorador de registros.

   Acessar a página da Análise de registros

   1. Na lista suspensa Recursos selecionados recentemente, clique em Aplicativo App Engine e, em seguida, clique em Todos os module_id. Você verá uma lista de solicitações de quando visitou seu aplicativo. Caso contrário, verifique se você selecionou Todos os module_id na lista suspensa. Se você vir mensagens de erro impressas no console do Google Cloud, verifique se o código do aplicativo corresponde ao código na seção sobre como gravar o app da Web.

   2. Verifique se a API Firestore está ativada.

Limpar

Excluir o projeto

Cuidado: excluir um projeto tem os seguintes efeitos:

• Tudo no projeto é excluído. Se você tiver usado um projeto existente para as tarefas neste documento, a exclusão dele incluirá a exclusão de quaisquer outros trabalhos feitos no projeto.
• Os IDs do projeto personalizados são perdidos. Ao criar o projeto, você pode ter criado um código do projeto personalizado para ser usado no futuro. Para preservar os URLs que usam o ID do projeto, como um URL appspot.com, exclua recursos específicos do projeto, em vez de excluir o projeto inteiro.

Se você planeja passar por várias arquiteturas, tutoriais ou guias de início rápido, a reutilização de projetos pode evitar que você exceda os limites da cota do projeto.

1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

Excluir a instância do App Engine

1. In the Google Cloud console, go to the Versions page for App Engine.

   Go to Versions

2. Select the checkbox for the non-default app version that you want to delete.
   Observação: A única maneira de excluir a versão padrão do seu aplicativo do App Engine é excluir o projeto. No entanto, é possível interromper a versão padrão no Console do Google Cloud. Isso encerra todas as instâncias associadas à versão. Você pode reiniciar essas instâncias posteriormente, se necessário.

   No ambiente padrão do App Engine, apenas será possível interromper a versão padrão se o aplicativo tiver uma escala manual ou básica.

3. Para excluir a versão do app, clique em Excluir.

A seguir

• Saiba mais sobre o App Engine.
• Adicionar processamento de segundo plano com Pub/Sub e Cloud Run
• Implantar um app no Compute Engine
• Implantar um app no Google Kubernetes Engine
• Autenticar usuários com o IAP