Merge pull request #566 from cerisier/canonical-name-module

fix: use label as canonical name for zig_module and use it for module deps

Author: aherrmann

.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/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
+build --deleted_packages=e2e/workspace,e2e/workspace/bazel_builtin,e2e/workspace/c-sources,e2e/workspace/canonical-name-module,e2e/workspace/canonical-name-module/other,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/canonical-name-module,e2e/workspace/canonical-name-module/other,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`.

e2e/workspace/canonical-name-module/BUILD.bazel

@@ -0,0 +1,22 @@
+load("@bazel_skylib//rules:build_test.bzl", "build_test")
+load("@rules_zig//zig:defs.bzl", "zig_binary", "zig_library")
+
+zig_library(
+    name = "data",
+    main = "data.zig",
+)
+
+zig_binary(
+    name = "binary",
+    main = "main.zig",
+    deps = [
+        ":data",
+        "//canonical-name-module/other:data",
+    ],
+)
+
+build_test(
+    name = "output_test",
+    size = "small",
+    targets = [":binary"],
+)

e2e/workspace/canonical-name-module/data.zig

@@ -0,0 +1 @@
+pub const hello_world = "Hello World!\n";

e2e/workspace/canonical-name-module/main.zig

@@ -0,0 +1,16 @@
+const builtin = @import("builtin");
+const std = @import("std");
+const data = @import("data");
+const other_data = @import("other/data");
+
+pub fn main() void {
+    if (builtin.zig_version.major == 0 and builtin.zig_version.minor >= 15) {
+        std.fs.File.stdout().writeAll(
+            data.hello_world,
+        ) catch unreachable;
+    } else {
+        std.io.getStdOut().writeAll(
+            data.hello_world,
+        ) catch unreachable;
+    }
+}

e2e/workspace/canonical-name-module/other/BUILD.bazel

@@ -0,0 +1,8 @@
+load("@rules_zig//zig:defs.bzl", "zig_library")
+
+zig_library(
+    name = "data",
+    import_name = "other/data",
+    main = "data.zig",
+    visibility = ["//visibility:public"],
+)

e2e/workspace/canonical-name-module/other/data.zig

@@ -0,0 +1 @@
+pub const other_hello_world = "Hello World!\n";

zig/private/BUILD.bazel

@@ -16,6 +16,7 @@ bzl_library(
     deps = [
         "//zig/private/common:bazel_builtin",
         "//zig/private/common:data",
+        "//zig/private/common:escape_label",
         "//zig/private/common:filetypes",
         "//zig/private/providers:zig_module_info",
     ],

zig/private/common/BUILD.bazel

@@ -25,6 +25,7 @@ bzl_library(
         ":cdeps",
         ":csrcs",
         ":data",
+        ":escape_label",
         ":filetypes",
         ":linker_script",
         ":location_expansion",
@@ -50,6 +51,7 @@ bzl_library(
         ":bazel_builtin",
         ":cdeps",
         ":csrcs",
+        ":escape_label",
         ":location_expansion",
         ":zig_cache",
         ":zig_lib_dir",
@@ -86,6 +88,7 @@ bzl_library(
     srcs = ["translate_c.bzl"],
     visibility = ["//zig:__subpackages__"],
     deps = [
+        ":escape_label",
         "//zig/private:cc_helper",
         "//zig/private/providers:zig_module_info",
         "@rules_cc//cc:action_names.bzl",
@@ -104,6 +107,12 @@ bzl_library(
     visibility = ["//zig:__subpackages__"],
 )
 
+bzl_library(
+    name = "escape_label",
+    srcs = ["escape_label.bzl"],
+    visibility = ["//zig:__subpackages__"],
+)
+
 bzl_library(
     name = "filetypes",
     srcs = ["filetypes.bzl"],
@@ -138,6 +147,7 @@ filegroup(
         ":cdeps.bzl",
         ":csrcs.bzl",
         ":data.bzl",
+        ":escape_label.bzl",
         ":filetypes.bzl",
         ":linker_script.bzl",
         ":location_expansion.bzl",

zig/private/common/escape_label.bzl

@@ -0,0 +1,29 @@
+"""Utility function for escaping Bazel labels into valid path components."""
+
+# Taken from https://github.com/bazelbuild/rules_cc/blob/109e43da9b210aa1806ac27bb640d2233c9703ce/cc/private/cc_common.bzl#L681-L701
+
+_PATH_ESCAPE_REPLACEMENTS = {
+    "_": "_U",
+    "/": "_S",
+    "\\": "_B",
+    ":": "_C",
+    "@": "_A",
+}
+
+# buildifier: disable=function-docstring
+def escape_label(*, label):
+    path = label.package + ":" + label.name
+    if label.repo_name:
+        path = label.repo_name + "@" + path
+    return escape_label_str(path)
+
+# buildifier: disable=function-docstring
+def escape_label_str(label_str):
+    result = []
+    for idx in range(len(label_str)):
+        c = label_str[idx]
+        result.append(_PATH_ESCAPE_REPLACEMENTS.get(
+            c,
+            c,  # no escaping by default
+        ))
+    return "".join(result)

zig/private/common/translate_c.bzl

@@ -3,6 +3,7 @@
 load("@rules_cc//cc:find_cc_toolchain.bzl", "find_cc_toolchain")
 load("@rules_cc//cc/common:cc_common.bzl", "cc_common")
 load("@rules_cc//cc/common:cc_info.bzl", "CcInfo")
+load("//zig/private/common:escape_label.bzl", "escape_label", "escape_label_str")
 load("//zig/private/providers:zig_module_info.bzl", "zig_module_info")
 
 def zig_translate_c(*, ctx, name, zigtoolchaininfo, global_args, cc_infos, output_prefix = ""):
@@ -84,7 +85,10 @@ def zig_translate_c(*, ctx, name, zigtoolchaininfo, global_args, cc_infos, outpu
 
     return zig_module_info(
         name = name,
-        canonical_name = "{}/{}".format(str(ctx.label), name),
+        # To avoid collisions, we need to escape both label and name,
+        # joined using a separator that cannot appear in escapted text.
+        # (here "__" is used as separator, since "_" is escaped as "_U").
+        canonical_name = "{}__{}".format(escape_label(label = ctx.label), escape_label_str(name)),
         main = zig_out,
         cdeps = [cc_info],
     )