Ao analisar as páginas anteriores, um tema se repete várias vezes: gerenciar seu próprio código é bastante simples, mas gerenciar as dependências dele é muito mais difícil. Há todos os tipos de dependências: às vezes, há uma dependência de uma tarefa (como "envie a documentação antes de marcar um lançamento como concluído") e, às vezes, há uma dependência de um artefato (como "preciso ter a versão mais recente da biblioteca de visão computacional para criar meu código"). Às vezes, você tem dependências internas em outra parte da sua base de código e, às vezes, tem dependências externas em código ou dados de outra equipe (na sua organização ou em terceiros). Mas, em qualquer caso, a ideia de "preciso disso antes de ter aquilo" é algo que se repete várias vezes no design de sistemas de build, e gerenciar dependências é talvez o trabalho mais fundamental de um sistema de build.
Como lidar com módulos e dependências
Projetos que usam sistemas de build baseados em artefatos, como o Bazel, são divididos em um conjunto
de módulos, com módulos expressando dependências entre si por arquivos
BUILD. A organização adequada desses módulos e dependências pode ter um efeito enorme no desempenho do sistema de build e no trabalho necessário para a manutenção.
Como usar módulos refinados e a regra 1:1:1
A primeira questão que surge ao estruturar um build baseado em artefatos é decidir quanta funcionalidade um módulo individual deve abranger. No Bazel, um módulo é representado por uma meta que especifica uma unidade passível de build, como um java_library ou um go_binary. Em um extremo, todo o projeto pode ser
contido em um único módulo colocando um arquivo BUILD na raiz e
agrupando recursivamente todos os arquivos de origem desse projeto. No outro extremo, quase todos os arquivos de origem podem ser transformados em módulos próprios, exigindo que cada arquivo seja listado em um arquivo BUILD de todos os outros arquivos de que depende.
A maioria dos projetos fica entre esses extremos, e a escolha envolve uma compensação entre desempenho e capacidade de manutenção. Usar um único módulo para todo o projeto pode significar que você nunca vai precisar tocar no arquivo BUILD, exceto ao adicionar uma dependência externa. No entanto, isso significa que o sistema de build sempre precisa criar todo o projeto de uma só vez. Isso significa que não será possível
paralelizar ou distribuir partes do build, nem armazenar em cache partes
que já foram criadas. Um módulo por arquivo é o oposto: o sistema de build
tem a máxima flexibilidade no armazenamento em cache e no agendamento das etapas do build, mas
os engenheiros precisam se esforçar mais para manter listas de dependências sempre que
mudam quais arquivos referenciam quais.
Embora a granularidade exata varie de acordo com o idioma (e muitas vezes até mesmo dentro do idioma), o Google tende a preferir módulos significativamente menores do que os que normalmente são escritos em um sistema de build baseado em tarefas. Um binário de produção típico no Google geralmente depende de dezenas de milhares de destinos, e até mesmo uma equipe de tamanho moderado pode ter centenas de destinos no código-fonte. Para linguagens como
Java, que têm uma forte noção integrada de empacotamento, cada diretório geralmente
contém um único pacote, destino e arquivo BUILD. O Pants, outro sistema de build
baseado no Bazel, chama isso de regra 1:1:1. Linguagens com convenções de
pacotes mais fracas geralmente definem vários destinos por arquivo BUILD.
Os benefícios de destinos de build menores começam a aparecer em grande escala porque levam a builds distribuídos mais rápidos e a uma necessidade menos frequente de recriar destinos.
As vantagens se tornam ainda mais convincentes depois que os testes entram em cena, já que
metas mais refinadas significam que o sistema de build pode ser muito mais inteligente ao
executar apenas um subconjunto limitado de testes que podem ser afetados por qualquer
mudança. Como o Google acredita nos benefícios sistêmicos de usar metas menores, investimos em ferramentas para gerenciar automaticamente arquivos BUILD e evitar sobrecarregar os desenvolvedores.
Algumas dessas ferramentas, como buildifier e buildozer, estão disponíveis com o
Bazel no
diretório buildtools.
Como minimizar a visibilidade do módulo
O Bazel e outros sistemas de build permitem que cada destino especifique uma visibilidade, uma
propriedade que determina quais outros destinos podem depender dele. Um destino particular só pode ser referenciado no próprio arquivo BUILD. Um destino pode conceder maior visibilidade aos destinos de uma lista explicitamente definida de arquivos BUILD ou, no caso de visibilidade pública, a todos os destinos no espaço de trabalho.
Como na maioria das linguagens de programação, geralmente é melhor minimizar a visibilidade o máximo possível. Em geral, as equipes do Google só tornam os destinos públicos se eles representarem bibliotecas amplamente usadas e disponíveis para qualquer equipe do Google.
As equipes que exigem coordenação antes de usar o código vão manter uma lista de permissões de destinos de clientes como visibilidade de destino. As metas de implementação interna de cada
equipe serão restritas apenas aos diretórios
de propriedade da equipe, e a maioria dos arquivos BUILD terá apenas uma meta que não seja
privada.
Gerenciamento de dependências
Os módulos precisam poder se referir uns aos outros. A desvantagem de dividir uma base de código em módulos refinados é que você precisa gerenciar as dependências entre eles, embora as ferramentas possam ajudar a automatizar isso. Expressar essas
dependências geralmente acaba sendo a maior parte do conteúdo em um arquivo BUILD.
Dependências internas
Em um projeto grande dividido em módulos refinados, a maioria das dependências provavelmente será interna, ou seja, em outro destino definido e criado no mesmo repositório de origem. As dependências internas diferem das externas porque são criadas com base na origem, em vez de serem baixadas como um artefato pré-criado durante a execução da build. Isso também significa que não há noção de "versão" para dependências internas. Um destino e todas as dependências internas dele são sempre criados no mesmo commit/revisão no repositório. Um problema que precisa ser tratado com cuidado em relação às dependências internas é como tratar as dependências transitivas (Figura 1). Suponha que o destino A dependa do destino B, que depende de um destino de biblioteca comum C. O destino A pode usar classes definidas no destino C?
Figura 1. Dependências transitivas
No que diz respeito às ferramentas subjacentes, não há problema com isso. B e C serão vinculados ao destino A quando ele for criado, então todos os símbolos definidos em C são conhecidos por A. O Bazel permitiu isso por muitos anos, mas, à medida que o Google cresceu, começamos a ter problemas. Suponha que B tenha sido refatorado para não precisar mais depender de C. Se a dependência de B em C fosse removida, A e qualquer outro destino que usasse C por uma dependência em B seriam interrompidos. Na prática, as dependências de um destino se tornaram parte do contrato público e nunca puderam ser alteradas com segurança. Isso significava que as dependências se acumulavam com o tempo e os builds no Google começaram a ficar mais lentos.
O Google acabou resolvendo esse problema ao introduzir um "modo de dependência transitiva estrita" no Bazel. Nesse modo, o Bazel detecta se um destino tenta referenciar um símbolo sem depender dele diretamente e, em caso afirmativo, falha com um erro e um comando do shell que pode ser usado para inserir automaticamente a dependência. Implementar essa mudança em toda a base de código do Google e refatorar cada um dos nossos milhões de destinos de build para listar explicitamente as dependências foi um esforço de vários anos, mas valeu a pena. Nossos builds agora são muito mais rápidos, já que os destinos têm menos dependências desnecessárias, e os engenheiros podem remover as dependências que não precisam sem se preocupar em interromper os destinos que dependem delas.
Como de costume, a aplicação de dependências transitivas estritas envolveu uma troca. Isso tornou os arquivos de build mais detalhados, já que as bibliotecas usadas com frequência agora precisam ser listadas explicitamente em muitos lugares em vez de serem incluídas incidentalmente, e os engenheiros precisaram se esforçar mais para adicionar dependências aos arquivos BUILD. Desde então, desenvolvemos ferramentas que reduzem esse trabalho detectando automaticamente muitas dependências ausentes e adicionando-as a arquivos BUILD sem intervenção do desenvolvedor. Mas, mesmo sem essas ferramentas, descobrimos que o trade-off vale a pena à medida que o codebase é escalonado: adicionar explicitamente uma dependência ao arquivo BUILD é um custo único, mas lidar com dependências transitivas implícitas pode causar problemas contínuos enquanto o destino de build existir. O Bazel impõe dependências transitivas estritas no código Java por padrão.
Dependências externas
Se uma dependência não for interna, ela será externa. Dependências externas são aquelas em artefatos criados e armazenados fora do sistema de build. A dependência é importada diretamente de um repositório de artefatos (normalmente acessado pela Internet) e usada como está, em vez de ser criada da origem. Uma das maiores diferenças entre dependências externas e internas é que as externas têm versões, e essas versões existem independentemente do código-fonte do projeto.
Gerenciamento de dependências automático x manual
Os sistemas de build podem permitir que as versões de dependências externas sejam gerenciadas
manualmente ou automaticamente. Quando gerenciado manualmente, o arquivo de build
lista explicitamente a versão que quer baixar do repositório de artefatos,
geralmente usando uma string de versão semântica, como
1.1.4. Quando gerenciado automaticamente, o arquivo de origem especifica um intervalo de versões aceitáveis, e o sistema de build sempre faz o download da mais recente. Por
exemplo, o Gradle permite que uma versão de dependência seja declarada como "1.+" para especificar
que qualquer versão secundária ou de patch de uma dependência é aceitável, desde que a
versão principal seja 1.
As dependências gerenciadas automaticamente podem ser convenientes para projetos pequenos, mas geralmente são uma receita para o desastre em projetos de tamanho não trivial ou que estão sendo trabalhados por mais de um engenheiro. O problema com as dependências gerenciadas automaticamente é que você não tem controle sobre quando a versão é atualizada. Não há como garantir que terceiros não farão atualizações destrutivas (mesmo quando afirmam usar a versão semântica). Assim, um build que funcionou em um dia pode ser corrompido no dia seguinte sem uma maneira fácil de detectar o que mudou ou de reverter para um estado funcional. Mesmo que o build não seja interrompido, pode haver mudanças sutis no comportamento ou na performance que são impossíveis de rastrear.
Por outro lado, como as dependências gerenciadas manualmente exigem uma mudança no controle de origem, elas podem ser facilmente descobertas e revertidas. Além disso, é possível fazer o check-out de uma versão mais antiga do repositório para criar com dependências mais antigas. O Bazel exige que as versões de todas as dependências sejam especificadas manualmente. Mesmo em escalas moderadas, o overhead do gerenciamento manual de versões vale a pena pela estabilidade que ele oferece.
A regra de uma versão
Diferentes versões de uma biblioteca geralmente são representadas por artefatos diferentes. Portanto, em teoria, não há motivo para que diferentes versões da mesma dependência externa não possam ser declaradas no sistema de build com nomes diferentes. Assim, cada destino poderia escolher qual versão da dependência usar. Isso causa muitos problemas na prática. Por isso, o Google aplica uma regra de uma versão (em inglês) estrita para todas as dependências de terceiros na nossa base de código.
O maior problema de permitir várias versões é a questão da dependência de diamante. Suponha que o destino A dependa do destino B e da v1 de uma biblioteca externa. Se o destino B for refatorado mais tarde para adicionar uma dependência na v2 da mesma biblioteca externa, o destino A vai falhar porque agora depende implicitamente de duas versões diferentes da mesma biblioteca. Na prática, nunca é seguro adicionar uma nova dependência de um destino a qualquer biblioteca de terceiros com várias versões, porque qualquer um dos usuários desse destino já pode depender de uma versão diferente. Seguir a regra de uma versão torna esse conflito impossível. Se um destino adicionar uma dependência em uma biblioteca de terceiros, todas as dependências existentes já estarão nessa mesma versão, então elas podem coexistir sem problemas.
Dependências externas transitivas
Lidar com as dependências transitivas de uma dependência externa pode ser particularmente difícil. Muitos repositórios de artefatos, como o Maven Central, permitem que os artefatos especifiquem dependências em versões específicas de outros artefatos no repositório. Ferramentas de build como Maven ou Gradle geralmente baixam recursivamente cada dependência transitiva por padrão. Isso significa que adicionar uma única dependência no projeto pode fazer com que dezenas de artefatos sejam baixados no total.
Isso é muito conveniente: ao adicionar uma dependência em uma nova biblioteca, seria muito difícil rastrear cada uma das dependências transitivas dessa biblioteca e adicioná-las manualmente. Mas também há uma grande desvantagem: como bibliotecas diferentes podem depender de versões diferentes da mesma biblioteca de terceiros, essa estratégia viola necessariamente a regra de uma versão e leva ao problema de dependência de diamante. Se o destino depender de duas bibliotecas externas que usam versões diferentes da mesma dependência, não é possível saber qual delas você vai receber. Isso também significa que a atualização de uma dependência externa pode causar falhas aparentemente não relacionadas em todo o código-fonte se a nova versão começar a extrair versões conflitantes de algumas das dependências.
Por isso, o Bazel não baixa automaticamente dependências transitivas.
Infelizmente, não há uma solução mágica. A alternativa do Bazel é exigir um arquivo global que liste todas as dependências externas do repositório e uma versão explícita usada para essa dependência em todo o repositório. Felizmente, o Bazel oferece ferramentas capazes de gerar automaticamente um arquivo com as dependências transitivas de um conjunto de artefatos do Maven. Essa ferramenta pode ser executada uma vez para gerar o arquivo WORKSPACE inicial
de um projeto. Depois, esse arquivo pode ser atualizado manualmente para ajustar as versões
de cada dependência.
Mais uma vez, a escolha aqui é entre conveniência e escalonabilidade. Projetos pequenos talvez prefiram não se preocupar com o gerenciamento de dependências transitivas e possam usar dependências transitivas automáticas. Essa estratégia se torna cada vez menos atraente à medida que a organização e a base de código crescem, e os conflitos e resultados inesperados se tornam mais frequentes. Em escalas maiores, o custo de gerenciar dependências manualmente é muito menor do que o custo de lidar com problemas causados pelo gerenciamento automático de dependências.
Armazenamento em cache de resultados de build usando dependências externas
As dependências externas geralmente são fornecidas por terceiros que lançam versões estáveis de bibliotecas, talvez sem fornecer o código-fonte. Algumas organizações também podem disponibilizar parte do próprio código como artefatos, permitindo que outros trechos de código dependam deles como dependências de terceiros, em vez de internas. Isso pode acelerar teoricamente as builds se os artefatos forem lentos para criar, mas rápidos para baixar.
No entanto, isso também introduz muito overhead e complexidade: alguém precisa ser responsável por criar cada um desses artefatos e fazer upload deles para o repositório de artefatos, e os clientes precisam garantir que eles permaneçam atualizados com a versão mais recente. A depuração também fica muito mais difícil porque diferentes partes do sistema foram criadas em diferentes pontos do repositório, e não há mais uma visão consistente da árvore de origem.
Uma maneira melhor de resolver o problema de artefatos que levam muito tempo para serem criados é usar um sistema de build que ofereça suporte ao armazenamento em cache remoto, conforme descrito anteriormente. Esse sistema salva os artefatos resultantes de cada build em um local compartilhado entre os engenheiros. Assim, se um desenvolvedor depender de um artefato criado recentemente por outra pessoa, o sistema de build fará o download automático em vez de criar. Isso oferece todos os benefícios de desempenho de depender diretamente de artefatos, garantindo que os builds sejam tão consistentes quanto se fossem sempre criados da mesma origem. Essa é a estratégia usada internamente pelo Google, e o Bazel pode ser configurado para usar um cache remoto.
Segurança e confiabilidade de dependências externas
Depender de artefatos de fontes terceirizadas é inerentemente arriscado. Há um risco de disponibilidade se a fonte de terceiros (como um repositório de artefatos) ficar inativa, porque toda a build pode ser interrompida se não for possível baixar uma dependência externa. Também há um risco de segurança: se o sistema de terceiros
for comprometido por um invasor, ele poderá substituir o artefato
referenciado por um de design próprio, permitindo que injete código arbitrário
no seu build. É possível reduzir os dois problemas espelhando os artefatos de que você depende em servidores controlados e bloqueando o acesso do sistema de build a repositórios de artefatos de terceiros, como o Maven Central. A desvantagem é que esses espelhos exigem esforço e recursos para serem mantidos. Por isso, a escolha de usá-los ou não depende da escala do projeto. O problema de segurança também pode
ser completamente evitado com pouca sobrecarga exigindo que o hash de cada
artefato de terceiros seja especificado no repositório de origem, fazendo com que o build
falhe se o artefato for adulterado. Outra alternativa que evita completamente o problema é usar as dependências do projeto. Quando um projeto
disponibiliza pacotes de terceiros das dependências, ele os verifica no controle de origem junto ao
código-fonte do projeto, como fonte ou como binários. Isso significa que todas as dependências externas do projeto são convertidas em internas. O Google usa essa abordagem internamente, verificando todas as bibliotecas de terceiros referenciadas no Google em um diretório third_party na raiz da árvore de origem do Google. No entanto, isso funciona no Google apenas porque o sistema de controle de origem da empresa é criado sob medida para processar um monorepo extremamente grande. Por isso, o fornecimento de terceiros pode não ser uma opção para todas as organizações.