Criar um servidor de status de pull request com Node.js

Artigo
02/11/2025

Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019

O fluxo de trabalho de PR (solicitação de pull) oferece aos desenvolvedores a oportunidade de obter comentários sobre seu código de colegas e de ferramentas automatizadas. Ferramentas e serviços que não são da Microsoft podem participar do fluxo de trabalho de PR usando a API de Status de PR. Este artigo orienta você pelo processo de criação de um servidor de status para validar PRs em um repositório Git do Azure DevOps Services. Para obter mais informações sobre status de PR, consulte Personalizar e estender fluxos de trabalho de solicitação de pull com status de solicitação de pull.

Pré-requisitos

Uma organização no Azure DevOps com um repositório Git. Se você não tiver uma organização, inscreva-se para carregar e compartilhar código em repositórios Git privados ilimitados gratuitos.
Instale VS Code ou outro editor de código de sua escolha. As instruções neste guia usam o VS Code, mas as etapas em outros editores de código são semelhantes.

Instalar Node.js

Para instalar Node.js, baixe a versão LTS apropriada para sua plataforma. O download contém um instalador, que pode ser executado para instalar o runtime Node.js no computador local. Ao instalar o Node.js, assegure-se de conservar a parte do gerenciador de pacotes npm da instalação, que é selecionada por padrão.

Criar um servidor Web básico usando o Express

As etapas nesta seção usam Express, que é uma estrutura da Web leve para Node.js que fornece muitos métodos de utilitário HTTP que simplificam a criação de um servidor Web. Essa estrutura fornece as funções básicas necessárias para ouvir eventos de PR.

Na linha de comando, crie uma nova pasta de projeto para o servidor Web.
```
mkdir pr-server
cd pr-server
```
Use o comando npm init para criar um novo arquivo package.json para o projeto.
```
npm init
```
Selecione Insira para aceitar os padrões para todas as opções, exceto o ponto de entrada. Alterar para app.js
```
entry point: (index.js) app.js
```
Instale o Express no diretório pr-server usando o comando a seguir. Isso instala o Express e o salva na lista de dependências.
```
npm install express
```
Crie um aplicativo Express como base para o servidor de status de PR. As etapas a seguir baseiam-se no exemplo 'Hello world' do Express . Abra a pasta do projeto no VS Code executando o comando a seguir na pasta pr-server.
```
code .
```

Crie um novo arquivo (Ctrl + N) e cole no código de exemplo a seguir.

const express = require('express')
const app = express()

app.get('/', function (req, res) {
res.send('Hello World!')
})

app.listen(3000, function () {
console.log('Example app listening on port 3000!')
})

Salve o arquivo como app.js.
Execute o servidor Web básico usando o seguinte comando:
```
node app.js
```
Verifique se o servidor está em execução navegando até http://localhost:3000/.

Monitorar solicitações HTTP POST

O servidor Web receberá POST solicitações do Azure DevOps Services, portanto, você precisa lidar com essas solicitações em seu servidor.

No final do arquivo app.js, adicione o código a seguir e salve o arquivo.

app.post('/', function (req, res) {
    res.send('Received the POST')
})

Execute novamente seu servidor Web usando o seguinte comando:
```
node app.js
```

Configurar um gancho de serviço para eventos de PR

Os ganchos de serviço são um recurso do Azure DevOps Services que pode alertar os serviços externos quando determinados eventos ocorrem. Para este exemplo, configure dois ganchos de serviço para eventos de PR, para que o servidor de status possa ser notificado. O primeiro é para o evento Pull request criada e o segundo é para o evento Pull request atualizada .

Para receber as notificações de gancho de serviço, exponha uma porta para a Internet pública. O utilitário ngrok é útil para fazer isso em um ambiente de desenvolvimento.

