[Possible Issue] No format file added -- fail to connect to build?

[Austinito]

Hey guys, wanted to start this discussion so I could bring a possible issue to light. Gotta finish some onboarding tasks, and kick some butt before doing a deep-dive.

Overview

I was having a lot of issues getting my Scala environment setup for my new work machine. However, was not able to connect to build server again.

I think this was due to no expected format file being there. I also uninstalled my bloop, and other things 😬 (should always do one thing at a time, I know...)

Workaround

Once I did a touch .scalafmt.conf command (My configured file for scalafmtConfigPath config), then the issue stopped occuring... If anyone else is able to verify this, I'd love to hear about it.

Other Details

Metals Server version: 1.3.1
Java: 17.0.11

logs:

ERROR Failed to connect with build server, no functionality will work.
java.nio.file.NoSuchFileException: {project_root}.scalafmt.conf
{Shutdown sequence}

[ckipp01]

Hey @Austinito sorry for the delay on this. This shouldn't be happening. Looking at the Metals code (which handles this) I see that if the file can't be found it should just default. Is this still happening to you?

[Austinito]

This is still happening to me.

Here's the setup for metals config:

    metals_config.settings = {
        serverProperties = {
            "-Xms8G",
            "-Xmx12G"
        },
        ammoniteJvmProperties = { "-Xmx1G" },
        enableSemanticHighlighting = false,
        showImplicitArguments = true,
        excludedPackages = {
            ...
        },
        scalafmtConfigPath = ".scalafmt.conf",
        testUserInterface = "Test Explorer",
    }

And here's the related logs:

