ตัวอย่างโปรโตคอลเหตุการณ์การสร้าง

รายงานปัญหา ดูแหล่งที่มา

ดูข้อกำหนดทั้งหมดของโปรโตคอล Build Event ได้ในคำจำกัดความบัฟเฟอร์ของโปรโตคอล อย่างไรก็ตาม การสร้างสัญชาตญาณบางอย่าง ก่อนที่จะดูรายละเอียดข้อกำหนดอาจมีประโยชน์

ลองใช้พื้นที่ทำงาน Bazel แบบง่ายที่ประกอบด้วยสคริปต์ Shell ว่าง 2 รายการ foo.sh และ foo_test.sh และไฟล์ BUILD ต่อไปนี้

sh_library(
    name = "foo_lib",
    srcs = ["foo.sh"],
)

sh_test(
    name = "foo_test",
    srcs = ["foo_test.sh"],
    deps = [":foo_lib"],
)

เมื่อเรียกใช้ bazel test ... ในโปรเจ็กต์นี้ กราฟบิลด์ของเหตุการณ์บิลด์ที่สร้างขึ้นจะคล้ายกับกราฟด้านล่าง ลูกศรแสดงถึงความสัมพันธ์ ของผู้ปกครองและเด็กที่กล่าวไว้ข้างต้น โปรดทราบว่าบางเหตุการณ์บิลด์และช่องส่วนใหญ่ถูกตัดออกเพื่อความสั้นกระชับ

Bep-graph

รูปที่ 1 กราฟ BEP

ในขั้นต้น ระบบจะเผยแพร่เหตุการณ์ BuildStarted เหตุการณ์แจ้งให้เราทราบว่ามีการเรียกใช้บิลด์ผ่านคำสั่ง bazel test และประกาศเหตุการณ์ย่อย ดังนี้

  • OptionsParsed
  • WorkspaceStatus
  • CommandLine
  • UnstructuredCommandLine
  • BuildMetadata
  • BuildFinished
  • PatternExpanded
  • Progress

เหตุการณ์ 3 รายการแรกให้ข้อมูลเกี่ยวกับวิธีการเรียก Bazel

เหตุการณ์บิลด์ PatternExpanded ให้ข้อมูลเชิงลึกเกี่ยวกับเป้าหมายที่เฉพาะเจาะจงในรูปแบบ ... ที่ขยายไปยัง //foo:foo_lib และ //foo:foo_test ซึ่งทำได้โดยการประกาศเหตุการณ์ TargetConfigured 2 รายการเป็นรายการย่อย โปรดทราบว่าเหตุการณ์ TargetConfigured จะประกาศเหตุการณ์ Configuration ว่าเป็นกิจกรรมย่อย แม้ว่า Configuration จะโพสต์ก่อนเหตุการณ์ TargetConfigured ก็ตาม

นอกจากความสัมพันธ์ระดับบนสุดและย่อยแล้ว เหตุการณ์ยังอาจอ้างอิงกันและกันโดยใช้ตัวระบุเหตุการณ์บิลด์ด้วย เช่น ในกราฟด้านบน เหตุการณ์ TargetComplete หมายถึงเหตุการณ์ NamedSetOfFiles ในช่อง fileSets

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

ด้านล่างเป็นเหตุการณ์ TargetComplete ของเป้าหมาย //foo:foo_lib จากกราฟด้านบน ซึ่งพิมพ์ไว้ในการแสดง JSON ของบัฟเฟอร์โปรโตคอล ตัวระบุเหตุการณ์บิลด์มีเป้าหมายเป็นสตริงที่คลุมเครือและอ้างถึงเหตุการณ์ Configuration โดยใช้ตัวระบุเหตุการณ์บิลด์ เหตุการณ์จะไม่ประกาศเหตุการณ์ย่อย เพย์โหลดมีข้อมูลว่าเป้าหมายนี้สร้างสำเร็จหรือไม่ ชุดไฟล์เอาต์พุต และประเภทของเป้าหมายที่สร้าง

{
  "id": {
    "targetCompleted": {
      "label": "//foo:foo_lib",
      "configuration": {
        "id": "544e39a7f0abdb3efdd29d675a48bc6a"
      }
    }
  },
  "completed": {
    "success": true,
    "outputGroup": [{
      "name": "default",
      "fileSets": [{
        "id": "0"
      }]
    }],
    "targetKind": "sh_library rule"
  }
}

ผลลัพธ์ Aspect ใน BEP

