Use Providers everywhere and stop using structs

jjudd · jjudd · commit ed11dc5c206d · 2025-02-26T17:00:13.000-07:00
diff --git a/dev/stardoc/stardoc.bzl b/dev/stardoc/stardoc.bzl
@@ -1,4 +1,8 @@
 load("@bazel_skylib//lib:paths.bzl", "paths")
+load(
+    "@rules_scala_annex//rules:providers.bzl",
+    _DocInfo = "DocInfo",
+)
 
 _bzl_files_containing_rules = [
     "//rules:scala.bzl",
@@ -15,7 +19,7 @@ def _get_stardoc_targets():
         sanitized_name = label.removeprefix("//rules:").removeprefix("//rules/").replace(":", "_")
 
         result.append(
-            struct(
+            _DocInfo(
                 name = paths.replace_extension(sanitized_name, "-docs"),
                 input = label,
                 out = paths.replace_extension(sanitized_name, ".md"),
diff --git a/rules/jvm/private/label.bzl b/rules/jvm/private/label.bzl
@@ -1,16 +1,25 @@
 load("@rules_java//java/common:java_info.bzl", "JavaInfo")
-load("@rules_scala_annex//rules:providers.bzl", "LabeledJars")
+load(
+    "@rules_scala_annex//rules:providers.bzl",
+    _LabeledJars = "LabeledJars",
+    _LabeledJarsData = "LabeledJarsData",
+)
 
 def labeled_jars_implementation(target, ctx):
     if JavaInfo not in target:
         return []
 
-    deps_labeled_jars = [dep[LabeledJars] for dep in getattr(ctx.rule.attr, "deps", []) if LabeledJars in dep]
+    deps_labeled_jars = [dep[_LabeledJars] for dep in getattr(ctx.rule.attr, "deps", []) if _LabeledJars in dep]
     java_info = target[JavaInfo]
     return [
-        LabeledJars(
+        _LabeledJars(
             values = depset(
-                [struct(label = ctx.label, jars = depset(transitive = [java_info.compile_jars, java_info.full_compile_jars]))],
+                [
+                    _LabeledJarsData(
+                        label = ctx.label,
+                        jars = depset(transitive = [java_info.compile_jars, java_info.full_compile_jars]),
+                    ),
+                ],
                 order = "preorder",
                 transitive = [labeled_jars.values for labeled_jars in deps_labeled_jars],
             ),
diff --git a/rules/private/coverage_replacements_provider.bzl b/rules/private/coverage_replacements_provider.bzl
@@ -1,5 +1,9 @@
 load("@bazel_skylib//lib:dicts.bzl", _dicts = "dicts")
 load("@rules_java//java/common:java_info.bzl", "JavaInfo")
+load(
+    "@rules_scala_annex//rules:providers.bzl",
+    _CoverageReplacementsData = "CoverageReplacementsData",
+)
 
 #
 # Coverage Replacements are a mapping of normal compiled artifacts to
@@ -73,7 +77,7 @@ _aspect = aspect(
     implementation = _aspect_impl,
 )
 
-coverage_replacements_provider = struct(
+coverage_replacements_provider = _CoverageReplacementsData(
     aspect = _aspect,
     dependency_attributes = _dependency_attributes,
     combine = _combine,
diff --git a/rules/private/phases/api.bzl b/rules/private/phases/api.bzl
@@ -1,5 +1,8 @@
 load(
     "@rules_scala_annex//rules:providers.bzl",
+    _PhasesInfo = "PhasesInfo",
+    _PhasesInitInfo = "PhasesInitInfo",
+    _PhasesOutInfo = "PhasesOutInfo",
     _ScalaConfiguration = "ScalaConfiguration",
     _ScalaRulePhase = "ScalaRulePhase",
 )
@@ -19,23 +22,23 @@ def run_phases(ctx, phases):
         )
 
     result_dict = {
-        "init": struct(
+        "init": _PhasesInitInfo(
             scala_configuration = toolchain.scala_configuration,
         ),
-        "out": struct(
+        "out": _PhasesOutInfo(
             output_groups = {},
             providers = [],
         ),
     }
 
-    result = struct(**result_dict)
+    result = _PhasesInfo(**result_dict)
 
     for (name, function) in phases:
         addition = function(ctx, result)
 
         if addition != None:
             result_dict[name] = addition
-            result = struct(**result_dict)
+            result = _PhasesInfo(**result_dict)
 
     return result
 
diff --git a/rules/private/phases/phase_binary_launcher.bzl b/rules/private/phases/phase_binary_launcher.bzl
@@ -1,4 +1,8 @@
 load("@rules_java//java/common:java_common.bzl", "java_common")
+load(
+    "@rules_scala_annex//rules:providers.bzl",
+    _ZincCompilationInfo = "ZincCompilationInfo",
+)
 load(
     "//rules/common:private/utils.bzl",
     _write_launcher = "write_launcher",
diff --git a/rules/private/phases/phase_classpaths.bzl b/rules/private/phases/phase_classpaths.bzl
@@ -2,6 +2,7 @@ load("@rules_java//java/common:java_common.bzl", "java_common")
 load("@rules_java//java/common:java_info.bzl", "JavaInfo")
 load(
     "@rules_scala_annex//rules:providers.bzl",
+    _ClasspathInfo = "ClasspathInfo",
     _ScalaInfo = "ScalaInfo",
 )
 load(
@@ -64,7 +65,7 @@ def phase_classpaths(ctx, g):
 
     jar = ctx.actions.declare_file("{}/classes.jar".format(ctx.label.name))
 
-    return struct(
+    return _ClasspathInfo(
         srcs = srcs,
         compile = compile_classpath,
         compiler = compiler_classpath,
diff --git a/rules/private/phases/phase_coverage_jacoco.bzl b/rules/private/phases/phase_coverage_jacoco.bzl
@@ -1,6 +1,7 @@
 load(
     "@rules_scala_annex//rules:providers.bzl",
     _CodeCoverageConfiguration = "CodeCoverageConfiguration",
+    _JacocoInfo = "JacocoInfo",
 )
 load(
     "@rules_scala_annex//rules/common:private/utils.bzl",
@@ -57,7 +58,7 @@ def phase_coverage_jacoco(ctx, g):
         ),
     ])
 
-    return struct(replacements = replacements)
+    return _JacocoInfo(replacements = replacements)
 
 def _format_in_out_pairs(in_out_pair):
     return (["--jar", "%s=%s" % (in_out_pair[0].path, in_out_pair[1].path)])
diff --git a/rules/private/phases/phase_ijinfo.bzl b/rules/private/phases/phase_ijinfo.bzl
@@ -10,6 +10,4 @@ load(
 #
 
 def phase_ijinfo(ctx, g):
-    intellij_info = _create_intellij_info(ctx.label, ctx.attr.deps, g.javainfo.java_info)
-    g.out.providers.append(intellij_info)
-    return struct(intellij_info = intellij_info)
+    g.out.providers.append(_create_intellij_info(ctx.label, ctx.attr.deps, g.javainfo.java_info))
diff --git a/rules/private/phases/phase_javainfo.bzl b/rules/private/phases/phase_javainfo.bzl
@@ -3,6 +3,7 @@ load("@rules_java//java/common:java_info.bzl", "JavaInfo")
 load("@rules_java//toolchains:toolchain_utils.bzl", "find_java_toolchain")
 load(
     "@rules_scala_annex//rules:providers.bzl",
+    _JavaScalaInfo = "JavaInfoPhaseInfo",
     _ScalaConfiguration = "ScalaConfiguration",
     _ScalaInfo = "ScalaInfo",
 )
@@ -70,7 +71,7 @@ def phase_javainfo(ctx, g):
     g.out.providers.append(java_info)
     g.out.providers.append(scala_info)
 
-    return struct(
+    return _JavaScalaInfo(
         java_info = java_info,
         scala_info = scala_info,
     )
diff --git a/rules/private/phases/phase_resources.bzl b/rules/private/phases/phase_resources.bzl
@@ -1,6 +1,6 @@
 load(
-    "//rules/common:private/utils.bzl",
-    _action_singlejar = "action_singlejar",
+    "@rules_scala_annex//rules:providers.bzl",
+    _ResourcesInfo = "ResourcesInfo",
 )
 #
 # PHASE: resources
@@ -11,6 +11,11 @@ load(
 # phase will merge it into the final jar.
 #
 
+load(
+    "//rules/common:private/utils.bzl",
+    _action_singlejar = "action_singlejar",
+)
+
 def phase_resources(ctx, g):
     if ctx.files.resources:
         resource_jar = ctx.actions.declare_file("{}/resources.jar".format(ctx.label.name))
@@ -24,9 +29,9 @@ def phase_resources(ctx, g):
                 for file in ctx.files.resources
             },
         )
-        return struct(jar = resource_jar)
+        return _ResourcesInfo(jar = resource_jar)
     else:
-        return struct()
+        return _ResourcesInfo()
 
 def _resources_make_path(file, strip_prefix):
     if strip_prefix:
diff --git a/rules/private/phases/phase_semanticdb.bzl b/rules/private/phases/phase_semanticdb.bzl
@@ -3,6 +3,7 @@ load(
     "@rules_scala_annex//rules:providers.bzl",
     _ScalaConfiguration = "ScalaConfiguration",
     _SemanticDbInfo = "SemanticDbInfo",
+    _SemanticDbPhaseInfo = "SemanticDbPhaseInfo",
 )
 
 def _semanticdb_directory_from_output_jar(file):
@@ -25,7 +26,7 @@ def phase_semanticdb(ctx, g):
     toolchain = ctx.toolchains["//rules/scala:toolchain_type"]
 
     if toolchain.scala_configuration.semanticdb_bundle:
-        return struct(outputs = [], arguments_modifier = lambda _: None)
+        return _SemanticDbPhaseInfo(outputs = [], arguments_modifier = lambda _: None)
 
     directory_name = "{}/semanticdb".format(ctx.label.name)
     outputs = []
@@ -75,4 +76,4 @@ def phase_semanticdb(ctx, g):
         ),
     )
 
-    return struct(outputs = outputs, arguments_modifier = add_scalacopts)
+    return _SemanticDbPhaseInfo(outputs = outputs, arguments_modifier = add_scalacopts)
diff --git a/rules/private/phases/phase_zinc_compile.bzl b/rules/private/phases/phase_zinc_compile.bzl
@@ -3,7 +3,9 @@ load("@rules_java//toolchains:toolchain_utils.bzl", "find_java_toolchain")
 load(
     "@rules_scala_annex//rules:providers.bzl",
     _ScalaConfiguration = "ScalaConfiguration",
+    _ZincCompilationInfo = "ZincCompilationInfo",
     _ZincConfiguration = "ZincConfiguration",
+    _ZincDepInfo = "ZincDepInfo",
     _ZincInfo = "ZincInfo",
 )
 load(
@@ -123,7 +125,7 @@ def phase_zinc_compile(ctx, g):
         deps_files = depset([analysis_store], transitive = [zinc.deps_files for zinc in zincs]),
         label = ctx.label,
         deps = depset(
-            [struct(
+            [_ZincDepInfo(
                 analysis_store = analysis_store,
                 jars = tuple(jars),
                 label = ctx.label,
@@ -133,7 +135,7 @@ def phase_zinc_compile(ctx, g):
     )
 
     g.out.providers.append(zinc_info)
-    return struct(
+    return _ZincCompilationInfo(
         mains_file = mains_file,
         used = used,
         # todo: see about cleaning up & generalizing fields below
diff --git a/rules/private/phases/phase_zinc_depscheck.bzl b/rules/private/phases/phase_zinc_depscheck.bzl
@@ -2,6 +2,7 @@ load(
     "@rules_scala_annex//rules:providers.bzl",
     _DepsConfiguration = "DepsConfiguration",
     _LabeledJars = "LabeledJars",
+    _ZincCompilationInfo = "ZincCompilationInfo",
 )
 load(
     "@rules_scala_annex//rules/common:private/utils.bzl",
diff --git a/rules/providers.bzl b/rules/providers.bzl
@@ -88,3 +88,111 @@ SemanticDbInfo = provider(
         "semanticdb_files": "The SemanticDB files.",
     },
 )
+
+CoverageReplacementsData = provider(
+    doc = "Data for coverage replacements",
+    fields = {
+        "aspect": "Coverage replacement aspect",
+        "dependency_attributes": "attributes used to form the dependency graph that we'll fold over for our aggregation",
+        "combine": "Function used to combine coverage replacements",
+        "from_ctx": "Function used to combine coverage replacements from a ctx",
+        "create": "Provider to use for coverage replacements",
+    },
+)
+
+ClasspathInfo = provider(
+    doc = "Outputs from the classpath phase.",
+    fields = {
+        "compile": "Classpath for this compilation.",
+        "compiler": "Classpath needed by the compiler for this compilation.",
+        "jar": "Output jar for this compilation.",
+        "plugin": "Classpath for the compiler plugins for this compilation.",
+        "sdeps": "Deps. TODO: better name for this?",
+        "src_jars": "Source jars for this compilation.",
+        "srcs": "Source files for this compilation.",
+    },
+)
+
+DocInfo = provider(
+    doc = "Documentation realted info for a label.",
+    fields = {
+        "input": "Associated label",
+        "name": "Docs label name",
+        "out": "Docs file",
+    },
+)
+
+LabeledJarsData = provider(
+    doc = "Data for LabeledJars",
+    fields = {
+        "jars": "Jars associated with the label",
+        "label": "Label for the jars",
+    },
+)
+
+JacocoInfo = provider(
+    doc = "Outputs from the Jacoco phase.",
+    fields = {
+        "replacements": "Coverage Replacement provider",
+    },
+)
+
+JavaInfoPhaseInfo = provider(
+    doc = "Outputs from the JavaInfo phase.",
+    fields = {
+        "java_info": "JavaInfo provider",
+        "scala_info": "ScalaInfo provider",
+    },
+)
+
+PhasesInfo = provider(
+    doc = "Info related to the phases to run.",
+)
+
+PhasesInitInfo = provider(
+    doc = "Init information needed for phases",
+    fields = {
+        "scala_configuration": "Scala configuration for the toolchain.",
+    },
+)
+
+PhasesOutInfo = provider(
+    doc = "Output related information for phases.",
+    fields = {
+        "output_groups": "Output groups",
+        "providers": "Providers",
+    },
+)
+
+ResourcesInfo = provider(
+    doc = "Outputs from the resources phase",
+    fields = {
+        "jar": "Resource jar containing resource files",
+    },
+)
+
+SemanticDbPhaseInfo = provider(
+    doc = "Outputs from the SemanticDB phase.",
+    fields = {
+        "arguments_modifier": "Function to call to modify the scalac arguments for SemanticDB support.",
+        "outputs": "Extra outputs for the SemanticDB files.",
+    },
+)
+
+ZincCompilationInfo = provider(
+    doc = "Outputs from the Zinc compilation phase.",
+    fields = {
+        "mains_file": "File containing the main methods of this compilation.",
+        "used": "File containing the used deps for this compilation.",
+        "zinc_info": "a ZincInfo provider for this compilation.",
+    },
+)
+
+ZincDepInfo = provider(
+    doc = "Information for a dep in a ZincInfo",
+    fields = {
+        "analysis_store": "Analysis store for this label",
+        "jars": "Jars for this label",
+        "label": "The label for this dep",
+    },
+)

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,4 @@ load(`
`10`	`10`	`#`
`11`	`11`
`12`	`12`	`def phase_ijinfo(ctx, g):`
`13`		`- intellij_info = _create_intellij_info(ctx.label, ctx.attr.deps, g.javainfo.java_info)`
`14`		`- g.out.providers.append(intellij_info)`
`15`		`- return struct(intellij_info = intellij_info)`
	`13`	`+ g.out.providers.append(_create_intellij_info(ctx.label, ctx.attr.deps, g.javainfo.java_info))`