Gerenciar funções

Você pode implantar, excluir e modificar funções usando os comandos da CLI do Firebase ou definindo opções de ambiente de execução no código-fonte das suas funções.

Implantar funções

Para implantar funções, execute o seguinte comando da CLI do Firebase:

$ firebase deploy --only functions

Por padrão, a CLI do Firebase implanta todas as funções dentro de index.js ao mesmo tempo. Se o projeto tiver mais de cinco funções, recomendamos que você use a sinalização --only com nomes de função específicos para implantar apenas as funções editadas. Implantar funções específicas dessa forma acelera o procedimento e ajuda a evitar alcançar o limite de cotas de implantação. Exemplo:

$ firebase deploy --only functions:addMessage,functions:makeUppercase

Ao implantar um grande número de funções, talvez você exceda a cota padrão e receba mensagens de erro HTTP 429 ou 500. Para resolver esse problema, implante funções em grupos de 10 ou menos.

Consulte a referência da CLI do Firebase para conferir uma lista completa de comandos disponíveis.

Por padrão, a CLI do Firebase procura o código-fonte na pasta functions/. Se preferir, organize funções em bases de código ou vários conjuntos de arquivos.

Excluir funções

Funções implantadas previamente podem ser excluídas:

  • explicitamente na CLI do Firebase com functions:delete
  • explicitamente usando o menu de contexto na lista de funções no Console do Firebase
  • implicitamente removendo a função de index.js antes da implantação.

Em todas as operações é necessário confirmar antes de remover a função da produção.

A exclusão explícita de funções da CLI do Firebase aceita vários argumentos, assim como grupos de funções, e permite especificar uma função executada em uma região específica. Além disso, você pode substituir o prompt de confirmação.

# Delete all functions that match the specified name in all regions.
$ firebase functions:delete myfunction

# Delete a specified function running in a specific region.
$ firebase functions:delete myfunction --region us-east-1

# Delete more than one function
$ firebase functions:delete myfunction myotherfunction

# Delete a specified functions group.
$ firebase functions:delete groupA

# Bypass the confirmation prompt.
$ firebase functions:delete myfunction --force

Com a exclusão implícita de funções, firebase deploy analisa index.js e remove da produção todas as funções que foram removidas do arquivo.

Modificar o nome, a região ou o acionador de uma função

Se você for renomear ou alterar a região ou o gatilho para funções que lidam com o tráfego de produção, siga as etapas desta seção a fim de evitar a perda de eventos durante a modificação. Antes de prosseguir, verifique se a função é idempotente, já que a versão antiga e a nova serão executadas simultaneamente durante a modificação.

Renomear uma função

Para renomear uma função, crie uma nova versão renomeada da função em index.js e execute dois comandos de implantação separados. O primeiro comando implanta a função recém-nomeada e o segundo remove a versão implementada anteriormente. Por exemplo, se você tiver uma função chamada webhook e quiser alterá-la para webhookNew, revise o código da seguinte maneira:

// before
const {onRequest} = require('firebase-functions/v2/https');

exports.webhook = onRequest((req, res) => {
    res.send("Hello");
});

// after
const {onRequest} = require('firebase-functions/v2/https');

exports.webhooknew = onRequest((req, res) => {
    res.send("Hello");
});

Em seguida, execute os seguintes comandos para implantar a nova função:

# Deploy new function called webhookNew
$ firebase deploy --only functions:webhooknew

# Wait until deployment is done; now both webhooknew and webhook are running

# Delete webhook
$ firebase functions:delete webhook

Alterar a região ou as regiões de uma função

Se você alterar as regiões especificadas de uma função que lida com tráfego de produção, é possível evitar a perda de eventos executando as etapas na ordem a seguir:

  1. Renomeie a função e altere a região ou as regiões dela, conforme quiser.
  2. Implante a função renomeada, o que resulta na execução temporária do mesmo código nos dois conjuntos de regiões.
  3. Exclua a função anterior.

Por exemplo, se você tiver uma função chamada webhook que esteja atualmente na região de funções padrão de us-central1 e quiser migrá-la para asia-northeast1, primeiro será necessário modificar o código-fonte para renomear a função e revisar a região.

// before
const {onRequest} = require('firebase-functions/v2/https');

exports.webhook = onRequest((req, res) => {
    res.send("Hello");
});

// after
const {onRequest} = require('firebase-functions/v2/https');

exports.webhookasia = onRequest({
        region: 'asia-northeast1'
    }, (req, res) => {
    res.send("Hello");
});

Em seguida, implante executando o comando:

$ firebase deploy --only functions:webhookAsia

