ref(provider/util): support storing any json marshallable value in provider private data

Author: cysp

internal/provider/content_type_resource.go

@@ -117,7 +117,7 @@ func (r *contentTypeResource) Create(ctx context.Context, req resource.CreateReq
 		return
 	}
 
-	resp.Diagnostics.Append(util.PrivateDataSetInt(ctx, resp.Private, "version", currentVersion)...)
+	resp.Diagnostics.Append(util.PrivateDataSetValue(ctx, resp.Private, "version", currentVersion)...)
 	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
 }
 
@@ -168,7 +168,7 @@ func (r *contentTypeResource) Read(ctx context.Context, req resource.ReadRequest
 		return
 	}
 
-	resp.Diagnostics.Append(util.PrivateDataSetInt(ctx, resp.Private, "version", currentVersion)...)
+	resp.Diagnostics.Append(util.PrivateDataSetValue(ctx, resp.Private, "version", currentVersion)...)
 	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
 }
 
@@ -181,7 +181,8 @@ func (r *contentTypeResource) Update(ctx context.Context, req resource.UpdateReq
 		return
 	}
 
-	currentVersion, currentVersionDiags := util.PrivateDataGetInt(ctx, req.Private, "version")
+	var currentVersion int
+	currentVersionDiags := util.PrivateDataGetValue(ctx, req.Private, "version", &currentVersion)
 	resp.Diagnostics.Append(currentVersionDiags...)
 
 	putContentTypeParams := contentfulManagement.PutContentTypeParams{
@@ -247,7 +248,7 @@ func (r *contentTypeResource) Update(ctx context.Context, req resource.UpdateReq
 		return
 	}
 
-	resp.Diagnostics.Append(util.PrivateDataSetInt(ctx, resp.Private, "version", currentVersion)...)
+	resp.Diagnostics.Append(util.PrivateDataSetValue(ctx, resp.Private, "version", currentVersion)...)
 	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
 }
 

internal/provider/editor_interface_resource.go

@@ -90,7 +90,7 @@ func (r *editorInterfaceResource) Create(ctx context.Context, req resource.Creat
 		return
 	}
 
-	resp.Diagnostics.Append(util.PrivateDataSetInt(ctx, resp.Private, "version", currentVersion)...)
+	resp.Diagnostics.Append(util.PrivateDataSetValue(ctx, resp.Private, "version", currentVersion)...)
 	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
 }
 
@@ -141,7 +141,7 @@ func (r *editorInterfaceResource) Read(ctx context.Context, req resource.ReadReq
 		return
 	}
 
-	resp.Diagnostics.Append(util.PrivateDataSetInt(ctx, resp.Private, "version", currentVersion)...)
+	resp.Diagnostics.Append(util.PrivateDataSetValue(ctx, resp.Private, "version", currentVersion)...)
 	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
 }
 
@@ -154,7 +154,8 @@ func (r *editorInterfaceResource) Update(ctx context.Context, req resource.Updat
 		return
 	}
 
-	currentVersion, currentVersionDiags := util.PrivateDataGetInt(ctx, req.Private, "version")
+	var currentVersion int
+	currentVersionDiags := util.PrivateDataGetValue(ctx, req.Private, "version", &currentVersion)
 	resp.Diagnostics.Append(currentVersionDiags...)
 
 	params := contentfulManagement.PutEditorInterfaceParams{
@@ -193,7 +194,7 @@ func (r *editorInterfaceResource) Update(ctx context.Context, req resource.Updat
 		return
 	}
 
-	resp.Diagnostics.Append(util.PrivateDataSetInt(ctx, resp.Private, "version", currentVersion)...)
+	resp.Diagnostics.Append(util.PrivateDataSetValue(ctx, resp.Private, "version", currentVersion)...)
 	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
 }
 

internal/provider/util/provider_private_data.go

@@ -2,8 +2,8 @@ package util
 
 import (
 	"context"
+	"encoding/json"
 
-	"github.com/go-faster/jx"
 	"github.com/hashicorp/terraform-plugin-framework/diag"
 )
 
