refactor: deduplicate ensureTemplateObjectKeysForV1 via stateutil.EnsureMapKeys (#3776)

* refactor: deduplicate ensureTemplateObjectKeysForV1 via stateutil.EnsureMapKeys

Extracts a shared EnsureMapKeys helper into the stateutil package and
replaces the near-identical private ensureTemplateObjectKeysForV1 functions
in the template and componenttemplate packages with calls to the shared
helper.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* ci: trigger checks

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: github-actions[bot]

internal/elasticsearch/index/componenttemplate/state_upgrade.go

@@ -45,7 +45,7 @@ func migrateComponentTemplateStateV0ToV1(_ context.Context, req resource.Upgrade
 	}
 
 	if tmpl, ok := stateMap[attrTemplate].(map[string]any); ok {
-		ensureTemplateObjectKeysForV1(tmpl)
+		stateutil.EnsureMapKeys(tmpl, attrAlias, attrMappings, attrSettings, attrDataStreamOptions)
 		aliasutil.NormalizeTemplateAliasesInV1State(tmpl)
 	}
 
@@ -57,19 +57,3 @@ func migrateComponentTemplateStateV0ToV1(_ context.Context, req resource.Upgrade
 
 	stateutil.MarshalStateMap(stateMap, resp)
 }
-
-func ensureTemplateObjectKeysForV1(tmpl map[string]any) {
-	if _, ok := tmpl[attrAlias]; !ok {
-		// Empty nested sets are null in Terraform JSON state, not [].
-		tmpl[attrAlias] = nil
-	}
-	if _, ok := tmpl[attrMappings]; !ok {
-		tmpl[attrMappings] = nil
-	}
-	if _, ok := tmpl[attrSettings]; !ok {
-		tmpl[attrSettings] = nil
-	}
-	if _, ok := tmpl[attrDataStreamOptions]; !ok {
-		tmpl[attrDataStreamOptions] = nil
-	}
-}

internal/elasticsearch/index/template/state_upgrade.go

@@ -75,7 +75,7 @@ func migrateIndexTemplateStateV0ToV1(_ context.Context, req resource.UpgradeStat
 	}
 
 	if tmpl, ok := stateMap[attrTemplate].(map[string]any); ok {
-		ensureTemplateObjectKeysForV1(tmpl)
+		stateutil.EnsureMapKeys(tmpl, attrAlias, attrMappings, attrSettings, attrLifecycle, attrDataStreamOptions)
 		aliasutil.NormalizeTemplateAliasesInV1State(tmpl)
 	}
 
@@ -87,24 +87,3 @@ func migrateIndexTemplateStateV0ToV1(_ context.Context, req resource.UpgradeStat
 
 	stateutil.MarshalStateMap(stateMap, resp)
 }
-
-// ensureTemplateObjectKeysForV1 fills keys the Plugin Framework v1 schema expects on the template
-// object so RawState JSON decodes after upgrade. Plugin SDK state may omit optional empty blocks.
-func ensureTemplateObjectKeysForV1(tmpl map[string]any) {
-	if _, ok := tmpl[attrAlias]; !ok {
-		// Empty nested sets are null in Terraform JSON state, not [].
-		tmpl[attrAlias] = nil
-	}
-	if _, ok := tmpl[attrMappings]; !ok {
-		tmpl[attrMappings] = nil
-	}
-	if _, ok := tmpl[attrSettings]; !ok {
-		tmpl[attrSettings] = nil
-	}
-	if _, ok := tmpl[attrLifecycle]; !ok {
-		tmpl[attrLifecycle] = nil
-	}
-	if _, ok := tmpl[attrDataStreamOptions]; !ok {
-		tmpl[attrDataStreamOptions] = nil
-	}
-}

internal/stateutil/state_upgrade.go

@@ -39,6 +39,17 @@ func UnmarshalStateMap(req resource.UpgradeStateRequest, resp *resource.UpgradeS
 	return m
 }
 
+// EnsureMapKeys sets each key in keys to nil in m if the key is absent. Used
+// during state upgrades to ensure the Plugin Framework can decode the JSON
+// state even when optional blocks were omitted in the prior SDK state.
+func EnsureMapKeys(m map[string]any, keys ...string) {
+	for _, k := range keys {
+		if _, ok := m[k]; !ok {
+			m[k] = nil
+		}
+	}
+}
+
 // MarshalStateMap encodes m as JSON and assigns it to resp.DynamicValue.
 func MarshalStateMap(m map[string]any, resp *resource.UpgradeStateResponse) {
 	stateJSON, err := json.Marshal(m)

internal/stateutil/state_upgrade_test.go

@@ -91,3 +91,37 @@ func TestMarshalStateMap_error(t *testing.T) {
 	require.Contains(t, resp.Diagnostics[0].Summary(), "State upgrade error")
 	require.Nil(t, resp.DynamicValue)
 }
+
+func TestEnsureMapKeys_sets_missing_keys_to_nil(t *testing.T) {
+	t.Parallel()
+	m := map[string]any{"a": "existing"}
+	stateutil.EnsureMapKeys(m, "a", "b", "c")
+	require.Equal(t, "existing", m["a"])
+	require.Nil(t, m["b"])
+	require.Nil(t, m["c"])
+}
+
+func TestEnsureMapKeys_does_not_overwrite_existing(t *testing.T) {
+	t.Parallel()
+	m := map[string]any{"x": "value", "y": 42}
+	stateutil.EnsureMapKeys(m, "x", "y", "z")
+	require.Equal(t, "value", m["x"])
+	require.Equal(t, 42, m["y"])
+	require.Nil(t, m["z"])
+}
+
+func TestEnsureMapKeys_empty_map(t *testing.T) {
+	t.Parallel()
+	m := map[string]any{}
+	stateutil.EnsureMapKeys(m, "a", "b")
+	require.Nil(t, m["a"])
+	require.Nil(t, m["b"])
+}
+
+func TestEnsureMapKeys_no_keys(t *testing.T) {
+	t.Parallel()
+	m := map[string]any{"a": "keep"}
+	stateutil.EnsureMapKeys(m)
+	require.Equal(t, "keep", m["a"])
+	require.Len(t, m, 1)
+}