perf(logging): cache colorEnabled instead of recomputing it per log line

colorEnabled re-read sys.env on every single log call

Author: hugo-vrijswijk

maven/src/main/scala/stryker4s/log/MavenMojoLogger.scala

@@ -31,5 +31,5 @@ class MavenMojoLogger(mavenLogger: Log) extends Logger {
     case Level.Error => if mavenLogger.isErrorEnabled() then onError
   }
 
-  override val colorEnabled = MessageUtils.isColorEnabled() && !sys.env.contains("NO_COLOR")
+  override lazy val colorEnabled = MessageUtils.isColorEnabled() && !sys.env.contains("NO_COLOR")
 }

maven/src/main/scala/stryker4s/maven/Stryker4sMavenRunner.scala

@@ -110,7 +110,6 @@ class Stryker4sMavenRunner(
     val binaryVersion = ScalaVersions.binaryVersion(ScalaVersions.fullVersionUnsafe(project))
     resolver
       .resolveTransitively(s"io.stryker-mutator:stryker4s-testrunner_$binaryVersion:$version")
-      .map(_.map(f => Path.fromNioPath(f.toPath)))
   }
 
   /** JVM options for the forked test-runner: the parent's system properties, minus platform/internal ones (mirrors the

maven/src/main/scala/stryker4s/maven/runner/ArtifactResolver.scala

@@ -1,6 +1,7 @@
 package stryker4s.maven.runner
 
 import cats.effect.IO
+import fs2.io.file.Path
 import org.apache.maven.execution.MavenSession
 import org.apache.maven.project.MavenProject
 import org.eclipse.aether.RepositorySystem
@@ -12,7 +13,6 @@ import org.eclipse.aether.util.artifact.JavaScopes
 import org.eclipse.aether.util.filter.DependencyFilterUtils
 import stryker4s.log.Logger
 
-import java.io.File
 import scala.jdk.CollectionConverters.*
 
 /** Resolves Maven artifacts (and their transitive runtime dependencies) at plugin runtime via Aether, against the
@@ -28,15 +28,15 @@ class ArtifactResolver(project: MavenProject, session: MavenSession, repoSystem:
     * @param coordinates
     *   `groupId:artifactId[:extension[:classifier]]:version`
     */
