Add default values

[jkroepke]

Terraform CLI and Framework Versions

Terraform v1.8.1
on darwin_amd64

github.com/hashicorp/terraform-plugin-framework

Use Cases or Problem Statement

Provide default values on timeouts.BlockAll and timeouts.Block.

While it's possible to define a reasonable default inside the operation method, it's missing as part of the documentation.

Passing the default values earlier would result into better end-user documentation by default.

Proposal

timeouts.BlockAllWithDefaults(ctx, map[string]time.Duration{
  "create": 5 * time.Minute,
  "read": 5 * time.Minute,
  "update": 5 * time.Minute,
  "delete": 5 * time.Minute,
})

Additional Information

I'm aware thats currently possible with custom description, however such functions would enrich the developer experience with an work out of the box scenario.

Code of Conduct

• I agree to follow this project's Code of Conduct

[bflad]

Hi @jkroepke 👋 Thank you for submitting this. It seems very reasonable for this Go module to implement those sort of details to make the development experience better. If I recall, this Go module was developed before the framework supported attribute-based default values (~v1.2.0 IIRC), which is why this might not have been done before.

Some considerations we'll need to work through:

• Whether we should instead extend the existing options types with this sort of information, e.g. https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework-timeouts@v0.4.1/resource/timeouts#Opts -- it feels like it might be less than ideal to continually introduce specialized constructor functions for each individual feature this Go module offers, since for example with the proposed BlockAllWithDefaults(), there is no way to customize the attribute descriptions.
• Whether the attribute description should automatically have words added about the default duration and what those words should be. I think we would also want to ensure that a custom description should never be overwritten or changed, but it is a design decision.
• What should the configuration reading methods looks like after this sort of enhancement? Currently they look like https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework-timeouts@v0.4.1/resource/timeouts#Value.Create with a default timeout function parameter.
• What to do with datasource schemas, since they do not implement default value support. It might be fair and okay to only implement this for managed resources, but I have to mention it since it will likely mean there is a difference in functionality between the two resource types.

If you have opinions on any of these, it would be great to hear them. 👍 Thanks again!