Open History to see the last commit
1import { render } from 'solid-js/web'
2import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
3import { FieldNoErrorsItem } from '../src/components/fields/fieldDetails/fieldErrors/FieldNoErrorsItem'
4import { PortalProvider } from '../src/components/ui/portal'
5import type {
6 FieldDebugReport,
7 FieldDebugReportRequest,
8 FieldDebugSuspicion,
9} from '../src/eventClientTypes'
10β
11const debugRequests = vi.hoisted(
12 () =>
13 [] as Array<{
14 target: Omit<FieldDebugReportRequest, 'requestId'>
15 onReport: (report: FieldDebugReport) => void
16 cancel: ReturnType<typeof vi.fn>
17 }>,
18)
19β
20vi.mock('../src/debugReports', () => ({
21 requestFieldDebugReport: vi.fn(
22 (
23 target: Omit<FieldDebugReportRequest, 'requestId'>,
24 onReport: (report: FieldDebugReport) => void,
25 ) => {
26 const cancel = vi.fn()
27 debugRequests.push({ target, onReport, cancel })
28 return cancel
29 },
30 ),
31}))
32β
33const suspicion = {
34 kind: 'schema-errors-on-unmounted-descendants',
35 evidence: {
36 fieldPath: 'dateRange',
37 unmountedDescendantPaths: ['dateRange.start', 'dateRange.end'],
38 },
39} satisfies FieldDebugSuspicion
40β
41const validatorsWithoutTriggersSuspicion = {
42 kind: 'validators-without-triggers',
43 evidence: {
44 fieldPath: 'profile.name',
45 validators: [
46 { scope: 'field', validatorIndex: 0 },
47 {
48 scope: 'formGroup',
49 formGroupPath: 'profile',
50 validatorIndex: 1,
51 },
52 ],
53 },
54} satisfies FieldDebugSuspicion
55β
56const disposers: Array<() => void> = []
57β
58beforeEach(() => {
59 debugRequests.splice(0)
60})
61β
62afterEach(() => {
63 for (const dispose of disposers.splice(0)) dispose()
64})
65β
66function renderNoErrorsItem() {
67 const container = document.createElement('div')
68 document.body.append(container)
69β
70 const dispose = render(
71 () => (
72 <PortalProvider>
73 <FieldNoErrorsItem formInstanceId="form-a" fieldId="field-name" />
74 </PortalProvider>
75 ),
76 container,
77 )
78 disposers.push(() => {
79 dispose()
80 container.remove()
81 })
82β
83 const debugTrigger = container.querySelector<HTMLElement>(
84 '[aria-label="Debug field"]',
85 )!
86β
87 const respond = async (
88 report: Omit<FieldDebugReport, 'requestId'> = {
89 suspicions: [suspicion],
90 },
91 ) => {
92 const request = debugRequests.at(-1)
93 expect(request).toBeDefined()
94 request!.onReport({ requestId: 'request', ...report })
95 await Promise.resolve()
96 }
97β
98 const dismiss = async () => {
99 const button = Array.from(
100 document.querySelectorAll<HTMLButtonElement>('[data-slot="button"]'),
101 ).find((candidate) => candidate.textContent.includes('useful'))
102 expect(button).toBeDefined()
103 button!.click()
104 await Promise.resolve()
105 }
106β
107 return {
108 debugTrigger,
109 dismiss,
110 respond,
111 content: () => document.body.textContent,
112 }
113}
114β
115describe('field debug info popover', () => {
116 it('explains empty validator trigger arrays with their locations', async () => {
117 const { content, debugTrigger, respond } = renderNoErrorsItem()
118β
119 debugTrigger.click()
120 await Promise.resolve()
121 await respond({ suspicions: [validatorsWithoutTriggersSuspicion] })
122β
123 expect(content()).toContain('Validators with triggers: []')
124 expect(content()).toContain('profile.name')
125 expect(content()).toContain('Form group')
126 expect(content()).toContain('profile')
127 expect(content()).toContain('#1')
128 expect(content()).toContain('#2')
129 expect(content()).toContain('triggers: []')
130 expect(content()).toContain('change')
131 expect(content()).toContain('blur')
132 expect(content()).toContain('Submit validation runs by default')
133 expect(content()).toContain('runOnMount: true')
134 })
135β
136 it('requests field guidance, renders aggregated paths, and retains dismissals', async () => {
137 const { content, debugTrigger, dismiss, respond } = renderNoErrorsItem()
138β
139 expect(content()).toContain('No error')
140 debugTrigger.click()
141 await Promise.resolve()
142 expect(debugRequests).toHaveLength(1)
143 expect(debugRequests[0]!.target).toEqual({
144 formInstanceId: 'form-a',
145 fieldId: 'field-name',
146 })
147 expect(content()).toContain('Investigating this field')
148β
149 await respond()
150 expect(content()).toContain('Schema errors in unmounted fields')
151 expect(content()).toContain('dateRange.start')
152 expect(content()).toContain('dateRange.end')
153β
154 await dismiss()
155 expect(content()).not.toContain('Schema errors in unmounted fields')
156 expect(content()).toContain(
157 'The only patterns related to this field are no longer considered relevant',
158 )
159β
160 debugTrigger.click()
161 await Promise.resolve()
162 debugTrigger.click()
163 await Promise.resolve()
164 expect(debugRequests).toHaveLength(1)
165 })
166β
167 it('shows the field-specific empty state', async () => {
168 const { content, debugTrigger, respond } = renderNoErrorsItem()
169β
170 debugTrigger.click()
171 await Promise.resolve()
172 await respond({ suspicions: [] })
173β
174 expect(content()).toContain(
175 "We couldn't find anything unusual that would help explain why this field has no errors",
176 )
177 })
178})