Open History to see the last commit
1import { InternalFormApi } from '@tanstack/form-core/internals'
2import { describe, expect, it } from 'vitest'
3import { z } from 'zod'
4import { createFieldsController } from '../src/bridge/fields'
5import { createMountedFormsController } from '../src/bridge/forms/mountedForms'
6import { formDevtoolsEventClient } from '../src/eventClient.lib'
7import { connectTestEventBus } from './testEventBus'
8import { setFieldValidatorErrors } from './testUtils'
9import type { FieldDebugReport } from '../src/eventClientTypes'
10β
11const schemaValidator = {
12 triggers: ['change'] as const,
13 run: z.unknown(),
14}
15β
16const emptyTriggerValidator = {
17 triggers: [] as [],
18 run: () => null,
19}
20β
21describe('general field debug report bridge', () => {
22 it('returns a correlated report built from the live field subtree', () => {
23 const disconnectEventBus = connectTestEventBus()
24 const mountedForms = createMountedFormsController()
25 const fields = createFieldsController(mountedForms)
26 const form = new InternalFormApi({
27 defaultValues: { parent: { child: '' } },
28 })
29 const parent = form._getOrCreateFieldApi({ name: 'parent' })
30 const child = form._getOrCreateFieldApi({
31 name: 'parent.child',
32 validators: [schemaValidator] as never,
33 })
34 const unregisterParent = parent._register()
35 const reports: Array<FieldDebugReport> = []
36 const cleanupReports = formDevtoolsEventClient.on(
37 'field-debug-report',
38 (event) => reports.push(event.payload),
39 )
40β
41 setFieldValidatorErrors(child, [{ message: 'Child error' }])
42β
43 try {
44 mountedForms.mountForm(form)
45 const formInstanceId =
46 mountedForms.getMountedFormsSnapshot()[0]!.instanceId
47 const fieldId = fields
48 .getFieldRowsSnapshot(form)
49 .find(({ path }) => path === 'parent')!.fieldId
50β
51 formDevtoolsEventClient.emit('field-debug-report-request', {
52 requestId: 'request-parent',
53 formInstanceId,
54 fieldId,
55 })
56β
57 expect(reports).toEqual([
58 {
59 requestId: 'request-parent',
60 suspicions: [
61 {
62 kind: 'schema-errors-on-unmounted-descendants',
63 evidence: {
64 fieldPath: 'parent',
65 unmountedDescendantPaths: ['parent.child'],
66 },
67 },
68 ],
69 },
70 ])
71β
72 setFieldValidatorErrors(parent, [{ message: 'Parent error' }])
73 formDevtoolsEventClient.emit('field-debug-report-request', {
74 requestId: 'parent-now-has-errors',
75 formInstanceId,
76 fieldId,
77 })
78 expect(reports.at(-1)).toEqual({
79 requestId: 'parent-now-has-errors',
80 suspicions: [],
81 })
82 } finally {
83 cleanupReports()
84 unregisterParent()
85 fields.dispose()
86 mountedForms.dispose()
87 disconnectEventBus()
88 }
89 })
90β
91 it('reports empty-trigger validators from the live validation route', () => {
92 const disconnectEventBus = connectTestEventBus()
93 const mountedForms = createMountedFormsController()
94 const fields = createFieldsController(mountedForms)
95 const form = new InternalFormApi({
96 defaultValues: { name: '' },
97 validators: [emptyTriggerValidator],
98 })
99 const field = form._getOrCreateFieldApi({
100 name: 'name',
101 validators: [emptyTriggerValidator] as never,
102 })
103 const unregister = field._register()
104 const reports: Array<FieldDebugReport> = []
105 const cleanupReports = formDevtoolsEventClient.on(
106 'field-debug-report',
107 (event) => reports.push(event.payload),
108 )
109β
110 try {
111 mountedForms.mountForm(form)
112 const formInstanceId =
113 mountedForms.getMountedFormsSnapshot()[0]!.instanceId
114 const fieldId = fields.getFieldRowsSnapshot(form)[0]!.fieldId
115β
116 formDevtoolsEventClient.emit('field-debug-report-request', {
117 requestId: 'request-empty-triggers',
118 formInstanceId,
119 fieldId,
120 })
121β
122 expect(reports).toEqual([
123 {
124 requestId: 'request-empty-triggers',
125 suspicions: [
126 {
127 kind: 'validators-without-triggers',
128 evidence: {
129 fieldPath: 'name',
130 validators: [
131 { scope: 'field', validatorIndex: 0 },
132 { scope: 'form', validatorIndex: 0 },
133 ],
134 },
135 },
136 ],
137 },
138 ])
139 } finally {
140 cleanupReports()
141 unregister()
142 fields.dispose()
143 mountedForms.dispose()
144 disconnectEventBus()
145 }
146 })
147β
148 it('returns empty reports for invalid targets and stops after disposal', () => {
149 const disconnectEventBus = connectTestEventBus()
150 const mountedForms = createMountedFormsController()
151 const fields = createFieldsController(mountedForms)
152 const form = new InternalFormApi({ defaultValues: { name: '' } })
153 form._getOrCreateFieldApi({ name: 'name' })
154 const reports: Array<FieldDebugReport> = []
155 const cleanupReports = formDevtoolsEventClient.on(
156 'field-debug-report',
157 (event) => reports.push(event.payload),
158 )
159β
160 mountedForms.mountForm(form)
161 const formInstanceId = mountedForms.getMountedFormsSnapshot()[0]!.instanceId
162 const fieldId = fields.getFieldRowsSnapshot(form)[0]!.fieldId
163β
164 formDevtoolsEventClient.emit('field-debug-report-request', {
165 requestId: 'unknown-field',
166 formInstanceId,
167 fieldId: 'unknown',
168 })
169 formDevtoolsEventClient.emit('field-debug-report-request', {
170 requestId: 'unknown-form',
171 formInstanceId: 'unknown',
172 fieldId,
173 })
174β
175 expect(reports).toEqual([
176 { requestId: 'unknown-field', suspicions: [] },
177 { requestId: 'unknown-form', suspicions: [] },
178 ])
179β
180 fields.dispose()
181 formDevtoolsEventClient.emit('field-debug-report-request', {
182 requestId: 'after-dispose',
183 formInstanceId,
184 fieldId,
185 })
186 expect(reports).toHaveLength(2)
187β
188 cleanupReports()
189 mountedForms.dispose()
190 disconnectEventBus()
191 })
192})