Primeiros passos: gravar, testar e implantar suas primeiras funções

Para começar a usar o Cloud Functions, siga as etapas deste tutorial, que começa com as tarefas de configuração necessárias e avança para a criação, teste e implantação de duas funções relacionadas:

  • addMessage(), que expõe um URL que aceita um valor de texto e o grava no Cloud Firestore.
  • makeUppercase(), que aciona a gravação no Cloud Firestore e transforma o texto em letras maiúsculas.

Um dos motivos por termos escolhido o Cloud Firestore e as funções JavaScript acionadas por HTTP para esta amostra é porque esses gatilhos em segundo plano podem ser testados completamente por meio do Pacote do emulador local do Firebase. Esse conjunto de ferramentas também é compatível com gatilhos chamáveis do Realtime Database, PubSub, Auth e HTTP. Outros tipos de gatilhos em segundo plano, como os do Configuração remota, TestLab e Analytics, podem ser testados de forma interativa usando conjuntos de ferramentas não descritos nesta página.

Veja nas seções a seguir os detalhes das etapas necessárias para criar, testar e implantar a amostra. Se você quiser apenas gerar o código e verificá-lo, acesse Análise completa do código de amostra.

Criar um projeto do Firebase

  1. No Console do Firebase, clique em Adicionar projeto e depois selecione ou insira o Nome do projeto.

    Se você tiver um projeto do Google Cloud Platform (GCP), poderá selecionar o projeto no menu suspenso para adicionar recursos do Firebase ao projeto em questão.

  2. (Opcional) Se você estiver criando um novo projeto, poderá editar o ID do projeto.

    O Firebase atribui automaticamente um ID exclusivo ao seu projeto. Consulte Noções básicas sobre projetos do Firebase para entender melhor como o Firebase usa o ID do projeto.

  3. Clique em Continuar.

  4. (Opcional) Configure o Google Analytics para o seu projeto, permitindo que você tenha uma ótima experiência ao usar qualquer um dos seguintes produtos do Firebase:

    Quando solicitado, selecione para usar uma Conta do Google Analytics ou criar uma nova conta.
    Se você decidir criar uma nova conta, selecione seu local de relatórios do Analytics e aceite as configurações de compartilhamento de dados e os termos do Google Analytics relacionados ao seu projeto.

  5. Clique em Criar projeto (ou Adicionar Firebase, se você estiver usando um projeto do GCP).

O Firebase provisiona recursos automaticamente para seu projeto. Quando o processo for concluído, você será direcionado para a página de visão geral do seu projeto no Console do Firebase.

Configurar o Node.js e a Firebase CLI

Você precisará de um ambiente do Node.js (em inglês) para criar funções, além da Firebase CLI para implantar funções no ambiente de execução do Cloud Functions. Para instalar o Node.js e o npm, recomendamos o Node Version Manager.

Depois de instalar o Node.js e o npm, instale a Firebase CLI usando o método de sua preferência. Para instalar a CLI pelo npm, use:

npm install -g firebase-tools

Essa ação instala o comando firebase disponível globalmente. Se o comando falhar, talvez seja necessário alterar as permissões do NPM (em inglês). Para atualizar para a versão mais recente, de firebase-tools execute novamente o mesmo comando.

Inicializar o SDK do Firebase para Cloud Functions

Ao inicializar o SDK do Firebase para Cloud Functions, você cria um projeto vazio que contém dependências e um código de amostra mínimo e escolhe o TypeScript ou JavaScript para compor funções.

Para inicializar seu projeto, faça o seguinte:

  1. Execute o firebase login para fazer login pelo navegador e autenticar a ferramenta do Firebase.
  2. Vá para o diretório do projeto do Firebase.
  3. Execute firebase init functions. A ferramenta oferece uma opção para instalar dependências com npm. Se você quiser gerenciar dependências de outra maneira, basta recusar. No entanto, se isso for feito, será necessário executar npm install antes de emular ou implantar as funções.
  4. A ferramenta oferece duas opções de linguagem compatíveis:

    Neste tutorial, selecione JavaScript.

Depois que esses comandos forem concluídos, a estrutura do seu projeto terá a seguinte aparência:

myproject
 +- .firebaserc    # Hidden file that helps you quickly switch between
 |                 # projects with `firebase use`
 |
 +- firebase.json  # Describes properties for your project
 |
 +- functions/     # Directory containing all your functions code
      |
      +- .eslintrc.json  # Optional file containing rules for JavaScript linting.
      |
      +- package.json  # npm package file describing your Cloud Functions code
      |
      +- index.js      # main source file for your Cloud Functions code
      |
      +- node_modules/ # directory where your dependencies (declared in
                       # package.json) are installed

O arquivo package.json criado durante a inicialização contém uma chave importante: "engines": {"node": "8"}. Isso especifica sua versão de nó para gravar e implementar funções. Você pode selecionar outras versões compatíveis.

