Merge pull request #543 from cerisier/mirrors

aherrmann · web-flow · commit 25c880136d66 · 2025-09-28T16:01:00.000+02:00
feat: support Zig mirrors
diff --git a/.bazelrc b/.bazelrc
@@ -18,8 +18,8 @@ build --workspace_status_command=$(pwd)/workspace_status.sh
 # To update these lines, execute
 # `bazel run @rules_bazel_integration_test//tools:update_deleted_packages`
 # docs: https://bazel.build/reference/command-line-reference#flag--deleted_packages
-build --deleted_packages=e2e/workspace,e2e/workspace/bazel_builtin,e2e/workspace/c-sources,e2e/workspace/cc-dependencies,e2e/workspace/cc-dependencies/shared-library,e2e/workspace/cc-dependencies/static-library,e2e/workspace/cc-dependencies/static-library-cdeps,e2e/workspace/configure-mode,e2e/workspace/configure-target,e2e/workspace/configure-threaded,e2e/workspace/configure-use_cc_common_link,e2e/workspace/configure-use_cc_common_link/shared-library,e2e/workspace/configure-use_cc_common_link/static-library,e2e/workspace/configure-version,e2e/workspace/data-dependencies,e2e/workspace/embed-file,e2e/workspace/env-attr,e2e/workspace/import-name-attr,e2e/workspace/include-dependencies,e2e/workspace/include-dependencies/zig-include,e2e/workspace/include-dependencies/zig-include-define,e2e/workspace/include-dependencies/zig-include-isystem,e2e/workspace/include-dependencies/zig-std-include,e2e/workspace/link-dependencies,e2e/workspace/link-dependencies/shared-library,e2e/workspace/link-dependencies/static-library,e2e/workspace/linker-script,e2e/workspace/linkopts-attr,e2e/workspace/location-expansion,e2e/workspace/multiple-sources-and-packages-test,e2e/workspace/multiple-sources-binary,e2e/workspace/root-module-from-single-dependency,e2e/workspace/runfiles-library,e2e/workspace/runfiles-library/dependency,e2e/workspace/runfiles-library/dependency/transitive-dependency,e2e/workspace/simple-binary,e2e/workspace/simple-library,e2e/workspace/simple-shared-library,e2e/workspace/simple-test,e2e/workspace/test-runner-attr,e2e/workspace/transitive-zig-modules-binary,e2e/workspace/transitive-zig-modules-binary/hello-world,e2e/workspace/transitive-zig-modules-binary/hello-world/data,e2e/workspace/transitive-zig-modules-binary/hello-world/data/hello,e2e/workspace/transitive-zig-modules-binary/hello-world/data/world,e2e/workspace/transitive-zig-modules-binary/hello-world/io,e2e/workspace/translate-c/transitive-cc-library-zig-binary,e2e/workspace/zig-docs,e2e/workspace/zig-header,e2e/workspace/zig-module-binary,e2e/workspace/zig-module-binary/data,e2e/workspace/zig-module-binary/io,zig/tests/integration_tests/minimal,zig/tests/integration_tests/workspace,zig/tests/integration_tests/workspace/custom_interpreter,zig/tests/integration_tests/workspace/env-attr,zig/tests/integration_tests/workspace/runfiles
-query --deleted_packages=e2e/workspace,e2e/workspace/bazel_builtin,e2e/workspace/c-sources,e2e/workspace/cc-dependencies,e2e/workspace/cc-dependencies/shared-library,e2e/workspace/cc-dependencies/static-library,e2e/workspace/cc-dependencies/static-library-cdeps,e2e/workspace/configure-mode,e2e/workspace/configure-target,e2e/workspace/configure-threaded,e2e/workspace/configure-use_cc_common_link,e2e/workspace/configure-use_cc_common_link/shared-library,e2e/workspace/configure-use_cc_common_link/static-library,e2e/workspace/configure-version,e2e/workspace/data-dependencies,e2e/workspace/embed-file,e2e/workspace/env-attr,e2e/workspace/import-name-attr,e2e/workspace/include-dependencies,e2e/workspace/include-dependencies/zig-include,e2e/workspace/include-dependencies/zig-include-define,e2e/workspace/include-dependencies/zig-include-isystem,e2e/workspace/include-dependencies/zig-std-include,e2e/workspace/link-dependencies,e2e/workspace/link-dependencies/shared-library,e2e/workspace/link-dependencies/static-library,e2e/workspace/linker-script,e2e/workspace/linkopts-attr,e2e/workspace/location-expansion,e2e/workspace/multiple-sources-and-packages-test,e2e/workspace/multiple-sources-binary,e2e/workspace/root-module-from-single-dependency,e2e/workspace/runfiles-library,e2e/workspace/runfiles-library/dependency,e2e/workspace/runfiles-library/dependency/transitive-dependency,e2e/workspace/simple-binary,e2e/workspace/simple-library,e2e/workspace/simple-shared-library,e2e/workspace/simple-test,e2e/workspace/test-runner-attr,e2e/workspace/transitive-zig-modules-binary,e2e/workspace/transitive-zig-modules-binary/hello-world,e2e/workspace/transitive-zig-modules-binary/hello-world/data,e2e/workspace/transitive-zig-modules-binary/hello-world/data/hello,e2e/workspace/transitive-zig-modules-binary/hello-world/data/world,e2e/workspace/transitive-zig-modules-binary/hello-world/io,e2e/workspace/translate-c/transitive-cc-library-zig-binary,e2e/workspace/zig-docs,e2e/workspace/zig-header,e2e/workspace/zig-module-binary,e2e/workspace/zig-module-binary/data,e2e/workspace/zig-module-binary/io,zig/tests/integration_tests/minimal,zig/tests/integration_tests/workspace,zig/tests/integration_tests/workspace/custom_interpreter,zig/tests/integration_tests/workspace/env-attr,zig/tests/integration_tests/workspace/runfiles
+build --deleted_packages=e2e/workspace,e2e/workspace/bazel_builtin,e2e/workspace/c-sources,e2e/workspace/cc-dependencies,e2e/workspace/cc-dependencies/shared-library,e2e/workspace/cc-dependencies/static-library,e2e/workspace/cc-dependencies/static-library-cdeps,e2e/workspace/configure-mode,e2e/workspace/configure-target,e2e/workspace/configure-threaded,e2e/workspace/configure-use_cc_common_link,e2e/workspace/configure-use_cc_common_link/shared-library,e2e/workspace/configure-use_cc_common_link/static-library,e2e/workspace/configure-version,e2e/workspace/data-dependencies,e2e/workspace/embed-file,e2e/workspace/env-attr,e2e/workspace/import-name-attr,e2e/workspace/include-dependencies,e2e/workspace/include-dependencies/zig-include,e2e/workspace/include-dependencies/zig-include-define,e2e/workspace/include-dependencies/zig-include-isystem,e2e/workspace/include-dependencies/zig-std-include,e2e/workspace/link-dependencies,e2e/workspace/link-dependencies/shared-library,e2e/workspace/link-dependencies/static-library,e2e/workspace/linker-script,e2e/workspace/linkopts-attr,e2e/workspace/location-expansion,e2e/workspace/multiple-sources-and-packages-test,e2e/workspace/multiple-sources-binary,e2e/workspace/root-module-from-single-dependency,e2e/workspace/runfiles-library,e2e/workspace/runfiles-library/dependency,e2e/workspace/runfiles-library/dependency/transitive-dependency,e2e/workspace/simple-binary,e2e/workspace/simple-library,e2e/workspace/simple-shared-library,e2e/workspace/simple-test,e2e/workspace/test-runner-attr,e2e/workspace/transitive-zig-modules-binary,e2e/workspace/transitive-zig-modules-binary/hello-world,e2e/workspace/transitive-zig-modules-binary/hello-world/data,e2e/workspace/transitive-zig-modules-binary/hello-world/data/hello,e2e/workspace/transitive-zig-modules-binary/hello-world/data/world,e2e/workspace/transitive-zig-modules-binary/hello-world/io,e2e/workspace/translate-c/transitive-cc-library-zig-binary,e2e/workspace/zig-docs,e2e/workspace/zig-header,e2e/workspace/zig-module-binary,e2e/workspace/zig-module-binary/data,e2e/workspace/zig-module-binary/io,zig/tests/integration_tests/minimal,zig/tests/integration_tests/mirrors,zig/tests/integration_tests/workspace,zig/tests/integration_tests/workspace/custom_interpreter,zig/tests/integration_tests/workspace/env-attr,zig/tests/integration_tests/workspace/runfiles
+query --deleted_packages=e2e/workspace,e2e/workspace/bazel_builtin,e2e/workspace/c-sources,e2e/workspace/cc-dependencies,e2e/workspace/cc-dependencies/shared-library,e2e/workspace/cc-dependencies/static-library,e2e/workspace/cc-dependencies/static-library-cdeps,e2e/workspace/configure-mode,e2e/workspace/configure-target,e2e/workspace/configure-threaded,e2e/workspace/configure-use_cc_common_link,e2e/workspace/configure-use_cc_common_link/shared-library,e2e/workspace/configure-use_cc_common_link/static-library,e2e/workspace/configure-version,e2e/workspace/data-dependencies,e2e/workspace/embed-file,e2e/workspace/env-attr,e2e/workspace/import-name-attr,e2e/workspace/include-dependencies,e2e/workspace/include-dependencies/zig-include,e2e/workspace/include-dependencies/zig-include-define,e2e/workspace/include-dependencies/zig-include-isystem,e2e/workspace/include-dependencies/zig-std-include,e2e/workspace/link-dependencies,e2e/workspace/link-dependencies/shared-library,e2e/workspace/link-dependencies/static-library,e2e/workspace/linker-script,e2e/workspace/linkopts-attr,e2e/workspace/location-expansion,e2e/workspace/multiple-sources-and-packages-test,e2e/workspace/multiple-sources-binary,e2e/workspace/root-module-from-single-dependency,e2e/workspace/runfiles-library,e2e/workspace/runfiles-library/dependency,e2e/workspace/runfiles-library/dependency/transitive-dependency,e2e/workspace/simple-binary,e2e/workspace/simple-library,e2e/workspace/simple-shared-library,e2e/workspace/simple-test,e2e/workspace/test-runner-attr,e2e/workspace/transitive-zig-modules-binary,e2e/workspace/transitive-zig-modules-binary/hello-world,e2e/workspace/transitive-zig-modules-binary/hello-world/data,e2e/workspace/transitive-zig-modules-binary/hello-world/data/hello,e2e/workspace/transitive-zig-modules-binary/hello-world/data/world,e2e/workspace/transitive-zig-modules-binary/hello-world/io,e2e/workspace/translate-c/transitive-cc-library-zig-binary,e2e/workspace/zig-docs,e2e/workspace/zig-header,e2e/workspace/zig-module-binary,e2e/workspace/zig-module-binary/data,e2e/workspace/zig-module-binary/io,zig/tests/integration_tests/minimal,zig/tests/integration_tests/mirrors,zig/tests/integration_tests/workspace,zig/tests/integration_tests/workspace/custom_interpreter,zig/tests/integration_tests/workspace/env-attr,zig/tests/integration_tests/workspace/runfiles
 
 # Load any settings specific to the current user.
 # Place settings that should affect the integration tests into `.bazelrc.ic.user`.
