Use ConsistentAnalysisStore

sbt/zinc#1326

rules/private/phases/phase_test_launcher.bzl

@@ -16,7 +16,7 @@ load(
 #
 
 def phase_test_launcher(ctx, g):
-    files = ctx.attr._target_jdk[java_common.JavaRuntimeInfo].files.to_list() + [g.compile.zinc_info.apis]
+    files = ctx.attr._target_jdk[java_common.JavaRuntimeInfo].files.to_list() + [g.compile.zinc_info.analysis_store]
 
     coverage_replacements = {}
     coverage_runner_jars = depset(direct = [])
@@ -35,7 +35,7 @@ def phase_test_launcher(ctx, g):
     all_jars = [test_jars, runner_jars]
 
     args = ctx.actions.args()
-    args.add("--apis", g.compile.zinc_info.apis.short_path)
+    args.add("--analysis_store", g.compile.zinc_info.analysis_store.short_path)
     args.add_all("--frameworks", ctx.attr.frameworks)
     if ctx.attr.isolation == "classloader":
         shared_deps = java_common.merge(_collect(JavaInfo, ctx.attr.shared_deps))

rules/private/phases/phase_zinc_compile.bzl

@@ -23,14 +23,9 @@ def phase_zinc_compile(ctx, g):
     scala_configuration = ctx.attr.scala[_ScalaConfiguration]
     zinc_configuration = ctx.attr.scala[_ZincConfiguration]
 
-    apis = ctx.actions.declare_file("{}/apis.gz".format(ctx.label.name))
-    infos = ctx.actions.declare_file("{}/infos.gz".format(ctx.label.name))
+    analysis_store = ctx.actions.declare_file("{}/analysis_store.gz".format(ctx.label.name))
     mains_file = ctx.actions.declare_file("{}.jar.mains.txt".format(ctx.label.name))
-    relations = ctx.actions.declare_file("{}/relations.gz".format(ctx.label.name))
-    setup = ctx.actions.declare_file("{}/setup.gz".format(ctx.label.name))
-    stamps = ctx.actions.declare_file("{}/stamps.gz".format(ctx.label.name))
     used = ctx.actions.declare_file("{}/deps_used.txt".format(ctx.label.name))
-
     tmp = ctx.actions.declare_directory("{}/tmp".format(ctx.label.name))
 
     javacopts = [
@@ -53,12 +48,8 @@ def phase_zinc_compile(ctx, g):
     args.add_all(javacopts, format_each = "--java_compiler_option=%s")
     args.add(ctx.label, format = "--label=%s")
     args.add("--main_manifest", mains_file)
-    args.add("--output_apis", apis)
-    args.add("--output_infos", infos)
+    args.add("--output_analysis_store", analysis_store)
     args.add("--output_jar", g.classpaths.jar)
-    args.add("--output_relations", relations)
-    args.add("--output_setup", setup)
-    args.add("--output_stamps", stamps)
     args.add("--output_used", used)
     args.add_all("--plugins", g.classpaths.plugin)
     args.add_all("--source_jars", g.classpaths.src_jars)
@@ -81,7 +72,18 @@ def phase_zinc_compile(ctx, g):
         ] + [zinc.deps_files for zinc in zincs],
     )
 
-    outputs = [g.classpaths.jar, mains_file, apis, infos, relations, setup, stamps, used, tmp]
+    outputs = [g.classpaths.jar, mains_file, analysis_store, used, tmp]
+
+    execution_requirements_tags = {
+        "supports-multiplex-workers": "1",
+        "supports-workers": "1",
+    }
+
+    # Disable sandboxing if incremental compilation features are going to be used
+    # because they require stashing files outside the sandbox that Bazel isn't
+    # aware of.
+    if zinc_configuration.incremental:
+        execution_requirements_tags["no-sandbox"] = "1"
 
     # todo: different execution path for nosrc jar?
     ctx.actions.run(
@@ -90,7 +92,10 @@ def phase_zinc_compile(ctx, g):
         outputs = outputs,
         executable = worker.files_to_run.executable,
         input_manifests = input_manifests,
-        execution_requirements = _resolve_execution_reqs(ctx, {"no-sandbox": "1", "supports-multiplex-workers": "1", "supports-workers": "1"}),
+        execution_requirements = _resolve_execution_reqs(
+            ctx,
+            execution_requirements_tags,
+        ),
         arguments = [args],
     )
 
@@ -99,16 +104,14 @@ def phase_zinc_compile(ctx, g):
         jars.append(jar.class_jar)
         jars.append(jar.ijar)
     zinc_info = _ZincInfo(
-        apis = apis,
-        deps_files = depset([apis, relations], transitive = [zinc.deps_files for zinc in zincs]),
+        analysis_store = analysis_store,
+        deps_files = depset([analysis_store], transitive = [zinc.deps_files for zinc in zincs]),
         label = ctx.label,
-        relations = relations,
         deps = depset(
             [struct(
-                apis = apis,
+                analysis_store = analysis_store,
                 jars = tuple(jars),
                 label = ctx.label,
-                relations = relations,
             )],
             transitive = [zinc.deps for zinc in zincs],
         ),
@@ -126,6 +129,5 @@ def _compile_analysis(analysis):
     return [
         "--analysis",
         "_{}".format(analysis.label),
-        analysis.apis.path,
-        analysis.relations.path,
+        analysis.analysis_store.path,
     ] + [jar.path for jar in analysis.jars]

rules/providers.bzl

@@ -66,6 +66,7 @@ ZincConfiguration = provider(
         "compiler_bridge": "compiled Zinc compiler bridge",
         "compile_worker": "the worker label for compilation with Zinc",
         "log_level": "log level for the Zinc compiler",
+        "incremental": "whether incremental compilation will be available for this Zinc compiler",
     },
 )
 
