Open History to see the last commit
1import { batch, createEffect, createRoot, createSignal } from 'solid-js'
2import type { Accessor } from 'solid-js'
3import type {
4 DevtoolsFieldDetail,
5 FieldDetailSettings,
6 FieldDetailSubscriptionDescriptor,
7} from '@/eventClientTypes'
8import type { FieldId, FormId } from '@/types/branded'
9import { formDevtoolsEventClient } from '@/eventClient.lib'
10β
11const defaultFieldDetailSettings = Object.freeze({
12 includeValues: true,
13 errorPayloadMode: 'full',
14 debounceMs: 0,
15}) satisfies FieldDetailSettings
16β
17const [fieldDetailSettingsById, setFieldDetailSettingsById] = createSignal<
18 Map<FieldId, FieldDetailSettings>
19>(new Map(), { equals: false })
20β
21const [fieldDetailsById, setFieldDetailsById] = createSignal<
22 Map<FieldId, DevtoolsFieldDetail>
23>(new Map(), { equals: false })
24β
25function getFieldDetailSettings(fieldId: FieldId): FieldDetailSettings {
26 return fieldDetailSettingsById().get(fieldId) ?? defaultFieldDetailSettings
27}
28β
29function getFieldDetail(fieldId: FieldId): DevtoolsFieldDetail | undefined {
30 return fieldDetailsById().get(fieldId)
31}
32β
33function normalizeDebounceMs(debounceMs: number): number {
34 return Number.isFinite(debounceMs) && debounceMs > 0 ? debounceMs : 0
35}
36β
37function areFieldDetailSettingsEqual(
38 left: FieldDetailSettings,
39 right: FieldDetailSettings,
40): boolean {
41 return (
42 left.includeValues === right.includeValues &&
43 left.errorPayloadMode === right.errorPayloadMode &&
44 left.debounceMs === right.debounceMs
45 )
46}
47β
48function deleteFieldDetail(fieldId: FieldId): void {
49 const current = fieldDetailsById()
50 if (!current.has(fieldId)) return
51β
52 const next = new Map(current)
53 next.delete(fieldId)
54 setFieldDetailsById(next)
55}
56β
57function updateFieldDetailSettings(
58 fieldId: FieldId,
59 patch: Partial<FieldDetailSettings>,
60): void {
61 const current = getFieldDetailSettings(fieldId)
62 const next: FieldDetailSettings = {
63 includeValues: patch.includeValues ?? current.includeValues,
64 errorPayloadMode: patch.errorPayloadMode ?? current.errorPayloadMode,
65 debounceMs:
66 patch.debounceMs === undefined
67 ? current.debounceMs
68 : normalizeDebounceMs(patch.debounceMs),
69 }
70β
71 if (areFieldDetailSettingsEqual(current, next)) return
72β
73 const nextSettingsById = new Map(fieldDetailSettingsById())
74 if (areFieldDetailSettingsEqual(next, defaultFieldDetailSettings)) {
75 nextSettingsById.delete(fieldId)
76 } else {
77 nextSettingsById.set(fieldId, next)
78 }
79β
80 batch(() => {
81 setFieldDetailSettingsById(nextSettingsById)
82 deleteFieldDetail(fieldId)
83 })
84}
85β
86function resetFieldDetailSettings(fieldId: FieldId): void {
87 const current = fieldDetailSettingsById()
88 if (!current.has(fieldId)) return
89β
90 const next = new Map(current)
91 next.delete(fieldId)
92 batch(() => {
93 setFieldDetailSettingsById(next)
94 deleteFieldDetail(fieldId)
95 })
96}
97β
98function getDescriptorKey({
99 formInstanceId,
100 fieldId,
101 settings,
102}: FieldDetailSubscriptionDescriptor): string {
103 return [
104 formInstanceId,
105 fieldId,
106 String(settings.includeValues),
107 settings.errorPayloadMode,
108 String(settings.debounceMs),
109 ].join('\0')
110}
111β
112function areDescriptorsEqual(
113 left: FieldDetailSubscriptionDescriptor,
114 right: FieldDetailSubscriptionDescriptor,
115): boolean {
116 return (
117 left.formInstanceId === right.formInstanceId &&
118 left.fieldId === right.fieldId &&
119 areFieldDetailSettingsEqual(left.settings, right.settings)
120 )
121}
122β
123interface RetainedDescriptor {
124 descriptor: FieldDetailSubscriptionDescriptor
125 consumers: number
126}
127β
128const retainedDescriptors = new Map<string, RetainedDescriptor>()
129β
130function hasRetainedField(formInstanceId: FormId, fieldId: FieldId): boolean {
131 for (const { descriptor } of retainedDescriptors.values()) {
132 if (
133 descriptor.formInstanceId === formInstanceId &&
134 descriptor.fieldId === fieldId
135 ) {
136 return true
137 }
138 }
139 return false
140}
141β
142function retainDescriptor(
143 descriptor: FieldDetailSubscriptionDescriptor,
144): () => void {
145 const key = getDescriptorKey(descriptor)
146 const retained = retainedDescriptors.get(key)
147β
148 if (retained) {
149 retained.consumers++
150 } else {
151 retainedDescriptors.set(key, { descriptor, consumers: 1 })
152 formDevtoolsEventClient.emit('field-detail-subscribe', descriptor)
153 }
154β
155 let isRetained = true
156 return () => {
157 if (!isRetained) return
158 isRetained = false
159β
160 const current = retainedDescriptors.get(key)
161 if (!current) return
162 current.consumers--
163 if (current.consumers > 0) return
164β
165 retainedDescriptors.delete(key)
166 formDevtoolsEventClient.emit('field-detail-unsubscribe', descriptor)
167 if (!hasRetainedField(descriptor.formInstanceId, descriptor.fieldId)) {
168 deleteFieldDetail(descriptor.fieldId)
169 }
170 }
171}
172β
173function applyFieldDetail(detail: DevtoolsFieldDetail): void {
174 const descriptor: FieldDetailSubscriptionDescriptor = detail
175 const retained = retainedDescriptors.get(getDescriptorKey(descriptor))
176 if (!retained || !areDescriptorsEqual(retained.descriptor, descriptor)) {
177 return
178 }
179β
180 const next = new Map(fieldDetailsById())
181 next.set(detail.fieldId, detail)
182 setFieldDetailsById(next)
183}
184β
185let fieldDetailEventConsumers = 0
186let cleanupFieldDetailEvents: (() => void) | undefined
187β
188function retainFieldDetailEvents(): () => void {
189 if (fieldDetailEventConsumers === 0) {
190 cleanupFieldDetailEvents = formDevtoolsEventClient.on(
191 'field-detail-changed',
192 (event) => applyFieldDetail(event.payload),
193 )
194 }
195β
196 fieldDetailEventConsumers++
197 let isRetained = true
198 return () => {
199 if (!isRetained) return
200 isRetained = false
201 fieldDetailEventConsumers--
202β
203 if (fieldDetailEventConsumers === 0) {
204 cleanupFieldDetailEvents?.()
205 cleanupFieldDetailEvents = undefined
206 }
207 }
208}
209β
210const fieldDetailsCache = {
211 fieldDetailSettingsById,
212 fieldDetailsById,
213 getFieldDetailSettings,
214 getFieldDetail,
215 updateFieldDetailSettings,
216 resetFieldDetailSettings,
217 applyDetail: applyFieldDetail,
218}
219β
220function mountFieldDetailEvents(
221 subscribedFormId: Accessor<FormId | null>,
222 displayedFieldIds: Accessor<ReadonlyArray<FieldId>>,
223): () => void {
224 return createRoot((dispose) => {
225 const releaseEvents = retainFieldDetailEvents()
226 let active = new Map<string, () => void>()
227β
228 createEffect(() => {
229 const formInstanceId = subscribedFormId()
230 const desired = new Map<string, FieldDetailSubscriptionDescriptor>()
231β
232 if (formInstanceId) {
233 for (const fieldId of new Set(displayedFieldIds())) {
234 const descriptor: FieldDetailSubscriptionDescriptor = {
235 formInstanceId,
236 fieldId,
237 settings: getFieldDetailSettings(fieldId),
238 }
239 desired.set(getDescriptorKey(descriptor), descriptor)
240 }
241 }
242β
243 const nextActive = new Map<string, () => void>()
244β
245 // Retain replacements before releasing stale descriptors. With multiple
246 // panel roots, this prevents a late old-settings unsubscribe from
247 // removing the newly configured bridge subscription.
248 for (const [key, descriptor] of desired) {
249 nextActive.set(key, active.get(key) ?? retainDescriptor(descriptor))
250 }
251β
252 for (const [key, release] of active) {
253 if (!nextActive.has(key)) release()
254 }
255β
256 active = nextActive
257 })
258β
259 return () => {
260 for (const release of active.values()) release()
261 releaseEvents()
262 dispose()
263 }
264 })
265}
266β
267export function createFieldDetailsStore(
268 subscribedFormId: Accessor<FormId | null>,
269 displayedFieldIds: Accessor<ReadonlyArray<FieldId>>,
270) {
271 createEffect(() => {
272 const retainedFieldIds = new Set(displayedFieldIds())
273 const currentSettings = fieldDetailSettingsById()
274 const currentDetails = fieldDetailsById()
275 let nextSettings: Map<FieldId, FieldDetailSettings> | undefined
276 let nextDetails: Map<FieldId, DevtoolsFieldDetail> | undefined
277β
278 for (const fieldId of currentSettings.keys()) {
279 if (retainedFieldIds.has(fieldId)) continue
280 nextSettings ??= new Map(currentSettings)
281 nextSettings.delete(fieldId)
282 }
283β
284 for (const fieldId of currentDetails.keys()) {
285 if (retainedFieldIds.has(fieldId)) continue
286 nextDetails ??= new Map(currentDetails)
287 nextDetails.delete(fieldId)
288 }
289β
290 batch(() => {
291 if (nextSettings) setFieldDetailSettingsById(nextSettings)
292 if (nextDetails) setFieldDetailsById(nextDetails)
293 })
294 })
295β
296 return {
297 ...fieldDetailsCache,
298 mountEvents: () =>
299 mountFieldDetailEvents(subscribedFormId, displayedFieldIds),
300 }
301}