Merge pull request #169 from docker/compose-inlay-hints-bug-fixes

Fix object attribute and recursion bugs in inlay hints

Author: rcjsuen

internal/compose/inlayHint.go

@@ -31,7 +31,10 @@ func allServiceProperties(node ast.Node) map[string]map[string]ast.Node {
 func hierarchyProperties(service string, serviceProps map[string]map[string]ast.Node, chain []map[string]ast.Node) []map[string]ast.Node {
 	if extends, ok := serviceProps[service]["extends"]; ok {
 		if s, ok := extends.(*ast.StringNode); ok {
-			chain = append(chain, hierarchyProperties(s.Value, serviceProps, chain)...)
+			// block self-referencing recursions
+			if s.Value != service {
+				chain = append(chain, hierarchyProperties(s.Value, serviceProps, chain)...)
+			}
 		} else if mappingNode, ok := extends.(*ast.MappingNode); ok {
 			external := false
 			for _, value := range mappingNode.Values {
@@ -77,6 +80,10 @@ func InlayHint(doc document.ComposeDocument, rng protocol.Range) ([]protocol.Inl
 							if name == "extends" {
 								continue
 							}
+							// skip object attributes for now
+							if _, ok := value.(*ast.MappingNode); ok {
+								continue
+							}
 
 							for _, parentProps := range chain {
 								if parentProp, ok := parentProps[name]; ok {

internal/compose/inlayHint_test.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+	"slices"
 	"strings"
 	"testing"
 
@@ -52,15 +53,15 @@ services:
 			},
 		},
 		{
-			name: "attribute recurses upwards",
+			name: "attribute recurses upwards for a match",
 			content: `
 services:
   web:
     attach: true
   web2:
     extends: web
   web3:
-    extends: web
+    extends: web2
     attach: false`,
 			inlayHints: []protocol.InlayHint{
 				{
@@ -70,6 +71,60 @@ services:
 				},
 			},
 		},
+		{
+			name: "extension at different levels have the right value",
+			content: `
+services:
+  web:
+    hostname: hostname1
+  web2:
+    extends: web
+    hostname: hostname2
+  web3:
+    extends: web2
+    hostname: hostname3`,
+			inlayHints: []protocol.InlayHint{
+				{
+					Label:       "(parent value: hostname1)",
+					PaddingLeft: types.CreateBoolPointer(true),
+					Position:    protocol.Position{Line: 6, Character: 23},
+				},
+				{
+					Label:       "(parent value: hostname2)",
+					PaddingLeft: types.CreateBoolPointer(true),
+					Position:    protocol.Position{Line: 9, Character: 23},
+				},
+			},
+		},
+		{
+			name: "self recursion returns nothing",
+			content: `
+services:
+  web:
+    hostname: hostname1
+    extends: web2`,
+			inlayHints: []protocol.InlayHint{},
+		},
+		{
+			name: "self recursion does not affect other hints",
+			content: `
+services:
+  web:
+    hostname: hostname1
+  web2:
+    extends: web
+    hostname: hostname2
+  web3:
+    extends: web3
+    hostname: hostname3`,
+			inlayHints: []protocol.InlayHint{
+				{
+					Label:       "(parent value: hostname1)",
+					PaddingLeft: types.CreateBoolPointer(true),
+					Position:    protocol.Position{Line: 6, Character: 23},
+				},
+			},
+		},
 		{
 			name: "extends as an object but without a file attribute",
 			content: `
@@ -118,6 +173,19 @@ services:
 				},
 			},
 		},
+		{
+			name: "unmatched tree structure should not render any hints",
+			content: `
+services:
+  web:
+    build: .
+    context: abc
+  web2:
+    extends: web
+    build:
+      context: def`,
+			inlayHints: []protocol.InlayHint{},
+		},
 		{
 			name: "sub-attributes unsupported",
 			content: `
@@ -138,6 +206,9 @@ services:
 		t.Run(tc.name, func(t *testing.T) {
 			doc := document.NewComposeDocument(u, 1, []byte(tc.content))
 			inlayHints, err := InlayHint(doc, protocol.Range{})
+			slices.SortFunc(inlayHints, func(a protocol.InlayHint, b protocol.InlayHint) int {
+				return int(a.Position.Line) - int(b.Position.Line)
+			})
 			require.NoError(t, err)
 			require.Equal(t, tc.inlayHints, inlayHints)
 		})