APIv4 - Throw exception instead of munging illegal join aliases #21072
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
|
(Standard links)
|
| catch (\API_Exception $e) { | ||
| $message = $e->getMessage(); | ||
| } | ||
| $this->assertEquals('Illegal join alias: "add.ress"', $message); |
There was a problem hiding this comment.
@colemanw - this makes sense but for test legibility could you add an OK alias - that would make it clearer when reading the test IMHO
The problem with "fixing" an illegal join alias is that it's then mysterious what the correct alias will be, leading to bugs when the incorrect alias gets used throughout the rest of the api params. Throwing an exception seems like a better way to ensure developers are alerted to the error.
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.
Overview
Improves APIv4 validation of explicit join aliases.
Before
Incorrect aliases would be silently "fixed".
After
Exception thrown.
Technical Details
The problem with "fixing" an illegal join alias is that it's then mysterious what the correct alias will be, leading to bugs when the incorrect alias gets used throughout the rest of the api params.
Throwing an exception seems like a better way to ensure developers are alerted to the error.