Unexpected errors on when running cli program outside of directory with solution

[nickbeaird]

I am new to the project and I ran into an error on the CLI invocation. I downloaded the tooling according to the command in the README dotnet tool install --global csharp-ls. I followed the output of that and ran csharp-ls and I received uncaught System.AggregateException: One or more errors occurred. (Header does not end with expected \r\n character sequence: ). I believe that this might related to ticket #106 .

I am am on an M1 mac and I have dotnet 10.0.100 installed.

Error output:

20:30:41.764 fail: LSP[0]
      System.AggregateException: One or more errors occurred. (Header does not end with expected \r\n character sequence: )
       ---> StreamJsonRpc.BadRpcHeaderException: Header does not end with expected \r\n character sequence:
         at StreamJsonRpc.HeaderDelimitedMessageHandler.ReadHeadersAsync(CancellationToken cancellationToken)
         at StreamJsonRpc.HeaderDelimitedMessageHandler.ReadCoreAsync(CancellationToken cancellationToken)
         at StreamJsonRpc.MessageHandlerBase.ReadAsync(CancellationToken cancellationToken)
         at StreamJsonRpc.JsonRpc.ReadAndHandleRequestsAsync()
         --- End of inner exception stack trace ---
         at Ionide.LanguageServerProtocol.Server.startWithSetupCore[client](FSharpFunc`2 setupRequestHandlings, IJsonRpcMessageHandler jsonRpcHandler, FSharpFunc`2 clientCreator, FSharpFunc`2 customizeRpc) in /_//src/LanguageServerProtocol.fs:line 215
         at Ionide.LanguageServerProtocol.Server.startWithSetup[client](FSharpFunc`2 setupRequestHandlings, Stream input, Stream output, FSharpFunc`2 clientCreator, FSharpFunc`2 customizeRpc) in /_//src/LanguageServerProtocol.fs:line 230
         at Ionide.LanguageServerProtocol.Server.start@271-1.Invoke(FSharpFunc`2 customizeRpc)
         at CSharpLanguageServer.Lsp.Server.startCore(ServerSettings settings) in /_//src/CSharpLanguageServer/Lsp/Server.fs:line 479
         at CSharpLanguageServer.Lsp.Server.start(ServerSettings options) in /_//src/CSharpLanguageServer/Lsp/Server.fs:line 484 crashed

I did run the troubleshooting csharp-ls --diagnose and interestingly it seems that the program then tries to recursively iterate through all of the git projects that I have that are children of the repo that I started in. I keep most of my projects in a directory called code and there are a number of projects that have a .sln file installed.

..... <truncated output>

      loadProjectTfms: failed to load /Users/nick/code/aspnetcore/src/Tools/dotnet-sql-cache/src/dotnet-sql-cache.csproj: Microsoft.Build.Exceptions.InvalidProjectFileException
20:53:22.408 dbug: Roslyn.Solution[0]
      loadProjectTfms: failed to load /Users/nick/code/aspnetcore/src/Tools/dotnet-user-jwts/src/dotnet-user-jwts.csproj: Microsoft.Build.Exceptions.InvalidProjectFileException
20:53:22.418 dbug: Roslyn.Solution[0]
      loadProjectTfms: failed to load /Users/nick/code/aspnetcore/src/Tools/dotnet-user-jwts/test/dotnet-user-jwts.Tests.csproj: Microsoft.Build.Exceptions.InvalidProjectFileException
20:53:22.428 dbug: Roslyn.Solution[0]
      loadProjectTfms: failed to load /Users/nick/code/aspnetcore/src/Tools/dotnet-user-secrets/src/dotnet-user-secrets.csproj: Microsoft.Build.Exceptions.InvalidProjectFileException
20:53:22.440 dbug: Roslyn.Solution[0]
      loadProjectTfms: failed to load /Users/nick/code/aspnetcore/src/Tools/dotnet-user-secrets/test/dotnet-user-secrets.Tests.csproj: Microsoft.Build.Exceptions.InvalidProjectFileException
20:53:22.449 dbug: Roslyn.Solution[0]
      loadProjectTfms: failed to load /Users/nick/code/aspnetcore/src/WebEncoders/src/Microsoft.Extensions.WebEncoders.csproj: Microsoft.Build.Exceptions.InvalidProjectFileException
20:53:22.453 info: Roslyn.Solution[0]
      Will use MSBuild props: map []
20:53:23.225 dbug: Diagnostics[0]
WindowShowMessage: csharp-ls: Solution "/Users/nick/code/aspnetcore/AspNetCore.sln" could not be loaded: System.AggregateException: One or more errors occurred. (An exception of type System.InvalidOperationException was thrown: Error while calling hostfxr function hostfxr_resolve_sdk2. Error code: -2147450725 Detailed error: A compatible .NET SDK was not found.

      Requested SDK version: 9.0.100-preview.2.24078.1
      global.json file: /Users/nick/code/aspnetcore/global.json

      Installed SDKs:

      Install the [9.0.100-preview.2.24078.1] .NET SDK or update [/Users/nick/code/aspnetcore/global.json] to match an installed SDK.

      Learn about SDK resolution:
      https://aka.ms/dotnet/sdk-not-found
      )
       ---> Microsoft.CodeAnalysis.MSBuild.RemoteInvocationException: An exception of type System.InvalidOperationException was thrown: Error while calling hostfxr function hostfxr_resolve_sdk2. Error code: -2147450725 Detailed error: A compatible .NET SDK was not found.

      Requested SDK version: 9.0.100-preview.2.24078.1
      global.json file: /Users/nick/code/aspnetcore/global.json

      Installed SDKs:

      Install the [9.0.100-preview.2.24078.1] .NET SDK or update [/Users/nick/code/aspnetcore/global.json] to match an installed SDK.

      Learn about SDK resolution:
      https://aka.ms/dotnet/sdk-not-found

         at Microsoft.CodeAnalysis.MSBuild.RpcClient.InvokeCoreAsync(Int32 targetObject, String methodName, List`1 parameters, Type expectedReturnType, CancellationToken cancellationToken)
         at Microsoft.CodeAnalysis.MSBuild.RpcClient.InvokeNullableAsync[T](Int32 targetObject, String methodName, List`1 parameters, CancellationToken cancellationToken)
         at Microsoft.CodeAnalysis.MSBuild.BuildHostProcessManager.<GetBuildHostAsync>g__NoLock_GetBuildHostAsync|15_0(BuildHostProcessKind buildHostKind, String projectOrSolutionFilePath, String dotnetPath, CancellationToken cancellationToken)
         at Microsoft.CodeAnalysis.MSBuild.BuildHostProcessManager.GetBuildHostAsync(BuildHostProcessKind buildHostKind, String projectOrSolutionFilePath, String dotnetPath, CancellationToken cancellationToken)
         at Microsoft.CodeAnalysis.MSBuild.BuildHostProcessManager.GetBuildHostWithFallbackAsync(BuildHostProcessKind buildHostKind, String projectOrSolutionFilePath, CancellationToken cancellationToken)
         at Microsoft.CodeAnalysis.MSBuild.MSBuildProjectLoader.Worker.LoadProjectFileInfosAsync(String projectPath, DiagnosticReportingOptions reportingOptions, CancellationToken cancellationToken)
         at Microsoft.CodeAnalysis.MSBuild.MSBuildProjectLoader.Worker.LoadProjectInfosFromPathAsync(String projectPath, DiagnosticReportingOptions reportingOptions, CancellationToken cancellationToken)
         at Microsoft.CodeAnalysis.MSBuild.MSBuildProjectLoader.Worker.LoadAsync(CancellationToken cancellationToken)
         at Microsoft.CodeAnalysis.MSBuild.MSBuildProjectLoader.LoadSolutionInfoAsync(String solutionFilePath, IProgress`1 progress, ILogger msbuildLogger, CancellationToken cancellationToken)
         at Microsoft.CodeAnalysis.MSBuild.MSBuildProjectLoader.LoadSolutionInfoAsync(String solutionFilePath, IProgress`1 progress, ILogger msbuildLogger, CancellationToken cancellationToken)
         at Microsoft.CodeAnalysis.MSBuild.MSBuildWorkspace.OpenSolutionAsync(String solutionFilePath, ILogger msbuildLogger, IProgress`1 progress, CancellationToken cancellationToken)
         --- End of inner exception stack trace ---
