Client Metals: connection to server is erroring. Shutting down server.

huntario commented 6 months ago

Describe the bug

Things were going awesome as I was step debugging through some tests using the inline test debugging option. Then it started to get slower and slower, until it locked up. Then I restarted the computer, uninstalled/reinstalled the Metals extension, and VSCode as well.

I will say I'm on Scala 2.13.5 but everything was working great fir my needs until this debug session seemed to trip me up and lock me out. Upgrading isn't an immediate option for me so mainly just posting in case others run into it.

I'm also seeing the same behavior as https://github.com/scalameta/metals-vscode/issues/1488 when this occurs. The buttons are unreactive.

Have "metals.javaHome": "/Users/hunter.leachman/.sdkman/candidates/java/current/bin/java" set in settings.json

Using coursier located at /usr/local/bin/coursier
/Users/hunter.leachman/.sdkman/candidates/java/current/bin/java -version:
openjdk version "17.0.11" 2024-04-16
/Users/hunter.leachman/.sdkman/candidates/java/current/bin/java -version:
OpenJDK Runtime Environment Temurin-17.0.11+9 (build 17.0.11+9)
OpenJDK 64-Bit Server VM Temurin-17.0.11+9 (build 17.0.11+9, mixed mode)
Using Java Home: /Users/hunter.leachman/.sdkman/candidates/java/current
Error: Could not find or load main class scala.meta.metals.Main
Caused by: java.lang.ClassNotFoundException: scala.meta.metals.Main
[Error - 4:11:10 AM] Server initialization failed.
  Message: Pending response rejected since connection got disposed
  Code: -32097 
[Info  - 4:11:10 AM] Connection to server got closed. Server will restart.
true
[Error - 4:11:10 AM] Metals client: couldn't create connection to server.
  Message: Pending response rejected since connection got disposed
  Code: -32097 
Error: Could not find or load main class scala.meta.metals.Main
Caused by: java.lang.ClassNotFoundException: scala.meta.metals.Main
[Error - 4:11:10 AM] Server initialization failed.
  Message: Pending response rejected since connection got disposed
  Code: -32097 
[Info  - 4:11:10 AM] Connection to server got closed. Server will restart.
true
[Error - 4:11:10 AM] Metals client: couldn't create connection to server.
  Message: Pending response rejected since connection got disposed
  Code: -32097 
Could not launch Metals Language Server:
Pending response rejected since connection got disposed
Release notes was not shown: not showing release notes since they've already been seen for your current version
Error: Could not find or load main class scala.meta.metals.Main
Caused by: java.lang.ClassNotFoundException: scala.meta.metals.Main
[Error - 4:11:10 AM] Server initialization failed.
  Message: Pending response rejected since connection got disposed
  Code: -32097 
[Info  - 4:11:10 AM] Connection to server got closed. Server will restart.
true
[Error - 4:11:10 AM] Metals client: couldn't create connection to server.
  Message: Pending response rejected since connection got disposed
  Code: -32097 
[Error - 4:11:10 AM] Restarting server failed
  Message: Pending response rejected since connection got disposed
  Code: -32097 
Error: Could not find or load main class scala.meta.metals.Main
Caused by: java.lang.ClassNotFoundException: scala.meta.metals.Main
[Error - 4:11:10 AM] Server initialization failed.
  Message: Pending response rejected since connection got disposed
  Code: -32097 
[Info  - 4:11:10 AM] Connection to server got closed. Server will restart.
true
[Error - 4:11:10 AM] Metals client: couldn't create connection to server.
  Message: Pending response rejected since connection got disposed
  Code: -32097 
[Error - 4:11:10 AM] Restarting server failed
  Message: Pending response rejected since connection got disposed
  Code: -32097 
Error: Could not find or load main class scala.meta.metals.Main
Caused by: java.lang.ClassNotFoundException: scala.meta.metals.Main
[Error - 4:11:10 AM] Server initialization failed.
  Message: Pending response rejected since connection got disposed
  Code: -32097 
[Error - 4:11:10 AM] The Metals server crashed 5 times in the last 3 minutes. The server will not be restarted. See the output for more information.
[Error - 4:11:10 AM] Metals client: couldn't create connection to server.
  Message: Pending response rejected since connection got disposed
  Code: -32097 
[Error - 4:11:10 AM] Restarting server failed
  Message: Pending response rejected since connection got disposed
  Code: -32097

