Bazel ロックファイル

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

Bazel のロックファイル機能を使用すると、プロジェクトに必要なソフトウェアライブラリまたはパッケージの特定のバージョンまたは依存関係を記録できます。これは、モジュール解決と拡張機能評価の結果を保存することで実現されます。ロックファイルは再現可能なビルドを促進し、一貫した開発環境を確保します。また、プロジェクトの依存関係に変更がない場合は Bazel が解決プロセスをスキップできるようにすることで、ビルド効率を高めています。さらに、ロックファイルは、外部ライブラリの予期しない更新や互換性を破る変更を防ぐことで安定性を向上させ、バグの発生リスクを軽減します。

ロックファイルの生成

ロックファイルは、ワークスペースのルート下に MODULE.bazel.lock という名前で生成されます。これは、ビルドプロセス（特にモジュール解決と拡張機能の評価後）で作成または更新されます。ロックファイルには、MODULE ファイル、フラグ、オーバーライド、その他の関連情報など、プロジェクトの現在の状態がキャプチャされます。重要なのは、ビルドの現在の呼び出しに含まれる依存関係のみが含まれることです。

プロジェクトに依存関係に影響する変更が加えられると、ロックファイルが自動的に更新され、新しい状態が反映されます。これにより、ロックファイルは現在のビルドに必要な特定の依存関係セットに焦点を当て続け、プロジェクトの解決済み依存関係を正確に表すことができます。

ロックファイルの使用

ロックファイルはフラグ --lockfile_mode で制御でき、プロジェクトの状態がロックファイルと異なる場合に Bazel の動作をカスタマイズできます。使用可能なモードは次のとおりです。

update（デフォルト）: プロジェクトの状態がロックファイルと一致する場合、ロックファイルから解決結果が直ちに返されます。それ以外の場合は、解決が実行され、ロックファイルが更新されて現在の状態が反映されます。
error: プロジェクトの状態がロックファイルと一致する場合、ロックファイルから解決結果が返されます。一致しない場合、Bazel はプロジェクトとロックファイルの差異を示すエラーをスローします。このモードは、プロジェクトの依存関係を変更せず、差異をエラーとして扱う場合に特に便利です。
off: ロックファイルはまったくチェックされません。

ロックファイルのメリット

ロックファイルには次のようなメリットがあり、さまざまな方法で使用できます。

再現可能なビルド。ロックファイルは、ソフトウェアライブラリの特定のバージョンまたは依存関係をキャプチャすることで、さまざまな環境で、また時間の経過とともにビルドを再現できるようにします。デベロッパーは、プロジェクトの構築時に一貫した予測可能な結果を期待できます。
効率的な解決策のスキップ。ロックファイルを使用すると、前回のビルド以降にプロジェクトの依存関係に変更がない場合、Bazel は解決プロセスをスキップできます。これにより、特に解決に時間のかかるシナリオで、ビルド効率が大幅に向上します。
安定性とリスクの軽減。ロックファイルは、外部ライブラリの予期しない更新や破壊的な変更を防ぐことで、安定性を維持するのに役立ちます。依存関係を特定のバージョンにロックすることで、互換性のないアップデートやテストされていないアップデートによるバグの発生リスクを軽減できます。

ロックファイルの内容

ロックファイルには、プロジェクトの状態が変更されたかどうかを判断するために必要な情報がすべて含まれています。また、現在の状態でプロジェクトをビルドした結果も含まれます。ロックファイルは主に 2 つの部分で構成されています。

モジュール解決策の入力（moduleFileHash、flags、localOverrideHashes など）と、解決策の出力（moduleDepGraph）。
ロックファイルには、モジュール拡張機能ごとに、それに影響する入力（transitiveDigest で表されます）と、その拡張機能の実行の出力（generatedRepoSpecs と呼ばれます）が含まれます。

ロックファイルの構造と各セクションの説明を示す例を次に示します。

{
  "lockFileVersion": 1,
  "moduleFileHash": "b0f47b98a67ee15f9.......8dff8721c66b721e370",
  "flags": {
    "cmdRegistries": [
      "https://bcr.bazel.build/"
    ],
    "cmdModuleOverrides": {},
    "allowedYankedVersions": [],
    "envVarAllowedYankedVersions": "",
    "ignoreDevDependency": false,
    "directDependenciesMode": "WARNING",
    "compatibilityMode": "ERROR"
  },
  "localOverrideHashes": {
    "bazel_tools": "b5ae1fa37632140aff8.......15c6fe84a1231d6af9"
  },
  "moduleDepGraph": {
    "<root>": {
      "name": "",
      "version": "",
      "executionPlatformsToRegister": [],
      "toolchainsToRegister": [],
      "extensionUsages": [
        {
          "extensionBzlFile": "extension.bzl",
          "extensionName": "lockfile_ext"
        }
      ],
      ...
    }
  },
  "moduleExtensions": {
    "//:extension.bzl%lockfile_ext": {
      "transitiveDigest": "oWDzxG/aLnyY6Ubrfy....+Jp6maQvEPxn0pBM=",
      "generatedRepoSpecs": {
        "hello": {
          "bzlFile": "@@//:extension.bzl",
          ...
        }
      }
    }
  }
}

モジュールファイルハッシュ

moduleFileHash は、MODULE.bazel ファイルの内容のハッシュを表します。このファイルに変更が加えられると、ハッシュ値は異なります。

フラグ

Flags オブジェクトには、解決結果に影響する可能性のあるすべてのフラグが保存されます。

ローカルオーバーライドハッシュ

ルートモジュールに local_path_overrides が含まれている場合、このセクションには MODULE.bazel ファイルのハッシュがローカルリポジトリに保存されます。これにより、この依存関係の変更を追跡できます。

モジュール依存関係グラフ

moduleDepGraph は、上記の入力を使用して解決プロセスの結果を表します。プロジェクトの実行に必要なすべてのモジュールの依存関係グラフを形成します。

モジュール拡張機能

moduleExtensions セクションは、現在の呼び出しで使用された拡張機能または以前に呼び出された拡張機能のみを含むマップです。使用されていない拡張機能は除外されます。つまり、依存関係グラフ全体で拡張機能が使用されていない場合は、moduleExtensions マップから削除されます。

このマップの各エントリは、使用されている拡張機能に対応しており、そのファイルと名前で識別されます。各エントリに対応する値には、その拡張機能に関連する情報が含まれます。

transitiveDigest は、拡張機能の実装とその伝播 .bzl ファイルのダイジェストです。
generatedRepoSpecs: 現在の入力でその拡張機能を実行した結果。

拡張機能の結果に影響する可能性があるもう 1 つの要因は、拡張機能の使用状況です。ロックファイルには保存されませんが、拡張機能の現在の状態とロックファイル内の状態を比較する際に使用状況が考慮されます。

ベストプラクティス

ロックファイル機能のメリットを最大限に活用するには、次のベストプラクティスを検討してください。

プロジェクトの依存関係や構成の変更を反映するように、ロックファイルを定期的に更新します。これにより、後続のビルドが最新かつ正確な依存関係セットに基づくようになります。
ロックファイルをバージョン管理に含めて、コラボレーションを促進し、すべてのチームメンバーが同じロックファイルにアクセスできるようにして、プロジェクト全体で一貫した開発環境を実現します。

これらのベストプラクティスに従うことで、Bazel のロックファイル機能を効果的に活用し、より効率的で信頼性が高く、コラボレーション重視のソフトウェア開発ワークフローを実現できます。