Open History to see the last commit
1import { InternalFormApi } from '@tanstack/form-core/internals'
2import { describe, expect, it, vi } 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 { DevtoolsFieldDetail } from '../src/eventClientTypes'
8import type { FieldId } from '../src/types/branded'
9β
10describe('field actions bridge', () => {
11 it('runs change, blur, and reset actions on an unmounted field', () => {
12 const disconnectEventBus = connectTestEventBus()
13 const mountedForms = createMountedFormsController()
14 const fields = createFieldsController(mountedForms)
15 const changeListener = vi.fn()
16 const blurListener = vi.fn()
17 const resetListener = vi.fn()
18 const details: Array<DevtoolsFieldDetail> = []
19 const cleanupDetails = formDevtoolsEventClient.on(
20 'field-detail-changed',
21 (event) => details.push(event.payload),
22 )
23 const form = new InternalFormApi({ defaultValues: { name: 'Ada' } })
24 const field = form._getOrCreateFieldApi({
25 name: 'name',
26 listeners: [
27 { triggers: ['change'], run: changeListener },
28 { triggers: ['blur'], run: blurListener },
29 { triggers: ['reset'], run: resetListener },
30 ],
31 })
32β
33 try {
34 mountedForms.mountForm(form)
35 const formInstanceId =
36 mountedForms.getMountedFormsSnapshot()[0]!.instanceId
37 const fieldId = fields.getFieldRowsSnapshot(form)[0]!.fieldId
38 const request = { formInstanceId, fieldId }
39 formDevtoolsEventClient.emit('field-detail-subscribe', {
40 ...request,
41 settings: {
42 includeValues: true,
43 errorPayloadMode: 'full',
44 debounceMs: 0,
45 },
46 })
47β
48 expect(field._isMounted).toBe(false)
49β
50 formDevtoolsEventClient.emit('field-handle-change-request', request)
51 expect(changeListener).toHaveBeenCalledOnce()
52 expect(field.value).toBe('Ada')
53β
54 formDevtoolsEventClient.emit('field-handle-blur-request', request)
55 expect(blurListener).toHaveBeenCalledOnce()
56 expect(field.meta).toMatchObject({
57 isTouched: true,
58 isBlurred: true,
59 })
60β
61 field.handleChange('Grace')
62 changeListener.mockClear()
63 formDevtoolsEventClient.emit('field-reset-request', request)
64 expect(resetListener).toHaveBeenCalledOnce()
65 expect(changeListener).not.toHaveBeenCalled()
66 expect(field.value).toBe('Ada')
67 expect(field.meta).toMatchObject({
68 isTouched: false,
69 isDirty: false,
70 isBlurred: false,
71 })
72 expect(details.at(-1)?.state.meta).toMatchObject({
73 isTouched: false,
74 isDirty: false,
75 isBlurred: false,
76 })
77 expect(field._isMounted).toBe(false)
78 } finally {
79 cleanupDetails()
80 fields.dispose()
81 mountedForms.dispose()
82 disconnectEventBus()
83 }
84 })
85β
86 it('ignores invalid targets and stops handling requests after disposal', () => {
87 const disconnectEventBus = connectTestEventBus()
88 const mountedForms = createMountedFormsController()
89 const fields = createFieldsController(mountedForms)
90 const firstForm = new InternalFormApi({ defaultValues: { name: '' } })
91 const secondForm = new InternalFormApi({ defaultValues: { name: '' } })
92 const firstField = firstForm._getOrCreateFieldApi({ name: 'name' })
93 const secondField = secondForm._getOrCreateFieldApi({ name: 'name' })
94 const firstBlur = vi.spyOn(firstField, 'handleBlur')
95 const secondBlur = vi.spyOn(secondField, 'handleBlur')
96β
97 mountedForms.mountForm(firstForm)
98 mountedForms.mountForm(secondForm)
99 const [firstMountedForm, secondMountedForm] =
100 mountedForms.getMountedFormsSnapshot()
101 const firstFieldId = fields.getFieldRowsSnapshot(firstForm)[0]!.fieldId
102 const secondFieldId = fields.getFieldRowsSnapshot(secondForm)[0]!.fieldId
103β
104 formDevtoolsEventClient.emit('field-handle-blur-request', {
105 formInstanceId: secondMountedForm!.instanceId,
106 fieldId: firstFieldId,
107 })
108 formDevtoolsEventClient.emit('field-handle-blur-request', {
109 formInstanceId: firstMountedForm!.instanceId,
110 fieldId: 'missing-field' as FieldId,
111 })
112 firstField._kill()
113 formDevtoolsEventClient.emit('field-handle-blur-request', {
114 formInstanceId: firstMountedForm!.instanceId,
115 fieldId: firstFieldId,
116 })
117β
118 expect(firstBlur).not.toHaveBeenCalled()
119 expect(secondBlur).not.toHaveBeenCalled()
120β
121 fields.dispose()
122 formDevtoolsEventClient.emit('field-handle-blur-request', {
123 formInstanceId: secondMountedForm!.instanceId,
124 fieldId: secondFieldId,
125 })
126 expect(secondBlur).not.toHaveBeenCalled()
127β
128 mountedForms.dispose()
129 disconnectEventBus()
130 })
131})