@@ -12,30 +12,35 @@ type ProviderPrivateData interface {
 	SetKey(ctx context.Context, key string, value []byte) diag.Diagnostics
 }
 
-func PrivateDataSetInt(ctx context.Context, providerData ProviderPrivateData, key string, value int) diag.Diagnostics {
-	encoder := jx.Encoder{}
-	encoder.Int(value)
-	valueBytes := encoder.Bytes()
+func PrivateDataSetValue[T interface{}](ctx context.Context, providerData ProviderPrivateData, key string, value T) diag.Diagnostics {
+	diags := diag.Diagnostics{}
+
+	valueBytes, err := json.Marshal(value)
+	if err != nil {
+		diags.AddError("Failed to marshal value", err.Error())
+	}
+
+	if diags.HasError() {
+		return diags
+	}
 
 	return providerData.SetKey(ctx, key, valueBytes)
 }
 
-func PrivateDataGetInt(ctx context.Context, providerData ProviderPrivateData, key string) (int, diag.Diagnostics) {
+func PrivateDataGetValue[T interface{}](ctx context.Context, providerData ProviderPrivateData, key string, value *T) diag.Diagnostics {
 	diags := diag.Diagnostics{}
 
 	valueBytes, getDiags := providerData.GetKey(ctx, key)
 	diags.Append(getDiags...)
 
 	if diags.HasError() {
-		return 0, diags
+		return diags
 	}
 
-	decoder := jx.DecodeBytes(valueBytes)
-
-	value, err := decoder.Int()
+	err := json.Unmarshal(valueBytes, value)
 	if err != nil {
-		diags.AddError("Failed to decode int", err.Error())
+		diags.AddError("Failed to unmarshal value", err.Error())
 	}
 
-	return value, diags
+	return diags
 }

internal/provider/util/provider_private_data_test.go

@@ -2,6 +2,7 @@ package util_test
 
 import (
 	"context"
+	"math"
 	"testing"
 
 	"github.com/cysp/terraform-provider-contentful/internal/provider/util"
@@ -47,7 +48,8 @@ func TestPrivateDataGetIntNotSet(t *testing.T) {
 
 	privateData := newProviderPrivateData()
 
-	value, diags := util.PrivateDataGetInt(ctx, privateData, "key")
+	var value int
+	diags := util.PrivateDataGetValue(ctx, privateData, "key", &value)
 
 	assert.EqualValues(t, 0, value)
 	assert.NotEmpty(t, diags)
@@ -60,12 +62,13 @@ func TestPrivateDataGetSetInt(t *testing.T) {
 
 	privateData := newProviderPrivateData()
 
-	diags := util.PrivateDataSetInt(ctx, privateData, "key", 42)
+	diags := util.PrivateDataSetValue(ctx, privateData, "key", 42)
 
 	assert.EqualValues(t, []byte{'4', '2'}, privateData.data["key"])
 	assert.Empty(t, diags)
 
-	value, diags := util.PrivateDataGetInt(ctx, privateData, "key")
+	var value int
+	diags = util.PrivateDataGetValue(ctx, privateData, "key", &value)
 
 	assert.EqualValues(t, 42, value)
 	assert.Empty(t, diags)
@@ -79,8 +82,21 @@ func TestPrivateDataGetIntInvalid(t *testing.T) {
 	privateData := newProviderPrivateData()
 	privateData.data["key"] = []byte("invalid")
 
-	value, diags := util.PrivateDataGetInt(ctx, privateData, "key")
+	var value int
+	diags := util.PrivateDataGetValue(ctx, privateData, "key", &value)
 
 	assert.EqualValues(t, 0, value)
 	assert.NotEmpty(t, diags)
 }
+
+func TestPrivateDataSetInf(t *testing.T) {
+	t.Parallel()
+
+	ctx := context.Background()
+
+	privateData := newProviderPrivateData()
+
+	diags := util.PrivateDataSetValue(ctx, privateData, "key", math.Inf(1))
+
+	assert.NotEmpty(t, diags)
+}