Kalıcı Çalışanlar Oluşturma

Kalıcı çalışanlar, derlemenizi hızlandırabilir. Derlemenizde başlangıç maliyeti yüksek olan veya işlemler arası önbelleğe alma işleminden faydalanabilecek tekrarlanan işlemler varsa bu işlemleri gerçekleştirmek için kendi kalıcı çalışanınızı uygulamak isteyebilirsiniz.

Bazel sunucusu, çalışanla stdin/stdout kullanarak iletişim kurar. Protokol arabelleklerinin veya JSON dizelerinin kullanımını destekler.

İşçi uygulaması iki bölümden oluşur:

Bir çalışana yardımcı olma

Kalıcı çalışanlar birkaç koşulu karşılamalıdır:

  • stdin öğesinden WorkRequests değerini okur.
  • WorkResponses (ve yalnızca WorkResponse öğeleri) stdout alanına yazılır.
  • --persistent_worker işaretini kabul eder. Sarmalayıcı, --persistent_worker komut satırı işaretini tanımalıdır ve yalnızca bu işaret iletildiyse kendini kalıcı hale getirmelidir. Aksi takdirde tek seferlik bir derleme yapmalı ve çıkmalıdır.

Programınız bu koşulları karşılıyorsa kalıcı bir işleyici olarak kullanılabilir.

İş istekleri

WorkRequest, çalışana yönelik bir bağımsız değişken listesi, çalışanın erişebileceği girişleri temsil eden yol özeti çiftlerinin bir listesi (bu zorunlu değildir ancak önbelleğe alma için bu bilgiyi kullanabilirsiniz) ve singleplex çalışanları için 0 olan istek kimliğini içerir.

NOT: Protokol arabellek spesifikasyonu "yılan büyük/küçük harf" (request_id) kullanırken, JSON protokolünde "deve büyük/küçük harf" (requestId) kullanılır. Bu dokümanda, JSON örneklerinde büyük/küçük harf kullanılır. Ancak protokolden bağımsız olarak alan hakkında konuşurken yılan şeklinde büyük harf kullanılır.

{
  "arguments" : ["--some_argument"],
  "inputs" : [
    { "path": "/path/to/my/file/1", "digest": "fdk3e2ml23d"},
    { "path": "/path/to/my/file/2", "digest": "1fwqd4qdd" }
 ],
  "requestId" : 12
}

İsteğe bağlı verbosity alanı, çalışandan ek hata ayıklama çıkışı istemek için kullanılabilir. Neyin nasıl üretileceği tamamen çalışanın işidir. Daha yüksek değerler daha ayrıntılı çıkış anlamına gelir. --worker_verbose işaretçisi Bazel'e iletildiğinde verbosity alanı 10 olarak ayarlanır ancak farklı çıkış miktarları için manuel olarak daha küçük veya daha büyük değerler kullanılabilir.

İsteğe bağlı sandbox_dir alanı yalnızca çoklu korumalı alan özelliğini destekleyen çalışanlar tarafından kullanılır.

İş yanıtları

WorkResponse, bir istek kimliği, sıfır veya sıfır olmayan bir çıkış kodu ve isteği işleme veya yürütme sırasında karşılaşılan hataları açıklayan bir çıkış dizesi içerir. output alanında kısa bir açıklama bulunur. Günlükler, çalışanın stderr öğesine yazılabilir. Çalışanlar yalnızca WorkResponses'yi stdout'ye yazabileceğinden, kullandığı araçların stdout'sini stderr'ye yönlendirmesi yaygın bir durumdur.

{
  "exitCode" : 1,
  "output" : "Action failed with the following message:\nCould not find input
    file \"/path/to/my/file/1\"",
  "requestId" : 12
}

Protobuflar standardına göre, tüm alanlar isteğe bağlıdır. Ancak Bazel, WorkRequest ve ilgili WorkResponse'nin aynı istek kimliğine sahip olmasını gerektirir. Bu nedenle, sıfırdan farklıysa istek kimliği belirtilmelidir. Bu geçerli bir WorkResponse.

{
  "requestId" : 12,
}