I've tried the Pre-release version. I noticed Bloop had a new release a few hours before my issues began? - https://scalacenter.github.io/bloop/setup#sbt -

I'm also getting these messages -

Client Metals: connection to server is erroring. Shutting down server. write EPIPE Metals client: couldn't create connection to server. Restarting server failed The Metals server crashed 5 times in the last 3 minutes. The server will not be restarted. See the output for more information.

Everything was going so well, it's like these errors are cached somewhere and won't go away?

The project compiles with sbt

Nothing seems to make the errors go away/

To Reproduce Steps to reproduce the behavior:

Use the inline test debugging for a few semi-long sessions, setting a few break points in a few files
Repeat and maybe notice the debugger taking longer and longer to connect?
Eventually it locks up, and the errors above continue after restarting, reinstalling, switching to pre/release versions

Expected behavior The errors at least go away after restarting computer, the plugin, or uinstalling/reinstalling

Screenshots

Screenshot 2024-04-30 at 5 02 59 AM

Installation:

Operating system: macOS/Windows/Linux
VSCode version:
VSCode extension version:
Metals version: (found in VSCode settings, under metals.serverVersion)

Additional context Everything was working so perfectly until these errors started seemingly out of no where.

Really appreciate y'all and the work you are doing. This has come a long way in the last 2 years since the last time I tried out Metals. I'm thiiiiiiiiis close (finger to thumb) to replacing IntelliJ, almost there.

"Metals client: couldn't create connection to server." "he Metals server crashed 5 times in the last 3 minutes. The server will not be restarted. See the output for more information." "Restarting server failed"

huntario commented 6 months ago

The strange thing about this is that I've never seen anything so resistant to restarting, reinstalling, etc. I deleted VS code entirely, remove all the traces of it I could fine, re-cloned a new copy of the repo I'm working on, reinstalled everything, and it just continues to fail.

tgodzik commented 6 months ago

Is there any Java process running in the background? I can't figure out why this would be happening. Maybe we are picking up JAVA_OPTS and that is interfering somehow?

huntario commented 6 months ago

Thank you so much, commenting out my JAVA_OPTS and restarting seems to resolve the issue for me. It will also let me add export JAVA_OPTS="-Xmx4g" back fine.

Adding export JAVA_OPTS="-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=localhost:5050" seems to bring the issue back. I also tried a couple different ports and it does the same. Don't see any difference in behavior between the pre-release and release versions either. I was using this to activate the debugger but I think I can find another way to do it for now.

Probably something local to me if no one else runs into it. Really appreciate your suggestion, got me out of a bad place.

tgodzik commented 6 months ago

Och, I think I know what happened. Metals reads JAVA_OPTS and adds it to java process, but it needs to have agentlib silent if you add -agentlib option, since it will print some stuff to stdout, which will not be understood by VS Code, it only expects jsons.

Would be great to detect that automatically and print to the user :thinking:

huntario commented 6 months ago

Good call, If I add quiet=y ( https://stackoverflow.com/questions/48431989/suppress-listening-for-transport-dt-socket-message-when-remote-debugging-java ) it seems to be cool with that.

Here is the process that is working for me now to step through test code AND code under test using ScalaTest.

in build.sbt place fork in Test := false which prevents SBT from running the tests in a forkedJVM which doesn't seem to want to listen, expected from my perspective.

Then in ./zshrc

export JAVA_OPTS="-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=localhost:5050,quiet=y -Xmx4g" (don't forget to source ~/.zshrc)

sbt
run

Then I'm able to run/debug the tests from the side test panel list (beaker icon) or the Debug play button/green triangle icon with this .vscode/launch.json :

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "scala",
      "request": "launch",
      "name": "Scala Test",
      "testClass": "com.hunter.applicationname.thing.HuntersDebugSpec"
    }
}

Where is com.hunter.applicationname.thing is the namespace at the top of the test file and HuntersDebugSpec is the name of the test class.

I still don't completely understand when the icons that show up inline next to the tests are expected to appear. It seems to show right when I start VSCode and import or clean and restart, but if I lose it I can't figure out how to get them back. Even after clicking the beaker. Then sometimes they come back when I least expect it Not super worried about it because the above two options are great.

FWIW this started around 9-11pm central US time for me yesterday. This all seemed to be working without the quiet=y? I don't believe I changed any configuration, was just stepping through some tests and adding some mocks to my tests. The fans came on the laptop and all hell eventually broke loose! Probably my fault in some way I'm sure but maybe this will help other people.