improvement: offer amend to handle single file scala-cli config on new file

kasiaMarek · kasiaMarek · commit 4b401c9df16a · 2023-08-25T15:56:46.000+02:00
diff --git a/metals/src/main/scala/scala/meta/internal/bsp/BspConfigGenerator.scala b/metals/src/main/scala/scala/meta/internal/bsp/BspConfigGenerator.scala
@@ -8,6 +8,7 @@ import scala.meta.internal.builds.BuildServerProvider
 import scala.meta.internal.builds.ShellRunner
 import scala.meta.internal.metals.Messages.BspProvider
 import scala.meta.internal.metals.MetalsEnrichments._
+import scala.meta.internal.metals.StatusBar
 import scala.meta.internal.metals.clients.language.MetalsLanguageClient
 import scala.meta.io.AbsolutePath
 
@@ -20,6 +21,7 @@ final class BspConfigGenerator(
     workspace: AbsolutePath,
     languageClient: MetalsLanguageClient,
     shellRunner: ShellRunner,
+    statusBar: StatusBar,
 )(implicit ec: ExecutionContext) {
   def runUnconditionally(
       buildTool: BuildServerProvider,
@@ -46,6 +48,7 @@ final class BspConfigGenerator(
       status <- buildTool.generateBspConfig(
         workspace,
         args => runUnconditionally(buildTool, args),
+        statusBar,
       )
     } yield (buildTool, status)
   }
diff --git a/metals/src/main/scala/scala/meta/internal/bsp/BspConnector.scala b/metals/src/main/scala/scala/meta/internal/bsp/BspConnector.scala
@@ -296,7 +296,9 @@ class BspConnector(
               buildTool
                 .generateBspConfig(
                   workspace,
-                  args => bspConfigGenerator.runUnconditionally(buildTool, args),
+                  args =>
+                    bspConfigGenerator.runUnconditionally(buildTool, args),
+                  statusBar,
                 )
                 .map(status => handleGenerationStatus(buildTool, status))
             case Right(details) if details.getName == BloopServers.name =>
@@ -329,6 +331,7 @@ class BspConnector(
               .generateBspConfig(
                 workspace,
                 args => bspConfigGenerator.runUnconditionally(buildTool, args),
+                statusBar,
               )
               .map(status => handleGenerationStatus(buildTool, status))
           case Right(connectionDetails) =>
diff --git a/metals/src/main/scala/scala/meta/internal/bsp/ScalaCliBspScope.scala b/metals/src/main/scala/scala/meta/internal/bsp/ScalaCliBspScope.scala
@@ -0,0 +1,37 @@
+package scala.meta.internal.bsp
+
+import scala.util.Try
+
+import scala.meta.internal.builds.ScalaCliBuildTool
+import scala.meta.internal.metals.MetalsEnrichments._
+import scala.meta.io.AbsolutePath
+
+object ScalaCliBspScope {
+  def inScope(root: AbsolutePath, file: AbsolutePath): Boolean = {
+    val roots = scalaCliBspRoot(root)
+    roots.isEmpty || roots.exists(bspRoot =>
+      file.toNIO.startsWith(bspRoot.toNIO)
+    )
+  }
+
+  private def scalaCliBspRoot(root: AbsolutePath): List[AbsolutePath] =
+    for {
+      path <- ScalaCliBuildTool.pathsToScalaCliBsp(root)
+      text <- path.readTextOpt.toList
+      json = ujson.read(text)
+      args <- json("argv").arrOpt.toList
+      tailArgs = args.toList.flatMap(_.strOpt).dropWhile(_ != "bsp")
+      rootArg <- tailArgs match {
+        case "bsp" :: tail => dropOptions(tail).takeWhile(!_.startsWith("-"))
+        case _ => Nil
+      }
+      rootPath <- Try(AbsolutePath(rootArg).dealias).toOption
+      if rootPath.exists
+    } yield rootPath
+
+  private def dropOptions(args: List[String]): List[String] =
+    args match {
+      case s"--$_" :: _ :: tail => dropOptions(tail)
+      case rest => rest
+    }
+}
diff --git a/metals/src/main/scala/scala/meta/internal/builds/BuildServerProvider.scala b/metals/src/main/scala/scala/meta/internal/builds/BuildServerProvider.scala
@@ -4,6 +4,7 @@ import scala.concurrent.Future
 
 import scala.meta.internal.bsp.BspConfigGenerationStatus._
 import scala.meta.internal.metals.Messages
+import scala.meta.internal.metals.StatusBar
 import scala.meta.io.AbsolutePath
 
 /**
@@ -18,6 +19,7 @@ trait BuildServerProvider extends BuildTool {
   def generateBspConfig(
       workspace: AbsolutePath,
       systemProcess: List[String] => Future[BspConfigGenerationStatus],
+      statusBar: StatusBar,
   ): Future[BspConfigGenerationStatus] =
     createBspFileArgs(workspace).map(systemProcess).getOrElse {
       Future.successful(
diff --git a/metals/src/main/scala/scala/meta/internal/builds/BuildTools.scala b/metals/src/main/scala/scala/meta/internal/builds/BuildTools.scala
@@ -115,7 +115,8 @@ final class BuildTools(
     if (isGradle) buf += GradleBuildTool(userConfig)
     if (isMaven) buf += MavenBuildTool(userConfig)
     if (isMill) buf += MillBuildTool(userConfig)
-    if (isScalaCli) buf += ScalaCliBuildTool(workspace, userConfig)
+    if (isScalaCli)
+      buf += ScalaCliBuildTool(workspace, userConfig)
 
     buf.result()
   }
diff --git a/metals/src/main/scala/scala/meta/internal/builds/ScalaCliBuildTool.scala b/metals/src/main/scala/scala/meta/internal/builds/ScalaCliBuildTool.scala
@@ -7,6 +7,7 @@ import scala.concurrent.Future
 import scala.meta.internal.bsp.BspConfigGenerationStatus._
 import scala.meta.internal.metals.BuildInfo
 import scala.meta.internal.metals.MetalsEnrichments._
+import scala.meta.internal.metals.StatusBar
 import scala.meta.internal.metals.UserConfiguration
 import scala.meta.internal.metals.scalacli.ScalaCli
 import scala.meta.io.AbsolutePath
@@ -23,21 +24,25 @@ class ScalaCliBuildTool(
   override def generateBspConfig(
       workspace: AbsolutePath,
       systemProcess: List[String] => Future[BspConfigGenerationStatus],
+      statusBar: StatusBar,
   ): Future[BspConfigGenerationStatus] =
     createBspFileArgs(workspace).map(systemProcess).getOrElse {
       // fallback to creating `.bsp/scala-cli.json` that starts JVM launcher
       val bspConfig = workspace.resolve(".bsp").resolve("scala-cli.json")
-      bspConfig.writeText(ScalaCli.scalaCliBspJsonContent())
+      statusBar.addMessage("scala-cli bspConfig")
+      bspConfig
+        .writeText(ScalaCli.scalaCliBspJsonContent(root = workspace.toString()))
       Future.successful(Generated)
     }
 
   def createBspConfigIfNone(
       workspace: AbsolutePath,
       systemProcess: List[String] => Future[BspConfigGenerationStatus],
+      statusBar: StatusBar,
   ): Future[BspConfigGenerationStatus] = {
     if (ScalaCliBuildTool.pathsToScalaCliBsp(workspace).exists(_.isFile))
       Future.successful(Generated)
-    else generateBspConfig(workspace, systemProcess)
+    else generateBspConfig(workspace, systemProcess, statusBar)
   }
 
   override def createBspFileArgs(
@@ -89,7 +94,10 @@ object ScalaCliBuildTool {
         json = ujson.read(text)
         version <- json("version").strOpt
       } yield version
-    new ScalaCliBuildTool(workspaceFolderVersions.headOption, userConfig)
+    new ScalaCliBuildTool(
+      workspaceFolderVersions.headOption,
+      userConfig,
+    )
   }
 }
 
diff --git a/metals/src/main/scala/scala/meta/internal/metals/Messages.scala b/metals/src/main/scala/scala/meta/internal/metals/Messages.scala
@@ -1,5 +1,7 @@
 package scala.meta.internal.metals
 
+import java.nio.file.Path
+
 import scala.collection.mutable
 
 import scala.meta.internal.builds.BuildTool
@@ -1009,3 +1011,24 @@ object Messages {
   }
 
 }
+
+object FileOutOfScalaCliBspScope {
+  val regenerateAndRestart = new MessageActionItem("Yes")
+  val ignore = new MessageActionItem("No")
+  def askToRegenerateConfigAndRestartBspMsg(file: String): String =
+    s"""|$file is outside of scala-cli build server scope.
+        |Would you like to fix this by regenerating bsp configuration and restarting the build sever?""".stripMargin
+  def askToRegenerateConfigAndRestartBsp(
+      file: Path
+  ): ShowMessageRequestParams = {
+    val params = new ShowMessageRequestParams()
+    params.setMessage(
+      askToRegenerateConfigAndRestartBspMsg(
+        s"File: ${file.getFileName().toString()}"
+      )
+    )
+    params.setType(MessageType.Warning)
+    params.setActions(List(regenerateAndRestart, ignore).asJava)
+    params
+  }
+}
diff --git a/metals/src/main/scala/scala/meta/internal/metals/MetalsLspService.scala b/metals/src/main/scala/scala/meta/internal/metals/MetalsLspService.scala
@@ -26,6 +26,7 @@ import scala.meta.internal.bsp.BspConnector
 import scala.meta.internal.bsp.BspServers
 import scala.meta.internal.bsp.BspSession
 import scala.meta.internal.bsp.BuildChange
+import scala.meta.internal.bsp.ScalaCliBspScope
 import scala.meta.internal.builds.BloopInstall
 import scala.meta.internal.builds.BuildServerProvider
 import scala.meta.internal.builds.BuildTool
@@ -309,6 +310,7 @@ class MetalsLspService(
     folder,
     languageClient,
     shellRunner,
+    statusBar,
   )
 
   private val diagnostics: Diagnostics = new Diagnostics(
@@ -1043,7 +1045,10 @@ class MetalsLspService(
             )
             .ignoreValue
         }
-        maybeImportScript(path).getOrElse(load())
+        for {
+          _ <- maybeAmendScalaCliBspConfig(path)
+          _ <- maybeImportScript(path).getOrElse(load())
+        } yield ()
       }.asJava
     }
   }
@@ -1150,6 +1155,40 @@ class MetalsLspService(
       .asJava
   }
 
+  private def maybeAmendScalaCliBspConfig(file: AbsolutePath): Future[Unit] = {
+    def isScalaCli = bspSession.exists(_.main.isScalaCLI)
+    def isScalaFile =
+      file.toString.isScala || file.isJava || file.isAmmoniteScript
+    if (
+      isScalaCli && isScalaFile &&
+      buildTargets.inverseSources(file).isEmpty &&
+      file.toNIO.startsWith(folder.toNIO) &&
+      !ScalaCliBspScope.inScope(folder, file)
+    ) {
+      languageClient
+        .showMessageRequest(
+          FileOutOfScalaCliBspScope.askToRegenerateConfigAndRestartBsp(
+            file.toNIO
+          )
+        )
+        .asScala
+        .flatMap {
+          case FileOutOfScalaCliBspScope.regenerateAndRestart =>
+            val buildTool =
+              ScalaCliBuildTool(folder, userConfig)
+            for {
+              _ <- buildTool.generateBspConfig(
+                folder,
+                bspConfigGenerator.runUnconditionally(buildTool, _),
+                statusBar,
+              )
+              _ <- quickConnectToBuildServer()
+            } yield ()
+          case _ => Future.successful(())
+        }
+    } else Future.successful(())
+  }
+
   private def didCompileTarget(report: CompileReport): Unit = {
     if (!isReliableFileWatcher) {
       // NOTE(olafur) this step is exclusively used when running tests on
@@ -1879,6 +1918,7 @@ class MetalsLspService(
                 buildTool,
                 args,
               ),
+            statusBar,
           )
           .map(status => ensureAndConnect(buildTool, status))
       case buildTools =>
@@ -1949,7 +1989,9 @@ class MetalsLspService(
               for {
                 _ <- buildTool.createBspConfigIfNone(
                   folder,
-                  args => bspConfigGenerator.runUnconditionally(buildTool, args),
+                  args =>
+                    bspConfigGenerator.runUnconditionally(buildTool, args),
+                  statusBar,
                 )
                 _ = tables.buildServers.chooseServer(ScalaCliBuildTool.name)
                 buildChange <- quickConnectToBuildServer()
diff --git a/metals/src/main/scala/scala/meta/internal/metals/scalacli/ScalaCli.scala b/metals/src/main/scala/scala/meta/internal/metals/scalacli/ScalaCli.scala
@@ -421,14 +421,17 @@ object ScalaCli {
 
   val scalaCliBspVersion = "2.1.0-M4"
 
-  def scalaCliBspJsonContent(args: List[String] = Nil): String = {
+  def scalaCliBspJsonContent(
+      args: List[String] = Nil,
+      root: String = ".",
+  ): String = {
     val argv = List(
       ScalaCli.javaCommand,
       "-cp",
       ScalaCli.scalaCliClassPath().mkString(File.pathSeparator),
       ScalaCli.scalaCliMainClass,
       "bsp",
-      ".",
+      root,
     ) ++ args
     val bsjJson = ujson.Obj(
       "name" -> "scala-cli",
diff --git a/tests/slow/src/test/scala/tests/scalacli/ScalaCliSuite.scala b/tests/slow/src/test/scala/tests/scalacli/ScalaCliSuite.scala
@@ -2,13 +2,24 @@ package tests.scalacli
 
 import scala.concurrent.Future
 
+import scala.meta.internal.metals.FileOutOfScalaCliBspScope
 import scala.meta.internal.metals.Messages
+import scala.meta.internal.metals.MetalsEnrichments._
+import scala.meta.internal.metals.MetalsServerConfig
 import scala.meta.internal.metals.ServerCommands
+import scala.meta.internal.metals.SlowTaskConfig
+import scala.meta.internal.metals.StatusBarConfig
+import scala.meta.internal.metals.scalacli.ScalaCli
 import scala.meta.internal.metals.{BuildInfo => V}
 
 import tests.FileLayout
 
 class ScalaCliSuite extends BaseScalaCliSuite(V.scala3) {
+  override def serverConfig: MetalsServerConfig =
+    MetalsServerConfig.default.copy(
+      slowTask = SlowTaskConfig.on,
+      statusBar = StatusBarConfig.showMessage,
+    )
 
   private def simpleFileTest(useBsp: Boolean): Future[Unit] =
     for {
@@ -362,4 +373,65 @@ class ScalaCliSuite extends BaseScalaCliSuite(V.scala3) {
     } yield ()
   }
 
+  test("single-file-config") {
+    cleanWorkspace()
+    val msg = FileOutOfScalaCliBspScope.askToRegenerateConfigAndRestartBspMsg(
+      "File: SomeFile.scala"
+    )
+    def workspaceMsgs =
+      (server.client.messageRequests.asScala ++ server.client.showMessages.asScala
+        .map(_.getMessage()))
+        .collect {
+          case `msg` => msg
+          case msg @ "scala-cli bspConfig" => msg
+        }
+        .mkString("\n")
+    def hasBuildTarget(fileName: String) = server.server.buildTargets
+      .inverseSources(workspace.resolve(fileName))
+      .isDefined
+    for {
+      _ <- scalaCliInitialize(useBsp = false)(
+        s"""/src/Main.scala
+           |object Main:
+           |  def foo = 3
+           |  val m = foo
+           |/SomeFile.scala
+           |object Other:
+           |  def foo = 3
+           |  val m = foo
+           |/.bsp/scala-cli.json
+           |${ScalaCli.scalaCliBspJsonContent(root = workspace.resolve("src/Main.scala").toString())}
+           |/.scala-build/ide-inputs.json
+           |${BaseScalaCliSuite.scalaCliIdeInputJson(".")}
+           |""".stripMargin
+      )
+      _ <- server.didOpen("src/Main.scala")
+      _ = assertNoDiff(workspaceMsgs, "")
+      _ = assert(hasBuildTarget("src/Main.scala"))
+      _ = assert(!hasBuildTarget("SomeFile.scala"))
+
+      _ <- server.didOpen("SomeFile.scala")
+      _ <- server.server.buildServerPromise.future
+      _ = assertNoDiff(workspaceMsgs, msg)
+      _ = assert(!hasBuildTarget("SomeFile.scala"))
+
+      _ = server.client.regenerateAndRestartScalaCliBuildSever =
+        FileOutOfScalaCliBspScope.regenerateAndRestart
+      _ <- server.didOpen("SomeFile.scala")
+      _ <- server.server.buildServerPromise.future
+      _ = assertNoDiff(
+        workspaceMsgs,
+        List(msg, msg, "scala-cli bspConfig").mkString("\n"),
+      )
+      _ = assert(hasBuildTarget("src/Main.scala"))
+      _ = assert(hasBuildTarget("SomeFile.scala"))
+
+      _ <- server.didOpen("SomeFile.scala")
+      _ = assertNoDiff(
+        workspaceMsgs,
+        List(msg, msg, "scala-cli bspConfig").mkString("\n"),
+      )
+    } yield ()
+  }
+
 }
diff --git a/tests/unit/src/main/scala/tests/TestingClient.scala b/tests/unit/src/main/scala/tests/TestingClient.scala

Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,8 @@ final class BuildTools(`
`115`	`115`	`if (isGradle) buf += GradleBuildTool(userConfig)`
`116`	`116`	`if (isMaven) buf += MavenBuildTool(userConfig)`
`117`	`117`	`if (isMill) buf += MillBuildTool(userConfig)`
`118`		`- if (isScalaCli) buf += ScalaCliBuildTool(workspace, userConfig)`
	`118`	`+ if (isScalaCli)`
	`119`	`+ buf += ScalaCliBuildTool(workspace, userConfig)`
`119`	`120`
`120`	`121`	`buf.result()`
`121`	`122`	`}`