Criar um app Node.js no ambiente flexível do App Engine

Criar um app Node.js no ambiente flexível do App Engine

ID da região

O REGION_ID é um código abreviado que o Google atribui com base na região que você selecionou ao criar o aplicativo. O código não corresponde a um país ou estado, ainda que alguns IDs de região sejam semelhantes aos códigos de país e estado geralmente usados. Para apps criados após fevereiro de 2020, o REGION_ID.r está incluído nos URLs do App Engine. Para apps existentes criados antes dessa data, o ID da região é opcional no URL.

Saiba mais sobre IDs de região.

OK

Neste guia de início rápido, você verá como criar e implantar um app que exibe uma mensagem curta. O aplicativo de amostra usa a versão mais recente do Node.js. É possível usar o mesmo código de exemplo do Node.js 18 e de versões posteriores, especificando a versão no arquivo app.yaml.

O exemplo de código para a versão Node.js 16 e anteriores está disponível no GitHub.

Antes de começar

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.

   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.

   Acessar o seletor de projetos

3. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

4. Ative a Cloud Build API.

   Ative a API

5. Instale a CLI do Google Cloud.

6. Para inicializar a CLI gcloud, execute o seguinte comando:

   gcloud init

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

   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.

   Acessar o seletor de projetos

8. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

9. Ative a Cloud Build API.

   Ative a API

10. Instale a CLI do Google Cloud.

11. Para inicializar a CLI gcloud, execute o seguinte comando:

    gcloud init

Pré-requisitos adicionais

1. Inicialize seu aplicativo do App Engine com o projeto e escolha a região:

   gcloud app create --project=[YOUR_PROJECT_ID]
   

   Quando solicitado, selecione a região em que você quer localizar o aplicativo do App Engine.

   Cuidado: não é possível alterar a região de um aplicativo depois de defini-la.

2. Instale os pré-requisitos a seguir:

   • Faça o download e instale o Git.
   • Prepare o ambiente para desenvolvimento em Node.js.

Locais do App Engine

O App Engine é regional. Isso significa que a infraestrutura que executa os aplicativos está em uma determinada região que é gerenciada pelo Google para estar disponível de modo redundante em todas as zonas dessa região.

Atender aos requisitos de latência, disponibilidade ou durabilidade são os principais fatores para selecionar a região de execução dos aplicativos. Geralmente, é possível selecionar a região mais próxima dos usuários do aplicativo, mas considere os locais em que o App Engine está disponível, bem como os locais dos outros produtos e serviços do Google Cloud usados pelo app. O uso de serviços em vários locais pode afetar a latência e o preço do aplicativo.

Não é possível alterar a região de um aplicativo depois de defini-la.

Observação: dois locais, chamados europe-west e us-central nos comandos do App Engine e no console do Google Cloud, são chamados europe-west1 e us-central1, respectivamente, em todos os outros lugares da documentação do Google.

Se você já criou um aplicativo do App Engine, será possível consultar a região dele com um dos seguintes procedimentos:

• Execute o comando gcloud app describe.‏

• Abra o Painel do App Engine no console do Google Cloud. A região aparece perto do topo da página.

OK

Neste início rápido, é demonstrado um aplicativo simples do Node.js escrito com a biblioteca Express.js.

Importante: para ter a melhor experiência no Windows, faça upgrade para a versão mais recente do gerenciador de pacotes Node.js (npm) executando npm install -g npm. O npm mais recente instala dependências em uma estrutura de diretório simples. Por isso, é improvável que as instalações entrem em conflito com o tamanho máximo do caminho do Windows, que é de 255 caracteres. Caso queira continuar usando uma versão mais antiga do npm, reduza o tamanho dos caminhos. Para isso, mova o projeto para a raiz do drive, por exemplo, C:\.

Download do app Hello World

Criamos um app Hello World simples para App Engine. Assim, é possível ter uma ideia de como implantar um app no Google Cloud.

1. Clone o repositório do app de amostra Hello World na máquina local.

   git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples
   

   Outra opção é fazer o download da amostra (em inglês) como um arquivo ZIP e extraí-lo.

2. Acesse o diretório que contém o código de amostra.

      cd nodejs-docs-samples/appengine/hello-world/flexible/
   

Como executar o Hello World na máquina local

1. Instale as dependências para o projeto.

   npm install
   

   ou, se você usa o Yarn:

   yarn install
   

2. Execute o script de inicialização:

   npm start
   

   ou, se você usa o Yarn:

   yarn start
   

3. Veja seu aplicativo no navegador da Web:

   • Se você estiver usando o Cloud Shell, clique em Visualização da Web na barra de ferramentas e selecione Visualizar na porta 8080.

   • Se você não estiver usando o Cloud Shell, digite o endereço a seguir:

   http://localhost:8080

A mensagem Hello World do aplicativo de amostra é exibida na página. Na janela do terminal, pressione Ctrl+C para sair do servidor da Web.

Implantar e executar o Hello World no App Engine

Para implantar o app Hello World no ambiente flexível do App Engine:

1. Implemente o aplicativo Hello World executando o comando a seguir no diretório hello-world/flexible/:

   gcloud app deploy

   Saiba mais sobre sinalizações opcionais.

   Sinalizações comuns do comando gcloud

   • Inclua a sinalização --version para especificar um ID exclusivo da versão do seu aplicativo. Quando a sinalização não é incluída, o ID é gerado automaticamente. Exemplo: --version [YOUR_VERSION_ID]
   • Inclua a sinalização --project para especificar um ID de projeto alternativo do Google Cloud para o que você inicializou como padrão na ferramenta gcloud. Exemplo: --project [YOUR_PROJECT_ID]

   Exemplo:

   gcloud app deploy --version pre-prod-5 --project my-sample-app

   Para aprender a implantar o app pela linha de comando, consulte Como testar e implantar o app. Para uma lista de todas as sinalizações de comando, consulte a referência do gcloud app deploy.

   OK
   Observação: durante a implantação, npm install é usado por padrão para instalar dependências, a menos que exista um arquivo yarn.lock não listado na seção app.yaml do arquivo skip_files. Nesse caso, yarn install --production será usado. Para fazer com que o build retorne para npm install, exclua o arquivo yarn.lock ou adicione yarn.lock à seção skip_files do arquivo app.yaml.

2. Inicie o navegador para visualizar o aplicativo em https://PROJECT_ID.REGION_ID.r.appspot.com

   gcloud app browse

   em que PROJECT_ID representa o ID do projeto do Google Cloud.

Nesse momento, a página que exibe a mensagem "Hello World" é enviada por um servidor da Web executado em uma instância do App Engine.

Parabéns! Você implantou seu primeiro aplicativo do App Engine no ambiente flexível do App Engine.

Se você encontrar erros na implantação do app, verifique as dicas de solução de problemas.

Confira as seções a seguir para informações sobre limpeza e links das próximas etapas.

Limpar

Para evitar cobranças, você pode excluir seu projeto do Google Cloud para interromper o faturamento de todos os recursos usados naquele projeto.

Cuidado: excluir um projeto tem os seguintes efeitos:
• Tudo no projeto é excluído. Se você tiver usado um projeto existente para as tarefas neste documento, a exclusão dele incluirá a exclusão de quaisquer outros trabalhos feitos no projeto.
• Os IDs do projeto personalizados são perdidos. Ao criar o projeto, você pode ter criado um código do projeto personalizado para ser usado no futuro. Para preservar os URLs que usam o ID do projeto, como um URL appspot.com, exclua recursos específicos do projeto, em vez de excluir o projeto inteiro.
1. No Console do Google Cloud, acesse a página Gerenciar recursos.

   Acessar "Gerenciar recursos"

2. Na lista de projetos, selecione o projeto que você quer excluir e clique em Excluir .
3. Na caixa de diálogo, digite o ID do projeto e clique em Encerrar para excluí-lo.

A seguir

Conheça a plataforma inteira

Agora que você sabe como é desenvolver e implantar aplicativos do App Engine, explore o restante do Google Cloud. Você já tem a Google Cloud CLI instalada, o que oferece as ferramentas para interagir com produtos como Cloud SQL, Cloud Storage, Firestore e muitos outros.

Saiba mais sobre o ambiente flexível do App Engine

Listamos alguns tópicos para você continuar aprendendo sobre o App Engine:

• Uma visão geral do App Engine
• Roteamento de solicitações
• Processamento de solicitações
• Como gerenciar instâncias

Revisão do código do Hello World

O Hello World é o app mais simples possível do App Engine. Nele, há apenas um serviço e uma versão, e todo o código é armazenado no diretório raiz. Nesta seção, cada arquivo do app é descrito em detalhes.

app.js

O arquivo app.js contém o código JavaScript para iniciar um servidor e responder a solicitações.

No código a seguir, as solicitações de clientes Web são respondidas com a mensagem "Hello World", por meio de um servidor executado na porta 8080.

const express = require('express');

const app = express();

app.get('/', (req, res) => {
  res.status(200).send('Hello, world!').end();
});

// Start the server
const PORT = parseInt(process.env.PORT) || 8080;
app.listen(PORT, () => {
  console.log(`App listening on port ${PORT}`);
  console.log('Press Ctrl+C to quit.');
});

app.yaml

O arquivo app.yaml descreve a seguinte configuração para seu app:

• Define env: flex, indicando que o aplicativo usa o ambiente flexível do App Engine.

• Especifica o ambiente de execução usado pelo app.

  runtime: nodejs
  env: flex
  runtime_config:
    operating_system: ubuntu22
  # This sample incurs costs to run on the App Engine flexible environment.
  # The settings below are to reduce costs during testing and are not appropriate
  # for production use. For more information, see:
  # https://cloud.google.com/appengine/docs/flexible/nodejs/configuring-your-app-with-app-yaml
  manual_scaling:
    instances: 1
  resources:
    cpu: 1
    memory_gb: 0.5
    disk_size_gb: 10
  

  • Para mais informações sobre como funciona o ambiente de execução do Node.js, consulte O ambiente de execução do Node.js.

  • Para aprender como projetar seu app para aproveitar mais as versões e os serviços, consulte Visão geral do App Engine.

  • Para mais detalhes sobre as configurações do App Engine, consulte Como configurar um app com o arquivo app.yaml.

  package.json

  package.json (em inglês) é usado para especificar dependências do app, versão do nó e inicialização do app.

  {
    "name": "appengine-hello-world",
    "description": "Simple Hello World Node.js sample for Google App Engine Flexible Environment.",
    "version": "0.0.2",
    "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": {
      "start": "node app.js",
      "test": "c8 mocha -p -j 2 --exit test/*.test.js"
    },
    "dependencies": {
      "express": "^4.17.1"
    },
    "devDependencies": {
      "c8": "^8.0.0",
      "mocha": "^10.0.0",
      "supertest": "^6.0.0"
    }
  }
  

  No exemplo anterior, o arquivo package.json especifica que o aplicativo usa o Node.js versão 18 e posterior e depende de express. Para mais detalhes sobre como instalar e executar o app, consulte a documentação do ambiente de execução do Node.js.