decoder/schema: Pass PrefillRequiredFields around via context

decoder/attribute_candidates.go

@@ -1,6 +1,7 @@
 package decoder
 
 import (
+ "context"
  "fmt"
  "sort"
  "strings"
@@ -11,11 +12,11 @@ import (
  "github.com/zclconf/go-cty/cty"
 )
 
-func attributeSchemaToCandidate(name string, attr *schema.AttributeSchema, rng hcl.Range) lang.Candidate {
+func attributeSchemaToCandidate(ctx context.Context, name string, attr *schema.AttributeSchema, rng hcl.Range) lang.Candidate {
  var snippet string
  var triggerSuggest bool
  if attr.Constraint != nil {
- cData := attr.Constraint.EmptyCompletionData(1, 0)
+ cData := attr.Constraint.EmptyCompletionData(ctx, 1, 0)
  snippet = fmt.Sprintf("%s = %s", name, cData.Snippet)
  triggerSuggest = cData.TriggerSuggest
  } else {

decoder/body_candidates.go

@@ -1,6 +1,7 @@
 package decoder
 
 import (
+ "context"
  "sort"
  "strings"
 
@@ -11,7 +12,7 @@ import (
 )
 
 // bodySchemaCandidates returns candidates for completion of fields inside a body or block.
-func (d *PathDecoder) bodySchemaCandidates(body *hclsyntax.Body, schema *schema.BodySchema, prefixRng, editRng hcl.Range) lang.Candidates {
+func (d *PathDecoder) bodySchemaCandidates(ctx context.Context, body *hclsyntax.Body, schema *schema.BodySchema, prefixRng, editRng hcl.Range) lang.Candidates {
  prefix, _ := d.bytesFromRange(prefixRng)
 
  candidates := lang.NewCandidates()
@@ -23,15 +24,15 @@ func (d *PathDecoder) bodySchemaCandidates(body *hclsyntax.Body, schema *schema.
  // check if count attribute is already declared, so we don't
  // suggest a duplicate
  if _, ok := body.Attributes["count"]; !ok {
- candidates.List = append(candidates.List, attributeSchemaToCandidate("count", countAttributeSchema(), editRng))
+ candidates.List = append(candidates.List, attributeSchemaToCandidate(ctx, "count", countAttributeSchema(), editRng))
  }
  }
 
  if schema.Extensions.ForEach {
  // check if for_each attribute is already declared, so we don't
  // suggest a duplicate
  if _, present := body.Attributes["for_each"]; !present {
- candidates.List = append(candidates.List, attributeSchemaToCandidate("for_each", forEachAttributeSchema(), editRng))
+ candidates.List = append(candidates.List, attributeSchemaToCandidate(ctx, "for_each", forEachAttributeSchema(), editRng))
  }
  }
  }
@@ -51,15 +52,15 @@ func (d *PathDecoder) bodySchemaCandidates(body *hclsyntax.Body, schema *schema.
  return candidates
  }
 
- candidates.List = append(candidates.List, attributeSchemaToCandidate(name, attr, editRng))
+ candidates.List = append(candidates.List, attributeSchemaToCandidate(ctx, name, attr, editRng))
  count++
  }
  } else if attr := schema.AnyAttribute; attr != nil && len(prefix) == 0 {
  if uint(count) >= d.maxCandidates {
  return candidates
  }
 
- candidates.List = append(candidates.List, attributeSchemaToCandidate("name", attr, editRng))
+ candidates.List = append(candidates.List, attributeSchemaToCandidate(ctx, "name", attr, editRng))
  count++
  }
 

decoder/candidates.go

@@ -38,6 +38,8 @@ func (d *PathDecoder) CandidatesAtPos(ctx context.Context, filename string, pos
  outerBodyRng = ob.Range()
  }
 
+ ctx = schema.WithPrefillRequiredFields(ctx, d.PrefillRequiredFields)
+
  return d.candidatesAtPos(ctx, rootBody, outerBodyRng, d.pathCtx.Schema, pos)
 }
 
@@ -71,7 +73,7 @@ func (d *PathDecoder) candidatesAtPos(ctx context.Context, body *hclsyntax.Body,
  if attr.NameRange.ContainsPos(pos) {
  prefixRng := attr.NameRange
  prefixRng.End = pos
- return d.bodySchemaCandidates(body, bodySchema, prefixRng, attr.Range()), nil
+ return d.bodySchemaCandidates(ctx, body, bodySchema, prefixRng, attr.Range()), nil
  }
  if attr.EqualsRange.ContainsPos(pos) {
  return lang.ZeroCandidates(), nil
@@ -98,7 +100,7 @@ func (d *PathDecoder) candidatesAtPos(ctx context.Context, body *hclsyntax.Body,
  if block.TypeRange.ContainsPos(pos) {
  prefixRng := block.TypeRange
  prefixRng.End = pos
- return d.bodySchemaCandidates(body, bodySchema, prefixRng, block.Range()), nil
+ return d.bodySchemaCandidates(ctx, body, bodySchema, prefixRng, block.Range()), nil
  }
 
  for i, labelRange := range block.LabelRanges {
@@ -152,7 +154,7 @@ func (d *PathDecoder) candidatesAtPos(ctx context.Context, body *hclsyntax.Body,
  rng = tokenRng
  }
 
- return d.bodySchemaCandidates(body, bodySchema, rng, rng), nil
+ return d.bodySchemaCandidates(ctx, body, bodySchema, rng, rng), nil
 }
 
 func (d *PathDecoder) isPosInsideAttrExpr(attr *hclsyntax.Attribute, pos hcl.Pos) bool {

decoder/expr_list_completion.go

@@ -17,7 +17,7 @@ func (list List) CompletionAtPos(ctx context.Context, pos hcl.Pos) []lang.Candid
  label = fmt.Sprintf("[ %s ]", list.cons.Elem.FriendlyName())
  }
 
- d := list.cons.EmptyCompletionData(1, 0)
+ d := list.cons.EmptyCompletionData(ctx, 1, 0)
 
  return []lang.Candidate{
  {

decoder/expr_map_completion.go

@@ -18,7 +18,7 @@ func (m Map) CompletionAtPos(ctx context.Context, pos hcl.Pos) []lang.Candidate
  label = fmt.Sprintf(`{ "key" = %s }`, m.cons.Elem.FriendlyName())
  }
 
- cData := m.cons.EmptyCompletionData(1, 0)
+ cData := m.cons.EmptyCompletionData(ctx, 1, 0)
 
  return []lang.Candidate{
  {
@@ -62,7 +62,7 @@ func (m Map) CompletionAtPos(ctx context.Context, pos hcl.Pos) []lang.Candidate
  return []lang.Candidate{}
  }
 
- cData := m.cons.Elem.EmptyCompletionData(2, 0)
+ cData := m.cons.Elem.EmptyCompletionData(ctx, 2, 0)
  kind := lang.AttributeCandidateKind
  // TODO: replace "attribute" kind w/ Elem type
 

decoder/expr_object.go

@@ -39,33 +39,3 @@ func (obj Object) ReferenceTargets(ctx context.Context, targetCtx *TargetContext
  // TODO
  return nil
 }
-
-type ObjectAttributes struct {
- expr hcl.Expression
- cons schema.ObjectAttributes
-}
-
-func (oa ObjectAttributes) CompletionAtPos(ctx context.Context, pos hcl.Pos) []lang.Candidate {
- // TODO
- return nil
-}
-
-func (oa ObjectAttributes) HoverAtPos(ctx context.Context, pos hcl.Pos) *lang.HoverData {
- // TODO
- return nil
-}
-
-func (oa ObjectAttributes) SemanticTokens(ctx context.Context) []lang.SemanticToken {
- // TODO
- return nil
-}
-
-func (oa ObjectAttributes) ReferenceOrigins(ctx context.Context, allowSelfRefs bool) reference.Origins {
- // TODO
- return nil
-}
-
-func (oa ObjectAttributes) ReferenceTargets(ctx context.Context, targetCtx *TargetContext) reference.Targets {
- // TODO
- return nil
-}

decoder/expr_set_completion.go

@@ -17,7 +17,7 @@ func (set Set) CompletionAtPos(ctx context.Context, pos hcl.Pos) []lang.Candidat
  label = fmt.Sprintf("[ %s ]", set.cons.Elem.FriendlyName())
  }
 
- d := set.cons.EmptyCompletionData(1, 0)
+ d := set.cons.EmptyCompletionData(ctx, 1, 0)
 
  return []lang.Candidate{
  {

decoder/expr_tuple_completion.go

@@ -28,7 +28,7 @@ func (tuple Tuple) CompletionAtPos(ctx context.Context, pos hcl.Pos) []lang.Cand
  label = fmt.Sprintf("[ %s ]", elemLabel)
  }
 
- d := tuple.cons.EmptyCompletionData(1, 0)
+ d := tuple.cons.EmptyCompletionData(ctx, 1, 0)
 
  return []lang.Candidate{
  {

decoder/expression_test.go

@@ -18,7 +18,6 @@ var (
  _ Expression = LiteralType{}
  _ Expression = LiteralValue{}
  _ Expression = Map{}
- _ Expression = ObjectAttributes{}
  _ Expression = Object{}
  _ Expression = Set{}
  _ Expression = Reference{}
@@ -29,7 +28,6 @@ var (
  _ ReferenceOriginsExpression = List{}
  _ ReferenceOriginsExpression = LiteralType{}
  _ ReferenceOriginsExpression = Map{}
- _ ReferenceOriginsExpression = ObjectAttributes{}
  _ ReferenceOriginsExpression = Object{}
  _ ReferenceOriginsExpression = Set{}
  _ ReferenceOriginsExpression = Reference{}
@@ -39,7 +37,6 @@ var (
  _ ReferenceTargetsExpression = List{}
  _ ReferenceTargetsExpression = LiteralType{}
  _ ReferenceTargetsExpression = Map{}
- _ ReferenceTargetsExpression = ObjectAttributes{}
  _ ReferenceTargetsExpression = Object{}
  _ ReferenceTargetsExpression = Reference{}
  _ ReferenceTargetsExpression = Tuple{}

decoder/label_candidates.go

@@ -1,6 +1,7 @@
 package decoder
 
 import (
+ "context"
  "encoding/json"
  "fmt"
  "sort"
@@ -164,7 +165,11 @@ func requiredFieldsSnippet(bodySchema *schema.BodySchema, placeholder int, inden
 
  var snippet string
  if attr.Constraint != nil {
- snippet = attr.Constraint.EmptyCompletionData(placeholder, indentCount).Snippet
+ // We already know we want to do pre-filling at this point
+ // We could plumb through the context here, but it saves us
+ // an argument in multiple functions above.
+ ctx := schema.WithPrefillRequiredFields(context.Background(), true)
+ snippet = attr.Constraint.EmptyCompletionData(ctx, placeholder, indentCount).Snippet
  } else {
  snippet = snippetForExprContraint(uint(placeholder), attr.Expr)
  }

schema/constraint.go

@@ -1,6 +1,8 @@
 package schema
 
 import (
+ "context"
+
  "github.com/hashicorp/hcl-lang/lang"
  "github.com/zclconf/go-cty/cty"
 )
@@ -16,7 +18,7 @@ type Constraint interface {
  // there is no corresponding configuration, such as when the Constraint
  // is part of another and it is desirable to complete
  // the parent constraint as whole.
- EmptyCompletionData(nextPlaceholder int, nestingLevel int) CompletionData
+ EmptyCompletionData(ctx context.Context, nextPlaceholder int, nestingLevel int) CompletionData
 }
 
 type ConstraintWithHoverData interface {

schema/constraint_any_expression.go

@@ -1,6 +1,8 @@
 package schema
 
 import (
+ "context"
+
  "github.com/zclconf/go-cty/cty"
 )
 
@@ -28,7 +30,7 @@ func (ae AnyExpression) Copy() Constraint {
  }
 }
 
-func (ae AnyExpression) EmptyCompletionData(nextPlaceholder int, nestingLevel int) CompletionData {
+func (ae AnyExpression) EmptyCompletionData(ctx context.Context, nextPlaceholder int, nestingLevel int) CompletionData {
  // TODO
  return CompletionData{}
 }

schema/constraint_keyword.go

@@ -1,6 +1,8 @@
 package schema
 
 import (
+ "context"
+
  "github.com/hashicorp/hcl-lang/lang"
 )
 
@@ -36,7 +38,7 @@ func (k Keyword) Copy() Constraint {
  }
 }
 
-func (k Keyword) EmptyCompletionData(nextPlaceholder int, nestingLevel int) CompletionData {
+func (k Keyword) EmptyCompletionData(ctx context.Context, nextPlaceholder int, nestingLevel int) CompletionData {
  return CompletionData{
  TriggerSuggest: true,
  NextPlaceholder: nextPlaceholder,

schema/constraint_list.go

@@ -1,6 +1,7 @@
 package schema
 
 import (
+ "context"
  "fmt"
 
  "github.com/hashicorp/hcl-lang/lang"
@@ -48,7 +49,7 @@ func (l List) Copy() Constraint {
  }
 }
 
-func (l List) EmptyCompletionData(nextPlaceholder int, nestingLevel int) CompletionData {
+func (l List) EmptyCompletionData(ctx context.Context, nextPlaceholder int, nestingLevel int) CompletionData {
  if l.Elem == nil {
  return CompletionData{
  NewText: "[ ]",
@@ -57,7 +58,7 @@ func (l List) EmptyCompletionData(nextPlaceholder int, nestingLevel int) Complet
  }
  }
 
- elemData := l.Elem.EmptyCompletionData(nextPlaceholder, nestingLevel)
+ elemData := l.Elem.EmptyCompletionData(ctx, nextPlaceholder, nestingLevel)
  if elemData.NewText == "" || elemData.Snippet == "" {
  return CompletionData{
  NewText: "[ ]",

schema/constraint_literal_type.go

@@ -1,6 +1,7 @@
 package schema
 
 import (
+ "context"
  "fmt"
 
  "github.com/hashicorp/hcl-lang/lang"
@@ -36,7 +37,7 @@ func (lt LiteralType) Copy() Constraint {
  }
 }
 
-func (lt LiteralType) EmptyCompletionData(nextPlaceholder int, nestingLevel int) CompletionData {
+func (lt LiteralType) EmptyCompletionData(ctx context.Context, nextPlaceholder int, nestingLevel int) CompletionData {
  if lt.Type.IsPrimitiveType() {
  var newText, snippet string
 
@@ -69,23 +70,23 @@ func (lt LiteralType) EmptyCompletionData(nextPlaceholder int, nestingLevel int)
  Type: lt.Type.ElementType(),
  },
  }
- return listCons.EmptyCompletionData(nextPlaceholder, nestingLevel)
+ return listCons.EmptyCompletionData(ctx, nextPlaceholder, nestingLevel)
  }
  if lt.Type.IsSetType() {
  setCons := Set{
  Elem: LiteralType{
  Type: lt.Type.ElementType(),
  },
  }
- return setCons.EmptyCompletionData(nextPlaceholder, nestingLevel)
+ return setCons.EmptyCompletionData(ctx, nextPlaceholder, nestingLevel)
  }
  if lt.Type.IsMapType() {
  mapCons := Map{
  Elem: LiteralType{
  Type: lt.Type.ElementType(),
  },
  }
- return mapCons.EmptyCompletionData(nextPlaceholder, nestingLevel)
+ return mapCons.EmptyCompletionData(ctx, nextPlaceholder, nestingLevel)
  }
  if lt.Type.IsTupleType() {
  types := lt.Type.TupleElementTypes()
@@ -95,7 +96,7 @@ func (lt LiteralType) EmptyCompletionData(nextPlaceholder int, nestingLevel int)
  Type: typ,
  }
  }
- return tupleCons.EmptyCompletionData(nextPlaceholder, nestingLevel)
+ return tupleCons.EmptyCompletionData(ctx, nextPlaceholder, nestingLevel)
  }
  if lt.Type.IsObjectType() {
  attrTypes := lt.Type.AttributeTypes()
@@ -117,7 +118,7 @@ func (lt LiteralType) EmptyCompletionData(nextPlaceholder int, nestingLevel int)
  cons := Object{
  Attributes: attrs,
  }
- return cons.EmptyCompletionData(nextPlaceholder, nestingLevel)
+ return cons.EmptyCompletionData(ctx, nextPlaceholder, nestingLevel)
  }
 
  return CompletionData{