Merge pull request #5901 from zakcutner/apijson

feat(apijson): add `decode_null_to_zero` tag option

Author: musa-cf

internal/apijsoncustom/decoder.go

@@ -0,0 +1,27 @@
+package apijsoncustom
+
+import (
+	"reflect"
+
+	"github.com/tidwall/gjson"
+)
+
+type UnionVariant struct {
+	TypeFilter         gjson.Type
+	DiscriminatorValue interface{}
+	Type               reflect.Type
+}
+
+var unionRegistry = map[reflect.Type]unionEntry{}
+
+type unionEntry struct {
+	discriminatorKey string
+	variants         []UnionVariant
+}
+
+func RegisterUnion(typ reflect.Type, discriminator string, variants ...UnionVariant) {
+	unionRegistry[typ] = unionEntry{
+		discriminatorKey: discriminator,
+		variants:         variants,
+	}
+}

internal/apijsoncustom/encoder.go

@@ -0,0 +1,82 @@
+package apijsoncustom
+
+import (
+	"reflect"
+	"strings"
+)
+
+const jsonStructTag = "json"
+const formatStructTag = "format"
+
+type parsedStructTag struct {
+	name              string
+	extras            bool
+	metadata          bool
+	inline            bool
+	required          bool
+	optional          bool
+	computed          bool
+	computed_optional bool
+	noRefresh         bool
+	// Don't skip this value, even if it's computed (no-op for computed optional fields)
+	// If encodeStateForUnknown is set on a computed field, this flag should also be set;
+	// otherwise this flag will have no effect
+	// NOTE: won't work if update behavior is 'patch'
+	forceEncode bool
+	// If the value in the plan is unknown,
+	// encode the value from the state instead
+	// This is similar to the UseStateForUnknown plan modifier,
+	// but it only impacts serialization of request bodies, not planning.
+	// NOTE #1: only use this for computed/computed_optional values that may be changed by the server;
+	// otherwise just use the UseStateForUnknown plan modifier
+	// NOTE #2: won't work if update behavior is 'patch'
+	encodeStateValueWhenPlanUnknown bool
+	// decodeZeroValueWhenNull indicates whether null and omitted values should
+	// be decoded as the zero value of the field type instead of leaving the
+	// field unset.
+	decodeZeroValueWhenNull bool
+}
+
+func parseJSONStructTag(field reflect.StructField) (tag parsedStructTag, ok bool) {
+	raw, ok := field.Tag.Lookup(jsonStructTag)
+	if !ok {
+		return
+	}
+	parts := strings.Split(raw, ",")
+	if len(parts) == 0 {
+		return tag, false
+	}
+	tag.name = parts[0]
+	for _, part := range parts[1:] {
+		switch part {
+		case "extras":
+			tag.extras = true
+		case "metadata":
+			tag.metadata = true
+		case "inline":
+			tag.inline = true
+		case "required":
+			tag.required = true
+		case "optional":
+			tag.optional = true
+		case "computed":
+			tag.computed = true
+		case "computed_optional":
+			tag.computed_optional = true
+		case "no_refresh":
+			tag.noRefresh = true
+		case "encode_state_for_unknown":
+			tag.encodeStateValueWhenPlanUnknown = true
+		case "decode_null_to_zero":
+			tag.decodeZeroValueWhenNull = true
+		case "force_encode":
+			tag.forceEncode = true
+		}
+	}
+	return
+}
+
+func parseFormatStructTag(field reflect.StructField) (format string, ok bool) {
+	format, ok = field.Tag.Lookup(formatStructTag)
+	return
+}

internal/apijsoncustom/json_test.go

@@ -10,7 +10,7 @@ import (
 
 	"github.com/cloudflare/cloudflare-go/v5"
 	"github.com/cloudflare/cloudflare-go/v5/option"
-	"github.com/cloudflare/terraform-provider-cloudflare/internal/apijson"
+	"github.com/cloudflare/terraform-provider-cloudflare/internal/apijsoncustom"
 	"github.com/cloudflare/terraform-provider-cloudflare/internal/logging"
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
 )
@@ -77,7 +77,7 @@ func (d *RulesetDataSource) Read(ctx context.Context, req datasource.ReadRequest
 		return
 	}
 	bytes, _ := io.ReadAll(res.Body)
-	err = apijson.UnmarshalComputed(bytes, &env)
+	err = apijsoncustom.UnmarshalComputed(bytes, &env)
 	if err != nil {
 		resp.Diagnostics.AddError("failed to deserialize http request", err.Error())
 		return

internal/apijsoncustom/registry.go

@@ -11,7 +11,7 @@ import (
 	"github.com/cloudflare/cloudflare-go/v5"
 	"github.com/cloudflare/cloudflare-go/v5/option"
 	"github.com/cloudflare/cloudflare-go/v5/rulesets"
-	"github.com/cloudflare/terraform-provider-cloudflare/internal/apijson"
+	"github.com/cloudflare/terraform-provider-cloudflare/internal/apijsoncustom"
 	"github.com/cloudflare/terraform-provider-cloudflare/internal/customfield"
 	"github.com/cloudflare/terraform-provider-cloudflare/internal/importpath"
 	"github.com/cloudflare/terraform-provider-cloudflare/internal/logging"
@@ -92,7 +92,7 @@ func (r *RulesetResource) Create(ctx context.Context, req resource.CreateRequest
 		return
 	}
 	bytes, _ := io.ReadAll(res.Body)
-	err = apijson.UnmarshalComputed(bytes, &env)
+	err = apijsoncustom.UnmarshalComputed(bytes, &env)
 	if err != nil {
 		resp.Diagnostics.AddError("failed to deserialize http request", err.Error())
 		return
@@ -143,7 +143,7 @@ func (r *RulesetResource) Update(ctx context.Context, req resource.UpdateRequest
 		return
 	}
 	bytes, _ := io.ReadAll(res.Body)
-	err = apijson.UnmarshalComputed(bytes, &env)
+	err = apijsoncustom.UnmarshalComputed(bytes, &env)
 	if err != nil {
 		resp.Diagnostics.AddError("failed to deserialize http request", err.Error())
 		return
@@ -189,7 +189,7 @@ func (r *RulesetResource) Read(ctx context.Context, req resource.ReadRequest, re
 		return
 	}
 	bytes, _ := io.ReadAll(res.Body)
-	err = apijson.Unmarshal(bytes, &env)
+	err = apijsoncustom.Unmarshal(bytes, &env)
 	if err != nil {
 		resp.Diagnostics.AddError("failed to deserialize http request", err.Error())
 		return
@@ -275,7 +275,7 @@ func (r *RulesetResource) ImportState(ctx context.Context, req resource.ImportSt
 		return
 	}
 	bytes, _ := io.ReadAll(res.Body)
-	err = apijson.Unmarshal(bytes, &env)
+	err = apijsoncustom.Unmarshal(bytes, &env)
 	if err != nil {
 		resp.Diagnostics.AddError("failed to deserialize http request", err.Error())
 		return