Modul Bazel

Laporkan masalah Lihat sumber

Modul Bazel adalah project Bazel yang dapat memiliki beberapa versi, yang masing-masing memublikasikan metadata tentang modul lain yang menjadi tempatnya bergantung. Hal ini analog dengan konsep umum dalam sistem pengelolaan dependensi lainnya, seperti artefak Maven, paket npm, modul Go, atau peti Cargo.

Modul harus memiliki file MODULE.bazel di root repo-nya. File ini adalah manifes modul, yang mendeklarasikan nama, versi, daftar dependensi langsung, dan informasi lainnya. Untuk contoh dasar:

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

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

Lihat daftar lengkap perintah yang tersedia dalam file MODULE.bazel.

Untuk melakukan resolusi modul, Bazel memulai dengan membaca file MODULE.bazel modul root, lalu berulang kali meminta file MODULE.bazel dependensi apa pun dari registry Bazel hingga menemukan seluruh grafik dependensi.

Secara default, Bazel lalu memilih satu versi dari setiap modul untuk digunakan. Bazel merepresentasikan setiap modul dengan repo, dan berkonsultasi lagi dengan registry untuk mempelajari cara menentukan setiap repo.

Format versi

Bazel memiliki ekosistem yang beragam dan project menggunakan berbagai skema pembuatan versi. Sejauh ini yang paling populer adalah SemVer, tetapi ada juga project terkemuka yang menggunakan skema berbeda seperti Abseil, yang versinya didasarkan pada tanggal, misalnya 20210324.2).

Karena alasan ini, Bzlmod mengadopsi versi spesifikasi SemVer yang lebih longgar. Perbedaannya mencakup:

  • SemVer menentukan bahwa bagian "rilis" dari versi harus terdiri dari 3 segmen: MAJOR.MINOR.PATCH. Di Bazel, persyaratan ini dilonggarkan sehingga sejumlah segmen diizinkan.
  • Di SemVer, masing-masing segmen di bagian "release" harus berupa digit saja. Pada Bazel, hal ini dilonggarkan untuk mengizinkan huruf juga, dan semantik perbandingan cocok dengan "ID" di bagian "prarilis".
  • Selain itu, semantik peningkatan versi utama, minor, dan patch tidak diterapkan. Namun, lihat tingkat kompatibilitas untuk mengetahui detail cara kami menunjukkan kompatibilitas mundur.

Versi SemVer yang valid adalah versi modul Bazel yang valid. Selain itu, dua versi SemVer a dan b akan membandingkan a < b jika dan hanya jika hal yang sama berlaku jika dibandingkan sebagai versi modul Bazel.

Pemilihan versi

Pertimbangkan masalah dependensi berlian, yang merupakan hal utama dalam ruang pengelolaan dependensi berversi. Misalkan Anda memiliki grafik dependensi:

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

Versi D mana yang harus digunakan? Untuk mengatasi pertanyaan ini, Bzlmod menggunakan algoritma Pemilihan Versi Minimal (MVS) yang diperkenalkan dalam sistem modul Go. MVS mengasumsikan bahwa semua versi baru modul kompatibel dengan versi sebelumnya, sehingga memilih versi tertinggi yang ditentukan oleh dependen mana pun (D 1.1 dalam contoh). Ini disebut "minimal" karena D 1.1 adalah versi paling awal yang dapat memenuhi persyaratan kita — meskipun D 1.2 atau yang lebih baru ada, kita tidak memilihnya. Penggunaan MVS akan menciptakan proses pemilihan versi yang berkualitas tinggi dan dapat direproduksi.

Versi Yanked

Registry dapat mendeklarasikan versi tertentu sebagai yanked jika harus dihindari (misalnya untuk kerentanan keamanan). Bazel menampilkan error saat memilih versi modul yang ditarik. Untuk memperbaiki error ini, upgrade ke versi yang lebih baru dan tidak ditarik, atau gunakan flag --allow_yanked_versions untuk mengizinkan versi yanked secara eksplisit.

Tingkat kompatibilitas

Dalam Go, asumsi MVS tentang kompatibilitas mundur berfungsi karena memperlakukan versi mundur modul yang tidak kompatibel sebagai modul terpisah. Dalam hal SemVer, itu berarti A 1.x dan A 2.x dianggap sebagai modul yang berbeda, dan dapat berdampingan dalam grafik dependensi yang di-resolve. Hal ini kemudian dapat dilakukan dengan encoding versi utama dalam jalur paket di Go, sehingga tidak ada konflik waktu kompilasi atau waktu penautan.

Namun, Bazel tidak dapat memberikan jaminan tersebut, sehingga memerlukan nomor "versi utama" untuk mendeteksi versi yang tidak kompatibel dengan versi sebelumnya. Nomor ini disebut tingkat kompatibilitas, dan ditentukan oleh setiap versi modul dalam perintah module(). Dengan informasi ini, Bazel dapat menampilkan error saat mendeteksi bahwa versi modul yang sama dengan tingkat kompatibilitas yang berbeda ada dalam grafik dependensi yang di-resolve.

Mengganti

Tentukan penggantian dalam file MODULE.bazel untuk mengubah perilaku resolusi modul Bazel. Hanya penggantian modul root yang berlaku — jika modul digunakan sebagai dependensi, penggantiannya akan diabaikan.

