feat!: Make the rewrite errors more useful #1174
Merged
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
aborgna-q
force-pushed
the
ab/replacement-errors
branch
from
e5a0145 to
1a56ed5
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1174 +/- ##
==========================================
- Coverage 87.09% 87.01% -0.09%
==========================================
Files 97 97
Lines 19297 19317 +20
Branches 18432 18452 +20
==========================================
+ Hits 16807 16808 +1
- Misses 1636 1655 +19
Partials 854 854
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
aborgna-q
changed the title
acl-cqc
approved these changes
Jun 7, 2024
| #[error("Replacement graph boundary size mismatch.")] | ||
| InvalidSignature, | ||
| #[error( | ||
| "Replacement graph boundary size mismatch. Expected {expected}, got {}.", |
There was a problem hiding this comment.
Suggested change
| "Replacement graph boundary size mismatch. Expected {expected}, got {}.", | |
| "Replacement graph boundary type mismatch. Expected {expected}, got {}.", |
Or maybe just "graph type" without the "boundary"
There was a problem hiding this comment.
(And the comment on the previous line too)
| } | ||
| let Some([rep_input, rep_output]) = replacement.get_io(rep_root) else { | ||
| return Err(InvalidReplacement::InvalidDataflowParent); | ||
| return Err(InvalidReplacement::InvalidDataflowParent { |
There was a problem hiding this comment.
This feels a strangely named error. It's not that the optype isn't a DataflowParent - that's guaranteed from the previous check that it's a Dfg. (Odd that we are checking OpTag::Dfg.is_superset(dfg_optype) rather than OpTag::Dfg == dfg_optype but there.)
So, it's that the input/output are missing. Indeed that's what the #[error] message for InvalidDataflowParent says! I'd suggest renaming to, say, MissingInputOutput.
(Also we kind of know what the op is, it's an OpType::DFG - so this just puts the input/output typerows in, well I guess that's fair.)
There was a problem hiding this comment.
I think we can replace this error with an expect. It can only trigger with invalid hugrs.
| #[error("Not a sibling subgraph.")] | ||
| NoSharedParent, | ||
| #[error( | ||
| "Invalid sibling subgraph. {first_node} has parent {}, but {other_node} has parent {}.", |
There was a problem hiding this comment.
I quite like "not a" sibling subgraph (the definition of such is that they are all siblings!), but ok
Closed
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jul 1, 2024
## 🤖 New release * `hugr`: 0.5.1 -> 0.6.0 * `hugr-core`: 0.2.0 -> 0.3.0 * `hugr-passes`: 0.2.0 -> 0.3.0 * `hugr-cli`: 0.1.1 -> 0.1.2 <details><summary><i><b>Changelog</b></i></summary><p> ## `hugr` <blockquote> ## 0.6.0 (2024-06-28) ### Bug Fixes - SimpleReplacement panic on multiports ([#1191](#1191)) - Add some validation for const nodes ([#1222](#1222)) - Cfg not validating entry/exit types ([#1229](#1229)) - `extract_hugr` not removing root node ports ([#1239](#1239)) ### Documentation - Fix documentation of `ValidationError::ConstTypeError` ([#1227](#1227)) ### Features - CircuitBuilder::add_constant ([#1168](#1168)) - [**breaking**] Make the rewrite errors more useful ([#1174](#1174)) - [**breaking**] Validate Extensions using hierarchy, ignore input_extensions, RIP inference ([#1142](#1142)) - [**breaking**] Infer extension deltas for Case, Cfg, Conditional, DataflowBlock, Dfg, TailLoop ([#1195](#1195)) - Helper functions for requesting inference, use with builder in tests ([#1219](#1219)) ### Refactor - [**breaking**] FunctionBuilder takes impl Into<PolyFuncType> ([#1220](#1220)) - [**breaking**] Remove NodeType and input_extensions ([#1183](#1183)) </blockquote> ## `hugr-core` <blockquote> ## 0.3.0 (2024-06-28) ### Bug Fixes - SimpleReplacement panic on multiports ([#1191](#1191)) - Add some validation for const nodes ([#1222](#1222)) - Cfg not validating entry/exit types ([#1229](#1229)) - `extract_hugr` not removing root node ports ([#1239](#1239)) ### Documentation - Fix documentation of `ValidationError::ConstTypeError` ([#1227](#1227)) ### Features - CircuitBuilder::add_constant ([#1168](#1168)) - [**breaking**] Make the rewrite errors more useful ([#1174](#1174)) - [**breaking**] Validate Extensions using hierarchy, ignore input_extensions, RIP inference ([#1142](#1142)) - [**breaking**] Infer extension deltas for Case, Cfg, Conditional, DataflowBlock, Dfg, TailLoop ([#1195](#1195)) - Helper functions for requesting inference, use with builder in tests ([#1219](#1219)) ### Refactor - [**breaking**] Remove NodeType and input_extensions ([#1183](#1183)) - [**breaking**] FunctionBuilder takes impl Into<PolyFuncType> ([#1220](#1220)) </blockquote> ## `hugr-passes` <blockquote> ## 0.3.0 (2024-06-28) ### Features - [**breaking**] Validate Extensions using hierarchy, ignore input_extensions, RIP inference ([#1142](#1142)) - Helper functions for requesting inference, use with builder in tests ([#1219](#1219)) </blockquote> ## `hugr-cli` <blockquote> ## 0.1.1 (2024-06-07) ### Features - Reexport `clap::Parser` and `clap_verbosity_flag::Level` from hugr_cli ([#1146](#1146)) ### Refactor - Move binary to hugr-cli ([#1134](#1134)) </blockquote> </p></details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/). --------- Co-authored-by: Douglas Wilson <[email protected]>
Merged
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.
Adds some context to the errors.
BREAKING CHANGE: Added more attributes to the
InvalidReplacementandInvalidSubgrapherror enums.