Comece agora: escrever, testar e implantar as primeiras funções

2ª geração 1ª geração

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, o teste e a implantação de duas funções relacionadas:

• Uma função "adicionar mensagem", que expõe um URL que aceita um valor de texto e o grava no Cloud Firestore.
• Uma função "mudar para letras maiúsculas", que é acionada em uma gravação no Cloud Firestore e transforma o texto em letras maiúsculas.

Um dos motivos por termos escolhido as funções JavaScript acionadas por HTTP e o Cloud Firestore para esta amostra é porque esses gatilhos em segundo plano podem ser testados completamente com o Firebase Local Emulator Suite. Esse conjunto de ferramentas também aceita gatilhos chamáveis HTTP, Realtime Database, PubSub e Auth. Outros tipos de gatilhos em segundo plano, como os de Remote Config, do TestLab e do Analytics, podem ser testados de modo interativo usando conjuntos de ferramentas não descritos nesta página.

Observação: é possível emular funções em qualquer projeto do Firebase. No entanto, para implantar no ambiente de execução recomendado do Node.js 14, o projeto precisa estar no plano de preços Blaze. Consulte os preços do Cloud Functions.

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 exemplo de código.

Criar um projeto do Firebase

1. No console do Firebase, clique em Adicionar projeto.

   • Para adicionar recursos do Firebase a um projeto do Google Cloud existente, digite o nome dele ou selecione-o no menu suspenso.

   • Para criar um novo projeto, digite o nome dele. Também é possível editar o ID do projeto exibido abaixo do nome dele.

     O Firebase gera um ID exclusivo para o projeto do Firebase com base no nome que você atribuir a ele. Se você quiser editar esse ID, faça isso agora, já que não é possível alterá-lo depois que o Firebase provisionar recursos para o projeto. Consulte Noções básicas sobre projetos do Firebase para saber mais sobre como o Firebase usa o ID do projeto.

2. Se solicitado, leia e aceite os Termos do Firebase.

3. Clique em Continuar.

4. (Opcional) Configure o Google Analytics para o projeto e tenha uma experiência ideal quando usar qualquer um destes produtos do Firebase:

   Firebase Crashlytics Firebase Cloud Messaging

   Firebase In-App Messaging Firebase Remote Config

   Personalização da Remote Config Firebase A/B Testing

   Selecione uma conta do Google Analytics ou crie uma nova.

   Se você criar uma nova conta, selecione seu local do relatório do Analytics e aceite as configurações de compartilhamento de dados e os termos do Google Analytics no projeto.

   É possível configurar o Google Analytics mais tarde na guia Integrações das configurações do projeto ().

5. Clique em Criar projeto ou Adicionar Firebase se você estiver usando um projeto do Google Cloud.

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

Configurar o Node.js e a CLI do Firebase

Você vai precisar de um ambiente do Node.js para criar funções e da CLI do Firebase para implantar essas funções no ambiente de execução do Cloud Functions. Para instalar o Node.js e npm, recomendamos o Node Version Manager.

Importante: há suporte para as versões 14 e 16 do Node.js. Consulte Definir opções de ambiente de execução para ver informações importantes sobre o suporte contínuo a essas versões do Node.js.

Depois de instalar o Node.js e o npm, use o método que preferir para instalar a CLI do Firebase. 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.

Em muitos casos, novos recursos e correções de bugs só são disponibilizados na versão mais recente da CLI do Firebase e do SDK firebase-functions. É recomendável atualizar com frequência a CLI do Firebase e o SDK com esses comandos dentro da pasta functions do projeto do Firebase:

npm install firebase-functions@latest firebase-admin@latest --save
npm install -g firebase-tools

Inicializar seu projeto

Ao inicializar o SDK do Firebase para Cloud Functions, você cria um projeto vazio com dependências e um exemplo de código mínimo e escolhe TypeScript ou JavaScript para criar funções. Para este tutorial, também será necessário inicializar o Cloud Firestore.

Para inicializar seu projeto, realize as seguintes ações:

1. Execute firebase login para fazer login pelo navegador e autenticar a CLI do Firebase.
2. Vá para o diretório do projeto do Firebase.
3. Execute firebase init firestore. Neste tutorial, aceite os valores padrão quando solicitados para regras do Firestore e arquivos de índice. Se você ainda não tiver usado o Cloud Firestore neste projeto, selecione um modo e local iniciais para o Firestore, conforme descrito em Introdução ao Cloud Firestore.
4. Execute firebase init functions. Conforme solicitação da CLI, selecione uma base de código que já exista ou inicie e atribua um nome a uma nova base. Para quem está começando, uma única base de código no local padrão é suficiente. Conforme você for implementando mais vezes, organize as funções em bases de código.