Baixe e descompacte a versão ngrok apropriada para sua plataforma.
Utilize o ngrok para começar a escutar na mesma porta que o seu servidor de exemplo: a porta 3000. Execute o comando a seguir em uma nova janela de comando.
```
ngrok http 3000
```
O Ngrok cria uma URL pública que encaminha para localhost:3000. Anote a URL, pois você precisa dela na próxima etapa. Ele se parece com o seguinte exemplo:
```
http://c3c1bffa.ngrok.io
```
Navegue até seu projeto no Azure DevOps, por exemplo, https://dev.azure.com/<your account>/<your project name>
No menu de navegação, passe o mouse sobre a engrenagem e selecione Ganchos de Serviço.
Se esse for seu primeiro gancho de serviço, selecione + Criar assinatura.

Se você já tiver outras integrações de serviço configuradas, selecione o botão "+ (+)" para criar uma nova assinatura de integração de serviço.
Na caixa de diálogo Nova Assinatura de Ganchos de Serviço, selecione Web Hooks na lista de serviços e, em seguida, selecione Avançar.
Selecione Solicitação de pull criada na lista de gatilhos de evento e selecione Avançar.
Na página Ação, insira a URL do ngrok na caixa URL . Selecione Teste para enviar um evento de teste para o seu servidor.

Na janela do console do ngrok, um POST de entrada retorna 200 OK, indicando que o servidor recebeu o evento de gancho de serviço.
```
HTTP Requests
-------------

POST /                         200 OK
```
Na janela Notificação de Teste, selecione a guia Resposta para ver os detalhes da resposta do servidor. Você deverá ver um comprimento de conteúdo de 17 que corresponde ao comprimento da cadeia de caracteres do manipulador POST (por exemplo, "Recebeu o POST").
Feche a janela Notificação de Teste e selecione Concluir para criar o gancho de serviço.

Percorra as etapas 3 a 9 novamente, mas desta vez configure o evento de Solicitação de pull atualizado .

Importante

Siga as etapas anteriores duas vezes e crie ganchos de serviço tanto para os eventos de solicitação de pull criados e os de solicitação de pull atualizados .

Postar status em PRs

Agora que o servidor pode receber eventos de gancho de serviço quando novas PRs forem criadas, atualize-o para fazer o postback do status para a PR.

As solicitações de gancho de serviço incluem uma carga JSON que descreve o evento. Para ajudar a analisar o JSON retornado pelo gancho de serviço, instale o pacote body-parser .
```
npm install body-parser
```

Atualize app.js para usar o body-parser para analisar application/json.

var bodyParser = require('body-parser')

app.use(bodyParser.json())

Para simplificar a criação de chamadas à API REST para o Azure Repos, instale o pacote azure-devops-node-api.
```
npm install azure-devops-node-api 
```

Atualize app.js para usar o pacote azure-devops-node-api, configurar os detalhes de uma conexão com sua conta e obter uma instância da API do Git.

const vsts = require("azure-devops-node-api")

const collectionURL = process.env.COLLECTIONURL    
const token = process.env.TOKEN

var authHandler = vsts.getPersonalAccessTokenHandler(token)
var connection = new vsts.WebApi(collectionURL, authHandler)

var vstsGit = connection.getGitApi().then( 
    vstsGit => {                                    
        vstsGit.createPullRequestStatus(prStatus, repoId, pullRequestId).then( result => {
            console.log(result);
        },
        error => {
            console.log(error);
        })
    }, 
    error => { 
        console.log(error);
    } 
);

Crie uma variável de ambiente para a URL da coleção, substituindo <your account> pelo nome da sua organização do Azure DevOps.
```
setx COLLECTIONURL "https://dev.azure.com/<your account>"
```
Crie um PAT (token de autenticação pessoal) para seu aplicativo usar, seguindo estas instruções: Autenticar com tokens de acesso pessoal. Você deve criar um novo PAT para cada serviço usado para acessar sua conta, nomeando-a adequadamente.
Crie uma variável de ambiente para seu PAT.
```
setx TOKEN "yourtokengoeshere"
```
Atualize a função post() para ler os detalhes de PR do conteúdo do gancho de serviço. Você precisa desses valores para o status de postback.
```
var repoId = req.body.resource.repository.id
var pullRequestId = req.body.resource.pullRequestId
var title = req.body.resource.title
```
Compile o objeto status para postar na PR.

