Untuk dokumentasi rilis stabil, gunakan menu drop-down "Dokumen berversi". Tampilan default mencerminkan versi terbaru di HEAD.

Halaman ini diterjemahkan oleh Cloud Translation API.

Membuat Pekerja Persisten

Laporkan masalah Lihat sumber

Pekerja persisten bisa membuat build Anda lebih cepat. Jika Anda memiliki tindakan berulang dalam build yang memiliki biaya startup tinggi atau akan memperoleh manfaat dari cache lintas tindakan, Anda dapat mengimplementasikan pekerja persisten Anda sendiri untuk melakukan tindakan ini.

Server Bazel berkomunikasi dengan pekerja menggunakan stdin/stdout. Server Bazel mendukung penggunaan buffering protokol atau string JSON.

Implementasi pekerja memiliki dua bagian:

Pekerja.
Aturan yang menggunakan pekerja.

Membuat pekerja

Pekerja persisten menjunjung beberapa persyaratan:

Fungsi ini membaca WorkRequests dari stdin-nya.
API ini menulis WorkResponses (dan hanya WorkResponse) ke stdout-nya.
Flag ini menerima flag --persistent_worker. Wrapper harus mengenali tanda command line --persistent_worker dan hanya akan bertahan jika tanda tersebut diteruskan. Jika tidak, kode harus melakukan kompilasi satu kali, lalu keluar.

Jika program Anda menjunjung persyaratan ini, program tersebut dapat digunakan sebagai pekerja persisten.

Permintaan pekerjaan

WorkRequest berisi daftar argumen untuk pekerja, daftar pasangan ringkasan jalur yang mewakili input yang dapat diakses pekerja (ini tidak diterapkan, tetapi Anda dapat menggunakan info ini untuk menyimpan cache), dan ID permintaan, yaitu 0 untuk pekerja singleplex.

CATATAN: Meskipun spesifikasi buffering protokol menggunakan "snake case" (request_id), protokol JSON menggunakan "camel case" (requestId). Dokumen ini menggunakan camel case dalam contoh JSON, tetapi snake case saat membahas kolom, terlepas dari protokolnya.

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

Kolom verbosity opsional dapat digunakan untuk meminta output proses debug tambahan dari pekerja. Pekerja bergantung sepenuhnya pada apa dan bagaimana cara menghasilkan output. Nilai yang lebih tinggi menunjukkan output yang lebih panjang. Meneruskan flag --worker_verbose ke Bazel akan menetapkan kolom verbosity ke 10, tetapi nilai yang lebih kecil atau lebih besar dapat digunakan secara manual untuk jumlah output yang berbeda.

Kolom sandbox_dir opsional hanya digunakan oleh pekerja yang mendukung sandbox multipleks.

Respons kerja

WorkResponse berisi ID permintaan, kode keluar dengan nilai nol atau bukan nol, dan string output yang menjelaskan error yang terjadi dalam memproses atau mengeksekusi permintaan. Kolom output berisi deskripsi singkat; log lengkap dapat ditulis ke stderr pekerja. Karena pekerja hanya dapat menulis WorkResponses ke stdout, biasanya pekerja mengalihkan stdout dari alat apa pun yang digunakannya ke stderr.

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

Sesuai dengan standar protobuf, semua kolom bersifat opsional. Namun, Bazel memerlukan WorkRequest dan WorkResponse yang sesuai untuk memiliki ID permintaan yang sama, sehingga ID permintaan harus ditentukan jika bukan nol. Ini adalah WorkResponse yang valid.

{
  "requestId" : 12,
}

request_id dari 0 menunjukkan permintaan "singleplex", yang digunakan saat permintaan ini tidak dapat diproses secara paralel dengan permintaan lain. Server menjamin bahwa pekerja tertentu menerima permintaan hanya dengan request_id 0 atau hanya request_id yang lebih besar dari nol. Permintaan singleplex dikirim secara serial, misalnya jika server tidak mengirim permintaan lain hingga menerima respons (kecuali untuk permintaan pembatalan, lihat di bawah).

Catatan