5. A CLI oferece duas opções de suporte de idioma:

   • JavaScript
   • TypeScript Consulte Criar funções com TypeScript para mais informações.

   Neste tutorial, selecione JavaScript.

6. A CLI oferece uma opção para instalar dependências com npm. Se quiser gerenciar dependências de outra forma, basta recusar. No entanto, se fizer isso, execute npm install antes de emular ou implantar as funções.

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": "16"}. Ela especifica sua versão do Node.js para escrever e implantar funções. É possível selecionar outras versões com suporte.

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, o 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 arquivo index.js:

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

// The Firebase Admin SDK to access Firestore.
const admin = require("firebase-admin");
admin.initializeApp();
index.js

Essas linhas carregam os módulos firebase-functions e firebase-admin e inicializam uma instância de app do admin em que as alterações do Cloud Firestore podem ser feitas. Sempre que o suporte ao SDK Admin está disponível, como em FCM, Authentication e Firebase Realtime Database, ele oferece uma maneira eficiente de integrar o Firebase usando Cloud Functions.

Quando você inicializa o projeto, a CLI do Firebase instala automaticamente os módulos de nó do Firebase e do SDK do Firebase para Cloud Functions. Para adicionar bibliotecas de terceiros ao 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
// 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 Firestore using the Firebase Admin SDK.
  const writeResult = await admin
    .firestore()
    .collection("messages")
    .add({ original: original });
  // Send back a message that we've successfully written the message
  res.json({ result: `Message with ID: ${writeResult.id} added.` });
});
index.js

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

Como as funções HTTP são síncronas (assim como as 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 ao 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 Firestore.
    const original = snap.data().original;

    // Access the parameter `{documentId}` with `context.params`
    functions.logger.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 Firestore.
    // Setting an 'uppercase' field in Firestore document returns a Promise.
    return snap.ref.set({ uppercase }, { merge: true });
  });
index.js

A função makeUppercase() é executada quando o Cloud Firestore é gravado. A função ref.set define o documento para detecção. Para melhorar o desempenho, seja o mais específico possível.

As chaves, como {documentId}, envolvem "parâmetros", caracteres curinga que expõem os dados correspondidos na callback.

O Cloud Firestore aciona o callback onCreate() sempre que novas mensagens são adicionadas.

Atenção: evite qualquer situação em que o resultado da função a acione novamente e crie um loop infinito. Por exemplo, uma função acionada por gravações em um documento específico do Cloud Firestore que é finalizada com a própria gravação nesse mesmo caminho. Crie funções de maneira idempotente para que elas produzam o mesmo resultado caso sejam executadas várias vezes para um único evento.

As funções orientadas a eventos, como eventos do Cloud Firestore, são assíncronas. A função de callback precisa retornar um null, um objeto ou uma promessa. 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

Com o Firebase Local Emulator Suite, é possível criar e testar apps na máquina local em vez de implantá-los 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 estas etapas:

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

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. A aparência será semalhente a esta: 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. Confira os efeitos das funções no Emulator Suite UI:

   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 implantar no ambiente de execução recomendado do Node.js 14, seu projeto precisa estar no plano de preços Blaze. Consulte os preços do Cloud Functions.

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 CLI do Firebase produz o URL para quaisquer endpoints 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. Ainda que você não precise 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. Esse 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, você pode conferir os registros no console do Google Cloud. Se você precisar excluir funções no desenvolvimento ou na produção, use a CLI do Firebase.

Na produção, convém otimizar o desempenho da função e controlar os custos definindo os números mínimo e máximo de instâncias a serem executadas. Consulte Controlar o comportamento de escalonamento para mais informações sobre essas opções de ambiente de execução.

Observação: a implantação de funções usando a CLI do Firebase está sujeita a limitações de taxa. Consulte Limites de cota para a implantação da CLI do Firebase.

Análise do exemplo de código completo

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

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

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

// Take the text parameter passed to this HTTP endpoint and insert it into
// 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 Firestore using the Firebase Admin SDK.
  const writeResult = await admin
    .firestore()
    .collection("messages")
    .add({ original: original });
  // Send back a message that we've successfully 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 Firestore.
    const original = snap.data().original;

    // Access the parameter `{documentId}` with `context.params`
    functions.logger.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 Firestore.
    // Setting an 'uppercase' field in Firestore document returns a Promise.
    return snap.ref.set({ uppercase }, { merge: true });
  });
index.js

Próximas etapas

Nesta documentação, é possível saber sobre como gerenciar funções do Cloud Functions e como lidar com todos os tipos de evento compatíveis com o Cloud Functions.

Para saber mais sobre o Cloud Functions, também é possível fazer o seguinte:

• Conferir os casos de uso do Cloud Functions.
• Conhecer o codelab do Cloud Functions.
• Analise e execute exemplos de código no GitHub (em inglês).