Fix BSP buildTarget/wrappedSources for GraalVM native image (#4153)

Author: Gedochao

modules/cli/src/main/resources/META-INF/native-image/org.virtuslab/scala-cli-core/reflect-config.json

@@ -1242,6 +1242,42 @@
     "allDeclaredMethods": true,
     "allDeclaredFields": true
   },
+  {
+    "name": "scala.build.bsp.ScalaScriptBuildServer",
+    "queryAllDeclaredMethods": true,
+    "allDeclaredConstructors": true,
+    "allPublicConstructors": true,
+    "allDeclaredMethods": true,
+    "allDeclaredFields": true
+  },
+  {
+    "name": "scala.build.bsp.WrappedSourceItem",
+    "allDeclaredConstructors": true,
+    "allPublicConstructors": true,
+    "allDeclaredMethods": true,
+    "allDeclaredFields": true
+  },
+  {
+    "name": "scala.build.bsp.WrappedSourcesItem",
+    "allDeclaredConstructors": true,
+    "allPublicConstructors": true,
+    "allDeclaredMethods": true,
+    "allDeclaredFields": true
+  },
+  {
+    "name": "scala.build.bsp.WrappedSourcesParams",
+    "allDeclaredConstructors": true,
+    "allPublicConstructors": true,
+    "allDeclaredMethods": true,
+    "allDeclaredFields": true
+  },
+  {
+    "name": "scala.build.bsp.WrappedSourcesResult",
+    "allDeclaredConstructors": true,
+    "allPublicConstructors": true,
+    "allDeclaredMethods": true,
+    "allDeclaredFields": true
+  },
   {
     "name": "scala.build.bsp.protocol.TextEdit",
     "allDeclaredConstructors": true,

modules/integration/src/test/java/scala/cli/integration/bsp/WrappedSourceItem.java

@@ -0,0 +1,8 @@
+package scala.cli.integration.bsp;
+
+public class WrappedSourceItem {
+  public String uri;
+  public String generatedUri;
+  public String topWrapper;
+  public String bottomWrapper;
+}

modules/integration/src/test/java/scala/cli/integration/bsp/WrappedSourcesItem.java

@@ -0,0 +1,9 @@
+package scala.cli.integration.bsp;
+
+import ch.epfl.scala.bsp4j.BuildTargetIdentifier;
+import java.util.List;
+
+public class WrappedSourcesItem {
+  public BuildTargetIdentifier target;
+  public List<WrappedSourceItem> sources;
+}

modules/integration/src/test/java/scala/cli/integration/bsp/WrappedSourcesResult.java

@@ -0,0 +1,7 @@
+package scala.cli.integration.bsp;
+
+import java.util.List;
+
+public class WrappedSourcesResult {
+  public List<WrappedSourcesItem> items;
+}

modules/integration/src/test/scala/scala/cli/integration/BspSuite.scala

@@ -79,7 +79,8 @@ trait BspSuite { this: ScalaCliSuite =>
     f: (
       os.Path,
       TestBspClient,
-      b.BuildServer & b.ScalaBuildServer & b.JavaBuildServer & b.JvmBuildServer
+      b.BuildServer & b.ScalaBuildServer & b.JavaBuildServer & b.JvmBuildServer &
+        TestBspClient.WrappedSourcesBuildServer
     ) => Future[T]
   ): T = withBspInitResults(
     inputs,
@@ -107,7 +108,8 @@ trait BspSuite { this: ScalaCliSuite =>
     f: (
       os.Path,
       TestBspClient,
-      b.BuildServer & b.ScalaBuildServer & b.JavaBuildServer & b.JvmBuildServer,
+      b.BuildServer & b.ScalaBuildServer & b.JavaBuildServer & b.JvmBuildServer &
+        TestBspClient.WrappedSourcesBuildServer,
       b.InitializeBuildResult
     ) => Future[T]
   ): T = {
@@ -120,8 +122,9 @@ trait BspSuite { this: ScalaCliSuite =>
 
       val proc = os.proc(TestUtil.cli, "bsp", bspOptions ++ extraOptionsOverride, args)
         .spawn(cwd = root, stderr = stderr, env = bspEnvs)
-      var remoteServer: b.BuildServer & b.ScalaBuildServer & b.JavaBuildServer & b.JvmBuildServer =
-        null
+      var remoteServer
+        : b.BuildServer & b.ScalaBuildServer & b.JavaBuildServer & b.JvmBuildServer &
+          TestBspClient.WrappedSourcesBuildServer = null
 
       val bspServerExited = Promise[Unit]()
       val t               = new Thread("bsp-server-watcher") {

modules/integration/src/test/scala/scala/cli/integration/BspTestDefinitions.scala

@@ -2394,4 +2394,55 @@ abstract class BspTestDefinitions extends ScalaCliSuite
       }
     }
   }
+
+  test("buildTarget/wrappedSources") {
+    val inputs = TestInputs(
+      os.rel / "simple.sc" ->
+        s"""val msg = "Hello"
+           |println(msg)
+           |""".stripMargin
+    )
+
+    withBsp(inputs, Seq(".")) { (root, _, remoteServer) =>
+      Future {
+        val buildTargetsResp = remoteServer.workspaceBuildTargets().asScala.await
+        val target           = {
+          val targets = buildTargetsResp.getTargets.asScala.map(_.getId).toSeq
+          expect(targets.length == 2)
+          extractMainTargets(targets)
+        }
+
+        val targets = List(target).asJava
+
+        val compileResp =
+          remoteServer.buildTargetCompile(new b.CompileParams(targets)).asScala.await
+        expect(compileResp.getStatusCode == b.StatusCode.OK)
+
+        val resp = remoteServer
+          .buildTargetWrappedSources(new b.SourcesParams(targets))
+          .asScala
+          .await
+
+        val items = resp.items.asScala
+        expect(items.nonEmpty)
+
+        val mainItem = items.find(_.target.getUri == target.getUri).get
+
+        val sources = mainItem.sources.asScala
+        expect(sources.size == 1)
+
+        val wrappedSource = sources.head
+        val sourceUri     = TestUtil.normalizeUri(wrappedSource.uri)
+        val expectedUri   =
+          TestUtil.normalizeUri((root / "simple.sc").toNIO.toUri.toASCIIString)
+        expect(sourceUri == expectedUri)
+
+        expect(wrappedSource.topWrapper.contains("simple"))
+        expect(wrappedSource.topWrapper.contains("scriptPath"))
+        expect(wrappedSource.bottomWrapper == "}")
+        expect(wrappedSource.generatedUri.endsWith(".scala"))
+        expect(wrappedSource.generatedUri.contains("simple"))
+      }
+    }
+  }
 }

modules/integration/src/test/scala/scala/cli/integration/TestBspClient.scala

@@ -4,8 +4,9 @@ import ch.epfl.scala.bsp4j as b
 import org.eclipse.lsp4j.jsonrpc
 
 import java.io.{InputStream, OutputStream}
-import java.util.concurrent.ExecutorService
+import java.util.concurrent.{CompletableFuture, ExecutorService}
 
+import scala.cli.integration.bsp.WrappedSourcesResult
 import scala.collection.mutable
 import scala.concurrent.{ExecutionContext, Future, Promise}
 import scala.util.{Failure, Success}
@@ -100,16 +101,23 @@ class TestBspClient extends b.BuildClient {
 
 object TestBspClient {
 
+  trait WrappedSourcesBuildServer {
+    @org.eclipse.lsp4j.jsonrpc.services.JsonRequest("buildTarget/wrappedSources")
+    def buildTargetWrappedSources(params: b.SourcesParams)
+      : CompletableFuture[WrappedSourcesResult]
+  }
+
   private trait BuildServer extends b.BuildServer with b.ScalaBuildServer with b.JavaBuildServer
-      with b.JvmBuildServer
+      with b.JvmBuildServer with WrappedSourcesBuildServer
 
   def connect(
     in: InputStream,
     out: OutputStream,
     es: ExecutorService
   ): (
     TestBspClient,
-    b.BuildServer & b.ScalaBuildServer & b.JavaBuildServer & b.JvmBuildServer,
+    b.BuildServer & b.ScalaBuildServer & b.JavaBuildServer & b.JvmBuildServer &
+      WrappedSourcesBuildServer,
     Future[Unit]
   ) = {