|
| 1 | +"""Aspect to collect package_info metadata for buildInfo. |
| 2 | +
|
| 3 | +This aspect traverses Go binary dependencies and collects version information |
| 4 | +from Gazelle-generated package_info targets referenced via the package_metadata |
| 5 | +common attribute (inherited from REPO.bazel default_package_metadata). |
| 6 | +
|
| 7 | +Implementation based on bazel-contrib/supply-chain gather_metadata pattern. |
| 8 | +""" |
| 9 | + |
| 10 | +load( |
| 11 | + "//go/private:providers.bzl", |
| 12 | + "GoArchive", |
| 13 | +) |
| 14 | + |
| 15 | +BuildInfoMetadata = provider( |
| 16 | + doc = "Provides dependency version metadata for buildInfo", |
| 17 | + fields = { |
| 18 | + "version_map": "Depset of (importpath, version) tuples", |
| 19 | + }, |
| 20 | +) |
| 21 | + |
| 22 | +def _buildinfo_aspect_impl(target, ctx): |
| 23 | + """Collects package_info metadata from dependencies. |
| 24 | +
|
| 25 | + Following bazel-contrib/supply-chain gather_metadata pattern, this checks: |
| 26 | + 1. package_metadata common attribute (from REPO.bazel default_package_metadata) |
| 27 | + 2. applicable_licenses attribute (fallback for older configs) |
| 28 | + 3. Direct package_info providers on the target itself |
| 29 | +
|
| 30 | + Args: |
| 31 | + target: The target being visited |
| 32 | + ctx: The aspect context |
| 33 | +
|
| 34 | + Returns: |
| 35 | + List containing BuildInfoMetadata provider |
| 36 | + """ |
| 37 | + direct_versions = [] |
| 38 | + |
| 39 | + # Approach 1: Check package_metadata common attribute (Bazel 5.4+) |
| 40 | + # This is set via REPO.bazel default_package_metadata in go_repository |
| 41 | + package_metadata = [] |
| 42 | + if hasattr(ctx.rule.attr, "package_metadata"): |
| 43 | + attr_value = ctx.rule.attr.package_metadata |
| 44 | + if attr_value: |
| 45 | + package_metadata = attr_value if type(attr_value) == "list" else [attr_value] |
| 46 | + |
| 47 | + # Approach 2: Check applicable_licenses (legacy compatibility) |
| 48 | + if not package_metadata and hasattr(ctx.rule.attr, "applicable_licenses"): |
| 49 | + attr_value = ctx.rule.attr.applicable_licenses |
| 50 | + if attr_value: |
| 51 | + package_metadata = attr_value if type(attr_value) == "list" else [attr_value] |
| 52 | + |
| 53 | + # Collect metadata from transitive dependencies (supply-chain pattern) |
| 54 | + transitive_depsets = [] |
| 55 | + |
| 56 | + # Traverse all attributes (supply-chain uses attr_aspects = ["*"]) |
| 57 | + attrs = [attr for attr in dir(ctx.rule.attr)] |
| 58 | + for attr_name in attrs: |
| 59 | + # Skip private attributes |
| 60 | + if attr_name.startswith("_"): |
| 61 | + continue |
| 62 | + |
| 63 | + attr_value = getattr(ctx.rule.attr, attr_name) |
| 64 | + if not attr_value: |
| 65 | + continue |
| 66 | + |
| 67 | + # Handle both lists and single values |
| 68 | + deps = attr_value if type(attr_value) == "list" else [attr_value] |
| 69 | + |
| 70 | + for dep in deps: |
| 71 | + # Only process Target types |
| 72 | + if type(dep) != "Target": |
| 73 | + continue |
| 74 | + |
| 75 | + # Collect transitive BuildInfoMetadata |
| 76 | + if BuildInfoMetadata in dep: |
| 77 | + transitive_depsets.append(dep[BuildInfoMetadata].version_map) |
| 78 | + |
| 79 | + # Return using supply-chain memory optimization pattern |
| 80 | + if not direct_versions and not transitive_depsets: |
| 81 | + # No metadata at all, return empty provider |
| 82 | + return [BuildInfoMetadata(version_map = depset([]))] |
| 83 | + |
| 84 | + if not direct_versions and len(transitive_depsets) == 1: |
| 85 | + # Only one transitive depset, pass it up directly to save memory |
| 86 | + return [BuildInfoMetadata(version_map = transitive_depsets[0])] |
| 87 | + |
| 88 | + # Combine direct and transitive metadata |
| 89 | + return [BuildInfoMetadata( |
| 90 | + version_map = depset( |
| 91 | + direct = direct_versions, |
| 92 | + transitive = transitive_depsets, |
| 93 | + ), |
| 94 | + )] |
| 95 | + |
| 96 | +buildinfo_aspect = aspect( |
| 97 | + doc = "Collects package_info metadata for Go buildInfo", |
| 98 | + implementation = _buildinfo_aspect_impl, |
| 99 | + attr_aspects = ["*"], # Traverse all attributes (supply-chain pattern) |
| 100 | + provides = [BuildInfoMetadata], |
| 101 | + # Apply to generated targets including package_info |
| 102 | + apply_to_generating_rules = True, |
| 103 | +) |
0 commit comments