2024.12.31 11:48:03 INFO  Started: Metals version 1.4.2 in folders '{dir}/akka-quickstart-scala' for client Neovim 0.10.3+v0.10.3.�[0m
2024.12.31 11:48:04 INFO  Attempting to connect to the build server...�[0m
2024.12.31 11:48:04 INFO  Found a Bloop server running�[0m
2024.12.31 11:48:04 INFO  tracing is disabled for protocol BSP, to enable tracing of incoming and outgoing JSON messages create an empty file at {dir}/akka-quickstart-scala/.metals/bsp.trace.json or {home_dir}/.cache/metals/bsp.trace.json�[0m
2024.12.31 11:48:05 INFO  Attempting to connect to the build server...�[0m
2024.12.31 11:48:05 INFO  Found a Bloop server running�[0m
2024.12.31 11:48:05 INFO  Attempting to connect to the build server...�[0m
2024.12.31 11:48:05 INFO  Found a Bloop server running�[0m
2024.12.31 11:48:05 INFO  tracing is disabled for protocol BSP, to enable tracing of incoming and outgoing JSON messages create an empty file at {dir}/akka-quickstart-scala/project/project/.metals/bsp.trace.json or {home_dir}/.cache/metals/bsp.trace.json�[0m
2024.12.31 11:48:05 INFO  tracing is disabled for protocol BSP, to enable tracing of incoming and outgoing JSON messages create an empty file at {dir}/akka-quickstart-scala/project/.metals/bsp.trace.json or {home_dir}/.cache/metals/bsp.trace.json�[0m
2024.12.31 11:48:05 INFO  time: Connected to build server in 1.32s�[0m
2024.12.31 11:48:05 INFO  Connected to Build server: Bloop v2.0.6�[0m
2024.12.31 11:48:06 INFO  running doctor check�[0m
2024.12.31 11:48:06 INFO  java targets: akka-quickstart-scala-test, akka-quickstart-scala-build, akka-quickstart-scala-build-build, akka-quickstart-scala�[0m
2024.12.31 11:48:07 INFO  Disconnecting from Bloop session...�[0m
2024.12.31 11:48:07 INFO  Shut down connection with build server.�[0m
2024.12.31 11:48:07 INFO  Shut down connection with build server.�[0m
2024.12.31 11:48:07 INFO  Shut down connection with build server.�[0m
2024.12.31 11:48:07 ERROR Failed to connect with build server, no functionality will work.
java.nio.file.NoSuchFileException: {dir}/akka-quickstart-scala/.scalafmt.conf
	at sun.nio.fs.UnixException.translateToIOException(UnixException.java:92)
	at sun.nio.fs.UnixException.rethrowAsIOException(UnixException.java:106)
	at sun.nio.fs.UnixException.rethrowAsIOException(UnixException.java:111)
	at sun.nio.fs.UnixFileSystemProvider.newByteChannel(UnixFileSystemProvider.java:218)
	at java.nio.file.Files.newByteChannel(Files.java:380)
	at java.nio.file.Files.newByteChannel(Files.java:432)
	at java.nio.file.Files.readAllBytes(Files.java:3288)
	at scala.meta.internal.io.PlatformFileIO$.slurp(PlatformFileIO.scala:42)
	at scala.meta.internal.io.FileIO$.slurp(FileIO.scala:18)
	at scala.meta.internal.mtags.ScalametaCommonEnrichments$XtensionAbsolutePath.toInput(ScalametaCommonEnrichments.scala:445)
	at scala.meta.internal.metals.MetalsEnrichments$XtensionAbsolutePathBuffers.toInputFromBuffers(MetalsEnrichments.scala:621)
	at scala.meta.internal.metals.FormattingProvider.validateWorkspace(FormattingProvider.scala:408)
	at scala.meta.internal.metals.ProjectMetalsLspService.$anonfun$check$2(ProjectMetalsLspService.scala:839)
	at scala.collection.immutable.List.foreach(List.scala:334)
	at scala.meta.internal.metals.ProjectMetalsLspService.check(ProjectMetalsLspService.scala:839)
	at scala.meta.internal.metals.ProjectMetalsLspService.$anonfun$connectionProvider$1(ProjectMetalsLspService.scala:176)
	at scala.meta.internal.metals.Indexer.$anonfun$indexWorkspace$10(Indexer.scala:144)
	at scala.runtime.java8.JFunction0$mcV$sp.apply(JFunction0$mcV$sp.scala:18)
	at scala.meta.internal.metals.TimerProvider.timedThunk(TimerProvider.scala:25)
	at scala.meta.internal.metals.Indexer.indexWorkspace(Indexer.scala:144)
	at scala.meta.internal.metals.Indexer.$anonfun$profiledIndexWorkspace$2(Indexer.scala:57)
	at scala.runtime.java8.JFunction0$mcV$sp.apply(JFunction0$mcV$sp.scala:18)
	at scala.meta.internal.metals.TimerProvider.timedThunk(TimerProvider.scala:25)
	at scala.meta.internal.metals.Indexer.$anonfun$profiledIndexWorkspace$1(Indexer.scala:57)
	at scala.runtime.java8.JFunction0$mcV$sp.apply(JFunction0$mcV$sp.scala:18)
	at scala.concurrent.Future$.$anonfun$apply$1(Future.scala:687)
	at scala.concurrent.impl.Promise$Transformation.run(Promise.scala:467)
	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1136)
	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:635)
	at java.lang.Thread.run(Thread.java:833)
�[0m

[Austinito]

Once I create a blank .scalafmt.conf file then Metals attaches and works as expected.

[Austinito]

I've made a PR that addresses it.
After the fix: it will still index the workspace and allow you to work even though the custom scalafmt configuration isn't found:

2024.12.31 16:50:52 WARN  Unable to get content from {dir}/akka-quickstart-scala/someFile.conf
java.nio.file.NoSuchFileException: {dir}/akka-quickstart-scala/someFile.conf
	at sun.nio.fs.UnixException.translateToIOException(UnixException.java:92)
	at sun.nio.fs.UnixException.rethrowAsIOException(UnixException.java:106)
	at sun.nio.fs.UnixException.rethrowAsIOException(UnixException.java:111)
	at sun.nio.fs.UnixFileSystemProvider.newByteChannel(UnixFileSystemProvider.java:218)
	at java.nio.file.Files.newByteChannel(Files.java:380)
	at java.nio.file.Files.newByteChannel(Files.java:432)
	at java.nio.file.Files.readAllBytes(Files.java:3288)
	at scala.meta.internal.io.PlatformFileIO$.slurp(PlatformFileIO.scala:42)
	at scala.meta.internal.io.FileIO$.slurp(FileIO.scala:18)
	at scala.meta.internal.mtags.ScalametaCommonEnrichments$XtensionAbsolutePath.toInput(ScalametaCommonEnrichments.scala:445)
	at scala.meta.internal.metals.MetalsEnrichments$XtensionAbsolutePathBuffers.toInputFromBuffers(MetalsEnrichments.scala:621)
	at scala.meta.internal.metals.FormattingProvider.$anonfun$getTextFromBuffers$1(FormattingProvider.scala:439)
	at scala.util.Try$.apply(Try.scala:217)
	at scala.meta.internal.metals.FormattingProvider.getTextFromBuffers(FormattingProvider.scala:439)
	at scala.meta.internal.metals.FormattingProvider.validateWorkspace(FormattingProvider.scala:409)

[ckipp01]

Yes, so the issue is that you have scalafmtConfigPath = ".scalafmt.conf",. That's not needed. Since it's hardcoded Metals assumes that it must be there and fails if it doesn't find it. You should be able to just remove that line and everything should work.

[Austinito]

That's true.
However, If I have scalafmtConfigPath defined, I'd expect it to work just the same as the default path: stay connected to build server.