20:53:23.226 dbug: Diagnostics[0]

[nickbeaird]

I would also be interested in trying to pick this up, or something that you might suggest would be a good pick for a newer contributor.

[razzmatazz]

Feel free to!

[nickbeaird]

Hi @razzmatazz I am hoping to get some feedback on this approach. I have a sample PR here, but I wanted to get feedback before proceeding further.

I had initially tried to validate the input at the point that it is sourced in the solutionFindAndLoadOnDir method, but by trying to set the line Directory.GetFiles(dir, p, SearchOption.AllDirectories) to Directory.GetFiles(dir, p, SearchOption.TopDirectoryOnly) caused a number of the unit tests to break. I see that the tests allow for sourcing a directory with cspoj files only for example. All in all, thank you for your time and let me know what thoughts that you have.

[razzmatazz]

Sorry for getting to this just now.

First thing, csharp-ls is expected to enter LSP-protocol mode (unless --diagnose arg is passed in), so that would explain the System.AggregateException: One or more errors occurred. (Header does not end with expected \r\n character sequence: ) error when you run csharp-ls from the terminal. This is the expected behaviour as editors will launch csharp-ls process and will communicate over stdio with the language server process–i.e. csharp-ls was looking for RPC request header on stdin and did not found it as you are presumably driving it from console yourself. (That is unless I misread some of your intent)

