Scala proto conventional stamping (#1243)

* Deprecate scalapb_proto_library

* Refactor/cleanup scala_proto

* proto scala move to phases (in progress 1)

* Add phases to proto aspect

* Add stamping phase to scala proto aspect

* Add aspect customization

* Lint

* Lint: remove unreachable code

* Fixes after review

Author: liucijus

scala/private/phases/api.bzl

@@ -41,8 +41,13 @@ def _adjust_phases(phases, adjustments):
                         break
     return phases
 
-# Execute phases
 def run_phases(ctx, builtin_customizable_phases):
+    return _run_phases(ctx, builtin_customizable_phases, target = None)
+
+def run_aspect_phases(ctx, builtin_customizable_phases, target):
+    return _run_phases(ctx, builtin_customizable_phases, target)
+
+def _run_phases(ctx, builtin_customizable_phases, target):
     # Loading custom phases
     # Phases must be passed in by provider
     phase_providers = [
@@ -62,7 +67,9 @@ def run_phases(ctx, builtin_customizable_phases):
     )
 
     # A placeholder for data shared with later phases
-    global_provider = {}
+    global_provider = {
+        "target": target,
+    }
     current_provider = struct(**global_provider)
     acculmulated_external_providers = {}
     for (name, function) in adjusted_phases:

scala/private/rule_impls.bzl

@@ -54,7 +54,8 @@ def compile_scala(
         scalac_jvm_flags,
         scalac,
         dependency_info,
-        unused_dependency_checker_ignored_targets):
+        unused_dependency_checker_ignored_targets,
+        stamp_target_label = None):
     # look for any plugins:
     input_plugins = plugins
     plugins = _collect_plugin_paths(plugins)
