การสร้างผู้ปฏิบัติงานถาวร

รายงานปัญหา ดูซอร์สโค้ด รุ่น Nightly · 8.0 7.4 7.3 · 7.2 · 7.1 · 7.0 · 6.5

ผู้ปฏิบัติงานแบบถาวรช่วยให้บิลด์เร็วขึ้น หากมีการดำเนินการซ้ำๆ ในบิลด์ที่มีต้นทุนเริ่มต้นสูงหรือจะได้ประโยชน์จากการแคชการดำเนินการข้าม คุณอาจต้องใช้งาน Persisted Worker ของคุณเองเพื่อดำเนินการเหล่านี้

เซิร์ฟเวอร์ Bazel จะสื่อสารกับเวิร์กเกอร์โดยใช้ stdin/stdout โดยรองรับการใช้บัฟเฟอร์โปรโตคอลหรือสตริง JSON

การติดตั้งใช้งานผู้ดําเนินการมี 2 ส่วน ได้แก่

• ผู้ปฏิบัติงาน
• กฎที่ใช้ผู้ปฏิบัติงาน

การสร้างผู้ปฏิบัติงาน

ผู้ปฏิบัติงานแบบถาวรต้องปฏิบัติตามข้อกำหนดบางประการ ดังนี้

• โดยจะอ่าน WorkRequests จาก stdin
• โดยจะเขียน WorkResponses (และเฉพาะ WorkResponse) ลงใน stdout
• ยอมรับ Flag --persistent_worker Wrapper ต้องจดจำ--persistent_worker Flag บรรทัดคำสั่งและทำให้ตัวเองคงอยู่เฉพาะในกรณีที่มีการส่ง Flag ดังกล่าว มิเช่นนั้นจะต้องทำการคอมไพล์แบบครั้งเดียวและออก

หากโปรแกรมของคุณเป็นไปตามข้อกำหนดเหล่านี้ ก็สามารถใช้เป็นเวิร์กเกอร์แบบถาวรได้

คำของาน

WorkRequest มีรายการอาร์กิวเมนต์สำหรับเวิร์กเกอร์ รายการคู่เส้นทาง-ข้อมูลสรุปที่แสดงอินพุตที่เวิร์กเกอร์เข้าถึงได้ (ระบบไม่ได้บังคับใช้ แต่คุณใช้ข้อมูลนี้เพื่อแคชได้) และรหัสคำขอ ซึ่งจะเป็น 0 สำหรับเวิร์กเกอร์แบบ Singleplex

หมายเหตุ: แม้ว่าข้อกำหนดของบัฟเฟอร์โปรโตคอลจะใช้ "รูปแบบ Snake Case" (request_id) แต่โปรโตคอล JSON จะใช้ "รูปแบบ Camel Case" (requestId) เอกสารนี้ใช้รูปแบบ Camel Case ในตัวอย่าง JSON แต่ใช้รูปแบบ Snake Case เมื่อพูดถึงฟิลด์โดยไม่คำนึงถึงโปรโตคอล

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

คุณสามารถใช้ช่อง verbosity (ไม่บังคับ) เพื่อขอเอาต์พุตการแก้ไขข้อบกพร่องเพิ่มเติมจากเวิร์กเกอร์ ขึ้นอยู่กับว่าผู้ปฏิบัติงานจะแสดงผลอะไรและอย่างไร ค่าที่สูงขึ้นบ่งบอกถึงเอาต์พุตที่ละเอียดมากขึ้น การส่ง Flag --worker_verbose ไปยัง Bazel จะตั้งค่าช่อง verbosity เป็น 10 แต่คุณใช้ค่าที่เล็กกว่าหรือมากกว่าได้ด้วยตัวเองสำหรับเอาต์พุตจำนวนต่างๆ

ช่อง sandbox_dir ที่ไม่บังคับจะใช้โดยผู้ปฏิบัติงานที่รองรับแซนด์บ็อกซ์แบบหลายช่องเท่านั้น

การตอบกลับงาน

