Open History to see the last commit
1import { createRoot } from 'solid-js'
2import { afterEach, beforeEach, describe, expect, it } from 'vitest'
3import { createFormDevtoolsStore } from '../src/stores/formDevtoolsStore'
4import { formDevtoolsEventClient } from '../src/eventClient.lib'
5import { connectTestEventBus } from './testEventBus'
6import type { FormDevtoolsStore } from '../src/stores/formDevtoolsStore'
7import type {
8 DevtoolsFieldDetail,
9 DevtoolsMountedFieldScaffold,
10 FieldDetailSubscriptionDescriptor,
11} from '../src/eventClientTypes'
12import type { FormId } from '../src/types/branded'
13β
14const formA = 'form-a' as FormId
15β
16function field(path: string, fieldId: string): DevtoolsMountedFieldScaffold {
17 return { path, fieldId }
18}
19β
20let fieldList!: FormDevtoolsStore['fieldList']
21let fieldMeta!: FormDevtoolsStore['fieldMeta']
22let fieldDetails!: FormDevtoolsStore['fieldDetails']
23let disposeStore!: () => void
24β
25beforeEach(() => {
26 createRoot((dispose) => {
27 const store = createFormDevtoolsStore()
28 fieldList = store.fieldList
29 fieldMeta = store.fieldMeta
30 fieldDetails = store.fieldDetails
31 disposeStore = dispose
32 })
33})
34β
35afterEach(() => {
36 fieldList.setSubscribedFormId(null)
37 fieldList.clearRows()
38 disposeStore()
39})
40β
41describe('field details store', () => {
42 it('stores independent detail settings and restores defaults on reset', () => {
43 fieldList.setSubscribedFormId(formA)
44 fieldList.applySnapshot({
45 formInstanceId: formA,
46 fields: [
47 field('user.name', 'field-name'),
48 field('user.email', 'field-email'),
49 ],
50 })
51 fieldList.setSelectedFieldPath('user.name')
52 fieldList.setFieldPinned('field-email', true)
53β
54 expect(fieldDetails.getFieldDetailSettings('field-name')).toEqual({
55 includeValues: true,
56 errorPayloadMode: 'full',
57 debounceMs: 0,
58 })
59β
60 fieldDetails.updateFieldDetailSettings('field-name', {
61 includeValues: false,
62 errorPayloadMode: 'messages',
63 debounceMs: 25,
64 })
65 fieldDetails.updateFieldDetailSettings('field-email', {
66 errorPayloadMode: 'messages',
67 debounceMs: -10,
68 })
69β
70 expect(fieldDetails.getFieldDetailSettings('field-name')).toEqual({
71 includeValues: false,
72 errorPayloadMode: 'messages',
73 debounceMs: 25,
74 })
75 expect(fieldDetails.getFieldDetailSettings('field-email')).toEqual({
76 includeValues: true,
77 errorPayloadMode: 'messages',
78 debounceMs: 0,
79 })
80β
81 fieldDetails.updateFieldDetailSettings('field-email', {
82 debounceMs: Number.POSITIVE_INFINITY,
83 })
84 expect(fieldDetails.getFieldDetailSettings('field-email').debounceMs).toBe(
85 0,
86 )
87β
88 fieldDetails.resetFieldDetailSettings('field-name')
89β
90 expect(fieldDetails.getFieldDetailSettings('field-name')).toEqual({
91 includeValues: true,
92 errorPayloadMode: 'full',
93 debounceMs: 0,
94 })
95 expect(fieldDetails.fieldDetailSettingsById().has('field-name')).toBe(false)
96 expect(
97 fieldDetails.getFieldDetailSettings('field-email').errorPayloadMode,
98 ).toBe('messages')
99 })
100β
101 it('keeps detail settings with a displayed field across path changes', () => {
102 fieldList.setSubscribedFormId(formA)
103 fieldList.applySnapshot({
104 formInstanceId: formA,
105 fields: [field('items[0]', 'field-item')],
106 })
107 fieldList.setSelectedFieldPath('items[0]')
108 fieldDetails.updateFieldDetailSettings('field-item', {
109 includeValues: false,
110 debounceMs: 50,
111 })
112β
113 fieldList.applyPatch({
114 formInstanceId: formA,
115 upsert: [{ fieldId: 'field-item', path: 'items[1]' }],
116 })
117β
118 expect(fieldList.selectedFieldPath()).toBe('items[1]')
119 expect(fieldDetails.getFieldDetailSettings('field-item')).toEqual({
120 includeValues: false,
121 errorPayloadMode: 'full',
122 debounceMs: 50,
123 })
124 })
125β
126 it('retains settings when unpinned fields remain selected', () => {
127 fieldList.setSubscribedFormId(formA)
128 fieldList.applySnapshot({
129 formInstanceId: formA,
130 fields: [
131 field('user.name', 'field-name'),
132 field('user.email', 'field-email'),
133 ],
134 })
135 fieldList.setSelectedFieldPath('user.name')
136 fieldList.setFieldPinned('field-name', true)
137 fieldDetails.updateFieldDetailSettings('field-name', {
138 errorPayloadMode: 'messages',
139 })
140β
141 fieldList.setFieldPinned('field-name', false)
142β
143 expect(
144 fieldDetails.getFieldDetailSettings('field-name').errorPayloadMode,
145 ).toBe('messages')
146β
147 fieldList.setSelectedFieldPath('user.email')
148β
149 expect(fieldDetails.getFieldDetailSettings('field-name')).toEqual({
150 includeValues: true,
151 errorPayloadMode: 'full',
152 debounceMs: 0,
153 })
154 expect(fieldDetails.fieldDetailSettingsById().has('field-name')).toBe(false)
155 })
156β
157 it('drops detail settings when displayed fields are removed or cleared', () => {
158 fieldList.setSubscribedFormId(formA)
159 fieldList.applySnapshot({
160 formInstanceId: formA,
161 fields: [
162 field('user.name', 'field-name'),
163 field('user.email', 'field-email'),
164 field('user.age', 'field-age'),
165 ],
166 })
167 fieldList.setSelectedFieldPath('user.name')
168 fieldList.setFieldPinned('field-email', true)
169 fieldList.setFieldPinned('field-age', true)
170 fieldDetails.updateFieldDetailSettings('field-name', { debounceMs: 10 })
171 fieldDetails.updateFieldDetailSettings('field-email', { debounceMs: 20 })
172 fieldDetails.updateFieldDetailSettings('field-age', { debounceMs: 30 })
173β
174 fieldList.applyPatch({
175 formInstanceId: formA,
176 remove: ['field-email'],
177 })
178β
179 expect(fieldDetails.fieldDetailSettingsById().has('field-email')).toBe(
180 false,
181 )
182 expect(fieldDetails.fieldDetailSettingsById().has('field-name')).toBe(true)
183β
184 fieldList.applySnapshot({
185 formInstanceId: formA,
186 fields: [field('user.name', 'field-name')],
187 })
188β
189 expect(fieldDetails.fieldDetailSettingsById().has('field-age')).toBe(false)
190 expect(fieldDetails.fieldDetailSettingsById().has('field-name')).toBe(true)
191β
192 fieldList.clearRows()
193β
194 expect(fieldDetails.fieldDetailSettingsById()).toEqual(new Map())
195 })
196β
197 it('reconciles selected and pinned subscriptions and rejects stale details', () => {
198 const disconnectEventBus = connectTestEventBus()
199 const subscribed: Array<FieldDetailSubscriptionDescriptor> = []
200 const unsubscribed: Array<FieldDetailSubscriptionDescriptor> = []
201 const cleanupSubscribe = formDevtoolsEventClient.on(
202 'field-detail-subscribe',
203 (event) => subscribed.push(event.payload),
204 )
205 const cleanupUnsubscribe = formDevtoolsEventClient.on(
206 'field-detail-unsubscribe',
207 (event) => unsubscribed.push(event.payload),
208 )
209 let cleanupEvents: (() => void) | undefined
210β
211 try {
212 fieldList.setSubscribedFormId(formA)
213 fieldList.applySnapshot({
214 formInstanceId: formA,
215 fields: [
216 field('user.name', 'field-name'),
217 {
218 ...field('user.email', 'field-email'),
219 summary: { isDirty: true },
220 },
221 ],
222 })
223 fieldList.setSelectedFieldPath('user.name')
224 fieldList.setFieldPinned('field-email', true)
225β
226 cleanupEvents = fieldDetails.mountEvents()
227β
228 expect(subscribed.map(({ fieldId }) => fieldId)).toEqual([
229 'field-name',
230 'field-email',
231 ])
232β
233 const oldNameDescriptor = subscribed[0]!
234 const oldDetail = {
235 ...oldNameDescriptor,
236 state: { value: 'Ada', meta: {} as never },
237 relations: {
238 directChildCount: 0,
239 listensTo: [{ fieldId: 'field-email', causes: [] }],
240 listenedToBy: [],
241 },
242 defaultValue: '',
243 } satisfies DevtoolsFieldDetail
244 formDevtoolsEventClient.emit('field-detail-changed', oldDetail)
245 expect(fieldDetails.getFieldDetail('field-name')?.state.value).toBe('Ada')
246 const relatedFieldId =
247 fieldDetails.getFieldDetail('field-name')!.relations.listensTo[0]!
248 .fieldId
249 expect(fieldList.rowsByFieldId().get(relatedFieldId)?.path).toBe(
250 'user.email',
251 )
252 expect(fieldMeta.getFieldSummary(relatedFieldId).isDirty).toBe(true)
253β
254 fieldDetails.updateFieldDetailSettings('field-name', {
255 includeValues: false,
256 debounceMs: 50,
257 })
258β
259 const newNameDescriptor = subscribed.at(-1)!
260 expect(newNameDescriptor).toMatchObject({
261 formInstanceId: formA,
262 fieldId: 'field-name',
263 settings: {
264 includeValues: false,
265 errorPayloadMode: 'full',
266 debounceMs: 50,
267 },
268 })
269 expect(unsubscribed).toContainEqual(oldNameDescriptor)
270 expect(fieldDetails.getFieldDetail('field-name')).toBeUndefined()
271β
272 formDevtoolsEventClient.emit('field-detail-changed', oldDetail)
273 expect(fieldDetails.getFieldDetail('field-name')).toBeUndefined()
274β
275 const newDetail = {
276 ...newNameDescriptor,
277 state: { meta: {} as never },
278 relations: {
279 directChildCount: 0,
280 listensTo: [],
281 listenedToBy: [],
282 },
283 } satisfies DevtoolsFieldDetail
284 formDevtoolsEventClient.emit('field-detail-changed', newDetail)
285 expect(fieldDetails.getFieldDetail('field-name')).toBe(newDetail)
286 } finally {
287 cleanupEvents?.()
288 cleanupUnsubscribe()
289 cleanupSubscribe()
290 disconnectEventBus()
291 }
292 })
293})