Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pass auxiliary class files to zinc so they are deleted together #3072

Merged
merged 13 commits into from
Mar 11, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
object foo
20 changes: 20 additions & 0 deletions integration/feature/auxiliary-class-files/repo/build.sc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
// Issue https://github.com/com-lihaoyi/mill/issues/3068
import mill._
import mill.scalalib._
import mill.scalajslib._
import mill.scalanativelib._

object app extends Module {
trait Common extends ScalaModule {
def millSourcePath = super.millSourcePath / os.up
def scalaVersion = "3.4.0"
}

object jvm extends Common
object js extends Common with ScalaJSModule {
def scalaJSVersion = "1.15.0"
}
object native extends Common with ScalaNativeModule {
def scalaNativeVersion = "0.4.17"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
package mill.integration

import utest._

// Regress test for issue https://github.com/com-lihaoyi/mill/issues/1901
object AuxiliaryClassFilesTests extends IntegrationTestSuite {
val tests: Tests = Tests {
test("tasty files are deleted together with companion class files") {
initWorkspace()
assert(eval("app.jvm.compile"))

val classes = wd / "out" / "app" / "jvm" / "compile.dest" / "classes"
val firstRun = os.list(classes).map(_.last)

os.remove(wd / "app" / "src" / "foo.scala")

assert(eval("app.jvm.compile"))

val secondRun = os.list(classes).map(_.last)

assert(firstRun == Seq("foo$.class", "foo.class", "foo.tasty"))
assert(secondRun == Seq.empty)
}

test("compilation fails when deleting a class used by other files") {
initWorkspace()

os.write(wd / "app" / "src" / "bar.scala", "object bar { println(foo) }")
val firstRunSuccessful = eval("app.jvm.compile")
assert(firstRunSuccessful)

val classes = wd / "out" / "app" / "jvm" / "compile.dest" / "classes"
val firstRun = os.list(classes).map(_.last)

os.remove(wd / "app" / "src" / "foo.scala")

val secondRunSuccessful = eval("app.jvm.compile")
assert(!secondRunSuccessful)

val secondRun = os.list(classes).map(_.last)

assert(firstRun == Seq(
"bar$.class",
"bar.class",
"bar.tasty",
"foo$.class",
"foo.class",
"foo.tasty"
))
assert(secondRun == Seq.empty)
}

test("nir files are deleted together with companion class files") {
initWorkspace()
assert(eval("app.native.compile"))

val classes = wd / "out" / "app" / "native" / "compile.dest" / "classes"
val firstRun = os.list(classes).map(_.last)

os.remove(wd / "app" / "src" / "foo.scala")

assert(eval("app.native.compile"))

val secondRun = os.list(classes).map(_.last)

assert(firstRun == Seq("foo$.class", "foo$.nir", "foo.class", "foo.nir", "foo.tasty"))
assert(secondRun == Seq.empty)
}

test("sjsir files are deleted together with companion class files") {
initWorkspace()
assert(eval("app.js.compile"))

val classes = wd / "out" / "app" / "js" / "compile.dest" / "classes"
val firstRun = os.list(classes).map(_.last)

os.remove(wd / "app" / "src" / "foo.scala")

assert(eval("app.js.compile"))

val secondRun = os.list(classes).map(_.last)

assert(firstRun == Seq("foo$.class", "foo$.sjsir", "foo.class", "foo.tasty"))
assert(secondRun == Seq.empty)
}
}
}
2 changes: 2 additions & 0 deletions scalajslib/src/mill/scalajslib/ScalaJSModule.scala
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,8 @@ trait ScalaJSModule extends scalalib.ScalaModule { outer =>
))
}

override protected def auxiliaryClassFileExtensions: T[Seq[String]] = super.auxiliaryClassFileExtensions() :+ "sjsir"

}

