move protov5 information into the resource metadataresponse

stephybun · stephybun · commit aef80babe1ef · 2025-08-20T11:24:17.000+02:00
diff --git a/internal/fwserver/server_listresources.go b/internal/fwserver/server_listresources.go
@@ -12,6 +12,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/internal/logging"
 	"github.com/hashicorp/terraform-plugin-framework/list"
 	"github.com/hashicorp/terraform-plugin-framework/provider"
+	"github.com/hashicorp/terraform-plugin-framework/resource"
 )
 
 func (s *Server) ListResourceType(ctx context.Context, typeName string) (list.ListResource, diag.Diagnostics) {
@@ -56,10 +57,10 @@ func (s *Server) ListResourceFuncs(ctx context.Context) (map[string]func() list.
 	for _, listResourceFunc := range listResourceFuncSlice {
 		listResource := listResourceFunc()
 
-		metadataReq := list.MetadataRequest{
+		metadataReq := resource.MetadataRequest{
 			ProviderTypeName: providerTypeName,
 		}
-		metadataResp := list.MetadataResponse{}
+		metadataResp := resource.MetadataResponse{}
 		listResource.Metadata(ctx, metadataReq, &metadataResp)
 
 		typeName := metadataResp.TypeName
@@ -86,8 +87,6 @@ func (s *Server) ListResourceFuncs(ctx context.Context) (map[string]func() list.
 
 		resourceFuncs, _ := s.ResourceFuncs(ctx)
 		if _, ok := resourceFuncs[typeName]; !ok {
-
-			// With the ProtoV5 info in Metadata we can keep this validation
 			// TODO update error message
 			if metadataResp.ProtoV5Schema == nil || metadataResp.ProtoV5IdentitySchema == nil {
 				s.listResourceFuncsDiags.AddError(
diff --git a/internal/proto5server/server_getmetadata_test.go b/internal/proto5server/server_getmetadata_test.go
@@ -225,14 +225,14 @@ func TestServerGetMetadata(t *testing.T) {
 							return []func() list.ListResource{
 								func() list.ListResource {
 									return &testprovider.ListResource{
-										MetadataMethod: func(_ context.Context, _ list.MetadataRequest, resp *list.MetadataResponse) {
+										MetadataMethod: func(_ context.Context, _ resource.MetadataRequest, resp *resource.MetadataResponse) {
 											resp.TypeName = "test_list_resource1"
 										},
 									}
 								},
 								func() list.ListResource {
 									return &testprovider.ListResource{
-										MetadataMethod: func(_ context.Context, _ list.MetadataRequest, resp *list.MetadataResponse) {
+										MetadataMethod: func(_ context.Context, _ resource.MetadataRequest, resp *resource.MetadataResponse) {
 											resp.TypeName = "test_list_resource2"
 										},
 									}
diff --git a/internal/proto5server/server_getproviderschema_test.go b/internal/proto5server/server_getproviderschema_test.go
@@ -381,7 +381,7 @@ func TestServerGetProviderSchema(t *testing.T) {
 												},
 											}
 										},
-										MetadataMethod: func(_ context.Context, _ list.MetadataRequest, resp *list.MetadataResponse) {
+										MetadataMethod: func(_ context.Context, _ resource.MetadataRequest, resp *resource.MetadataResponse) {
 											resp.TypeName = "test_list_resource1"
 										},
 									}
@@ -397,7 +397,7 @@ func TestServerGetProviderSchema(t *testing.T) {
 												},
 											}
 										},
-										MetadataMethod: func(_ context.Context, _ list.MetadataRequest, resp *list.MetadataResponse) {
+										MetadataMethod: func(_ context.Context, _ resource.MetadataRequest, resp *resource.MetadataResponse) {
 											resp.TypeName = "test_list_resource2"
 										},
 									}
diff --git a/internal/proto5server/server_listresource.go b/internal/proto5server/server_listresource.go
@@ -5,12 +5,12 @@ package proto5server
 
 import (
 	"context"
-	"github.com/hashicorp/terraform-plugin-framework/list"
 
 	"github.com/hashicorp/terraform-plugin-framework/diag"
 	"github.com/hashicorp/terraform-plugin-framework/internal/fromproto5"
 	"github.com/hashicorp/terraform-plugin-framework/internal/fwserver"
 	"github.com/hashicorp/terraform-plugin-framework/internal/toproto5"
+	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-go/tfprotov5"
 )
 
@@ -48,9 +48,8 @@ func (s *Server) ListResource(ctx context.Context, protoReq *tfprotov5.ListResou
 		return ListRequestErrorDiagnostics(ctx, allDiags...)
 	}
 
-	// This breaks consistency with other RPCs but this allows us to switch the logic without an interceptor in mux
-	metadataResp := list.MetadataResponse{}
-	listResource.Metadata(ctx, list.MetadataRequest{}, &metadataResp)
+	metadataResp := resource.MetadataResponse{}
+	listResource.Metadata(ctx, resource.MetadataRequest{}, &metadataResp)
 
 	req := &fwserver.ListRequest{
 		Config:          config,
@@ -76,7 +75,7 @@ func (s *Server) ListResource(ctx context.Context, protoReq *tfprotov5.ListResou
 			return ListRequestErrorDiagnostics(ctx, allDiags...)
 		}
 	}
-	
+
 	stream := &fwserver.ListResultsStream{}
 
 	s.FrameworkServer.ListResource(ctx, req, stream)
diff --git a/internal/proto5server/server_listresource_test.go b/internal/proto5server/server_listresource_test.go
@@ -118,7 +118,7 @@ func TestServerListResource(t *testing.T) {
 				}
 				resp.Results = slices.Values(results)
 			},
-			MetadataMethod: func(ctx context.Context, req list.MetadataRequest, resp *list.MetadataResponse) {
+			MetadataMethod: func(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
 				resp.TypeName = "test_resource"
 			},
 		}
diff --git a/internal/proto5server/server_validatelistresourceconfig_test.go b/internal/proto5server/server_validatelistresourceconfig_test.go
@@ -58,7 +58,7 @@ func TestServerValidateListResourceConfig(t *testing.T) {
 							return []func() list.ListResource{
 								func() list.ListResource {
 									return &testprovider.ListResource{
-										MetadataMethod: func(_ context.Context, _ list.MetadataRequest, resp *list.MetadataResponse) {
+										MetadataMethod: func(_ context.Context, _ resource.MetadataRequest, resp *resource.MetadataResponse) {
 											resp.TypeName = "test_resource"
 										},
 										ListResourceConfigSchemaMethod: func(_ context.Context, _ list.ListResourceSchemaRequest, resp *list.ListResourceSchemaResponse) {},
@@ -96,7 +96,7 @@ func TestServerValidateListResourceConfig(t *testing.T) {
 										ListResourceConfigSchemaMethod: func(_ context.Context, _ list.ListResourceSchemaRequest, resp *list.ListResourceSchemaResponse) {
 											resp.Schema = testSchema
 										},
-										MetadataMethod: func(_ context.Context, _ list.MetadataRequest, resp *list.MetadataResponse) {
+										MetadataMethod: func(_ context.Context, _ resource.MetadataRequest, resp *resource.MetadataResponse) {
 											resp.TypeName = "test_resource"
 										},
 									}
@@ -135,7 +135,7 @@ func TestServerValidateListResourceConfig(t *testing.T) {
 											ListResourceConfigSchemaMethod: func(_ context.Context, _ list.ListResourceSchemaRequest, resp *list.ListResourceSchemaResponse) {
 												resp.Schema = testSchema
 											},
-											MetadataMethod: func(_ context.Context, _ list.MetadataRequest, resp *list.MetadataResponse) {
+											MetadataMethod: func(_ context.Context, _ resource.MetadataRequest, resp *resource.MetadataResponse) {
 												resp.TypeName = "test_resource"
 											},
 										},
diff --git a/internal/testing/testprovider/listresource.go b/internal/testing/testprovider/listresource.go
@@ -7,20 +7,21 @@ import (
 	"context"
 
 	"github.com/hashicorp/terraform-plugin-framework/list"
+	"github.com/hashicorp/terraform-plugin-framework/resource"
 )
 
 var _ list.ListResource = &ListResource{}
 
 // Declarative list.ListResource for unit testing.
 type ListResource struct {
 	// ListResource interface methods
-	MetadataMethod                 func(context.Context, list.MetadataRequest, *list.MetadataResponse)
+	MetadataMethod                 func(context.Context, resource.MetadataRequest, *resource.MetadataResponse)
 	ListResourceConfigSchemaMethod func(context.Context, list.ListResourceSchemaRequest, *list.ListResourceSchemaResponse)
 	ListMethod                     func(context.Context, list.ListRequest, *list.ListResultsStream)
 }
 
 // Metadata satisfies the list.ListResource interface.
-func (r *ListResource) Metadata(ctx context.Context, req list.MetadataRequest, resp *list.MetadataResponse) {
+func (r *ListResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
 	if r.MetadataMethod == nil {
 		return
 	}
diff --git a/list/list_resource.go b/list/list_resource.go
@@ -30,10 +30,7 @@ type ListResource interface {
 	// The method signature is intended to be compatible with the Metadata
 	// method signature in the Resource interface. One implementation of
 	// Metadata can satisfy both interfaces.
-
-	// Since we're passing additional schema information around in here we should use the
-	// MetadataRequest and MetadataResponse for list
-	Metadata(context.Context, MetadataRequest, *MetadataResponse)
+	Metadata(context.Context, resource.MetadataRequest, *resource.MetadataResponse)
 
 	// ListResourceConfigSchema should return the schema for list blocks.
 	ListResourceConfigSchema(context.Context, ListResourceSchemaRequest, *ListResourceSchemaResponse)
diff --git a/list/list_resource_test.go b/list/list_resource_test.go
@@ -26,7 +26,7 @@ type ComputeInstanceWithListResourceConfigValidators struct {
 func (c *ComputeInstanceResource) Configure(_ context.Context, _ resource.ConfigureRequest, _ *resource.ConfigureResponse) {
 }
 
-func (c *ComputeInstanceResource) Metadata(_ context.Context, _ list.MetadataRequest, _ *list.MetadataResponse) {
+func (c *ComputeInstanceResource) Metadata(_ context.Context, _ resource.MetadataRequest, _ *resource.MetadataResponse) {
 }
 
 func (c *ComputeInstanceWithValidateListResourceConfig) ValidateListResourceConfig(_ context.Context, _ list.ValidateConfigRequest, _ *list.ValidateConfigResponse) {
diff --git a/list/no_op_resource_test.go b/list/no_op_resource_test.go
@@ -25,6 +25,3 @@ func (*NoOpResource) Update(_ context.Context, _ resource.UpdateRequest, _ *reso
 
 func (*NoOpResource) Delete(_ context.Context, _ resource.DeleteRequest, _ *resource.DeleteResponse) {
 }
-
-func (*NoOpResource) Metadata(_ context.Context, _ resource.MetadataRequest, _ *resource.MetadataResponse) {
-}
diff --git a/resource/metadata.go b/resource/metadata.go
@@ -3,6 +3,8 @@
 
 package resource
 
+import "github.com/hashicorp/terraform-plugin-go/tfprotov5"
+
 // MetadataRequest represents a request for the Resource to return metadata,
 // such as its type name. An instance of this request struct is supplied as
 // an argument to the Resource type Metadata method.
@@ -25,6 +27,9 @@ type MetadataResponse struct {
 	// ResourceBehavior is used to control framework-specific logic when
 	// interacting with this resource.
 	ResourceBehavior ResourceBehavior
+
+	ProtoV5Schema         func() *tfprotov5.Schema
+	ProtoV5IdentitySchema func() *tfprotov5.ResourceIdentitySchema
 }
 
 // ResourceBehavior controls framework-specific logic when interacting

Original file line number	Diff line number	Diff line change
`@@ -381,7 +381,7 @@ func TestServerGetProviderSchema(t *testing.T) {`
`381`	`381`	`},`
`382`	`382`	`}`
`383`	`383`	`},`
`384`		`- MetadataMethod: func(_ context.Context, _ list.MetadataRequest, resp *list.MetadataResponse) {`
	`384`	`+ MetadataMethod: func(_ context.Context, _ resource.MetadataRequest, resp *resource.MetadataResponse) {`
`385`	`385`	`resp.TypeName = "test_list_resource1"`
`386`	`386`	`},`
`387`	`387`	`}`
`@@ -397,7 +397,7 @@ func TestServerGetProviderSchema(t *testing.T) {`
`397`	`397`	`},`
`398`	`398`	`}`
`399`	`399`	`},`
`400`		`- MetadataMethod: func(_ context.Context, _ list.MetadataRequest, resp *list.MetadataResponse) {`
	`400`	`+ MetadataMethod: func(_ context.Context, _ resource.MetadataRequest, resp *resource.MetadataResponse) {`
`401`	`401`	`resp.TypeName = "test_list_resource2"`
`402`	`402`	`},`
`403`	`403`	`}`
Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,7 @@ func TestServerListResource(t *testing.T) {`
`118`	`118`	`}`
`119`	`119`	`resp.Results = slices.Values(results)`
`120`	`120`	`},`
`121`		`- MetadataMethod: func(ctx context.Context, req list.MetadataRequest, resp *list.MetadataResponse) {`
	`121`	`+ MetadataMethod: func(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {`
`122`	`122`	`resp.TypeName = "test_resource"`
`123`	`123`	`},`
`124`	`124`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ type ComputeInstanceWithListResourceConfigValidators struct {`
`26`	`26`	`func (c ComputeInstanceResource) Configure(_ context.Context, _ resource.ConfigureRequest, _ resource.ConfigureResponse) {`
`27`	`27`	`}`
`28`	`28`
`29`		`-func (c ComputeInstanceResource) Metadata(_ context.Context, _ list.MetadataRequest, _ list.MetadataResponse) {`
	`29`	`+func (c ComputeInstanceResource) Metadata(_ context.Context, _ resource.MetadataRequest, _ resource.MetadataResponse) {`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`func (c ComputeInstanceWithValidateListResourceConfig) ValidateListResourceConfig(_ context.Context, _ list.ValidateConfigRequest, _ list.ValidateConfigResponse) {`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,3 @@ func (NoOpResource) Update(_ context.Context, _ resource.UpdateRequest, _ reso`
`25`	`25`
`26`	`26`	`func (NoOpResource) Delete(_ context.Context, _ resource.DeleteRequest, _ resource.DeleteResponse) {`
`27`	`27`	`}`
`28`		`-`
`29`		`-func (NoOpResource) Metadata(_ context.Context, _ resource.MetadataRequest, _ resource.MetadataResponse) {`
`30`		`-}`