temporary interface the new RPC

Author: stephybun

tfprotov5/provider.go

@@ -93,6 +93,21 @@ type ProviderServerWithListResource interface {
 	ListResourceServer
 }
 
+// ProviderServerGenerateResourceConfig is a temporary interface for servers
+// to implement the GenerateResourceConfig RPC
+//
+// - GenerateResourceConfig
+//
+// Deprecated: All methods will be moved into the
+// ProviderServer interface and this interface will be removed in a future
+// version.
+type ProviderServerGenerateResourceConfig interface {
+	ProviderServer
+
+	// GenerateResourceConfig is an interface encapsulating the GenerateResourceConfig RPC request.
+	GenerateResourceConfig(context.Context, *GenerateResourceConfigRequest) (*GenerateResourceConfigResponse, error)
+}
+
 // ProviderServerWithActions is a temporary interface for servers
 // to implement Action RPCs
 //

tfprotov5/resource.go

@@ -77,7 +77,7 @@ type ResourceServer interface {
 	// This functionality is only supported in Terraform 1.14 and later. The
 	// provider must have enabled the GenerateResourceConfig server capability to
 	// enable these requests.
-	GenerateResourceConfig(context.Context, *GenerateResourceConfigRequest) (*GenerateResourceConfigResponse, error)
+	// GenerateResourceConfig(context.Context, *GenerateResourceConfigRequest) (*GenerateResourceConfigResponse, error)
 }
 
 // ValidateResourceTypeConfigRequest is the request Terraform sends when it

tfprotov5/tf5server/server.go

@@ -1499,7 +1499,31 @@ func (s *server) GenerateResourceConfig(ctx context.Context, protoReq *tfplugin5
 
 	ctx = tf5serverlogging.DownstreamRequest(ctx)
 
-	resp, err := s.downstream.GenerateResourceConfig(ctx, req)
+	// TODO: Remove this check and error in preference of
+	// s.downstream.GenerateResourceConfig below once ProviderServer interface
+	// implements this RPC method.
+	// nolint:staticcheck
+	generateResourceConfigProviderServer, ok := s.downstream.(tfprotov5.ProviderServerGenerateResourceConfig)
+	if !ok {
+		logging.ProtocolError(ctx, "ProviderServer does not implement GenerateResourceConfig")
+
+		protoResp := &tfplugin5.GenerateResourceConfig_Response{
+			Diagnostics: []*tfplugin5.Diagnostic{
+				{
+					Severity: tfplugin5.Diagnostic_ERROR,
+					Summary:  "Provider GenerateResourceConfig Not Implemented",
+					Detail: "A GenerateResourceConfig call was received by the provider, however the provider does not implement the call. " +
+						"Either upgrade the provider to a version that implements action support or this is a bug in Terraform that should be reported to the Terraform maintainers.",
+				},
+			},
+		}
+
+		return protoResp, nil
+	}
+
+	// TODO: Update this to call downstream once optional interface is removed
+	// resp, err := s.downstream.GenerateResourceConfig(ctx, req)
+	resp, err := generateResourceConfigProviderServer.GenerateResourceConfig(ctx, req)
 	if err != nil {
 		logging.ProtocolError(ctx, "Error from downstream", map[string]any{logging.KeyError: err})
 		return nil, err