Bazel Kilit Dosyası

Bazel'deki kilit dosyası özelliği, bir projenin gerektirdiği yazılım kitaplıklarının veya paketlerin belirli sürümlerinin ya da bağımlılıklarının kaydedilmesini sağlar. Bunu, modül çözünürlüğü ve uzantı değerlendirmesinin sonucunu depolayarak yapar. Kilit dosyası, tutarlı geliştirme ortamları sağlayarak yeniden üretilebilir derlemeleri destekler. Ayrıca, Bazel'ın çözüm sürecinin proje bağımlılıklarındaki değişikliklerden etkilenmeyen kısımları atlamasına olanak tanıyarak yapı verimliliğini de artırır. Ayrıca kilit dosyası, harici kitaplıklarda beklenmedik güncellemeleri veya bozucu değişiklikleri önleyerek kararlılığı artırır ve böylece hata oluşturma riskini azaltır.

Kilit dosyası oluşturma

Kilit dosyası, MODULE.bazel.lock adlı çalışma alanı kökü altında oluşturulur. Derleme işlemi sırasında, özellikle modül çözümleme ve uzantı değerlendirmesinden sonra oluşturulur veya güncellenir. Önemli bir nokta, yalnızca derlemenin mevcut çağrısına dahil edilen bağımlılıkları içermesidir.

Projede bağımlılıkları etkileyen değişiklikler olduğunda kilit dosyası yeni durumu yansıtacak şekilde otomatik olarak güncellenir. Bu, kilit dosyasının mevcut derleme için gereken belirli bağımlılıklar kümesine odaklanmasını ve projenin çözülmüş bağımlılıklarını doğru bir şekilde göstermesini sağlar.

Kilit Dosyası Kullanımı

Kilit dosyası, proje durumu kilit dosyasından farklı olduğunda Bazel'in davranışını özelleştirmek için --lockfile_mode işaretiyle kontrol edilebilir. Kullanılabilir modlar şunlardır:

  • update (Varsayılan): Bilinen kayıt defteri dosyalarının indirilmesini atlamak ve sonuçları hâlâ güncel olan uzantıları yeniden değerlendirmekten kaçınmak için kilit dosyasında bulunan bilgileri kullanın. Eksik bilgiler kilit dosyasına eklenir. Bu modda Bazel, değişmeyen bağımlılıklarda da geri çekilen sürümler gibi değişken bilgileri yenilemekten kaçınır.
  • refresh: update gibi, ancak bu moda geçiş yapıldığında değişken bilgiler her zaman ve bu moddayken yaklaşık olarak saatte bir yenilenir.
  • error: update ile aynıdır ancak herhangi bir bilgi eksikse veya güncel değilse Bazel bir hatayla başarısız olur. Bu mod, kilit dosyasını hiçbir zaman değiştirmez veya çözüm sırasında ağ istekleri gerçekleştirmez. Kendilerini reproducible olarak işaretleyen modül uzantıları yine de ağ istekleri gerçekleştirebilir ancak her zaman aynı sonucu vermesi beklenir.
  • off: Kilit dosyası kontrol edilmez veya güncellenmez.

Kilit dosyası avantajları

Kilit dosyası çeşitli avantajlar sunar ve çeşitli şekillerde kullanılabilir:

  • Yeniden oluşturulabilir derlemeler. Kilit dosyası, yazılım kitaplıklarının belirli sürümlerini veya bağımlılıklarını yakalayarak derlemelerin farklı ortamlarda ve zaman içinde yeniden üretilebilir olmasını sağlar. Geliştiriciler, projelerini oluştururken tutarlı ve tahmin edilebilir sonuçlara güvenebilir.

  • Hızlı artımlı çözünürlükler. Kilit dosyası, Bazel'in daha önce bir derlemede kullanılmış kayıt defteri dosyalarını indirmesini önler. Bu, özellikle çözümün zaman alıcı olabileceği senaryolarda derleme verimliliğini önemli ölçüde artırır.

  • Kararlılık ve risk azaltma. Kilit dosyası, beklenmeyen güncellemeleri önleyerek veya harici kitaplıklarda değişiklikleri bozarak kararlılığı korumaya yardımcı olur. Bağımlılıkları belirli sürümlere kilitleyerek, uyumsuz veya test edilmemiş güncellemelerden kaynaklanan hata oluşması riskini azaltır.

Kilit dosyası içeriği

Kilit dosyası, proje durumunun değişip değişmediğini belirlemek için gerekli tüm bilgileri içerir. Ayrıca projeyi mevcut haliyle kurmanın sonucunu da içerir. Kilit dosyası iki ana bölümden oluşur:

  1. Modül çözme işlemine giriş olan tüm uzak dosyaların karma oluşturma işlemleri.
  2. Kilit dosyası, her bir modül uzantısı için onu etkileyen girişleri (bzlTransitiveDigest, usagesDigest ve diğer alanlarla temsil edilen) ve bu uzantıyı çalıştırmanın çıkışını (generatedRepoSpecs olarak adlandırılır) içerir

Aşağıda, kilit dosyasının yapısını ve her bölümün açıklamalarını gösteren bir örnek verilmiştir:

