fix: bump array version on reset so array fields re-render#2243
Open
hemraj-007 wants to merge 1 commit into
Open
fix: bump array version on reset so array fields re-render#2243hemraj-007 wants to merge 1 commit into
hemraj-007 wants to merge 1 commit into
Conversation
Bump _arrayVersion after form.reset and form.resetField so React array fields re-render when reset shortens the array. Fixes TanStack#2228 Co-authored-by: Cursor <cursoragent@cursor.com>
📝 WalkthroughWalkthroughForm reset operations now bump ChangesArray reset rerender
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
packages/form-core/src/FormApi.ts (1)
1850-1858: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winExtract duplicated array-version-bump loop into a shared helper.
The loop at lines 1851–1858 is identical to the one already in
update()at lines 1786–1793. Extracting it into a private method (e.g.,bumpArrayVersionsForAllFields()) would eliminate the duplication and ensure both call sites stay in sync.♻️ Proposed refactor
+ /** + * `@private` Bump _arrayVersion for every mounted field whose value is an array. + */ + private bumpArrayVersionsForAllFields = () => { + const helper = metaHelper(this) + for (const fieldKey of Object.keys( + this.fieldInfo, + ) as DeepKeys<TFormData>[]) { + if (Array.isArray(this.getFieldValue(fieldKey))) { + helper.bumpArrayVersion(fieldKey) + } + } + } + reset = (values?: TFormData, opts?: { keepDefaultValues?: boolean }) => { // ... existing reset logic ... - const helper = metaHelper(this) - for (const fieldKey of Object.keys( - this.fieldInfo, - ) as DeepKeys<TFormData>[]) { - if (Array.isArray(this.getFieldValue(fieldKey))) { - helper.bumpArrayVersion(fieldKey) - } - } + this.bumpArrayVersionsForAllFields() }Then apply the same replacement in
update()at lines 1786–1793.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/form-core/src/FormApi.ts` around lines 1850 - 1858, Extract the duplicated array-version-bump loop from update() and the shown flow into a shared private method, such as bumpArrayVersionsForAllFields(). Have the helper create or use metaHelper(this), iterate over fieldInfo keys, and call bumpArrayVersion for array-valued fields; replace both existing loops with calls to this method.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/form-core/src/FormApi.ts`:
- Around line 2966-2969: Add a FormApi.spec.ts test covering resetField on an
array field, using the existing FormApi, FieldApi, and resetField test patterns.
Set an array value, call resetField, then assert the default array is restored
and the field meta _arrayVersion is bumped as expected.
---
Nitpick comments:
In `@packages/form-core/src/FormApi.ts`:
- Around line 1850-1858: Extract the duplicated array-version-bump loop from
update() and the shown flow into a shared private method, such as
bumpArrayVersionsForAllFields(). Have the helper create or use metaHelper(this),
iterate over fieldInfo keys, and call bumpArrayVersion for array-valued fields;
replace both existing loops with calls to this method.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: b94af9cf-baaa-470c-9593-93e75079298b
📒 Files selected for processing (4)
.changeset/fix-array-reset-rerender.mdpackages/form-core/src/FormApi.tspackages/form-core/tests/FormApi.spec.tspackages/react-form/tests/useField.test.tsx
Comment on lines
+2966
to
+2969
|
|
||
| if (Array.isArray(this.getFieldValue(field))) { | ||
| metaHelper(this).bumpArrayVersion(field) | ||
| } |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Add test coverage for resetField array version bump.
The reset() path has a dedicated test in FormApi.spec.ts, but the resetField() array-version bump (lines 2967–2968) has no corresponding test. A regression could silently break this path.
🧪 Suggested test
it('should bump array version when resetField is called on an array field', () => {
const form = new FormApi({
defaultValues: {
items: [1, 2, 3],
},
})
form.mount()
const field = new FieldApi({ form, name: 'items' })
field.mount()
form.setFieldValue('items', [1, 2, 3, 4, 5])
// _arrayVersion is bumped by pushFieldValue or setFieldValue paths
form.resetField('items')
expect(form.getFieldValue('items')).toEqual([1, 2, 3])
expect(form.getFieldMeta('items')?._arrayVersion).toBe(1)
})🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/form-core/src/FormApi.ts` around lines 2966 - 2969, Add a
FormApi.spec.ts test covering resetField on an array field, using the existing
FormApi, FieldApi, and resetField test patterns. Set an array value, call
resetField, then assert the default array is restored and the field meta
_arrayVersion is bumped as expected.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
_arrayVersionafterform.reset()andform.resetField()when the target field is an array.[1,2,3]→[4]previously still rendered 3 items).Test Plan
pnpm run test:libinpackages/form-corepnpm run test:libinpackages/react-formSummary by CodeRabbit