WorkResponse มีรหัสคำขอ รหัสออก 0 หรือไม่ใช่ 0 และสตริงเอาต์พุตที่อธิบายข้อผิดพลาดที่พบระหว่างการประมวลผลหรือดำเนินการตามคำขอ ช่อง output มีคำอธิบายสั้นๆ ระบบอาจเขียนบันทึกที่สมบูรณ์ไปยัง stderr ของผู้ปฏิบัติงาน เนื่องจากผู้ปฏิบัติงานเขียนได้แค่ WorkResponses ไปยัง stdout จึงเป็นเรื่องปกติที่ผู้ปฏิบัติงานจะเปลี่ยนเส้นทาง stdout ของเครื่องมือที่ใช้ไปยัง stderr

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

ไม่จำเป็นต้องกรอกข้อมูลครบทุกช่องตามมาตรฐานของ protobuf อย่างไรก็ตาม Bazel กำหนดให้ WorkRequest และ WorkResponse ที่เกี่ยวข้องต้องมีรหัสคำขอเดียวกัน จึงต้องระบุรหัสคำขอหากไม่ใช่ 0 WorkResponse นี้ถูกต้อง

{
  "requestId" : 12,
}

request_id เท่ากับ 0 บ่งบอกถึงคำขอ "แบบเดี่ยว" ซึ่งจะใช้เมื่อประมวลผลคำขอนี้ควบคู่ไปกับคำขออื่นๆ ไม่ได้ เซิร์ฟเวอร์รับประกันว่าผู้ปฏิบัติงานหนึ่งๆ จะได้รับคำขอที่มี request_id เท่ากับ 0 เท่านั้น หรือมี request_id มากกว่า 0 เท่านั้น ระบบจะส่งคำขอแบบ Singleplex แบบอนุกรม เช่น หากเซิร์ฟเวอร์ไม่ส่งคำขออื่นจนกว่าจะได้รับการตอบกลับ (ยกเว้นคำขอยกเลิก ดูด้านล่าง)

หมายเหตุ

