Nullify write-only attributes during Plan and Apply regardless of client capability

Author: SBGoods

internal/fwserver/server_createresource.go

@@ -163,16 +163,15 @@ func (s *Server) CreateResource(ctx context.Context, req *CreateResourceRequest,
 		resp.NewState.Raw = semanticEqualityResp.NewData.TerraformValue
 	}
 
-	if req.ClientCapabilities.WriteOnlyAttributesAllowed {
-		modifiedState, err := tftypes.Transform(resp.NewState.Raw, NullifyWriteOnlyAttributes(ctx, req.ResourceSchema))
-		if err != nil {
-			resp.Diagnostics.AddError(
-				"Error modifying state",
-				"There was an unexpected error modifying the NewState. This is always a problem with the provider. Please report the following to the provider developer:\n\n"+err.Error(),
-			)
-			return
-		}
-
-		resp.NewState.Raw = modifiedState
+	// Set any write-only attributes in the state to null
+	modifiedState, err := tftypes.Transform(resp.NewState.Raw, NullifyWriteOnlyAttributes(ctx, req.ResourceSchema))
+	if err != nil {
+		resp.Diagnostics.AddError(
+			"Error Modifying State",
+			"There was an unexpected error modifying the NewState. This is always a problem with the provider. Please report the following to the provider developer:\n\n"+err.Error(),
+		)
+		return
 	}
+
+	resp.NewState.Raw = modifiedState
 }

internal/fwserver/server_createresource_test.go

@@ -535,9 +535,6 @@ func TestServerCreateResource(t *testing.T) {
 				Provider: &testprovider.Provider{},
 			},
 			request: &fwserver.CreateResourceRequest{
-				ClientCapabilities: fwserver.ApplyResourceChangeClientCapabilities{
-					WriteOnlyAttributesAllowed: true,
-				},
 				PlannedState: &tfsdk.Plan{
 					Raw: tftypes.NewValue(testSchemaTypeWriteOnly, map[string]tftypes.Value{
 						"test_required":   tftypes.NewValue(tftypes.String, "test-plannedstate-value"),

internal/fwserver/server_planresourcechange.go

@@ -81,7 +81,7 @@ func (s *Server) PlanResourceChange(ctx context.Context, req *PlanResourceChange
 		err := tftypes.Walk(req.Config.Raw, RequiredWriteOnlyNilsAttributePaths(ctx, req.Config.Schema, &reqWriteOnlyPaths))
 		if err != nil {
 			resp.Diagnostics.AddError(
-				"Error validating plan",
+				"Error Validating Plan",
 				"There was an unexpected error validating the plan. This is always a problem with the provider. Please report the following to the provider developer:\n\n"+err.Error(),
 			)
 			return
@@ -367,6 +367,18 @@ func (s *Server) PlanResourceChange(ctx context.Context, req *PlanResourceChange
 				"Ensure all resource plan modifiers do not attempt to change resource plan data from being a null value if the request plan is a null value.",
 		)
 	}
+
+	// Set any write-only attributes in the plan to null
+	modifiedPlan, err := tftypes.Transform(resp.PlannedState.Raw, NullifyWriteOnlyAttributes(ctx, req.ResourceSchema))
+	if err != nil {
+		resp.Diagnostics.AddError(
+			"Error Modifying Planned State",
+			"There was an unexpected error modifying the PlannedState. This is always a problem with the provider. Please report the following to the provider developer:\n\n"+err.Error(),
+		)
+		return
+	}
+
+	resp.PlannedState.Raw = modifiedPlan
 }
 
 func MarkComputedNilsAsUnknown(ctx context.Context, config tftypes.Value, resourceSchema fwschema.Schema) func(*tftypes.AttributePath, tftypes.Value) (tftypes.Value, error) {

internal/fwserver/server_updateresource.go

@@ -176,16 +176,15 @@ func (s *Server) UpdateResource(ctx context.Context, req *UpdateResourceRequest,
 		resp.NewState.Raw = semanticEqualityResp.NewData.TerraformValue
 	}
 
-	if req.ClientCapabilities.WriteOnlyAttributesAllowed {
-		modifiedState, err := tftypes.Transform(resp.NewState.Raw, NullifyWriteOnlyAttributes(ctx, req.ResourceSchema))
-		if err != nil {
-			resp.Diagnostics.AddError(
-				"Error modifying state",
-				"There was an unexpected error modifying the NewState. This is always a problem with the provider. Please report the following to the provider developer:\n\n"+err.Error(),
-			)
-			return
-		}
-
-		resp.NewState.Raw = modifiedState
+	// Set any write-only attributes in the state to null
+	modifiedState, err := tftypes.Transform(resp.NewState.Raw, NullifyWriteOnlyAttributes(ctx, req.ResourceSchema))
+	if err != nil {
+		resp.Diagnostics.AddError(
+			"Error Modifying State",
+			"There was an unexpected error modifying the NewState. This is always a problem with the provider. Please report the following to the provider developer:\n\n"+err.Error(),
+		)
+		return
 	}
+
+	resp.NewState.Raw = modifiedState
 }

internal/fwserver/server_updateresource_test.go

@@ -806,9 +806,6 @@ func TestServerUpdateResource(t *testing.T) {
 				Provider: &testprovider.Provider{},
 			},
 			request: &fwserver.UpdateResourceRequest{
-				ClientCapabilities: fwserver.ApplyResourceChangeClientCapabilities{
-					WriteOnlyAttributesAllowed: true,
-				},
 				PlannedState: &tfsdk.Plan{
 					Raw: tftypes.NewValue(testSchemaTypeWriteOnly, map[string]tftypes.Value{
 						"test_required":   tftypes.NewValue(tftypes.String, "test-plannedstate-value"),