trait TestScalaJSModule extends ScalaJSModule with TestModule {
Expand Down
44 changes: 40 additions & 4 deletions scalalib/api/src/mill/scalalib/api/ZincWorkerApi.scala
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ trait ZincWorkerApi {
scalacPluginClasspath: Agg[PathRef],
reporter: Option[CompileProblemReporter],
reportCachedProblems: Boolean,
incrementalCompilation: Boolean
incrementalCompilation: Boolean,
auxiliaryClassFileExtensions: Seq[String]
)(implicit ctx: ZincWorkerApi.Ctx): mill.api.Result[CompilationResult] =
compileMixed(
upstreamCompileOutput = upstreamCompileOutput,
Expand All @@ -75,8 +76,10 @@ trait ZincWorkerApi {
compilerClasspath = compilerClasspath,
scalacPluginClasspath = scalacPluginClasspath,
reporter = reporter,
reportCachedProblems = reportCachedProblems
): @nowarn("cat=deprecation")
reportCachedProblems = reportCachedProblems,
incrementalCompilation = incrementalCompilation,
auxiliaryClassFileExtensions = auxiliaryClassFileExtensions
)

/** Compile a mixed Scala/Java or Scala-only project */
@deprecated("Use override with `incrementalCompilation` parameter", "Mill 0.11.6")
Expand Down Expand Up @@ -105,7 +108,40 @@ trait ZincWorkerApi {
scalacPluginClasspath = scalacPluginClasspath,
reporter = reporter,
reportCachedProblems = reportCachedProblems,
incrementalCompilation = true
incrementalCompilation = true,
auxiliaryClassFileExtensions = Seq.empty[String]
)

/** Compile a mixed Scala/Java or Scala-only project */
@deprecated("Use override with `platformSuffix` parameter", "Mill 0.11.8")
lolgab marked this conversation as resolved.
Show resolved Hide resolved
def compileMixed(
upstreamCompileOutput: Seq[CompilationResult],
sources: Agg[os.Path],
compileClasspath: Agg[os.Path],
javacOptions: Seq[String],
scalaVersion: String,
scalaOrganization: String,
scalacOptions: Seq[String],
compilerClasspath: Agg[PathRef],
scalacPluginClasspath: Agg[PathRef],
reporter: Option[CompileProblemReporter],
reportCachedProblems: Boolean,
incrementalCompilation: Boolean
)(implicit ctx: ZincWorkerApi.Ctx): mill.api.Result[CompilationResult] =
compileMixed(
upstreamCompileOutput = upstreamCompileOutput,
sources = sources,
compileClasspath = compileClasspath,
javacOptions = javacOptions,
scalaVersion = scalaVersion,
scalaOrganization = scalaOrganization,
scalacOptions = scalacOptions,
compilerClasspath = compilerClasspath,
scalacPluginClasspath = scalacPluginClasspath,
reporter = reporter,
reportCachedProblems = reportCachedProblems,
incrementalCompilation = incrementalCompilation,
auxiliaryClassFileExtensions = Seq.empty[String]
)

def discoverMainClasses(compilationResult: CompilationResult): Seq[String]
Expand Down
14 changes: 12 additions & 2 deletions scalalib/src/mill/scalalib/ScalaModule.scala
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,8 @@ trait ScalaModule extends JavaModule with TestModule.ScalaModuleBase { outer =>
scalacPluginClasspath = scalacPluginClasspath(),
reporter = T.reporter.apply(hashCode),
reportCachedProblems = zincReportCachedProblems(),
incrementalCompilation = zincIncrementalCompilation()
incrementalCompilation = zincIncrementalCompilation(),
auxiliaryClassFileExtensions = auxiliaryClassFileExtensions()
)
}

Expand Down Expand Up @@ -548,6 +549,14 @@ trait ScalaModule extends JavaModule with TestModule.ScalaModuleBase { outer =>
else ZincWorkerUtil.scalaBinaryVersion(scalaVersion())
}

/**
* Files extensions that need to be managed by Zinc together with class files
*/
protected def auxiliaryClassFileExtensions: T[Seq[String]] = T {
lefou marked this conversation as resolved.
Show resolved Hide resolved
if (ZincWorkerUtil.isScala3(scalaVersion())) Seq("tasty")
else Seq.empty[String]
}