• บัฟเฟอร์โปรโตคอลแต่ละรายการจะมีความยาวในรูปแบบ varint อยู่ด้านหน้า (ดูMessageLite.writeDelimitedTo()
• คำขอและการตอบกลับ JSON จะไม่มีตัวบ่งชี้ขนาดนำหน้า
• คำขอ JSON จะใช้โครงสร้างเดียวกับ protobuf แต่จะใช้ JSON มาตรฐานและใช้รูปแบบตัวพิมพ์ใหญ่และตัวพิมพ์เล็กสลับกันสำหรับชื่อช่องทั้งหมด
• โปรแกรมประมวลผล JSON ต้องยอมรับช่องที่ไม่รู้จักในข้อความเหล่านี้และใช้ค่าเริ่มต้นของ protobuf สำหรับค่าที่ขาดหายไป เพื่อรักษาพร็อพเพอร์ตี้ความเข้ากันได้ย้อนหลังและไปข้างหน้าแบบเดียวกับ protobuf
• Bazel จะจัดเก็บคำขอเป็น protobuf และแปลงเป็น JSON โดยใช้รูปแบบ JSON ของ protobuf

การยกเลิก

ผู้ปฏิบัติงานสามารถเลือกที่จะอนุญาตให้ยกเลิกคำของานก่อนทำเสร็จได้ ซึ่งมีประโยชน์อย่างยิ่งในการเชื่อมต่อกับการดำเนินการแบบไดนามิกที่การดําเนินการในเครื่องอาจถูกขัดจังหวะโดยการดำเนินการระยะไกลที่เร็วกว่าเป็นประจำ หากต้องการอนุญาตการยกเลิก ให้เพิ่ม supports-worker-cancellation: 1 ลงในช่อง execution-requirements (ดูด้านล่าง) แล้วตั้งค่า Flag --experimental_worker_cancellation

คำขอยกเลิกคือ WorkRequest ที่มีการตั้งค่าฟิลด์ cancel (และการตอบกลับการยกเลิกก็เช่นกัน คือ WorkResponse ที่มีการตั้งค่าฟิลด์ was_cancelled) ฟิลด์อื่นเพียงช่องเดียวที่ต้องอยู่ในคำขอยกเลิกหรือการตอบกลับการยกเลิกคือ request_id ซึ่งระบุคำขอที่จะยกเลิก ช่อง request_id จะเท่ากับ 0 สําหรับผู้ทํางานแบบ Singleplex หรือ request_id ที่ไม่ใช่ 0 ของ WorkRequest ที่ส่งไปก่อนหน้านี้สําหรับผู้ทํางานแบบ Multiplex เซิร์ฟเวอร์อาจส่งคำขอยกเลิกสำหรับคำขอที่เจ้าหน้าที่ตอบกลับแล้ว ในกรณีนี้ต้องไม่สนใจคำขอยกเลิก

ข้อความ WorkRequest แต่ละรายการที่ยกเลิกไม่ได้ต้องได้รับการตอบกลับเพียงครั้งเดียว ไม่ว่าจะมีการยกเลิกหรือไม่ก็ตาม เมื่อเซิร์ฟเวอร์ส่งคำขอยกเลิกแล้ว ผู้ปฏิบัติงานอาจตอบกลับด้วย WorkResponse โดยตั้งค่า request_id และตั้งค่าช่อง was_cancelled เป็น "จริง" ระบบยอมรับการส่ง WorkResponse ปกติด้วย แต่จะไม่สนใจฟิลด์ output และ exit_code

เมื่อส่งคำตอบสำหรับ WorkRequest แล้ว ผู้ปฏิบัติงานต้องไม่แตะต้องไฟล์ในไดเรกทอรีการทำงาน เซิร์ฟเวอร์สามารถล้างไฟล์ได้ ซึ่งรวมถึงไฟล์ชั่วคราว

การสร้างกฎที่ใช้แรงงาน

นอกจากนี้ คุณยังต้องสร้างกฎที่จะสร้างการดำเนินการโดยผู้ปฏิบัติงานด้วย การสร้างกฎ Starlark ที่ใช้เวิร์กเกอร์นั้นเหมือนกับการสร้างกฎอื่นๆ

นอกจากนี้ กฎต้องมีข้อมูลอ้างอิงถึงตัวผู้ปฏิบัติงานเอง และการดำเนินการที่เกิดจากกฎมีข้อกำหนดบางอย่าง

การอ้างอิงถึงผู้ปฏิบัติงาน

กฎที่ใช้ผู้ปฏิบัติงานต้องมีช่องที่อ้างอิงถึงตัวผู้ปฏิบัติงานเอง คุณจึงต้องสร้างอินสแตนซ์ของกฎ \*\_binary เพื่อกําหนดผู้ปฏิบัติงาน หากชื่อคนงานคือ MyWorker.Java กฎที่เกี่ยวข้องอาจเป็นดังนี้

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

ซึ่งจะสร้างป้ายกำกับ "worker" ที่หมายถึงไบนารีของ Worker จากนั้นคุณจะกำหนดกฎที่ใช้ผู้ปฏิบัติงาน กฎนี้ควรกำหนดแอตทริบิวต์ซึ่งอ้างอิงถึงไบนารีของเวิร์กเกอร์

หากไบนารีของเวิร์กเกอร์ที่คุณสร้างอยู่ในแพ็กเกจชื่อ "work" ซึ่งอยู่ในระดับบนสุดของบิลด์ คำจำกัดความของแอตทริบิวต์อาจเป็นดังนี้

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

cfg = "exec" บ่งบอกว่าควรสร้างเวิร์กเกอร์ให้ทำงานบนแพลตฟอร์มการดำเนินการของคุณแทนแพลตฟอร์มเป้าหมาย (กล่าวคือ ใช้เวิร์กเกอร์เป็นเครื่องมือระหว่างการบิลด์)

ข้อกำหนดการดําเนินการของงาน

กฎที่ใช้ผู้ปฏิบัติงานจะสร้างการดำเนินการให้ผู้ปฏิบัติงานดำเนินการ การดําเนินการเหล่านี้มีข้อกําหนด 2 ข้อ

• ฟิลด์ "arguments" การดำเนินการนี้จะรับรายการสตริง โดยสตริงทั้งหมดยกเว้นรายการสุดท้ายจะเป็นอาร์กิวเมนต์ที่ส่งไปยังเวิร์กเกอร์เมื่อเริ่มต้น องค์ประกอบสุดท้ายในรายการ "arguments" คืออาร์กิวเมนต์ flag-file (ตามด้วย @) ผู้ปฏิบัติงานจะอ่านอาร์กิวเมนต์จากไฟล์ Flag ที่ระบุตาม WorkRequest แต่ละรายการ กฎของคุณจะเขียนอาร์กิวเมนต์ที่ไม่ใช่การเริ่มต้นสำหรับเวิร์กเกอร์ลงในไฟล์ Flag นี้ได้

• ฟิลด์ "execution-requirements" ซึ่งใช้พจนานุกรมที่มี "supports-workers" : "1", "supports-multiplex-workers" : "1" หรือทั้ง 2 อย่าง

  จำเป็นต้องมีฟิลด์ "arguments" และ "execution-requirements" สำหรับการดำเนินการทั้งหมดที่ส่งไปยังผู้ปฏิบัติงาน นอกจากนี้ การดําเนินการที่ควรดำเนินการโดยผู้ทํางาน JSON ต้องมี "requires-worker-protocol" : "json" ในช่องข้อกําหนดการดําเนินการ "requires-worker-protocol" : "proto" ยังเป็นข้อกำหนดการดำเนินการที่ถูกต้องด้วย แม้ว่าจะไม่จำเป็นสำหรับผู้ปฏิบัติงานระดับโปรโต เนื่องจากเป็นผู้ปฏิบัติงานเริ่มต้น

  นอกจากนี้ คุณยังตั้งค่า worker-key-mnemonic ในข้อกำหนดการดำเนินการได้ด้วย ซึ่งอาจมีประโยชน์ในกรณีที่คุณนําไฟล์ปฏิบัติการไปใช้ซ้ำสําหรับการดําเนินการหลายประเภทและต้องการแยกความแตกต่างของการดำเนินการโดยผู้ดําเนินการนี้

• ไฟล์ชั่วคราวที่สร้างขึ้นในระหว่างการดำเนินการควรบันทึกไว้ในไดเรกทอรีของผู้ใช้ ซึ่งจะเป็นการเปิดใช้แซนด์บ็อกซ์

หมายเหตุ: หากต้องการส่งอาร์กิวเมนต์ที่ขึ้นต้นด้วยลิเทอรัล @ ให้เริ่มต้นอาร์กิวเมนต์ด้วย @@ แทน หากอาร์กิวเมนต์เป็นป้ายกำกับที่เก็บข้อมูลภายนอกด้วย ระบบจะไม่ถือว่าอาร์กิวเมนต์นั้นเป็นอาร์กิวเมนต์ไฟล์ Flag

สมมติว่าคําจํากัดความของกฎมีแอตทริบิวต์ "worker" ตามที่อธิบายไว้ข้างต้น นอกเหนือจากแอตทริบิวต์ "srcs" ที่แสดงอินพุต แอตทริบิวต์ "output" ที่แสดงเอาต์พุต และแอตทริบิวต์ "args" ที่แสดงอาร์กิวเมนต์เริ่มต้นของเวิร์กเกอร์ การเรียก ctx.actions.run อาจมีลักษณะดังนี้

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

ดูตัวอย่างอื่นได้ที่การใช้ PersistedWorker

ตัวอย่าง

ฐานโค้ด Bazel ใช้เวิร์กเกอร์คอมไพเลอร์ Java นอกเหนือจากเวิร์กเกอร์ JSON ตัวอย่างที่ใช้ในการทดสอบการผสานรวม

คุณสามารถใช้สคาฟ์เฟิลดิ้งของเครื่องมือดังกล่าวเพื่อเปลี่ยนเครื่องมือที่ใช้ Java เป็นเวิร์กเกอร์ได้โดยส่งการเรียกกลับที่ถูกต้อง

ดูตัวอย่างกฎที่ใช้ผู้ปฏิบัติงานได้ที่การทดสอบการผสานรวมผู้ปฏิบัติงานของ Bazel

ผู้มีส่วนร่วมภายนอกได้ติดตั้งใช้งาน WOrker ในภาษาต่างๆ มากมาย โปรดดูการใช้งาน WOrker แบบคงที่ของ Bazel ในหลายภาษา คุณสามารถดูตัวอย่างอื่นๆ อีกมากมายใน GitHub