bicep: Support @sealed() decorator on user defined types#4684
Merged
Conversation
When the `@sealed()` decorator is applied on user defined types, it causes an `additionalProperties: false` property to be added to the type defintition in the generated arm deployment. Our unmarshalling logic did not understand this pattern and so it would cause an error when trying to unmarshall this, since it expected if `additionalProperties` was set, it would be to set to an object that described information about the additional properties. I've updated the marshalling code to support `false` as a valid value for the additional properties node when parsing an ARM template. Since Go doesn't have great support for modeling descrimited unions, the new `ArmTemplateParameterAdditionalPropertiesValue` type is used to provide the logcal descrimited union of `false` or a object like value. Fixes Azure#4659
ellismg
requested review from
JeffreyCA,
hemarina,
vhvb1989,
wbreza and
weikanglim
as code owners
January 9, 2025 22:57
1 task
ellismg
commented
Jan 9, 2025
ellismg
left a comment
ellismg
left a comment
Member
Author
There was a problem hiding this comment.
You have more context in this part of the code than I do, @vhvb1989, so you'll have a better sense of if I did the right thing here or not.
I'm not sure if there's a case where they can emit additionalProperties as true (I think this is allowed by JSON Schema, but I'm not sure if bicep ever emits this), but it wasn't clear exactly to me what we should do when AdditionalProperties was true. I think in practice we don't have to analyze this part of the document, just make sure as we transform it we keep the text the user provided. I could imagine changing ArmTemplateParameterAdditionalPropertiesValue to also have a *bool field, with the idea that either it or the *ArmTemplateParameterAdditionalPropertiesProperties is always set (the bool is set to true or false if it was in the document, otherwise the value was an object and the props field is set), and we also modify MarshalJSON to emit true when needed.
Collaborator
Azure Dev CLI Install InstructionsInstall scriptsMacOS/Linux
bash: pwsh: WindowsPowerShell install MSI install Standalone Binary
MSI
Documentationlearn.microsoft.com documentationtitle: Azure Developer CLI reference
|
Menghua1
pushed a commit
to Yionse/azure-dev
that referenced
this pull request
Jan 24, 2025
When the `@sealed()` decorator is applied on user defined types, it causes an `additionalProperties: false` property to be added to the type defintition in the generated arm deployment. Our unmarshalling logic did not understand this pattern and so it would cause an error when trying to unmarshall this, since it expected if `additionalProperties` was set, it would be to set to an object that described information about the additional properties. I've updated the marshalling code to support `false` as a valid value for the additional properties node when parsing an ARM template. Since Go doesn't have great support for modeling descrimited unions, the new `ArmTemplateParameterAdditionalPropertiesValue` type is used to provide the logcal descrimited union of `false` or a object like value. Fixes Azure#4659
14 tasks
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
4 participants
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.
When the
@sealed()decorator is applied on user defined types, it causes anadditionalProperties: falseproperty to be added to the type defintition in the generated arm deployment. Our unmarshalling logic did not understand this pattern and so it would cause an error when trying to unmarshall this, since it expected ifadditionalPropertieswas set, it would be to set to an object that described information about the additional properties.I've updated the marshalling code to support
falseas a valid value for the additional properties node when parsing an ARM template. Since Go doesn't have great support for modeling descrimited unions, the newArmTemplateParameterAdditionalPropertiesValuetype is used to provide the logcal descrimited union offalseor a object like value.Fixes #4659