Handle Invalid WSL URIs

[jpogran]

This adds another piece of logic to attempt to detect UNC WSL Uri as the workspace to open, and return a more informative error so the client can handle prompting the user.

The UNC WSL Uri being passed is in the form of \\wsl$\Ubuntu\home\james\some\path. If the user wants to edit files in the WSL instance, they should be opening the workspace in the Remote WSL extension.

When the VS Code sends the path to terraform-ls, it is urlencoded as \\wsl%24\Ubuntu\home\james\some\path. This fails uri.IsURIValid, which is incorrect because it is a valid path that needs to be decoded. Even if it is decoded, further on in the uri package we make assumptions about file paths that ignore the server portion of a UNC path, resulting in terraform-ls attempting to use Ubuntu\home\james\some\path. A future PR can address that.

Works with, but not required, hashicorp/vscode-terraform#1219

Closes #656

[radeksimko]

I left suggestions in-line.

I reckon we'll also need to update this test

terraform-ls/internal/langserver/handlers/initialize_test.go

Lines 98 to 117 in 2e881ba

	func TestInitialize_withInvalidRootURI(t *testing.T) {
	tmpDir := TempDir(t)
	ls := langserver.NewLangServerMock(t, NewMockSession(&MockSessionInput{
	TerraformCalls: &exec.TerraformMockCalls{
	PerWorkDir: map[string][]*mock.Call{
	tmpDir.Path(): validTfMockCalls(),
	},
	},
	}))
	stop := ls.Start(t)
	defer stop()
	ls.CallAndExpectError(t, &langserver.CallRequest{
	Method: "initialize",
	ReqParams: `{
	"capabilities": {},
	"processId": 12345,
	"rootUri": "meh"
	}`}, code.SystemError.Err())
	}

We could also add a similar one with a WSL URI but it's probably not worth it since we're comparing error type only anyway without the extra Data field.

[radeksimko]

Just one minor question/suggestion regarding the test, merge at will.

One thing I was aiming to achieve with the extra Data field was that we'd be able to compare it more easily with just == or === on the client side. Therefore I don't fully understand the motivation behind startsWith method here, but we can discuss it in that PR rather than here.

Even if it is decoded, further on in the uri package we make assumptions about file paths that ignore the server portion of a UNC path, resulting in terraform-ls attempting to use Ubuntu\home\james\some\path. A future PR can address that.

Yep - we can address that as part of #74

[github-actions]

This functionality has been released in v0.29.2 of the language server.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.