Merge pull request #6 from dfinity-lab/gl/json-output

Gl/json output

Author: EnzoPlayer0ne

BUILD.bazel

@@ -1,5 +1,18 @@
 load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
-load("//rust:defs.bzl", "capture_clippy_output", "clippy_flags", "error_format", "extra_exec_rustc_flag", "extra_exec_rustc_flags", "extra_rustc_flag", "extra_rustc_flags", "is_proc_macro_dep", "is_proc_macro_dep_enabled")
+load(
+    "//rust:defs.bzl",
+    "capture_clippy_output",
+    "clippy_flags",
+    "error_format",
+    "extra_exec_rustc_flag",
+    "extra_exec_rustc_flags",
+    "extra_rustc_flag",
+    "extra_rustc_flags",
+    "is_proc_macro_dep",
+    "is_proc_macro_dep_enabled",
+    "output_diagnostics",
+    "source_path_prefix",
+)
 
 exports_files(["LICENSE"])
 
@@ -18,6 +31,13 @@ error_format(
     visibility = ["//visibility:public"],
 )
 
+# This setting may be changed from the command line to generate rustc diagnostics.
+output_diagnostics(
+    name = "output_diagnostics",
+    build_setting_default = False,
+    visibility = ["//visibility:public"],
+)
+
 # This setting may be used to pass extra options to clippy from the command line.
 # It applies across all targets.
 clippy_flags(
@@ -76,6 +96,15 @@ extra_exec_rustc_flag(
     visibility = ["//visibility:public"],
 )
 
+# This setting may be used to override the prefix for source paths rustc embeds into build artifacts.
+# Setting this setting to a fixed value (e.g., "/source/") can help achieve reproducible builds and
+# improve cache utilization.
+source_path_prefix(
+    name = "source_path_prefix",
+    build_setting_default = ".",
+    visibility = ["//visibility:public"],
+)
+
 # This setting is used by the clippy rules. See https://bazelbuild.github.io/rules_rust/rust_clippy.html
 label_flag(
     name = "clippy.toml",

examples/crate_universe/cargo_aliases/Cargo.toml

@@ -17,5 +17,7 @@ value-bag = "=1.0.0-alpha.7"
 names = "=0.13.0"
 pinned_names = { package = "names", git = "https://github.com/fnichol/names.git", rev = "760516503b89ddc8bc2ab42d579d4566cfb1054f" }
 
+wasmtime-runtime = "0.37.0"
+
 [dev-dependencies]
 env_logger = "0.9.0"

rust/defs.bzl

@@ -49,6 +49,8 @@ load(
     _extra_rustc_flags = "extra_rustc_flags",
     _is_proc_macro_dep = "is_proc_macro_dep",
     _is_proc_macro_dep_enabled = "is_proc_macro_dep_enabled",
+    _output_diagnostics = "output_diagnostics",
+    _source_path_prefix = "source_path_prefix",
 )
 load(
     "//rust/private:rustdoc.bzl",
@@ -103,6 +105,9 @@ rust_clippy = _rust_clippy
 capture_clippy_output = _capture_clippy_output
 # See @rules_rust//rust/private:clippy.bzl for a complete description.
 
+output_diagnostics = _output_diagnostics
+# See @rules_rust//rust/private:rustc.bzl for a complete description.
+
 error_format = _error_format
 # See @rules_rust//rust/private:rustc.bzl for a complete description.
 
@@ -124,6 +129,9 @@ is_proc_macro_dep = _is_proc_macro_dep
 is_proc_macro_dep_enabled = _is_proc_macro_dep_enabled
 # See @rules_rust//rust/private:rustc.bzl for a complete description.
 
+source_path_prefix = _source_path_prefix
+# See @rules_rust//rust/private:rustc.bzl for a complete description.
+
 rust_common = _rust_common
 # See @rules_rust//rust/private:common.bzl for a complete description.
 

rust/private/common.bzl

@@ -51,6 +51,10 @@ def _create_crate_info(**kwargs):
         kwargs.update({"wrapped_crate_type": None})
     if not "metadata" in kwargs:
         kwargs.update({"metadata": None})
+    if not "rust_metadata_rustc_output" in kwargs:
+        kwargs.update({"rust_metadata_rustc_output": None})
+    if not "rust_lib_rustc_output" in kwargs:
+        kwargs.update({"rust_lib_rustc_output": None})
     if not "rustc_env_files" in kwargs:
         kwargs.update({"rustc_env_files": []})
     return CrateInfo(**kwargs)

rust/private/providers.bzl

@@ -23,9 +23,11 @@ CrateInfo = provider(
         "deps": "depset[DepVariantInfo]: This crate's (rust or cc) dependencies' providers.",
         "edition": "str: The edition of this crate.",
         "is_test": "bool: If the crate is being compiled in a test context",
-        "metadata": "File: The rmeta file produced for this crate. It is optional.",
+        "metadata": "File: The output from rustc from producing the output file. It is optional.",
+        "rust_metadata_rustc_output": "File: The rmeta file produced for this crate. It is optional.",
         "name": "str: The name of this crate.",
         "output": "File: The output File that will be produced, depends on crate type.",
+        "rust_lib_rustc_output": "File: The output from rustc from producing the output file. It is optional.",
         "owner": "Label: The label of the target that produced this CrateInfo",
         "proc_macro_deps": "depset[DepVariantInfo]: This crate's rust proc_macro dependencies' providers.",
         "root": "File: The source File entrypoint to this crate, eg. lib.rs",

rust/private/rust.bzl

@@ -65,6 +65,9 @@ def _assert_correct_dep_mapping(ctx):
                 ),
             )
 
+def _rustc_output_name(name):
+    return name + ".rustc-output"
+
 def _determine_lib_name(name, crate_type, toolchain, lib_hash = None):
     """See https://github.com/bazelbuild/rules_rust/issues/405
 
@@ -276,14 +279,24 @@ def _rust_library_common(ctx, crate_type):
         toolchain,
         output_hash,
     )
+
     rust_lib = ctx.actions.declare_file(rust_lib_name)
+    rust_lib_build_output = None
+    output_diagnostics = ctx.attr._output_diagnostics
+    if ctx.attr._process_wrapper and output_diagnostics:
+        rust_lib_build_output = ctx.actions.declare_file(_rustc_output_name(rust_lib_name))
 
     rust_metadata = None
+    rust_metadata_build_output = None
     if can_build_metadata(toolchain, ctx, crate_type) and not ctx.attr.disable_pipelining:
+        rust_metadata_name = paths.replace_extension(rust_lib_name, ".rmeta")
+
         rust_metadata = ctx.actions.declare_file(
-            paths.replace_extension(rust_lib_name, ".rmeta"),
+            rust_metadata_name,
             sibling = rust_lib,
         )
+        if output_diagnostics:
+            rust_metadata_build_output = ctx.actions.declare_file(_rustc_output_name(rust_metadata_name))
 
     deps = transform_deps(ctx.attr.deps)
     proc_macro_deps = transform_deps(ctx.attr.proc_macro_deps + get_import_macro_deps(ctx))
@@ -301,7 +314,9 @@ def _rust_library_common(ctx, crate_type):
             proc_macro_deps = depset(proc_macro_deps),
             aliases = ctx.attr.aliases,
             output = rust_lib,
+            rust_lib_rustc_output = rust_lib_build_output,
             metadata = rust_metadata,
+            rust_metadata_rustc_output = rust_metadata_build_output,
             edition = get_edition(ctx.attr, toolchain, ctx.label),
             rustc_env = ctx.attr.rustc_env,
             rustc_env_files = ctx.files.rustc_env_files,
@@ -607,7 +622,7 @@ _common_attrs = {
             The order that these files will be processed is unspecified, so
             multiple definitions of a particular variable are discouraged.
 
-            Note that the variables here are subject to 
+            Note that the variables here are subject to
             [workspace status](https://docs.bazel.build/versions/main/user-manual.html#workspace_status)
             stamping should the `stamp` attribute be enabled. Stamp variables
             should be wrapped in brackets in order to be resolved. E.g.
@@ -620,7 +635,7 @@ _common_attrs = {
             List of compiler flags passed to `rustc`.
 
             These strings are subject to Make variable expansion for predefined
-            source/output path variables like `$location`, `$execpath`, and 
+            source/output path variables like `$location`, `$execpath`, and
             `$rootpath`. This expansion is useful if you wish to pass a generated
             file of arguments to rustc: `@$(location //package:target)`.
         """),
@@ -660,6 +675,9 @@ _common_attrs = {
     "_error_format": attr.label(
         default = Label("//:error_format"),
     ),
+    "_output_diagnostics": attr.label(
+        default = Label("//:output_diagnostics"),
+    ),
     "_extra_exec_rustc_flag": attr.label(
         default = Label("//:extra_exec_rustc_flag"),
     ),
@@ -672,6 +690,9 @@ _common_attrs = {
     "_extra_rustc_flags": attr.label(
         default = Label("//:extra_rustc_flags"),
     ),
+    "_source_path_prefix": attr.label(
+        default = Label("//:source_path_prefix"),
+    ),
     "_import_macro_dep": attr.label(
         default = Label("//util/import"),
         cfg = "exec",
@@ -732,7 +753,7 @@ _rust_test_attrs = dict({
         mandatory = False,
         default = True,
         doc = dedent("""\
-            Whether to use `libtest`. For targets using this flag, individual tests can be run by using the 
+            Whether to use `libtest`. For targets using this flag, individual tests can be run by using the
             [--test_arg](https://docs.bazel.build/versions/4.0.0/command-line-reference.html#flag--test_arg) flag.
             E.g. `bazel test //src:rust_test --test_arg=foo::test::test_fn`.
         """),

rust/private/rust_analyzer.bzl

@@ -188,10 +188,12 @@ def _create_single_crate(ctx, info):
             "include_dirs": [crate_root, _EXEC_ROOT_TEMPLATE + out_dir_path],
         }
 
+    # We deduplicate the entries from each of the additional targets to work around
+    # https://github.com/bazelbuild/bazel/issues/16664
+    #
     # TODO: The only imagined use case is an env var holding a filename in the workspace passed to a
     # macro like include_bytes!. Other use cases might exist that require more complex logic.
-    expand_targets = concat([getattr(ctx.rule.attr, attr, []) for attr in ["data", "compile_data"]])
-
+    expand_targets = _deduplicate(_concat([getattr(ctx.rule.attr, attr, []) for attr in ["data", "compile_data"]]))
     crate["env"].update({k: dedup_expand_location(ctx, v, expand_targets) for k, v in info.env.items()})
 
     # Omit when a crate appears to depend on itself (e.g. foo_test crates).
@@ -211,6 +213,12 @@ def _create_single_crate(ctx, info):
         crate["proc_macro_dylib_path"] = _EXEC_ROOT_TEMPLATE + info.proc_macro_dylib_path
     return crate
 
+def _deduplicate(xs):
+    return {x: True for x in xs}.keys()
+
+def _concat(xss):
+    return [x for xs in xss for x in xs]
+
 def _rust_analyzer_toolchain_impl(ctx):
     toolchain = platform_common.ToolchainInfo(
         proc_macro_srv = ctx.executable.proc_macro_srv,