Agora, há duas funções idênticas em execução: webhook está em execução em us-central1, enquanto webhookasia está em execução em asia-northeast1.

Em seguida, exclua webhook:

$ firebase functions:delete webhook

Agora, há apenas uma função: webhookasia, que está sendo executada em asia-northeast1.

Alterar o tipo de gatilho de uma função

À medida que você desenvolve sua implantação do Cloud Functions para Firebase ao longo do tempo, pode ser necessário alterar o tipo de gatilho de uma função por vários motivos. Por exemplo, é possível mudar de um tipo de evento do Firebase Realtime Database ou do Cloud Firestore para outro, como do evento genérico onWrite para o evento onCreate granular.

Não é possível alterar o tipo de evento de uma função apenas alterando o código-fonte e executando firebase deploy. Para evitar erros, altere o tipo de gatilho de uma função ao seguir este procedimento:

  1. Modifique o código-fonte para incluir uma nova função com o tipo de gatilho desejado.
  2. Implante a função, o que resulta na execução temporária da função antiga e da nova.
  3. Exclua explicitamente a função antiga da produção usando a CLI do Firebase.

Por exemplo, se você tiver uma função objectchanged com o tipo de evento legado onMetadataUpdated e quiser alterá-la para onObjectFinalized, renomeie a função e edite-a para ter o tipo de evento onObjectFinalized.

// before
const {onMetadataUpdated} = require('firebase-functions/v2/storage');

exports.objectchanged = onMetadataUpdated((event) => {
    return console.log('File name is: ', event.data.name);
});

// after
const {onObjectFinalized} = require('firebase-functions/v2/storage');

exports.objectchanged = onObjectFinalized((event) => {
    return console.log('File name is: ', event.data.name);
});

Em seguida, execute os seguintes comandos para criar a nova função primeiro, antes de excluir a função antiga:

# Create new function objectFinalized
$ firebase deploy --only functions:objectFinalized

# Wait until deployment is done; now both objectChanged and objectFinalized are running

# Delete objectChanged
$ firebase functions:delete objectChanged

Definir opções do ambiente de execução

Com o Cloud Functions para Firebase, você pode selecionar opções de ambiente de execução, como a versão do Node.js, o tempo limite por função, a alocação de memória e a quantidade mínima/máxima de instâncias de função.

É prática recomendada que essas opções, exceto pela versão do Node.js, sejam definidas em um objeto de configuração dentro do código da função. O objeto RuntimeOptions é a fonte de verdade para as opções de ambiente de execução da sua função e vai substituir as opções definidas por qualquer outro método, como o console do Google Cloud ou a CLI gcloud.

Se o seu fluxo de trabalho de desenvolvimento envolver a configuração manual de opções de ambiente de execução usando o Console do Google Cloud ou a CLI gcloud e você não quiser que esses valores sejam substituídos em cada implantação, defina a opção preserveExternalChanges como true. Com essa opção definida como true, o Firebase mescla as opções de ambiente de execução definidas no seu código com as configurações da versão atualmente implantada da função na prioridade a seguir:

  1. A opção está definida no código de funções: substituir as alterações externas.
  2. A opção está definida como RESET_VALUE no código das funções: substituir as alterações externas pelo valor padrão.
  3. A opção não está definida no código de funções, mas está configurada na função implantada atualmente: usar a opção especificada na função implantada.

O uso da opção preserveExternalChanges: true não é recomendado na maioria dos casos, porque o código deixa de ser a fonte de verdade completa das opções de ambiente de execução para suas funções. Se for usar essa opção, verifique o console do Google Cloud ou use a CLI gcloud para consultar a configuração completa de uma função.

Definir a versão do Node.js

O SDK do Firebase para Cloud Functions (2nd gen) permite uma seleção do ambiente de execução do Node.js. É possível executar exclusivamente todas as funções em um projeto no ambiente de execução correspondente a uma dessas versões do Node.js com suporte:

  • Node.js 16
  • Node.js 14

Para definir a versão do Node.js, faça o seguinte:

Defina a versão no campo engines no arquivo package.json que foi criado no diretório functions/ durante a inicialização. Por exemplo, para usar apenas a versão 16, edite esta linha em package.json:

  "engines": {"node": "16"}

O campo engines é obrigatório. Ele precisa especificar uma das versões compatíveis do Node.js para que você possa implantar e executar funções. Atualmente, firebase init functions define esse campo como 16.

Fazer upgrade do ambiente de execução do Node.js

