Fixes: #20670: Related Object Validation #20717
Open
+182
−36
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
Index related objects from 1 and not from 0, just like top-level objects.
Use the parent object index as record index, and its own index only on the field name.
The related object fields are not covered by the form, so don't pass any validation before trying to iterate over them and accessing their elements. Instead of allowing a hard technical error to be raised, explicitly check that it is indeed a list, and raise a normal validation error if not. The error message is chosen to be similar in format and wording to the other existing validation errors. The used word "list" is quite universal, and conveys the wanted meaning in the context of python, json and yaml.
Elements of the "related objects list" are passed to the `prep_related_object_data` function before any validation takes place, with the potential of failing with a hard error. Similar to the "related objects not list" case explicitly validate the elements general type, and raise a normal validation error if it isn't a dictionary. The word "dictionary" is used here, since it is python terminology, and is close enough to yaml's "mapping". While json calls them "objects", their key-value syntax should make it obvious what "dictionary" means here.
jnovinger
requested review from
a team and
bctiemann
and removed request for
a team
Change this one special case to also use the same communication channel (toast notification) and message format as all other validation errors. The error message is kept mostly the same, just the index prefix is removed. This allowed keeping and easily adjusting the existing localizations of it.
m-hau
force-pushed
the
bugfix/related-object-validation
branch
from
d3671b5 to
fbe76ac
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes: #20670
Explicitly check that any related object field is a list, and that each related object is a dictionary, and trigger a validation error if this is not the case. This prevents these cases to result in a hard internal error to occur.
While testing I also found three other minor issues in the same code area, which I took the liberty to fix as well:
Please see the individual commit messages for more detailed information on each individual change.