Expose an opaque ParseError type
#970
Merged
Conversation
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
john-h-kastner-aws
approved these changes
Jun 12, 2024
cedar-policy/src/api/err.rs
Outdated
| #[repr(transparent)] | ||
| #[error(transparent)] | ||
| #[diagnostic(transparent)] | ||
| pub struct ParseError(#[from] cedar_policy_core::parser::err::ParseError); |
There was a problem hiding this comment.
Regarding exposing ParseError as an enum in the future, we should fine based on https://predr.ag/blog/turning-rust-struct-to-enum-is-not-always-breaking/ (by the author of cargo-semver-checks, so I assume they know what they're talking about)
shaobo-he-aws
approved these changes
Jun 12, 2024
2 tasks
shaobo-he-aws
approved these changes
Jun 13, 2024
cdisselkoen
approved these changes
Jun 13, 2024
Comment on lines
+752
to
+753
| /// Marked as `non_exhaustive` to support adding additional error information | ||
| /// in the future without a major version bump. |
There was a problem hiding this comment.
I don't think we technically need non_exhaustive for that, since the fields are already private, but it doesn't hurt
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.
Description of changes
This PR addresses #745 for
ParseErrorsby exposing the bare minimum level of detail: users can use themiette::Diagnoticattached toParseErrors, or use.iter()to get an iterator over individualParseErrors. EachParseErrorwill expose no internal information outside of itsmiette::Diagnostic.I think the ideal solution here is to flatten the structure of
ParseErrorto remove the distinction between CST and AST errors and get rid of the "Kind" pattern, similar to what has been done for the validation & evaluation errors... but this is a large amount of work for small benefit (I find it unlikely that users will need to programmatically match against parse errors). Assuming this PR is approved, I'll make a backlog issue for the larger change. Note that this larger change can be made in a backwards-compatible way in the future.Issue #, if available
Checklist for requesting a review
The change in this PR is (choose one, and delete the other options):
cedar-policy(e.g., changes to the signature of an existing API).(Part of the batch of breaking error structure changes for 4.0)
I confirm that this PR (choose one, and delete the other options):
(Adds an undocumented breaking change made in #908.)
I confirm that
cedar-spec(choose one, and delete the other options):