Add clarification for nil check of ProviderData in data source and re…

…source Configure() method (#951)
hashicorp · Mar 13, 2024 · d88ef0e · d88ef0e
1 parent c2c3dda
commit d88ef0e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/website/docs/plugin/framework/data-sources/configure.mdx b/website/docs/plugin/framework/data-sources/configure.mdx
@@ -66,7 +66,8 @@ type ThingDataSource struct {
 }
 
 func (d *ThingDataSource) Configure(ctx context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
-  // Prevent panic if the provider has not been configured.
+  // A nil check should always be performed when handling ProviderData as it
+  // is only set after the ConfigureProvider RPC has been called by Terraform.
   if req.ProviderData == nil {
     return
   }

diff --git a/website/docs/plugin/framework/resources/configure.mdx b/website/docs/plugin/framework/resources/configure.mdx
@@ -66,7 +66,8 @@ type ThingResource struct {
 }
 
 func (r *ThingResource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) {
-  // Prevent panic if the provider has not been configured.
+  // A nil check should always be performed when handling ProviderData as it
+  // is only set after the ConfigureProvider RPC has been called by Terraform.
   if req.ProviderData == nil {
     return
   }