Replace : with %3A after file:/// scheme in URIs to match VS Code's LSP client (#4345)

Co-authored-by: Stefan VanBuren <[email protected]>

Author: yjoer

private/buf/buflsp/buflsp_test.go

@@ -146,7 +146,7 @@ func setupLSPServer(
 	})
 
 	testWorkspaceDir := filepath.Dir(testProtoPath)
-	testURI := uri.New(testProtoPath)
+	testURI := buflsp.FilePathToURI(testProtoPath)
 	var initResult protocol.InitializeResult
 	_, initErr := clientJSONConn.Call(ctx, protocol.MethodInitialize, &protocol.InitializeParams{
 		RootURI: uri.New(testWorkspaceDir),

private/buf/buflsp/definition_test.go

@@ -16,13 +16,12 @@ package buflsp_test
 
 import (
 	"path/filepath"
-	"strings"
 	"testing"
 
+	"github.com/bufbuild/buf/private/buf/buflsp"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"go.lsp.dev/protocol"
-	"go.lsp.dev/uri"
 )
 
 func TestDefinition(t *testing.T) {
@@ -37,7 +36,7 @@ func TestDefinition(t *testing.T) {
 	require.NoError(t, err)
 
 	clientJSONConn, testURI := setupLSPServer(t, testProtoPath)
-	typesURI := uri.New(typesProtoPath)
+	typesURI := buflsp.FilePathToURI(typesProtoPath)
 
 	tests := []struct {
 		name               string
@@ -242,9 +241,7 @@ func TestDefinitionURLEncoding(t *testing.T) {
 	require.Len(t, locations, 1, "expected exactly one definition location")
 	location := locations[0]
 
-	// Construct the expected URI with @ encoded as %40
-	// Use uri.File() to get the correct URI format for the platform (e.g., file:/// on Windows)
-	expectedURI := protocol.URI(strings.ReplaceAll(string(uri.File(testProtoPath)), "@", "%40"))
+	expectedURI := buflsp.FilePathToURI(testProtoPath)
 
 	assert.Equal(t, expectedURI, location.URI, "returned URI should have @ encoded as %40")
 

private/buf/buflsp/diagnostics_test.go

@@ -141,7 +141,7 @@ func setupLSPServerWithDiagnostics(
 	})
 
 	testWorkspaceDir := filepath.Dir(testProtoPath)
-	testURI := uri.New(testProtoPath)
+	testURI := buflsp.FilePathToURI(testProtoPath)
 	var initResult protocol.InitializeResult
 	_, initErr := clientJSONConn.Call(ctx, protocol.MethodInitialize, &protocol.InitializeParams{
 		RootURI: uri.New(testWorkspaceDir),

private/buf/buflsp/document_link_test.go

@@ -18,10 +18,10 @@ import (
 	"path/filepath"
 	"testing"
 
+	"github.com/bufbuild/buf/private/buf/buflsp"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"go.lsp.dev/protocol"
-	"go.lsp.dev/uri"
 )
 
 func TestDocumentLink(t *testing.T) {
@@ -126,7 +126,7 @@ func TestDocumentLink(t *testing.T) {
 				case linkTargetTypeLocal:
 					localPath, err := filepath.Abs(expected.localPath)
 					require.NoError(t, err)
-					expectedURI := uri.New(localPath)
+					expectedURI := buflsp.FilePathToURI(localPath)
 					assert.Equal(t, expectedURI, link.Target, "link %d (%s): wrong target", i, expected.description)
 				case linkTargetTypeURL:
 					assert.Equal(t, protocol.DocumentURI(expected.targetURL), link.Target, "link %d (%s): wrong target", i, expected.description)

private/buf/buflsp/references_test.go

@@ -19,10 +19,10 @@ import (
 	"slices"
 	"testing"
 
+	"github.com/bufbuild/buf/private/buf/buflsp"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"go.lsp.dev/protocol"
-	"go.lsp.dev/uri"
 )
 
 func TestReferences(t *testing.T) {
@@ -37,7 +37,7 @@ func TestReferences(t *testing.T) {
 	require.NoError(t, err)
 
 	clientJSONConn, testURI := setupLSPServer(t, testProtoPath)
-	typesURI := uri.New(typesProtoPath)
+	typesURI := buflsp.FilePathToURI(typesProtoPath)
 
 	type refLocation struct {
 		uri  protocol.URI

private/buf/buflsp/rename_test.go

@@ -20,10 +20,10 @@ import (
 	"slices"
 	"testing"
 
+	"github.com/bufbuild/buf/private/buf/buflsp"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"go.lsp.dev/protocol"
-	"go.lsp.dev/uri"
 )
 
 func TestRename(t *testing.T) {
@@ -38,9 +38,9 @@ func TestRename(t *testing.T) {
 	subpkgOptionsProtoPath, err := filepath.Abs("testdata/rename/subpkg/options.proto")
 	require.NoError(t, err)
 	clientJSONConn, testURI := setupLSPServer(t, testProtoPath)
-	typesURI := uri.New(typesProtoPath)
-	extensionsURI := uri.New(extensionsProtoPath)
-	subpkgOptionsURI := uri.New(subpkgOptionsProtoPath)
+	typesURI := buflsp.FilePathToURI(typesProtoPath)
+	extensionsURI := buflsp.FilePathToURI(extensionsProtoPath)
+	subpkgOptionsURI := buflsp.FilePathToURI(subpkgOptionsProtoPath)
 
 	type editLocation struct {
 		uri            protocol.URI
@@ -361,7 +361,7 @@ func TestPrepareRename(t *testing.T) {
 	wktProtoPath, err := filepath.Abs("testdata/rename/wkt.proto")
 	require.NoError(t, err)
 	clientJSONConn, testURI := setupLSPServer(t, testProtoPath)
-	wktURI := uri.New(wktProtoPath)
+	wktURI := buflsp.FilePathToURI(wktProtoPath)
 
 	tests := []struct {
 		name          string

private/buf/buflsp/type_definition_test.go

@@ -18,10 +18,10 @@ import (
 	"path/filepath"
 	"testing"
 
+	"github.com/bufbuild/buf/private/buf/buflsp"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"go.lsp.dev/protocol"
-	"go.lsp.dev/uri"
 )
 
 func TestTypeDefinition(t *testing.T) {
@@ -36,7 +36,7 @@ func TestTypeDefinition(t *testing.T) {
 	require.NoError(t, err)
 
 	clientJSONConn, testURI := setupLSPServer(t, testProtoPath)
-	typesURI := uri.New(typesProtoPath)
+	typesURI := buflsp.FilePathToURI(typesProtoPath)
 
 	tests := []struct {
 		name                string

private/buf/buflsp/uri.go

@@ -28,13 +28,22 @@ import (
 // microsoft/vscode-uri package which encodes '@' as '%40' everywhere to avoid ambiguity
 // with the authority component separator (user@host).
 //
+// Additionally, on Windows, the package also encodes ':' as '%3A' in drive letter paths
+// (e.g., 'file:///d:/path' becomes 'file:///d%3A/path').
+//
 // When URIs don't match exactly, LSP operations like go-to-definition fail because
 // the client's URI (with %40) doesn't match the server's URI (with @).
 func normalizeURI(u protocol.URI) protocol.URI {
-	return protocol.URI(strings.ReplaceAll(string(u), "@", "%40"))
+	normalized := strings.ReplaceAll(string(u), "@", "%40")
+
+	if after, found := strings.CutPrefix(normalized, "file:///"); found {
+		normalized = "file:///" + strings.ReplaceAll(after, ":", "%3A")
+	}
+
+	return protocol.URI(normalized)
 }
 
-// filePathToURI converts a file path to a properly encoded URI.
-func filePathToURI(path string) protocol.URI {
+// FilePathToURI converts a file path to a properly encoded URI.
+func FilePathToURI(path string) protocol.URI {
 	return normalizeURI(uri.File(path))
 }

private/buf/buflsp/uri_test.go

@@ -0,0 +1,69 @@
+// Copyright 2020-2025 Buf Technologies, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package buflsp
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"go.lsp.dev/protocol"
+)
+
+func TestNormalizeURI(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		name     string
+		input    protocol.URI
+		expected protocol.URI
+	}{
+		{
+			name:     "unix-path-unchanged",
+			input:    "file:///home/user/project/foo.proto",
+			expected: "file:///home/user/project/foo.proto",
+		},
+		{
+			name:     "at-sign-encoded",
+			input:    "file:///home/user@host/project/foo.proto",
+			expected: "file:///home/user%40host/project/foo.proto",
+		},
+		{
+			name:     "windows-drive-letter-colon-encoded",
+			input:    "file:///C:/Users/project/foo.proto",
+			expected: "file:///C%3A/Users/project/foo.proto",
+		},
+		{
+			name:     "windows-lowercase-drive-letter-colon-encoded",
+			input:    "file:///d:/Users/project/foo.proto",
+			expected: "file:///d%3A/Users/project/foo.proto",
+		},
+		{
+			name:     "non-file-uri-colon-not-encoded",
+			input:    "untitled:Untitled-1",
+			expected: "untitled:Untitled-1",
+		},
+		{
+			name:     "at-sign-and-windows-drive-letter-both-encoded",
+			input:    "file:///C:/Users/user@host/foo.proto",
+			expected: "file:///C%3A/Users/user%40host/foo.proto",
+		},
+	}
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			t.Parallel()
+			assert.Equal(t, test.expected, normalizeURI(test.input))
+		})
+	}
+}

private/buf/buflsp/workspace.go

@@ -247,7 +247,7 @@ func (w *workspace) indexFiles(ctx context.Context) {
 	for fileInfo := range w.fileInfos(ctx) {
 		file, ok := previous[fileInfo.Path()]
 		if !ok {
-			fileURI := filePathToURI(fileInfo.LocalPath())
+			fileURI := FilePathToURI(fileInfo.LocalPath())
 			file = w.lsp.fileManager.Track(fileURI)
 			w.lsp.logger.Debug("workspace: index track file", slog.String("path", file.uri.Filename()))
 		}