Add support for -Xshow-phases (#1314)

Fix & Unit Test
sbt · Dec 24, 2023 · c68a4c2 · c68a4c2
1 parent 1c809a6
commit c68a4c2
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 3 deletions.
diff --git a/internal/compiler-bridge/src/main/scala/xsbt/CallbackGlobal.scala b/internal/compiler-bridge/src/main/scala/xsbt/CallbackGlobal.scala
@@ -102,6 +102,8 @@ sealed class ZincCompiler(settings: Settings, dreporter: DelegatingReporter, out
     val analyzer = new Analyzer(global)
     def newPhase(prev: Phase) = analyzer.newPhase(prev)
     def name = phaseName
+
+    def description = "analyze the generated class files and map them to sources"
   }
 
   /** Phase that extracts dependency information */
@@ -116,6 +118,8 @@ sealed class ZincCompiler(settings: Settings, dreporter: DelegatingReporter, out
     val dependency = new Dependency(global)
     def newPhase(prev: Phase) = dependency.newPhase(prev)
     def name = phaseName
+
+    def description = "extract dependency information"
   }
 
   /**
@@ -136,13 +140,18 @@ sealed class ZincCompiler(settings: Settings, dreporter: DelegatingReporter, out
     val api = new API(global)
     def newPhase(prev: Phase) = api.newPhase(prev)
     def name = phaseName
+
+    def description = "construct a representation of the public API"
   }
 
   override lazy val phaseDescriptors = {
     phasesSet += sbtAnalyzer
+    phasesDescMap(sbtAnalyzer) = sbtAnalyzer.description
     if (callback.enabled()) {
       phasesSet += sbtDependency
+      phasesDescMap(sbtDependency) = sbtDependency.description
       phasesSet += apiExtractor
+      phasesDescMap(apiExtractor) = apiExtractor.description
     }
     this.computePhaseDescriptors
   }

diff --git a/internal/compiler-bridge/src/main/scala/xsbt/CompilerBridge.scala b/internal/compiler-bridge/src/main/scala/xsbt/CompilerBridge.scala
@@ -152,14 +152,14 @@ private final class CachedCompiler0(
     // cast down to AnalysisCallback2
     val callback2 = callback.asInstanceOf[xsbti.AnalysisCallback2]
 
+    compiler.set(callback, underlyingReporter)
     if (command.shouldStopWithInfo) {
       underlyingReporter.info(null, command.getInfoMessage(compiler), true)
       throw new InterfaceCompileFailed(args, Array(), StopInfoError)
     }
 
     if (noErrors(underlyingReporter)) {
       debug(log, prettyPrintCompilationArguments(args))
-      compiler.set(callback, underlyingReporter)
       val run = new compiler.ZincRun(compileProgress)
 
       run.compileFiles(sources)

diff --git a/zinc/src/test/scala/sbt/inc/IncrementalCompilerSpec.scala b/zinc/src/test/scala/sbt/inc/IncrementalCompilerSpec.scala
@@ -211,4 +211,18 @@ class IncrementalCompilerSpec extends BaseCompilerSpec {
       comp.close()
     }
   }
+
+  it should "not throw NullPointerException when passing -Xshow-phases to scalac" in withTmpDir {
+    tmp =>
+      val comp = ProjectSetup.simple(
+        tmp.toPath,
+        Seq(SourceFiles.Good),
+        Seq("-Xshow-phases")
+      ).createCompiler()
+      try {
+        assertThrows[CompileFailed] {
+          comp.doCompile()
+        }
+      } finally comp.close()
+  }
 }
diff --git a/zinc/src/test/scala/sbt/inc/TestProjectSetup.scala b/zinc/src/test/scala/sbt/inc/TestProjectSetup.scala
@@ -148,9 +148,13 @@ case class CompilerSetup(
 case class ProjectPaths(baseDir: Path) {}
 
 object ProjectSetup {
-  def simple(baseDir: Path, classes: Seq[String]): ProjectSetup = {
+  def simple(
+      baseDir: Path,
+      classes: Seq[String],
+      scalacOptions: Seq[String] = Nil
+  ): ProjectSetup = {
     val sources = Map(Paths.get("src") -> classes.map(Paths.get(_)))
-    ProjectSetup(VirtualSubproject(baseDir), sources, Nil, Map.empty)
+    ProjectSetup(VirtualSubproject(baseDir), sources, Nil, Map.empty, scalacOptions = scalacOptions)
   }
 }