-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathuseEventBatcher.test.ts
More file actions
686 lines (561 loc) · 21.3 KB
/
Copy pathuseEventBatcher.test.ts
File metadata and controls
686 lines (561 loc) · 21.3 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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
import { renderHook, act } from '@testing-library/react';
import { QueryClient } from '@tanstack/react-query';
import {
applyBatch,
useEventBatcher,
type ResourceEvent,
} from './useEventBatcher';
// WatchState enum values (matches Wails-generated enum).
const IDLE = 0;
const SYNCING = 1;
const SYNCED = 2;
// ---------------------------------------------------------------------------
// applyBatch (pure function) — no timers needed
// ---------------------------------------------------------------------------
describe('applyBatch', () => {
const idAccessor = 'metadata.name';
const makeItem = (name: string, extra?: Record<string, unknown>) => ({
metadata: { name },
...extra,
});
const baseData = {
result: [makeItem('pod-1'), makeItem('pod-2')],
success: true,
totalCount: 2,
};
it('adds a new item via ADD', () => {
const events: ResourceEvent[] = [
{
type: 'ADD',
payload: { data: makeItem('pod-3'), key: 'k', connection: 'c', id: 'pod-3', namespace: 'default' },
},
];
const result = applyBatch(baseData, events, idAccessor);
expect(result.result).toHaveLength(3);
expect(result.result[2].metadata.name).toBe('pod-3');
});
it('deduplicates ADD for an existing item', () => {
const events: ResourceEvent[] = [
{
type: 'ADD',
payload: { data: makeItem('pod-1'), key: 'k', connection: 'c', id: 'pod-1', namespace: 'default' },
},
];
const result = applyBatch(baseData, events, idAccessor);
expect(result.result).toHaveLength(2);
});
it('updates an existing item via UPDATE', () => {
const events: ResourceEvent[] = [
{
type: 'UPDATE',
payload: {
data: makeItem('pod-1', { status: 'Running' }),
key: 'k', connection: 'c', id: 'pod-1', namespace: 'default',
},
},
];
const result = applyBatch(baseData, events, idAccessor);
expect(result.result).toHaveLength(2);
expect(result.result[0].status).toBe('Running');
});
it('ignores UPDATE for non-existent item', () => {
const events: ResourceEvent[] = [
{
type: 'UPDATE',
payload: {
data: makeItem('pod-999'),
key: 'k', connection: 'c', id: 'pod-999', namespace: 'default',
},
},
];
const result = applyBatch(baseData, events, idAccessor);
expect(result.result).toHaveLength(2);
});
it('removes an item via DELETE', () => {
const events: ResourceEvent[] = [
{
type: 'DELETE',
payload: { data: makeItem('pod-1'), key: 'k', connection: 'c', id: 'pod-1', namespace: 'default' },
},
];
const result = applyBatch(baseData, events, idAccessor);
expect(result.result).toHaveLength(1);
expect(result.result[0].metadata.name).toBe('pod-2');
});
it('ignores DELETE for non-existent item', () => {
const events: ResourceEvent[] = [
{
type: 'DELETE',
payload: { data: makeItem('pod-999'), key: 'k', connection: 'c', id: 'pod-999', namespace: 'default' },
},
];
const result = applyBatch(baseData, events, idAccessor);
expect(result.result).toHaveLength(2);
});
it('applies multiple events in sequence', () => {
const events: ResourceEvent[] = [
{ type: 'ADD', payload: { data: makeItem('pod-3'), key: 'k', connection: 'c', id: 'pod-3', namespace: 'default' } },
{ type: 'UPDATE', payload: { data: makeItem('pod-1', { status: 'Running' }), key: 'k', connection: 'c', id: 'pod-1', namespace: 'default' } },
{ type: 'DELETE', payload: { data: makeItem('pod-2'), key: 'k', connection: 'c', id: 'pod-2', namespace: 'default' } },
];
const result = applyBatch(baseData, events, idAccessor);
expect(result.result).toHaveLength(2);
expect(result.result[0].metadata.name).toBe('pod-1');
expect(result.result[0].status).toBe('Running');
expect(result.result[1].metadata.name).toBe('pod-3');
});
it('handles undefined oldData by creating a fresh structure', () => {
const events: ResourceEvent[] = [
{ type: 'ADD', payload: { data: makeItem('pod-1'), key: 'k', connection: 'c', id: 'pod-1', namespace: 'default' } },
];
const result = applyBatch(undefined, events, idAccessor);
expect(result.result).toHaveLength(1);
expect(result.success).toBe(true);
});
it('handles class instances (non-plain objects) as oldData', () => {
class ListResult {
result: any[];
success: boolean;
totalCount: number;
constructor() {
this.result = [makeItem('pod-1')];
this.success = true;
this.totalCount = 1;
}
}
const classData = new ListResult();
const events: ResourceEvent[] = [
{ type: 'ADD', payload: { data: makeItem('pod-2'), key: 'k', connection: 'c', id: 'pod-2', namespace: 'default' } },
];
const result = applyBatch(classData, events, idAccessor);
expect(result.result).toHaveLength(2);
});
it('supports nested id accessor paths', () => {
const deepAccessor = 'spec.id';
const data = {
result: [{ spec: { id: 'a' } }],
success: true,
totalCount: 1,
};
const events: ResourceEvent[] = [
{ type: 'UPDATE', payload: { data: { spec: { id: 'a' }, updated: true }, key: 'k', connection: 'c', id: 'a', namespace: 'default' } },
];
const result = applyBatch(data, events, deepAccessor);
expect(result.result[0].updated).toBe(true);
});
});
// ---------------------------------------------------------------------------
// useEventBatcher (hook) — adaptive batching
// ---------------------------------------------------------------------------
// Shared helpers.
const queryKey = ['resources', 'test'];
const getResourceKey = (id: string, ns: string) => ['resource', ns, id];
const idAccessor = 'metadata.name';
const makePayload = (id: string, type: 'ADD' | 'UPDATE' | 'DELETE'): ResourceEvent => ({
type,
payload: {
data: { metadata: { name: id } },
key: 'core::v1::Pod',
connection: 'cluster-1',
id,
namespace: 'default',
},
} as ResourceEvent);
function makeQueryClient() {
const qc = new QueryClient({
defaultOptions: { queries: { retry: false } },
});
qc.setQueryData(queryKey, { result: [], success: true, totalCount: 0 });
return qc;
}
// ---------------------------------------------------------------------------
// Sync-mode tests (REQ-BATCH-2)
// ---------------------------------------------------------------------------
describe('useEventBatcher — sync mode (SYNCING)', () => {
let queryClient: QueryClient;
beforeEach(() => {
vi.useFakeTimers();
queryClient = makeQueryClient();
});
afterEach(() => {
vi.useRealTimers();
queryClient.clear();
});
it('events during SYNCING buffer for 500ms before flush', () => {
const { result } = renderHook(() =>
useEventBatcher(queryClient, queryKey, getResourceKey, idAccessor, SYNCING as any),
);
act(() => {
result.current(makePayload('pod-1', 'ADD'));
});
// Before 500ms — cache should still be empty.
const cached = queryClient.getQueryData(queryKey) as any;
expect(cached.result).toHaveLength(0);
// At 499ms — still empty.
act(() => { vi.advanceTimersByTime(499); });
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(0);
// At 500ms — flushed.
act(() => { vi.advanceTimersByTime(1); });
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(1);
});
it('multiple events in sync window produce single setQueryData call', () => {
const setQueryDataSpy = vi.spyOn(queryClient, 'setQueryData');
const { result } = renderHook(() =>
useEventBatcher(queryClient, queryKey, getResourceKey, idAccessor, SYNCING as any),
);
act(() => {
for (let i = 0; i < 50; i++) {
result.current(makePayload(`pod-${i}`, 'ADD'));
}
});
setQueryDataSpy.mockClear();
act(() => { vi.advanceTimersByTime(500); });
// 1 list update + 50 individual resource updates = 51 calls total.
expect(setQueryDataSpy).toHaveBeenCalledTimes(51);
const cached = queryClient.getQueryData(queryKey) as any;
expect(cached.result).toHaveLength(50);
setQueryDataSpy.mockRestore();
});
it('custom syncWindowMs is respected', () => {
const { result } = renderHook(() =>
useEventBatcher(queryClient, queryKey, getResourceKey, idAccessor, SYNCING as any, { syncWindowMs: 200 }),
);
act(() => { result.current(makePayload('pod-1', 'ADD')); });
// At 199ms — still empty.
act(() => { vi.advanceTimersByTime(199); });
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(0);
// At 200ms — flushed.
act(() => { vi.advanceTimersByTime(1); });
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(1);
});
});
// ---------------------------------------------------------------------------
// RAF-mode tests (REQ-BATCH-1)
// ---------------------------------------------------------------------------
describe('useEventBatcher — RAF mode (SYNCED)', () => {
let queryClient: QueryClient;
let rafCallbacks: Array<FrameRequestCallback>;
beforeEach(() => {
vi.useFakeTimers();
queryClient = makeQueryClient();
rafCallbacks = [];
vi.stubGlobal('requestAnimationFrame', (cb: FrameRequestCallback) => {
rafCallbacks.push(cb);
return rafCallbacks.length;
});
vi.stubGlobal('cancelAnimationFrame', (id: number) => {
// Mark as cancelled by clearing entry.
if (id > 0 && id <= rafCallbacks.length) {
rafCallbacks[id - 1] = () => {};
}
});
});
afterEach(() => {
vi.useRealTimers();
vi.unstubAllGlobals();
queryClient.clear();
});
function flushRAF() {
const cbs = [...rafCallbacks];
rafCallbacks = [];
for (const cb of cbs) {
cb(performance.now());
}
}
it('events during SYNCED flush on next animation frame', () => {
const { result } = renderHook(() =>
useEventBatcher(queryClient, queryKey, getResourceKey, idAccessor, SYNCED as any),
);
act(() => {
result.current(makePayload('pod-1', 'ADD'));
});
// Before RAF fires — cache should still be empty.
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(0);
// Trigger RAF.
act(() => { flushRAF(); });
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(1);
});
it('multiple events within one frame are batched into single update', () => {
const setQueryDataSpy = vi.spyOn(queryClient, 'setQueryData');
const { result } = renderHook(() =>
useEventBatcher(queryClient, queryKey, getResourceKey, idAccessor, SYNCED as any),
);
act(() => {
result.current(makePayload('pod-1', 'ADD'));
result.current(makePayload('pod-2', 'ADD'));
result.current(makePayload('pod-3', 'ADD'));
});
setQueryDataSpy.mockClear();
act(() => { flushRAF(); });
// 1 list update + 3 individual resource updates = 4 calls.
expect(setQueryDataSpy).toHaveBeenCalledTimes(4);
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(3);
setQueryDataSpy.mockRestore();
});
it('RAF cancelled on unmount', () => {
const { result, unmount } = renderHook(() =>
useEventBatcher(queryClient, queryKey, getResourceKey, idAccessor, SYNCED as any),
);
act(() => {
result.current(makePayload('pod-1', 'ADD'));
});
unmount();
act(() => { flushRAF(); });
// Should NOT have flushed since we unmounted.
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(0);
});
it('updates individual resource caches on ADD', () => {
const { result } = renderHook(() =>
useEventBatcher(queryClient, queryKey, getResourceKey, idAccessor, SYNCED as any),
);
act(() => { result.current(makePayload('pod-1', 'ADD')); });
act(() => { flushRAF(); });
const individual = queryClient.getQueryData(getResourceKey('pod-1', 'default')) as any;
expect(individual.result.metadata.name).toBe('pod-1');
});
it('updates individual resource caches on UPDATE', () => {
queryClient.setQueryData(queryKey, {
result: [{ metadata: { name: 'pod-1' } }],
success: true,
totalCount: 1,
});
const { result } = renderHook(() =>
useEventBatcher(queryClient, queryKey, getResourceKey, idAccessor, SYNCED as any),
);
const updateEvent: ResourceEvent = {
type: 'UPDATE',
payload: {
data: { metadata: { name: 'pod-1' }, status: 'Running' },
key: 'core::v1::Pod',
connection: 'cluster-1',
id: 'pod-1',
namespace: 'default',
},
};
act(() => { result.current(updateEvent); });
act(() => { flushRAF(); });
const individual = queryClient.getQueryData(getResourceKey('pod-1', 'default')) as any;
expect(individual.result.status).toBe('Running');
});
it('does NOT set individual cache on DELETE', () => {
queryClient.setQueryData(queryKey, {
result: [{ metadata: { name: 'pod-1' } }],
success: true,
totalCount: 1,
});
const { result } = renderHook(() =>
useEventBatcher(queryClient, queryKey, getResourceKey, idAccessor, SYNCED as any),
);
act(() => { result.current(makePayload('pod-1', 'DELETE')); });
act(() => { flushRAF(); });
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(0);
const individual = queryClient.getQueryData(getResourceKey('pod-1', 'default'));
expect(individual).toBeUndefined();
});
});
// ---------------------------------------------------------------------------
// Mode transition tests
// ---------------------------------------------------------------------------
describe('useEventBatcher — mode transitions', () => {
let queryClient: QueryClient;
let rafCallbacks: Array<FrameRequestCallback>;
beforeEach(() => {
vi.useFakeTimers();
queryClient = makeQueryClient();
rafCallbacks = [];
vi.stubGlobal('requestAnimationFrame', (cb: FrameRequestCallback) => {
rafCallbacks.push(cb);
return rafCallbacks.length;
});
vi.stubGlobal('cancelAnimationFrame', (id: number) => {
if (id > 0 && id <= rafCallbacks.length) {
rafCallbacks[id - 1] = () => {};
}
});
});
afterEach(() => {
vi.useRealTimers();
vi.unstubAllGlobals();
queryClient.clear();
});
function flushRAF() {
const cbs = [...rafCallbacks];
rafCallbacks = [];
for (const cb of cbs) {
cb(performance.now());
}
}
it('SYNCING→SYNCED: pending sync timer flushes, then RAF used for new events', () => {
// Start in SYNCING.
const { result, rerender } = renderHook(
({ state }: { state: any }) =>
useEventBatcher(queryClient, queryKey, getResourceKey, idAccessor, state),
{ initialProps: { state: SYNCING } },
);
// Enqueue during sync mode.
act(() => { result.current(makePayload('pod-1', 'ADD')); });
// Transition to SYNCED.
rerender({ state: SYNCED });
// The pending setTimeout should still fire.
act(() => { vi.advanceTimersByTime(500); });
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(1);
// New events use RAF.
act(() => { result.current(makePayload('pod-2', 'ADD')); });
// setTimeout should NOT cause a flush (mode changed).
act(() => { vi.advanceTimersByTime(500); });
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(1);
// RAF should cause flush.
act(() => { flushRAF(); });
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(2);
});
it('re-renders with new watchState do not lose buffered events', () => {
const { result, rerender } = renderHook(
({ state }: { state: any }) =>
useEventBatcher(queryClient, queryKey, getResourceKey, idAccessor, state),
{ initialProps: { state: SYNCING } },
);
act(() => {
result.current(makePayload('pod-1', 'ADD'));
result.current(makePayload('pod-2', 'ADD'));
});
// Transition mid-batch.
rerender({ state: SYNCED });
// Original timer still fires and includes all buffered events.
act(() => { vi.advanceTimersByTime(500); });
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(2);
});
});
// ---------------------------------------------------------------------------
// Performance tests
// ---------------------------------------------------------------------------
describe('useEventBatcher — performance', () => {
let queryClient: QueryClient;
beforeEach(() => {
vi.useFakeTimers();
queryClient = makeQueryClient();
});
afterEach(() => {
vi.useRealTimers();
queryClient.clear();
});
it('1000 ADD events during sync: single batch application', () => {
const setQueryDataSpy = vi.spyOn(queryClient, 'setQueryData');
const { result } = renderHook(() =>
useEventBatcher(queryClient, queryKey, getResourceKey, idAccessor, SYNCING as any),
);
act(() => {
for (let i = 0; i < 1000; i++) {
result.current(makePayload(`pod-${i}`, 'ADD'));
}
});
setQueryDataSpy.mockClear();
act(() => { vi.advanceTimersByTime(500); });
// 1 list update + 1000 individual = 1001 calls, but only 1 batch computation.
expect(setQueryDataSpy).toHaveBeenCalledTimes(1001);
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(1000);
setQueryDataSpy.mockRestore();
});
it('mixed ADD/UPDATE/DELETE preserves correctness', () => {
const { result } = renderHook(() =>
useEventBatcher(queryClient, queryKey, getResourceKey, idAccessor, SYNCING as any),
);
act(() => {
// Add 10 pods.
for (let i = 0; i < 10; i++) {
result.current(makePayload(`pod-${i}`, 'ADD'));
}
// Update 5.
for (let i = 0; i < 5; i++) {
result.current({
type: 'UPDATE',
payload: {
data: { metadata: { name: `pod-${i}` }, status: 'Running' },
key: 'core::v1::Pod',
connection: 'cluster-1',
id: `pod-${i}`,
namespace: 'default',
},
});
}
// Delete 3.
for (let i = 7; i < 10; i++) {
result.current(makePayload(`pod-${i}`, 'DELETE'));
}
});
act(() => { vi.advanceTimersByTime(500); });
const cached = queryClient.getQueryData(queryKey) as any;
expect(cached.result).toHaveLength(7);
// First 5 should have status: Running.
for (let i = 0; i < 5; i++) {
const pod = cached.result.find((p: any) => p.metadata.name === `pod-${i}`);
expect(pod.status).toBe('Running');
}
// Pods 7-9 should be deleted.
for (let i = 7; i < 10; i++) {
const pod = cached.result.find((p: any) => p.metadata.name === `pod-${i}`);
expect(pod).toBeUndefined();
}
});
});
// ---------------------------------------------------------------------------
// Edge cases
// ---------------------------------------------------------------------------
describe('useEventBatcher — edge cases', () => {
let queryClient: QueryClient;
beforeEach(() => {
vi.useFakeTimers();
queryClient = makeQueryClient();
});
afterEach(() => {
vi.useRealTimers();
queryClient.clear();
});
it('skips flush when idAccessor is undefined', () => {
const { result } = renderHook(() =>
useEventBatcher(queryClient, queryKey, getResourceKey, undefined, SYNCED as any),
);
act(() => { result.current(makePayload('pod-1', 'ADD')); });
act(() => { vi.advanceTimersByTime(500); });
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(0);
});
it('clears timer on unmount and does not flush (sync mode)', () => {
const { result, unmount } = renderHook(() =>
useEventBatcher(queryClient, queryKey, getResourceKey, idAccessor, SYNCING as any),
);
act(() => { result.current(makePayload('pod-1', 'ADD')); });
unmount();
act(() => { vi.advanceTimersByTime(500); });
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(0);
});
it('starts a new batch window after the previous one flushes', () => {
const { result } = renderHook(() =>
useEventBatcher(queryClient, queryKey, getResourceKey, idAccessor, SYNCING as any),
);
// First batch.
act(() => { result.current(makePayload('pod-1', 'ADD')); });
act(() => { vi.advanceTimersByTime(500); });
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(1);
// Second batch.
act(() => { result.current(makePayload('pod-2', 'ADD')); });
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(1);
act(() => { vi.advanceTimersByTime(500); });
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(2);
});
it('IDLE state uses RAF mode', () => {
let rafCalled = false;
vi.stubGlobal('requestAnimationFrame', (cb: FrameRequestCallback) => {
rafCalled = true;
// Execute immediately for this test.
cb(performance.now());
return 1;
});
vi.stubGlobal('cancelAnimationFrame', () => {});
const { result } = renderHook(() =>
useEventBatcher(queryClient, queryKey, getResourceKey, idAccessor, IDLE as any),
);
act(() => { result.current(makePayload('pod-1', 'ADD')); });
expect(rafCalled).toBe(true);
expect((queryClient.getQueryData(queryKey) as any).result).toHaveLength(1);
vi.unstubAllGlobals();
});
});