State é uma enumeração do tipo GitStatusState. Use succeeded para indicar que a PR passou na verificação de status e está pronta para mesclagem.

description é um valor de cadeia de caracteres que é exibido para o usuário na seção Status e no feed de atividades na exibição de detalhes da PR.

O targetUrl é uma URL usada para criar um link para o texto de descrição na seção Status e no feed de atividades, que é onde os usuários podem ir para obter mais informações sobre o status, por exemplo, um relatório de build ou uma execução de teste. Se nenhuma URL for especificada, a descrição será exibida como texto sem nenhum link.

O contexto name e genre são usados para categorizar o status e distingui-lo do status de postagem de outros serviços.
```
    var prStatus = {
        "state": "succeeded",
        "description": "Ready for review",
        "targetUrl": "https://visualstudio.microsoft.com",
        "context": {
            "name": "wip-checker",
            "genre": "continuous-integration"
        }
    }
```
Em vez de postar o status succeeded de imediato, inspecione o título da PR para ver se o usuário indicou se ela é um trabalho em andamento adicionando WIP ao título. Nesse caso, altere o status postado de volta para a PR.
```
    if (title.includes("WIP")) {
        prStatus.state = "pending"
        prStatus.description = "Work in progress"
    }
```
Por fim, poste o status usando o método createPullRequestStatus(). Ele requer o objeto de status, a ID do repositório e a ID da solicitação de pull. Imprima a resposta no console do node para que você possa ver o resultado da postagem.
```
vstsGit.createPullRequestStatus(prStatus, repoId, pullRequestId).then( result => {
    console.log(result)
})
```

O método resultante deve ser semelhante a este:

app.post("/", function (req, res) {

    // Get the details about the PR from the service hook payload
    var repoId = req.body.resource.repository.id
    var pullRequestId = req.body.resource.pullRequestId
    var title = req.body.resource.title

    // Build the status object that we want to post.
    // Assume that the PR is ready for review...
    var prStatus = {
        "state": "succeeded",
        "description": "Ready for review",
        "targetUrl": "https://visualstudio.microsoft.com",
        "context": {
            "name": "wip-checker",
            "genre": "continuous-integration"
        }
    }

    // Check the title to see if there is "WIP" in the title.
    if (title.includes("WIP")) {

        // If so, change the status to pending and change the description.
        prStatus.state = "pending"
        prStatus.description = "Work in progress"
    }

    // Post the status to the PR
    vstsGit.createPullRequestStatus(prStatus, repoId, pullRequestId).then( result => {
        console.log(result)
    })

    res.send("Received the POST")
})

Salve app.js e reinicie seu aplicativo Node.js.
```
node app.js
```

Criar uma PR para testar o servidor de status

Agora que o servidor está em execução e monitorando notificações de gancho de serviço, crie uma solicitação de pull para testá-lo.

Comece na visualização de arquivos. Edite o arquivo readme.md em seu repositório (ou em qualquer outro arquivo se você não tiver um readme.md).
Faça uma edição e confirme as alterações no repositório.
Assegure-se de confirmar as alterações em um novo branch para que você possa criar uma PR na próxima etapa.
Selecione o link Criar uma solicitação de pull .
Adicione wip no título para testar a funcionalidade do aplicativo. Selecione Criar para criar a PR.
Depois que a PR é criada, a seção de status é exibida com a entrada Trabalho em andamento vinculada à URL especificada no conteúdo.
Atualize o título da PR e remova o texto WIP e observe que o status muda de Trabalho em andamento para Pronto para revisão.