0 değerine sahip bir request_id, "tek kanallı" bir isteği gösterir. Bu istek, diğer isteklerle paralel olarak işlenemediği durumlarda kullanılır. Sunucu, belirli bir çalışanın yalnızca request_id 0 veya yalnızca request_id sıfırdan büyük olan istekler aldığını garanti eder. Singleplex istekler seri olarak gönderilir. Örneğin, sunucu bir yanıt alana kadar başka bir istek göndermezse (iptal istekleri hariç aşağıdaki bilgilere bakın).

Notlar

  • Her protokol arabelleğinden önce varint biçimindeki uzunluğu gelir (bkz. MessageLite.writeDelimitedTo()).
  • JSON isteklerinin ve yanıtlarının önünde bir boyut göstergesi bulunmaz.
  • JSON istekleri, protobuf ile aynı yapıyı korur ancak standart JSON'u kullanır ve tüm alan adları için büyük/küçük harf kullanımını tercih eder.
  • protobuf ile aynı geriye dönük ve ileriye dönük uyumluluk özelliklerini korumak için JSON işleyicilerinin bu mesajlardaki bilinmeyen alanları tolere etmesi ve eksik değerler için protobuf varsayılanlarını kullanması gerekir.
  • Bazel, istekleri protobuf olarak depolar ve protobuf'in JSON biçimini kullanarak JSON'a dönüştürür.

İptal

Çalışanlar, isteğe bağlı olarak iş isteklerinin tamamlanmadan önce iptal edilmesine izin verebilir. Bu, özellikle yerel yürütmenin daha hızlı bir uzak yürütme tarafından düzenli olarak kesintiye uğratılabileceği dinamik yürütmeyle bağlantılı olarak faydalıdır. İptal işlemine izin vermek için execution-requirements alanına supports-worker-cancellation: 1 ekleyin (aşağıya bakın) ve --experimental_worker_cancellation işaretini ayarlayın.

İptal isteği, cancel alanının ayarlandığı bir WorkRequest'dir (benzer şekilde iptal yanıtı, was_cancelled alanının ayarlandığı bir WorkResponse'dir). İptal isteğinde veya iptal yanıtında olması gereken diğer tek alan, hangi isteğin iptal edileceğini belirten request_id alanıdır. request_id alanı, tek yönlü çalışanlar için 0 veya daha önce gönderilmiş WorkRequest olan Multiplex çalışanları için 0 olmayan request_id olacaktır. Sunucu, çalışanın daha önce yanıtladığı istekler için iptal istekleri gönderebilir. Bu durumda, iptal isteğinin yoksayılması gerekir.

İptal edilmemiş her WorkRequest mesajı, iptal edilip edilmediğine bakılmaksızın tam olarak bir kez yanıtlanmalıdır. Sunucu bir iptal isteği gönderdikten sonra, çalışan, request_id ayarlı ve was_cancelled alanının doğru değerine ayarlandığı bir WorkResponse ile yanıt verebilir. Normal bir WorkResponse göndermek de kabul edilir ancak output ve exit_code alanları yoksayılır.

Bir WorkRequest için yanıt gönderildikten sonra işleyici, çalışma dizinindeki dosyalara dokunmamalıdır. Sunucu, geçici dosyalar da dahil olmak üzere dosyaları temizleyebilir.

Çalışanı kullanan kuralı yapmak

Ayrıca, çalışan tarafından gerçekleştirilecek işlemleri oluşturan bir kural oluşturmanız gerekir. İşçi kullanan bir Starlark kuralı oluşturmak, başka bir kural oluşturmaya benzer.

Ayrıca, kuralın işçiye referans vermesi gerekir ve ürettiği işlemler için bazı koşullar vardır.

Çalışana referans verme

Çalışanı kullanan kuralın, çalışanın kendisini ifade eden bir alan içermesi gerekir. Bu nedenle, çalışanınızı tanımlamak için \*\_binary kuralının bir örneğini oluşturmanız gerekir. Çalışanınızın adı MyWorker.Java ise ilişkili kural şu olabilir:

java_binary(
    name = "worker",
    srcs = ["MyWorker.Java"],
)

