Otimizar a velocidade de iteração

Esta página descreve como otimizar o desempenho de build do Bazel ao executar o Bazel repetidamente.

Estado do ambiente de execução do Bazel

Uma invocação do Bazel envolve várias partes que interagem.

• A interface de linha de comando (CLI) bazel é a ferramenta de front-end voltada ao usuário e recebe comandos dele.

• A ferramenta de linha de comando inicia um servidor do Bazel para cada base de saída distinta. O servidor do Bazel geralmente é persistente, mas é desligado após algum tempo de inatividade para não desperdiçar recursos.

• O servidor do Bazel executa as etapas de carregamento e análise de um determinado comando (build, run, cquery etc.), em que ele cria as partes necessárias do gráfico de build na memória. As estruturas de dados resultantes são mantidas no servidor do Bazel como parte do cache de análise.

• O servidor do Bazel também pode executar a ação ou enviar ações para execução remota, se estiver configurado para isso. Os resultados das execuções de ações também são armazenados em cache, ou seja, no cache de ações (ou cache de execução, que pode ser local ou remoto e compartilhado entre servidores do Bazel).

• O resultado da invocação do Bazel fica disponível na árvore de saída.

Execução iterativa do Bazel

Em um fluxo de trabalho típico de desenvolvedor, é comum criar (ou executar) um trecho de código repetidamente, geralmente com uma frequência muito alta (por exemplo, para resolver algum erro de compilação ou investigar um teste com falha). Nessa situação, é importante que invocações repetidas de bazel tenham o menor sobrecarga possível em relação à ação repetida subjacente (por exemplo, invocar um compilador ou executar um teste).

Com isso em mente, vamos analisar novamente o estado de execução do Bazel:

O cache de análise é uma parte essencial dos dados. Uma quantidade significativa de tempo pode ser gasta apenas nas fases de carregamento e análise de uma execução a frio (ou seja, uma execução logo após o início do servidor Bazel ou quando o cache de análise foi descartado). Para um único build frio bem-sucedido (por exemplo, para um lançamento de produção), esse custo é tolerável, mas para builds repetidos do mesmo destino, é importante que esse custo seja amortizado e não repetido em cada invocação.

O cache de análise é bastante volátil. Primeiro, ele faz parte do estado em processo do servidor Bazel. Portanto, perder o servidor significa perder o cache. No entanto, o cache também é invalidado com muita facilidade. Por exemplo, muitas flags de linha de comando bazel fazem com que o cache seja descartado. Isso acontece porque muitas flags afetam o gráfico de build (por exemplo, devido a atributos configuráveis). Algumas mudanças de flag também podem fazer com que o servidor do Bazel seja reiniciado (por exemplo, mudar as opções de inicialização).

Um bom cache de execução também é valioso para o desempenho da build. Um cache de execução pode ser mantido localmente no disco ou remotamente. O cache pode ser compartilhado entre servidores do Bazel e entre desenvolvedores.

Evitar descartar o cache de análise

O Bazel vai mostrar um aviso se o cache de análise for descartado ou se o servidor for reiniciado. Evite o uso iterativo de qualquer uma destas opções:

• Tenha cuidado ao mudar flags bazel no meio de um fluxo de trabalho iterativo. Por exemplo, misturar um bazel build -c opt com um bazel cquery faz com que cada comando descarte o cache de análise do outro. Em geral, tente usar um conjunto fixo de flags durante um fluxo de trabalho específico.

• Perder o servidor do Bazel significa perder o cache de análise. O servidor do Bazel tem um tempo de inatividade configurável, após o qual ele é desligado. É possível configurar esse tempo no arquivo bazelrc de acordo com suas necessidades. O servidor também é reiniciado quando as flags de inicialização mudam. Portanto, evite alterar essas flags, se possível.

• Atenção: o servidor do Bazel é encerrado se você pressionar Ctrl-C várias vezes enquanto o Bazel está em execução. É tentador tentar economizar tempo interrompendo um build em execução que não é mais necessário, mas pressione Ctrl-C apenas uma vez para solicitar o encerramento normal da invocação atual.

• Se você quiser usar vários conjuntos de flags do mesmo espaço de trabalho, use várias bases de saída distintas, alternadas com a flag --output_base. Cada base de saída recebe o próprio servidor do Bazel.

Para transformar essa condição em um erro em vez de um aviso, use a flag --noallow_analysis_cache_discard (introduzida no Bazel 6.4.0).