Support arbitrary nested values for edge_config_item (#390)

Author: dglsparsons

client/edge_config_item.go

@@ -2,29 +2,33 @@ package client
 
 import (
 	"context"
+	"encoding/json"
 	"fmt"
 
 	"github.com/hashicorp/terraform-plugin-log/tflog"
 )
 
 type EdgeConfigOperation struct {
-	Operation string `json:"operation"`
-	Key       string `json:"key"`
-	Value     string `json:"value"`
+	Operation string          `json:"operation"`
+	Key       string          `json:"key"`
+	Value     json.RawMessage `json:"value,omitempty"`
 }
 
 type EdgeConfigItem struct {
-	TeamID       string
-	Key          string `json:"key"`
-	Value        string `json:"value"`
-	EdgeConfigID string `json:"edgeConfigId"`
+	TeamID       string          `json:"-"`
+	Key          string          `json:"key"`
+	Value        json.RawMessage `json:"value"`
+	EdgeConfigID string          `json:"edgeConfigId"`
 }
 
 type CreateEdgeConfigItemRequest struct {
 	EdgeConfigID string
 	TeamID       string
 	Key          string
-	Value        string
+	// Value should be a valid JSON encoding of the item value. For strings,
+	// include quotes (e.g. "\"hello\""). For objects/arrays/numbers/bools/null,
+	// provide the raw JSON representation.
+	Value json.RawMessage
 }
 
 func (c *Client) CreateEdgeConfigItem(ctx context.Context, request CreateEdgeConfigItemRequest) (e EdgeConfigItem, err error) {
@@ -70,7 +74,6 @@ type EdgeConfigItemRequest struct {
 	EdgeConfigID string
 	TeamID       string
 	Key          string
-	Value        string
 }
 
 func (c *Client) DeleteEdgeConfigItem(ctx context.Context, request EdgeConfigItemRequest) error {
@@ -87,7 +90,6 @@ func (c *Client) DeleteEdgeConfigItem(ctx context.Context, request EdgeConfigIte
 				{
 					Operation: "delete",
 					Key:       request.Key,
-					Value:     request.Value,
 				},
 			},
 		},

docs/data-sources/edge_config_item.md

@@ -23,10 +23,17 @@ data "vercel_edge_config" "example" {
   id = "ecfg_xxxxxxxxxxxxxxxxxxxxxxxxxxxx"
 }
 
-data "vercel_edge_config_item" "test" {
+# Read a string item
+data "vercel_edge_config_item" "string_item" {
   id  = data.vercel_edge_config.example.id
   key = "foobar"
 }
+
+# Read a JSON item
+data "vercel_edge_config_item" "json_item" {
+  id  = data.vercel_edge_config.example.id
+  key = "flags"
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
@@ -43,4 +50,5 @@ data "vercel_edge_config_item" "test" {
 
 ### Read-Only
 
-- `value` (String) The value assigned to the key.
+- `value` (String) The value assigned to the key (only set for string values).
+- `value_json` (Dynamic) Structured JSON value (object/array/number/bool/null) assigned to the key.

docs/resources/edge_config_item.md

@@ -25,8 +25,11 @@ resource "vercel_edge_config" "example" {
 
 resource "vercel_edge_config_item" "example" {
   edge_config_id = vercel_edge_config.example.id
-  key            = "foobar"
-  value          = "baz"
+  key            = "flags"
+  value_json     = {
+    featureA = true
+    nested   = { a = 1, b = [1, 2, 3] }
+  }
 }
 ```
 
@@ -37,11 +40,12 @@ resource "vercel_edge_config_item" "example" {
 
 - `edge_config_id` (String) The ID of the Edge Config store.
 - `key` (String) The name of the key you want to add to or update within your Edge Config.
-- `value` (String) The value you want to assign to the key.
 
 ### Optional
 
 - `team_id` (String) The ID of the team the Edge Config should exist under. Required when configuring a team resource if a default team has not been set in the provider.
+- `value` (String) The value you want to assign to the key when using a string.
+- `value_json` (Dynamic) Structured JSON value to assign to the key (object/array/number/bool/null).
 
 ## Import
 

examples/data-sources/vercel_edge_config_item/data-source.tf

@@ -2,7 +2,14 @@ data "vercel_edge_config" "example" {
   id = "ecfg_xxxxxxxxxxxxxxxxxxxxxxxxxxxx"
 }
 
-data "vercel_edge_config_item" "test" {
+# Read a string item
+data "vercel_edge_config_item" "string_item" {
   id  = data.vercel_edge_config.example.id
   key = "foobar"
 }
+
+# Read a JSON item
+data "vercel_edge_config_item" "json_item" {
+  id  = data.vercel_edge_config.example.id
+  key = "flags"
+}

examples/resources/vercel_edge_config_item/resource.tf

@@ -4,6 +4,9 @@ resource "vercel_edge_config" "example" {
 
 resource "vercel_edge_config_item" "example" {
   edge_config_id = vercel_edge_config.example.id
-  key            = "foobar"
-  value          = "baz"
+  key            = "flags"
+  value_json     = {
+    featureA = true
+    nested   = { a = 1, b = [1, 2, 3] }
+  }
 }

vercel/data_source_edge_config_item.go

@@ -2,11 +2,13 @@ package vercel
 
 import (
 	"context"
+	"encoding/json"
 	"fmt"
 
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
 	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/hashicorp/terraform-plugin-go/tftypes"
 	"github.com/hashicorp/terraform-plugin-log/tflog"
 	"github.com/vercel/terraform-provider-vercel/v3/client"
 )
@@ -71,18 +73,23 @@ An Edge Config Item is a value within an Edge Config.`,
 				Required:    true,
 			},
 			"value": schema.StringAttribute{
-				Description: "The value assigned to the key.",
+				Description: "The value assigned to the key (only set for string values).",
+				Computed:    true,
+			},
+			"value_json": schema.DynamicAttribute{
+				Description: "Structured JSON value (object/array/number/bool/null) assigned to the key.",
 				Computed:    true,
 			},
 		},
 	}
 }
 
 type EdgeConfigItemDataSource struct {
-	EdgeConfigID types.String `tfsdk:"id"`
-	TeamID       types.String `tfsdk:"team_id"`
-	Key          types.String `tfsdk:"key"`
-	Value        types.String `tfsdk:"value"`
+	EdgeConfigID types.String  `tfsdk:"id"`
+	TeamID       types.String  `tfsdk:"team_id"`
+	Key          types.String  `tfsdk:"key"`
+	Value        types.String  `tfsdk:"value"`
+	ValueJSON    types.Dynamic `tfsdk:"value_json"`
 }
 
 // Read will read the edgeConfigItem information by requesting it from the Vercel API, and will update terraform
@@ -113,14 +120,39 @@ func (d *edgeConfigItemDataSource) Read(ctx context.Context, req datasource.Read
 		return
 	}
 
-	result := responseToEdgeConfigItem(out)
+	// Parse API value
+	var result EdgeConfigItemDataSource
+	result.EdgeConfigID = types.StringValue(out.EdgeConfigID)
+	result.TeamID = types.StringValue(out.TeamID)
+	result.Key = types.StringValue(out.Key)
+	if len(out.Value) > 0 {
+		var sv string
+		if err := json.Unmarshal(out.Value, &sv); err == nil {
+			result.Value = types.StringValue(sv)
+			result.ValueJSON = types.DynamicNull()
+		} else {
+			tfval, err := tftypes.ValueFromJSONWithOpts(out.Value, tftypes.DynamicPseudoType, tftypes.ValueFromJSONOpts{IgnoreUndefinedAttributes: true})
+			if err != nil {
+				resp.Diagnostics.AddError("Error parsing Edge Config Item value", err.Error())
+				return
+			}
+			av, err := types.DynamicType.ValueFromTerraform(ctx, tfval)
+			if err != nil {
+				resp.Diagnostics.AddError("Error converting Edge Config Item value", err.Error())
+				return
+			}
+			result.Value = types.StringNull()
+			result.ValueJSON = av.(types.Dynamic)
+		}
+	}
+
 	tflog.Info(ctx, "read edge config item", map[string]any{
 		"edge_config_id": result.EdgeConfigID.ValueString(),
 		"team_id":        result.TeamID.ValueString(),
 		"key":            result.Key.ValueString(),
 	})
 
-	diags = resp.State.Set(ctx, EdgeConfigItemDataSource(result))
+	diags = resp.State.Set(ctx, result)
 	resp.Diagnostics.Append(diags...)
 	if resp.Diagnostics.HasError() {
 		return

vercel/data_source_project_deployment_retention_test.go

@@ -25,10 +25,10 @@ func TestAcc_ProjectDeploymentRetentionDataSource(t *testing.T) {
 					resource.TestCheckResourceAttr("data.vercel_project_deployment_retention.example", "expiration_canceled", "unlimited"),
 					resource.TestCheckResourceAttr("data.vercel_project_deployment_retention.example", "expiration_errored", "unlimited"),
 
-					resource.TestCheckResourceAttr("data.vercel_project_deployment_retention.example_2", "expiration_preview", "unlimited"),
-					resource.TestCheckResourceAttr("data.vercel_project_deployment_retention.example_2", "expiration_production", "unlimited"),
-					resource.TestCheckResourceAttr("data.vercel_project_deployment_retention.example_2", "expiration_canceled", "unlimited"),
-					resource.TestCheckResourceAttr("data.vercel_project_deployment_retention.example_2", "expiration_errored", "unlimited"),
+					resource.TestCheckResourceAttrSet("data.vercel_project_deployment_retention.example_2", "expiration_preview"),
+					resource.TestCheckResourceAttrSet("data.vercel_project_deployment_retention.example_2", "expiration_production"),
+					resource.TestCheckResourceAttrSet("data.vercel_project_deployment_retention.example_2", "expiration_canceled"),
+					resource.TestCheckResourceAttrSet("data.vercel_project_deployment_retention.example_2", "expiration_errored"),
 				),
 			},
 		},