Importar os módulos necessários e inicializar um aplicativo

Depois de concluir as tarefas de configuração, abra o diretório de origem e comece a adicionar o código conforme descrito nas seções a seguir. Para essa amostra, seu projeto precisa importar os módulos do Cloud Functions e do SDK Admin usando instruções require do Node. Adicione linhas como as seguintes ao seu arquivo index.js:

// The Cloud Functions for Firebase SDK to create Cloud Functions and setup triggers.
const functions = require('firebase-functions');

// The Firebase Admin SDK to access Cloud Firestore.
const admin = require('firebase-admin');
admin.initializeApp();

Essas linhas carregam os módulos firebase-functions e firebase-admin e inicializam uma instância de admin do app em que as alterações do Cloud Firestore podem ser feitas. Os locais compatíveis com o SDK Admin, assim como com o FCM, o Authentication e o Firebase Realtime Database, têm acesso a uma maneira avançada de integrar o Firebase por meio do Cloud Functions.

A Firebase CLI instala automaticamente o Firebase e o SDK do Firebase para os módulos do Node do Cloud Functions quando você inicializa o projeto. Para adicionar bibliotecas de terceiros ao seu projeto, modifique package.json e execute npm install. Para mais informações, consulte Gerenciar dependências.

Adicione a função addMessage()

Para a função addMessage(), adicione estas linhas a index.js:

// Take the text parameter passed to this HTTP endpoint and insert it into
// Cloud Firestore under the path /messages/:documentId/original
exports.addMessage = functions.https.onRequest(async (req, res) => {
  // Grab the text parameter.
  const original = req.query.text;
  // Push the new message into Cloud Firestore using the Firebase Admin SDK.
  const writeResult = await admin.firestore().collection('messages').add({original: original});
  // Send back a message that we've succesfully written the message
  res.json({result: `Message with ID: ${writeResult.id} added.`});
});

A função addMessage() é um endpoint de HTTP. Qualquer solicitação para o endpoint resulta na transmissão de objetos de solicitação e resposta (ambos em inglês) do estilo ExpressJS ao callback onRequest().

Como as funções HTTP são síncronas (semelhantes às funções chamáveis), é necessário enviar uma resposta o mais rápido possível e adiar o trabalho usando o Cloud Firestore. A função HTTP addMessage() transmite um valor de texto para o endpoint HTTP e o insere no banco de dados no caminho /messages/:documentId/original

Adicione a função makeUppercase()

Para a função makeUppercase(), adicione estas linhas a index.js:

// Listens for new messages added to /messages/:documentId/original and creates an
// uppercase version of the message to /messages/:documentId/uppercase
exports.makeUppercase = functions.firestore.document('/messages/{documentId}')
    .onCreate((snap, context) => {
      // Grab the current value of what was written to Cloud Firestore.
      const original = snap.data().original;

      // Access the parameter `{documentId}` with `context.params`
      console.log('Uppercasing', context.params.documentId, original);

      const uppercase = original.toUpperCase();

      // You must return a Promise when performing asynchronous tasks inside a Functions such as
      // writing to Cloud Firestore.
      // Setting an 'uppercase' field in Cloud Firestore document returns a Promise.
      return snap.ref.set({uppercase}, {merge: true});
    });

A função makeUppercase() é executada após a gravação no Cloud Firestore. A função ref.set define o documento a ser detectado. Para melhorar o desempenho, seja o mais específico possível.

As chaves, por exemplo, {documentId}, envolvem "parâmetros", caracteres curinga que expõem os dados correspondidos no retorno de chamada.

O Cloud Firestore aciona o retorno de chamada onWrite() sempre que os dados são gravados ou atualizados no documento especificado.

As funções baseadas em eventos, como os eventos do Cloud Firestore, são assíncronas. A função de chamada precisa retornar um valor null, um objeto ou uma promessa (em inglês). Se não retornar nada, a função expira, sinaliza um erro e é repetida. Consulte Sincronização, dessincronização e promessas.

Emular a execução de suas funções

O Pacote do emulador local do Firebase permite criar e testar apps na máquina local em vez de implantar em um projeto do Firebase. O teste local durante o desenvolvimento é altamente recomendado, já que ele reduz o risco de erros de codificação que podem gerar custos em um ambiente de produção, como um loop infinito.

