Expose fail function
#15958
Open
Expose fail function
#15958
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 2 out of 2 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (2)
src/Bicep.Core/Semantics/Namespaces/SystemNamespaceType.cs:1076
- [nitpick] The description for the 'fail' function could be clearer. Consider rephrasing to 'Raises a runtime error with the provided message, causing the deployment to fail when evaluated.'
.WithGenericDescription("Raises a runtime error with the provided message. Will cause a deployment to fail when evaluated.")
src/Bicep.Core.IntegrationTests/ScenarioTests.cs:6604
- [nitpick] The error message 'should have supplied one' is unclear. It should be more descriptive, such as 'A required parameter was not supplied'.
param required string = fail('should have supplied one')
|
Test this change out locally with the following install scripts (Action run 12521230248) VSCode
Azure CLI
|
Dotnet Test Results 78 files - 39 78 suites - 39 30m 37s ⏱️ - 18m 2s Results for commit 2c339b9. ± Comparison against base commit b732155. This pull request removes 1846 and adds 632 tests. Note that renamed tests count towards both. |
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 #14067
This PR exposes the new
failfunction that is available in the ARM engine. One thing I went back and forth on is what the return type of this function should be. Three viable options are:ErrorAnyNeverMy first instinct was to use
Error, but this makes thefailfunction surprisingly difficult to use. It's essentially forbidden everywhere unless you wrap it inany(), which hurts usability. I considered using a return type ofanyto remove the need for this boilerplate -- this is close to the semantic used in the original C# proposal forthrowexpressions -- but I wasn't happy with the downstream effects of given Bicep's union type semantics. Iffail(...)is of typeany, thencondition ? 'boo' : fail('boo!')is of typeany, since the union ofanywith anything else isany. This isn't really correct, since the expression will only be evaluated if the condition is true, in which case the ternary's type would be'boo'.I ended up choosing
neverboth because afail(...)expression can't ever finish evaluating (and therefore doesn't really have a type) and because it had the right downstream assignability behavior. Very open to discussion on this if anyone feels strongly thatneveris incorrect, though!Microsoft Reviewers: Open in CodeFlow