fixup parameter values to be lazy eval'd

Emyrk · Emyrk · commit 44b3cdf395ab · 2025-02-27T14:48:48.000-06:00
diff --git a/cli/clidisplay/resources.go b/cli/clidisplay/resources.go
@@ -57,7 +57,7 @@ func Parameters(writer io.Writer, params []types.Parameter) {
 	row := table.Row{"Parameter"}
 	tableWriter.AppendHeader(row)
 	for _, p := range params {
-		strVal := p.Value.Value
+		strVal := p.Value.AsString()
 		//value := p.Value.Value
 		//
 		//if value.IsNull() {
@@ -71,7 +71,7 @@ func Parameters(writer io.Writer, params []types.Parameter) {
 		//}
 
 		tableWriter.AppendRow(table.Row{
-			fmt.Sprintf("%s (%s): %s\n%s", p.Name, p.BlockName, p.Description, formatOptions(strVal, p.Options)),
+			fmt.Sprintf("%s: %s\n%s", p.Name, p.Description, formatOptions(strVal, p.Options)),
 		})
 		tableWriter.AppendSeparator()
 	}
diff --git a/cli/root.go b/cli/root.go
@@ -10,7 +10,6 @@ import (
 
 	"github.com/coder/preview"
 	"github.com/coder/preview/cli/clidisplay"
-	"github.com/coder/preview/types"
 	"github.com/coder/serpent"
 )
 
@@ -56,15 +55,13 @@ func (r *RootCmd) Root() *serpent.Command {
 		Handler: func(i *serpent.Invocation) error {
 			dfs := os.DirFS(dir)
 
-			rvars := make(map[string]types.ParameterValue)
+			rvars := make(map[string]string)
 			for _, val := range vars {
 				parts := strings.Split(val, "=")
 				if len(parts) != 2 {
 					continue
 				}
-				rvars[parts[0]] = types.ParameterValue{
-					Value: parts[1],
-				}
+				rvars[parts[0]] = parts[1]
 			}
 
 			input := preview.Input{
diff --git a/extract/parameter.go b/extract/parameter.go
@@ -12,10 +12,10 @@ import (
 	"github.com/coder/preview/types"
 )
 
-func ParameterFromBlock(block *terraform.Block) (types.Parameter, hcl.Diagnostics) {
+func ParameterFromBlock(block *terraform.Block) (*types.Parameter, hcl.Diagnostics) {
 	diags := required(block, "name", "type")
 	if diags.HasErrors() {
-		return types.Parameter{}, diags
+		return nil, diags
 	}
 
 	pType, typDiag := requiredString("type", block)
@@ -28,17 +28,13 @@ func ParameterFromBlock(block *terraform.Block) (types.Parameter, hcl.Diagnostic
 		diags = diags.Append(nameDiag)
 	}
 
-	pVal, valDiags := richParameterValue(block)
-	diags = diags.Extend(valDiags)
-
 	if diags.HasErrors() {
-		return types.Parameter{}, diags
+		return nil, diags
 	}
 
+	pVal := richParameterValue(block)
 	p := types.Parameter{
-		Value: types.ParameterValue{
-			Value: pVal,
-		},
+		Value: pVal,
 		RichParameter: types.RichParameter{
 			Name:        pName,
 			Description: optionalString(block, "description"),
@@ -54,7 +50,6 @@ func ParameterFromBlock(block *terraform.Block) (types.Parameter, hcl.Diagnostic
 			DisplayName:  optionalString(block, "display_name"),
 			Order:        optionalInteger(block, "order"),
 			Ephemeral:    optionalBoolean(block, "ephemeral"),
-			BlockName:    block.NameLabel(),
 		},
 	}
 
@@ -80,7 +75,10 @@ func ParameterFromBlock(block *terraform.Block) (types.Parameter, hcl.Diagnostic
 		p.Validations = append(p.Validations, &valid)
 	}
 
-	return p, diags
+	// Diagnostics are scoped to the parameter
+	p.Diagnostics = diags
+
+	return &p, nil
 }
 
 func ParameterValidationFromBlock(block *terraform.Block) (types.ParameterValidation, hcl.Diagnostics) {
@@ -243,25 +241,19 @@ func required(block *terraform.Block, keys ...string) hcl.Diagnostics {
 	return diags
 }
 
-func richParameterValue(block *terraform.Block) (string, hcl.Diagnostics) {
+func richParameterValue(block *terraform.Block) types.HCLString {
 	// Find the value of the parameter from the context.
 	paramPath := append([]string{"data"}, block.Labels()...)
+	path := strings.Join(paramPath, ".")
+
 	valueRef := hclext.ScopeTraversalExpr(append(paramPath, "value")...)
 	val, diags := valueRef.Value(block.Context().Inner())
-	if diags.HasErrors() {
-		return "", diags
-	}
-
-	if !val.Type().Equals(cty.String) {
-		return "", hcl.Diagnostics{
-			{
-				Severity: hcl.DiagError,
-				Summary:  "Invalid parameter value",
-				Detail:   fmt.Sprintf("Expected a string, got %q", val.Type().FriendlyName()),
-			},
-		}
+	return types.HCLString{
+		Value:      val,
+		ValueDiags: diags,
+		ValueExpr:  &valueRef,
+		Source:     &path,
 	}
-	return val.AsString(), nil
 }
 
 func ParameterCtyType(typ string) (cty.Type, error) {
diff --git a/extract/state.go b/extract/state.go
@@ -52,9 +52,7 @@ func ParameterFromState(block *tfjson.StateResource) (types.Parameter, error) {
 	}
 
 	param := types.Parameter{
-		Value: types.ParameterValue{
-			Value: st.string("value"),
-		},
+		Value: types.StringLiteral(st.string("value")),
 		RichParameter: types.RichParameter{
 			Name:         st.string("name"),
 			Description:  st.optionalString("description"),
@@ -68,7 +66,6 @@ func ParameterFromState(block *tfjson.StateResource) (types.Parameter, error) {
 			DisplayName:  st.optionalString("display_name"),
 			Order:        st.optionalInteger("order"),
 			Ephemeral:    st.optionalBool("ephemeral"),
-			BlockName:    block.Name,
 		},
 	}
 
diff --git a/internal/verify/cmp.go b/internal/verify/cmp.go
@@ -35,7 +35,7 @@ func CompareParameters(t *testing.T, pr *preview.Output, values *tfjson.StateMod
 	types.SortParameters(pr.Parameters)
 	for i, param := range stateParams {
 		// TODO: A better compare function would be easier to debug
-		assert.Equal(t, param, pr.Parameters[i], "parameter %q %d", param.BlockName, i)
+		assert.Equal(t, param, pr.Parameters[i], "parameter %q %d", param.Name, i)
 	}
 
 	return passed
diff --git a/parameter.go b/parameter.go
@@ -20,8 +20,8 @@ func RichParameters(modules terraform.Modules) ([]types.Parameter, hcl.Diagnosti
 				diags = diags.Extend(pDiags)
 			}
 
-			if !pDiags.HasErrors() {
-				params = append(params, param)
+			if param != nil {
+				params = append(params, *param)
 			}
 		}
 	}
diff --git a/paramhook.go b/paramhook.go
@@ -30,7 +30,7 @@ func ParameterContextsEvalHook(input Input) func(ctx *tfcontext.Context, blocks
 			pv, ok := input.RichParameterValue(name)
 			if ok {
 				// TODO: Handle non-string types
-				value = cty.StringVal(pv.Value)
+				value = cty.StringVal(pv)
 			} else {
 				// get the default value
 				// TODO: Log any diags
diff --git a/preview.go b/preview.go
@@ -14,7 +14,7 @@ import (
 
 type Input struct {
 	PlanJSONPath    string
-	ParameterValues map[string]types.ParameterValue
+	ParameterValues map[string]string
 }
 
 type Output struct {
@@ -88,7 +88,7 @@ func Preview(ctx context.Context, input Input, dir fs.FS) (*Output, hcl.Diagnost
 	}, diags.Extend(rpDiags).Extend(tagDiags)
 }
 
-func (i Input) RichParameterValue(key string) (types.ParameterValue, bool) {
+func (i Input) RichParameterValue(key string) (string, bool) {
 	p, ok := i.ParameterValues[key]
 	return p, ok
 }
diff --git a/preview_test.go b/preview_test.go
@@ -65,10 +65,8 @@ func Test_Extract(t *testing.T) {
 			name: "conditional",
 			dir:  "conditional",
 			input: preview.Input{
-				ParameterValues: map[string]types.ParameterValue{
-					"project": {
-						Value: "small",
-					},
+				ParameterValues: map[string]string{
+					"project": "small",
 				},
 			},
 			expTags:     map[string]string{},
@@ -85,10 +83,8 @@ func Test_Extract(t *testing.T) {
 				"zone": "eu",
 			},
 			input: preview.Input{
-				ParameterValues: map[string]types.ParameterValue{
-					"region": {
-						Value: "eu",
-					},
+				ParameterValues: map[string]string{
+					"region": "eu",
 				},
 			},
 			expUnknowns: []string{},
@@ -103,10 +99,8 @@ func Test_Extract(t *testing.T) {
 				"zone": "eu",
 			},
 			input: preview.Input{
-				ParameterValues: map[string]types.ParameterValue{
-					"region": {
-						Value: "eu",
-					},
+				ParameterValues: map[string]string{
+					"region": "eu",
 				},
 			},
 			expUnknowns: []string{},
@@ -158,7 +152,7 @@ func Test_Extract(t *testing.T) {
 			expTags: map[string]string{},
 			input: preview.Input{
 				PlanJSONPath:    "before.json",
-				ParameterValues: map[string]types.ParameterValue{},
+				ParameterValues: map[string]string{},
 			},
 			expUnknowns: []string{},
 			params:      map[string]func(t *testing.T, parameter types.Parameter){},
@@ -168,7 +162,7 @@ func Test_Extract(t *testing.T) {
 			dir:     "nulldefault",
 			expTags: map[string]string{},
 			input: preview.Input{
-				ParameterValues: map[string]types.ParameterValue{},
+				ParameterValues: map[string]string{},
 			},
 			expUnknowns: []string{},
 			params:      map[string]func(t *testing.T, parameter types.Parameter){},
@@ -178,7 +172,7 @@ func Test_Extract(t *testing.T) {
 			dir:     "manymodules",
 			expTags: map[string]string{},
 			input: preview.Input{
-				ParameterValues: map[string]types.ParameterValue{},
+				ParameterValues: map[string]string{},
 				PlanJSONPath:    "out.json",
 			},
 			expUnknowns: []string{},
@@ -189,7 +183,7 @@ func Test_Extract(t *testing.T) {
 			dir:     "dupemodparams",
 			expTags: map[string]string{},
 			input: preview.Input{
-				ParameterValues: map[string]types.ParameterValue{},
+				ParameterValues: map[string]string{},
 			},
 			expUnknowns: []string{},
 			params:      map[string]func(t *testing.T, parameter types.Parameter){},
diff --git a/previewe2e_test.go b/previewe2e_test.go
@@ -14,7 +14,6 @@ import (
 
 	"github.com/coder/preview"
 	"github.com/coder/preview/internal/verify"
-	"github.com/coder/preview/types"
 )
 
 // Test_VerifyE2E will fully evaluate with `terraform apply`
@@ -137,7 +136,7 @@ func Test_VerifyE2E(t *testing.T) {
 					output, diags := preview.Preview(context.Background(),
 						preview.Input{
 							PlanJSONPath:    "plan.json",
-							ParameterValues: map[string]types.ParameterValue{},
+							ParameterValues: map[string]string{},
 						},
 						os.DirFS(wp))
 					if diags.HasErrors() {
diff --git a/types/parameter.go b/types/parameter.go
@@ -7,6 +7,7 @@ import (
 	"slices"
 	"strings"
 
+	"github.com/hashicorp/hcl/v2"
 	"github.com/zclconf/go-cty/cty"
 )
 
@@ -22,27 +23,25 @@ func SortParameters(lists []Parameter) {
 			return order
 		}
 
-		if a.BlockName != b.BlockName {
-			return strings.Compare(a.BlockName, b.BlockName)
-		}
-
 		return strings.Compare(a.Name, b.Name)
 	})
 }
 
 type Parameter struct {
-	// TODO: Might be value in a "Lazy" parameter
-	Value ParameterValue
 	RichParameter
-}
+	// Value is not immediately cast into a string.
+	// Value is not required at template import, so defer
+	// casting to a string until it is absolutely necessary.
+	Value HCLString `json:"value"`
 
-type ParameterValue struct {
-	// Value must be string due to the terraform type constraints
-	Value string `json:"value"`
+	// Diagnostics is used to store any errors that occur during parsing
+	// of the parameter.
+	Diagnostics hcl.Diagnostics `json:"-" hcl:"-"`
 }
 
 type RichParameter struct {
 	Name         string                 `json:"name"`
+	DisplayName  string                 `json:"display_name"`
 	Description  string                 `json:"description"`
 	Type         string                 `json:"type"`
 	Mutable      bool                   `json:"mutable"`
@@ -52,12 +51,8 @@ type RichParameter struct {
 	Validations  []*ParameterValidation `json:"validations"`
 	Required     bool                   `json:"required"`
 	// legacy_variable_name was removed (= 14)
-	DisplayName string `json:"display_name"`
-	Order       int64  `json:"order"`
-	Ephemeral   bool   `json:"ephemeral"`
-
-	// HCL props
-	BlockName string `json:"block_name"`
+	Order     int64 `json:"order"`
+	Ephemeral bool  `json:"ephemeral"`
 }
 
 type ParameterValidation struct {
@@ -69,10 +64,10 @@ type ParameterValidation struct {
 }
 
 type ParameterOption struct {
-	Name        string `json:"name" hcl:"name,attr"`
-	Description string `json:"description" hcl:"description,attr"`
-	Value       string `json:"value" hcl:"value,attr"`
-	Icon        string `json:"icon" hcl:"icon,attr"`
+	Name        string `json:"name"`
+	Description string `json:"description"`
+	Value       string `json:"value"`
+	Icon        string `json:"icon"`
 }
 
 // Hash can be used to compare two RichParameter objects at a glance.
diff --git a/types/value.go b/types/value.go
@@ -2,6 +2,7 @@ package types
 
 import (
 	"github.com/hashicorp/hcl/v2"
+	"github.com/hashicorp/hcl/v2/hclsyntax"
 	"github.com/zclconf/go-cty/cty"
 )
 
@@ -18,6 +19,14 @@ type HCLString struct {
 	Source *string
 }
 
+func StringLiteral(s string) HCLString {
+	v := cty.StringVal(s)
+	return HCLString{
+		Value:     v,
+		ValueExpr: &hclsyntax.LiteralValueExpr{Val: v},
+	}
+}
+
 // AsString is a safe function. It will always return a string.
 // The caller should check if this value is Valid and known before
 // calling this function.
diff --git a/web/session.go b/web/session.go

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ func CompareParameters(t testing.T, pr preview.Output, values *tfjson.StateMod`
`35`	`35`	`types.SortParameters(pr.Parameters)`
`36`	`36`	`for i, param := range stateParams {`
`37`	`37`	`// TODO: A better compare function would be easier to debug`
`38`		`- assert.Equal(t, param, pr.Parameters[i], "parameter %q %d", param.BlockName, i)`
	`38`	`+ assert.Equal(t, param, pr.Parameters[i], "parameter %q %d", param.Name, i)`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`return passed`
Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,8 @@ func RichParameters(modules terraform.Modules) ([]types.Parameter, hcl.Diagnosti`
`20`	`20`	`diags = diags.Extend(pDiags)`
`21`	`21`	`}`
`22`	`22`
`23`		`- if !pDiags.HasErrors() {`
`24`		`- params = append(params, param)`
	`23`	`+ if param != nil {`
	`24`	`+ params = append(params, *param)`
`25`	`25`	`}`
`26`	`26`	`}`
`27`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ import (`
`14`	`14`
`15`	`15`	`type Input struct {`
`16`	`16`	`PlanJSONPath string`
`17`		`- ParameterValues map[string]types.ParameterValue`
	`17`	`+ ParameterValues map[string]string`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`type Output struct {`
`@@ -88,7 +88,7 @@ func Preview(ctx context.Context, input Input, dir fs.FS) (*Output, hcl.Diagnost`
`88`	`88`	`}, diags.Extend(rpDiags).Extend(tagDiags)`
`89`	`89`	`}`
`90`	`90`
`91`		`-func (i Input) RichParameterValue(key string) (types.ParameterValue, bool) {`
	`91`	`+func (i Input) RichParameterValue(key string) (string, bool) {`
`92`	`92`	`p, ok := i.ParameterValues[key]`
`93`	`93`	`return p, ok`
`94`	`94`	`}`