Improve policy compiler error message for incompatible outputs. #1082
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
The previous message was confusing to users in the situation where the
output of the current block was correct, but the previous blocks had
incorrect types. It made them believe that the incorrect type was the
"expected" output type for the rule, and that the problem was at the
error line/column.
For example, the rule:
```
rule:
match:
- condition: foo
output: "'incorrect'"
- condition: bar
output: "false"
- output: "true"
```
would point at the "bar" block as having the wrong type, even though the
wrong type is in the "foo" block.
The new message makes it clear that the error arises from the type of
the block being incompatible with the *previous* block types -- not with
the expected output of the rule.
TristonianJones
approved these changes
Dec 4, 2024
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.
The previous message was confusing to users in the situation where the output of the current block was correct, but the previous blocks had incorrect types. It made them believe that the incorrect type was the "expected" output type for the rule, and that the problem was at the error line/column.
For example, the rule:
would point at the "bar" block as having the wrong type, even though the wrong type is in the "foo" block.
The new message makes it clear that the error arises from the type of the block being incompatible with the previous block types -- not with the expected output of the rule.