Refactor hoverAtPos to use collected origins (#155)

Author: dbanck

decoder/hover.go

@@ -283,7 +283,7 @@ func (d *PathDecoder) hoverDataForExpr(ctx context.Context, expr hcl.Expression,
 
 		tes, ok := constraints.TraversalExprs()
 		if ok {
-			content, err := d.hoverContentForTraversalExpr(e.AsTraversal(), tes)
+			content, err := d.hoverContentForTraversalExpr(e.AsTraversal(), tes, pos)
 			if err != nil {
 				return nil, err
 			}
@@ -642,19 +642,28 @@ func stringValFromTemplateExpr(tplExpr *hclsyntax.TemplateExpr) (cty.Value, bool
 	return cty.StringVal(value), true
 }
 
-func (d *PathDecoder) hoverContentForTraversalExpr(traversal hcl.Traversal, tes []schema.TraversalExpr) (string, error) {
-	origin, err := reference.TraversalToLocalOrigin(traversal, tes)
-	if err != nil {
-		return "", nil
+func (d *PathDecoder) hoverContentForTraversalExpr(traversal hcl.Traversal, tes []schema.TraversalExpr, pos hcl.Pos) (string, error) {
+	origins, ok := d.pathCtx.ReferenceOrigins.AtPos(traversal.SourceRange().Filename, pos)
+	if !ok {
+		return "", &reference.NoOriginFound{}
 	}
 
-	targets, ok := d.pathCtx.ReferenceTargets.Match(origin)
-	if !ok {
-		return "", &reference.NoTargetFound{}
+	for _, origin := range origins {
+		matchableOrigin, ok := origin.(reference.MatchableOrigin)
+		if !ok {
+			continue
+		}
+		targets, ok := d.pathCtx.ReferenceTargets.Match(matchableOrigin)
+		if !ok {
+			// target not found
+			continue
+		}
+
+		// TODO: Reflect additional found targets here?
+		return hoverContentForReferenceTarget(targets[0])
 	}
 
-	// TODO: Reflect additional found targets here?
-	return hoverContentForReferenceTarget(targets[0])
+	return "", &reference.NoTargetFound{}
 }
 
 func hoverContentForReferenceTarget(ref reference.Target) (string, error) {

decoder/hover_expressions_test.go

@@ -1309,6 +1309,7 @@ func TestDecoder_HoverAtPos_traversalExpressions(t *testing.T) {
 		name         string
 		attrSchema   map[string]*schema.AttributeSchema
 		refs         reference.Targets
+		origins      reference.Origins
 		cfg          string
 		pos          hcl.Pos
 		expectedData *lang.HoverData
@@ -1324,6 +1325,32 @@ func TestDecoder_HoverAtPos_traversalExpressions(t *testing.T) {
 				},
 			},
 			reference.Targets{},
+			reference.Origins{
+				reference.LocalOrigin{
+					Addr: lang.Address{
+						lang.RootStep{Name: "var"},
+						lang.AttrStep{Name: "blah"},
+					},
+					Range: hcl.Range{
+						Filename: "test.tf",
+						Start: hcl.Pos{
+							Line:   1,
+							Column: 8,
+							Byte:   7,
+						},
+						End: hcl.Pos{
+							Line:   1,
+							Column: 16,
+							Byte:   15,
+						},
+					},
+					Constraints: reference.OriginConstraints{
+						reference.OriginConstraint{
+							OfType: cty.String,
+						},
+					},
+				},
+			},
 			`attr = var.blah`,
 			hcl.Pos{Line: 1, Column: 10, Byte: 9},
 			nil,
@@ -1347,6 +1374,32 @@ func TestDecoder_HoverAtPos_traversalExpressions(t *testing.T) {
 					Type: cty.Bool,
 				},
 			},
+			reference.Origins{
+				reference.LocalOrigin{
+					Addr: lang.Address{
+						lang.RootStep{Name: "var"},
+						lang.AttrStep{Name: "blah"},
+					},
+					Range: hcl.Range{
+						Filename: "test.tf",
+						Start: hcl.Pos{
+							Line:   1,
+							Column: 8,
+							Byte:   7,
+						},
+						End: hcl.Pos{
+							Line:   1,
+							Column: 16,
+							Byte:   15,
+						},
+					},
+					Constraints: reference.OriginConstraints{
+						reference.OriginConstraint{
+							OfType: cty.String,
+						},
+					},
+				},
+			},
 			`attr = var.blah`,
 			hcl.Pos{Line: 1, Column: 10, Byte: 9},
 			nil,
@@ -1370,6 +1423,32 @@ func TestDecoder_HoverAtPos_traversalExpressions(t *testing.T) {
 					Type: cty.String,
 				},
 			},
+			reference.Origins{
+				reference.LocalOrigin{
+					Addr: lang.Address{
+						lang.RootStep{Name: "var"},
+						lang.AttrStep{Name: "blah"},
+					},
+					Range: hcl.Range{
+						Filename: "test.tf",
+						Start: hcl.Pos{
+							Line:   1,
+							Column: 8,
+							Byte:   7,
+						},
+						End: hcl.Pos{
+							Line:   1,
+							Column: 16,
+							Byte:   15,
+						},
+					},
+					Constraints: reference.OriginConstraints{
+						reference.OriginConstraint{
+							OfType: cty.String,
+						},
+					},
+				},
+			},
 			`attr = var.blah`,
 			hcl.Pos{Line: 1, Column: 10, Byte: 9},
 			&lang.HoverData{
@@ -1408,6 +1487,33 @@ func TestDecoder_HoverAtPos_traversalExpressions(t *testing.T) {
 					Type: cty.DynamicPseudoType,
 				},
 			},
+			reference.Origins{
+				reference.LocalOrigin{
+					Addr: lang.Address{
+						lang.RootStep{Name: "var"},
+						lang.AttrStep{Name: "foo"},
+						lang.AttrStep{Name: "bar"},
+					},
+					Range: hcl.Range{
+						Filename: "test.tf",
+						Start: hcl.Pos{
+							Line:   1,
+							Column: 8,
+							Byte:   7,
+						},
+						End: hcl.Pos{
+							Line:   1,
+							Column: 19,
+							Byte:   18,
+						},
+					},
+					Constraints: reference.OriginConstraints{
+						reference.OriginConstraint{
+							OfType: cty.String,
+						},
+					},
+				},
+			},
 			`attr = var.foo.bar`,
 			hcl.Pos{Line: 1, Column: 10, Byte: 9},
 			&lang.HoverData{
@@ -1447,6 +1553,32 @@ func TestDecoder_HoverAtPos_traversalExpressions(t *testing.T) {
 					Name:    "special",
 				},
 			},
+			reference.Origins{
+				reference.LocalOrigin{
+					Addr: lang.Address{
+						lang.RootStep{Name: "var"},
+						lang.AttrStep{Name: "foo"},
+					},
+					Range: hcl.Range{
+						Filename: "test.tf",
+						Start: hcl.Pos{
+							Line:   1,
+							Column: 8,
+							Byte:   7,
+						},
+						End: hcl.Pos{
+							Line:   1,
+							Column: 15,
+							Byte:   14,
+						},
+					},
+					Constraints: reference.OriginConstraints{
+						reference.OriginConstraint{
+							OfScopeId: lang.ScopeId("foo"),
+						},
+					},
+				},
+			},
 			`attr = var.foo`,
 			hcl.Pos{Line: 1, Column: 10, Byte: 9},
 			&lang.HoverData{
@@ -1480,6 +1612,7 @@ func TestDecoder_HoverAtPos_traversalExpressions(t *testing.T) {
 			d := testPathDecoder(t, &PathContext{
 				Schema:           bodySchema,
 				ReferenceTargets: tc.refs,
+				ReferenceOrigins: tc.origins,
 				Files: map[string]*hcl.File{
 					"test.tf": f,
 				},