บิลด์ทั่วไปจะประเมินการดำเนินการที่เชื่อมโยงกับคู่ (target, configuration) เมื่อสร้างที่เปิดใช้มุมมอง Bazel จะประเมินเป้าหมายที่เชื่อมโยงกับ (target, configuration, aspect) เป้าหมายเพิ่มเติม สำหรับเป้าหมายแต่ละรายการที่ได้รับผลกระทบจากลักษณะที่เปิดใช้ที่กำหนด

ผลการประเมินด้านต่างๆ จะพร้อมใช้งานใน BEP แม้ว่าจะไม่มีประเภทเหตุการณ์ที่เฉพาะเจาะจงตามกลุ่มเป้าหมาย สำหรับ (target, configuration) แต่ละคู่ที่มีแง่มุมที่เกี่ยวข้อง Bazel จะเผยแพร่เหตุการณ์ TargetConfigured และ TargetComplete เพิ่มเติมที่แสดงผลลัพธ์จากการใช้ลักษณะดังกล่าวกับเป้าหมาย ตัวอย่างเช่น หาก //:foo_lib สร้างด้วย --aspects=aspects/myaspect.bzl%custom_aspect เหตุการณ์นี้จะปรากฏใน BEP ด้วย

{
  "id": {
    "targetCompleted": {
      "label": "//foo:foo_lib",
      "configuration": {
        "id": "544e39a7f0abdb3efdd29d675a48bc6a"
      },
      "aspect": "aspects/myaspect.bzl%custom_aspect"
    }
  },
  "completed": {
    "success": true,
    "outputGroup": [{
      "name": "default",
      "fileSets": [{
        "id": "1"
      }]
    }]
  }
}

กำลังใช้ NamedSetOfFiles

การระบุอาร์ติแฟกต์ที่ผลิตโดยเป้าหมาย (หรือแง่มุม) หนึ่งๆ เป็นกรณีการใช้งานทั่วไปของ BEP ที่สามารถดำเนินการได้อย่างมีประสิทธิภาพด้วยการเตรียมพร้อม ส่วนนี้จะอธิบายโครงสร้างที่แชร์ซ้ำๆ ซึ่งนำเสนอโดยเหตุการณ์ NamedSetOfFiles ซึ่งตรงกับโครงสร้างของ Depset ของ Starlark

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

Namesetoffiles-bep-graph

รูปที่ 2 กราฟ BEP ของNamedSetOfFiles

เหตุการณ์ NamedSetOfFiles จะปรากฏในสตรีม BEP เสมอก่อนเหตุการณ์ TargetComplete หรือ NamedSetOfFiles ที่อ้างอิงเหตุการณ์ดังกล่าว ค่านี้เป็นค่าผกผันของความสัมพันธ์ของเหตุการณ์ "หลัก-ย่อย" ที่ทุกเหตุการณ์ยกเว้นเหตุการณ์แรกจะปรากฏหลังจากที่ประกาศอย่างน้อย 1 เหตุการณ์ กิจกรรม NamedSetOfFiles จะประกาศโดยกิจกรรม Progress ที่ไม่มีการสื่อความหมาย

เนื่องด้วยข้อจำกัดในการสั่งซื้อและการแชร์เหล่านี้ ผู้บริโภคทั่วไปจึงต้องบัฟเฟอร์เหตุการณ์ NamedSetOfFiles ทั้งหมดจนกว่าสตรีม BEP จะหมดลง สตรีมเหตุการณ์ JSON และโค้ด Python ต่อไปนี้แสดงวิธีป้อนข้อมูลการจับคู่จากเป้าหมาย/มุมมองไปจนถึงอาร์ติแฟกต์ที่สร้างขึ้นในกลุ่มเอาต์พุต "เริ่มต้น" และวิธีประมวลผลเอาต์พุตสำหรับชุดย่อยของเป้าหมาย/ด้านที่สร้างขึ้น

named_sets = {}  # type: dict[str, NamedSetOfFiles]
outputs = {}     # type: dict[str, dict[str, set[str]]]

for event in stream:
  kind = event.id.WhichOneof("id")
  if kind == "named_set":
    named_sets[event.id.named_set.id] = event.named_set_of_files
  elif kind == "target_completed":
    tc = event.id.target_completed
    target_id = (tc.label, tc.configuration.id, tc.aspect)
    outputs[target_id] = {}
    for group in event.completed.output_group:
      outputs[target_id][group.name] = {fs.id for fs in group.file_sets}

for result_id in relevant_subset(outputs.keys()):
  visit = outputs[result_id].get("default", [])
  seen_sets = set(visit)
  while visit:
    set_name = visit.pop()
    s = named_sets[set_name]
    for f in s.files:
      process_file(result_id, f)
    for fs in s.file_sets:
      if fs.id not in seen_sets:
        visit.add(fs.id)
        seen_sets.add(fs.id)