textDocument/definition URI is incompatible with (...)ExternalSourceService cache

[Hoffs]

Hi,

I've been working on extending LSP client to pull metadata/file source when textDocument/definition returns result with $metadata$ URI (e.g. uri = "file:///%24metadata%24/Project/nvim-csharp-metadata/Assembly/System/Console/Symbol/System/Console.cs").

The problem I encountered that it seems to be impossible to get subsequent results using textDocument/definition when being run from $metadata$ file. For example, first definition request is done from normal file and gets:

{
  bufnr = 1,
  client_id = 1,
  method = "textDocument/definition",
  params = {
    position = {
      character = 20,
      line = 8
    },
    textDocument = {
      uri = "file:///home/hoffs/projects/nvim-csharp-metadata/Program.cs"
    }
  }
}
----- response ------
  {
    range = {
      end = {
        character = 36,
        line = 1774
      },
      start = {
        character = 27,
        line = 1774
      }
    },
    uri = "file:///%24metadata%24/Project/nvim-csharp-metadata/Assembly/System/Console/Symbol/System/Console.cs"
  }

Then that file can be fetched with custom call to o#/metadata, but then once in that temporary/pseudo file buffer, named $metadata$/Project/nvim-csharp-metadata/Assembly/System/Console/Symbol/System/Console.cs any textDocument/definition request is incompatible to properly resolve to cached document.

I believe the issue lies at FromUri call at:

omnisharp-roslyn/src/OmniSharp.LanguageServerProtocol/Handlers/OmniSharpDefinitionHandler.cs

Lines 35 to 40 in 657b064

	var omnisharpRequest = new GotoDefinitionRequest()
	{
	FileName = FromUri(request.TextDocument.Uri),
	Column = Convert.ToInt32(request.Position.Character),
	Line = Convert.ToInt32(request.Position.Line)
	};

As this Uri->FileName gets translated to incompatible string for FindDocumentInCache.

omnisharp-roslyn/src/OmniSharp.Roslyn.CSharp/Services/Navigation/GotoDefinitionServiceV2.cs

Lines 33 to 34 in 657b064

	var document = externalSourceService.FindDocumentInCache(request.FileName) ??
	_workspace.GetDocument(request.FileName);

omnisharp-roslyn/src/OmniSharp.Roslyn/BaseExternalSourceService.cs

Lines 17 to 25 in 657b064

	public Document FindDocumentInCache(string fileName)
	{
	if (_cache.TryGetValue(fileName, out var metadataDocument))
	{
	return metadataDocument;
	}
	return null;
	}

LSP URI	FileName/Cache Key attempted
file://$metadata$/Project/nvim-csharp-metadata/Assembly/System/Console/Symbol/System/Console.cs	\\\\$metadata$\\Project\\nvim-csharp-metadata\\Assembly\\System\\Console\\Symbol\\System\\Console.cs
file:///$metadata$/Project/nvim-csharp-metadata/Assembly/System/Console/Symbol/System/Console.cs	/$metadata$/Project/nvim-csharp-metadata/Assembly/System/Console/Symbol/System/Console.cs

The desired cache key is $metadata$/Project/nvim-csharp-metadata/Assembly/System/Console/Symbol/System/Console.cs which I believe is impossible to get when going through FromUri.

So while the metadata functionality is a bit outside the standard LSP spec, since it already returns and saves the $metadata$ documents in cache (without even calling o#/metadata), I believe it would be nice if it would properly work if textDocument/definition requests come from $metadata$ file.

If thats fine, this could either be done by not using FromUri or having special case for when URI is for $metadata$ file. IMO 2nd row in the table, where $metadata$ is supposedly under root (/$metadata$/...) should be the happy scenario when providing URI for $metadata$ documents, so then in the handler it could just have a check for StartsWith('/$metadata$/'... or something.

[tadeokondrak]

Hi, not sure if this is helpful, but I'm also trying to get metadata working in a non-VSCode LSP client, and for your example, I think file:///Project/nvim-csharp-metadata/Assembly/System/Console/Symbol/System/[metadata] Console.cs would work. That seems to be the URL used in VSCode.

[svermeulen]

Is there a way to at least disable this $metadata$ feature so that us LSP users don't run into this error constantly?

[kflu]

is it reasonable to say that omnisharp-roslyn lsp should not return any URI that contains $metadata$, which does not comply with LSP standard, and most lsp clients don’t know how to handle it.

I’m using vim-lsp and also bump into this.

[joaotavora]

And, for good measure here's my +1 to this issue. In the Eglot client, I get a nonsensical URL like /$metadata$/Project/my-project/Assembly/.... This $metadata$ variable does sound like something which could be set, somehow.

[tilupe]

+1

[griggsca91]

Just would like to say, I started a new job in a dotnet shop, and would love to be able to have this support with my neovim editor

[Multirious]

+1. This is also problematic on Helix editor. helix-editor/helix#2430

Helix also dumped out a lot of received malformed notification from Language Server: Unhandled that has been coming from OmniSharp too. Not sure if this issue been mentioned before.

[AugustoDeveloper]

Hey, guys, do we have any updates?

[KiLLeRRaT]

I have just installed and configured https://github.com/Hoffs/omnisharp-extended-lsp.nvim and it seems to be working well for me. I have only used it for around 30 minutes so far, but so far, so good...

Edit: I did find that if I bind straight to this, my goto definition stops working for other file types. I've added an ftplugin specific binding just for cs files. As per https://github.com/KiLLeRRaT/.dotfiles/blob/65839bcdb41558d543395c0efa329f2fab6cc644/nvim-lua/.config/nvim/after/ftplugin/cs.lua#L9C1-L9C96

[AugustoDeveloper]

I have just installed and configured https://github.com/Hoffs/omnisharp-extended-lsp.nvim and it seems to be working well for me. I have only used it for around 30 minutes so far, but so far, so good...

Yes, it works, but if you try to go to definition on metadata file, an error will be displayed.

[jknopp]

+1 on this using https://github.com/Hoffs/omnisharp-extended-lsp.nvim

[KiLLeRRaT]

+1 on this using https://github.com/Hoffs/omnisharp-extended-lsp.nvim

See my edit on my first post about this and the ftplugin binding.