Merge pull request #38 from pluralsh/marcin/eng-2117-annoying-terraform-provider-bug-when-creating-cluster-wo

fix: Fix inconsistent result after apply error for cluster tags

Author: michaeljguarino

internal/common/cluster_tags.go

@@ -20,7 +20,7 @@ func MapFrom(values map[string]any, ctx context.Context, d diag.Diagnostics) typ
 func MapFromWithConfig(values map[string]any, config types.Map, ctx context.Context, d diag.Diagnostics) types.Map {
 	if len(values) == 0 {
 		// Rewriting config to state to avoid inconsistent result errors.
-		// This could happen, for example, when sending "nil" to API and "[]" is returned as a result.
+		// This could happen, for example, when sending "nil" to API and "{}" is returned as a result.
 		return config
 	}
 

internal/common/map.go

@@ -0,0 +1,27 @@
+package common
+
+import (
+	"github.com/hashicorp/terraform-plugin-framework/attr"
+	"github.com/hashicorp/terraform-plugin-framework/diag"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
+	console "github.com/pluralsh/console-client-go"
+)
+
+func TagsFrom(tags []*console.ClusterTags, config types.Map, d diag.Diagnostics) basetypes.MapValue {
+	if len(tags) == 0 {
+		// Rewriting config to state to avoid inconsistent result errors.
+		// This could happen, for example, when sending "nil" to API and "{}" is returned as a result.
+		return config
+	}
+
+	resultMap := make(map[string]attr.Value, len(tags))
+	for _, tag := range tags {
+		resultMap[tag.Name] = types.StringValue(tag.Value)
+	}
+
+	result, tagsDiagnostics := types.MapValue(types.StringType, resultMap)
+	d.Append(tagsDiagnostics...)
+
+	return result
+}

internal/common/tags.go

@@ -39,7 +39,7 @@ func (c *cluster) From(cl *console.ClusterFragment, ctx context.Context, d diag.
 	c.Handle = types.StringPointerValue(cl.Handle)
 	c.DesiredVersion = types.StringPointerValue(cl.Version)
 	c.Protect = types.BoolPointerValue(cl.Protect)
-	c.Tags = common.ClusterTagsFrom(cl.Tags, d)
+	c.Tags = common.TagsFrom(cl.Tags, c.Tags, d)
 	c.Metadata = types.StringValue(string(metadata))
 	c.ProviderId = common.ClusterProviderIdFrom(cl.Provider)
 	c.NodePools = common.ClusterNodePoolsFrom(cl.NodePools, c.NodePools, ctx, d)

internal/datasource/cluster_model.go

@@ -56,6 +56,10 @@ type cluster struct {
 // }
 
 func (c *cluster) TagsAttribute(ctx context.Context, d diag.Diagnostics) []*console.TagAttributes {
+	if c.Tags.IsNull() {
+		return nil
+	}
+
 	result := make([]*console.TagAttributes, 0)
 	elements := make(map[string]types.String, len(c.Tags.Elements()))
 	d.Append(c.Tags.ElementsAs(ctx, &elements, false)...)
@@ -107,7 +111,7 @@ func (c *cluster) From(cl *console.ClusterFragment, ctx context.Context, d diag.
 	c.Handle = types.StringPointerValue(cl.Handle)
 	// c.DesiredVersion = c.ClusterVersionFrom(cl.Provider, cl.Version, cl.CurrentVersion)
 	c.Protect = types.BoolPointerValue(cl.Protect)
-	c.Tags = common.ClusterTagsFrom(cl.Tags, d)
+	c.Tags = common.TagsFrom(cl.Tags, c.Tags, d)
 	// c.ProviderId = common.ClusterProviderIdFrom(cl.Provider)
 	// c.NodePools = common.ClusterNodePoolsFrom(cl.NodePools, c.NodePools, ctx, d)
 	c.Metadata = types.StringValue(string(metadata))
@@ -120,7 +124,7 @@ func (c *cluster) FromCreate(cc *console.CreateCluster, ctx context.Context, d d
 	c.Handle = types.StringPointerValue(cc.CreateCluster.Handle)
 	// c.DesiredVersion = c.ClusterVersionFrom(cc.CreateCluster.Provider, cc.CreateCluster.Version, cc.CreateCluster.CurrentVersion)
 	c.Protect = types.BoolPointerValue(cc.CreateCluster.Protect)
-	c.Tags = common.ClusterTagsFrom(cc.CreateCluster.Tags, d)
+	c.Tags = common.TagsFrom(cc.CreateCluster.Tags, c.Tags, d)
 	// c.ProviderId = common.ClusterProviderIdFrom(cc.CreateCluster.Provider)
 	// c.NodePools = common.ClusterNodePoolsFrom(cc.CreateCluster.NodePools, c.NodePools, ctx, d)
 }

internal/resource/cluster_model.go

@@ -9,7 +9,6 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework-validators/listvalidator"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/booldefault"
-	"github.com/hashicorp/terraform-plugin-framework/resource/schema/mapplanmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/objectplanmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
@@ -217,7 +216,6 @@ func (r *clusterResource) schema() schema.Schema {
 				MarkdownDescription: "Key-value tags used to filter clusters.",
 				Optional:            true,
 				ElementType:         types.StringType,
-				PlanModifiers:       []planmodifier.Map{mapplanmodifier.UseStateForUnknown()},
 			},
 			"bindings": schema.SingleNestedAttribute{
 				Description:         "Read and write policies of this cluster.",

internal/resource/cluster_schema.go

@@ -3,6 +3,7 @@ package resource
 import (
 	"context"
 	"strings"
+
 	"terraform-provider-plural/internal/common"
 
 	"github.com/hashicorp/terraform-plugin-framework/diag"
@@ -30,7 +31,8 @@ func (g *globalService) From(response *gqlclient.GlobalServiceFragment, d diag.D
 	if response.Provider != nil {
 		g.ProviderId = types.StringValue(response.Provider.ID)
 	}
-	g.Tags = common.ClusterTagsFrom(response.Tags, d)
+	g.Tags = common.TagsFrom(response.Tags, g.Tags, d)
+
 }
 
 func (g *globalService) Attributes(ctx context.Context, d diag.Diagnostics) gqlclient.GlobalServiceAttributes {
@@ -47,6 +49,10 @@ func (g *globalService) Attributes(ctx context.Context, d diag.Diagnostics) gqlc
 }
 
 func (g *globalService) TagsAttribute(ctx context.Context, d diag.Diagnostics) []*gqlclient.TagAttributes {
+	if g.Tags.IsNull() {
+		return nil
+	}
+
 	result := make([]*gqlclient.TagAttributes, 0)
 	elements := make(map[string]types.String, len(g.Tags.Elements()))
 	d.Append(g.Tags.ElementsAs(ctx, &elements, false)...)

internal/resource/global_service_model.go

@@ -109,7 +109,7 @@ func (is *infrastructureStack) From(stack *gqlclient.InfrastructureStackFragment
 func infrastructureStackFilesFrom(files []*gqlclient.StackFileFragment, config types.Map, d diag.Diagnostics) types.Map {
 	if len(files) == 0 {
 		// Rewriting config to state to avoid inconsistent result errors.
-		// This could happen, for example, when sending "nil" to API and "[]" is returned as a result.
+		// This could happen, for example, when sending "nil" to API and "{}" is returned as a result.
 		return config
 	}