Provide additional tester context #1975
Merged
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
core: * Change the third parameter of Tester and RankedTester from just the root schema to a new TesterContext object. It contains the root schema and the global config. * Remove UI Schema generation from mapStateToJsonFormsRendererProps. Instead, it is taken from the state. react: * Rename ctxToJsonFormsDispatchProps to ctxToJsonFormsRendererProps * Add HOC withJsonFormsRendererProps that injects state props vue: * Upgrade @vue/test-utils to the latest stable version * Add config as an optional renderer prop Fixes eclipsesource#1970
lucas-koehler
force-pushed
the
1970-more-tester-context
branch
from
3f9b74d
to
fd93428
Compare
lucas-koehler
changed the title
sdirix
requested changes
Jul 15, 2022
Comment on lines
+35
to
+46
| const testerContext = useMemo( | ||
| () => ({ | ||
| rootSchema: rootSchema, | ||
| config: config | ||
| }), | ||
| [rootSchema, config] | ||
| ); | ||
| const cell = useMemo( | ||
| () => maxBy(cells, r => r.tester(uischema, schema, testerContext)), | ||
| [cells, uischema, schema, testerContext] | ||
| ); | ||
| if (cell === undefined || cell.tester(uischema, schema, testerContext) === -1) { |
There was a problem hiding this comment.
Personally I would have done one useMemo as the standalone testerContext useMemo is not really necessary but that's just a minor issue.
Comment on lines
+108
to
122
| const testerContext = useMemo( | ||
| () => ({ | ||
| rootSchema: props.rootSchema, | ||
| config: props.config | ||
| }), | ||
| [props.rootSchema, props.config] | ||
| ); | ||
| const renderer = useMemo( | ||
| () => maxBy(props.renderers, r => r.tester(props.uischema, props.schema, props.rootSchema)), | ||
| [props.renderers, props.uischema, props.schema] | ||
| () => maxBy(props.renderers, r => r.tester(props.uischema, props.schema, testerContext)), | ||
| [props.renderers, props.uischema, props.schema, testerContext] | ||
| ); | ||
| if ( | ||
| renderer === undefined || | ||
| renderer.tester(props.uischema, props.schema, props.rootSchema) === -1 | ||
| renderer.tester(props.uischema, props.schema, testerContext) === -1 | ||
| ) { |
MIGRATION.md
Outdated
| Therefore the manual resolving of JSON Schemas before handing them over to JSON Forms does not need to be performed in those cases. | ||
| In addition, testers can now access the global `config` to consider default UI Schema options. |
There was a problem hiding this comment.
There are also other use cases so I would just add that the config is now available. Especially as we don't use the config in this PR.
MIGRATION.md
Outdated
| Therefore the manual resolving of JSON Schemas before handing them over to JSON Forms does not need to be performed in those cases. | ||
| In addition, testers can now access the global `config` to consider default UI Schema options. |
There was a problem hiding this comment.
Instead of global I usually use the term "form wide" to avoid confusion
packages/core/src/testers/testers.ts
Outdated
| export interface TesterContext { | ||
| /** The root JsonSchema of the form. Can be used to resolve references. */ | ||
| rootSchema: JsonSchema; | ||
| /** The global configuration object given to JsonForms. Can be used to derive default UISchema options. */ |
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.
core:
react:
vue:
Fixes #1970