Scala cli actionable diagnostic

[lwronski]

This PR adds support for actionable diagnostic from scala-cli. These are diagnostics that contain information that allows users to fix some configs/directives by Quick Fix actions in metals.

For now, in scala-cli there is only implemented actionable diagnostics for updating lib in using directives, and it works in this way with metals:

Screen.Recording.2022-08-24.at.19.57.06.mov

I added didSave flag to check method, because when actionable diagnostics were applied in unit tests and saved content to the file, the scala-cli reload bsp server and at the same time metals expect to get Compile Result from server but fail, because bsp server is down. I attach error logs:

2022.08.23 14:48:03 INFO  Disconnecting from scala-cli session...
2022.08.23 14:48:02 INFO  Shut down connection with build server.
2022.08.23 14:48:03 INFO  Attempting to connect to the build server...
2022.08.23 14:48:03 INFO  Running BSP server [/Users/lwronski/projects/scala-cli/out/cli/standaloneLauncher.dest/launcher, bsp, ., --actions, -S, 2.13.8]
2022.08.23 14:48:02 INFO  tracing is disabled for protocol BSP, to enable tracing of incoming and outgoing JSON messages create an empty file at /Users/lwronski/projects/metals/tests/unit/target/e2e/actionableDiagnostic/empty-string-multiline/.metals/bsp.trace.json or /Users/lwronski/Library/Caches/org.scalameta.metals/bsp.trace.json
tests.codeactions.ActionableDiagnosticsSuite:
==> X tests.codeactions.ActionableDiagnosticsSuite.empty-string-multiline  11.177s scala.meta.internal.metals.MetalsBspException: BSP connection failed in the attempt to get: CompileResult
Caused by: java.util.concurrent.ExecutionException: Boxed Exception
Caused by: java.lang.InterruptedException

To fix it, I just skip saving updating files to disk, and in this way, I avoiding to reload of bsp. I don't find any better solution to fix it in my test ActionableDiagnosticsSuite.

[tgodzik]

Thanks for the great work! I left a bunch of comments, but mostly minor things.

[tgodzik]

Could you maybe add layout as a parameter? Boolean scalaCLi is not clear on what it does.

[lwronski]

In BaseCodeActionLspSuite layout is created base on few parameters such as: scalacOptionsJson, scalafixConf, path, input. I'm not sure what you expect, do you want that users how to pass explicitly layout: String?

For now, I changed name from scalaCli to scalaCliLayout.

[tgodzik]

Suggested change

	skipDiff: Boolean = false,
	assertion: Option[(Boolean, String)],

Maybe something like this? Have separate assertion to make sure skipDiff is not used by mistake?

[lwronski]

I don't understand why you used Boolean there, so I changed the assertion type a bit to:

assertion:  Option[Unit => Unit]

which allows to override default assert in test

[tgodzik]

I was thinking:

assertion.map{ case (condition, msg) => assert(condition, msg)}

This way we would steer with the types what needs to be done.

[ckipp01]

What's the actual diagnostic tied to this look like?

[lwronski]

[Trace - 02:46:40 PM] Received notification 'build/publishDiagnostics'
Params: {
  "textDocument": {
    "uri": "file:///private/tmp/scala-demo/Hello.scala"
  },
  "buildTarget": {
    "uri": "file:/private/tmp/scala-demo/.scala-build/?id\u003dproject_bd2c96d2de"
  },
  "diagnostics": [
    {
      "range": {
        "start": {
          "line": 0,
          "character": 15
        },
        "end": {
          "line": 0,
          "character": 40
        }
      },
      "severity": 4,
      "source": "scala-cli",
      "message": "com.lihaoyi::os-lib:0.7.8 is outdated, update to 0.8.1\n     com.lihaoyi::os-lib:0.7.8 -\u003e com.lihaoyi::os-lib:0.8.1",
      "data": {
        "range": {
          "start": {
            "line": 0,
            "character": 15
          },
          "end": {
            "line": 0,
            "character": 40
          }
        },
        "newText": "com.lihaoyi::os-lib:0.8.1"
      }
    }
  ],
  "reset": false
}

[ckipp01]

I commented on it in the tests, but the diagnostic message mention what the applied suggestion will be?

[lwronski]

For now no, so I updated it and use AnnotatedTextEdit to send some more additional message about the applied suggestion. I will update this PR after release scala-cli to 0.1.17.

For dependency actionable diagnostic - in field AnnotatedTextEdit. annotationId I set value to: update dependency to 0.8.1.

[tgodzik]

Annotated text edit seems a bit more complex and might not be supported by all the clients, what about doing:

Fix: <diagnostic message> truncated to a sensible length?

[lwronski]

Right, so I dropped the idea of AnnotatedTextEdit. So now, I use the first line from diagnostic message to set title of codeAction, here is the result:

[tgodzik]

Annotated text edit seems a bit more complex and might not be supported by all the clients, what about doing:

Fix: <diagnostic message> truncated to a sensible length?

[tgodzik]

LGTM!

[ckipp01]

Great work @lwronski. Excited to see more things like this.