Skip to content

fix(react): form.reset not working inside of onSubmit #1494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

harry-whorlow
Copy link
Contributor

@harry-whorlow harry-whorlow commented May 9, 2025

Relates to #1490, #1485 and potentially #1487.

This appears to stem from the react adapter as Angular, Vue and Core all seem to work as intended.

Reset will work correctly initially then on next pass wipe the previous state. Curiously this seems to only be the case in the onSubmit handler.

Copy link

nx-cloud bot commented May 9, 2025

View your CI Pipeline Execution ↗ for commit 840aaf9.

Command Status Duration Result
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 1m 23s View ↗
nx run-many --target=build --exclude=examples/** ✅ Succeeded 22s View ↗

☁️ Nx Cloud last updated this comment at 2025-05-18 17:26:22 UTC

@harry-whorlow harry-whorlow changed the title chore: test cases fix(react): form.reset not working inside of onSubmit May 9, 2025
Copy link

pkg-pr-new bot commented May 9, 2025

More templates

@tanstack/angular-form

npm i https://pkg.pr.new/@tanstack/angular-form@1494

@tanstack/form-core

npm i https://pkg.pr.new/@tanstack/form-core@1494

@tanstack/react-form

npm i https://pkg.pr.new/@tanstack/react-form@1494

@tanstack/lit-form

npm i https://pkg.pr.new/@tanstack/lit-form@1494

@tanstack/solid-form

npm i https://pkg.pr.new/@tanstack/solid-form@1494

@tanstack/svelte-form

npm i https://pkg.pr.new/@tanstack/svelte-form@1494

@tanstack/vue-form

npm i https://pkg.pr.new/@tanstack/vue-form@1494

commit: 840aaf9

@bpinto
Copy link

bpinto commented May 10, 2025

I'm not sure if this is the proper fix, but this fixes the newly added test without introducing other test failures.

Test is failing given opts doesn't contain the latest defaultValues as the latest values were passed via reset and not via props, therefore calling update(opts) here is actually overriding the new default values set via reset().

diff --git a/packages/react-form/src/useForm.tsx b/packages/react-form/src/useForm.tsx
index 729064ab..dd7a012c 100644
--- a/packages/react-form/src/useForm.tsx
+++ b/packages/react-form/src/useForm.tsx
@@ -210,13 +210,5 @@ export function useForm<
 
   useStore(formApi.store, (state) => state.isSubmitting)
 
-  /**
-   * formApi.update should not have any side effects. Think of it like a `useRef`
-   * that we need to keep updated every render with the most up-to-date information.
-   */
-  useIsomorphicLayoutEffect(() => {
-    formApi.update(opts)
-  })
-
   return formApi
 }

@harry-whorlow
Copy link
Contributor Author

harry-whorlow commented May 12, 2025

@bpinto thanks for taking a look into this, I was rather busy over the weekend, so it's super appreciated!

hmm thats, interesting... I'll shoot crutch corn a message since he authored the code, but you are correct it dose pass the tests, though to play devils advocate we are lacking framework specific tests so it might be breaking something. 😊

Once again thanks for the investigation!

[edit] So to me removing the update(ops) won't work as we need to update the opts passed to form if they change. It's really a question as to what is causing the re-render of the form.

@LeCarbonator
Copy link
Contributor

LeCarbonator commented May 16, 2025

these lines changing this.options appear to be the cause. Commenting them out makes the test pass.

Of course it breaks everything else, but perhaps this could help with resolving this.

Copy link

codecov bot commented May 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.17%. Comparing base (1a7b9f3) to head (840aaf9).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1494      +/-   ##
==========================================
+ Coverage   89.13%   89.17%   +0.03%     
==========================================
  Files          31       31              
  Lines        1417     1422       +5     
  Branches      362      364       +2     
==========================================
+ Hits         1263     1268       +5     
  Misses        137      137              
  Partials       17       17              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@LeCarbonator
Copy link
Contributor

Testing on stackblitz, this appears to work as expected in react now!

@@ -216,7 +225,7 @@ export function useForm<
*/
useIsomorphicLayoutEffect(() => {
formApi.update(opts)
})
}, [stableOptsRef.current])
Copy link

@bpinto bpinto May 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given this value (stableOptsRef.current) is calculated on every re-render, I don't think using it as a [deps] adds any additional benefit over doing the check inside of the useIsomorphicLayoutEffect function.

  useIsomorphicLayoutEffect(() => {
    if (!evaluate(opts, stableOptsRef.current) {
      formApi.update(opts)
    }
  })

The reason for why I bring this up, is because I personally would rather avoid using a toString() to compare functions inside the evaluate function as that seems fragile/expensive. Therefore, there might be some alternative checks we could do here.

I don't know what the shouldUpdateReeval inside formApi.update() function is for but for the other 2 updates, if the form has been touched (!this.state.isTouched) then the update is skipped. So maybe there is something we can check to avoid the update() call altogether and potentially not need to deal with function toString() comparison.

  useIsomorphicLayoutEffect(() => {
    if (!formApi.form.state.isTouched) {
      formApi.update(opts)
    }
  })

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm... My concern here is that this issue only exists in the react sphere, all the other frameworks are working correctly, and modify core just to service a bug that only exists in react feels off.

I think I'll shelve this for a short minuet to look into other solutions, I appreciate the input.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants