tfsdk: Consider Deprecating ServeOpts Name Field In Preference of Address Field

[bflad]

Module version

v0.6.1

Use-cases

The framework currently has a ServeOpts type Name field, which is documented as:

	// Name is the name of the provider, in full address form. For example:
	// registry.terraform.io/hashicorp/random.
	Name string

This mismatch between a provider name (typically the last part of a full provider address) and a provider address is understandably confusing for provider developers, who may gloss over the field documentation given the field name. When only the name is provided here, this can have non-obvious downstream consequences such as not being able to attach debuggers since the reattach configuration will never have a provider address that matches.

Attempted Solutions

Go documentation. Having the full provider address as an example for the field in the scaffolding provider.

Proposal

• Add ServeOpts type Address field. Add logic in Serve which validates that Address is a full provider address.
• Where Name is used, prefer Address if not empty instead. If for some reason the provider name (type) is actually necessary, then pare down the address value to just the name.
• Deprecate the ServeOpts type Name field, recommending Address instead. Remove it in minor+1 version before 1.0.

References

• Unable to use debugger #286

[github-actions]

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