Send actionable text edit in data field (#1448)

Author: lwronski

modules/build/src/main/scala/scala/build/ConsoleBloopBuildClient.scala

@@ -62,6 +62,7 @@ class ConsoleBloopBuildClient(
         updatedDiag.setRelatedInformation(diag.getRelatedInformation)
         updatedDiag.setSeverity(diag.getSeverity)
         updatedDiag.setSource(diag.getSource)
+        updatedDiag.setData(diag.getData)
 
         (originalPath, updatedDiag)
     }

modules/build/src/main/scala/scala/build/bsp/BspClient.scala

@@ -8,10 +8,11 @@ import java.nio.file.Paths
 import java.util.concurrent.{ConcurrentHashMap, ExecutorService}
 
 import scala.build.Position.File
+import scala.build.bsp.protocol.TextEdit
 import scala.build.errors.{BuildException, CompositeBuildException, Diagnostic, Severity}
 import scala.build.postprocessing.LineConversion
 import scala.build.{BloopBuildClient, GeneratedSource, Logger}
-import scala.jdk.CollectionConverters._
+import scala.jdk.CollectionConverters.*
 
 class BspClient(
   readFilesEs: ExecutorService,
@@ -194,10 +195,9 @@ class BspClient(
         val bDiag =
           new b.Diagnostic(range, diag.message)
 
-        diag.relatedInformation.foreach { relatedInformation =>
-          val location = new b.Location(path.toNIO.toUri.toASCIIString, range)
-          val related  = new b.DiagnosticRelatedInformation(location, relatedInformation.message)
-          bDiag.setRelatedInformation(List(related).asJava)
+        diag.textEdit.foreach { textEdit =>
+          val bTextEdit = TextEdit(range, textEdit.newText)
+          bDiag.setData(bTextEdit.toJsonTree())
         }
         bDiag.setSeverity(diag.severity.toBsp4j)
         bDiag.setSource("scala-cli")

modules/build/src/main/scala/scala/build/bsp/package.scala

@@ -111,6 +111,7 @@ package object bsp {
       )
       diag0.setSeverity(diag.getSeverity)
       diag0.setSource(diag.getSource)
+      diag0.setData(diag.getData)
       diag0
     }
   }

modules/build/src/main/scala/scala/build/bsp/protocol/TextEdit.scala

@@ -0,0 +1,8 @@
+package scala.build.bsp.protocol
+
+import ch.epfl.scala.bsp4j as b
+import com.google.gson.Gson
+
+case class TextEdit(range: b.Range, newText: String) {
+  def toJsonTree() = new Gson().toJsonTree(this)
+}

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

@@ -1095,6 +1095,13 @@
     "allDeclaredMethods": true,
     "allDeclaredFields": true
   },
+  {
+    "name": "scala.build.bsp.protocol.TextEdit",
+    "allDeclaredConstructors": true,
+    "allPublicConstructors": true,
+    "allDeclaredMethods": true,
+    "allDeclaredFields": true
+  },
   {
     "name": "scala.cli.commands.BloopJson",
     "allDeclaredConstructors": true,

modules/cli/src/main/scala/scala/cli/internal/CliLogger.scala

@@ -9,7 +9,7 @@ import org.scalajs.logging.{Level => ScalaJsLevel, Logger => ScalaJsLogger, Scal
 import java.io.PrintStream
 
 import scala.build.blooprifle.BloopRifleLogger
-import scala.build.errors.Diagnostic.RelatedInformation
+import scala.build.bsp.protocol.TextEdit
 import scala.build.errors.{BuildException, CompositeBuildException, Diagnostic, Severity}
 import scala.build.internal.CustomProgressBarRefreshDisplay
 import scala.build.{ConsoleBloopBuildClient, Logger, Position}
@@ -32,7 +32,7 @@ class CliLogger(
         d.severity,
         d.message,
         hashMap,
-        d.relatedInformation
+        d.textEdit
       )
     }
   }
@@ -59,7 +59,7 @@ class CliLogger(
     severity: Severity,
     message: String,
     contentCache: mutable.Map[os.Path, Seq[String]],
-    relatedInformation: Option[RelatedInformation]
+    textEditOpt: Option[Diagnostic.TextEdit]
   ) =
     if (positions.isEmpty)
       out.println(
@@ -83,13 +83,9 @@ class CliLogger(
         diag.setSeverity(severity.toBsp4j)
         diag.setSource("scala-cli")
 
-        for {
-          filePath <- f.path
-          info     <- relatedInformation
-        } {
-          val location = new Location(filePath.toNIO.toUri.toASCIIString, range)
-          val related  = new b.DiagnosticRelatedInformation(location, info.message)
-          diag.setRelatedInformation(List(related).asJava)
+        for (textEdit <- textEditOpt) {
+          val bTextEdit = TextEdit(range, textEdit.newText)
+          diag.setData(bTextEdit.toJsonTree())
         }
 
         for (file <- f.path) {

modules/core/src/main/scala/scala/build/errors/Diagnostic.scala

@@ -1,18 +1,17 @@
 package scala.build.errors
 
 import scala.build.Position
-import scala.build.errors.Diagnostic.RelatedInformation
+import scala.build.errors.Diagnostic.TextEdit
 
 trait Diagnostic {
   def message: String
   def severity: Severity
   def positions: Seq[Position]
-  def relatedInformation: Option[RelatedInformation] = None
+  def textEdit: Option[TextEdit] = None
 }
 
 object Diagnostic {
-
-  case class RelatedInformation(message: String)
+  case class TextEdit(newText: String)
   object Messages {
     val bloopTooOld =
       "JVM that is hosting bloop is older than the requested runtime. Please run `scala-cli bloop exit`, and then use `--jvm` flag to restart Bloop"

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

@@ -5,8 +5,8 @@ import ch.epfl.scala.bsp4j as b
 import com.eed3si9n.expecty.Expecty.expect
 import com.github.plokhotnyuk.jsoniter_scala.core.*
 import com.github.plokhotnyuk.jsoniter_scala.macros.*
-import com.google.gson.Gson
 import com.google.gson.internal.LinkedTreeMap
+import com.google.gson.{Gson, JsonElement}
 import org.eclipse.lsp4j.jsonrpc.messages.ResponseError
 
 import java.net.URI
@@ -1187,7 +1187,7 @@ abstract class BspTestDefinitions(val scalaVersionOpt: Option[String])
            |""".stripMargin
     )
     withBsp(inputs, Seq(".", "--actions")) {
-      (root, localClient, remoteServer) =>
+      (_, localClient, remoteServer) =>
         async {
           // prepare build
           val buildTargetsResp = await(remoteServer.workspaceBuildTargets().asScala)
@@ -1215,11 +1215,16 @@ abstract class BspTestDefinitions(val scalaVersionOpt: Option[String])
             strictlyCheckMessage = false
           )
 
-          val relatedInformation = updateActionableDiagnostic.getRelatedInformation().asScala.head
-          expect(relatedInformation.getMessage.contains("com.lihaoyi::os-lib:"))
-          expect(
-            relatedInformation.getLocation().getUri() == (root / fileName).toNIO.toUri.toASCIIString
+          val textEdit = new Gson().fromJson[TextEdit](
+            updateActionableDiagnostic.getData().asInstanceOf[JsonElement],
+            classOf[TextEdit]
           )
+
+          expect(textEdit.newText.contains("com.lihaoyi::os-lib:"))
+          expect(textEdit.range.getStart.getLine == 0)
+          expect(textEdit.range.getStart.getCharacter == 15)
+          expect(textEdit.range.getEnd.getLine == 0)
+          expect(textEdit.range.getEnd.getCharacter == 40)
         }
     }
   }
@@ -1304,4 +1309,6 @@ object BspTestDefinitions {
   )
   private val detailsCodec: JsonValueCodec[Details] = JsonCodecMaker.make
 
+  private final case class TextEdit(range: b.Range, newText: String)
+
 }

modules/options/src/main/scala/scala/build/actionable/ActionableDiagnostic.scala

@@ -3,24 +3,18 @@ package scala.build.actionable
 import dependency._
 
 import scala.build.Position
-import scala.build.errors.Diagnostic.RelatedInformation
+import scala.build.errors.Diagnostic.TextEdit
 import scala.build.errors.{Diagnostic, Severity}
 
 abstract class ActionableDiagnostic extends Diagnostic {
 
-  /** Provide the message of actionable diagnostic
-    */
-  def message: String
-
   /** Provide the new content which will be replaced by actionable diagnostic
     */
   def suggestion: String
 
-  def positions: Seq[Position]
-
   override def severity = Severity.Hint
 
-  override def relatedInformation: Option[RelatedInformation] = Some(RelatedInformation(suggestion))
+  override def textEdit: Option[TextEdit] = Some(TextEdit(suggestion))
 }
 
 object ActionableDiagnostic {