added logging for req/resp deferred actions

internal/logging/keys.go

@@ -63,9 +63,15 @@ const (
 	// The protocol version being used, as a string, such as "6"
 	KeyProtocolVersion = "tf_proto_version"
 
+	// The Deferred reason for an RPC response
+	KeyDeferredReason = "tf_deferred_reason"
+
 	// Whether the GetProviderSchemaOptional server capability is enabled
 	KeyServerCapabilityGetProviderSchemaOptional = "tf_server_capability_get_provider_schema_optional"
 
 	// Whether the PlanDestroy server capability is enabled
 	KeyServerCapabilityPlanDestroy = "tf_server_capability_plan_destroy"
+
+	// Whether the DeferralAllowed client capability is enabled
+	KeyClientCapabilityDeferralAllowed = "tf_client_capability_deferral_allowed"
 )

tfprotov5/internal/tf5serverlogging/client_capabilities.go

@@ -0,0 +1,76 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package tf5serverlogging
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-go/internal/logging"
+	"github.com/hashicorp/terraform-plugin-go/tfprotov5"
+)
+
+// ConfigureProviderClientCapabilities generates a TRACE "Announced client capabilities" log.
+func ConfigureProviderClientCapabilities(ctx context.Context, capabilities *tfprotov5.ConfigureProviderClientCapabilities) {
+	responseFields := map[string]interface{}{
+		logging.KeyClientCapabilityDeferralAllowed: false,
+	}
+
+	if capabilities != nil {
+		responseFields[logging.KeyClientCapabilityDeferralAllowed] = capabilities.DeferralAllowed
+	}
+
+	logging.ProtocolTrace(ctx, "Announced client capabilities", responseFields)
+}
+
+// ReadDataSourceClientCapabilities generates a TRACE "Announced client capabilities" log.
+func ReadDataSourceClientCapabilities(ctx context.Context, capabilities *tfprotov5.ReadDataSourceClientCapabilities) {
+	responseFields := map[string]interface{}{
+		logging.KeyClientCapabilityDeferralAllowed: false,
+	}
+
+	if capabilities != nil {
+		responseFields[logging.KeyClientCapabilityDeferralAllowed] = capabilities.DeferralAllowed
+	}
+
+	logging.ProtocolTrace(ctx, "Announced client capabilities", responseFields)
+}
+
+// ReadResourceClientCapabilities generates a TRACE "Announced client capabilities" log.
+func ReadResourceClientCapabilities(ctx context.Context, capabilities *tfprotov5.ReadResourceClientCapabilities) {
+	responseFields := map[string]interface{}{
+		logging.KeyClientCapabilityDeferralAllowed: false,
+	}
+
+	if capabilities != nil {
+		responseFields[logging.KeyClientCapabilityDeferralAllowed] = capabilities.DeferralAllowed
+	}
+
+	logging.ProtocolTrace(ctx, "Announced client capabilities", responseFields)
+}
+
+// PlanResourceChangeClientCapabilities generates a TRACE "Announced client capabilities" log.
+func PlanResourceChangeClientCapabilities(ctx context.Context, capabilities *tfprotov5.PlanResourceChangeClientCapabilities) {
+	responseFields := map[string]interface{}{
+		logging.KeyClientCapabilityDeferralAllowed: false,
+	}
+
+	if capabilities != nil {
+		responseFields[logging.KeyClientCapabilityDeferralAllowed] = capabilities.DeferralAllowed
+	}
+
+	logging.ProtocolTrace(ctx, "Announced client capabilities", responseFields)
+}
+
+// ImportResourceStateClientCapabilities generates a TRACE "Announced client capabilities" log.
+func ImportResourceStateClientCapabilities(ctx context.Context, capabilities *tfprotov5.ImportResourceStateClientCapabilities) {
+	responseFields := map[string]interface{}{
+		logging.KeyClientCapabilityDeferralAllowed: false,
+	}
+
+	if capabilities != nil {
+		responseFields[logging.KeyClientCapabilityDeferralAllowed] = capabilities.DeferralAllowed
+	}
+
+	logging.ProtocolTrace(ctx, "Announced client capabilities", responseFields)
+}