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

errorDebugInfoPopover.test.tsx

204 lines5.6 KB

1import { render } from 'solid-js/web'
2import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
3import { FieldDetailErrorItem } from '../src/components/fields/fieldDetails/fieldErrors/FieldDetailErrorItem'
4import { PortalProvider } from '../src/components/ui/portal'
5import { FormDevtoolsStoreProvider } from '../src/stores/formDevtoolsStore'
6import type {
7 DevtoolsFieldError,
8 FieldErrorDebugReport,
9} from '../src/eventClientTypes'
10​
11const debugRequests = vi.hoisted(
12 () =>
13 [] as Array<{
14 onReport: (report: FieldErrorDebugReport) => void
15 cancel: ReturnType<typeof vi.fn>
16 }>,
18​
19vi.mock('../src/debugReports', () => ({
20 requestFieldErrorDebugReport: vi.fn(
21 (_target, onReport: (report: FieldErrorDebugReport) => void) => {
22 const cancel = vi.fn()
23 debugRequests.push({ onReport, cancel })
24 return cancel
25 },
26 ),
27}))
28​
29const error = {
30 error: { message: 'Schema error' },
31 source: {
32 scope: 'field',
33 validatorIndex: 0,
34 validatorType: 'schema',
35 },
36 sourceEvent: 'change',
37} satisfies DevtoolsFieldError
38​
39const suspicion = {
40 kind: 'schema-error-on-unmounted-field',
41 evidence: {
42 fieldPath: 'grandparent.parent.child',
43 mountedAncestorPath: 'grandparent',
44 },
45} as const
46​
47const serverSuspicion = {
48 kind: 'server-error-on-unmounted-field',
49 evidence: {
50 fieldPath: 'firstName',
51 },
52} as const
53​
54const errorsHiddenSuspicion = {
55 kind: 'errors-hidden',
56 evidence: {
57 fieldPath: 'firstName',
58 },
59} as const
60​
61const disposers: Array<() => void> = []
62​
63beforeEach(() => {
64 debugRequests.splice(0)
65})
66​
67afterEach(() => {
68 for (const dispose of disposers.splice(0)) dispose()
69})
70​
71function renderErrorItem() {
72 const container = document.createElement('div')
73 document.body.append(container)
74​
75 const dispose = render(
76 () => (
77 <PortalProvider>
78 <FormDevtoolsStoreProvider>
79 <FieldDetailErrorItem
80 formInstanceId="form-a"
81 fieldId="field-name"
82 error={error}
83 hasHiddenErrors={() => false}
84 />
85 </FormDevtoolsStoreProvider>
86 </PortalProvider>
87 ),
88 container,
89 )
90 disposers.push(() => {
91 dispose()
92 container.remove()
93 })
94​
95 const triggers = container.querySelectorAll<HTMLElement>(
96 '[data-slot="popover-trigger"]',
97 )
98 const debugTrigger = triggers.item(1)
99​
100 const respond = async (
101 report: Omit<FieldErrorDebugReport, 'requestId'> = {
102 suspicions: [suspicion],
103 },
104 ) => {
105 const request = debugRequests.at(-1)
106 expect(request).toBeDefined()
107 request!.onReport({ requestId: 'request', ...report })
108 await Promise.resolve()
109 }
110​
111 const dismiss = async () => {
112 const button = Array.from(
113 document.querySelectorAll<HTMLButtonElement>('[data-slot="button"]'),
114 ).find((candidate) => candidate.textContent.includes('useful'))
115 expect(button).toBeDefined()
116 button!.click()
117 await Promise.resolve()
118 }
119​
120 return {
121 debugTrigger,
122 dismiss,
123 respond,
124 content: () => document.body.textContent,
125 }
127​
128describe('error debug info popover', () => {
129 it('explains how to investigate hidden field errors', async () => {
130 const { content, debugTrigger, respond } = renderErrorItem()
131​
132 debugTrigger.click()
133 await Promise.resolve()
134 await respond({ suspicions: [errorsHiddenSuspicion] })
135​
136 expect(content()).toContain('Errors are hidden')
137 expect(content()).toContain('There are errors')
138 expect(content()).toContain('firstName')
139 expect(content()).toContain('errorVisibility')
140 expect(content()).toContain('handleChange')
141 expect(content()).toContain('handleBlur')
142 expect(content()).toContain('Did the callbacks get called?')
143 })
144​
145 it('explains why FormData omits an unmounted field', async () => {
146 const { content, debugTrigger, respond } = renderErrorItem()
147​
148 debugTrigger.click()
149 await Promise.resolve()
150 await respond({ suspicions: [serverSuspicion] })
151​
152 expect(content()).toContain('Server expected missing field')
153 expect(content()).toContain(
154 'that field was not included in the submitted FormData',
155 )
156 expect(content()).toContain('firstName')
157 })
158​
159 it('requests a report, renders typed evidence, and retains dismissals', async () => {
160 const { content, debugTrigger, dismiss, respond } = renderErrorItem()
161​
162 debugTrigger.click()
163 await Promise.resolve()
164 expect(debugRequests).toHaveLength(1)
165 expect(content()).toContain('Investigating this error')
166​
167 await respond()
168 expect(content()).toContain('Schema error in unmounted field')
169 expect(content()).toContain('grandparent.parent.child')
170 expect(content()).toContain('grandparent')
171​
172 await dismiss()
173 expect(content()).not.toContain('Schema error in unmounted field')
174 expect(content()).toContain(
175 'The only patterns related to this error are no longer considered relevant',
176 )
177​
178 debugTrigger.click()
179 await Promise.resolve()
180 debugTrigger.click()
181 await Promise.resolve()
182 expect(debugRequests).toHaveLength(1)
183 expect(content()).not.toContain('Schema error in unmounted field')
184 })
185​
186 it('shows the generic empty state and resets dismissals on remount', async () => {
187 const empty = renderErrorItem()
188 empty.debugTrigger.click()
189 await Promise.resolve()
190 await empty.respond({ suspicions: [] })
191 expect(empty.content()).toContain(
192 "We couldn't find anything unusual that would help explain this error",
193 )
194​
195 disposers.pop()?.()
196 debugRequests.splice(0)
197​
198 const next = renderErrorItem()
199 next.debugTrigger.click()
200 await Promise.resolve()
201 await next.respond()
202 expect(next.content()).toContain('Schema error in unmounted field')
203 })
204})