Criar e implantar uma função do Cloud Run HTTP usando o Node.js (1ª geração)

Este guia ensina como escrever uma função do Cloud Run usando o ambiente de execução do Node.js. Há dois tipos de funções do Cloud Run:

• Uma função HTTP, que você invoca a partir de solicitações HTTP padrão.
• Uma função direcionada a eventos, que você usa para processar eventos da infraestrutura do Cloud, como mensagens em um tópico do Pub/Sub ou alterações em um bucket do Cloud Storage.

O exemplo mostra como criar uma função HTTP simples.

Saiba mais: para mais detalhes, leia sobre funções HTTP e funções orientadas a eventos.

Antes de começar

Faça login na sua conta do Google Cloud . Se você começou a usar o Google Cloud, crie uma conta para avaliar o desempenho de nossos produtos em situações reais. Clientes novos também recebem US$ 300 em créditos para executar, testar e implantar cargas de trabalho.

Instale a CLI do Google Cloud.

Observação:se você já instalou a CLI gcloud, execute o comando gcloud components update para verificar se tem a versão mais recente.

Ao usar um provedor de identidade (IdP) externo, primeiro faça login na CLI gcloud com sua identidade federada.

Para inicializar a CLI gcloud, execute o seguinte comando:

gcloud init

Crie ou selecione um Google Cloud projeto.

Funções necessárias para selecionar ou criar um projeto

• Selecionar um projeto: não é necessário um papel específico do IAM para selecionar um projeto. Você pode escolher qualquer projeto em que tenha recebido um papel.
• Criar um projeto: para criar um projeto, é necessário ter o papel de Criador de projetos (roles/resourcemanager.projectCreator), que contém a permissão resourcemanager.projects.create. Saiba como conceder papéis.

Observação: se você não pretende manter os recursos criados neste procedimento, crie um projeto novo em vez de selecionar um que já existe. Depois de concluir essas etapas, é possível excluir o projeto. Para fazer isso, basta remover todos os recursos associados a ele.

• Crie um projeto do Google Cloud :

  gcloud projects create PROJECT_ID

  Substitua PROJECT_ID por um nome para o projeto Google Cloud que você está criando.

• Selecione o projeto Google Cloud que você criou:

  gcloud config set project PROJECT_ID

  Substitua PROJECT_ID pelo nome do projeto do Google Cloud .

Verifique se o faturamento está ativado para o projeto do Google Cloud .

Ative as APIs Cloud Functions e Cloud Build:

Funções necessárias para ativar APIs

Para ativar as APIs, é necessário ter o papel do IAM de administrador de uso do serviço (roles/serviceusage.serviceUsageAdmin), que contém a permissão serviceusage.services.enable. Saiba como conceder papéis.

gcloud services enable cloudfunctions cloudbuild.googleapis.com

Instale a CLI do Google Cloud.

Observação:se você já instalou a CLI gcloud, execute o comando gcloud components update para verificar se tem a versão mais recente.

Ao usar um provedor de identidade (IdP) externo, primeiro faça login na CLI gcloud com sua identidade federada.

Para inicializar a CLI gcloud, execute o seguinte comando:

gcloud init

Crie ou selecione um Google Cloud projeto.

Funções necessárias para selecionar ou criar um projeto

• Selecionar um projeto: não é necessário um papel específico do IAM para selecionar um projeto. Você pode escolher qualquer projeto em que tenha recebido um papel.
• Criar um projeto: para criar um projeto, é necessário ter o papel de Criador de projetos (roles/resourcemanager.projectCreator), que contém a permissão resourcemanager.projects.create. Saiba como conceder papéis.

Observação: se você não pretende manter os recursos criados neste procedimento, crie um projeto novo em vez de selecionar um que já existe. Depois de concluir essas etapas, é possível excluir o projeto. Para fazer isso, basta remover todos os recursos associados a ele.

• Crie um projeto do Google Cloud :

  gcloud projects create PROJECT_ID

  Substitua PROJECT_ID por um nome para o projeto Google Cloud que você está criando.

• Selecione o projeto Google Cloud que você criou:

  gcloud config set project PROJECT_ID

  Substitua PROJECT_ID pelo nome do projeto do Google Cloud .

Verifique se o faturamento está ativado para o projeto do Google Cloud .

Ative as APIs Cloud Functions e Cloud Build:

Funções necessárias para ativar APIs

Para ativar as APIs, é necessário ter o papel do IAM de administrador de uso do serviço (roles/serviceusage.serviceUsageAdmin), que contém a permissão serviceusage.services.enable. Saiba como conceder papéis.

gcloud services enable cloudfunctions cloudbuild.googleapis.com

1. Prepare seu ambiente de desenvolvimento.

   Acessar o guia de configuração do Node.js

crie uma função

