further clean up

Author: stephybun

internal/fwschemadata/data_set.go

@@ -6,11 +6,11 @@ package fwschemadata
 import (
 	"context"
 	"fmt"
-	"github.com/hashicorp/terraform-plugin-go/tftypes"
 
 	"github.com/hashicorp/terraform-plugin-framework/diag"
 	"github.com/hashicorp/terraform-plugin-framework/internal/reflect"
 	"github.com/hashicorp/terraform-plugin-framework/path"
+	"github.com/hashicorp/terraform-plugin-go/tftypes"
 )
 
 // Set replaces the entire value. The value can be a tftypes.Value or a struct whose fields

internal/fwserver/server_getmetadata_test.go

@@ -839,6 +839,7 @@ func TestServerGetMetadata(t *testing.T) {
 					diag.NewErrorDiagnostic(
 						"ListResource Type Defined without a Matching Managed Resource Type",
 						"The test_resource_1 ListResource type name was returned, but no matching managed Resource type was defined. "+
+							"If the matching managed Resource type is a legacy resource, ProtoV5Schema and ProtoV5IdentitySchema must be specified in the Metadata method. "+
 							"This is always an issue with the provider and should be reported to the provider developers.",
 					),
 				},

internal/fwserver/server_listresource.go

@@ -13,7 +13,6 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/list"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
-	"github.com/hashicorp/terraform-plugin-go/tfprotov5"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
 )
 
@@ -50,8 +49,6 @@ type ListResultsStream struct {
 	// Results is a function that emits [ListResult] values via its push
 	// function argument.
 	Results iter.Seq[ListResult]
-
-	ResultsProtoV5 iter.Seq[tfprotov5.ListResourceResult]
 }
 
 func ListResultError(summary string, detail string) ListResult {
@@ -62,18 +59,6 @@ func ListResultError(summary string, detail string) ListResult {
 	}
 }
 
-func ListResultErrorProto5(summary string, detail string) tfprotov5.ListResourceResult {
-	return tfprotov5.ListResourceResult{
-		Diagnostics: []*tfprotov5.Diagnostic{
-			{
-				Severity: 1,
-				Summary:  summary,
-				Detail:   detail,
-			},
-		},
-	}
-}
-
 // ListResult represents a listed managed resource instance.
 type ListResult struct {
 	// Identity is the identity of the managed resource instance. A nil value
@@ -121,8 +106,6 @@ func (s *Server) ListResource(ctx context.Context, fwReq *ListRequest, fwStream
 	if listResourceWithConfigure, ok := listResource.(list.ListResourceWithConfigure); ok {
 		logging.FrameworkTrace(ctx, "ListResource implements ListResourceWithConfigure")
 
-		// ListResourceConfigureData isn't populated in the ConfigureProvider RPC
-		// We can use ResourceConfigureData here for now or populate ListResourceConfigureData
 		configureReq := resource.ConfigureRequest{
 			ProviderData: s.ListResourceConfigureData,
 		}

internal/fwserver/server_listresources.go

@@ -87,11 +87,11 @@ func (s *Server) ListResourceFuncs(ctx context.Context) (map[string]func() list.
 
 		resourceFuncs, _ := s.ResourceFuncs(ctx)
 		if _, ok := resourceFuncs[typeName]; !ok {
-			// TODO update error message
 			if metadataResp.ProtoV5Schema == nil || metadataResp.ProtoV5IdentitySchema == nil {
 				s.listResourceFuncsDiags.AddError(
 					"ListResource Type Defined without a Matching Managed Resource Type",
 					fmt.Sprintf("The %s ListResource type name was returned, but no matching managed Resource type was defined. ", typeName)+
+						"If the matching managed Resource type is a legacy resource, ProtoV5Schema and ProtoV5IdentitySchema must be specified in the Metadata method. "+
 						"This is always an issue with the provider and should be reported to the provider developers.",
 				)
 				continue

internal/proto5server/server_listresource.go

@@ -58,7 +58,7 @@ func (s *Server) ListResource(ctx context.Context, protoReq *tfprotov5.ListResou
 		Limit:           protoReq.Limit,
 	}
 
-	// There's validation in xxx that ensures both are set if either is provided so perhaps it's sufficient to only nil check Identity
+	// There's validation in ListResources that ensures both are set if either is provided so it should be sufficient to only nil check Identity
 	if metadataResp.ProtoV5IdentitySchema != nil {
 		req.ResourceSchema, _ = fromproto5.ResourceSchema(ctx, metadataResp.ProtoV5Schema())
 		req.ResourceIdentitySchema, _ = fromproto5.IdentitySchema(ctx, metadataResp.ProtoV5IdentitySchema())

list/metadata.go

@@ -3,8 +3,6 @@
 
 package list
 
-import "github.com/hashicorp/terraform-plugin-go/tfprotov5"
-
 // MetadataRequest represents a request for the ListResource to return metadata,
 // such as its type name. An instance of this request struct is supplied as
 // an argument to the ListResource type Metadata method.
@@ -23,9 +21,4 @@ type MetadataResponse struct {
 	// TypeName should be the full list resource type, including the provider
 	// type prefix and an underscore. For example, examplecloud_thing.
 	TypeName string
-
-	// Could this also live in the Schema instead? Should it?
-	// If it's here we can do validation
-	ProtoV5Schema         func() *tfprotov5.Schema
-	ProtoV5IdentitySchema func() *tfprotov5.ResourceIdentitySchema
 }

resource/metadata.go

@@ -28,8 +28,15 @@ type MetadataResponse struct {
 	// interacting with this resource.
 	ResourceBehavior ResourceBehavior
 
-	ProtoV5Schema         func() *tfprotov5.Schema
+	// ProtoV5IdentitySchema is the ProtoV5 representation of the resource identity
+	// schema. This should only be supplied if framework functionality is being used
+	// with a legacy resource. Currently, this only applies to list.
 	ProtoV5IdentitySchema func() *tfprotov5.ResourceIdentitySchema
+
+	// ProtoV5Schema is the ProtoV5 representation of the resource schema
+	// This should only be supplied if framework functionality is being used
+	// with a legacy resource. Currently, this only applies to list.
+	ProtoV5Schema func() *tfprotov5.Schema
 }
 
 // ResourceBehavior controls framework-specific logic when interacting