Merge pull request #83 from docker/long-form-depends_on-definition

Support looking up services using the long form depends_on syntax

Author: rcjsuen

CHANGELOG.md

@@ -10,7 +10,8 @@ All notable changes to the Docker Language Server will be documented in this fil
     - support code navigation when a single attribute of a target has been reused ([#78](https://github.com/docker/docker-language-server/issues/78))
 - Compose
   - textDocument/definition
-    - support lookup of services referenced by the short form syntax of `depends_on` ([#67](https://github.com/docker/docker-language-server/issues/67))
+    - support lookup of `services` referenced by the short form syntax of `depends_on` ([#67](https://github.com/docker/docker-language-server/issues/67))
+    - support lookup of `services` referenced by the long form syntax of `depends_on` ([#68](https://github.com/docker/docker-language-server/issues/68))
 
 ### Fixed
 - ensure file validation is skipped if the file has since been closed by the editor ([#79](https://github.com/docker/docker-language-server/issues/79))

internal/compose/definition.go

@@ -21,27 +21,16 @@ func Definition(ctx context.Context, definitionLinkSupport bool, doc document.Co
 						if service.Content[j].Value == "depends_on" {
 							if service.Content[j+1].Kind == yaml.SequenceNode {
 								for _, dependency := range service.Content[j+1].Content {
-									if dependency.Line == line && dependency.Column <= character && character <= dependency.Column+len(dependency.Value) {
-										serviceRange := ServiceDefinitionRange(root, dependency.Value)
-										if serviceRange == nil {
-											return nil, nil
-										}
-
-										return createDefinitionResult(
-											definitionLinkSupport,
-											*serviceRange,
-											&protocol.Range{
-												Start: protocol.Position{
-													Line:      params.Position.Line,
-													Character: protocol.UInteger(dependency.Column - 1),
-												},
-												End: protocol.Position{
-													Line:      params.Position.Line,
-													Character: protocol.UInteger(dependency.Column + len(dependency.Value) - 1),
-												},
-											},
-											params.TextDocument.URI,
-										), nil
+									link := serviceDependencyLink(root, definitionLinkSupport, params, dependency, line, character)
+									if link != nil {
+										return link, nil
+									}
+								}
+							} else if service.Content[j+1].Kind == yaml.MappingNode {
+								for k := 0; k < len(service.Content[j+1].Content); k += 2 {
+									link := serviceDependencyLink(root, definitionLinkSupport, params, service.Content[j+1].Content[k], line, character)
+									if link != nil {
+										return link, nil
 									}
 								}
 							}
@@ -54,7 +43,33 @@ func Definition(ctx context.Context, definitionLinkSupport bool, doc document.Co
 	return nil, nil
 }
 
-func ServiceDefinitionRange(root yaml.Node, serviceName string) *protocol.Range {
+func serviceDependencyLink(root yaml.Node, definitionLinkSupport bool, params *protocol.DefinitionParams, dependency *yaml.Node, line, character int) any {
+	if dependency.Line == line && dependency.Column <= character && character <= dependency.Column+len(dependency.Value) {
+		serviceRange := serviceDefinitionRange(root, dependency.Value)
+		if serviceRange == nil {
+			return nil
+		}
+
+		return createDefinitionResult(
+			definitionLinkSupport,
+			*serviceRange,
+			&protocol.Range{
+				Start: protocol.Position{
+					Line:      params.Position.Line,
+					Character: protocol.UInteger(dependency.Column - 1),
+				},
+				End: protocol.Position{
+					Line:      params.Position.Line,
+					Character: protocol.UInteger(dependency.Column + len(dependency.Value) - 1),
+				},
+			},
+			params.TextDocument.URI,
+		)
+	}
+	return nil
+}
+
+func serviceDefinitionRange(root yaml.Node, serviceName string) *protocol.Range {
 	for i := 0; i < len(root.Content[0].Content); i += 2 {
 		switch root.Content[0].Content[i].Value {
 		case "services":

internal/compose/definition_test.go

@@ -106,6 +106,51 @@ services:
 				},
 			},
 		},
+		{
+			name: "long syntax form of depends_on in services",
+			content: `
+services:
+  web:
+    build: .
+    depends_on:
+      db:
+        condition: service_healthy
+        restart: true
+      redis:
+        condition: service_started
+  db:
+    image: postgres
+  redis:
+    image: redis`,
+			line:      8,
+			character: 9,
+			locations: []protocol.Location{
+				{
+					URI: composeFileURI,
+					Range: protocol.Range{
+						Start: protocol.Position{Line: 12, Character: 2},
+						End:   protocol.Position{Line: 12, Character: 7},
+					},
+				},
+			},
+			links: []protocol.LocationLink{
+				{
+					OriginSelectionRange: &protocol.Range{
+						Start: protocol.Position{Line: 8, Character: 6},
+						End:   protocol.Position{Line: 8, Character: 11},
+					},
+					TargetURI: composeFileURI,
+					TargetRange: protocol.Range{
+						Start: protocol.Position{Line: 12, Character: 2},
+						End:   protocol.Position{Line: 12, Character: 7},
+					},
+					TargetSelectionRange: protocol.Range{
+						Start: protocol.Position{Line: 12, Character: 2},
+						End:   protocol.Position{Line: 12, Character: 7},
+					},
+				},
+			},
+		},
 	}
 
 	for _, tc := range testCases {