{
  "lockFileVersion": 10,
  "registryFileHashes": {
    "https://bcr.bazel.build/bazel_registry.json": "8a28e4af...5d5b3497",
    "https://bcr.bazel.build/modules/foo/1.0/MODULE.bazel": "7cd0312e...5c96ace2",
    "https://bcr.bazel.build/modules/foo/2.0/MODULE.bazel": "70390338... 9fc57589",
    "https://bcr.bazel.build/modules/foo/2.0/source.json": "7e3a9adf...170d94ad",
    "https://registry.mycorp.com/modules/foo/1.0/MODULE.bazel": "not found",
    ...
  },
  "selectedYankedVersions": {
    "foo@2.0": "Yanked for demo purposes"
  },
  "moduleExtensions": {
    "//:extension.bzl%lockfile_ext": {
      "general": {
        "bzlTransitiveDigest": "oWDzxG/aLnyY6Ubrfy....+Jp6maQvEPxn0pBM=",
        "usagesDigest": "aLmqbvowmHkkBPve05yyDNGN7oh7QE9kBADr3QIZTZs=",
        ...,
        "generatedRepoSpecs": {
          "hello": {
            "bzlFile": "@@//:extension.bzl",
            ...
          }
        }
      }
    },
    "//:extension.bzl%lockfile_ext2": {
      "os:macos": {
        "bzlTransitiveDigest": "oWDzxG/aLnyY6Ubrfy....+Jp6maQvEPxn0pBM=",
        "usagesDigest": "aLmqbvowmHkkBPve05y....yDNGN7oh7r3QIZTZs=",
        ...,
        "generatedRepoSpecs": {
          "hello": {
            "bzlFile": "@@//:extension.bzl",
            ...
          }
        }
      },
      "os:linux": {
        "bzlTransitiveDigest": "eWDzxG/aLsyY3Ubrto....+Jp4maQvEPxn0pLK=",
        "usagesDigest": "aLmqbvowmHkkBPve05y....yDNGN7oh7r3QIZTZs=",
        ...,
        "generatedRepoSpecs": {
          "hello": {
            "bzlFile": "@@//:extension.bzl",
            ...
          }
        }
      }
    }
  }
}

Kayıt Defteri Dosyası Karmaları

registryFileHashes bölümü, modül çözümlemesi sırasında erişilen uzaktan kayıt defterlerindeki tüm dosyaların karmalarını içerir. Aynı girişler sağlandığında ve tüm uzak girişlere karma oluşturma işlemi uygulandığında çözüm algoritması tamamen deterministik olduğundan bu, kilit dosyasında uzak bilgilerin aşırı tekrarlanmasını önlerken tamamen yeniden üretilebilir bir çözüm sonucu sağlar. Bu işlemin, belirli bir kayıt defterinin belirli bir modülü içermediği ancak daha düşük önceliğe sahip bir kayıt defteri içermesi durumunda da kayıt gerektirdiğini unutmayın (örnekteki "bulunamadı" girişine bakın). Doğası gereği değişken olan bu bilgiler bazel mod deps --lockfile_mode=refresh aracılığıyla güncellenebilir.

Bazel, indirmeden önce kayıt defteri dosyalarını depolama alanı önbelleğinden aramak için kilit dosyasında bulunan karma oluşturma işlemlerini kullanır. Bu da sonraki çözümleri hızlandırır.

Seçilen Yanklanan Sürümler

selectedYankedVersions bölümü, modül çözünürlüğü tarafından seçilen modüllerin yankılanmış sürümlerini içerir. Bu durum, derleme sırasında genellikle bir hatayla sonuçlandığından yalnızca yankılanan sürümlere --allow_yanked_versions veya BZLMOD_ALLOW_YANKED_VERSIONS aracılığıyla açıkça izin verildiğinde bu bölüm boş bırakılamaz.

Modül dosyalarıyla karşılaştırıldığında yankı uygulanmış sürüm bilgileri doğası gereği değişebildiğinden ve bu nedenle karma tarafından referans gösterilemediğinden bu alan gereklidir. Bu bilgiler bazel mod deps --lockfile_mode=refresh üzerinden güncellenebilir.

Modül Uzantıları

moduleExtensions bölümü, yalnızca mevcut çağrıda kullanılan veya daha önce çağrılan uzantıları içeren ve artık kullanılmayan uzantıları hariç tutan bir haritadır. Diğer bir deyişle, bağımlılık grafiğinde artık kullanılmayan uzantılar moduleExtensions haritasından kaldırılır.

Bir uzantı, işletim sisteminden veya mimari türünden bağımsızsa bu bölümde yalnızca tek bir "genel" giriş bulunur. Aksi takdirde, her biri uzantının söz konusu özelliklerle ilgili değerlendirilmesinin sonucuna karşılık gelen, işletim sisteminden, mimariden veya her ikisinden sonra adlandırılmış birden fazla giriş dahil edilir.

