Remove json-schema-ref-parser #1762
Merged
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
sdirix
force-pushed
the
remove-json-schema-ref-parser
branch
from
3f57522 to
45c2f65
Compare
sdirix
force-pushed
the
remove-json-schema-ref-parser
branch
from
45c2f65 to
ae1e113
Compare
eneufeld
reviewed
Jun 14, 2021
| }); | ||
|
|
||
| it('should add an item within an array', async () => { | ||
| it.skip('should add an item within an array', async () => { |
Member
|
I tested the examples, the AnyOf, OneOf, AllOf Resolve example (/packages/examples/src/anyOf-oneOf-allOf-resolve.ts) is crashing. I didn't test which of these crashed before. |
eneufeld
approved these changes
Jun 15, 2021
Member
eneufeld
left a comment
eneufeld
left a comment
There was a problem hiding this comment.
As discussed, we should update the resolver code and the examples in a follow up commit.
Removes json-schema-ref-parser and corresponding resolving functionality and dependencies from JSON Forms. Resolving of external dependencies is not a core feature of JSON Forms which is why we delegated it to a 3rd party dependency. However the json-schema-ref-parser library is not only slow and mutating schemas in place but also brings in a number of questionable Node dependent dependencies. The only binding actually using this functionality is the React binding. The way resolving was implemented resulted in the same flow as resolving it outside of JSON Forms and handing the resolved schema over for all but the very niche use case of unresolved schemas in the ui schema registry. Even that case can still be handled using a custom renderer. Based on these downsides and the very little upsides we decided to remove json-schema-ref-parser without a replacement from JSON Forms. Angular and Vue consumers don't need to spend any migration efforts. In @jsonforms/react we still export the backward API compatible 'ResolvedJsonFormsDispatch'. Therefore only React consumers actually using the now removed `refParserOptions` are forced to migrate while for all other React consumers it depends on their use cases. The built-in resolving mechanism in JSON Forms is quite basic. When the schema was fully resolved anyway the basic resolving did quite fine. However as this is no longer the case by default, there are now cases which are no longer supported and break. This is especially the case for complex combinator use cases involving references. Of course these can still be used when the consumer resolves their schema themselves before handing it over to JSON Forms. We also plan to make our built-in resolving more robust before the full 3.0 release to cover more of these cases. However we will not reach feature parity without major additional efforts.
sdirix
force-pushed
the
remove-json-schema-ref-parser
branch
from
ae1e113 to
5e01daf
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Removes json-schema-ref-parser and corresponding resolving functionality
and dependencies from JSON Forms.
Resolving of external dependencies is not a core feature of JSON Forms
which is why we delegated it to a 3rd party dependency. However the
json-schema-ref-parser library is not only slow and mutating schemas in
place but also brings in a number of questionable Node dependent
dependencies.
The only binding actually using this functionality is the React
binding. The way resolving was implemented resulted in the same flow
as resolving it outside of JSON Forms and handing the
resolved schema over.
Based on these downsides and the very little upsides we decided to
remove json-schema-ref-parser without a replacement from JSON Forms.
Angular and Vue consumers don't need to spend any migration efforts. In
@jsonforms/react we still export the backward API compatible
'ResolvedJsonFormsDispatch'. Therefore only React consumers actually
using the now removed 'refParserOptions' are forced to migrate while
for all other React consumers it depends on their use cases.
The built-in resolving mechanism in JSON Forms is quite basic. When
the schema was fully resolved anyway the basic resolving did quite
fine. However as this is no longer the case by default, there are
now cases which are no longer supported and break. This is especially
the case for complex combinator use cases involving references.
Of course these can still be used when the consumer resolves their
schema themselves before handing it over to JSON Forms. We also plan
to make our built-in resolving more robust before the full 3.0 release
to cover more of these cases. However we will not reach feature parity
without major additional efforts.