Setiap penggantian ditentukan untuk nama modul tertentu, yang memengaruhi semua versinya dalam grafik dependensi. Meskipun hanya penggantian modul root yang berlaku, penggantian ini dapat terjadi untuk dependensi transitif yang tidak langsung diandalkan oleh modul root.

Penggantian versi tunggal

single_version_override memiliki beberapa tujuan:

  • Dengan atribut version, Anda dapat menyematkan dependensi ke versi tertentu, terlepas dari versi dependensi yang diminta dalam grafik dependensi.
  • Dengan atribut registry, Anda dapat memaksa dependensi ini agar berasal dari registry tertentu, bukan mengikuti proses pemilihan registry normal.
  • Dengan atribut patch*, Anda dapat menentukan kumpulan patch yang akan diterapkan ke modul yang didownload.

Semua atribut ini bersifat opsional dan dapat dicampur dan dicocokkan satu sama lain.

Penggantian beberapa versi

multiple_version_override dapat ditentukan untuk memungkinkan beberapa versi modul yang sama hidup berdampingan dalam grafik dependensi yang telah di-resolve.

Anda dapat menentukan daftar eksplisit versi yang diizinkan untuk modul, yang semuanya harus ada dalam grafik dependensi sebelum penyelesaian — harus ada beberapa dependensi transitif yang bergantung pada setiap versi yang diizinkan. Setelah resolusi, hanya versi modul yang diizinkan yang tersisa, sedangkan Bazel mengupgrade versi modul lain ke versi terdekat yang diizinkan dan lebih tinggi pada tingkat kompatibilitas yang sama. Jika tidak ada versi yang lebih tinggi yang diizinkan pada tingkat kompatibilitas yang sama, Bazel akan menampilkan error.

Misalnya, jika versi 1.1, 1.3, 1.5, 1.7, dan 2.0 sudah ada dalam grafik dependensi sebelum penyelesaian dan versi utamanya adalah tingkat kompatibilitas:

  • Penggantian beberapa versi yang memungkinkan 1.3, 1.7, dan 2.0 menyebabkan 1.1 diupgrade ke 1.3, 1.5 diupgrade ke 1.7, dan versi lainnya tetap sama.
  • Penggantian beberapa versi yang mengizinkan 1.5 dan 2.0 akan menghasilkan error, karena 1.7 tidak memiliki versi yang lebih tinggi dengan tingkat kompatibilitas yang sama untuk diupgrade.
  • Penggantian beberapa versi yang mengizinkan 1.9 dan 2.0 akan menghasilkan error, karena 1.9 tidak ada dalam grafik dependensi sebelum penyelesaian.

Selain itu, pengguna juga dapat mengganti registry menggunakan atribut registry, mirip dengan penggantian versi tunggal.

Penggantian non-registry

Penggantian non-registry sepenuhnya menghapus modul dari resolusi versi. Bazel tidak meminta file MODULE.bazel ini dari registry, melainkan dari repo itu sendiri.

Bazel mendukung penggantian non-registry berikut:

Menentukan repositori yang tidak merepresentasikan modul Bazel

Dengan bazel_dep, Anda dapat menentukan repositori yang merepresentasikan modul Bazel lainnya. Terkadang, Anda perlu menentukan repo yang tidak merepresentasikan modul Bazel; misalnya, repo yang berisi file JSON biasa untuk dibaca sebagai data.

Dalam hal ini, Anda dapat menggunakan perintah use_repo_rule untuk secara langsung menentukan repo dengan memanggil aturan repo. Repositori ini hanya akan terlihat oleh modul tempatnya ditentukan.

Pada dasarnya, hal ini diimplementasikan menggunakan mekanisme yang sama seperti ekstensi modul, yang memungkinkan Anda menentukan repo dengan lebih fleksibilitas.

Nama repositori dan dependensi ketat

Nama jelas repo yang mendukung modul ke dependensi langsungnya akan ditetapkan secara default ke nama modulnya, kecuali jika atribut repo_name dari perintah bazel_dep menentukan sebaliknya. Perhatikan bahwa ini berarti modul hanya dapat menemukan dependensi langsungnya. Hal ini membantu mencegah kerusakan yang tidak disengaja karena perubahan pada dependensi transitif.

Nama kanonis repo yang mendukung modul adalah module_name~version (misalnya, bazel_skylib~1.0.3) atau module_name~ (misalnya, bazel_features~), bergantung pada apakah ada beberapa versi modul di seluruh grafik dependensi (lihat multiple_version_override). Perhatikan bahwa format nama kanonis bukanlah API yang harus Anda andalkan dan dapat berubah kapan saja. Daripada melakukan hard-coding terhadap nama kanonis, gunakan cara yang didukung untuk mendapatkannya langsung dari Bazel: * Dalam file BUILD dan .bzl, gunakan Label.repo_name pada instance Label yang dibuat dari string label yang diberikan oleh nama jelas repo, misalnya, Label("@bazel_skylib").repo_name. * Saat mencari runfile, gunakan $(rlocationpath ...) atau salah satu library runfile di @bazel_tools//tools/{bash,cpp,java}/runfiles atau, untuk kumpulan aturan rules_foo, di @rules_foo//foo/runfiles. * Saat berinteraksi dengan Bazel dari alat eksternal seperti IDE atau server bahasa, gunakan perintah bazel mod dump_repo_mapping untuk mendapatkan pemetaan dari nama yang jelas ke nama kanonis untuk sekumpulan repositori tertentu.

Ekstensi modul juga dapat memperkenalkan repositori tambahan ke dalam cakupan modul yang terlihat.