fix(form-core): make fieldMeta values optional to reflect runtime behaviour. #1787
+258
−14
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| --- | ||
| '@tanstack/form-core': patch | ||
| --- | ||
|
|
||
| Make fieldMeta values optional to reflect runtime behavior and prevent crashes | ||
|
|
||
| BREAKING CHANGE: `fieldMeta` values are now typed as `Record<DeepKeys<TData>, AnyFieldMeta | undefined>` instead of `Record<DeepKeys<TData>, AnyFieldMeta>`. This accurately reflects that field metadata is only available after a field has been mounted. | ||
|
|
||
| **Why:** Previously, TypeScript allowed unchecked access to `fieldMeta` properties, leading to runtime crashes when accessing metadata of unmounted fields during the first render. | ||
|
|
||
| **What changed:** The type now includes `undefined` in the union, forcing developers to handle the case where a field hasn't been mounted yet. | ||
|
|
||
| **How to migrate:** | ||
|
|
||
| ```typescript | ||
| // Before (crashes at runtime) | ||
| const isValid = form.state.fieldMeta.name.isValid | ||
|
|
||
| // After - use optional chaining | ||
| const isValid = form.state.fieldMeta.name?.isValid | ||
|
|
||
| // Or explicit undefined check | ||
| const fieldMeta = form.state.fieldMeta.name | ||
| if (fieldMeta) { | ||
| const isValid = fieldMeta.isValid | ||
| } | ||
| ``` | ||
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
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
|
There was a problem hiding this comment.
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,186 @@ | ||
| import { describe, expect, it } from 'vitest' | ||
| import { FieldApi, FormApi } from '../src/index' | ||
|
|
||
| describe('fieldMeta accessing', () => { | ||
| it('should return undefined for unmounted fields', () => { | ||
| const form = new FormApi({ | ||
| defaultValues: { | ||
| name: '', | ||
| email: '', | ||
| }, | ||
| }) | ||
|
|
||
| expect(form.state.fieldMeta.name).toBeUndefined() | ||
| expect(form.state.fieldMeta.email).toBeUndefined() | ||
| }) | ||
|
|
||
| it('should have defined fieldMeta after field is mounted', () => { | ||
| const form = new FormApi({ | ||
| defaultValues: { | ||
| name: '', | ||
| }, | ||
| }) | ||
|
|
||
| const field = new FieldApi({ | ||
| form, | ||
| name: 'name', | ||
| }) | ||
|
|
||
| field.mount() | ||
|
|
||
| expect(form.state.fieldMeta.name).toBeDefined() | ||
| expect(form.state.fieldMeta.name?.isValid).toBe(true) | ||
| expect(form.state.fieldMeta.name?.isTouched).toBe(false) | ||
| expect(form.state.fieldMeta.name?.isDirty).toBe(false) | ||
| }) | ||
|
|
||
| it('should handle nested field paths', () => { | ||
| const form = new FormApi({ | ||
| defaultValues: { | ||
| user: { | ||
| profile: { | ||
| firstName: '', | ||
| lastName: '', | ||
| }, | ||
| }, | ||
| }, | ||
| }) | ||
|
|
||
| expect(form.state.fieldMeta['user.profile.firstName']).toBeUndefined() | ||
| expect(form.state.fieldMeta['user.profile.lastName']).toBeUndefined() | ||
|
|
||
| const firstNameField = new FieldApi({ | ||
| form, | ||
| name: 'user.profile.firstName', | ||
| }) | ||
|
|
||
| firstNameField.mount() | ||
|
|
||
| expect(form.state.fieldMeta['user.profile.firstName']).toBeDefined() | ||
|
|
||
| expect(form.state.fieldMeta['user.profile.lastName']).toBeUndefined() | ||
| }) | ||
|
|
||
| it('should handle array fields', () => { | ||
| const form = new FormApi({ | ||
| defaultValues: { | ||
| items: ['item1', 'item2'], | ||
| }, | ||
| }) | ||
|
|
||
| expect(form.state.fieldMeta['items[0]']).toBeUndefined() | ||
| expect(form.state.fieldMeta['items[1]']).toBeUndefined() | ||
|
|
||
| const field0 = new FieldApi({ | ||
| form, | ||
| name: 'items[0]', | ||
| }) | ||
|
|
||
| field0.mount() | ||
|
|
||
| expect(form.state.fieldMeta['items[0]']).toBeDefined() | ||
| expect(form.state.fieldMeta['items[1]']).toBeUndefined() | ||
| }) | ||
|
|
||
| it('should handle getFieldMeta returning undefined', () => { | ||
| const form = new FormApi({ | ||
| defaultValues: { | ||
| name: '', | ||
| }, | ||
| }) | ||
|
|
||
| const fieldMeta = form.getFieldMeta('name') | ||
| expect(fieldMeta).toBeUndefined() | ||
|
|
||
| const field = new FieldApi({ | ||
| form, | ||
| name: 'name', | ||
| }) | ||
|
|
||
| field.mount() | ||
|
|
||
| const fieldMetaAfterMount = form.getFieldMeta('name') | ||
| expect(fieldMetaAfterMount).toBeDefined() | ||
| expect(fieldMetaAfterMount?.isValid).toBe(true) | ||
| }) | ||
|
|
||
| it('should handle multiple fields with mixed mount states', () => { | ||
| const form = new FormApi({ | ||
| defaultValues: { | ||
| firstName: '', | ||
| lastName: '', | ||
| email: '', | ||
| }, | ||
| }) | ||
|
|
||
| const firstNameField = new FieldApi({ | ||
| form, | ||
| name: 'firstName', | ||
| }) | ||
|
|
||
| const lastNameField = new FieldApi({ | ||
| form, | ||
| name: 'lastName', | ||
| }) | ||
|
|
||
| firstNameField.mount() | ||
|
|
||
| expect(form.state.fieldMeta.firstName).toBeDefined() | ||
| expect(form.state.fieldMeta.email).toBeUndefined() | ||
| }) | ||
|
|
||
| it('should preserve fieldMeta after unmounting and remounting', () => { | ||
| const form = new FormApi({ | ||
| defaultValues: { | ||
| name: '', | ||
| }, | ||
| }) | ||
|
|
||
| const field = new FieldApi({ | ||
| form, | ||
| name: 'name', | ||
| }) | ||
|
|
||
| const cleanup = field.mount() | ||
|
|
||
| field.setValue('test') | ||
| expect(form.state.fieldMeta.name?.isTouched).toBe(true) | ||
| expect(form.state.fieldMeta.name?.isDirty).toBe(true) | ||
|
|
||
| cleanup() | ||
|
|
||
| const metaAfterCleanup = form.state.fieldMeta.name | ||
|
|
||
| expect(metaAfterCleanup).toBeDefined() | ||
| }) | ||
|
|
||
| it('should work with form validation that accesses fieldMeta', () => { | ||
| const form = new FormApi({ | ||
| defaultValues: { | ||
| password: '', | ||
| confirmPassword: '', | ||
| }, | ||
| validators: { | ||
| onChange: ({ value }) => { | ||
| if (value.password !== value.confirmPassword) { | ||
| return 'Passwords must match' | ||
| } | ||
| return undefined | ||
| }, | ||
| }, | ||
| }) | ||
|
|
||
| form.mount() | ||
|
|
||
| const passwordField = new FieldApi({ | ||
| form, | ||
| name: 'password', | ||
| }) | ||
|
|
||
| passwordField.mount() | ||
|
|
||
| expect(() => { | ||
| passwordField.setValue('test123') | ||
| }).not.toThrow() | ||
| }) | ||
| }) |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure how GH actions will handle descriptions like this. I assume it'll be okay? Either way, as mentioned above, types aren't considered breaking changes.