Ignore diff when using empty json object {}.

Author: gigerdo

internal/fleet/integration_policy/models.go

@@ -50,7 +50,7 @@ func (model *integrationPolicyModel) populateFromAPI(ctx context.Context, data *
 	model.Enabled = types.BoolValue(data.Enabled)
 	model.IntegrationName = types.StringValue(data.Package.Name)
 	model.IntegrationVersion = types.StringValue(data.Package.Version)
-	model.VarsJson = utils.MapToNormalizedType(utils.Deref(data.Vars), path.Root("vars_json"), &diags)
+	model.VarsJson = normalizeVarsJson(model.VarsJson, utils.MapToNormalizedType(utils.Deref(data.Vars), path.Root("vars_json"), &diags))
 
 	model.populateInputFromAPI(ctx, data.Inputs, &diags)
 
@@ -64,7 +64,7 @@ func (model *integrationPolicyModel) populateInputFromAPI(ctx context.Context, i
 				InputID:     types.StringValue(meta.Key),
 				Enabled:     types.BoolPointerValue(inputData.Enabled),
 				StreamsJson: utils.MapToNormalizedType(utils.Deref(inputData.Streams), meta.Path.AtName("streams_json"), diags),
-				VarsJson:    utils.MapToNormalizedType(utils.Deref(inputData.Vars), meta.Path.AtName("vars_json"), diags),
+				VarsJson:    normalizeVarsJson(model.VarsJson, utils.MapToNormalizedType(utils.Deref(inputData.Vars), meta.Path.AtName("vars_json"), diags)),
 			}
 		})
 	if newInputs == nil {
@@ -147,3 +147,16 @@ func sortInputs(incoming []integrationPolicyInputModel, existing []integrationPo
 		return iIdx < jIdx
 	})
 }
+
+// normalizeVarsJson handles the case where both nil (from API) and "{}" (from config)
+// represent an empty JSON object. If the existing value is "{}" and the incoming
+// value is null (from API returning nil), preserve the "{}" to avoid unwanted diffs.
+func normalizeVarsJson(existing jsontypes.Normalized, incoming jsontypes.Normalized) jsontypes.Normalized {
+	if incoming.IsNull() && !existing.IsNull() && !existing.IsUnknown() {
+		existingValue := existing.ValueString()
+		if existingValue == "{}" {
+			return jsontypes.NewNormalizedValue("{}")
+		}
+	}
+	return incoming
+}

internal/fleet/integration_policy/models_test.go

@@ -3,6 +3,7 @@ package integration_policy
 import (
 	"testing"
 
+	"github.com/hashicorp/terraform-plugin-framework-jsontypes/jsontypes"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 	"github.com/stretchr/testify/require"
 )
@@ -62,3 +63,41 @@ func Test_SortInputs(t *testing.T) {
 		require.Equal(t, want, incoming)
 	})
 }
+
+func TestNormalizeVarsJson(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		name     string
+		existing jsontypes.Normalized
+		api      jsontypes.Normalized
+		want     jsontypes.Normalized
+	}{
+		{
+			name:     "plan defines empty object, but api returns null -> preserve empty object",
+			existing: jsontypes.NewNormalizedValue("{}"),
+			api:      jsontypes.NewNormalizedNull(),
+			want:     jsontypes.NewNormalizedValue("{}"),
+		},
+		{
+			name:     "plan does not define value, api returns null -> preserve null",
+			existing: jsontypes.NewNormalizedUnknown(),
+			api:      jsontypes.NewNormalizedNull(),
+			want:     jsontypes.NewNormalizedNull(),
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			result := normalizeVarsJson(tt.existing, tt.api)
+
+			// Compare the states and values
+			require.Equal(t, tt.want.IsNull(), result.IsNull(), "IsNull() should match")
+			require.Equal(t, tt.want.IsUnknown(), result.IsUnknown(), "IsUnknown() should match")
+
+			if !tt.want.IsNull() && !tt.want.IsUnknown() {
+				require.Equal(t, tt.want.ValueString(), result.ValueString(), "ValueString() should match")
+			}
+		})
+	}
+}