Skip to content

Add custom code to handle wsl$ URIs #377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rcjsuen merged 2 commits into from
Jul 28, 2025
Merged

Add custom code to handle wsl$ URIs #377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32827af
Add custom code to handle wsl$ URIs
rcjsuen Jul 28, 2025
fb2d2ed
Include the fix in CHANGELOG.md
rcjsuen Jul 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ All notable changes to the Docker Language Server will be documented in this fil
- Compose
- textDocument/documentLink
- improve handling of malformed image attribute values with registry prefixes ([#369](https://github.com/docker/docker-language-server/issues/369))
- convert links properly if a WSL URI with a dollar sign is used ([#366](https://github.com/docker/docker-language-server/issues/366))

## [0.14.0] - 2025-07-16

Expand Down
60 changes: 37 additions & 23 deletions internal/compose/documentLink.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"context"
"fmt"
"net/url"
"path"
"path/filepath"
"strings"

Expand Down Expand Up @@ -31,8 +32,15 @@ func createRange(t *token.Token, length int) protocol.Range {
}
}

func createLink(folderAbsolutePath string, node *token.Token) *protocol.DocumentLink {
func createLink(folderAbsolutePath string, wslDollarSign bool, node *token.Token) *protocol.DocumentLink {
file := node.Value
if wslDollarSign {
return &protocol.DocumentLink{
Range: createRange(node, len(file)),
Target: types.CreateStringPointer("file://wsl%24" + path.Join(strings.ReplaceAll(folderAbsolutePath, "\\", "/"), file)),
Tooltip: types.CreateStringPointer("\\\\wsl%24" + strings.ReplaceAll(path.Join(folderAbsolutePath, file), "/", "\\")),
}
}
abs := filepath.ToSlash(filepath.Join(folderAbsolutePath, file))
return &protocol.DocumentLink{
Range: createRange(node, len(file)),
Expand All @@ -41,10 +49,10 @@ func createLink(folderAbsolutePath string, node *token.Token) *protocol.Document
}
}

func createFileLink(folderAbsolutePath string, serviceNode *ast.MappingValueNode) *protocol.DocumentLink {
func createFileLink(folderAbsolutePath string, wslDollarSign bool, serviceNode *ast.MappingValueNode) *protocol.DocumentLink {
attributeValue := stringNode(serviceNode.Value)
if attributeValue != nil {
return createLink(folderAbsolutePath, attributeValue.GetToken())
return createLink(folderAbsolutePath, wslDollarSign, attributeValue.GetToken())
}
return nil
}
Expand All @@ -56,12 +64,12 @@ func stringNode(value ast.Node) *ast.StringNode {
return nil
}

func createdNestedLink(folderAbsolutePath string, serviceNode *ast.MappingValueNode, parent, child string) *protocol.DocumentLink {
func createdNestedLink(folderAbsolutePath string, wslDollarSign bool, serviceNode *ast.MappingValueNode, parent, child string) *protocol.DocumentLink {
if resolveAnchor(serviceNode.Key).GetToken().Value == parent {
if mappingNode, ok := resolveAnchor(serviceNode.Value).(*ast.MappingNode); ok {
for _, buildAttribute := range mappingNode.Values {
if resolveAnchor(buildAttribute.Key).GetToken().Value == child {
return createFileLink(folderAbsolutePath, buildAttribute)
return createFileLink(folderAbsolutePath, wslDollarSign, buildAttribute)
}
}
}
Expand All @@ -86,29 +94,29 @@ func createImageLink(serviceNode *ast.MappingValueNode) *protocol.DocumentLink {
return nil
}

func createLabelFileLink(folderAbsolutePath string, serviceNode *ast.MappingValueNode) []protocol.DocumentLink {
func createLabelFileLink(folderAbsolutePath string, wslDollarSign bool, serviceNode *ast.MappingValueNode) []protocol.DocumentLink {
if resolveAnchor(serviceNode.Key).GetToken().Value == "label_file" {
if sequence, ok := resolveAnchor(serviceNode.Value).(*ast.SequenceNode); ok {
links := []protocol.DocumentLink{}
for _, node := range sequence.Values {
if s, ok := resolveAnchor(node).(*ast.StringNode); ok {
links = append(links, *createLink(folderAbsolutePath, s.GetToken()))
links = append(links, *createLink(folderAbsolutePath, wslDollarSign, s.GetToken()))
}
}
return links
}

link := createFileLink(folderAbsolutePath, serviceNode)
link := createFileLink(folderAbsolutePath, wslDollarSign, serviceNode)
if link != nil {
return []protocol.DocumentLink{*link}
}
}
return nil
}

func createObjectFileLink(folderAbsolutePath string, serviceNode *ast.MappingValueNode) *protocol.DocumentLink {
func createObjectFileLink(folderAbsolutePath string, wslDollarSign bool, serviceNode *ast.MappingValueNode) *protocol.DocumentLink {
if resolveAnchor(serviceNode.Key).GetToken().Value == "file" {
return createFileLink(folderAbsolutePath, serviceNode)
return createFileLink(folderAbsolutePath, wslDollarSign, serviceNode)
}
return nil
}
Expand Down Expand Up @@ -167,14 +175,14 @@ func includedFiles(nodes []ast.Node) []*token.Token {
return tokens
}

func scanForLinks(folderAbsolutePath string, n *ast.MappingValueNode) []protocol.DocumentLink {
func scanForLinks(folderAbsolutePath string, wslDollarSign bool, n *ast.MappingValueNode) []protocol.DocumentLink {
if s, ok := resolveAnchor(n.Key).(*ast.StringNode); ok {
links := []protocol.DocumentLink{}
switch s.Value {
case "include":
if sequence, ok := resolveAnchor(n.Value).(*ast.SequenceNode); ok {
for _, token := range includedFiles(sequence.Values) {
link := createLink(folderAbsolutePath, token)
link := createLink(folderAbsolutePath, wslDollarSign, token)
if link != nil {
links = append(links, *link)
}
Expand All @@ -190,22 +198,22 @@ func scanForLinks(folderAbsolutePath string, n *ast.MappingValueNode) []protocol
links = append(links, *link)
}

link = createdNestedLink(folderAbsolutePath, serviceAttribute, "build", "dockerfile")
link = createdNestedLink(folderAbsolutePath, wslDollarSign, serviceAttribute, "build", "dockerfile")
if link != nil {
links = append(links, *link)
}

link = createdNestedLink(folderAbsolutePath, serviceAttribute, "credential_spec", "file")
link = createdNestedLink(folderAbsolutePath, wslDollarSign, serviceAttribute, "credential_spec", "file")
if link != nil {
links = append(links, *link)
}

link = createdNestedLink(folderAbsolutePath, serviceAttribute, "extends", "file")
link = createdNestedLink(folderAbsolutePath, wslDollarSign, serviceAttribute, "extends", "file")
if link != nil {
links = append(links, *link)
}

labelFileLinks := createLabelFileLink(folderAbsolutePath, serviceAttribute)
labelFileLinks := createLabelFileLink(folderAbsolutePath, wslDollarSign, serviceAttribute)
links = append(links, labelFileLinks...)
}
}
Expand All @@ -216,7 +224,7 @@ func scanForLinks(folderAbsolutePath string, n *ast.MappingValueNode) []protocol
for _, node := range mappingNode.Values {
if configAttributes, ok := resolveAnchor(node.Value).(*ast.MappingNode); ok {
for _, configAttribute := range configAttributes.Values {
link := createObjectFileLink(folderAbsolutePath, configAttribute)
link := createObjectFileLink(folderAbsolutePath, wslDollarSign, configAttribute)
if link != nil {
links = append(links, *link)
}
Expand All @@ -229,7 +237,7 @@ func scanForLinks(folderAbsolutePath string, n *ast.MappingValueNode) []protocol
for _, node := range mappingNode.Values {
if configAttributes, ok := resolveAnchor(node.Value).(*ast.MappingNode); ok {
for _, configAttribute := range configAttributes.Values {
link := createObjectFileLink(folderAbsolutePath, configAttribute)
link := createObjectFileLink(folderAbsolutePath, wslDollarSign, configAttribute)
if link != nil {
links = append(links, *link)
}
Expand All @@ -256,16 +264,22 @@ func scanForLinks(folderAbsolutePath string, n *ast.MappingValueNode) []protocol
return nil
}

func documentFolder(documentURI protocol.URI) (string, error) {
func documentFolder(documentURI protocol.URI) (string, bool, error) {
url, err := url.Parse(string(documentURI))
if err != nil {
return "", fmt.Errorf("LSP client sent invalid URI: %v", string(documentURI))
if strings.HasPrefix(documentURI, "file://wsl%24/") {
path := documentURI[len("file://wsl%24"):]
idx := strings.LastIndex(path, "/")
return path[0 : idx+1], true, nil
}
return "", false, fmt.Errorf("LSP client sent invalid URI: %v", string(documentURI))
}
return types.AbsoluteFolder(url)
folder, err := types.AbsoluteFolder(url)
return folder, false, err
}

func DocumentLink(ctx context.Context, documentURI protocol.URI, doc document.ComposeDocument) ([]protocol.DocumentLink, error) {
abs, err := documentFolder(documentURI)
abs, wslDollarSign, err := documentFolder(documentURI)
if err != nil {
return nil, err
}
Expand All @@ -279,7 +293,7 @@ func DocumentLink(ctx context.Context, documentURI protocol.URI, doc document.Co
for _, documentNode := range file.Docs {
if mappingNode, ok := documentNode.Body.(*ast.MappingNode); ok {
for _, node := range mappingNode.Values {
links = append(links, scanForLinks(abs, node)...)
links = append(links, scanForLinks(abs, wslDollarSign, node)...)
}
}
}
Expand Down
52 changes: 52 additions & 0 deletions internal/compose/documentLink_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,58 @@ func documentLinkTarget(testsFolder, fileName string) *string {
return &target
}

func TestDocumentLink_WSL(t *testing.T) {
composeStringURI := "file://wsl%24/docker-desktop/tmp/compose.yaml"
testCases := []struct {
name string
content string
links []protocol.DocumentLink
}{
{
name: "included files, string array",
content: `include:
- file.yaml
- ./file2.yaml
- ../other/file3.yaml`,
links: []protocol.DocumentLink{
{
Range: protocol.Range{
Start: protocol.Position{Line: 1, Character: 4},
End: protocol.Position{Line: 1, Character: 13},
},
Target: types.CreateStringPointer("file://wsl%24/docker-desktop/tmp/file.yaml"),
Tooltip: types.CreateStringPointer("\\\\wsl%24\\docker-desktop\\tmp\\file.yaml"),
},
{
Range: protocol.Range{
Start: protocol.Position{Line: 2, Character: 4},
End: protocol.Position{Line: 2, Character: 16},
},
Target: types.CreateStringPointer("file://wsl%24/docker-desktop/tmp/file2.yaml"),
Tooltip: types.CreateStringPointer("\\\\wsl%24\\docker-desktop\\tmp\\file2.yaml"),
},
{
Range: protocol.Range{
Start: protocol.Position{Line: 3, Character: 4},
End: protocol.Position{Line: 3, Character: 23},
},
Target: types.CreateStringPointer("file://wsl%24/docker-desktop/other/file3.yaml"),
Tooltip: types.CreateStringPointer("\\\\wsl%24\\docker-desktop\\other\\file3.yaml"),
},
},
},
}

for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
doc := document.NewComposeDocument(document.NewDocumentManager(), "compose.yaml", 1, []byte(tc.content))
links, err := DocumentLink(context.Background(), composeStringURI, doc)
require.NoError(t, err)
require.Equal(t, tc.links, links)
})
}
}

func TestDocumentLink_IncludedFiles(t *testing.T) {
testsFolder := filepath.Join(os.TempDir(), "composeDocumentLinkTests")
composeFilePath := filepath.Join(testsFolder, "docker-compose.yml")
Expand Down
Loading