@@ -156,11 +157,10 @@ declare_zinc_configuration = rule(
 ZincInfo = provider(
     doc = "Zinc-specific outputs.",
     fields = {
-        "apis": "The API file.",
+        "analysis_store": "The analysis store file.",
         "deps": "The depset of library dependency outputs.",
         "deps_files": "The depset of all Zinc files.",
         "label": "The label for this output.",
-        "relations": "The relations file.",
     },
 )
 

rules/scala.bzl

@@ -536,6 +536,10 @@ _configure_zinc_scala = rule(
         ),
         "deps_direct": attr.string(default = "error"),
         "deps_used": attr.string(default = "error"),
+        "incremental": attr.bool(
+            doc = "Whether Zinc's incremental compilation will be available for this Zinc compiler. If True, this requires additional configuration to use incremental compilation.",
+            default = False,
+        ),
         "_compile_worker": attr.label(
             default = "@rules_scala_annex//src/main/scala/higherkindness/rules_scala/workers/zinc/compile",
             allow_files = True,

rules/scala/private/provider.bzl

@@ -47,6 +47,7 @@ def configure_zinc_scala_implementation(ctx):
             compile_worker = ctx.attr._compile_worker,
             compiler_bridge = ctx.file.compiler_bridge,
             log_level = ctx.attr.log_level,
+            incremental = ctx.attr.incremental,
         ),
         _DepsConfiguration(
             direct = ctx.attr.deps_direct,

src/main/scala/higherkindness/rules_scala/common/sbt-testing/BUILD

@@ -25,6 +25,9 @@ scala_library(
     srcs = _common_srcs,
     scala = "//src/main/scala:zinc",
     visibility = ["//visibility:public"],
+    deps_used_whitelist = [
+        "@annex//:org_scala_lang_scala_library",
+    ],
     deps = [
         "@annex//:org_scala_lang_modules_scala_xml_2_13",
         "@annex//:org_scala_sbt_test_interface",

src/main/scala/higherkindness/rules_scala/workers/common/AnalysisUtil.scala

@@ -0,0 +1,30 @@
+package higherkindness.rules_scala
+package workers.common
+
+import java.io.File
+import sbt.internal.inc.Analysis
+import sbt.internal.inc.consistent.ConsistentFileAnalysisStore
+import xsbti.compile.AnalysisStore
+import xsbti.compile.analysis.ReadWriteMappers
+
+object AnalysisUtil {
+  def getAnalysisStore(analysisStoreFile: File, debug: Boolean): AnalysisStore = {
+    if (debug) {
+      ConsistentFileAnalysisStore.text(
+        analysisStoreFile,
+        ReadWriteMappers.getEmptyMappers,
+        sort = true,
+      )
+    } else {
+      ConsistentFileAnalysisStore.binary(
+        analysisStoreFile,
+        ReadWriteMappers.getEmptyMappers,
+        sort = true,
+      )
+    }
+  }
+
+  def getAnalysis(analysisStore: AnalysisStore): Analysis = {
+    analysisStore.get().get().getAnalysis.asInstanceOf[Analysis]
+  }
+}

src/main/scala/higherkindness/rules_scala/workers/common/CommonArguments.scala

@@ -22,7 +22,7 @@ object CommonArguments {
     parser
       .addArgument("--analysis")
       .action(ArgumentsImpl.append)
-      .help("Analysis, given as: label apis relations [jar ...]")
+      .help("Analysis, given as: label analysis_store [jar ...]")
       .metavar("args")
       .nargs("*")
     parser
@@ -76,14 +76,8 @@ object CommonArguments {
       .required(true)
       .`type`(ArgumentsImpl.fileType.verifyCanCreate)
     parser
-      .addArgument("--output_apis")
-      .help("Output APIs")
-      .metavar("path")
-      .required(true)
-      .`type`(ArgumentsImpl.fileType.verifyCanCreate())
-    parser
-      .addArgument("--output_infos")
-      .help("Output Zinc source infos")
+      .addArgument("--output_analysis_store")
+      .help("Output Analysis Store")
       .metavar("path")
       .required(true)
       .`type`(ArgumentsImpl.fileType.verifyCanCreate())
@@ -93,24 +87,6 @@ object CommonArguments {
       .metavar("path")
       .required(true)
       .`type`(ArgumentsImpl.fileType.verifyCanCreate())
-    parser
-      .addArgument("--output_relations")
-      .help("Output Zinc relations")
-      .metavar("path")
-      .required(true)
-      .`type`(ArgumentsImpl.fileType.verifyCanCreate())
-    parser
-      .addArgument("--output_setup")
-      .help("Output Zinc setup")
-      .metavar("path")
-      .required(true)
-      .`type`(ArgumentsImpl.fileType.verifyCanCreate())
-    parser
-      .addArgument("--output_stamps")
-      .help("Output Zinc source stamps")
-      .metavar("path")
-      .required(true)
-      .`type`(ArgumentsImpl.fileType.verifyCanCreate())
     parser
       .addArgument("--output_used")
       .help("Output list of used jars")