fix: improve dynamic block schema merging logic to not modify in place

hashicorp · Jun 5, 2024 · a1758a4 · a1758a4
1 parent 9dbd8b9
commit a1758a4
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 8 deletions.
diff --git a/decoder/internal/schemahelper/block_schema.go b/decoder/internal/schemahelper/block_schema.go
@@ -38,23 +38,24 @@ func MergeBlockBodySchemas(block *hcl.Block, blockSchema *schema.BlockSchema) (*
 		}
 		for bType, block := range depSchema.Blocks {
 			if _, exists := mergedSchema.Blocks[bType]; !exists {
+				b := block.Copy()
 				// propagate DynamicBlocks extension to any nested blocks
 				if mergedSchema.Extensions != nil && mergedSchema.Extensions.DynamicBlocks {
-					if block.Body.Extensions == nil {
-						block.Body.Extensions = &schema.BodyExtensions{}
+					if b.Body.Extensions == nil {
+						b.Body.Extensions = &schema.BodyExtensions{}
 					}
-					block.Body.Extensions.DynamicBlocks = true
+					b.Body.Extensions.DynamicBlocks = true
 				}
 
-				mergedSchema.Blocks[bType] = block
+				mergedSchema.Blocks[bType] = b
 			} else {
 				// Skip duplicate block type
 				continue
 			}
 		}
 
 		if mergedSchema.Extensions != nil && mergedSchema.Extensions.DynamicBlocks && len(depSchema.Blocks) > 0 {
-			mergedSchema.Blocks["dynamic"] = buildDynamicBlockSchema(depSchema)
+			mergedSchema.Blocks["dynamic"] = buildDynamicBlockSchema(depSchema, mergedSchema)
 		}
 
 		mergedSchema.TargetableAs = append(mergedSchema.TargetableAs, depSchema.TargetableAs...)
@@ -87,7 +88,7 @@ func MergeBlockBodySchemas(block *hcl.Block, blockSchema *schema.BlockSchema) (*
 			}
 		}
 
-		mergedSchema.Blocks["dynamic"] = buildDynamicBlockSchema(mergedSchema)
+		mergedSchema.Blocks["dynamic"] = buildDynamicBlockSchema(mergedSchema, mergedSchema)
 	}
 
 	return mergedSchema, result

diff --git a/decoder/internal/schemahelper/dynamic_block.go b/decoder/internal/schemahelper/dynamic_block.go
@@ -9,9 +9,14 @@ import (
 	"github.com/zclconf/go-cty/cty"
 )
 
-func buildDynamicBlockSchema(inputSchema *schema.BodySchema) *schema.BlockSchema {
+// buildDynamicBlockSchema
+// inputSchema schema used to figure out which blocks can be dynamic (commonly the dependent schema in order to NOT include static blocks like e.g. lifecycle)
+// sourceSchema schema used to copy the body of the block (commonly the merged schema in order to include changes that were made to the schema)
+func buildDynamicBlockSchema(inputSchema *schema.BodySchema, sourceSchema *schema.BodySchema) *schema.BlockSchema {
 	dependentBody := make(map[schema.SchemaKey]*schema.BodySchema)
-	for blockName, block := range inputSchema.Blocks {
+	for blockName := range inputSchema.Blocks {
+		block := sourceSchema.Blocks[blockName]
+
 		dependentBody[schema.NewSchemaKey(schema.DependencyKeys{
 			Labels: []schema.LabelDependent{
 				{Index: 0, Value: blockName},