1. Crie um diretório no seu sistema local para o código de função:

   Linux ou macOS

   mkdir ~/helloworld
   cd ~/helloworld
   

   Windows

   mkdir %HOMEPATH%\helloworld
   cd %HOMEPATH%\helloworld
   

2. Crie um arquivo index.js no diretório helloworld com o seguinte conteúdo:

   const functions = require('@google-cloud/functions-framework');
   const escapeHtml = require('escape-html');
   
   /**
    * Responds to an HTTP request using data from the request body parsed according
    * to the "content-type" header.
    *
    * @param {Object} req Cloud Function request context.
    * @param {Object} res Cloud Function response context.
    */
   functions.http('helloHttp', (req, res) => {
     res.send(`Hello ${escapeHtml(req.query.name || req.body.name || 'World')}!`);
   });

   Esse exemplo de função recebe um nome fornecido na solicitação HTTP e retorna uma saudação, ou "Hello World!", quando nenhum nome é fornecido.

   Observação: o Cloud Run functions procura funções implantáveis no index.js por padrão. Use a flag --source ao implantar a função por meio de gcloud para especificar um diretório diferente que contenha um arquivo index.js.

Especificar as dependências

As dependências no Node.js são armazenadas em um arquivo chamado package.json. É possível criar esse arquivo manualmente ou com o comando npm.

• Para criar seu arquivo de dependência package.json usando npm, execute estes comandos:

  npm init
  npm install c8 gaxios mocha sinon supertest wait-port --save-dev
  npm install @google-cloud/functions-framework escape-html
  

• Se preferir criar seu arquivo package.json manualmente, crie um arquivo package.json no diretório helloworld com o seguinte conteúdo:

  {
    "name": "nodejs-docs-samples-functions-hello-world-http",
    "version": "0.0.1",
    "private": true,
    "license": "Apache-2.0",
    "author": "Google Inc.",
    "repository": {
      "type": "git",
      "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
    },
    "engines": {
      "node": ">=16.0.0"
    },
    "scripts": {
      "unit-test": "c8 mocha -p -j 2 test/index.test.js test/*unit*test.js test/*integration*test.js --timeout=6000 --exit",
      "system-test": "c8 mocha -p -j 2 test/*system*test.js --timeout=600000 --exit",
      "all-test": "npm run unit-test && npm run system-test",
      "test": "npm -- run unit-test"
    },
    "dependencies": {
      "@google-cloud/functions-framework": "^3.1.0",
      "escape-html": "^1.0.3"
    },
    "devDependencies": {
      "c8": "^10.0.0",
      "gaxios": "^6.0.0",
      "mocha": "^10.0.0",
      "sinon": "^18.0.0",
      "supertest": "^7.0.0",
      "wait-port": "^1.0.4"
    }
  }
  

  Observação: as bibliotecas de cliente do Node.js estão disponíveis para uma série de produtos do Google Cloud e podem ser instaladas como dependências. Confira a lista aqui.

Saiba mais: para mais detalhes, leia sobre como especificar dependências.

Implantar a função

Para implantar a função com um gatilho HTTP, execute o seguinte comando no diretório helloworld:

gcloud functions deploy helloHttp --no-gen2 --runtime nodejs22 --trigger-http --allow-unauthenticated

A flag --allow-unauthenticated permite que você atinja a função sem autenticação. Para exigir autenticação, omita a sinalização.

Saiba mais: para mais detalhes, leia sobre Como implantar Cloud Run functions.

Testar a função

1. Quando a implantação da função estiver concluída, anote a propriedade httpsTrigger.url ou encontre-a usando o seguinte comando:

   gcloud functions describe helloHttp
   

   A aparência será semelhante a esta:

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/helloHttp

2. Visite este URL no navegador. Você verá uma mensagem "Hello World!".

   Tente passar um nome na solicitação HTTP, por exemplo, usando este URL:

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/helloHttp?name=NAME

   Você verá uma mensagem "Hello NAME!"

Ver registros

Os registros do Cloud Run functions são visíveis usando a CLI do Google Cloud e na interface do Cloud Logging.

Usar a ferramenta de linha de comando

Para ver os registros da função com a CLI gcloud, use o comando logs read, seguido pelo nome da função:

gcloud functions logs read helloHttp

A saída será semelhante a esta:

LEVEL  NAME       EXECUTION_ID  TIME_UTC                 LOG
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:25.983  Function execution started
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:26.001  Function execution took 19 ms, finished with status code: 200

Observação: normalmente há um pequeno atraso entre o momento em que as entradas de registro são criadas e quando elas são exibidas no Cloud Logging.

Usar o painel do Logging

Também é possível ver os registros do Cloud Run functions no console doGoogle Cloud .

Saiba mais: para mais detalhes, leia sobre como gravar, ver e responder a registros.