core: Remove AJV usage from combinator mappers #2413
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
✅ Deploy Preview for jsonforms-examples ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
sdirix
reviewed
Feb 12, 2025
- Adapt algorithm to determine the fitting schema index for combinators to no longer use AJV - New heuristic uses identifying properties that should match a const value in the schema - Adapt MaterialOneOfRenderer.test.tsx to fit new heuristic - Describe changes and add examples to migration guide - Adapt some of the anyOf and oneOf examples to custom and new identification properties #2371
In contrast to oneOf and anyOf rendererer, allOf renderers do not need the `indexOfFittingSchema` because all schemas apply at once. Thus, remove using mapStateToCombinatorRendererProps from mapStateToAllOfProps and, with this, the unnecessary calculation of the index. Part of #2371
lucas-koehler
force-pushed
the
lk/2371-remove-ajv-from-combinators
branch
from
07fe0f7 to
d9b3550
Compare
- remove usage of any number or string property as fallback - choose type, kind default prop based on combinator schema with const entry instead of presence in the data object - Adapt tests - remove usage of id as a default prop
lucas-koehler
force-pushed
the
lk/2371-remove-ajv-from-combinators
branch
from
d9b3550 to
cf3f154
Compare
|
@sdirix The tests are fixed and the review comments applied :) |
sdirix
requested changes
Jul 22, 2025
There was a problem hiding this comment.
- The preselection for primitives fails now (example
#oneOf_1273_simple). However I think we can add primitive detection to our determinator. - All the
oneOfvalidation examples no longer properly work with the new AJV-less approach in case thedatais set to a valid initial data which is not the first entry. We should think about what we advice users for these cases. - The
oneOfrecursive example detection is also broken, we should addtype/kindproperties there I think.
For migration: We should provide a way to restore the old behavior. For this we can hand over a (by default unused) AJV to the determination function and show the user how they can customize this function to use AJV to restore the old behavior.
Comment on lines
+23
to
+24
| Furthermore, subschemas can no longer automatically be selected based on validation results like | ||
| produced by different required properties between subschemas. |
There was a problem hiding this comment.
Suggested change
| Furthermore, subschemas can no longer automatically be selected based on validation results like | |
| produced by different required properties between subschemas. | |
| Furthermore, subschemas can no longer automatically be selected based on validation results like produced by different required properties between subschemas. |
| @@ -36,6 +36,12 @@ export interface CombinatorSubSchemaRenderInfo { | |||
|
|
|||
| export type CombinatorKeyword = 'anyOf' | 'oneOf' | 'allOf'; | |||
|
|
|||
| /** Custom schema keyword to define the property identifying different combinator schemas. */ | |||
| export const COMBINATOR_TYPE_PROPERTY = 'x-jsf-type-property'; | |||
There was a problem hiding this comment.
We could place these two properties as well as getCombinatorIndexOfFittingSchema into a Combinators object. Then in all our code we should always refer to Combinators.COMBINATOR_TYPE_PROPERTY etc. This would allow adopters to easily globally override these two properties as well the actual determination function for easier customization.
| @@ -2,6 +2,116 @@ | |||
|
|
|||
| ## Migrating to JSON Forms 3.6 | |||
|
|
|||
| ### Combinator (anyOf & oneOf) index selection now uses a heuristic instead of AJV | |||
There was a problem hiding this comment.
I think we should place this for JSON Forms 4.0 as this will break adopters
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.
In contrast to oneOf and anyOf rendererer, allOf renderers do not need the
indexOfFittingSchemabecause all schemas apply at once.Thus, remove using mapStateToCombinatorRendererProps from mapStateToAllOfProps and, with this, the unnecessary calculation of the index.
fix #2371