Skip to content

Support searching for service references in volumes_from #455

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 1 commit into from
Aug 22, 2025
Merged

Support searching for service references in volumes_from #455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ All notable changes to the Docker Language Server will be documented in this fil

## [Unreleased]

### Added

- Compose
- textDocument/definition
- support jumping to service references in the `volumes_from` attribute of a service object ([#452](https://github.com/docker/docker-language-server/issues/452))
- textDocument/documentHighlight
- support highlighting service references in the `volumes_from` attribute of a service object ([#452](https://github.com/docker/docker-language-server/issues/452))
- textDocument/prepareRename
- support preparing renames for services in the `volumes_from` attribute of a service object ([#452](https://github.com/docker/docker-language-server/issues/452))
- textDocument/rename
- support renaming service referencesin the `volumes_from` attribute of a service object ([#452](https://github.com/docker/docker-language-server/issues/452))

### Fixed

- Compose
Expand Down
19 changes: 18 additions & 1 deletion internal/compose/documentHighlight.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ func extendedServiceReferences(servicesNode *ast.MappingNode) []*token.Token {
for _, serviceNode := range servicesNode.Values {
if serviceAttributes, ok := resolveAnchor(serviceNode.Value).(*ast.MappingNode); ok {
for _, attributeNode := range serviceAttributes.Values {
if resolveAnchor(attributeNode.Key).GetToken().Value == "extends" {
switch resolveAnchor(attributeNode.Key).GetToken().Value {
case "extends":
attributeNodeValue := resolveAnchor(attributeNode.Value)
if extendedValue, ok := attributeNodeValue.(*ast.StringNode); ok {
tokens = append(tokens, extendedValue.GetToken())
Expand All @@ -66,6 +67,22 @@ func extendedServiceReferences(servicesNode *ast.MappingNode) []*token.Token {
}
}
}
case "volumes_from":
if sequenceNode, ok := resolveAnchor(attributeNode.Value).(*ast.SequenceNode); ok {
for _, volume := range sequenceNode.Values {
volumeToken := resolveAnchor(volume).GetToken()
split := strings.Split(volumeToken.Value, ":")
if len(split) == 1 {
tokens = append(tokens, volumeToken)
} else if len(split[0]) > 0 && split[0] != "container" {
tokens = append(tokens, &token.Token{
Type: volumeToken.Type,
Value: split[0],
Position: volumeToken.Position,
})
}
}
}
}
}
}
Expand Down
316 changes: 316 additions & 0 deletions internal/compose/documentHighlight_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1803,6 +1803,322 @@ services:
End: protocol.Position{Line: 6, Character: 8},
},
},
{
name: "undefined read highlight on a volumes_from array item",
content: `
services:
test:
volumes_from:
- server`,
line: 4,
character: 10,
locations: func(u protocol.DocumentUri) any { return nil },
links: func(u protocol.DocumentUri) any { return nil },
ranges: []protocol.DocumentHighlight{
documentHighlight(4, 8, 4, 14, protocol.DocumentHighlightKindRead),
},
renameEdits: func(u protocol.DocumentUri) *protocol.WorkspaceEdit {
return &protocol.WorkspaceEdit{
Changes: map[protocol.DocumentUri][]protocol.TextEdit{
u: {
{
NewText: "newName",
Range: protocol.Range{
Start: protocol.Position{Line: 4, Character: 8},
End: protocol.Position{Line: 4, Character: 14},
},
},
},
},
}
},
prepareRename: &protocol.Range{
Start: protocol.Position{Line: 4, Character: 8},
End: protocol.Position{Line: 4, Character: 14},
},
},
{
name: "undefined read highlight on a volumes_from array item (volumes_from attribute key is anchored)",
content: `
services:
test:
&anchor volumes_from:
- server`,
line: 4,
character: 10,
locations: func(u protocol.DocumentUri) any { return nil },
links: func(u protocol.DocumentUri) any { return nil },
ranges: []protocol.DocumentHighlight{
documentHighlight(4, 8, 4, 14, protocol.DocumentHighlightKindRead),
},
renameEdits: func(u protocol.DocumentUri) *protocol.WorkspaceEdit {
return &protocol.WorkspaceEdit{
Changes: map[protocol.DocumentUri][]protocol.TextEdit{
u: {
{
NewText: "newName",
Range: protocol.Range{
Start: protocol.Position{Line: 4, Character: 8},
End: protocol.Position{Line: 4, Character: 14},
},
},
},
},
}
},
prepareRename: &protocol.Range{
Start: protocol.Position{Line: 4, Character: 8},
End: protocol.Position{Line: 4, Character: 14},
},
},
{
name: "undefined read highlight on a volumes_from array item (volumes_from attribute value is anchored)",
content: `
services:
test:
volumes_from: &anchor
- server`,
line: 4,
character: 10,
locations: func(u protocol.DocumentUri) any { return nil },
links: func(u protocol.DocumentUri) any { return nil },
ranges: []protocol.DocumentHighlight{
documentHighlight(4, 8, 4, 14, protocol.DocumentHighlightKindRead),
},
renameEdits: func(u protocol.DocumentUri) *protocol.WorkspaceEdit {
return &protocol.WorkspaceEdit{
Changes: map[protocol.DocumentUri][]protocol.TextEdit{
u: {
{
NewText: "newName",
Range: protocol.Range{
Start: protocol.Position{Line: 4, Character: 8},
End: protocol.Position{Line: 4, Character: 14},
},
},
},
},
}
},
prepareRename: &protocol.Range{
Start: protocol.Position{Line: 4, Character: 8},
End: protocol.Position{Line: 4, Character: 14},
},
},
{
name: "undefined read highlight on a volumes_from array item (array item is anchored)",
content: `
services:
test:
volumes_from:
- &anchor server`,
line: 4,
character: 18,
locations: func(u protocol.DocumentUri) any { return nil },
links: func(u protocol.DocumentUri) any { return nil },
ranges: []protocol.DocumentHighlight{
documentHighlight(4, 16, 4, 22, protocol.DocumentHighlightKindRead),
},
renameEdits: func(u protocol.DocumentUri) *protocol.WorkspaceEdit {
return &protocol.WorkspaceEdit{
Changes: map[protocol.DocumentUri][]protocol.TextEdit{
u: {
{
NewText: "newName",
Range: protocol.Range{
Start: protocol.Position{Line: 4, Character: 16},
End: protocol.Position{Line: 4, Character: 22},
},
},
},
},
}
},
prepareRename: &protocol.Range{
Start: protocol.Position{Line: 4, Character: 16},
End: protocol.Position{Line: 4, Character: 22},
},
},
{
name: "undefined read highlight on a volumes_from array item with a :ro suffix",
content: `
services:
test:
volumes_from:
- server:ro`,
line: 4,
character: 10,
locations: func(u protocol.DocumentUri) any { return nil },
links: func(u protocol.DocumentUri) any { return nil },
ranges: []protocol.DocumentHighlight{
documentHighlight(4, 8, 4, 14, protocol.DocumentHighlightKindRead),
},
renameEdits: func(u protocol.DocumentUri) *protocol.WorkspaceEdit {
return &protocol.WorkspaceEdit{
Changes: map[protocol.DocumentUri][]protocol.TextEdit{
u: {
{
NewText: "newName",
Range: protocol.Range{
Start: protocol.Position{Line: 4, Character: 8},
End: protocol.Position{Line: 4, Character: 14},
},
},
},
},
}
},
prepareRename: &protocol.Range{
Start: protocol.Position{Line: 4, Character: 8},
End: protocol.Position{Line: 4, Character: 14},
},
},
{
name: "read highlight on a volumes_from array item pointing to a service",
content: `
services:
test:
volumes_from:
- server
server:`,
line: 4,
character: 10,
locations: func(u protocol.DocumentUri) any {
return types.CreateDefinitionResult(false, protocol.Range{
Start: protocol.Position{Line: 5, Character: 2},
End: protocol.Position{Line: 5, Character: 8},
}, nil, u)
},
links: func(u protocol.DocumentUri) any {
return types.CreateDefinitionResult(true, protocol.Range{
Start: protocol.Position{Line: 5, Character: 2},
End: protocol.Position{Line: 5, Character: 8},
}, &protocol.Range{
Start: protocol.Position{Line: 4, Character: 8},
End: protocol.Position{Line: 4, Character: 14},
}, u)
},
ranges: []protocol.DocumentHighlight{
documentHighlight(4, 8, 4, 14, protocol.DocumentHighlightKindRead),
documentHighlight(5, 2, 5, 8, protocol.DocumentHighlightKindWrite),
},
renameEdits: func(u protocol.DocumentUri) *protocol.WorkspaceEdit {
return &protocol.WorkspaceEdit{
Changes: map[protocol.DocumentUri][]protocol.TextEdit{
u: {
{
NewText: "newName",
Range: protocol.Range{
Start: protocol.Position{Line: 4, Character: 8},
End: protocol.Position{Line: 4, Character: 14},
},
},
{
NewText: "newName",
Range: protocol.Range{
Start: protocol.Position{Line: 5, Character: 2},
End: protocol.Position{Line: 5, Character: 8},
},
},
},
},
}
},
prepareRename: &protocol.Range{
Start: protocol.Position{Line: 4, Character: 8},
End: protocol.Position{Line: 4, Character: 14},
},
},
{
name: "write highlight on a volumes_from array item pointing to a service",
content: `
services:
test:
volumes_from:
- server
server:`,
line: 5,
character: 5,
locations: func(u protocol.DocumentUri) any {
return types.CreateDefinitionResult(false, protocol.Range{
Start: protocol.Position{Line: 5, Character: 2},
End: protocol.Position{Line: 5, Character: 8},
}, nil, u)
},
links: func(u protocol.DocumentUri) any {
return types.CreateDefinitionResult(true, protocol.Range{
Start: protocol.Position{Line: 5, Character: 2},
End: protocol.Position{Line: 5, Character: 8},
}, &protocol.Range{
Start: protocol.Position{Line: 5, Character: 2},
End: protocol.Position{Line: 5, Character: 8},
}, u)
},
ranges: []protocol.DocumentHighlight{
documentHighlight(4, 8, 4, 14, protocol.DocumentHighlightKindRead),
documentHighlight(5, 2, 5, 8, protocol.DocumentHighlightKindWrite),
},
renameEdits: func(u protocol.DocumentUri) *protocol.WorkspaceEdit {
return &protocol.WorkspaceEdit{
Changes: map[protocol.DocumentUri][]protocol.TextEdit{
u: {
{
NewText: "newName",
Range: protocol.Range{
Start: protocol.Position{Line: 4, Character: 8},
End: protocol.Position{Line: 4, Character: 14},
},
},
{
NewText: "newName",
Range: protocol.Range{
Start: protocol.Position{Line: 5, Character: 2},
End: protocol.Position{Line: 5, Character: 8},
},
},
},
},
}
},
prepareRename: &protocol.Range{
Start: protocol.Position{Line: 5, Character: 2},
End: protocol.Position{Line: 5, Character: 8},
},
},
{
name: "undefined read highlight on a volumes_from with no service just :ro",
content: `
services:
test:
volumes_from:
- :ro`,
line: 4,
character: 8,
locations: func(u protocol.DocumentUri) any { return nil },
links: func(u protocol.DocumentUri) any { return nil },
ranges: nil,
renameEdits: func(u protocol.DocumentUri) *protocol.WorkspaceEdit {
return nil
},
prepareRename: nil,
},
{
name: "undefined read highlight on a volumes_from array item pointing to a container",
content: `
services:
test:
volumes_from:
- container:ro`,
line: 4,
character: 10,
locations: func(u protocol.DocumentUri) any { return nil },
links: func(u protocol.DocumentUri) any { return nil },
ranges: nil,
renameEdits: func(u protocol.DocumentUri) *protocol.WorkspaceEdit {
return nil
},
prepareRename: nil,
},
{
name: "invalid services value",
content: `
Expand Down
Loading