Dicas e truques

Neste documento, descrevemos as práticas recomendadas para projetar, implementar, testar e implantar o Cloud Functions.

Correção

Nesta seção, você verá as práticas recomendadas gerais para projetar e implementar funções do Google Functions.

Escreva funções idempotentes

As funções devem produzir o mesmo resultado, mesmo que sejam chamadas várias vezes. Isso permite que você tente executar uma invocação novamente caso a anterior falhe no seu código. Para saber mais informações, consulte Repetir funções em segundo plano.

Não inicie atividades em segundo plano

Atividade em segundo plano é o que acontecerá depois que a função terminar. Uma chamada de função termina quando a função retorna ou sinaliza a conclusão, como a chamada do argumento callback nas funções de segundo plano do Node.js. Qualquer código executado após a finalização normal não pode acessar a CPU e não irá progredir.

Além disso, quando uma invocação subsequente é executada no mesmo ambiente, a atividade em segundo plano é retomada, interferindo na nova invocação. Isso pode levar a um comportamento inesperado e erros difíceis de diagnosticar. O acesso à rede depois que uma função é concluída normalmente causa a redefinição das conexões (código do erro ECONNRESET).

Ela normalmente pode ser detectada em registros de invocações individuais, encontrando tudo o que será registrado depois da linha que informa sobre o término da invocação. Às vezes, a atividade em segundo plano pode ser aprofundada no código, especialmente quando operações assíncronas, como callbacks ou timers, estão presentes. Revise o código para verificar se todas as operações assíncronas foram concluídas antes de você finalizar a função.

Sempre exclua arquivos temporários

O armazenamento de disco local no diretório temporário é um sistema de arquivos na memória. Os arquivos que você grava consomem memória disponível para sua função e, às vezes, permanecem entre as chamadas. Deixar de excluir explicitamente esses arquivos pode resultar em um erro de memória insuficiente e uma inicialização a frio subsequente.

Veja a memória usada por uma função individual selecionando-a na lista de funções do Console do GCP e escolhendo o gráfico Uso de memória.

Não tente gravar fora do diretório temporário e não se esqueça de usar métodos independentes de plataforma/SO para criar caminhos de arquivo.

Você pode ignorar as restrições de tamanho em arquivos temporários usando o pipelining. Por exemplo, processe um arquivo no Cloud Storage criando um stream de leitura, passando-o por um processo baseado em stream e gravando o stream de saída diretamente no Cloud Storage.

Ferramentas

Nesta seção, você verá diretrizes sobre como usar ferramentas para implementar, testar e interagir com funções do Google Functions.

Desenvolvimento local

A implantação de funções demora um pouco, então muitas vezes é mais rápido testar o código da função localmente usando um shim.

Recomendamos usar o emulador Node.js do Cloud Functions como um shim.

Use SendGrid para enviar e-mails

O Cloud Functions não permite conexões de saída na porta 25, então não é possível estabelecer conexões não seguras com um servidor SMTP. A maneira recomendada de enviar e-mails é usando o SendGrid (em inglês). Veja um exemplo completo no Tutorial do SendGrid e outras opções para envio de e-mails na documentação Enviar e-mails a partir de uma instância do Google Compute Engine.

Desempenho

Nesta seção, você verá as práticas recomendadas para otimizar o desempenho.

Usar dependências com sabedoria

Como as funções não têm estado, o ambiente de execução normalmente é inicializado do zero, o que é chamado de inicialização a frio. Quando ocorre uma inicialização a frio, o contexto global da função é avaliado.

Se suas funções importam módulos, o tempo de carregamento deles pode ser adicionado à latência de chamada durante uma inicialização a frio. É possível reduzir essa latência, bem como o tempo necessário para implantar sua função, carregando as dependências necessárias e não carregando as dependências que sua função não utiliza.

Usar variáveis globais para reutilizar objetos em futuras invocações

Não há garantia de que o estado de uma função do Google Functions seja preservado para futuras invocações. No entanto, essas funções frequentemente reciclam o ambiente de execução de uma invocação anterior. Se você declarar uma variável no escopo global, o valor dela pode ser reutilizado em invocações subsequentes sem necessidade de recálculo.

Dessa forma, é possível armazenar em cache os objetos cuja recriação em cada invocação de função pode ser cara. Mover esses objetos do corpo da função para o escopo global pode resultar em melhorias significativas de desempenho. No exemplo a seguir, um objeto pesado é criado apenas uma vez por instância de função e é compartilhado em todas as invocações que alcançam a instância determinada:

console.log('Global scope');
const perInstance = heavyComputation();
const functions = require('firebase-functions');

exports.function = functions.https.onRequest((req, res) => {
    console.log('Function invocation');
    const perFunction = lightweightComputation();

    res.send(`Per instance: ${perInstance}, per function: ${perFunction}`);
});

É muito importante fazer o armazenamento em cache de conexões de rede, referências de biblioteca e objetos de cliente de API em escopo global. Consulte Como otimizar as redes para ver alguns exemplos.

Faça a inicialização lenta de variáveis globais

Se você inicializar variáveis em escopo global, o código de inicialização sempre será executado por meio de uma chamada de inicialização a frio, aumentando a latência da sua função. Se alguns objetos não forem usados em todos os caminhos de código, realize uma inicialização lenta sob demanda para eles:

const functions = require('firebase-functions');
let myCostlyVariable;

exports.function = functions.https.onRequest((req, res) => {
    doUsualWork();
    if(unlikelyCondition()){
        myCostlyVariable = myCostlyVariable || buildCostlyVariable();
    }
    res.status(200).send('OK');
});

Isso é importante principalmente se você definir várias funções em um único arquivo e diferentes funções usarem variáveis diferentes. A menos que você use a inicialização lenta, poderá desperdiçar recursos em variáveis que são inicializadas, mas nunca usadas.

Outros recursos

Saiba mais sobre como otimizar o desempenho no vídeo do "Atlas de desempenho do Google Cloud", Tempo de inicialização a frio do Cloud Functions.

Enviar comentários sobre…

Precisa de ajuda? Acesse nossa página de suporte.