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

fieldDebugReportsBridge.test.ts

168 lines5.5 KB

1import { InternalFormApi } from '@tanstack/form-core/internals'
2import { describe, expect, it } from 'vitest'
3import { createFieldsController } from '../src/bridge/fields'
4import { createMountedFormsController } from '../src/bridge/forms/mountedForms'
5import { formDevtoolsEventClient } from '../src/eventClient.lib'
6import { connectTestEventBus } from './testEventBus'
7import type {
8 DevtoolsFieldError,
9 FieldErrorDebugReport,
10} from '../src/eventClientTypes'
11​
12const schemaError = {
13 error: { message: 'Schema error' },
14 source: {
15 scope: 'form',
16 validatorIndex: 0,
17 validatorType: 'schema',
18 },
19 sourceEvent: 'change',
20} satisfies DevtoolsFieldError
21​
22describe('field debug report bridge', () => {
23 it('returns a correlated report built from the live field trie', () => {
24 const disconnectEventBus = connectTestEventBus()
25 const mountedForms = createMountedFormsController()
26 const fields = createFieldsController(mountedForms)
27 const form = new InternalFormApi({
28 defaultValues: { parent: { child: '' } },
29 })
30 const parent = form._getOrCreateFieldApi({ name: 'parent' })
31 form._getOrCreateFieldApi({ name: 'parent.child' })
32 const unregisterParent = parent._register()
33 const reports: Array<FieldErrorDebugReport> = []
34 const cleanupReports = formDevtoolsEventClient.on(
35 'field-error-debug-report',
36 (event) => reports.push(event.payload),
37 )
38​
39 try {
40 mountedForms.mountForm(form)
41 const formInstanceId =
42 mountedForms.getMountedFormsSnapshot()[0]!.instanceId
43 const fieldId = fields
44 .getFieldRowsSnapshot(form)
45 .find(({ path }) => path === 'parent.child')!.fieldId
46​
47 formDevtoolsEventClient.emit('field-error-debug-report-request', {
48 requestId: 'request-child',
49 formInstanceId,
50 fieldId,
51 error: schemaError,
52 })
53​
54 expect(reports).toEqual([
55 {
56 requestId: 'request-child',
57 suspicions: [
58 {
59 kind: 'schema-error-on-unmounted-field',
60 evidence: {
61 fieldPath: 'parent.child',
62 mountedAncestorPath: 'parent',
63 },
64 },
65 ],
66 },
67 ])
68 } finally {
69 cleanupReports()
70 unregisterParent()
71 fields.dispose()
72 mountedForms.dispose()
73 disconnectEventBus()
74 }
75 })
76​
77 it('returns empty reports for invalid targets and keeps requests isolated', () => {
78 const disconnectEventBus = connectTestEventBus()
79 const mountedForms = createMountedFormsController()
80 const fields = createFieldsController(mountedForms)
81 const firstForm = new InternalFormApi({ defaultValues: { first: '' } })
82 const secondForm = new InternalFormApi({ defaultValues: { second: '' } })
83 const firstField = firstForm._getOrCreateFieldApi({ name: 'first' })
84 const secondField = secondForm._getOrCreateFieldApi({ name: 'second' })
85 const reports: Array<FieldErrorDebugReport> = []
86 const cleanupReports = formDevtoolsEventClient.on(
87 'field-error-debug-report',
88 (event) => reports.push(event.payload),
89 )
90​
91 try {
92 mountedForms.mountForm(firstForm)
93 mountedForms.mountForm(secondForm)
94 const mounted = mountedForms.getMountedFormsSnapshot()
95 const firstFormId = mounted[0]!.instanceId
96 const secondFieldId = fields.getFieldRowsSnapshot(secondForm)[0]!.fieldId
97 const firstFieldId = fields.getFieldRowsSnapshot(firstForm)[0]!.fieldId
98​
99 formDevtoolsEventClient.emit('field-error-debug-report-request', {
100 requestId: 'wrong-form',
101 formInstanceId: firstFormId,
102 fieldId: secondFieldId,
103 error: schemaError,
104 })
105 formDevtoolsEventClient.emit('field-error-debug-report-request', {
106 requestId: 'unknown-field',
107 formInstanceId: firstFormId,
108 fieldId: 'unknown',
109 error: schemaError,
110 })
111 formDevtoolsEventClient.emit('field-error-debug-report-request', {
112 requestId: 'unknown-form',
113 formInstanceId: 'unknown',
114 fieldId: firstFieldId,
115 error: schemaError,
116 })
117​
118 expect(reports).toEqual([
119 { requestId: 'wrong-form', suspicions: [] },
120 { requestId: 'unknown-field', suspicions: [] },
121 { requestId: 'unknown-form', suspicions: [] },
122 ])
123​
124 firstField._isKilled = true
125 formDevtoolsEventClient.emit('field-error-debug-report-request', {
126 requestId: 'killed-field',
127 formInstanceId: firstFormId,
128 fieldId: firstFieldId,
129 error: schemaError,
130 })
131 expect(reports.at(-1)).toEqual({
132 requestId: 'killed-field',
133 suspicions: [],
134 })
135 firstField._isKilled = false
136 expect(secondField._isKilled).toBe(false)
137 } finally {
138 cleanupReports()
139 fields.dispose()
140 mountedForms.dispose()
141 disconnectEventBus()
142 }
143 })
144​
145 it('stops responding after disposal', () => {
146 const disconnectEventBus = connectTestEventBus()
147 const mountedForms = createMountedFormsController()
148 const fields = createFieldsController(mountedForms)
149 const reports: Array<FieldErrorDebugReport> = []
150 const cleanupReports = formDevtoolsEventClient.on(
151 'field-error-debug-report',
152 (event) => reports.push(event.payload),
153 )
154​
155 fields.dispose()
156 formDevtoolsEventClient.emit('field-error-debug-report-request', {
157 requestId: 'after-dispose',
158 formInstanceId: 'form',
159 fieldId: 'field',
160 error: schemaError,
161 })
162​
163 expect(reports).toEqual([])
164 cleanupReports()
165 mountedForms.dispose()
166 disconnectEventBus()
167 })
168})