Sua primeira função: Node.js

Este guia ensina como escrever um Cloud Function usando o ambiente de execução do Node.js. Há dois tipos de Cloud Functions:

  • 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 Cloud Pub/Sub ou alterações em um bucket do Cloud Storage.

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

Estrutura do guia

  1. Como criar um projeto do GCP usando o SDK do Cloud
  2. Como criar uma função
  3. Como especificar dependências
  4. Como implantar a função
  5. Como testar a função

Como criar um projeto do GCP usando o Cloud SDK

  1. Faça login na sua conta do Google Cloud. Se você começou a usar o Google Cloud agora, 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.
  2. No Console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

    Acessar o seletor de projetos

  3. Verifique se o faturamento está ativado para seu projeto na nuvem. Saiba como confirmar se o faturamento está ativado para o projeto.

  4. Ative as APIs Cloud Functions and Cloud Build.

    Ative as APIs

  5. No Console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

    Acessar o seletor de projetos

  6. Verifique se o faturamento está ativado para seu projeto na nuvem. Saiba como confirmar se o faturamento está ativado para o projeto.

  7. Ative as APIs Cloud Functions and Cloud Build.

    Ative as APIs

  8. Instale e inicie o SDK do Cloud.
  9. Atualize e instale os componentes gcloud:
    gcloud components update
  10. Prepare seu ambiente de desenvolvimento.

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

Como criar 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 escapeHtml = require('escape-html');
    
    /**
     * HTTP Cloud Function.
     *
     * @param {Object} req Cloud Function request context.
     *                     More info: https://expressjs.com/en/api.html#req
     * @param {Object} res Cloud Function response context.
     *                     More info: https://expressjs.com/en/api.html#res
     */
    exports.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.

Como especificar dependências

Dependências no Node.js são gerenciadas com npm e expressas em um arquivo de metadados chamado package.json.

  1. Crie um arquivo package.json no diretório helloworld, manualmente ou executando o comando:

    npm init
    
  2. Adicione a dependência da função, neste caso, o pacote escape-html, ao seu arquivo package.json, manualmente ou executando o comando:

    npm install escape-html
    

    Seu arquivo package.json deve conter uma seção como esta:

    {
      ...
      "dependencies": {
        "escape-html": "^1.0.3"
      }
      ...
    }
    

    Se você estiver criando o arquivo package.json manualmente, copie o seguinte conteúdo nele:

    {
      "name": "nodejs-docs-samples-functions-hello-world",
      "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": ">=12.0.0"
      },
      "scripts": {
        "unit-test": "mocha test/index.test.js test/*unit*test.js test/*integration*test.js --timeout=6000 --exit",
        "system-test": "mocha test/*system*test.js --timeout=600000 --exit",
        "all-test": "npm run unit-test && npm run system-test",
        "test": "npm -- run all-test"
      },
      "dependencies": {
        "@google-cloud/debug-agent": "^5.0.0",
        "escape-html": "^1.0.3"
      },
      "devDependencies": {
        "@google-cloud/functions-framework": "^1.1.1",
        "@google-cloud/pubsub": "^2.0.0",
        "@google-cloud/storage": "^5.0.0",
        "gaxios": "^4.3.0",
        "mocha": "^9.0.0",
        "moment": "^2.24.0",
        "promise-retry": "^2.0.0",
        "sinon": "^11.0.0",
        "supertest": "^6.0.0",
        "uuid": "^8.0.0",
        "wait-port": "^0.2.9"
      }
    }
    

Como 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 --runtime nodejs14 --trigger-http --allow-unauthenticated

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

Como 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!"

Como visualizar registros

Como usar a ferramenta de linha de comando

Os registros do Cloud Functions são visíveis na IU do Cloud Logging e na ferramenta de linha de comando gcloud.

Para ver os registros da função com a ferramenta 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

Como usar o painel do Logging

Você também pode ver os registros do Cloud Functions no Console do Cloud.