Para emular suas funções, siga as etapas a seguir:

  1. Execute firebase emulators:start e verifique a saída do URL da IU do Pacote do emulador. O padrão é localhost:4.000, mas pode estar hospedado em uma porta diferente na sua máquina. Digite esse URL no navegador para abrir a IU do Pacote do emulador.

  2. Verifique a saída do comando firebase emulators:start para o URL da função http addMessage(). Ele será semelhante a http://localhost:5001/MY_PROJECT/us-central1/addMessage, porém:

    1. MY_PROJECT será substituído pelo ID do projeto;
    2. a porta pode ser diferente na máquina local.
  3. Adicione a string de consulta ?text=uppercaseme ao final do URL da função. Ele deve ser parecido com este: http://localhost:5001/MY_PROJECT/us-central1/addMessage?text=uppercaseme. Se quiser, você pode alterar a mensagem "uppercaseme" para uma mensagem personalizada.

  4. Crie uma nova mensagem abrindo o URL em uma nova guia do navegador.

  5. Veja os efeitos das funções na IU do Pacote do emulador.

    1. Na guia Registros, você verá novos registros indicando que as funções addMessage() e makeUppercase() foram executadas:

      i functions: Beginning execution of "addMessage"

      i functions: Beginning execution of "makeUppercase"

    2. Na guia Firestore, você verá um documento que contém a mensagem original e a versão em letra maiúscula da mensagem. Se originalmente era "uppercaseme", ela aparecerá como "UPPERCASEME".

Implantar funções em um ambiente de produção

Quando as funções estiverem funcionando da maneira correta no emulador, você poderá continuar a implantá-las, testá-las e executá-las no ambiente de produção.

Para completar o tutorial, implante suas funções e, em seguida, execute addMessage() para acionar makeUppercase().

  1. Execute este comando para implantar as funções:

    $ firebase deploy --only functions
    

    Depois de executar o comando, a Firebase CLI produz o URL para quaisquer pontos de extremidade da função HTTP. No seu terminal, aparecerá uma linha como esta:

    Function URL (addMessage): https://us-central1-MY_PROJECT.cloudfunctions.net/addMessage
    

    O URL contém o código do seu projeto, bem como uma região para a função HTTP. Embora não seja necessário se preocupar com isso agora, algumas funções HTTP de produção precisam especificar um local para minimizar a latência da rede.

    Se você encontrar erros de acesso, como "Não foi possível autorizar o acesso ao projeto", tente verificar o alias do seu projeto.

  2. Use o resultado do URL addMessage() da CLI para adicionar um parâmetro de consulta de texto e abra-o em um navegador:

    https://us-central1-MY_PROJECT.cloudfunctions.net/addMessage?text=uppercasemetoo
    

    A função executa e redireciona o navegador para o Console do Firebase no local do banco de dados em que a string de texto está armazenada. Este evento de gravação aciona makeUppercase(), que grava uma versão da string em letra maiúscula.

Após a implantação e execução das funções, é possível ver os registros no Console do Firebase para o Cloud Functions. Se você precisar excluir funções em desenvolvimento ou produção, use a Firebase CLI.

Análise completa do código de amostra

Veja a seguir o valor de functions/index.js completo contendo as funções addMessage() e makeUppercase(). Com essas funções, é possível enviar um parâmetro para um endpoint HTTP, que grava um valor no Cloud Firestore. Depois, elas mudam todos os caracteres da string para letras maiúsculas.

// The Cloud Functions for Firebase SDK to create Cloud Functions and setup triggers.
const functions = require('firebase-functions');

// The Firebase Admin SDK to access Cloud Firestore.
const admin = require('firebase-admin');
admin.initializeApp();

// Take the text parameter passed to this HTTP endpoint and insert it into
// Cloud Firestore under the path /messages/:documentId/original
exports.addMessage = functions.https.onRequest(async (req, res) => {
  // Grab the text parameter.
  const original = req.query.text;
  // Push the new message into Cloud Firestore using the Firebase Admin SDK.
  const writeResult = await admin.firestore().collection('messages').add({original: original});
  // Send back a message that we've succesfully written the message
  res.json({result: `Message with ID: ${writeResult.id} added.`});
});

// Listens for new messages added to /messages/:documentId/original and creates an
// uppercase version of the message to /messages/:documentId/uppercase
exports.makeUppercase = functions.firestore.document('/messages/{documentId}')
    .onCreate((snap, context) => {
      // Grab the current value of what was written to Cloud Firestore.
      const original = snap.data().original;

      // Access the parameter `{documentId}` with `context.params`
      console.log('Uppercasing', context.params.documentId, original);

      const uppercase = original.toUpperCase();

      // You must return a Promise when performing asynchronous tasks inside a Functions such as
      // writing to Cloud Firestore.
      // Setting an 'uppercase' field in Cloud Firestore document returns a Promise.
      return snap.ref.set({uppercase}, {merge: true});
    });

Próximas etapas

Veja mais informações nesta documentação sobre os conceitos gerais do Cloud Functions, bem como guias sobre como escrever funções para saber como processar os tipos de evento compatíveis com o Cloud Functions.

Para saber mais sobre o Cloud Functions, você também pode fazer o seguinte:

Tutorial em vídeo

Para saber mais sobre o Cloud Functions, assista a tutoriais em vídeo. Neste vídeo, você verá instruções detalhadas sobre como usar o Cloud Functions, incluindo a configuração do Node.js e da CLI.