Bazel モジュール

問題を報告ソースを表示 Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bazel モジュールは、複数のバージョンを持つことができる Bazel プロジェクトです。各モジュールは、依存する他のモジュールに関するメタデータを公開します。これは、Maven のアーティファクト、npm のパッケージ、Go のモジュール、Cargo のcrate など、他の依存関係管理システムの一般的なコンセプトに似ています。

モジュールには、リポジトリのルート（WORKSPACE ファイルの次）に MODULE.bazel ファイルが必要です。このファイルはモジュールのマニフェストで、名前、バージョン、直接依存関係のリストなどの情報を宣言します。基本的な例:

module(name = "my-module", version = "1.0")

bazel_dep(name = "rules_cc", version = "0.0.1")
bazel_dep(name = "protobuf", version = "3.19.0")

モジュール解決を実行するために、Bazel はまずルートモジュールの MODULE.bazel ファイルを読み取り、依存関係グラフ全体が検出されるまで Bazel レジストリから依存関係の MODULE.bazel ファイルを繰り返しリクエストします。

デフォルトでは、Bazel は使用する各モジュールの 1 つのバージョンを選択します。Bazel は各モジュールをリポジトリで表し、レジストリに再度問い合わせて、各リポジトリの定義方法を学習します。

バージョン形式

Bazel には多様なエコシステムがあり、プロジェクトではさまざまなバージョニングスキームが使用されています。特によく利用されているのが SemVer ですが、Abseil など、さまざまなスキームを使用する著名なプロジェクトも存在します。このバージョンのバージョンは日付ベースのものです（例: 20210324.2）。

このため、Bzlmod では、SemVer 仕様のより緩和されたバージョンを採用しています。違いは次のとおりです。

SemVer では、バージョンの「リリース」部分は 3 つのセグメント（MAJOR.MINOR.PATCH）で構成する必要があります。Bazel ではこの要件が緩和され、任意の数のセグメントが許容されます。
SemVer では、「リリース」部分の各セグメントは数字のみにする必要があります。Bazel では、文字も使用できるように緩和されており、比較セマンティクスは「prerelease」部分の「識別子」と一致します。
また、メジャーバージョン、マイナーバージョン、パッチバージョンの増加のセマンティクスは適用されません。ただし、下位互換性を示す方法については、互換性レベルをご覧ください。

有効な SemVer バージョンは、有効な Bazel モジュールバージョンです。また、2 つの SemVer バージョン a と b が a < b と比較されるのは、Bazel モジュールバージョンとして比較した場合に同じ結果が得られる場合に限られます。

バージョンの選択

バージョン管理された依存関係管理の分野では定番のダイアモンド依存関係の問題について考えてみましょう。次の依存関係グラフがあるとします。

       A 1.0
      /     \
   B 1.0    C 1.1
     |        |
   D 1.0    D 1.1

どのバージョンの D を使用すればよいですか？この問題を解決するために、Bzlmod は Go モジュールシステムで導入された最小バージョン選択（MVS）アルゴリズムを使用します。MVS は、モジュールの新しいバージョンはすべて下位互換性があると想定するため、依存関係によって指定された最高バージョン（この例では D 1.1）を選択します。これを「ミニマル」と呼んでいるのは、D 1.1 が要件を満たす最も初期のバージョンであるためです。D 1.2 以降が存在しても、Google では選択しません。MVS を使用すると、忠実度が高く再現可能なバージョン選択プロセスが作成されます。

取り消されたバージョン

レジストリでは、特定のバージョンを回避する必要がある場合（セキュリティの脆弱性など）に、そのバージョンを削除済みとして宣言できます。ヤンクされたバージョンのモジュールを選択すると、Bazel はエラーをスローします。このエラーを解決するには、ヤンクされていない新しいバージョンにアップグレードするか、--allow_yanked_versions フラグを使用してヤンクされたバージョンを明示的に許可します。

互換性レベル

Go では、下位互換性に関する MVS の想定が機能します。これは、下位互換性のないバージョンのモジュールを別のモジュールとして扱うためです。SemVer では、A 1.x と A 2.x は異なるモジュールと見なされ、解決された依存関係グラフに共存できます。これは、Go のパッケージパスにメジャーバージョンをエンコードすることで可能になります。これにより、コンパイル時またはリンク時に競合が発生しません。

