fix: omitExtraData on submit and on validateForm #4228

helen-m-lin · 2024-06-25T05:50:10Z

Reasons for making this change

fixes #4187, fixes #4165, fixes #4109

enforce omitExtraData when validating form programatically or submitting form
very small refactor for omitExtraData to avoid duplicate code in onSubmit and onChange

Checklist

I'm updating documentation
- I've checked the rendering of the Markdown text I've added
I'm adding or updating code
- I've added and/or updated tests. I've run npm run test:update to update snapshots, if needed.
- I've updated docs if needed
- I've updated the changelog with a description of the PR
I'm adding a new feature
- I've updated the playground with an example use of the feature

heath-freenome

@helen-m-lin Can you please update the CHANGELOG.md file with the appropriate details for this PR

CHANGELOG.md

Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com>

packages/core/src/components/Form.tsx

heath-freenome · 2024-06-25T23:26:08Z

packages/core/test/Form.test.jsx

+  describe('omitExtraData on submit', () => {
+    it('should call omitExtraData when the omitExtraData prop is true', () => {


It may be useful to keep testing getUsedFormData() independently of omitExtraData()... @nickgros your thoughts?

Looks like this is just verifying that it's called when the prop is set. Method is unit tested below

Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com>

heath-freenome · 2024-06-28T20:29:27Z

CHANGELOG.md

 - Fix field disable or readonly property can't cover globalOptions corresponding property (#4212)[https://github.com/rjsf-team/react-jsonschema-form/pull/4212]
+- Fixed `omitExtraData` not working in `onSubmit` and `validateForm`; fixing [#4187](https://github.com/rjsf-team/react-jsonschema-form/issues/4187), [#4165](https://github.com/rjsf-team/react-jsonschema-form/issues/4165) and [#4109](https://github.com/rjsf-team/react-jsonschema-form/issues/4109)



@helen-m-lin Since we released 5.18.5, can you move this change comment up to the 5.18.6

I tried rebasing your PR already and then I realized your comment needed to move. Plus another fix just merged so you'll have to rebase again.

@heath-freenome I moved the changelog comment to 5.18.6. Let me know if there is anything else!

Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com> Co-authored-by: Abdallah Al-Soqatri <abdallah.al-soqatri@aspentech.com> Co-authored-by: Kevin Burnett <18027+burnettk@users.noreply.github.com> Co-authored-by: Marek Bodinger <marek.bodinger@gmail.com> Co-authored-by: Mehdi Salem <mehdi.salem@qt.io> Co-authored-by: Nick Grosenbacher <nickgrosenbacher@gmail.com> Co-authored-by: Abdallah Al-Soqatri <abdallah.al-soqatri@inmation.com> Co-authored-by: Jonasz Wiącek <jonaszwiacek@gmail.com> Co-authored-by: Bogdan Savluk <savluk.bogdan@gmail.com> Co-authored-by: Christian Wendt <54559756+cwendtxealth@users.noreply.github.com> Co-authored-by: Ben Lambert <ben@blam.sh> Co-authored-by: David R. Bild <david@davidbild.org> Co-authored-by: Ariqun <38001928+Ariqun@users.noreply.github.com> Co-authored-by: Shivam Anand Murmu <35562703+Rozamo@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Shubham Biswas <46351104+Shubhcoder@users.noreply.github.com> Co-authored-by: popmanhe <neo_temp@hotmail.com> Co-authored-by: Yuki Aoki <me@aoki.app> Co-authored-by: Xiangcheng Kuo <37873394+orange-guo@users.noreply.github.com> Co-authored-by: Bart van Andel <bavanandel@gmail.com> Co-authored-by: Laurent Direr <laurent.direr@gmail.com> Co-authored-by: Vegard Stenvik <42935080+vstenvik@users.noreply.github.com> Co-authored-by: Appie <abdallarko@hotmail.com> Co-authored-by: Oren Forer <oforer@gmail.com> Co-authored-by: Marcus Penn <11893741+mpenndev@users.noreply.github.com> Co-authored-by: joachimhagheim <47362824+joachimhagheim@users.noreply.github.com> Co-authored-by: MarekBodingerBA <104828482+MarekBodingerBA@users.noreply.github.com> Co-authored-by: momesana <momesana@gmail.com> Co-authored-by: Martti Roitto <MarttiR@users.noreply.github.com> Co-authored-by: Serge van den Oever <serge@macaw.nl> Co-authored-by: Enzo Ferey <hello@enzoferey.com> Co-authored-by: Skyf0l <tom.rorato@gmail.com> Co-authored-by: Jaejoon Han <jj2726@gmail.com> Co-authored-by: とまとみ <tomatommy.bs@gmail.com> Co-authored-by: Daniel Todd <todddaniel@gmail.com> Co-authored-by: Dmitry Dzhus <dima@dzhus.org> Co-authored-by: Alexander Kachkaev <alexander@kachkaev.ru> Co-authored-by: shaddollxz <56341682+shaddollxz@users.noreply.github.com> Co-authored-by: Changyu Geng <gcyyq@hotmail.com> Co-authored-by: Helen Lin <46795546+helen-m-lin@users.noreply.github.com> Co-authored-by: solimant <solimant@users.noreply.github.com> Co-authored-by: David Li <davidli@cs.stanford.edu> fix(utils): direct lodash function import to improve bundling on library client side (#3976) fix: #3961 resolve all recurse list for object properties (#3981) fix gap in outline when label is hidden (#3984) Fix: Expose the internal `ajv` variable in the validator implementation classes (#3991) Fixes: #3972 indirectly by exposing the `ajv` variable for use in the issue Fix: Change FormHelperText usage with @mui/material to render divs (#4032) Fixes #4031 by switching the render component for `FormHelperText` to be `div` fix: Added support for anyOf/oneOf in uiSchema (#4055) Fixes #4039 by updating `MultiSchemaField` to properly support `anyOf`/`oneOf` arrays in the `uiSchema` Fix checkbox with 0 as a value was unselectable in antd (#4068) Fixed #4067 by properly dealing with enums that have 0 as a value Fix potential XSS in the preview button of FileWidget (#4065) Fix: Make 'ui:rows' option work with chakra-ui for textarea elements #4070 (#4078) Fix typo in ErrorsListTemplate example (#4087) Fix #4080 by moving `base64` encoder/decoder from `@rjsf/utils` to playground (#4093) Fix: Error state not resetting when schema changes (#4079) (#4103) Fix noImplicitAny error (#4106) Fixes: [WARNING] Duplicate key "include" in object literal [duplicate-object-key] (#4114) Fixes: Warning: validateDOMNesting(...): <p> cannot appear as a descendant of <p>. (#4117) Fix documentation to add missing Form imports (#4131) Fix #4127 to add missing `Form` import in documentation Fix: filename should be bold (#4125) Fix: use correct ConfigProvider context by using named imports (#4132) Fix 4134 by filtering out bad DOM props (#4140) Fixes: #4134 by updating the spreading of props onto the `TextField` to remove bad DOM fields Fixed Programmatic submit not working properly in Firefox (#4150) Fix Maximum call stack size exceeded in findSchemaDefinition (#4123) fix typos in constants.ts, Form.tsx (#4185) Fix mui imports in docs (#4218) fix] Resetting number fields should check the entire string when deciding to leave the input text alone (#4202) (#4220) Fixed performance issue with large schema dependencies and oneOf (#4203) (#4204) Fixed performance issue #4203 fix(core): field ui-options higher priority (#4212) fix(antd): disabled property of options of antd theme (#4216) fix: omitExtraData on submit and on validateForm (#4228) Fix IdSchema and PathSchema types (#4196) fixes #4236 Fix #4197 in various themes by showing empty option in SelectWidget when appropriate (#4200) fix: xss when rendering schema errors (#4256) fix 4215 and 4260 by updating optionsList() to take a uiSchema (#4263) Fixes #4215 and #4260 by supporting alternate titles for enums and anyOf/oneOf lists via the uiSchema Fixed Changelog (#4269)

helen-m-lin added 2 commits June 24, 2024 21:50

fix: omitExtraData on submit and on validateForm

c64e122

test: update tests for omitExtraData

917e6ac

heath-freenome reviewed Jun 25, 2024

View reviewed changes

helen-m-lin and others added 2 commits June 25, 2024 15:52

Merge branch 'main' into fix-4187-omit-extra-data

a262f7c

ci: update changelog

bdc4f06

helen-m-lin requested a review from heath-freenome June 25, 2024 23:12

heath-freenome reviewed Jun 25, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Update CHANGELOG.md

a46cd70

Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com>

heath-freenome reviewed Jun 25, 2024

View reviewed changes

Apply suggestions from code review

602780a

Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com>

heath-freenome approved these changes Jun 28, 2024

View reviewed changes

Merge branch 'main' into fix-4187-omit-extra-data

8fe05b6

heath-freenome reviewed Jun 28, 2024

View reviewed changes

helen-m-lin and others added 2 commits July 1, 2024 10:23

Merge branch 'main' into fix-4187-omit-extra-data

52d277a

docs: update changelog

4605f28

heath-freenome merged commit b1cf91d into rjsf-team:main Jul 1, 2024
5 checks passed

heath-freenome mentioned this pull request Jul 2, 2024

Omit extra data in schemaUtils #4139

Draft

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: omitExtraData on submit and on validateForm #4228

fix: omitExtraData on submit and on validateForm #4228

helen-m-lin commented Jun 25, 2024 •

edited

Loading

heath-freenome left a comment

heath-freenome Jun 25, 2024

nickgros Jun 28, 2024

heath-freenome Jun 28, 2024

heath-freenome Jun 28, 2024

helen-m-lin Jul 1, 2024

		describe('omitExtraData on submit', () => {
		it('should call omitExtraData when the omitExtraData prop is true', () => {

		- Fix field disable or readonly property can't cover globalOptions corresponding property (#4212)[https://github.com/rjsf-team/react-jsonschema-form/pull/4212]
		- Fixed `omitExtraData` not working in `onSubmit` and `validateForm`; fixing [#4187](https://github.com/rjsf-team/react-jsonschema-form/issues/4187), [#4165](https://github.com/rjsf-team/react-jsonschema-form/issues/4165) and [#4109](https://github.com/rjsf-team/react-jsonschema-form/issues/4109)

fix: omitExtraData on submit and on validateForm #4228

fix: omitExtraData on submit and on validateForm #4228

Conversation

helen-m-lin commented Jun 25, 2024 • edited Loading

Reasons for making this change

Checklist

heath-freenome left a comment

Choose a reason for hiding this comment

heath-freenome Jun 25, 2024

Choose a reason for hiding this comment

nickgros Jun 28, 2024

Choose a reason for hiding this comment

heath-freenome Jun 28, 2024

Choose a reason for hiding this comment

heath-freenome Jun 28, 2024

Choose a reason for hiding this comment

helen-m-lin Jul 1, 2024

Choose a reason for hiding this comment

helen-m-lin commented Jun 25, 2024 •

edited

Loading