Merge pull request #23 from grafana/julienduchesne/fix-self-scope

Fix `self` scope

Author: julienduchesne

pkg/position/range.go

@@ -48,3 +48,21 @@ func InRange(point ast.Location, theRange ast.LocationRange) bool {
 
 	return true
 }
+
+// RangeGreaterOrEqual returns true if the first range is greater than the second.
+func RangeGreaterOrEqual(a ast.LocationRange, b ast.LocationRange) bool {
+	if a.Begin.Line > b.Begin.Line {
+		return false
+	}
+	if a.End.Line < b.End.Line {
+		return false
+	}
+	if a.Begin.Line == b.Begin.Line && a.Begin.Column > b.Begin.Column {
+		return false
+	}
+	if a.End.Line == b.End.Line && a.End.Column < b.End.Column {
+		return false
+	}
+
+	return true
+}

pkg/processing/find_field.go

@@ -51,7 +51,7 @@ func FindRangesFromIndexList(stack *nodestack.NodeStack, indexList []string, vm
 		tmpStack := nodestack.NewNodeStack(stack.From)
 		tmpStack.Stack = make([]ast.Node, len(stack.Stack))
 		copy(tmpStack.Stack, stack.Stack)
-		foundDesugaredObjects = findTopLevelObjects(tmpStack, vm)
+		foundDesugaredObjects = filterSelfScope(findTopLevelObjects(tmpStack, vm))
 	} else if start == "std" {
 		return nil, fmt.Errorf("cannot get definition of std lib")
 	} else if strings.Contains(start, ".") {

pkg/processing/object.go

@@ -0,0 +1,33 @@
+package processing
+
+import (
+	"github.com/google/go-jsonnet/ast"
+	"github.com/grafana/jsonnet-language-server/pkg/position"
+)
+
+// filterSelfScope takes in an array of objects (blocks delimited by curly braces) and
+//   returns a new array of objects, where only objects in scope of the first one are kept
+// This is done by comparing the location ranges. If the range of the first object is
+//   contained within the range of another object, the latter object is removed because
+//   it is a parent of the first object.
+func filterSelfScope(objs []*ast.DesugaredObject) (result []*ast.DesugaredObject) {
+	if len(objs) == 0 {
+		return objs
+	}
+
+	// Copy the array so we don't modify the original
+	result = objs[:]
+
+	topLevel := result[0]
+	i := 1
+	for i < len(result) {
+		obj := result[i]
+		// If the current object is contained within the top level object, remove it
+		if position.RangeGreaterOrEqual(obj.LocRange, topLevel.LocRange) {
+			result = append(result[:i], result[i+1:]...)
+			continue
+		}
+		i++
+	}
+	return
+}

pkg/server/definition_test.go

@@ -466,6 +466,21 @@ func TestDefinitionFail(t *testing.T) {
 			},
 			expected: fmt.Errorf("could not find a lhs object"),
 		},
+		{
+			name: "goto self fails when out of scope",
+			params: protocol.DefinitionParams{
+				TextDocumentPositionParams: protocol.TextDocumentPositionParams{
+					TextDocument: protocol.TextDocumentIdentifier{
+						URI: "testdata/goto-self-out-of-scope.jsonnet",
+					},
+					Position: protocol.Position{
+						Line:      3,
+						Character: 18,
+					},
+				},
+			},
+			expected: fmt.Errorf("field test was not found in ast.DesugaredObject"),
+		},
 	}
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {

pkg/server/testdata/goto-self-out-of-scope.jsonnet

@@ -0,0 +1,6 @@
+{
+  test: 'test',
+  sub: {
+    test2: self.test,
+  },
+}