Setiap buffering protokol didahului dengan panjangnya dalam format varint (lihat MessageLite.writeDelimitedTo().
Permintaan dan respons JSON tidak didahului dengan indikator ukuran.
Permintaan JSON menerapkan struktur yang sama dengan protobuf, tetapi menggunakan JSON standar dan menggunakan camel case untuk semua nama kolom.
Untuk mempertahankan properti kompatibilitas mundur dan maju yang sama seperti protobuf, pekerja JSON harus menoleransi kolom yang tidak diketahui dalam pesan ini, dan menggunakan default protobuf untuk nilai yang tidak ada.
Bazel menyimpan permintaan sebagai protobuf dan mengonversinya menjadi JSON menggunakan format JSON protobuf

Peredam Bising

Pekerja dapat secara opsional mengizinkan permintaan pekerjaan dibatalkan sebelum mereka selesai. Hal ini sangat berguna dalam kaitannya dengan eksekusi dinamis, karena eksekusi lokal dapat sering terganggu oleh eksekusi jarak jauh yang lebih cepat. Untuk mengizinkan pembatalan, tambahkan supports-worker-cancellation: 1 ke kolom execution-requirements (lihat di bawah) dan tetapkan flag --experimental_worker_cancellation.

Permintaan pembatalan adalah WorkRequest dengan kolom cancel yang ditetapkan (dan serupa dengan respons pembatalan adalah WorkResponse dengan kolom was_cancelled). Satu-satunya kolom lain yang harus ada dalam permintaan pembatalan atau respons pembatalan adalah request_id, yang menunjukkan permintaan mana yang akan dibatalkan. Kolom request_id akan menjadi 0 untuk pekerja singleplex atau request_id non-0 dari WorkRequest yang dikirim sebelumnya untuk pekerja multipleks. Server dapat mengirim permintaan pembatalan untuk permintaan yang sudah direspons oleh pekerja, dalam hal ini permintaan pembatalan harus diabaikan.

Setiap pesan WorkRequest yang bukan pembatalan harus dijawab tepat sekali, baik dibatalkan atau dibatalkan. Setelah server mengirim permintaan pembatalan, pekerja dapat merespons dengan WorkResponse dengan menetapkan request_id dan kolom was_cancelled ditetapkan ke true. Mengirim WorkResponse reguler juga diterima, tetapi kolom output dan exit_code akan diabaikan.

Setelah respons dikirim untuk WorkRequest, pekerja tidak boleh menyentuh file dalam direktori kerjanya. Server bebas membersihkan file, termasuk file sementara.

Membuat aturan yang menggunakan pekerja

Anda juga harus membuat aturan yang menghasilkan tindakan untuk dilakukan oleh pekerja. Membuat aturan Starlark yang menggunakan pekerja sama seperti membuat aturan lainnya.

Selain itu, aturan harus berisi referensi ke pekerja itu sendiri, dan ada beberapa persyaratan untuk tindakan yang dihasilkannya.

Merujuk ke pekerja

Aturan yang menggunakan pekerja harus berisi kolom yang merujuk pada pekerja itu sendiri, sehingga Anda harus membuat instance aturan \*\_binary untuk menentukan pekerja Anda. Jika pekerja Anda dipanggil MyWorker.Java, ini mungkin adalah aturan terkait:

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

Tindakan ini akan membuat label "pekerja", yang mengacu pada biner pekerja. Kemudian, tentukan aturan yang menggunakan pekerja. Aturan ini harus menentukan atribut yang merujuk pada biner pekerja.

Jika biner pekerja yang Anda build berada dalam paket bernama "work", yang berada di level teratas build, hal ini mungkin merupakan definisi atribut:

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

cfg = "exec" menunjukkan bahwa pekerja harus dibuat untuk berjalan di platform eksekusi Anda, bukan di platform target (yaitu, pekerja digunakan sebagai alat selama build).

Persyaratan tindakan kerja

Aturan yang menggunakan pekerja membuat tindakan untuk dilakukan oleh pekerja. Tindakan ini memiliki beberapa persyaratan.

Kolom "arguments". Tindakan ini memerlukan daftar string, semuanya kecuali yang terakhir, merupakan argumen yang diteruskan ke pekerja saat memulai. Elemen terakhir dalam daftar "argumen" adalah argumen flag-file (@-preceded). Pekerja membaca argumen dari flagfile yang ditentukan berdasarkan per-WorkRequest. Aturan Anda dapat menulis argumen non-startup untuk pekerja ke flagfile ini.
Kolom "execution-requirements", yang menggunakan kamus yang berisi "supports-workers" : "1", "supports-multiplex-workers" : "1", atau keduanya.

Kolom "arguments" dan "execution-requirements" diperlukan untuk semua tindakan yang dikirim ke pekerja. Selain itu, tindakan yang harus dijalankan oleh pekerja JSON harus menyertakan "requires-worker-protocol" : "json" dalam kolom persyaratan eksekusi. "requires-worker-protocol" : "proto" juga merupakan persyaratan eksekusi yang valid, meskipun tidak diperlukan untuk pekerja proto, karena merupakan default.

Anda juga dapat menetapkan worker-key-mnemonic di persyaratan eksekusi. Hal ini mungkin berguna jika Anda menggunakan kembali file yang dapat dieksekusi untuk beberapa jenis tindakan dan ingin membedakan tindakan berdasarkan pekerja ini.
File sementara yang dibuat selama tindakan tersebut harus disimpan ke direktori pekerja. Tindakan ini akan mengaktifkan sandbox.

Dengan asumsi definisi aturan dengan atribut "pekerja" yang dijelaskan di atas, selain atribut "srcs" yang mewakili input, atribut "output" yang mewakili output, dan atribut "args" yang mewakili argumen startup pekerja, panggilan ke ctx.actions.run mungkin:

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"]
 )

Untuk contoh lainnya, lihat Mengimplementasikan pekerja persisten.

Contoh

Code base Bazel menggunakan pekerja compiler Java, selain contoh pekerja JSON yang digunakan dalam pengujian integrasi kami.

Anda dapat menggunakan scaffolding untuk membuat alat berbasis Java menjadi pekerja dengan meneruskan callback yang benar.

Untuk contoh aturan yang menggunakan pekerja, lihat pengujian integrasi pekerja Bazel.

Kontributor eksternal telah menerapkan pekerja dalam berbagai bahasa; lihat implementasi Polyglot untuk pekerja persisten Bazel. Anda dapat menemukan lebih banyak contoh di GitHub.