ただし、Bazel ではこのような保証を提供できないため、下位互換性のないバージョンを検出するには「メジャーバージョン」番号が必要です。この数値は互換性レベルと呼ばれ、各モジュールバージョンの module() ディレクティブで指定されます。この情報により、Bazel は、解決された依存関係グラフに互換性レベルが異なる同じモジュールのバージョンが存在することを検出すると、エラーをスローできます。

オーバーライド

Bazel モジュール解決の動作を変更するには、MODULE.bazel ファイルでオーバーライドを指定します。ルートモジュールのオーバーライドのみが有効になります。モジュールが依存関係として使用されている場合、そのオーバーライドは無視されます。

各オーバーライドは特定のモジュール名に対して指定され、依存関係グラフ内のすべてのバージョンに影響します。ルートモジュールのオーバーライドのみが有効になりますが、ルートモジュールが直接依存しない推移的依存関係のオーバーライドが有効になる場合があります。

単一バージョンのオーバーライド

single_version_override は複数の目的で使用されます。

version 属性を使用すると、依存関係グラフでリクエストされる依存関係のバージョンに関係なく、依存関係を特定のバージョンに固定できます。
registry 属性を使用すると、通常のレジストリ選択プロセスに従う代わりに、この依存関係を特定のレジストリから取得させることができます。
patch* 属性を使用すると、ダウンロードしたモジュールに適用するパッチのセットを指定できます。

これらの属性はすべて省略可能で、組み合わせて使用できます。

複数バージョンのオーバーライド

multiple_version_override を指定すると、解決された依存関係グラフに同じモジュールの複数のバージョンを共存させることができます。

モジュールに対して許可されるバージョンの明示的なリストを指定できます。このリストはすべて、解決前に依存関係グラフ内に存在する必要があります。許可される各バージョンに応じて、なんらかの推移的依存関係が存在する必要があります。解決後、許可されたバージョンのモジュールのみが残り、他のバージョンのモジュールは、同じ互換性レベルで最も近い上位の許可されたバージョンにアップグレードされます。同じ互換性レベルで許可されているバージョンがない場合、Bazel はエラーをスローします。

たとえば、解決前に依存関係グラフにバージョン 1.1、1.3、1.5、1.7、2.0 が存在し、メジャーバージョンが互換性レベルの場合:

複数バージョンのオーバーライドで 1.3、1.7、2.0 を許可すると、1.1 は 1.3 にアップグレードされ、1.5 は 1.7 にアップグレードされ、他のバージョンは変わりません。
1.5 と 2.0 を許可する複数バージョンのオーバーライドでは、1.7 にアップグレードする同じ互換性レベルのバージョンがないため、エラーが発生します。
1.9 と 2.0 を許可する複数バージョンのオーバーライドでは、解決前に依存関係グラフに 1.9 が存在しないため、エラーが発生します。

さらに、ユーザーは単一バージョンのオーバーライドと同様に、registry 属性を使用してレジストリをオーバーライドできます。

レジストリ以外のオーバーライド

レジストリ以外のオーバーライドは、バージョン解決からモジュールを完全に削除します。Bazel は、これらの MODULE.bazel ファイルをレジストリではなく、リポジトリ自体からリクエストします。

Bazel は、次のレジストリ以外のオーバーライドをサポートしています。

リポジトリ名と厳密な依存関係

モジュールをバッキングするリポジトリの正規名は module_name~version です（例: bazel_skylib~1.0.3）。レジストリ以外のオーバーライドがあるモジュールの場合は、version の部分を文字列 override に置き換えます。正規名の形式は API ではなく、いつでも変更される可能性があります。

モジュールを直接依存関係にバインドするリポジトリの表示名は、bazel_dep ディレクティブの repo_name 属性で指定されていない限り、デフォルトでモジュール名になります。つまり、モジュールは直接依存関係のみを見つけることができます。これにより、伝播依存関係の変更による意図しない破損を防ぐことができます。

モジュール拡張機能を使用すると、モジュールの公開スコープに追加のリポジトリを導入することもできます。