Extensões de módulo

As extensões de módulo permitem que os usuários ampliem o sistema de módulos lendo dados de entrada dos módulos no gráfico de dependência, executando a lógica necessária para resolver dependências e, por fim, criando repositórios chamando as regras de repo. Essas extensões têm recursos semelhantes às regras do repositório, o que permite que elas realizem E/S de arquivos, enviem solicitações de rede e assim por diante. Entre outras coisas, eles permitem que o Bazel interaja com outros sistemas de gerenciamento de pacotes, respeitando o gráfico de dependências criado com os módulos do Bazel.

É possível definir extensões de módulo em arquivos .bzl, assim como nas regras de repositório. Elas não são invocadas diretamente. Em vez disso, cada módulo especifica partes de dados chamadas tags para que as extensões leiam. O Bazel executa a resolução de módulo antes de avaliar as extensões. A extensão lê todas as tags pertencentes a ela em todo o gráfico de dependência.

Uso da extensão

As extensões são hospedadas nos próprios módulos do Bazel. Para usar uma extensão em um módulo, primeiro adicione um bazel_dep ao módulo que hospeda a extensão e, em seguida, chame a função integrada use_extension para incluí-la no escopo. Considere o seguinte exemplo: um snippet de um arquivo MODULE.bazel para usar a extensão "maven" definida no módulo rules_jvm_external:

bazel_dep(name = "rules_jvm_external", version = "4.5")
maven = use_extension("@rules_jvm_external//:extensions.bzl", "maven")

Isso vincula o valor de retorno de use_extension a uma variável, o que permite que o usuário use a sintaxe de ponto para especificar tags para a extensão. As tags precisam seguir o esquema definido pelas classes de tag correspondentes especificadas na definição de extensão. Veja um exemplo de especificação de algumas tags maven.install e maven.artifact:

maven.install(artifacts = ["org.junit:junit:4.13.2"])
maven.artifact(group = "com.google.guava",
               artifact = "guava",
               version = "27.0-jre",
               exclusions = ["com.google.j2objc:j2objc-annotations"])

Use a diretiva use_repo para trazer repositórios gerados pela extensão para o escopo do módulo atual.

use_repo(maven, "maven")

Os repositórios gerados por uma extensão fazem parte da API dela. Neste exemplo, a extensão do módulo "maven" promete gerar um repositório chamado maven. Com a declaração acima, a extensão resolve corretamente rótulos como @maven//:org_junit_junit para apontar para o repositório gerado pela extensão "maven".

Definição da extensão

É possível definir extensões de módulo de maneira semelhante às regras de repositório, usando a função module_extension. No entanto, enquanto as regras de repositório têm vários atributos, as extensões de módulo têm tag_classes, cada uma com vários atributos. As classes de tag definem esquemas para as tags usadas por essa extensão. Por exemplo, a extensão "maven" acima pode ser definida assim:

# @rules_jvm_external//:extensions.bzl

_install = tag_class(attrs = {"artifacts": attr.string_list(), ...})
_artifact = tag_class(attrs = {"group": attr.string(), "artifact": attr.string(), ...})
maven = module_extension(
  implementation = _maven_impl,
  tag_classes = {"install": _install, "artifact": _artifact},
)

Essas declarações mostram que as tags maven.install e maven.artifact podem ser especificadas usando o esquema de atributo especificado.

A função de implementação das extensões de módulo é semelhante à das regras do repositório, exceto pelo fato de que elas recebem um objeto module_ctx, que concede acesso a todos os módulos que usam a extensão e todas as tags pertinentes. Em seguida, a função de implementação chama as regras de repo para gerar repositórios.

# @rules_jvm_external//:extensions.bzl

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_file")  # a repo rule
def _maven_impl(ctx):
  # This is a fake implementation for demonstration purposes only

  # collect artifacts from across the dependency graph
  artifacts = []
  for mod in ctx.modules:
    for install in mod.tags.install:
      artifacts += install.artifacts
    artifacts += [_to_artifact(artifact) for artifact in mod.tags.artifact]

  # call out to the coursier CLI tool to resolve dependencies
  output = ctx.execute(["coursier", "resolve", artifacts])
  repo_attrs = _process_coursier_output(output)

  # call repo rules to generate repos
  for attrs in repo_attrs:
    http_file(**attrs)
  _generate_hub_repo(name = "maven", repo_attrs)

Identidade da extensão

As extensões de módulo são identificadas pelo nome e pelo arquivo .bzl que aparece na chamada para use_extension. No exemplo a seguir, a extensão maven é identificada pelo arquivo .bzl @rules_jvm_external//:extension.bzl e pelo nome maven:

maven = use_extension("@rules_jvm_external//:extensions.bzl", "maven")

A reexportação de uma extensão de um arquivo .bzl diferente dá a ela uma nova identidade. Se ambas as versões da extensão forem usadas no gráfico de módulo transitivo, elas serão avaliadas separadamente e só vão mostrar as tags associadas a essa identidade específica.

Como autor de uma extensão, você precisa garantir que os usuários usem apenas a extensão do módulo de um único arquivo .bzl.

Nomes e visibilidade do repositório

Os repositórios gerados por extensões têm nomes canônicos no formato module_repo_canonical_name~extension_name~repo_name. Para extensões hospedadas no módulo raiz, a parte module_repo_canonical_name é substituída pela string _main. O formato de nome canônico não é uma API de que você depende. Ele está sujeito a mudanças a qualquer momento.

Essa política de nomenclatura significa que cada extensão tem seu próprio "namespace de repositório". Duas extensões distintas podem definir um repositório com o mesmo nome sem risco de conflitos. Isso também significa que repository_ctx.name informa o nome canônico do repo, que não é o mesmo nome especificado na chamada de regra de repo.

Considerando os repositórios gerados por extensões de módulo, há várias regras de visibilidade de repositórios:

• Um repositório de módulo do Bazel pode acessar todos os repositórios introduzidos no arquivo MODULE.bazel usando bazel_dep e use_repo.
• Um repositório gerado por uma extensão de módulo pode ver todos os repositórios visíveis para o módulo que hospeda a extensão, além de todos os outros repositórios gerados pela mesma extensão de módulo (usando os nomes especificados nas chamadas de regra de repo como os nomes aparentes deles).
  • Isso pode resultar em um conflito. Se o repositório do módulo puder acessar um repositório com o nome aparente foo e a extensão gerar um repositório com o nome especificado foo, então, para todos os repositórios gerados por essa extensão, foo se refere ao primeiro.

Práticas recomendadas

Esta seção descreve as práticas recomendadas ao escrever extensões para que elas sejam simples de usar, de manter e se adaptem bem às mudanças ao longo do tempo.

Colocar cada extensão em um arquivo separado

Quando as extensões estão em arquivos diferentes, uma extensão pode carregar repositórios gerados por outra extensão. Mesmo que você não use essa funcionalidade, é melhor colocá-las em arquivos separados, caso precise dela mais tarde. Isso ocorre porque a identificação da extensão é baseada no arquivo dela. Portanto, mover a extensão para outro arquivo posteriormente altera sua API pública e é uma alteração incompatível com versões anteriores para seus usuários.