Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

internal/fwserver - Fix DataSource/Resource Type Not Found errors when GetProviderSchema is not called #852

Merged
merged 4 commits into from
Oct 9, 2023
Merged

internal/fwserver - Fix DataSource/Resource Type Not Found errors when GetProviderSchema is not called #852

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4deabdc
initial fix for provider type name
austinvalle Oct 6, 2023
f147a4e
introduce provider name mutex
austinvalle Oct 6, 2023
8a47174
add changelog entries
austinvalle Oct 6, 2023
4a11126
fix changelog to be more user-friendly
austinvalle Oct 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changes/unreleased/BUG FIXES-20231006-163235.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: BUG FIXES
body: 'internal/fwserver: Fix `Data Source Type Not Found` errors when `GetProviderSchema`
austinvalle marked this conversation as resolved.
Show resolved Hide resolved
is not called'
time: 2023-10-06T16:32:35.47541-04:00
custom:
Issue: "853"
6 changes: 6 additions & 0 deletions .changes/unreleased/BUG FIXES-20231006-163300.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: BUG FIXES
body: 'internal/fwserver: Fix `Resource Type Not Found` errors when `GetProviderSchema`
is not called'
time: 2023-10-06T16:33:00.557415-04:00
custom:
Issue: "853"
36 changes: 32 additions & 4 deletions internal/fwserver/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,14 @@ type Server struct {
// access from race conditions.
providerMetaSchemaMutex sync.Mutex

// providerTypeName is the type name of the provider, if the provider
// implemented the Metadata method.
// providerTypeName is the cached type name of the provider, if the provider
// implemented the Metadata method. Access this field with the Provider.ProviderTypeName() method.
providerTypeName string

// providerTypeNameMutex is a mutex to protect concurrent providerTypeName
// access from race conditions.
providerTypeNameMutex sync.Mutex

// resourceSchemas is the cached Resource Schemas for RPCs that need to
// convert configuration data from the protocol. If not found, it will be
// fetched from the ResourceType.GetSchema() method.
Expand Down Expand Up @@ -140,6 +144,7 @@ func (s *Server) DataSourceFuncs(ctx context.Context) (map[string]func() datasou
return s.dataSourceFuncs, s.dataSourceTypesDiags
}

providerTypeName := s.ProviderTypeName(ctx)
s.dataSourceFuncs = make(map[string]func() datasource.DataSource)

logging.FrameworkTrace(ctx, "Calling provider defined Provider DataSources")
Expand All @@ -150,7 +155,7 @@ func (s *Server) DataSourceFuncs(ctx context.Context) (map[string]func() datasou
dataSource := dataSourceFunc()

dataSourceTypeNameReq := datasource.MetadataRequest{
ProviderTypeName: s.providerTypeName,
ProviderTypeName: providerTypeName,
}
dataSourceTypeNameResp := datasource.MetadataResponse{}

Expand Down Expand Up @@ -285,6 +290,28 @@ func (s *Server) DataSourceSchemas(ctx context.Context) (map[string]fwschema.Sch
return dataSourceSchemas, diags
}

// ProviderTypeName returns the TypeName associated with the Provider. The TypeName is cached on first use.
func (s *Server) ProviderTypeName(ctx context.Context) string {
austinvalle marked this conversation as resolved.
Show resolved Hide resolved
logging.FrameworkTrace(ctx, "Checking ProviderTypeName lock")
s.providerTypeNameMutex.Lock()
defer s.providerTypeNameMutex.Unlock()

if s.providerTypeName != "" {
return s.providerTypeName
}

metadataReq := provider.MetadataRequest{}
metadataResp := provider.MetadataResponse{}

logging.FrameworkTrace(ctx, "Calling provider defined Provider Metadata")
s.Provider.Metadata(ctx, metadataReq, &metadataResp)
logging.FrameworkTrace(ctx, "Called provider defined Provider Metadata")

s.providerTypeName = metadataResp.TypeName

return s.providerTypeName
}

// ProviderSchema returns the Schema associated with the Provider. The Schema
// and Diagnostics are cached on first use.
func (s *Server) ProviderSchema(ctx context.Context) (fwschema.Schema, diag.Diagnostics) {
Expand Down Expand Up @@ -374,6 +401,7 @@ func (s *Server) ResourceFuncs(ctx context.Context) (map[string]func() resource.
return s.resourceFuncs, s.resourceTypesDiags
}

providerTypeName := s.ProviderTypeName(ctx)
s.resourceFuncs = make(map[string]func() resource.Resource)

logging.FrameworkTrace(ctx, "Calling provider defined Provider Resources")
Expand All @@ -384,7 +412,7 @@ func (s *Server) ResourceFuncs(ctx context.Context) (map[string]func() resource.
res := resourceFunc()

resourceTypeNameReq := resource.MetadataRequest{
ProviderTypeName: s.providerTypeName,
ProviderTypeName: providerTypeName,
}
resourceTypeNameResp := resource.MetadataResponse{}

Expand Down
11 changes: 0 additions & 11 deletions internal/fwserver/server_getmetadata.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ import (
"context"

"github.com/hashicorp/terraform-plugin-framework/diag"
"github.com/hashicorp/terraform-plugin-framework/internal/logging"
"github.com/hashicorp/terraform-plugin-framework/provider"
)

// GetMetadataRequest is the framework server request for the
Expand Down Expand Up @@ -44,15 +42,6 @@ func (s *Server) GetMetadata(ctx context.Context, req *GetMetadataRequest, resp
resp.Resources = []ResourceMetadata{}
resp.ServerCapabilities = s.ServerCapabilities()

metadataReq := provider.MetadataRequest{}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we call s.ProviderTypeName() to set providerTypeName in order to preserve original behaviour?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also wondered this, it felt weird to make the call here to populate a cache used somewhere else. If we do want to preserve this, we could maybe change the naming up:

s.SetProviderTypeName()

But I went for the "lazy-load" approach 😆

Copy link
Member Author

@austinvalle austinvalle Oct 6, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a clarification, the overall behavior of GetMetadata + GetProviderSchema is still preserved as there already exists a test for this:

terraform-plugin-framework/internal/fwserver/server_getmetadata_test.go

Line 156 in f147a4e

"datasources-provider-type-name": {

The implementation detail has just been moved closer to where it's needed for the other RPCs to consume as well 👍🏻

An alternative approach could be to set s.ProviderTypeName() at the top of every RPC

metadataResp := provider.MetadataResponse{}

logging.FrameworkTrace(ctx, "Calling provider defined Provider Metadata")
s.Provider.Metadata(ctx, metadataReq, &metadataResp)
logging.FrameworkTrace(ctx, "Called provider defined Provider Metadata")

s.providerTypeName = metadataResp.TypeName

datasourceMetadatas, diags := s.DataSourceMetadatas(ctx)

resp.Diagnostics.Append(diags...)
Expand Down
11 changes: 0 additions & 11 deletions internal/fwserver/server_getproviderschema.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ import (

"github.com/hashicorp/terraform-plugin-framework/diag"
"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
"github.com/hashicorp/terraform-plugin-framework/internal/logging"
"github.com/hashicorp/terraform-plugin-framework/provider"
)

// GetProviderSchemaRequest is the framework server request for the
Expand All @@ -31,15 +29,6 @@ type GetProviderSchemaResponse struct {
func (s *Server) GetProviderSchema(ctx context.Context, req *GetProviderSchemaRequest, resp *GetProviderSchemaResponse) {
resp.ServerCapabilities = s.ServerCapabilities()

metadataReq := provider.MetadataRequest{}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we call s.ProviderTypeName() to set providerTypeName in order to preserve original behaviour?

metadataResp := provider.MetadataResponse{}

logging.FrameworkTrace(ctx, "Calling provider defined Provider Metadata")
s.Provider.Metadata(ctx, metadataReq, &metadataResp)
logging.FrameworkTrace(ctx, "Called provider defined Provider Metadata")

s.providerTypeName = metadataResp.TypeName

providerSchema, diags := s.ProviderSchema(ctx)

resp.Diagnostics.Append(diags...)
Expand Down
32 changes: 26 additions & 6 deletions internal/proto5server/server_getproviderschema_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -527,32 +527,37 @@ func TestServerGetProviderSchema_logging(t *testing.T) {
expectedEntries := []map[string]interface{}{
{
"@level": "trace",
"@message": "Calling provider defined Provider Metadata",
"@message": "Checking ProviderSchema lock",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Called provider defined Provider Metadata",
"@message": "Calling provider defined Provider Schema",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Checking ProviderSchema lock",
"@message": "Called provider defined Provider Schema",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Calling provider defined Provider Schema",
"@message": "Checking ResourceTypes lock",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Called provider defined Provider Schema",
"@message": "Checking ProviderTypeName lock",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Checking ResourceTypes lock",
"@message": "Calling provider defined Provider Metadata",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Called provider defined Provider Metadata",
"@module": "sdk.framework",
},
{
Expand All @@ -570,6 +575,21 @@ func TestServerGetProviderSchema_logging(t *testing.T) {
"@message": "Checking DataSourceTypes lock",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Checking ProviderTypeName lock",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Calling provider defined Provider Metadata",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Called provider defined Provider Metadata",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Calling provider defined Provider DataSources",
Expand Down
32 changes: 26 additions & 6 deletions internal/proto6server/server_getproviderschema_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -527,32 +527,37 @@ func TestServerGetProviderSchema_logging(t *testing.T) {
expectedEntries := []map[string]interface{}{
{
"@level": "trace",
"@message": "Calling provider defined Provider Metadata",
"@message": "Checking ProviderSchema lock",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Called provider defined Provider Metadata",
"@message": "Calling provider defined Provider Schema",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Checking ProviderSchema lock",
"@message": "Called provider defined Provider Schema",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Calling provider defined Provider Schema",
"@message": "Checking ResourceTypes lock",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Called provider defined Provider Schema",
"@message": "Checking ProviderTypeName lock",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Checking ResourceTypes lock",
"@message": "Calling provider defined Provider Metadata",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Called provider defined Provider Metadata",
"@module": "sdk.framework",
},
{
Expand All @@ -570,6 +575,21 @@ func TestServerGetProviderSchema_logging(t *testing.T) {
"@message": "Checking DataSourceTypes lock",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Checking ProviderTypeName lock",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Calling provider defined Provider Metadata",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Called provider defined Provider Metadata",
"@module": "sdk.framework",
},
{
"@level": "trace",
"@message": "Calling provider defined Provider DataSources",
Expand Down
Loading