@@ -72,6 +73,7 @@ def compile_scala(
     args.set_param_file_format("multiline")
     args.use_param_file(param_file_arg = "@%s", use_always = True)
     args.add("--CurrentTarget", target_label)
+    args.add("--StampLabel", stamp_target_label if stamp_target_label != None else target_label)
     args.add("--JarOutput", output)
     args.add("--Manifest", manifest)
     args.add("--PrintCompileTime", print_compile_time)

scala_proto/BUILD

@@ -1,15 +1,15 @@
 load(
     "//scala_proto:scala_proto_toolchain.bzl",
-    "export_scalapb_toolchain_deps",
     "scala_proto_deps_toolchain",
     "scala_proto_toolchain",
 )
 load(
-    "//scala_proto:default_dep_sets.bzl",
+    "//scala_proto/default:default_deps.bzl",
     "DEFAULT_SCALAPB_COMPILE_DEPS",
     "DEFAULT_SCALAPB_GRPC_DEPS",
 )
 load("//scala:providers.bzl", "declare_deps_provider")
+load("//scala_proto/private:toolchain_deps.bzl", "export_scalapb_toolchain_deps")
 
 toolchain_type(
     name = "toolchain_type",
@@ -52,7 +52,6 @@ scala_proto_toolchain(
     visibility = ["//visibility:public"],
     with_flat_package = True,
     with_grpc = True,
-    # with_java=True,
     with_single_line_to_string = True,
 )
 

scala_proto/default/BUILD

@@ -1,11 +1,8 @@
-load(
-    "//scala:scala_cross_version.bzl",
-    _default_maven_server_urls = "default_maven_server_urls",
-)
+load("//scala:scala_cross_version.bzl", "default_maven_server_urls")
 load("//third_party/repositories:repositories.bzl", "repositories")
 
 def scala_proto_default_repositories(
-        maven_servers = _default_maven_server_urls(),
+        maven_servers = default_maven_server_urls(),
         overriden_artifacts = {}):
     repositories(
         for_artifact_ids = [

scala_proto/default_dep_sets.bzl renamed to scala_proto/default/default_deps.bzl

@@ -0,0 +1,66 @@
+load("@rules_proto//proto:defs.bzl", "ProtoInfo")
+load(
+    "@io_bazel_rules_scala//scala_proto/private:scala_proto_aspect_provider.bzl",
+    "ScalaProtoAspectInfo",
+)
+load(
+    "@io_bazel_rules_scala//scala/private:phases/api.bzl",
+    "extras_phases",
+    "run_phases",
+)
+load("@bazel_skylib//lib:dicts.bzl", "dicts")
+load("//scala_proto/private:scala_proto_aspect.bzl", "make_scala_proto_aspect")
+
+def phase_merge_aspect_java_info(ctx, p):
+    java_info = java_common.merge([dep[ScalaProtoAspectInfo].java_info for dep in ctx.attr.deps])
+    return struct(
+        java_info = java_info,
+        external_providers = {
+            "JavaInfo": java_info,
+        },
+    )
+
+def phase_default_info(ctx, p):
+    java_info = p.merge_aspects.java_info
+    return struct(
+        external_providers = {
+            "DefaultInfo": DefaultInfo(
+                files = depset(
+                    java_info.source_jars,
+                    transitive = [java_info.full_compile_jars],
+                ),
+            ),
+        },
+    )
+
+def _scala_proto_library(ctx):
+    return run_phases(
+        ctx,
+        [
+            ("merge_aspects", phase_merge_aspect_java_info),
+            ("default_info", phase_default_info),
+        ],
+    )
+
+scala_proto_aspect = make_scala_proto_aspect()
+
+def make_scala_proto_library(*extras, aspects = [scala_proto_aspect]):
+    attrs = {
+        "deps": attr.label_list(providers = [ProtoInfo], aspects = aspects),
+    }
+    return rule(
+        implementation = _scala_proto_library,
+        attrs = dicts.add(
+            attrs,
+            extras_phases(extras),
+            *[extra["attrs"] for extra in extras if "attrs" in extra]
+        ),
+        fragments = ["java"],
+        provides = [DefaultInfo, JavaInfo],
+    )
+
+scala_proto_library = make_scala_proto_library(
+    aspects = [
+        scala_proto_aspect,
+    ],
+)

scala_proto/private/scala_proto_default_repositories.bzl renamed to scala_proto/default/repositories.bzl

@@ -3,11 +3,21 @@ load("//scala/private:common.bzl", "write_manifest_file")
 load("//scala/private:dependency.bzl", "legacy_unclear_dependency_info_for_protobuf_scrooge")
 load("//scala/private:rule_impls.bzl", "compile_scala")
 load("//scala/private/toolchain_deps:toolchain_deps.bzl", "find_deps_info_on")
-load("@bazel_tools//tools/jdk:toolchain_utils.bzl", "find_java_runtime_toolchain", "find_java_toolchain")
-
-ScalaPBAspectInfo = provider(fields = [
-    "java_info",
-])
+load(
+    "@bazel_tools//tools/jdk:toolchain_utils.bzl",
+    "find_java_runtime_toolchain",
+    "find_java_toolchain",
+)
+load(
+    "@io_bazel_rules_scala//scala_proto/private:scala_proto_aspect_provider.bzl",
+    "ScalaProtoAspectInfo",
+)
+load(
+    "@io_bazel_rules_scala//scala/private:phases/api.bzl",
+    "extras_phases",
+    "run_aspect_phases",
+)
+load("@bazel_skylib//lib:dicts.bzl", "dicts")
 
 def _import_paths(proto):
     source_root = proto.proto_source_root
@@ -75,7 +85,7 @@ def _generate_sources(ctx, toolchain, proto):
 
     return outputs.values()
 
-def _compile_sources(ctx, toolchain, proto, src_jars, deps):
+def _compile_sources(ctx, toolchain, proto, src_jars, deps, stamp_label):
     output = ctx.actions.declare_file(ctx.label.name + "_scalapb.jar")
     manifest = ctx.actions.declare_file(ctx.label.name + "_MANIFEST.MF")
     write_manifest_file(ctx.actions, manifest, None)
@@ -111,6 +121,7 @@ def _compile_sources(ctx, toolchain, proto, src_jars, deps):
         scalac = toolchain.scalac,
         dependency_info = legacy_unclear_dependency_info_for_protobuf_scrooge(ctx),
         unused_dependency_checker_ignored_targets = [],
+        stamp_target_label = stamp_label,
     )
 
     return JavaInfo(
@@ -122,27 +133,60 @@ def _compile_sources(ctx, toolchain, proto, src_jars, deps):
         runtime_deps = compile_deps,
     )
 
-####
-# This is applied to the DAG of proto_librarys reachable from a deps
-# or a scalapb_scala_library. Each proto_library will be one scalapb
-# invocation assuming it has some sources.
-def _scalapb_aspect_impl(target, ctx):
+def _phase_proto_provider(ctx, p):
+    return p.target[ProtoInfo]
+
+def _phase_deps(ctx, p):
+    return [d[ScalaProtoAspectInfo].java_info for d in ctx.rule.attr.deps]
+
+def _phase_generate_and_compile(ctx, p):
+    proto = p.proto_info
+    deps = p.deps
+    stamp_label = p.stamp_label
     toolchain = ctx.toolchains["@io_bazel_rules_scala//scala_proto:toolchain_type"]
-    proto = target[ProtoInfo]
-    deps = [d[ScalaPBAspectInfo].java_info for d in ctx.rule.attr.deps]
 
     if proto.direct_sources and _code_should_be_generated(ctx, toolchain):
         src_jars = _generate_sources(ctx, toolchain, proto)
-        java_info = _compile_sources(ctx, toolchain, proto, src_jars, deps)
-        return [ScalaPBAspectInfo(java_info = java_info)]
+        java_info = _compile_sources(ctx, toolchain, proto, src_jars, deps, stamp_label)
+        return java_info
     else:
         # this target is only an aggregation target
-        return [ScalaPBAspectInfo(java_info = java_common.merge(deps))]
+        return java_common.merge(deps)
+
+def _phase_aspect_provider(ctx, p):
+    return struct(
+        external_providers = {
+            "ScalaProtoAspectInfo": ScalaProtoAspectInfo(java_info = p.generate_and_compile),
+        },
+    )
+
+def _phase_stamp_label(ctx, p):
+    rule_label = str(p.target.label)
+    toolchain = ctx.toolchains["@io_bazel_rules_scala//scala_proto:toolchain_type"]
 
-scalapb_aspect = aspect(
-    implementation = _scalapb_aspect_impl,
-    attr_aspects = ["deps"],
-    incompatible_use_toolchain_transition = True,
+    if toolchain.stamp_by_convention and rule_label.endswith("_proto"):
+        return rule_label.rstrip("_proto") + "_scala_proto"
+    else:
+        return rule_label
+
+####
+# This is applied to the DAG of proto_librarys reachable from a deps
+# or a scalapb_scala_library. Each proto_library will be one scalapb
+# invocation assuming it has some sources.
+def _scala_proto_aspect_impl(target, ctx):
+    return run_aspect_phases(
+        ctx,
+        [
+            ("proto_info", _phase_proto_provider),
+            ("deps", _phase_deps),
+            ("stamp_label", _phase_stamp_label),
+            ("generate_and_compile", _phase_generate_and_compile),
+            ("aspect_provider", _phase_aspect_provider),
+        ],
+        target = target,
+    )
+
+def make_scala_proto_aspect(*extras):
     attrs = {
         "_java_toolchain": attr.label(
             default = Label("@bazel_tools//tools/jdk:current_java_toolchain"),
@@ -151,10 +195,21 @@ scalapb_aspect = aspect(
             default = Label("@bazel_tools//tools/jdk:current_java_runtime"),
             cfg = "exec",
         ),
-    },
-    toolchains = [
-        "@io_bazel_rules_scala//scala:toolchain_type",
-        "@io_bazel_rules_scala//scala_proto:toolchain_type",
-        "@io_bazel_rules_scala//scala_proto:deps_toolchain_type",
-    ],
-)
+    }
+    return aspect(
+        implementation = _scala_proto_aspect_impl,
+        attr_aspects = ["deps"],
+        incompatible_use_toolchain_transition = True,
+        attrs = dicts.add(
+            attrs,
+            extras_phases(extras),
+            *[extra["attrs"] for extra in extras if "attrs" in extra]
+        ),
+        toolchains = [
+            "@io_bazel_rules_scala//scala:toolchain_type",
+            "@io_bazel_rules_scala//scala_proto:toolchain_type",
+            "@io_bazel_rules_scala//scala_proto:deps_toolchain_type",
+        ],
+    )
+
+scala_proto_aspect = make_scala_proto_aspect()

scala_proto/private/scala_proto.bzl

@@ -0,0 +1,3 @@
+ScalaProtoAspectInfo = provider(fields = [
+    "java_info",
+])

scala_proto/private/scalapb_aspect.bzl renamed to scala_proto/private/scala_proto_aspect.bzl

@@ -0,0 +1,18 @@
+load(
+    "@io_bazel_rules_scala//scala/private/toolchain_deps:toolchain_deps.bzl",
+    "expose_toolchain_deps",
+)
+
+def _export_scalapb_toolchain_deps(ctx):
+    return expose_toolchain_deps(ctx, "@io_bazel_rules_scala//scala_proto:deps_toolchain_type")
+
+export_scalapb_toolchain_deps = rule(
+    _export_scalapb_toolchain_deps,
+    attrs = {
+        "deps_id": attr.string(
+            mandatory = True,
+        ),
+    },
+    incompatible_use_toolchain_transition = True,
+    toolchains = ["@io_bazel_rules_scala//scala_proto:deps_toolchain_type"],
+)