Conversation
TypeString rendered object types but dropped the optional(...) modifier, so its output did not round-trip through TypeConstraint: an optional attribute silently became required when the string was re-parsed. Wrap optional attributes in optional(...). Default values are tracked in the separate Defaults struct rather than in cty.Type, so they aren't available here; optional(type) is valid native syntax and restores the round-trip.
|
Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement Learn more about why HashiCorp requires a CLA and what the CLA includes Have you signed the CLA already but the status is still pending? Recheck it. |
1 similar comment
|
Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement Learn more about why HashiCorp requires a CLA and what the CLA includes Have you signed the CLA already but the status is still pending? Recheck it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
TypeStringrenders object types but drops theoptional(...)modifier, so its output does not round-trip back throughTypeConstraint.The doc comment says the result is rendered "as it would be expected to appear in the HCL native syntax" and that it "produces reasonable results only for types like what would be produced by the
TypeandTypeConstraintfunctions."TypeConstraintdoes produce object types with optional attributes, butTypeStringemits them as plain required attributes:Re-parsing that string gives
AttributeOptional("foo") == false, so an optional attribute silently becomes required.optional(...)parsing was added in 47464b2 butTypeStringwas never updated to render it. This fixes that by wrapping optional attributes inoptional(...). Default values are tracked in the separateDefaultsstruct rather than incty.Type, so they aren't available here;optional(type)is valid native syntax and restores the round-trip.Related Issue
None.
How Has This Been Tested?
Added two cases to
TestTypeString. They fail before the change:and pass after it.
go test ./ext/typeexpr/...,go vet ./ext/typeexpr/..., andgofmt -lare clean. Confirmed the corrected output re-parses:object({a=optional(string)})yieldsAttributeOptional("a") == true.Happy to add a CHANGELOG entry if you'd like one.