1. Visão geral
O Google Cloud Functions é uma plataforma de computação sem servidor orientada a eventos. Com o Cloud Functions, você escreve seu código sem se preocupar com o provisionamento de recursos ou o escalonamento para lidar com requisitos em constante mudança.
As funções do Cloud escritas em JavaScript são executadas em um ambiente Node.js no Google Cloud Platform. É possível executar a Função do Cloud em qualquer ambiente de execução padrão do Node.js para ativar a portabilidade e o teste local.
Tutorial
Neste codelab, você vai criar uma Função do Cloud para Node.js que informa se uma temperatura especificada é aceitável ou muito alta. Você vai criar, testar e depurar sua função do Cloud usando o Visual Studio Code na máquina local. Por fim, você vai implantar a função no Google Cloud Platform.
O que você vai aprender
- Functions Framework para Node.js.
- Crie e teste uma função HTTP do Cloud localmente.
- Depure uma função HTTP na máquina local.
- Implante uma função HTTP do computador local.
2. Configuração e requisitos
Pré-requisitos
- SDK do Cloud
- Visual Studio Code
- Node.js 8.6.0 ou mais recente. Para instalar o Node.js, use o nvm. Para verificar sua versão, execute node –version.
- Conclusão do guia "Minha primeira função: Node.js"
Custos
Embora este codelab exija apenas uma invocação de uma função do Cloud implantada, consulte as informações de preços da API Cloud Functions para entender como funciona o faturamento.
Muitas APIs do Google podem ser usadas sem taxas, mas o uso do Google Cloud Platform (ou seja, produtos e APIs) não é sem custo financeiro. Você precisa de uma conta de faturamento ativa para usar o Cloud Functions. Lembre-se de que determinados produtos do Google Cloud Platform (GCP) têm um nível"Sempre sem custo financeiro" que você precisa exceder para incorrer no faturamento. Para os fins do codelab, cada invocação do Cloud Functions é contabilizada nesse nível sem custo financeiro. Desde que você permaneça dentro dos limites agregados (em cada mês), não haverá cobranças.
3. Instale o Functions Framework para Node.js
O Functions Framework para Node.js é um framework FaaS (função como serviço) de código aberto para escrever funções portáteis do Node.js, criado pela equipe do Google Cloud Functions.
O Functions Framework permite gravar funções leves executadas em diferentes ambientes, inclusive:
- Google Cloud Functions
- Sua máquina de desenvolvimento local
- Cloud Run e Cloud Run no GKE
- Ambientes baseados no Knative
Crie um novo app node.js.
npm init
Ao aceitar os padrões, use index.js como o ponto de entrada do seu app.
Agora instale o Functions Framework para Node.js.
npm install @google-cloud/functions-framework
Abra o package.json. Verifique se o framework de funções está listado como uma dependência, conforme mostrado no exemplo abaixo.
"dependencies": {
"@google-cloud/functions-framework": "^1.7.1"
}
O Functions Framework foi instalado. Agora você está pronto para criar sua função do Cloud.
4. Criar e testar uma função do Cloud em HTTP localmente
Criar uma função do Cloud local
Nesta seção, você vai criar e testar uma função HTTP que responde a solicitações HTTP.
Crie um arquivo chamado index.js no mesmo diretório do arquivo package.json.
Adicione o seguinte:
exports.validateTemperature = async (req, res) => {
try {
if (req.body.temp < 100) {
res.status(200).send("Temperature OK");
} else {
res.status(200).send("Too hot");
}
} catch (error) {
//return an error
console.log("got error: ", error);
res.status(500).send(error);
}
};
Agora você já pode testar a função.
Testar a função no Visual Studio Code
A partir deste ponto, este codelab usa o terminal integrado no Visual Studio Code.
No Visual Studio Code, abra uma janela de terminal.
Execute este comando:
node node_modules/@google-cloud/functions-framework --target=validateTemperature
Esse comando inicia um servidor local pronto para chamar a função validateTemperature quando o servidor recebe uma solicitação HTTP.
Você vai ver a seguinte saída na janela do terminal:
Serving function... Function: validateTemperature URL: http://localhost:8080/
Crie uma segunda janela de terminal no VS Code clicando no ícone de adição New Terminal no painel da janela do terminal. Você vai alternar entre estas duas janelas de terminal: a primeira para veicular a função e a segunda para chamar a função usando curl.
Use o menu suspenso para alternar entre as janelas do terminal. Se uma janela de terminal estiver executando uma função, a lista suspensa vai se referir a ela como node. Caso contrário, ele será chamado de zsh (ou o shell que você está usando).
Na segunda janela do terminal, execute o comando a seguir para enviar uma carga útil de temperatura de 50 ao servidor local que atende à função validateTemperature.
curl -X POST http://localhost:8080 -H "Content-Type:application/json" -d '{"temp":"50"}'
Você vai receber a seguinte resposta da função na nuvem:
Temperature OK
Na segunda janela do terminal, teste a função novamente enviando uma carga útil de temperatura "muito alta", conforme mostrado abaixo:
curl -X POST http://localhost:8080 -H "Content-Type:application/json" -d '{"temp":"120"}'
Você vai receber a seguinte resposta da função na nuvem:
Too hot
Por fim, teste a função chamando-a com uma carga útil ausente.
curl -X POST http://localhost:8080
Você vai receber a seguinte resposta da função na nuvem:
Too hot
O ideal é que a função não retorne "muito quente" se nenhuma temperatura for fornecida. Você descobriu um bug no código.
Pressione Ctrl + C na primeira janela do terminal que atende à sua função para interromper a execução dela.
5. Depurar uma função HTTP na máquina local
Abra a paleta de comandos no Visual Studio Code. Se você estiver em um Mac, use Cmd + Shift + P. Se você estiver no Windows, use Ctrl + Shift + P.
Digite auto attach na paleta de comandos e escolha o primeiro item da lista.
Para este codelab, escolha Only With Flag, conforme mostrado na imagem abaixo:
Agora, recarregue a janela do terminal que você usou no VS Code para veicular sua função passando o cursor sobre o ícone de aviso que aparece no lado direito.
Clique em Relaunch Terminal.
Na janela do terminal recarregada, execute novamente o framework de funções para disponibilizar sua função usando o seguinte comando:
node --inspect node_modules/.bin/functions-framework --target=validateTemperature
em que a flag --inspect informa ao Node.js para aguardar um cliente de depuração. Para mais informações, consulte a documentação do Node sobre depuração.
Você está usando node_modules/.bin/functions-framework em vez de node_modules/@google-cloud/functions-framework. É necessário usar o executável com link simbólico automático em /node_modules/.bin para usar o modo de inspeção.
Desta vez, você vai ver uma barra de status laranja no VS Code indicando que o depurador está anexado.
Defina um ponto de interrupção na linha 3 clicando na margem à esquerda do número da linha.
O ícone de ponto de interrupção vai ficar vermelho brilhante, indicando que essa linha de código pode ser acessada pelo depurador.
Na segunda janela de terminal, acesse o ponto de interrupção executando o seguinte comando curl.
curl -X POST http://localhost:8080
Um destaque amarelo vai aparecer na linha 3. Esse destaque indica que esta linha é a instrução atual que está sendo avaliada pelo depurador.
Passe o cursor sobre a variável "temp" para verificar se o conteúdo dela é undefined, já que a solicitação não forneceu um payload de temperatura.
Clique no ícone "Passar por cima" para executar a próxima instrução.
Você vai ver a instrução atual pular para a parte "else" da instrução "if".
Para esta demonstração, suponha que a especificação exige que todas as solicitações enviem uma leitura de temperatura. No caso improvável de uma leitura de temperatura não ser fornecida, a função vai gerar uma exceção.
Clique no botão "Desconectar" para desconectar o depurador.
Na primeira janela do terminal, pressione Ctrl + C para interromper a execução da função.
Atualize a função para adicionar uma instrução "if" que gere uma exceção se a temperatura não estiver definida, conforme mostrado abaixo:
exports.validateTemperature = async (req, res) => {
try {
// add this if statement below line #2
if (!req.body.temp) {
throw "Temperature is undefined";
}
...
Na primeira janela do terminal, execute a função do Cloud novamente com o seguinte comando sem a flag "–inspect" para evitar anexar o depurador.
node node_modules/@google-cloud/functions-framework --target=validateTemperature
Para verificar se uma exceção é gerada, execute o seguinte comando na segunda janela do terminal:
curl -X POST http://localhost:8080
Você vai receber esta saída da sua solicitação:
Temperature is undefined
Na primeira janela do terminal, você também vai ver o erro registrado pela sua função.
Serving function... Function: validateTemperature URL: http://localhost:8080/ got error: Temperature is undefined
Agora você pode interromper a execução da função pressionando Ctrl + C na primeira janela do terminal.
6. Implantar uma função HTTP da máquina local no Google Cloud
Agora que você criou, testou e depurou uma função do Cloud na máquina local, está tudo pronto para implantá-la no Google Cloud.
Verifique se você está usando o projeto criado na etapa 2 localmente executando o seguinte comando:
gcloud config get-value project
Se o projeto especificado na etapa 2 não for a configuração ativa, execute o seguinte comando:
gcloud config set project <project-name-created-step-2>
Em qualquer janela de terminal, execute o seguinte comando:
gcloud functions deploy validateTemperature --trigger-http --runtime nodejs12 --allow-unauthenticated
em que os parâmetros são explicados da seguinte maneira:
deploy validateTemperature: o subcomando gcloud para implantar uma função do Cloud com o nomevalidateTemperaturee um ponto de entrada chamadovalidateTemperature.--trigger-http: o tipo de evento de acionamento--runtime nodejs12: o ambiente de execução de destino para essa função.--allow-unauthenticated: permite o acesso público para chamar a função.
Você vai receber uma solicitação para ativar as APIs Cloud Functions. Digite y para ativar as APIs.
API [cloudfunctions.googleapis.com] not enabled on project [1057316433766]. Would you like to enable and retry (this will take a few minutes)? (y/N)? y
Quando a implantação for concluída, você verá o seguinte na saída:
Deploying function (may take a while - up to 2 minutes)...done. availableMemoryMb: 256 buildId: <your-build-id> entryPoint: validateTemperature httpsTrigger: url: https://<your-region-and-project>.cloudfunctions.net/validateTemperature ...
Na janela do terminal, use curl para chamar esse endpoint público.
curl -X POST https://<your-region-and-project>.cloudfunctions.net/validateTemperature -H "Content-Type:application/json" -d '{"temp":"50"}'
e confirme se a função do Cloud foi implantada com sucesso verificando a resposta adequada.
Temperature OK
7. Limpar
Para evitar cobranças acidentais, por exemplo, se essa Função do Cloud for invocada mais vezes do que sua alocação mensal de invocações da Função do Cloud no nível sem custo financeiro, exclua a Função do Cloud ou o projeto criado na etapa 2.
Para excluir a função do Cloud, acesse o console do Cloud Functions em https://console.cloud.google.com/functions/. Verifique se o projeto criado na etapa 2 é o projeto selecionado no momento.
Selecione a função "validateTemperature" implantada na etapa 6. Em seguida, clique em "Excluir".
Se você quiser excluir todo o projeto, acesse https://console.cloud.google.com/cloud-resource-manager, selecione o projeto criado na etapa 2 e escolha "Excluir". Se você excluir o projeto, vai precisar mudar de projeto no SDK Cloud. Para conferir a lista de todos os projetos disponíveis, execute gcloud projects list.
8. Parabéns!
Parabéns por concluir o codelab. Saiba mais sobre como o Cloud Functions oferece suporte ao ambiente de execução do Node.js e como a depuração local funciona com o Cloud Functions.
O que vimos
- Functions Framework para Node.js.
- Crie e teste uma função HTTP do Cloud localmente.
- Depure uma função HTTP na máquina local.
- Implante uma função HTTP do computador local.