provider timeouts #19222
provider timeouts #19222
Conversation
Resource timeouts were a separate config block, but did not exist in the resource schema. Insert any defined timeouts when generating the configshema.Block so that the fields can be accepted and validated by core.
helper/schema will remove "timeouts" from the config, and stash them in the diff.Meta map. Terraform sees "timeouts" as a regular config block, so needs them to be present in the state in order to not show a diff. Have the GRPCProviderServer shim copy all timeout values into any state it returns to provide consistent diffs in core.
jbardin
force-pushed
the
jbardin/timeout
branch
from
7e59e12
to
e38a5a7
Compare
helper/schema/core_schema.go
Outdated
| @@ -172,6 +172,53 @@ func (r *Resource) CoreConfigSchema() *configschema.Block { | |||
| } | |||
| } | |||
|
|
|||
| // insert configured timeout values into the schema | |||
| if r.Timeouts != nil { | |||
There was a problem hiding this comment.
Ahh, I like that it's possible to leave this out of the schema in the common case where it's not used. I was worried initially that we'd have a redundant extra timeouts thing in every schema!
helper/schema/core_schema.go
Outdated
| } | ||
| } | ||
|
|
||
| block.BlockTypes["timeouts"] = &configschema.NestedBlock{ |
There was a problem hiding this comment.
Is there already an InternalValidate step somewhere that prohibits a resource schema from containing a normal attribute called timeouts? Not absolutely required right now of course, since any existing one like that would already be broken in some sense, but given that this feature is not well-known I worry that provider developers might try it in future and get confused about the weird behavior that will inevitably result, particularly if they define timeouts as something that ends up in block.Attributes and so it'd actually be in both maps. 😱
There was a problem hiding this comment.
Now that you mention it, I think I'll add a check that this isn't overriding a timeouts block or attribute. This would probably leave it closer to the original behavior.
Don't overwrite anything the provider defined, in order to maintain existing behavior. Change strings to pre-defined constants
|
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. |
ghost
locked and limited conversation to collaborators
Resource timeouts were a separate config block, but did not exist in the
resource schema. Insert any defined timeouts when generating the
configshema.Block so that the fields can be accepted and validated by
core.
helper/schema will remove "timeouts" from the config, and stash them in
the diff.Meta map. Terraform sees "timeouts" as a regular config block,
so needs them to be present in the state in order to not show a diff.
Have the GRPCProviderServer shim copy all timeout values into any state
it returns to provide consistent diffs in core.