As for the second part, it is also expected that editors will provide rootUri/rootPath/workspaceFolders pointing to working directories of the project when starting the server (otherwise csharp-ls will try to use CWD for the process as launched by the editor, as a workaround). I.e. editors are to provide rootUri pointing to a particular project directory under code directory, when launched, i.e. code/projectX. You should only need to specify .sln/.slnx file via the -s arg when there are multiple .sln files in you project or if csharp-ls does not find it for you for some reason.

csharp-ls --diagnose command line option, has been added to enable diagnostics outside of the editor environment, i.e. on the console, started by the user thus it will look for .sln files on CWD.

Again, I am not sure I grasp what it the particular problem you are trying to solve. Are you starting csharp-ls from a command line "naked" or is the issue that your editor does not start csharp-ls properly/or does not find correct .slnx/.sln file?

[nickbeaird]

Okay yes, my issue is explicitly about running the application from the command line. I was doing this to get acquainted with the project as I am in the process of setting up an LSP env for C# in emacs, which I am not fully there yet. Understanding a little better now, the exception StreamJsonRpc.BadRpcHeaderException is the expected output when running the app via the cli. If so, then possibly adding additional error handling and stdout messaging for direct cli invocation could help, or possibly adding documentation to the readme about it might be a way to call it out.

To your second point on the--diagnose option and based on my output above, I was suprised by how long it took to load, the number of solutions loaded, and the error that I received. If I am reading what you are saying the -s flag is a requirement when using the --diagnose flag, but it is not required with the cli program without the --diagnose flag. As the cli program takes quite some time to error out do you think that there can be some sort of error handling on invalid directories (e.g. multiple solutions, no valid files, etc) when invoking --diagnose via the command line? I would also be potentially interested to know are there invalid directory types, or does this source all C# file recursively? It could potentially help with the developer experience to error early if that is possible.

At this point my suggestions above point to possibly improving output when running this program in isolation. I defer to your thoughts on the matter.