Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

devtoolsBridge.test.ts

248 lines7.9 KB

1import {
2 InternalFormApi,
3 InternalFormGroupApi,
4} from '@tanstack/form-core/internals'
5import { describe, expect, it } from 'vitest'
6import { createFieldIdentityController } from '../src/bridge/fields/identity'
7import { getFieldRowsSnapshot } from '../src/bridge/fields/list'
8import { setFieldValidatorErrors } from './testUtils'
9​
10describe('form devtools bridge field snapshots', () => {
11 it('includes mounted and unmounted fields and omits raw values', () => {
12 const identity = createFieldIdentityController()
13 const form = new InternalFormApi({
14 defaultValues: { name: 'Ada', password: 'secret' },
15 })
16 const mountedField = form._getOrCreateFieldApi({ name: 'name' })
17 form._getOrCreateFieldApi({ name: 'password' })
18 const unregister = mountedField._register()
19​
20 try {
21 const rows = getFieldRowsSnapshot(form, identity)
22 const row = rows[0]!
23​
24 expect(rows).toHaveLength(2)
25 expect(row.path).toBe('name')
26 expect(row.fieldId).toEqual(expect.any(String))
27 expect(row.summary).toBeUndefined()
28 expect(Object.keys(row).sort()).toEqual(['fieldId', 'path'])
29 expect(rows[1]).toEqual({
30 fieldId: expect.any(String),
31 path: 'password',
32 isMounted: false,
33 })
34​
35 mountedField.handleChange('Grace')
36 expect(getFieldRowsSnapshot(form, identity)[0]?.summary).toEqual({
37 isDirty: true,
38 isTouched: true,
39 isDefaultValue: false,
40 })
41​
42 mountedField._setMeta((meta) => ({ ...meta, isDirty: false }))
43 expect(getFieldRowsSnapshot(form, identity)[0]?.summary).toEqual({
44 isTouched: true,
45 isDefaultValue: false,
46 })
47​
48 mountedField._setMeta((meta) => ({ ...meta, isTouched: false }))
49 expect(getFieldRowsSnapshot(form, identity)[0]?.summary).toEqual({
50 isDefaultValue: false,
51 })
52​
53 mountedField._setMeta((meta) => ({ ...meta, isBlurred: true }))
54 expect(getFieldRowsSnapshot(form, identity)[0]?.summary).toEqual({
55 isBlurred: true,
56 isDefaultValue: false,
57 })
58​
59 mountedField._setMeta((meta) => ({ ...meta, isBlurred: false }))
60 expect(getFieldRowsSnapshot(form, identity)[0]?.summary).toEqual({
61 isDefaultValue: false,
62 })
63​
64 mountedField.handleChange('Ada', {
65 markAsDirty: false,
66 markAsTouched: false,
67 causeValidation: false,
68 })
69 expect(getFieldRowsSnapshot(form, identity)[0]?.summary).toBeUndefined()
70​
71 setFieldValidatorErrors(mountedField, [{ message: 'Invalid name' }])
72 expect(getFieldRowsSnapshot(form, identity)[0]?.summary).toEqual({
73 hasSelfErrors: true,
74 validity: 'invalid',
75 })
76​
77 setFieldValidatorErrors(mountedField, [])
78 expect(getFieldRowsSnapshot(form, identity)[0]?.summary).toBeUndefined()
79 } finally {
80 unregister()
81 }
82 })
83​
84 it('represents nested fields without transporting trie linkage', () => {
85 const identity = createFieldIdentityController()
86 const form = new InternalFormApi({
87 defaultValues: { user: { profile: { name: '' } } },
88 })
89 form._getOrCreateFieldApi({ name: 'user.profile.name' })
90​
91 const rows = getFieldRowsSnapshot(form, identity)
92 expect(rows.map(({ path }) => path)).toEqual([
93 'user',
94 'user.profile',
95 'user.profile.name',
96 ])
97 expect(rows.map((row) => Object.keys(row).sort())).toEqual([
98 ['fieldId', 'isMounted', 'path'],
99 ['fieldId', 'isMounted', 'path'],
100 ['fieldId', 'isMounted', 'path'],
101 ])
102 })
103​
104 it('keeps unmounted fields while their summaries change', () => {
105 const identity = createFieldIdentityController()
106 const form = new InternalFormApi({ defaultValues: { name: '' } })
107 const field = form._getOrCreateFieldApi({ name: 'name' })
108​
109 const fieldId = getFieldRowsSnapshot(form, identity)[0]!.fieldId
110 expect(getFieldRowsSnapshot(form, identity)).toEqual([
111 { fieldId, path: 'name', isMounted: false },
112 ])
113​
114 setFieldValidatorErrors(field, [{ message: 'Invalid name' }])
115 expect(getFieldRowsSnapshot(form, identity)).toEqual([
116 {
117 fieldId,
118 path: 'name',
119 isMounted: false,
120 summary: { hasSelfErrors: true, validity: 'invalid' },
121 },
122 ])
123​
124 setFieldValidatorErrors(field, [])
125 expect(getFieldRowsSnapshot(form, identity)).toEqual([
126 { fieldId, path: 'name', isMounted: false },
127 ])
128 })
129​
130 it('excludes FormGroup backing fields', () => {
131 const identity = createFieldIdentityController()
132 const form = new InternalFormApi({
133 defaultValues: { guestDetails: { wrong: '' } },
134 })
135 const parent = form._getOrCreateFieldApi({ name: 'guestDetails' })
136 const child = form._getOrCreateFieldApi({ name: 'guestDetails.wrong' })
137 const group = new InternalFormGroupApi({ form, name: 'guestDetails' })
138​
139 try {
140 setFieldValidatorErrors(child, [{ message: 'Invalid field' }])
141​
142 expect(parent.state.meta.isValid).toBe(false)
143 expect(getFieldRowsSnapshot(form, identity)).toEqual([
144 {
145 fieldId: expect.any(String),
146 path: 'guestDetails.wrong',
147 isMounted: false,
148 summary: { hasSelfErrors: true, validity: 'invalid' },
149 },
150 ])
151 } finally {
152 group._cleanup()
153 }
154 })
155​
156 it('distinguishes errors hidden by error visibility', () => {
157 const identity = createFieldIdentityController()
158 const form = new InternalFormApi({
159 defaultValues: { name: '' },
160 errorVisibility: () => false,
161 })
162 const field = form._getOrCreateFieldApi({ name: 'name' })
163 const unregister = field._register()
164​
165 try {
166 setFieldValidatorErrors(field, [{ message: 'Invalid name' }])
167​
168 expect(field.meta.isValid).toBe(true)
169 expect(field.meta.original.isValid).toBe(false)
170 expect(getFieldRowsSnapshot(form, identity)[0]?.summary).toEqual({
171 hasSelfErrors: true,
172 validity: 'invalidHidden',
173 })
174 } finally {
175 unregister()
176 }
177 })
178​
179 it('keeps field identity stable when a mounted field path changes', () => {
180 const identity = createFieldIdentityController()
181 const form = new InternalFormApi({
182 defaultValues: { items: ['a', 'b'] },
183 })
184 const field = form._getOrCreateFieldApi({ name: 'items[0]' })
185 const unregister = field._register()
186​
187 try {
188 const before = getFieldRowsSnapshot(form, identity).find(
189 (row) => row.path === 'items[0]',
190 )!
191​
192 form.swapFieldValues('items', 0, 1)
193​
194 const after = getFieldRowsSnapshot(form, identity).find(
195 (row) => row.path === 'items[1]',
196 )!
197 expect(before.path).toBe('items[0]')
198 expect(after.path).toBe('items[1]')
199 expect(after.fieldId).toBe(before.fieldId)
200 } finally {
201 unregister()
202 }
203 })
204​
205 it('drops killed fields and keeps moved mounted fields after removal', () => {
206 const identity = createFieldIdentityController()
207 const form = new InternalFormApi({
208 defaultValues: { items: ['a', 'b'] },
209 })
210 const removedField = form._getOrCreateFieldApi({ name: 'items[0]' })
211 const movedField = form._getOrCreateFieldApi({ name: 'items[1]' })
212 const unregisterRemoved = removedField._register()
213 const unregisterMoved = movedField._register()
214​
215 try {
216 const movedFieldId = getFieldRowsSnapshot(form, identity).find(
217 (row) => row.path === 'items[1]',
218 )!.fieldId
219​
220 form.removeFieldValue('items', 0)
221​
222 const rows = getFieldRowsSnapshot(form, identity)
223 expect(rows).toHaveLength(2)
224 expect(rows).toEqual(
225 expect.arrayContaining([
226 {
227 path: 'items',
228 fieldId: expect.any(String),
229 isMounted: false,
230 summary: {
231 isDirty: true,
232 isTouched: true,
233 isDefaultValue: false,
234 },
235 },
236 {
237 path: 'items[0]',
238 fieldId: movedFieldId,
239 summary: { isDefaultValue: false },
240 },
241 ]),
242 )
243 } finally {
244 unregisterRemoved()
245 unregisterMoved()
246 }
247 })
248})