Para fazer upgrade do ambiente de execução do Node.js, siga as etapas a seguir:

  1. Verifique se o projeto está no plano de preços Blaze.
  2. Verifique se você está usando a CLI do Firebase v9.17.0 ou mais recente.
  3. Altere o valor engines no arquivo package.json criado no diretório functions/ durante a inicialização. Por exemplo, se você estiver fazendo upgrade da versão 10 para a versão 16, a entrada terá esta aparência: "engines": {"node": "16"}
  4. Implante novamente as funções usando a CLI do Firebase v9.17.0 ou versões mais recentes.

Controlar o comportamento de escalonamento

Por padrão, o Cloud Functions para Firebase escalona o número de instâncias em execução com base no número de solicitações recebidas. Isso pode reduzir até zero a quantidade de instâncias em períodos de tráfego menor. No entanto, se o app exigir latência reduzida, e você quiser limitar o número de inicializações a frio, altere esse comportamento padrão especificando um número mínimo de instâncias de contêiner a serem mantidas em modo de espera e prontas para exibir solicitações.

Da mesma forma, é possível definir um número máximo para limitar o escalonamento de instâncias em resposta a solicitações recebidas. Use essa configuração como uma maneira de controlar seus custos ou de limitar o número de conexões com um serviço de apoio, como um banco de dados.

Usando essas configurações com a configuração de simultaneidade por instância (nova na 2ª geração), é possível controlar e ajustar o comportamento de escalonamento das funções. A natureza do aplicativo e da função determina quais configurações são mais econômicas e resulta no melhor desempenho.

Para alguns apps com pouco tráfego, uma opção de CPU mais baixa sem várias simultaneidades é ideal. Para outras em que as inicializações a frio são um problema crítico, a definição de alta simultaneidade e instâncias mínimas significa que um conjunto de instâncias é sempre mantido aquecido para lidar com grandes picos de tráfego.

Para apps de menor escala que recebem muito pouco tráfego, definir instâncias máximas baixas com alta simultaneidade significa que o app pode lidar com bursts de tráfego sem gerar custos excessivos.

Permitir solicitações simultâneas

No Cloud Functions para Firebase (1st gen), cada instância processa uma solicitação por vez. Portanto, o comportamento de escalonamento foi definido apenas com as configurações minInstances e maxInstances. Além de controlar o número de instâncias, no Cloud Functions para Firebase (2nd gen) é possível controlar o número de solicitações que cada instância pode exibir ao mesmo tempo, com a opção concurrency. O valor padrão de simultaneidade é 80, mas é possível defini-lo como qualquer número inteiro entre 1 e 1.000.

As funções com configurações de simultaneidade mais altas podem absorver picos de tráfego sem inicialização a frio, porque cada instância provavelmente tem alguma margem. Se uma instância estiver configurada para processar até 50 solicitações simultâneas, mas no momento gerencia apenas 25, ela poderá processar um pico de 25 solicitações extras sem exigir que uma nova instância inicie a frio. Por outro lado, com uma configuração de simultaneidade de apenas 1, esse pico nas solicitações pode levar a 25 inicializações a frio.

Ao testar configurações de simultaneidade mais altas no Cloud Functions para Firebase (2nd gen), é importante lembrar que:

  • Configurações de simultaneidade mais altas podem exigir mais CPU e RAM para um desempenho ideal até atingir um limite prático. Uma função com processamento de vídeo ou imagem intenso, por exemplo, pode não ter os recursos para lidar com 1.000 solicitações simultâneas, mesmo quando as configurações de CPU e RAM são maximizadas.
  • Como o Cloud Functions para Firebase (2nd gen) usa a tecnologia do Cloud Run, também é possível consultar as orientações do Google Cloud para otimizar a simultaneidade.
  • Teste várias vezes a simultaneidade em um ambiente de teste antes de mudar para a simultaneidade na produção.

Reduzir o número de inicializações a frio

Para definir o número mínimo de instâncias em uma função no código-fonte, use a opção minInstances. Por exemplo, esta função define um mínimo de cinco instâncias que devem ser mantidas quentes:

  const { onCall } = require("firebase-functions/v2/https");

  exports.getAutocompleteResponse = onCall(
    {
      // Keep 5 instances warm for this latency-critical function
      minInstances: 5,
    },
    (event) => {
      // Autocomplete user’s search term
    }
  );