-  def resolveArtifact(coordinates: String): IO[File] = {
+  def resolveArtifact(coordinates: String): IO[Path] = {
     log.debug(s"Resolving artifact $coordinates")
     val request = new ArtifactRequest(new DefaultArtifact(coordinates), repositories, null)
     IO.blocking:
-      repoSystem.resolveArtifact(repoSession, request).getArtifact().getFile()
+      Path.fromNioPath(repoSystem.resolveArtifact(repoSession, request).getArtifact().getPath())
   }
 
   /** Resolve an artifact together with all of its transitive runtime dependencies. */
-  def resolveTransitively(coordinates: String): IO[Seq[File]] = {
+  def resolveTransitively(coordinates: String): IO[Seq[Path]] = {
     log.debug(s"Resolving $coordinates with transitive dependencies")
     val root = new Dependency(new DefaultArtifact(coordinates), JavaScopes.RUNTIME)
     val collectRequest = new CollectRequest(root, repositories)
@@ -49,6 +49,6 @@ class ArtifactResolver(project: MavenProject, session: MavenSession, repoSystem:
         .getArtifactResults()
         .asScala
         .toSeq
-        .map(_.getArtifact().getFile())
+        .map(a => Path.fromNioPath(a.getArtifact().getPath()))
   }
 }

maven/src/main/scala/stryker4s/maven/runner/ZincCompiler.scala

@@ -116,16 +116,22 @@ object ZincCompiler {
         .resolveTransitively(compilerCoords)
         .toResource
         .flatMap(makeScalaInstance(scalaVersion, _))
-      scalac <- resolver.resolveArtifact(bridgeCoords).map(ZincUtil.scalaCompiler(scalaInstance, _)).toResource
+      scalac <- resolver
+        .resolveArtifact(bridgeCoords)
+        .map(p => ZincUtil.scalaCompiler(scalaInstance, p.toNioPath))
+        .toResource
       compilers = ZincUtil.compilers(scalaInstance, ClasspathOptionsUtil.boot(), None, scalac)
     } yield new ZincCompiler(scalaInstance, compilers)
   }
 
-  def makeScalaInstance(scalaVersion: String, scalaCompilerClasspath: Seq[File]): Resource[IO, ScalaInstance] = {
-    val allJars = scalaCompilerClasspath.filterNot { jar =>
-      val name = jar.getName()
-      name.startsWith("compiler-interface") || name.startsWith("util-interface")
-    }.toArray
+  def makeScalaInstance(scalaVersion: String, scalaCompilerClasspath: Seq[Path]): Resource[IO, ScalaInstance] = {
+    val allJars = scalaCompilerClasspath
+      .filterNot { jar =>
+        val name = jar.fileName.toString
+        name.startsWith("compiler-interface") || name.startsWith("util-interface")
+      }
+      .map(_.toNioPath.toFile())
+      .toArray
     val libraryJars = allJars.filter { jar =>
       val name = jar.getName()
       name.startsWith("scala-library") || name.startsWith("scala3-library") || name.startsWith("scala-reflect")

maven/src/test/scala/stryker4s/maven/runner/ZincCompilerTest.scala

@@ -1,19 +1,18 @@
 package stryker4s.maven.runner
 
 import cats.effect.IO
+import fs2.io.file.Path
 import stryker4s.testkit.Stryker4sIOSuite
 
-import java.io.File
-
 class ZincCompilerTest extends Stryker4sIOSuite {
 
   private val jars = Seq(
-    new File("scala-library-2.13.18.jar"),
-    new File("scala3-library_3-3.3.4.jar"),
-    new File("scala-reflect-2.13.18.jar"),
-    new File("scala-compiler-2.13.18.jar"),
-    new File("compiler-interface-2.0.0.jar"),
-    new File("util-interface-2.0.0.jar")
+    Path("scala-library-2.13.18.jar"),
+    Path("scala3-library_3-3.3.4.jar"),
+    Path("scala-reflect-2.13.18.jar"),
+    Path("scala-compiler-2.13.18.jar"),
+    Path("compiler-interface-2.0.0.jar"),
+    Path("util-interface-2.0.0.jar")
   )
 
   test("makeScalaInstance excludes the compiler-interface and util-interface jars from allJars") {

modules/api/src/main/scala/stryker4s/log/Logger.scala

@@ -35,7 +35,7 @@ trait Logger {
   /** Whether colors are enabled in the log. Loggers can override this, a build tool might provide a flag to
     * disable/enable colors
     */
-  protected def colorEnabled: Boolean = {
+  protected lazy val colorEnabled: Boolean = {
 
     // Explicitly disable color https://no-color.org/
     val notNoColor = !sys.env.contains("NO_COLOR")

modules/mill/src/main/scala/stryker4s/log/MillLogger.scala

@@ -25,6 +25,6 @@ class MillLogger(millLogger: MillInternalLogger, env: Map[String, String]) exten
       e.printStackTrace(pw)
       writer.toString()
 
-  override protected def colorEnabled: Boolean =
+  override protected lazy val colorEnabled: Boolean =
     mill.api.daemon.loggerColorEnabled(millLogger) && !env.contains("NO_COLOR")
 }

modules/testkit/src/main/scala/stryker4s/testkit/TestLogger.scala

@@ -37,6 +37,6 @@ protected[testkit] class TestLogger(printLogs: Boolean) extends Logger {
   }
 
   // Always log with colors so we can test for color codes
-  override val colorEnabled = true
+  override lazy val colorEnabled = true
 
 }