Remove Controller
assertions and return errors instead
#10704
Merged
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.
This PR changes the return type of
Controller
methods to present errors in cases the controller would panic due to dynamically verified constraints (e.g. all identifiers present,since
frontiers are valid, etc).All previous uses of these methods simply
unwrap()
their results, panicking just as they would before. However, there is now the possibility of some remediation whereas there would not be otherwise. The methods validate the transition before they take them, so that if an error is returned the command had no effect.These validation steps could likely be broken out to independent methods to allow users (@mjibson, @sploiselle) to validate commands before launching them. We can do that in follow up work if it would be useful, but didn't want to overdo it here.
Motivation
The coordinator was at the mercy of the
Controller
to determine what commands would work and which would not. Ideally this gets us closer to clearer communication and less guessing.Checklist