Specify in the documentation of timeout the import path

[remyleone]

Could you specify the imports path for different package that are used in documentation:

https://github.com/hashicorp/terraform-plugin-framework/blob/main/website/docs/plugin/framework/resources/timeouts.mdx

https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework-timeouts/datasource/timeouts

I'm not sure if it is the correct one. Also why is it not in the main terraform-plugin-framework package ?

[bflad]

Also why is it not in the main terraform-plugin-framework package ?

The timeouts handling is no longer included with the SDK because a design goal with this Go module is to ensure that only core provider development functionality is included and subsequently controlled by the same versioning. For example, the terraform-plugin-framework-validators Go module is separate so it can be potentially released with breaking changes (e.g. due to more subjective reasons) without affecting all consumers of this Go module. Over time, this stance may change and the code may become introduced into this Go module as we gain confidence with these "satellite" pieces of framework functionality.

Timeouts in particular are an interesting piece of provider development history. We have found that numerous occasions that practitioner-configurable timeouts were arbitrarily being added to resources when not strictly necessary. While they can provide a really rough escape hatch in certain problematic API situations, having an arbitrarily short time restriction on an infrastructure operation can give practitioners more headaches -- an error where the operation would have eventually succeeded, then requiring manual triage and remediation. Your mileage may vary of course, which is why the functionality is still offered, but outside the "core" framework.

[bflad]

To answer your first question, it depends where the timeout functionality is destined for:

• Resource: github.com/hashicorp/terraform-plugin-framework-timeouts/resource/timeouts
• Data Source: github.com/hashicorp/terraform-plugin-framework-timeouts/datasource/timeouts

The Go compiler should give an error if you try to do it wrong though.

[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.