Add well-known annotations to help with hermetic remote builds

Author: dzbarsky

.bazelversion

@@ -1 +1 @@
-9.0.0rc3
+9.0.0rc5

rs/extensions.bzl

@@ -1,7 +1,7 @@
 load("@aspect_tools_telemetry_report//:defs.bzl", "TELEMETRY")  # buildifier: disable=load
 load("@bazel_lib//lib:repo_utils.bzl", "repo_utils")
 load("@bazel_skylib//lib:paths.bzl", "paths")
-load("//rs/private:annotations.bzl", "annotation_for", "build_annotation_map")
+load("//rs/private:annotations.bzl", "WELL_KNOWN_ANNOTATIONS", "annotation_for", "build_annotation_map", "format_well_known_annotation")
 load("//rs/private:cargo_credentials.bzl", "load_cargo_credentials")
 load("//rs/private:cfg_parser.bzl", "cfg_matches_expr_for_cfg_attrs", "triple_to_cfg_attrs")
 load("//rs/private:crate_git_repository.bzl", "crate_git_repository")
@@ -366,7 +366,10 @@ def _generate_hub_and_spokes(
                         fail(("ERROR: Cargo.lock out of sync: %s requires %s %s but Cargo.lock has %s.\n\n" +
                               "If this is incorrect, please set `validate_lockfile = False` in `crate.from_cargo`\n" +
                               "and file a bug at https://github.com/dzbarsky/rules_rs/issues/new") % (
-                            package["name"], dep_name, req, locked_version
+                            package["name"],
+                            dep_name,
+                            req,
+                            locked_version,
                         ))
 
             features = dep["features"]
@@ -442,6 +445,26 @@ def _generate_hub_and_spokes(
         feature_resolutions = feature_resolutions_by_fq_crate[_fq_crate(crate_name, version)]
 
         annotation = annotation_for(annotations, crate_name, version)
+        well_known_annotation = WELL_KNOWN_ANNOTATIONS.get(crate_name)
+        if well_known_annotation and annotation.gen_build_script == "auto":
+            print("""
+WARNING: A well-known crate annotation exists for {crate}! Apply the following to your MODULE.bazel:
+
+```
+{formatted_well_known_annotation}
+```
+
+You can disable this warning by configuring your MODULE.bazel like so:
+
+```
+crate.annotation(
+    crate = "{crate}",
+    gen_build_script = "on",
+)
+```""".format(
+                crate = crate_name,
+                formatted_well_known_annotation = format_well_known_annotation(crate_name, well_known_annotation),
+            ))
 
         kwargs = dict(
             hub_name = hub_name,

rs/private/annotations.bzl

@@ -39,3 +39,45 @@ def build_annotation_map(mod, cfg_name):
             fail("Duplicate crate.annotation for %s version %s in repo %s" % (annotation.crate, version_key, cfg_name))
         crate_map[version_key] = annotation
     return annotations
+
+def format_well_known_annotation(crate, annotation):
+    target = annotation.target
+    idx = target.find("//")
+    if idx == -1:
+        module_name = target[1:]
+    else:
+        module_name = target[1:idx]
+
+    return """\
+bazel_dep(name = "{module_name}", version = "{module_version}")
+
+crate.annotation(
+    crate = "{crate}",
+    gen_build_script = "off",
+    deps = ["{target}"],
+)
+
+inject_repo(crate, "{module_name}")""".format(
+        crate = crate,
+        target = target,
+        module_name = module_name,
+        module_version = annotation.module_version,
+    )
+
+def _bazel_dep(target, module_version):
+    return struct(
+        target = target,
+        module_version = module_version,
+    )
+
+WELL_KNOWN_ANNOTATIONS = {
+    "alsa-sys": _bazel_dep("@alsa_lib", "1.2.9.bcr.4"),
+    "bzip2-sys": _bazel_dep("@bzip2//:bz2", "1.0.8.bcr.3"),
+    "gdk-pixbuf-sys": _bazel_dep("@gdk-pixbuf", "2.44.4"),
+    "gio-sys": _bazel_dep("@glib//gio", "2.82.2.bcr.7"),
+    "glib-sys": _bazel_dep("@glib//glib", "2.82.2.bcr.7"),
+    "gobject-sys": _bazel_dep("@glib//gobject", "2.82.2.bcr.7"),
+    "lzma-sys": _bazel_dep("@xz//:lzma", "5.4.5.bcr.7"),
+    "tikv-jemalloc-sys": _bazel_dep("@jemalloc", "5.3.0-bcr.alpha.4"),
+    "zstd-sys": _bazel_dep("@zstd", "1.5.7"),
+}

test/MODULE.bazel

@@ -2,15 +2,20 @@ bazel_dep(name = "platforms", version = "1.0.0")
 bazel_dep(name = "toolchains_llvm_bootstrapped", version = "0.3.1")
 archive_override(
     module_name = "toolchains_llvm_bootstrapped",
-    integrity = "sha256-dBvq3EBkK0YWeYLZz+lPGT1EP5jKdpvZ7VJ6iy//ADM=",
-    patch_strip = 1,
-    patches = [
-        "//:toolchains_llvm_bootstrapped_ws2.patch",
-    ],
-    strip_prefix = "toolchains_llvm_bootstrapped-ae1f72282fbe8695c5641eda171d6b7b73e475b6",
-    urls = ["https://github.com/cerisier/toolchains_llvm_bootstrapped/archive/ae1f72282fbe8695c5641eda171d6b7b73e475b6/master.tar.gz"],
+    integrity = "sha256-es2Zf7dKYEVDuvkm6E90CnunXSisameDh5/5nyhyu2Q=",
+    strip_prefix = "toolchains_llvm_bootstrapped-873b8be7d416283761b158ef4635e605970ab3db",
+    urls = ["https://github.com/cerisier/toolchains_llvm_bootstrapped/archive/873b8be7d416283761b158ef4635e605970ab3db.tar.gz"],
 )
 
+osx = use_extension("@toolchains_llvm_bootstrapped//toolchain/extension:osx.bzl", "osx")
+
+osx.framework(name = "CoreFoundation")
+osx.framework(name = "CoreServices")
+osx.framework(name = "CFNetwork")
+osx.framework(name = "DiskArbitration")
+osx.framework(name = "IOKit")
+osx.framework(name = "Security")
+
 #local_path_override(
 #    module_name = "toolchains_llvm_bootstrapped",
 #    path = "../../toolchains_llvm_bootstrapped",
@@ -158,8 +163,23 @@ crate.annotation(
 ]
 
 ### Fix -sys crates
+bazel_dep(name = "bzip2", version = "1.0.8.bcr.3")
+
+crate.annotation(
+    crate = "bzip2-sys",
+    gen_build_script = "off",
+    deps = ["@bzip2//:bz2"],
+)
+
+inject_repo(crate, "bzip2")
+
 bazel_dep(name = "glib", version = "2.82.2.bcr.7")
 
+crate.annotation(
+    crate = "gio-sys",
+    gen_build_script = "off",
+    deps = ["@glib//gio"],
+)
 crate.annotation(
     crate = "glib-sys",
     gen_build_script = "off",
@@ -170,14 +190,30 @@ crate.annotation(
     gen_build_script = "off",
     deps = ["@glib//gobject"],
 )
+
+inject_repo(crate, "glib")
+
+bazel_dep(name = "xz", version = "5.4.5.bcr.7")
+
 crate.annotation(
-    crate = "gio-sys",
+    crate = "lzma-sys",
     gen_build_script = "off",
-    deps = ["@glib//gio"],
+    deps = ["@xz//:lzma"],
 )
 
-inject_repo(crate, "glib")
+inject_repo(crate, "xz")
+
+bazel_dep(name = "zstd", version = "1.5.7")
+
+crate.annotation(
+    crate = "zstd-sys",
+    gen_build_script = "off",
+    deps = ["@zstd"],
+)
+
+inject_repo(crate, "zstd")
 
+# TODO(zbarsky): alsa-sys is not curently tested, fix it
 bazel_dep(name = "alsa_lib", version = "1.2.9.bcr.4")
 
 crate.annotation(