Veja alguns pontos a serem considerados ao definir um valor para minInstances:

  • Se o Cloud Functions para Firebase escalonar seu app acima da configuração minInstances, uma inicialização a frio será feita para cada instância acima desse limite.
  • Inicializações a frio afetam de forma mais grave os apps que têm aumento de tráfego. Se o app apresentar picos de tráfego, e um valor de minInstances alto o suficiente for definido para que as inicializações a frio sejam reduzidas a cada aumento, você vai notar que a latência vai ser bem menor. Para apps com tráfego constante, inicializações a frio não afetam muito o desempenho.

  • Definir um limite de instâncias mínimas é uma boa ideia para ambientes de produção, mas isso geralmente deve ser evitado em ambientes de teste. Para reduzir a escala a zero no projeto de teste e seguir diminuindo as inicializações a frio no projeto de produção, defina minInstances com base na variável de ambiente FIREBASE_CONFIG:

    // Get Firebase project ID from `FIREBASE_CONFIG` environment variable
const envProjectId = JSON.parse(process.env.FIREBASE_CONFIG).projectId;

exports.renderProfilePage = onRequest(
  {
    // Keep 5 instances warm for this latency-critical function
    // in production only. Default to 0 for test projects.
    minInstances: envProjectId === "my-production-project" ? 5 : 0,
  },
  (req, res) => {
    // render some html
  }
);

Limitar o número máximo de instâncias para uma função

Para definir o máximo de instâncias no código-fonte da função, use a opção maxInstances. Por exemplo, esta função define um limite de 100 instâncias para não sobrecarregar um banco de dados legado hipotético:

  const { onMessagePublished } = require("firebase-functions/v2/pubsub");

  exports.mirrorevents = onMessagePublished(
    { topic: "topic-name", maxInstances: 100 },
    (event) => {
      // Connect to legacy database
    }
  );

Se uma função HTTP for escalonada até o limite maxInstances, as novas solicitações serão enfileiradas por 30 segundos e rejeitadas com um código de resposta 429 Too Many Requests se nenhuma instância estiver disponível depois desse tempo.

Para saber mais sobre as práticas recomendadas para o uso das configurações de instâncias máximas, confira estas práticas recomendadas para usar maxInstances.

Definir o tempo limite e a alocação de memória

Em alguns casos, suas funções podem ter requisitos especiais para um valor de tempo limite longo ou uma grande alocação de memória. Você pode definir esses valores no Console do Google Cloud ou no código-fonte da função (somente no Firebase).

Para definir a alocação de memória e o tempo limite no código-fonte das funções, use GlobalOptions.memory e GlobalOptions.timeoutSeconds para personalizar a máquina virtual que executa suas funções. Por exemplo, essa função do Cloud Storage usa 1 GiB de memória e expira após 300 segundos:

  exports.convertLargeFile = onObjectFinalized({
    timeoutSeconds: 300,
    memory: "1GiB",
  }, (event) => {
    // Do some complicated things that take a lot of memory and time
  });

O valor máximo para timeoutSeconds é 540 ou 9 minutos.

Para definir a alocação de memória e o tempo limite no Console do Google Cloud, siga as etapas a seguir:

  1. No Console do Google Cloud, selecione Cloud Functions para Firebase no menu à esquerda.
  2. Clique no nome de uma função para selecioná-la em uma lista de funções.
  3. Clique no ícone Editar no menu na parte superior.
  4. Selecione uma alocação de memória no menu suspenso Memória alocada.
  5. Clique em Mais para exibir as opções avançadas e insira um número de segundos na caixa de texto Tempo limite.
  6. Clique em Salvar para atualizar a função.

Substituir os padrões da CPU

Para até 2 GB de memória alocada, cada função no Cloud Functions para Firebase (2nd gen) tem como padrão uma CPU e, em seguida, aumenta para duas CPUs para 4 e 8 GB. Observe que isso é significativamente diferente do comportamento padrão da 1ª geração de maneiras que podem levar a custos um pouco mais altos para funções de pouca memória, conforme mostra a tabela a seguir:

RAM alocada CPU padrão da versão 1 (fracional) CPU padrão da versão 2 Aumento de preço por ms
128 MB 1/12 1 10.5x
256 MB 1/6 1 5.3x
512 MB 1/3 1 2.7x
1 GB 7/12 1 1.6x
2 GB 1 1 1x
4 GB 2 2 1x
8 GB 2 2 1x
16 GB n/a 4 n/a

Se você preferir preservar o comportamento da 1ª geração para suas funções da 2ª, defina os padrões da 1ª como uma opção global:

// Turn off Firebase defaults
setGlobalOptions({ cpu: 'gcfv1' });

Para funções com uso intensivo da CPU, a 2ª geração oferece a flexibilidade de configurar mais CPUs. É possível aumentar a CPU por função, como mostrado abaixo:

// Boost CPU in a function:
export const analyzeImage = onObjectFinalized({ cpu: 2 }, (event) => {
  // computer vision goes here
});