Bu işlem, çalışan ikilisini belirten "worker" etiketini oluşturur. Ardından, çalışanı kullanan bir kural tanımlarsınız. Bu kural, çalışan ikilisine atıfta bulunan bir özellik tanımlamalıdır.

Derlediğiniz çalışan ikili programı, derlemenin en üst düzeyindeki "iş" adlı bir paketteyse özellik tanımı şu olabilir:

"worker": attr.label(
    default = Label("//work:worker"),
    executable = True,
    cfg = "exec",
)

cfg = "exec", işleyicinin hedef platform yerine yürütme platformunuzda çalışacak şekilde oluşturulması gerektiğini gösterir (yani işleyici, derleme sırasında araç olarak kullanılır).

İş eylemi gereksinimleri

Çalışanı kullanan kural, çalışanın gerçekleştireceği işlemleri oluşturur. Bu işlemler için birkaç koşul vardır.

  • "arguments" alanı. Bu, bir dize listesi alır. Bu dizelerin sonuncusu hariç başlatma sırasında çalışana iletilen bağımsız değişkenlerdir. "Bağımsız değişkenler" listesindeki son öğe, bir flag-file (@ öncesinde sunulan) bağımsız değişkenidir. Çalışanlar, belirtilen işaret dosyasındaki bağımsız değişkenleri WorkRequest başına ayrı olarak okur. Kuralınız, bu işaret dosyasına çalışan için başlatma dışı bağımsız değişkenler yazabilir.

  • "supports-workers" : "1", "supports-multiplex-workers" : "1" veya her ikisini içeren bir sözlük alan "execution-requirements" alanı.

    "arguments" ve "execution-requirements" alanları, çalışanlara gönderilen tüm işlemler için gereklidir. Ayrıca, JSON çalışanları tarafından yürütülmesi gereken işlemlerin yürütme koşulları alanına "requires-worker-protocol" : "json" eklenmesi gerekir. "requires-worker-protocol" : "proto" aynı zamanda geçerli bir yürütme şartıdır ancak varsayılan olarak proto çalışanları için gerekli değildir.

    Ayrıca yürütme koşullarında bir worker-key-mnemonic de ayarlayabilirsiniz. Yürütülebilir dosyayı birden fazla işlem türü için yeniden kullanıyorsanız ve bu çalışanın işlemlerini ayırt etmek istiyorsanız bu özellik yararlı olabilir.

  • İşlem sırasında oluşturulan geçici dosyalar, çalışanın dizinine kaydedilmelidir. Bu, korumalı alanı etkinleştirir.

Yukarıda açıklanan "işçi" özelliğine sahip bir kural tanımı varsayımıyla, girişleri temsil eden bir "srcs" özelliği, çıkışları temsil eden bir "output" özelliği ve işçi başlangıç bağımsız değişkenlerini temsil eden bir "args" özelliğinin yanı sıra ctx.actions.run çağrısı şöyle olabilir:

ctx.actions.run(
  inputs=ctx.files.srcs,
  outputs=[ctx.outputs.output],
  executable=ctx.executable.worker,
  mnemonic="someMnemonic",
  execution_requirements={
    "supports-workers" : "1",
    "requires-worker-protocol" : "json"},
  arguments=ctx.attr.args + ["@flagfile"]
 )

Başka bir örnek için Kalıcı çalışanları uygulama başlıklı makaleyi inceleyin.

Örnekler

Bazel kod tabanı, entegrasyon testlerimizde kullanılan örnek JSON işleyicisinin yanı sıra Java derleyici işleyicileri kullanır.

Doğru geri çağırma işlevini göndererek Java tabanlı herhangi bir aracı işçiye dönüştürmek için bu iskeleti kullanabilirsiniz.

Çalışan kullanan bir kural örneği için Bazel'in çalışan entegrasyon testine göz atın.

Harici katkıda bulunanlar, çalışanları çeşitli dillerde uyguladı. Bazel kalıcı çalışanlarının çok dilli uygulamalarını inceleyin. GitHub'da daha birçok örnek bulabilirsiniz.