-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathuseRevalidateFieldDataPostMessageEvent.test.ts
More file actions
386 lines (313 loc) · 14.2 KB
/
useRevalidateFieldDataPostMessageEvent.test.ts
File metadata and controls
386 lines (313 loc) · 14.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
import { vi, describe, it, expect, beforeEach, afterEach } from "vitest";
import { VisualBuilder } from "../..";
import { FieldSchemaMap } from "../../utils/fieldSchemaMap";
import { handleRevalidateFieldData } from "../useRevalidateFieldDataPostMessageEvent";
import * as cslpdata from "../../../cslp";
// Mock dependencies
vi.mock("../../utils/fieldSchemaMap", () => ({
FieldSchemaMap: {
clearContentTypeSchema: vi.fn(),
clear: vi.fn(),
},
}));
vi.spyOn(cslpdata, "extractDetailsFromCslp");
vi.mock("../../generators/generateOverlay", () => ({
hideFocusOverlay: vi.fn(),
}));
vi.mock("../../listeners/mouseClick", () => ({
handleBuilderInteraction: vi.fn(),
}));
// Mock window.location.reload
Object.defineProperty(window, "location", {
value: {
reload: vi.fn(),
},
writable: true,
});
// Mock requestAnimationFrame
global.requestAnimationFrame = vi.fn((cb) => {
cb(0);
return 0;
});
describe("handleRevalidateFieldData", () => {
let visualBuilderContainer: HTMLDivElement;
let overlayWrapper: HTMLDivElement;
let focusedToolbar: HTMLDivElement;
// Create DOM elements once for all tests (optimization)
beforeAll(() => {
visualBuilderContainer = document.createElement("div");
visualBuilderContainer.classList.add("visual-builder__container");
overlayWrapper = document.createElement("div");
overlayWrapper.classList.add("visual-builder__overlay__wrapper");
focusedToolbar = document.createElement("div");
focusedToolbar.classList.add("visual-builder__focused-toolbar");
document.body.appendChild(visualBuilderContainer);
document.body.appendChild(overlayWrapper);
document.body.appendChild(focusedToolbar);
});
beforeEach(() => {
// Clear mocks before each test to ensure clean state
vi.clearAllMocks();
// Reset VisualBuilder global state
VisualBuilder.VisualBuilderGlobalState = {
// @ts-expect-error mocking only required properties
value: {
previousHoveredTargetDOM: null,
previousSelectedEditableDOM: null,
isFocussed: false,
},
};
});
// Clean up DOM after all tests complete
afterAll(() => {
document.body.innerHTML = "";
});
it("should revalidate specific field when hovered element exists", async () => {
const mockElement = document.createElement("div");
mockElement.setAttribute("data-cslp", "content_type.entry.field");
VisualBuilder.VisualBuilderGlobalState.value.previousHoveredTargetDOM =
mockElement;
const mockExtractDetailsFromCslp = await import("../../../cslp");
vi.mocked(
mockExtractDetailsFromCslp.extractDetailsFromCslp
).mockReturnValue({
content_type_uid: "test_content_type",
entry_uid: "test_entry",
locale: "en-us",
fieldPath: "test_field",
fieldPathWithIndex: "test_field",
} as any);
await handleRevalidateFieldData();
expect(FieldSchemaMap.clearContentTypeSchema).toHaveBeenCalledWith(
"test_content_type"
);
expect(window.location.reload).not.toHaveBeenCalled();
});
it("should fallback to focused element when no hovered element", async () => {
const mockElement = document.createElement("div");
mockElement.setAttribute("data-cslp", "content_type.entry.field");
VisualBuilder.VisualBuilderGlobalState.value.previousHoveredTargetDOM =
null;
VisualBuilder.VisualBuilderGlobalState.value.previousSelectedEditableDOM =
mockElement;
const mockExtractDetailsFromCslp = await import("../../../cslp");
vi.mocked(
mockExtractDetailsFromCslp.extractDetailsFromCslp
).mockReturnValue({
content_type_uid: "test_content_type",
entry_uid: "test_entry",
locale: "en-us",
fieldPath: "test_field",
fieldPathWithIndex: "test_field",
} as any);
await handleRevalidateFieldData();
expect(FieldSchemaMap.clearContentTypeSchema).toHaveBeenCalledWith(
"test_content_type"
);
});
it("should clear all field schema cache when no target element", async () => {
VisualBuilder.VisualBuilderGlobalState.value.previousHoveredTargetDOM =
null;
VisualBuilder.VisualBuilderGlobalState.value.previousSelectedEditableDOM =
null;
await handleRevalidateFieldData();
expect(FieldSchemaMap.clear).toHaveBeenCalled();
expect(window.location.reload).not.toHaveBeenCalled();
});
it("should refresh iframe when clearing cache fails", async () => {
VisualBuilder.VisualBuilderGlobalState.value.previousHoveredTargetDOM =
null;
VisualBuilder.VisualBuilderGlobalState.value.previousSelectedEditableDOM =
null;
vi.mocked(FieldSchemaMap.clear).mockImplementation(() => {
throw new Error("Cache clear failed");
});
await handleRevalidateFieldData();
expect(FieldSchemaMap.clear).toHaveBeenCalled();
expect(window.location.reload).toHaveBeenCalled();
});
it("should refresh iframe when any error occurs", async () => {
const mockElement = document.createElement("div");
mockElement.setAttribute("data-cslp", "content_type.entry.field");
VisualBuilder.VisualBuilderGlobalState.value.previousHoveredTargetDOM =
mockElement;
const mockExtractDetailsFromCslp = await import("../../../cslp");
vi.mocked(
mockExtractDetailsFromCslp.extractDetailsFromCslp
).mockImplementation(() => {
throw new Error("CSLP parsing failed");
});
await handleRevalidateFieldData();
expect(window.location.reload).toHaveBeenCalled();
});
it("should handle elements without data-cslp attribute", async () => {
const mockElement = document.createElement("div");
// No data-cslp attribute
VisualBuilder.VisualBuilderGlobalState.value.previousHoveredTargetDOM =
mockElement;
// Reset the clear mock to not throw error for this test
vi.mocked(FieldSchemaMap.clear).mockReset();
vi.mocked(FieldSchemaMap.clear).mockImplementation(() => {
// Successful clear - no error
});
await handleRevalidateFieldData();
expect(FieldSchemaMap.clear).toHaveBeenCalled();
expect(window.location.reload).not.toHaveBeenCalled();
});
describe("unfocus and refocus behavior", () => {
let hideFocusOverlay: any;
let handleBuilderInteraction: any;
// Import mocked modules once for all tests in this describe block
beforeAll(async () => {
const overlayModule = await import(
"../../generators/generateOverlay"
);
const mouseClickModule = await import("../../listeners/mouseClick");
hideFocusOverlay = vi.mocked(overlayModule.hideFocusOverlay);
handleBuilderInteraction = vi.mocked(
mouseClickModule.handleBuilderInteraction
);
});
it("should unfocus element before revalidation when focused element exists", async () => {
const mockElement = document.createElement("div");
mockElement.setAttribute("data-cslp", "content_type.entry.field");
mockElement.setAttribute("data-cslp-unique-id", "unique-123");
VisualBuilder.VisualBuilderGlobalState.value.previousSelectedEditableDOM =
mockElement;
VisualBuilder.VisualBuilderGlobalState.value.isFocussed = true;
const mockExtractDetailsFromCslp = await import("../../../cslp");
vi.mocked(
mockExtractDetailsFromCslp.extractDetailsFromCslp
).mockReturnValue({
content_type_uid: "test_content_type",
entry_uid: "test_entry",
locale: "en-us",
fieldPath: "test_field",
fieldPathWithIndex: "test_field",
} as any);
await handleRevalidateFieldData();
// Should call hideFocusOverlay to unfocus
expect(hideFocusOverlay).toHaveBeenCalledWith(
expect.objectContaining({
visualBuilderContainer: expect.any(HTMLDivElement),
visualBuilderOverlayWrapper: expect.any(HTMLDivElement),
focusedToolbar: expect.any(HTMLDivElement),
noTrigger: true,
})
);
// Should clear global state
expect(
VisualBuilder.VisualBuilderGlobalState.value
.previousSelectedEditableDOM
).toBeNull();
expect(
VisualBuilder.VisualBuilderGlobalState.value.isFocussed
).toBe(false);
});
it("should refocus element after revalidation completes", async () => {
const mockElement = document.createElement("div");
mockElement.setAttribute("data-cslp", "content_type.entry.field");
mockElement.setAttribute("data-cslp-unique-id", "unique-123");
document.body.appendChild(mockElement);
VisualBuilder.VisualBuilderGlobalState.value.previousSelectedEditableDOM =
mockElement;
const mockExtractDetailsFromCslp = await import("../../../cslp");
vi.mocked(
mockExtractDetailsFromCslp.extractDetailsFromCslp
).mockReturnValue({
content_type_uid: "test_content_type",
entry_uid: "test_entry",
locale: "en-us",
fieldPath: "test_field",
fieldPathWithIndex: "test_field",
} as any);
await handleRevalidateFieldData();
// Should refocus the element using unique ID
expect(handleBuilderInteraction).toHaveBeenCalledWith(
expect.objectContaining({
event: expect.any(MouseEvent),
previousSelectedEditableDOM: null,
visualBuilderContainer: expect.any(HTMLDivElement),
overlayWrapper: expect.any(HTMLDivElement),
})
);
document.body.removeChild(mockElement);
});
it("should refocus using data-cslp when unique ID is not available", async () => {
const mockElement = document.createElement("div");
mockElement.setAttribute("data-cslp", "content_type.entry.field");
// No unique ID
document.body.appendChild(mockElement);
VisualBuilder.VisualBuilderGlobalState.value.previousSelectedEditableDOM =
mockElement;
const mockExtractDetailsFromCslp = await import("../../../cslp");
vi.mocked(
mockExtractDetailsFromCslp.extractDetailsFromCslp
).mockReturnValue({
content_type_uid: "test_content_type",
entry_uid: "test_entry",
locale: "en-us",
fieldPath: "test_field",
fieldPathWithIndex: "test_field",
} as any);
await handleRevalidateFieldData();
// Should still call handleBuilderInteraction
expect(handleBuilderInteraction).toHaveBeenCalled();
document.body.removeChild(mockElement);
});
it("should not refocus if element cannot be found after revalidation", async () => {
const mockElement = document.createElement("div");
mockElement.setAttribute("data-cslp", "content_type.entry.field");
// Don't append to DOM - element won't be found
VisualBuilder.VisualBuilderGlobalState.value.previousSelectedEditableDOM =
mockElement;
const mockExtractDetailsFromCslp = await import("../../../cslp");
vi.mocked(
mockExtractDetailsFromCslp.extractDetailsFromCslp
).mockReturnValue({
content_type_uid: "test_content_type",
entry_uid: "test_entry",
locale: "en-us",
fieldPath: "test_field",
fieldPathWithIndex: "test_field",
} as any);
await handleRevalidateFieldData();
// Should not call handleBuilderInteraction if element not found
expect(handleBuilderInteraction).not.toHaveBeenCalled();
});
it("should not unfocus or refocus when no element is focused", async () => {
VisualBuilder.VisualBuilderGlobalState.value.previousSelectedEditableDOM =
null;
await handleRevalidateFieldData();
// Should not call unfocus/refocus functions
expect(hideFocusOverlay).not.toHaveBeenCalled();
expect(handleBuilderInteraction).not.toHaveBeenCalled();
// Should still clear cache
expect(FieldSchemaMap.clear).toHaveBeenCalled();
});
it("should handle refocus errors gracefully", async () => {
const mockElement = document.createElement("div");
mockElement.setAttribute("data-cslp", "content_type.entry.field");
document.body.appendChild(mockElement);
VisualBuilder.VisualBuilderGlobalState.value.previousSelectedEditableDOM =
mockElement;
const mockExtractDetailsFromCslp = await import("../../../cslp");
vi.mocked(
mockExtractDetailsFromCslp.extractDetailsFromCslp
).mockReturnValue({
content_type_uid: "test_content_type",
entry_uid: "test_entry",
locale: "en-us",
fieldPath: "test_field",
fieldPathWithIndex: "test_field",
} as any);
// Make handleBuilderInteraction throw an error
handleBuilderInteraction.mockRejectedValueOnce(
new Error("Refocus failed")
);
// Should not throw - error should be caught and logged
await expect(handleRevalidateFieldData()).resolves.not.toThrow();
document.body.removeChild(mockElement);
});
});
});