override def artifactSuffix: T[String] = s"${platformSuffix()}_${artifactScalaVersion()}"

override def artifactId: T[String] = artifactName() + artifactSuffix()
Expand Down Expand Up @@ -665,7 +674,8 @@ trait ScalaModule extends JavaModule with TestModule.ScalaModuleBase { outer =>
scalacPluginClasspath = semanticDbPluginClasspath(),
reporter = None,
reportCachedProblems = zincReportCachedProblems(),
incrementalCompilation = zincIncrementalCompilation()
incrementalCompilation = zincIncrementalCompilation(),
auxiliaryClassFileExtensions = auxiliaryClassFileExtensions()
)
.map(r =>
SemanticDbJavaModule.copySemanticdbFiles(r.classes.path, T.workspace, T.dest / "data")
Expand Down
18 changes: 13 additions & 5 deletions scalalib/worker/src/mill/scalalib/worker/ZincWorkerImpl.scala
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import sbt.internal.util.{ConsoleAppender, ConsoleOut}
import sbt.mill.SbtLoggerUtils
import xsbti.compile.{
AnalysisContents,
AuxiliaryClassFileExtension,
ClasspathOptions,
CompileAnalysis,
CompileOrder,
Expand Down Expand Up @@ -306,7 +307,8 @@ class ZincWorkerImpl(
compilers = javaOnlyCompilers(javacOptions),
reporter = reporter,
reportCachedProblems = reportCachedProblems,
incrementalCompilation = incrementalCompilation
incrementalCompilation = incrementalCompilation,
auxiliaryClassFileExtensions = Seq.empty[String]
)
}

Expand All @@ -322,7 +324,8 @@ class ZincWorkerImpl(
scalacPluginClasspath: Agg[PathRef],
reporter: Option[CompileProblemReporter],
reportCachedProblems: Boolean,
incrementalCompilation: Boolean
incrementalCompilation: Boolean,
auxiliaryClassFileExtensions: Seq[String]
)(implicit ctx: ZincWorkerApi.Ctx): Result[CompilationResult] = {
withCompilers(
scalaVersion = scalaVersion,
Expand All @@ -340,7 +343,8 @@ class ZincWorkerImpl(
compilers = compilers,
reporter = reporter,
reportCachedProblems: Boolean,
incrementalCompilation
incrementalCompilation,
auxiliaryClassFileExtensions
)
}
}
Expand Down Expand Up @@ -423,7 +427,8 @@ class ZincWorkerImpl(
compilers: Compilers,
reporter: Option[CompileProblemReporter],
reportCachedProblems: Boolean,
incrementalCompilation: Boolean
incrementalCompilation: Boolean,
auxiliaryClassFileExtensions: Seq[String]
)(implicit ctx: ZincWorkerApi.Ctx): Result[CompilationResult] = {
os.makeDir.all(ctx.dest)

Expand Down Expand Up @@ -496,6 +501,9 @@ class ZincWorkerImpl(
.map(path => converter.toVirtualFile(path.toNIO))
.toArray

val incOptions =
IncOptions.of().withAuxiliaryClassFiles(auxiliaryClassFileExtensions.map(new AuxiliaryClassFileExtension(_)).toArray)

val inputs = ic.inputs(
classpath = classpath,
sources = virtualSources,
Expand All @@ -512,7 +520,7 @@ class ZincWorkerImpl(
skip = false,
cacheFile = zincFile.toNIO,
cache = new FreshCompilerCache,
incOptions = IncOptions.of(),
incOptions = incOptions,
reporter = newReporter,
progress = None,
earlyAnalysisStore = None,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,8 @@ trait ScalaNativeModule extends ScalaModule { outer =>
}
}

override protected def auxiliaryClassFileExtensions: T[Seq[String]] = super.auxiliaryClassFileExtensions() :+ "nir"

}

trait TestScalaNativeModule extends ScalaNativeModule with TestModule {
Expand Down
Loading