diff --git a/docs/extensions.md b/docs/extensions.md
diff --git a/zig/private/bzlmod/zig.bzl b/zig/private/bzlmod/zig.bzl
@@ -48,9 +48,16 @@ The provided index must use a schema that is compatible with the [upstream index
 """,
 )
 
+zig_mirrors = tag_class(
+    attrs = {
+        "urls": attr.string_list(doc = "The mirrors base URLs.", mandatory = True),
+    },
+)
+
 TAG_CLASSES = {
     "toolchain": zig_toolchain,
     "index": zig_index,
+    "mirrors": zig_mirrors,
 }
 
 def handle_toolchain_tags(modules, *, known_versions):
@@ -158,8 +165,11 @@ def merge_version_specs(version_specs):
     return result
 
 def _toolchain_extension(module_ctx):
+    mirrors = []
     version_specs = []
     for mod in module_ctx.modules:
+        for mirrors_tag in mod.tags.mirrors:
+            mirrors.extend(mirrors_tag.urls)
         for index in mod.tags.index:
             file_path = module_ctx.path(index.file)
             file_content = module_ctx.read(file_path)
@@ -194,6 +204,7 @@ def _toolchain_extension(module_ctx):
             zig_repository(
                 name = repo_name,
                 url = known_versions[zig_version][platform].url,
+                mirrors = mirrors,
                 sha256 = known_versions[zig_version][platform].sha256,
                 zig_version = zig_version,
                 platform = platform,
diff --git a/zig/private/repo/zig_repository.bzl b/zig/private/repo/zig_repository.bzl
@@ -14,6 +14,7 @@ DOC = "Fetch and install a Zig toolchain."
 
 ATTRS = {
     "url": attr.string(mandatory = True, doc = "The URL to the Zig SDK release archive."),
+    "mirrors": attr.string_list(mandatory = True, doc = "List of URLs to Zig releases mirrors."),
     "sha256": attr.string(mandatory = False, doc = "The expected SHA-256 of the downloaded artifact. Provide only one of `sha256` or `integrity`."),
     "integrity": attr.string(mandatory = False, doc = "The expected checksum of the downloaded artifact in Subresource Integrity format. Provide only one of `sha256` or `integrity`."),
     "zig_version": attr.string(mandatory = True, doc = "The Zig SDK version number."),
@@ -63,6 +64,13 @@ def _get_integrity_args(*, sha256, integrity):
 
     return result
 
+def _mirrors_urls(url, mirrors):
+    filename = _basename(url)
+    return [
+        mirror + "/" + filename
+        for mirror in mirrors
+    ] + [url]
+
 def _zig_repository_impl(repository_ctx):
     cache_prefix = env_zig_cache_prefix(
         repository_ctx.os.environ,
@@ -95,7 +103,10 @@ zig_toolchain(
     repository_ctx.file("BUILD.bazel", build_content)
 
     download_args = {
-        "url": repository_ctx.attr.url,
+        "url": _mirrors_urls(
+            url = repository_ctx.attr.url,
+            mirrors = repository_ctx.attr.mirrors,
+        ),
         "stripPrefix": _get_strip_prefix(url = repository_ctx.attr.url),
     }
     integrity = _get_integrity_args(
diff --git a/zig/tests/integration_tests/BUILD.bazel b/zig/tests/integration_tests/BUILD.bazel
@@ -126,12 +126,38 @@ bazel_integration_tests(
     workspace_path = "minimal",
 )
 
+mirrors_files = integration_test_utils.glob_workspace_files("mirrors") + [
+    "//:all_files",
+    "//:bazelrc",
+    ".bazelrc.meta",
+]
+
+zig_test(
+    name = "mirrors_tests_runner",
+    main = "mirrors_tests_runner.zig",
+    tags = ["manual"],
+    deps = [":integration_testing"],
+)
+
+bazel_integration_tests(
+    name = "mirrors_test",
+    timeout = "moderate",
+    bazel_versions = bazel_binaries.versions.all,
+    tags = ["requires-network"] + integration_test_utils.DEFAULT_INTEGRATION_TEST_TAGS,
+    test_runner = ":mirrors_tests_runner",
+    workspace_files = mirrors_files,
+    workspace_path = "mirrors",
+)
+
 test_suite(
     name = "integration_tests",
     tags = integration_test_utils.DEFAULT_INTEGRATION_TEST_TAGS,
     tests = integration_test_utils.bazel_integration_test_names(
         "minimal_test",
         bazel_binaries.versions.all,
+    ) + integration_test_utils.bazel_integration_test_names(
+        "mirrors_test",
+        bazel_binaries.versions.all,
     ) + integration_test_utils.bazel_integration_test_names(
         "bzlmod_test",
         bazel_binaries.versions.all,
diff --git a/zig/tests/integration_tests/mirrors/.bazelrc b/zig/tests/integration_tests/mirrors/.bazelrc
@@ -0,0 +1,14 @@
+# Common configuration.
+import %workspace%/../../../../.bazelrc.common
+
+# Zig build mode flag aliases. See further explanation in that file.
+import %workspace%/../../../../.bazelrc.flags
+
+# Remote cache configuration.
+import %workspace%/../../../../.bazelrc.remote
+
+# Build metadata
+import %workspace%/../.bazelrc.meta
+
+# Load any settings specific to the current user.
+try-import %workspace%/../../../../.bazelrc.ic.user
diff --git a/zig/tests/integration_tests/mirrors/BUILD.bazel b/zig/tests/integration_tests/mirrors/BUILD.bazel
@@ -0,0 +1,6 @@
+load("@rules_zig//zig:defs.bzl", "zig_binary")
+
+zig_binary(
+    name = "binary",
+    main = "main.zig",
+)
diff --git a/zig/tests/integration_tests/mirrors/MODULE.bazel b/zig/tests/integration_tests/mirrors/MODULE.bazel
@@ -0,0 +1,44 @@
+module(name = "mirrors")
+
+bazel_dep(name = "rules_zig", version = "0.0.0")
+bazel_dep(name = "platforms", version = "0.0.6")
+
+bazel_dep(name = "rules_cc", version = "0.1.1", dev_dependency = True)
+
+local_path_override(
+    module_name = "rules_zig",
+    path = "../../../..",
+)
+
+zig = use_extension("@rules_zig//zig:extensions.bzl", "zig")
+
+# https://ziglang.org/download/community-mirrors.txt
+zig.mirrors(urls = [
+    "https://pkg.machengine.org/zig",
+    "https://zigmirror.hryx.net/zig",
+    "https://zig.linus.dev/zig",
+    "https://zig.squirl.dev",
+    "https://zig.florent.dev",
+    "https://zig.mirror.mschae23.de/zig",
+    "https://zigmirror.meox.dev",
+])
+zig.toolchain(
+    default = True,
+    zig_version = "0.15.1",
+)
+use_repo(zig, "zig_toolchains")
+
+bazel_dep(name = "toolchains_buildbuddy", dev_dependency = True)
+archive_override(
+    module_name = "toolchains_buildbuddy",
+    integrity = "sha256-UA+poYaWFbPxgtoA2re4mX89c3/8yYchpKwr4pvvGOw=",
+    strip_prefix = "buildbuddy-toolchain-ffd296b7a9821174cdb2188d1373fd262cacb09d",
+    urls = ["https://github.com/buildbuddy-io/buildbuddy-toolchain/archive/ffd296b7a9821174cdb2188d1373fd262cacb09d.tar.gz"],
+)
+
+buildbuddy = use_extension(
+    "@toolchains_buildbuddy//:extensions.bzl",
+    "buildbuddy",
+    dev_dependency = True,
+)
+use_repo(buildbuddy, "buildbuddy_toolchain")
diff --git a/zig/tests/integration_tests/mirrors/WORKSPACE.bazel b/zig/tests/integration_tests/mirrors/WORKSPACE.bazel
diff --git a/zig/tests/integration_tests/mirrors/main.zig b/zig/tests/integration_tests/mirrors/main.zig
@@ -0,0 +1,10 @@
+const std = @import("std");
+const builtin = @import("builtin");
+
+pub fn main() void {
+    if (builtin.zig_version.major == 0 and builtin.zig_version.minor >= 15) {
+        std.fs.File.stdout().writeAll("Hello World!\n") catch unreachable;
+    } else {
+        std.io.getStdOut().writeAll("Hello World!\n") catch unreachable;
+    }
+}
diff --git a/zig/tests/integration_tests/mirrors_tests_runner.zig b/zig/tests/integration_tests/mirrors_tests_runner.zig
@@ -0,0 +1,86 @@
+const builtin = @import("builtin");
+const std = @import("std");
+const integration_testing = @import("integration_testing");
+const BitContext = integration_testing.BitContext;
+
+test "Zig distribution is fetched from a mirror" {
+    if (builtin.zig_version.major == 0 and builtin.zig_version.minor < 15) {
+        return error.SkipZigTest;
+    }
+
+    const ctx = try BitContext.init();
+
+    const result = try ctx.exec_bazel(.{
+        .argv = &[_][]const u8{
+            "run",
+            "//:binary",
+            "--repository_cache=",
+            "--experimental_remote_downloader=",
+            "--build_event_json_file=bes.json",
+        },
+    });
+    defer result.deinit();
+
+    try std.testing.expect(result.success);
+
+    var workspace = try std.fs.cwd().openDir(ctx.workspace_path, .{});
+    defer workspace.close();
+
+    const bes_file = try workspace.openFile("bes.json", .{});
+    defer bes_file.close();
+
+    var bes_buffer: [4096]u8 = undefined;
+    var bes_reader = bes_file.reader(&bes_buffer);
+    const bes = &bes_reader.interface;
+
+    var line_buffer = std.array_list.Managed(u8).init(std.testing.allocator);
+    defer line_buffer.deinit();
+    var line_writer = line_buffer.writer();
+    var adapter = line_writer.adaptToNewApi(&.{});
+    const line = &adapter.new_interface;
+
+    const expected_url_prefix = "https://pkg.machengine.org/zig/zig";
+    var fetch_used_mirror = false;
+
+    while (true) {
+        line_buffer.clearRetainingCapacity();
+        _ = bes.streamDelimiter(line, '\n') catch |err| switch (err) {
+            error.EndOfStream => break,
+            else => return err,
+        };
+        bes.toss(1);
+
+        const trimmed_line = std.mem.trim(u8, line_buffer.items, " \t\r\n");
+        if (trimmed_line.len > 0) {
+            var parsed = try std.json.parseFromSlice(std.json.Value, std.testing.allocator, trimmed_line, .{});
+            defer parsed.deinit();
+
+            if (parsed.value == .object) {
+                const root_obj = parsed.value.object;
+                if (root_obj.get("id")) |id_value| {
+                    if (id_value == .object) {
+                        if (id_value.object.get("fetch")) |fetch_id| {
+                            if (fetch_id == .object) {
+                                if (fetch_id.object.get("url")) |url_value| {
+                                    if (url_value == .string) {
+                                        if (std.mem.startsWith(u8, url_value.string, expected_url_prefix)) {
+                                            fetch_used_mirror = true;
+                                        }
+                                    }
+                                }
+                            }
+
+                            std.debug.print("{s}\n", .{trimmed_line});
+                        }
+                    }
+                }
+            }
+        }
+
+        if (fetch_used_mirror) {
+            break;
+        }
+    }
+
+    try std.testing.expectEqual(true, fetch_used_mirror);
+}
