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

austinvalle · 2023-10-06T12:58:30Z

Closes #853

Terraform 1.6 no longer calls GetProviderSchema before any of the other RPCs, which currently populates s.providerTypeName. Without this populated, data sources + resources are added to their respective caches without the provider prefix, i.e. _thing instead of the correct examplecloud_thing, resulting in a confusing Not Found error.

Notes

Unfortunately, this can't be recreated easily in CI because terraform-plugin-testing manages the plugin processes similar to debug mode, so the plugin keeps the provider running, whereas terraform core does not. Therefore, during a test run, s.providerTypeName happens to be populated due to a prior GetProviderSchema call populating it.

See: https://developer.hashicorp.com/terraform/plugin/debugging#debugging-caveats

bendbennett

Looks good.
Just a couple of minor comments.

internal/fwserver/server.go

bendbennett · 2023-10-06T13:22:12Z

internal/fwserver/server_getmetadata.go

@@ -44,15 +42,6 @@ func (s *Server) GetMetadata(ctx context.Context, req *GetMetadataRequest, resp
 	resp.Resources = []ResourceMetadata{}
 	resp.ServerCapabilities = s.ServerCapabilities()

-	metadataReq := provider.MetadataRequest{}


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

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 😆

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

bendbennett · 2023-10-06T13:22:22Z

internal/fwserver/server_getproviderschema.go

@@ -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{}


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

austinvalle · 2023-10-06T20:51:07Z

I'm not sure the best way to add a CI test for this functionality (due to the way this bug is exposed), any suggestions for improving the test coverage of this is appreciated.

I'm just been running manual tests with a sandbox provider comparing v1.4.0 to the latest commit of this PR 8a47174.

Before

 $ go list -m github.com/hashicorp/terraform-plugin-framework/...
github.com/hashicorp/terraform-plugin-framework v1.4.0

 $ terraform1.6 -chdir=examples/resources apply -auto-approve    
╷
│ Warning: Provider development overrides are in effect
│ 
│ The following provider development overrides are set in the CLI configuration:
│  - austinvalle/sandbox in /Users/austin.valle/go/bin
│ 
│ The behavior may therefore not match any released version of the provider and applying changes may
│ cause the state to become incompatible with published releases.
╵
╷
│ Error: Resource Type Not Found
│ 
│   with examplecloud_thing.this,
│   on resource.tf line 8, in resource "examplecloud_thing" "this":
│    8: resource "examplecloud_thing" "this" {
│ 
│ No resource type named "examplecloud_thing" was found in the provider.
╵
╷
│ Error: Data Source Type Not Found
│ 
│   with data.examplecloud_thing.this,
│   on resource.tf line 12, in data "examplecloud_thing" "this":
│   12: data "examplecloud_thing" "this" {
│ 
│ No data source type named "examplecloud_thing" was found in the provider.
╵

After

 $ go get -u github.com/hashicorp/terraform-plugin-framework@8a471749f9833cc8e7bb0355d436a23782e1c9a4
go: upgraded github.com/hashicorp/terraform-plugin-framework v1.4.0 => v1.4.1-0.20231006203353-8a471749f983

 $ go mod tidy

 $ go install .

 $ terraform1.6 -chdir=examples/resources apply -auto-approve 
╷
│ Warning: Provider development overrides are in effect
│ 
│ The following provider development overrides are set in the CLI configuration:
│  - austinvalle/sandbox in /Users/austin.valle/go/bin
│ 
│ The behavior may therefore not match any released version of the provider and applying changes may
│ cause the state to become incompatible with published releases.
╵
data.examplecloud_thing.this: Reading...
examplecloud_thing.this: Refreshing state...
data.examplecloud_thing.this: Read complete after 0s

No changes. Your infrastructure matches the configuration.

Terraform has compared your real infrastructure against your configuration and found no differences, so
no changes are needed.

Apply complete! Resources: 0 added, 0 changed, 0 destroyed.

bflad

Looks good to me 🚀

.changes/unreleased/BUG FIXES-20231006-163235.yaml

github-actions · 2023-11-09T02:03:53Z

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

initial fix for provider type name

4deabdc

bendbennett reviewed Oct 6, 2023

View reviewed changes

introduce provider name mutex

f147a4e

austinvalle changed the title ~~(WIP) - Fix DataSource/Resource Type Not Found errors in Terraform 1.6~~ internal/fwserver - Fix DataSource/Resource Type Not Found errors in Terraform 1.6 Oct 6, 2023

austinvalle changed the title ~~internal/fwserver - Fix DataSource/Resource Type Not Found errors in Terraform 1.6~~ internal/fwserver - Fix DataSource/Resource Type Not Found errors when GetProviderSchema is not called Oct 6, 2023

add changelog entries

8a47174

austinvalle marked this pull request as ready for review October 6, 2023 21:01

austinvalle requested a review from a team as a code owner October 6, 2023 21:01

austinvalle added this to the v1.4.1 milestone Oct 6, 2023

bflad added the bug Something isn't working label Oct 9, 2023

bflad approved these changes Oct 9, 2023

View reviewed changes

.changes/unreleased/BUG FIXES-20231006-163235.yaml Outdated Show resolved Hide resolved

fix changelog to be more user-friendly

4a11126

austinvalle merged commit f5a990a into main Oct 9, 2023
21 checks passed

austinvalle deleted the av/fix-provider-type-name branch October 9, 2023 10:56

ewbankkit mentioned this pull request Oct 10, 2023

Build with terraform-plugin-framework@v1.4.1 hashicorp/terraform-provider-aws#33865

Merged

github-actions bot locked as resolved and limited conversation to collaborators Nov 9, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

austinvalle commented Oct 6, 2023 •

edited

Loading

bendbennett left a comment

bendbennett Oct 6, 2023

austinvalle Oct 6, 2023

austinvalle Oct 6, 2023 •

edited

Loading

bendbennett Oct 6, 2023

austinvalle commented Oct 6, 2023 •

edited

Loading

bflad left a comment

github-actions bot commented Nov 9, 2023

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

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

Conversation

austinvalle commented Oct 6, 2023 • edited Loading

Notes

bendbennett left a comment

Choose a reason for hiding this comment

bendbennett Oct 6, 2023

Choose a reason for hiding this comment

austinvalle Oct 6, 2023

Choose a reason for hiding this comment

austinvalle Oct 6, 2023 • edited Loading

Choose a reason for hiding this comment

bendbennett Oct 6, 2023

Choose a reason for hiding this comment

austinvalle commented Oct 6, 2023 • edited Loading

Before

After

bflad left a comment

Choose a reason for hiding this comment

github-actions bot commented Nov 9, 2023

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

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

austinvalle commented Oct 6, 2023 •

edited

Loading

austinvalle Oct 6, 2023 •

edited

Loading

austinvalle commented Oct 6, 2023 •

edited

Loading