fwserver: add list resources to GetMetadata

Author: bbasata

internal/fwserver/server.go

@@ -14,6 +14,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/function"
 	"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
 	"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"
 )
@@ -172,6 +173,20 @@ type Server struct {
 	// Provider.Resources() method.
 	resourceFuncs map[string]func() resource.Resource
 
+	// listResourceFuncs is the cached Resource List functions for RPCs that need to
+	// access resource lists. If not found, it will be fetched from the
+	// Provider.ListResources() method.
+	listResourceFuncs map[string]func() list.ListResource
+
+	// listResourceTypesDiags is the cached Diagnostics obtained while populating
+	// listResourceTypes. This is to ensure any warnings or errors are also
+	// returned appropriately when fetching listResourceTypes.
+	listResourceTypesDiags diag.Diagnostics
+
+	// listResourceTypesMutex is a mutex to protect concurrent listResourceTypes
+	// access from race conditions.
+	listResourceTypesMutex sync.Mutex
+
 	// resourceTypesDiags is the cached Diagnostics obtained while populating
 	// resourceTypes. This is to ensure any warnings or errors are also
 	// returned appropriately when fetching resourceTypes.

internal/fwserver/server_getmetadata.go

@@ -20,6 +20,7 @@ type GetMetadataResponse struct {
 	Diagnostics        diag.Diagnostics
 	EphemeralResources []EphemeralResourceMetadata
 	Functions          []FunctionMetadata
+	ListResources      []ListResourceMetadata
 	Resources          []ResourceMetadata
 	ServerCapabilities *ServerCapabilities
 }
@@ -52,28 +53,39 @@ type ResourceMetadata struct {
 	TypeName string
 }
 
+// ListResourceMetadata is the framework server equivalent of the
+// tfprotov5.ListResourceMetadata and tfprotov6.ListResourceMetadata types.
+type ListResourceMetadata struct {
+	// TypeName is the name of the list resource.
+	TypeName string
+}
+
 // GetMetadata implements the framework server GetMetadata RPC.
 func (s *Server) GetMetadata(ctx context.Context, req *GetMetadataRequest, resp *GetMetadataResponse) {
 	resp.DataSources = []DataSourceMetadata{}
 	resp.EphemeralResources = []EphemeralResourceMetadata{}
 	resp.Functions = []FunctionMetadata{}
+	resp.ListResources = []ListResourceMetadata{}
 	resp.Resources = []ResourceMetadata{}
+
 	resp.ServerCapabilities = s.ServerCapabilities()
 
 	datasourceMetadatas, diags := s.DataSourceMetadatas(ctx)
-
 	resp.Diagnostics.Append(diags...)
 
 	ephemeralResourceMetadatas, diags := s.EphemeralResourceMetadatas(ctx)
-
 	resp.Diagnostics.Append(diags...)
 
 	functionMetadatas, diags := s.FunctionMetadatas(ctx)
-
 	resp.Diagnostics.Append(diags...)
 
 	resourceMetadatas, diags := s.ResourceMetadatas(ctx)
+	resp.Diagnostics.Append(diags...)
 
+	// Metadata for list resources must be retrieved after metadata for managed
+	// resources. Server.ListResourceMetadatas checks that each list resource
+	// type nane matches a known managed Resource type name.
+	listResourceMetadatas, diags := s.ListResourceMetadatas(ctx)
 	resp.Diagnostics.Append(diags...)
 
 	if resp.Diagnostics.HasError() {
@@ -83,5 +95,6 @@ func (s *Server) GetMetadata(ctx context.Context, req *GetMetadataRequest, resp
 	resp.DataSources = datasourceMetadatas
 	resp.EphemeralResources = ephemeralResourceMetadatas
 	resp.Functions = functionMetadatas
+	resp.ListResources = listResourceMetadatas
 	resp.Resources = resourceMetadatas
 }