Merge pull request #136 from docker/dependent-service-compose-completions

Suggest dependent services for the depends_on attribute

Author: rcjsuen

CHANGELOG.md

@@ -6,7 +6,10 @@ All notable changes to the Docker Language Server will be documented in this fil
 
 ### Added
 
-- updated Compose schema to the latest version ([#117](https://github.com/docker/docker-language-server/issues/117))
+- Compose
+  - updated Compose schema to the latest version ([#117](https://github.com/docker/docker-language-server/issues/117))
+  - textDocument/completion
+    - suggest dependent service names for the `depends_on` attribute ([#131](https://github.com/docker/docker-language-server/issues/131))
 
 ### Fixed
 

internal/compose/completion.go

@@ -16,7 +16,7 @@ import (
 
 func prefix(line string, character int) string {
 	sb := strings.Builder{}
-	for i := 0; i < character; i++ {
+	for i := range character {
 		if unicode.IsSpace(rune(line[i])) {
 			sb.Reset()
 		} else {
@@ -62,9 +62,14 @@ func Completion(ctx context.Context, params *protocol.CompletionParams, doc docu
 		return nil, nil
 	}
 
+	wordPrefix := prefix(lines[lspLine], character-1)
+	dependencies := dependencyCompletionItems(file, path, params, protocol.UInteger(len(wordPrefix)))
+	if len(dependencies) > 0 {
+		return &protocol.CompletionList{Items: dependencies}, nil
+	}
+
 	items := []protocol.CompletionItem{}
 	nodeProps := nodeProperties(path, line, character)
-	wordPrefix := prefix(lines[lspLine], character-1)
 	if schema, ok := nodeProps.(*jsonschema.Schema); ok {
 		if schema.Enum != nil {
 			for _, value := range schema.Enum.Values {
@@ -151,6 +156,52 @@ func Completion(ctx context.Context, params *protocol.CompletionParams, doc docu
 	return &protocol.CompletionList{Items: items}, nil
 }
 
+func findServices(file *ast.File) []string {
+	services := []string{}
+	for _, documentNode := range file.Docs {
+		if mappingNode, ok := documentNode.Body.(*ast.MappingNode); ok {
+			for _, n := range mappingNode.Values {
+				if s, ok := n.Key.(*ast.StringNode); ok {
+					if s.Value == "services" {
+						if mappingNode, ok := n.Value.(*ast.MappingNode); ok {
+							for _, service := range mappingNode.Values {
+								services = append(services, service.Key.GetToken().Value)
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+	return services
+}
+
+func dependencyCompletionItems(file *ast.File, path []*ast.MappingValueNode, params *protocol.CompletionParams, prefixLength protocol.UInteger) []protocol.CompletionItem {
+	if len(path) == 3 && path[2].Key.GetToken().Value == "depends_on" {
+		items := []protocol.CompletionItem{}
+		for _, service := range findServices(file) {
+			if service != path[1].Key.GetToken().Value {
+				item := protocol.CompletionItem{
+					Label: service,
+					TextEdit: protocol.TextEdit{
+						NewText: service,
+						Range: protocol.Range{
+							Start: protocol.Position{
+								Line:      params.Position.Line,
+								Character: params.Position.Character - prefixLength,
+							},
+							End: params.Position,
+						},
+					},
+				}
+				items = append(items, item)
+			}
+		}
+		return items
+	}
+	return nil
+}
+
 func constructCompletionNodePath(file *ast.File, line int) []*ast.MappingValueNode {
 	for _, documentNode := range file.Docs {
 		if mappingNode, ok := documentNode.Body.(*ast.MappingNode); ok {

internal/compose/completion_test.go

@@ -1832,6 +1832,93 @@ networks:
 			character: 2,
 			list:      nil,
 		},
+		{
+			name: "depends_on array items",
+			content: `
+services:
+  test:
+    image: alpine
+    depends_on:
+      - 
+  test2:
+    image: alpine`,
+			line:      5,
+			character: 8,
+			list: &protocol.CompletionList{
+				Items: []protocol.CompletionItem{
+					{
+						Label:    "test2",
+						TextEdit: textEdit("test2", 5, 8, 0),
+					},
+				},
+			},
+		},
+		{
+			name: "depends_on array items across two files",
+			content: `
+---
+services:
+  test:
+    image: alpine
+    depends_on:
+      - 
+---
+services:
+  test2:
+    image: alpine`,
+			line:      6,
+			character: 8,
+			list: &protocol.CompletionList{
+				Items: []protocol.CompletionItem{
+					{
+						Label:    "test2",
+						TextEdit: textEdit("test2", 6, 8, 0),
+					},
+				},
+			},
+		},
+		{
+			name: "depends_on array items",
+			content: `
+services:
+  test:
+    image: alpine
+    depends_on:
+      - t
+  test2:
+    image: alpine`,
+			line:      5,
+			character: 9,
+			list: &protocol.CompletionList{
+				Items: []protocol.CompletionItem{
+					{
+						Label:    "test2",
+						TextEdit: textEdit("test2", 5, 9, 1),
+					},
+				},
+			},
+		},
+		{
+			name: "depends_on service object",
+			content: `
+services:
+  test:
+    image: alpine
+    depends_on:
+      
+  test2:
+    image: alpine`,
+			line:      5,
+			character: 6,
+			list: &protocol.CompletionList{
+				Items: []protocol.CompletionItem{
+					{
+						Label:    "test2",
+						TextEdit: textEdit("test2", 5, 6, 0),
+					},
+				},
+			},
+		},
 	}
 
 	composeFileURI := fmt.Sprintf("file:///%v", strings.TrimPrefix(filepath.ToSlash(filepath.Join(os.TempDir(), "compose.yaml")), "/"))