Uzantı haritasındaki her giriş, kullanılan bir uzantıya karşılık gelir ve bulunduğu dosya ve adla tanımlanır. Her girişin karşılık gelen değeri, ilgili uzantıyla ilişkili alakalı bilgileri içerir:

  1. bzlTransitiveDigest, uzantı uygulamasının ve geçişli olarak yüklenen .bzl dosyalarının özetidir.
  2. usagesDigest, tüm etiketleri içeren bağımlılık grafiğindeki uzantı kullanımlarının özetidir.
  3. Uzantıdaki diğer girişleri izleyen, belirtilmemiş diğer alanlar (ör. okuduğu dosyaların veya dizinlerin içeriği ya da kullandığı ortam değişkenleri).
  4. generatedRepoSpecs, uzantı tarafından oluşturulan depoları mevcut girişle kodlar.
  5. İsteğe bağlı moduleExtensionMetadata alanı, uzantı tarafından sağlanan meta verileri içerir. Örneğin, oluşturduğu belirli depoların kök modül tarafından use_repo aracılığıyla içe aktarılıp aktarılmayacağı. Bu bilgiler bazel mod tidy komutunu destekler.

Modül uzantıları, döndürülen meta verileri reproducible = True ile ayarlayarak kilit dosyasına dahil edilmeyi devre dışı bırakabilir. Bu sayede, aynı girişler verildiğinde her zaman aynı depoları oluşturacaklarını taahhüt ederler.

En İyi Uygulamalar

Kilit dosyası özelliğinin avantajlarından en iyi şekilde yararlanmak için aşağıdaki en iyi uygulamalardan yararlanabilirsiniz:

  • Kilit dosyasını, proje bağımlılıkları veya yapılandırmadaki değişiklikleri yansıtacak şekilde düzenli olarak güncelleyin. Bu, sonraki derlemelerin en güncel ve doğru bağımlılık gruplarına dayanmasını sağlar. Tüm uzantıları tek seferde kilitlemek için bazel mod deps --lockfile_mode=update komutunu çalıştırın.

  • İş birliğini kolaylaştırmak ve tüm ekip üyelerinin aynı kilit dosyasına erişmesini sağlamak için kilit dosyasını sürüm kontrolüne dahil ederek proje genelinde tutarlı geliştirme ortamları oluşturun.

  • Bazel'i çalıştırmak için bazelisk kullanın ve sürüm kontrolüne, kilit dosyasına karşılık gelen Bazel sürümünü belirten bir .bazelversion dosyası ekleyin. Bazel'in kendisi derlemenize bir bağımlılık olduğundan, kilit dosyası Bazel sürümüne özgüdür ve geriye dönük uyumlu Bazel sürümleri arasında bile değişir. bazelisk kullanılması, tüm geliştiricilerin kilit dosyasıyla eşleşen bir Bazel sürümü kullanmasını sağlar.

Bu en iyi uygulamaları izleyerek Bazel'deki kilit dosyası özelliğini etkili bir şekilde kullanarak daha verimli, güvenilir ve ortak çalışmaya dayalı yazılım geliştirme iş akışları elde edebilirsiniz.

Çakışmaları Birleştir

Kilit dosyası biçimi, birleştirme çakışmalarını en aza indirmek için tasarlanmıştır ancak bu çakışmalar yine de yaşanabilir.

Otomatik Çözünürlük

Bazel, bu çakışmaların otomatik olarak çözülmesine yardımcı olmak için özel bir git birleştirme sürücüsü sağlar.

Git deponuzun kökündeki bir .gitattributes dosyasına şu satırı ekleyerek sürücüyü ayarlayın:

# A custom merge driver for the Bazel lockfile.
# https://bazel.build/external/lockfile#automatic-resolution
MODULE.bazel.lock merge=bazel-lockfile-merge

Ardından, sürücüyü kullanmak isteyen her geliştiricinin aşağıdaki adımları uygulayarak sürücüyü bir kez kaydettirmesi gerekir:

  1. jq'yi (1.5 veya sonraki sürümler) yükleyin.
  2. Aşağıdaki komutları çalıştırın:
jq_script=$(curl https://raw.githubusercontent.com/bazelbuild/bazel/master/scripts/bazel-lockfile-merge.jq)
printf '%s\n' "${jq_script}" | less # to optionally inspect the jq script
git config --global merge.bazel-lockfile-merge.name   "Merge driver for the Bazel lockfile (MODULE.bazel.lock)"
git config --global merge.bazel-lockfile-merge.driver "jq -s '${jq_script}' -- %O %A %B > %A.jq_tmp && mv %A.jq_tmp %A"

Manuel Çözüm

registryFileHashes ve selectedYankedVersions alanlarındaki basit birleştirme çakışmaları, çakışmanın her iki tarafındaki tüm girişler korunarak güvenli bir şekilde giderilebilir.

Diğer birleştirme çakışması türleri manuel olarak çözülmemelidir. Bunun yerine:

  1. git reset MODULE.bazel.lock && git checkout MODULE.bazel.lock aracılığıyla kilit dosyasının önceki durumunu geri yükleyin.
  2. MODULE.bazel dosyasında çakışmaları giderin.
  3. Kilit dosyasını güncellemek için bazel mod deps komutunu çalıştırın.