Add AdditionalPropertiesDescription property to ObjectType #15990
Conversation
This file contains 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
There was a problem hiding this comment.
Copilot reviewed 5 out of 18 changed files in this pull request and generated no comments.
Files not reviewed (13)
- src/Bicep.Core/TypeSystem/Providers/MicrosoftGraph/MicrosoftGraphResourceTypeProvider.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/ResourceDerivedTypeResolver.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/Providers/ThirdParty/ExtensibilityResourceTypeFactory.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/Providers/ThirdParty/ThirdPartyResourceTypeProvider.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/DeclaredTypeManager.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/Providers/Az/AzResourceTypeFactory.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/Providers/Az/AzResourceTypeProvider.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/Providers/K8s/K8sResourceTypeProvider.cs: Evaluated as low risk
- src/Bicep.LangServer.IntegrationTests/HoverTests.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/Types/NamespaceType.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/TypeValidator.cs: Evaluated as low risk
- src/Bicep.Core.UnitTests/Utils/BuiltInTestTypes.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/TypeHelper.cs: Evaluated as low risk
Comments suppressed due to low confidence (2)
src/Bicep.Core/Emit/CompileTimeImports/ArmDeclarationToExpressionConverter.cs:385
- Ensure that the new behavior of setting
additionalPropertiesDescriptionis covered by tests.
additionalPropertiesDescription: addlProperties?.Description is StringLiteralExpression stringLiteral ? stringLiteral.Value : null),
src/Bicep.Core/Semantics/SymbolHelper.cs:61
- The objectType.AdditionalPropertiesDescription might be null. Ensure that null values are handled appropriately.
return new PropertySymbol("*", objectType.AdditionalPropertiesDescription, objectType.AdditionalPropertiesType.Type);
|
Test this change out locally with the following install scripts (Action run 12657034838) VSCode
Azure CLI
|
Dotnet Test Results 77 files - 38 77 suites - 38 31m 41s ⏱️ - 17m 13s Results for commit b7c1de9. ± Comparison against base commit 73f3473. This pull request removes 1840 and adds 636 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
There was a problem hiding this comment.
Copilot reviewed 6 out of 21 changed files in this pull request and generated no comments.
Files not reviewed (15)
- src/Bicep.Core/TypeSystem/Providers/MicrosoftGraph/MicrosoftGraphResourceTypeProvider.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/Providers/Az/AzResourceTypeFactory.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/Providers/Az/AzResourceTypeProvider.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/Providers/K8s/K8sResourceTypeProvider.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/Providers/ThirdParty/ThirdPartyResourceTypeProvider.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/ArmTemplateTypeLoader.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/DeclaredTypeManager.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/Providers/ThirdParty/ExtensibilityResourceTypeFactory.cs: Evaluated as low risk
- src/Bicep.LangServer.IntegrationTests/HoverTests.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/Types/NamespaceType.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/TypeValidator.cs: Evaluated as low risk
- src/Bicep.Core.UnitTests/Utils/BuiltInTestTypes.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/TypeHelper.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/TypeCollapser.cs: Evaluated as low risk
- src/Bicep.Core/TypeSystem/ResourceDerivedTypeResolver.cs: Evaluated as low risk
jeskew
reviewed
Jan 6, 2025
jeskew
approved these changes
Jan 7, 2025
levimatheri
deleted the
muriukilevi/add-additional-properties-description
branch
levimatheri
added a commit
that referenced
this pull request
Jan 27, 2025
Follow up to [PR feedback](#15990 (comment)). With the current `ObjectType` signature, it's technically possible for `AdditionalPropertiesDescription` to be non-null even if `AdditionalPropertiesType` is null. This PR creates a new `NamedTypeProperty` record that represents a property with a name and a type, which is used for the `ObjectType.Properties` property. The `TypeProperty` record encapsulates the type ref, flags and description, preventing a non-null description with a null type ref being passed into `ObjectType`. New `ObjectType` signature: `public ObjectType(string name, TypeSymbolValidationFlags validationFlags, IEnumerable<NamedTypeProperty> properties, TypeProperty? additionalProperties, Func<ObjectType, FunctionResolver> methodResolverBuilder)` ###### Microsoft Reviewers: [Open in CodeFlow](https://microsoft.github.io/open-pr/?codeflow=https://github.com/Azure/bicep/pull/16053)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Resolves #13893.