Always start Bloop under specific dir under home

Rather than in the current directory, which users might delete later on,
which sometimes prevents Bloop from starting sub-processes (like javac…)

Author: alexarchambault

modules/bloop-rifle/src/main/scala/scala/build/blooprifle/BloopRifle.scala

@@ -54,6 +54,7 @@ object BloopRifle {
           bloopJava,
           config.javaOpts,
           cp.map(_.toPath),
+          config.workingDir,
           scheduler,
           config.startCheckPeriod,
           config.startCheckTimeout,

modules/bloop-rifle/src/main/scala/scala/build/blooprifle/BloopRifleConfig.scala

@@ -12,6 +12,7 @@ final case class BloopRifleConfig(
   javaPath: String,
   javaOpts: Seq[String],
   classPath: String => Either[Throwable, Seq[File]],
+  workingDir: File,
   bspSocketOrPort: Option[() => BspConnectionAddress],
   bspStdin: Option[InputStream],
   bspStdout: Option[OutputStream],
@@ -116,13 +117,15 @@ object BloopRifleConfig {
 
   def default(
     address: Address,
-    bloopClassPath: String => Either[Throwable, Seq[File]]
+    bloopClassPath: String => Either[Throwable, Seq[File]],
+    workingDir: File
   ): BloopRifleConfig =
     BloopRifleConfig(
       address = address,
       javaPath = "java",
       javaOpts = defaultJavaOpts,
       classPath = bloopClassPath,
+      workingDir = workingDir,
       bspSocketOrPort = None,
       bspStdin = None,
       bspStdout = None,

modules/bloop-rifle/src/main/scala/scala/build/blooprifle/internal/Operations.scala

@@ -102,6 +102,7 @@ object Operations {
     javaPath: String,
     javaOpts: Seq[String],
     classPath: Seq[Path],
+    workingDir: File,
     scheduler: ScheduledExecutorService,
     waitInterval: FiniteDuration,
     timeout: Duration,
@@ -124,6 +125,7 @@ object Operations {
         ) ++
         addressArgs
     val b = new ProcessBuilder(command: _*)
+    b.directory(workingDir)
     b.redirectInput(ProcessBuilder.Redirect.PIPE)
 
     // https://stackoverflow.com/questions/55628999/java-processbuilder-how-to-suppress-output-instead-of-redirecting-it/55629297#55629297

modules/build/src/main/scala/scala/build/Directories.scala

@@ -11,6 +11,7 @@ trait Directories {
   def virtualProjectsDir: os.Path
   def bspSocketDir: os.Path
   def bloopDaemonDir: os.Path
+  def bloopWorkingDir: os.Path
 }
 
 object Directories {
@@ -28,11 +29,13 @@ object Directories {
       // FIXME I would have preferred to use projDirs.dataLocalDir, but it seems named socket
       // support, or name sockets in general, aren't fine with it.
       os.Path(projDirs.cacheDir, Os.pwd) / "bsp-sockets"
-    lazy val bloopDaemonDir: os.Path = {
+    lazy val bloopDaemonDir: os.Path =
+      bloopWorkingDir / "daemon"
+    lazy val bloopWorkingDir: os.Path = {
       val baseDir =
         if (Properties.isMac) projDirs.cacheDir
         else projDirs.dataLocalDir
-      os.Path(baseDir, Os.pwd) / "bloop" / "daemon"
+      os.Path(baseDir, Os.pwd) / "bloop"
     }
   }
 
@@ -48,7 +51,9 @@ object Directories {
     lazy val bspSocketDir: os.Path =
       dir / "data-local" / "bsp-sockets"
     lazy val bloopDaemonDir: os.Path =
-      dir / "data-local" / "bloop" / "daemon"
+      bloopWorkingDir / "daemon"
+    lazy val bloopWorkingDir: os.Path =
+      dir / "data-local" / "bloop"
   }
 
   def default(): Directories = {

modules/build/src/test/scala/scala/build/tests/util/BloopServer.scala

@@ -6,20 +6,21 @@ import scala.util.Properties
 
 object BloopServer {
 
+  private def directories = scala.build.Directories.default()
+
   // FIXME We could use a test-specific Bloop instance here.
   // Not sure how to properly shut it down or have it exit after a period
   // of inactivity, so we keep using our default global Bloop for now.
   private def bloopAddress =
     if (Properties.isWin)
       BloopRifleConfig.Address.Tcp(BloopRifleConfig.defaultHost, BloopRifleConfig.defaultPort)
-    else {
-      val directories = scala.build.Directories.default()
+    else
       BloopRifleConfig.Address.DomainSocket(directories.bloopDaemonDir.toNIO)
-    }
 
   val bloopConfig = BloopRifleConfig.default(
     bloopAddress,
-    v => Bloop.bloopClassPath(Logger.nop, v)
+    v => Bloop.bloopClassPath(Logger.nop, v),
+    directories.bloopWorkingDir.toIO
   )
 
 }

modules/cli/src/main/scala/scala/cli/commands/SharedCompilationServerOptions.scala

@@ -83,7 +83,12 @@ final case class SharedCompilationServerOptions(
   @Group("Compilation server")
   @HelpMessage("JVM to use to start Bloop (e.g. 'system|11', 'temurin:17', …)")
   @Hidden
-    bloopJvm: Option[String] = None
+    bloopJvm: Option[String] = None,
+
+  @Group("Compilation server")
+  @HelpMessage("Working directory for Bloop, if it needs to be started")
+  @Hidden
+    bloopWorkingDir: Option[String] = None
 ) {
   // format: on
 
@@ -239,9 +244,14 @@ final case class SharedCompilationServerOptions(
           )
       }
 
+    val workingDir = bloopWorkingDir
+      .filter(_.trim.nonEmpty)
+      .map(os.Path(_, Os.pwd))
+      .getOrElse(directories.bloopWorkingDir)
     val baseConfig = BloopRifleConfig.default(
       address,
-      v => Bloop.bloopClassPath(logger, v)
+      v => Bloop.bloopClassPath(logger, v),
+      workingDir.toIO
     )
 
     baseConfig.copy(

website/docs/reference/cli-options.md

@@ -151,6 +151,10 @@ Bloop global options file
 
 JVM to use to start Bloop (e.g. 'system|11', 'temurin:17', …)
 
+#### `--bloop-working-dir`
+
+Working directory for Bloop, if it needs to be started
+
 ## Compile options
 
 Available in commands: