-
Notifications
You must be signed in to change notification settings - Fork 389
Expand file tree
/
Copy pathutils.test.ts
More file actions
1125 lines (971 loc) · 31.8 KB
/
utils.test.ts
File metadata and controls
1125 lines (971 loc) · 31.8 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
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { NumericUnit, TSource } from '@hyperdx/common-utils/dist/types';
import { SortingState } from '@tanstack/react-table';
import { act, renderHook } from '@testing-library/react';
import { MetricsDataType, NumberFormat } from '../types';
import * as utils from '../utils';
import {
formatAttributeClause,
formatDurationMs,
formatNumber,
getAllMetricTables,
getMetricTableName,
mapKeyBy,
orderByStringToSortingState,
sortingStateToOrderByString,
stripTrailingSlash,
useQueryHistory,
} from '../utils';
describe('formatAttributeClause', () => {
it('should format SQL attribute clause correctly', () => {
expect(
formatAttributeClause('ResourceAttributes', 'service', 'nginx', true),
).toBe("ResourceAttributes['service']='nginx'");
expect(formatAttributeClause('metadata', 'environment', 'prod', true)).toBe(
"metadata['environment']='prod'",
);
expect(formatAttributeClause('data', 'user-id', 'abc-123', true)).toBe(
"data['user-id']='abc-123'",
);
});
it('should format lucene attribute clause correctly', () => {
expect(formatAttributeClause('attrs', 'service', 'nginx', false)).toBe(
'attrs.service:"nginx"',
);
expect(
formatAttributeClause('metadata', 'environment', 'prod', false),
).toBe('metadata.environment:"prod"');
expect(formatAttributeClause('data', 'user-id', 'abc-123', false)).toBe(
'data.user-id:"abc-123"',
);
});
});
describe('getMetricTableName', () => {
// Base source object with required properties
const createBaseSource = () => ({
from: {
tableName: '',
databaseName: 'test_db',
},
id: 'test-id',
name: 'test-source',
timestampValueExpression: 'timestamp',
connection: 'test-connection',
kind: 'metric' as const,
});
// Source with metric tables
const createSourceWithMetrics = () => ({
...createBaseSource(),
metricTables: {
gauge: 'gauge_table',
counter: 'counter_table',
},
});
it('returns the default table name when metricType is null', () => {
const source = createSourceWithMetrics() as unknown as TSource;
expect(getMetricTableName(source)).toBe('');
expect(getMetricTableName(source, undefined)).toBe('');
});
it('returns the specific metric table when metricType is provided', () => {
const source = createSourceWithMetrics() as unknown as TSource;
expect(getMetricTableName(source, 'gauge' as MetricsDataType)).toBe(
'gauge_table',
);
expect(getMetricTableName(source, 'counter' as MetricsDataType)).toBe(
'counter_table',
);
});
it('handles case insensitivity for metric types', () => {
const source = createSourceWithMetrics() as unknown as TSource;
expect(getMetricTableName(source, 'GAUGE' as MetricsDataType)).toBe(
'gauge_table',
);
expect(getMetricTableName(source, 'Counter' as MetricsDataType)).toBe(
'counter_table',
);
});
it('returns undefined when the requested metric type does not exist', () => {
const source = {
...createBaseSource(),
metricTables: {
gauge: 'gauge_table',
},
} as unknown as TSource;
expect(
getMetricTableName(source, 'histogram' as MetricsDataType),
).toBeUndefined();
});
it('handles sources without metricTables property', () => {
const source = createBaseSource() as unknown as TSource;
expect(getMetricTableName(source)).toBe('');
expect(
getMetricTableName(source, 'gauge' as MetricsDataType),
).toBeUndefined();
});
});
describe('getAllMetricTables', () => {
const createMetricSource = (metricTables: Record<string, string>): TSource =>
({
kind: 'metric' as const,
from: { databaseName: 'test_db', tableName: '' },
connection: 'test-conn',
id: 'test-id',
name: 'test',
timestampValueExpression: 'timestamp',
metricTables,
}) as unknown as TSource;
it('returns empty array for non-metric source', () => {
const source = {
kind: 'log' as const,
from: { databaseName: 'test_db', tableName: 'logs' },
connection: 'test-conn',
id: 'test-id',
name: 'test',
timestampValueExpression: 'timestamp',
} as unknown as TSource;
expect(getAllMetricTables(source)).toEqual([]);
});
it('returns empty array when metricTables is undefined', () => {
const source = {
kind: 'metric' as const,
from: { databaseName: 'test_db', tableName: '' },
connection: 'test-conn',
id: 'test-id',
name: 'test',
timestampValueExpression: 'timestamp',
} as unknown as TSource;
expect(getAllMetricTables(source)).toEqual([]);
});
it('returns TableConnection for each populated metric table', () => {
const source = createMetricSource({
Gauge: 'gauge_table',
Sum: 'sum_table',
});
const result = getAllMetricTables(source);
expect(result).toEqual(
expect.arrayContaining([
{
tableName: 'gauge_table',
databaseName: 'test_db',
connectionId: 'test-conn',
},
{
tableName: 'sum_table',
databaseName: 'test_db',
connectionId: 'test-conn',
},
]),
);
expect(result).toHaveLength(2);
});
it('filters out metric types with no table name', () => {
const source = createMetricSource({
Gauge: 'gauge_table',
Histogram: '',
});
const result = getAllMetricTables(source);
expect(result).toEqual([
{
tableName: 'gauge_table',
databaseName: 'test_db',
connectionId: 'test-conn',
},
]);
});
it('returns all four metric types when all are populated', () => {
const source = createMetricSource({
Gauge: 'gauge_t',
Histogram: 'histogram_t',
Sum: 'sum_t',
Summary: 'summary_t',
});
const result = getAllMetricTables(source);
expect(result).toHaveLength(4);
expect(result.map(t => t.tableName).sort()).toEqual([
'gauge_t',
'histogram_t',
'sum_t',
'summary_t',
]);
// All should share the same database and connection
for (const tc of result) {
expect(tc.databaseName).toBe('test_db');
expect(tc.connectionId).toBe('test-conn');
}
});
it('returns empty array when all metric table values are falsy', () => {
const source = createMetricSource({
Gauge: '',
Histogram: '',
});
expect(getAllMetricTables(source)).toEqual([]);
});
});
describe('formatNumber', () => {
it('handles undefined/null values', () => {
expect(formatNumber(undefined)).toBe('N/A');
expect(formatNumber(null as any)).toBe('N/A');
});
it('returns string representation when no format options provided', () => {
expect(formatNumber(1234)).toBe('1234');
expect(formatNumber(0)).toBe('0');
expect(formatNumber(-1234)).toBe('-1234');
});
describe('number format', () => {
it('formats with mantissa', () => {
const format: NumberFormat = {
output: 'number',
mantissa: 2,
};
expect(formatNumber(1234.5678, format)).toBe('1234.57');
});
it('formats with thousand separator', () => {
const format: NumberFormat = {
output: 'number',
thousandSeparated: true,
};
expect(formatNumber(1234567, format)).toBe('1,234,567');
});
it('does not apply factor multiplication', () => {
const format: NumberFormat = {
output: 'number',
factor: 0.001, // Convert to milliseconds
};
expect(formatNumber(1000, format)).toBe('1000');
});
});
describe('currency format', () => {
it('formats with default currency symbol', () => {
const format: NumberFormat = {
output: 'currency',
thousandSeparated: true,
};
expect(formatNumber(1234.56, format)).toBe('$1,235');
});
it('formats with custom currency symbol', () => {
const format: NumberFormat = {
output: 'currency',
currencySymbol: '€',
};
expect(formatNumber(1234.56, format)).toBe('€1235');
});
});
describe('percentage format', () => {
it('formats as percentage', () => {
const format: NumberFormat = {
output: 'percent',
};
expect(formatNumber(0.1234, format)).toBe('12%');
});
it('formats percentage with mantissa', () => {
const format: NumberFormat = {
output: 'percent',
mantissa: 2,
};
expect(formatNumber(0.1234, format)).toBe('12.34%');
});
});
describe('byte format', () => {
it('formats bytes with binary base', () => {
const format: NumberFormat = {
output: 'byte',
decimalBytes: false,
};
expect(formatNumber(1024, format)).toBe('1 KB');
});
it('formats bytes with decimal base', () => {
const format: NumberFormat = {
output: 'byte',
decimalBytes: true,
};
expect(formatNumber(1000, format)).toBe('1 KB');
});
});
describe('time format', () => {
it('formats seconds input', () => {
const format: NumberFormat = {
output: 'time',
factor: 1, // seconds
};
expect(formatNumber(3661, format)).toBe('1:01:01');
});
it('formats milliseconds input', () => {
const format: NumberFormat = {
output: 'time',
factor: 0.001, // milliseconds
};
expect(formatNumber(61000, format)).toBe('0:01:01');
});
it('formats microseconds input', () => {
const format: NumberFormat = {
output: 'time',
factor: 0.000001, // microseconds
};
expect(formatNumber(1000000, format)).toBe('0:00:01');
});
it('formats nanoseconds input', () => {
const format: NumberFormat = {
output: 'time',
factor: 0.000000001, // nanoseconds
};
expect(formatNumber(1000000001, format)).toBe('0:00:01');
});
});
describe('duration format', () => {
it('formats seconds input as adaptive duration', () => {
const format: NumberFormat = {
output: 'duration',
factor: 1,
};
expect(formatNumber(30.41, format)).toBe('30.41s');
expect(formatNumber(0.045, format)).toBe('45ms');
expect(formatNumber(3661, format)).toBe('1.02h');
});
it('formats milliseconds input as adaptive duration', () => {
const format: NumberFormat = {
output: 'duration',
factor: 0.001,
};
expect(formatNumber(30410, format)).toBe('30.41s');
expect(formatNumber(45, format)).toBe('45ms');
});
it('formats nanoseconds input as adaptive duration', () => {
const format: NumberFormat = {
output: 'duration',
factor: 0.000000001,
};
expect(formatNumber(30410000000, format)).toBe('30.41s');
expect(formatNumber(45000000, format)).toBe('45ms');
expect(formatNumber(500, format)).toBe('0.5µs');
});
it('handles zero value', () => {
const format: NumberFormat = {
output: 'duration',
factor: 1,
};
expect(formatNumber(0, format)).toBe('0ms');
});
it('defaults factor to 1 (seconds) when not specified', () => {
const format: NumberFormat = {
output: 'duration',
};
expect(formatNumber(1.5, format)).toBe('1.5s');
});
it('formats sub-millisecond values as microseconds', () => {
const format: NumberFormat = {
output: 'duration',
factor: 1,
};
expect(formatNumber(0.0003, format)).toBe('300µs');
});
it('formats large values as hours', () => {
const format: NumberFormat = {
output: 'duration',
factor: 1,
};
expect(formatNumber(7200, format)).toBe('2h');
});
});
describe('unit handling', () => {
it('appends unit to formatted number', () => {
const format: NumberFormat = {
output: 'number',
unit: 'ms',
};
expect(formatNumber(1234, format)).toBe('1234 ms');
});
});
describe('average format', () => {
it('formats large numbers with abbreviations when average is true', () => {
const format: NumberFormat = {
output: 'number',
average: true,
};
expect(formatNumber(1234567, format)).toBe('1m');
});
});
describe('numericUnit with data output (byte)', () => {
it('formats with fixed unit suffix', () => {
expect(
formatNumber(500, {
output: 'byte',
numericUnit: NumericUnit.Kibibytes,
}),
).toBe('500 KiB');
expect(
formatNumber(500, {
output: 'byte',
numericUnit: NumericUnit.Megabytes,
mantissa: 1,
}),
).toBe('500.0 MB');
});
it('auto-scales IEC bytes', () => {
expect(
formatNumber(0, {
output: 'byte',
numericUnit: NumericUnit.BytesIEC,
}),
).toBe('0 B');
expect(
formatNumber(1024, {
output: 'byte',
numericUnit: NumericUnit.BytesIEC,
}),
).toBe('1 KiB');
expect(
formatNumber(1048576, {
output: 'byte',
numericUnit: NumericUnit.BytesIEC,
mantissa: 2,
}),
).toBe('1.00 MiB');
});
it('auto-scales SI bytes', () => {
expect(
formatNumber(1000, {
output: 'byte',
numericUnit: NumericUnit.BytesSI,
}),
).toBe('1 KB');
expect(
formatNumber(1000000, {
output: 'byte',
numericUnit: NumericUnit.BytesSI,
}),
).toBe('1 MB');
});
it('auto-scales IEC bits', () => {
expect(
formatNumber(1024, {
output: 'byte',
numericUnit: NumericUnit.BitsIEC,
}),
).toBe('1 Kibit');
});
it('auto-scales SI bits', () => {
expect(
formatNumber(1000, {
output: 'byte',
numericUnit: NumericUnit.BitsSI,
}),
).toBe('1 Kbit');
});
it('handles negative values in auto-scale', () => {
expect(
formatNumber(-1024, {
output: 'byte',
numericUnit: NumericUnit.BytesIEC,
}),
).toBe('-1 KiB');
expect(
formatNumber(-1500000, {
output: 'byte',
numericUnit: NumericUnit.BytesSI,
mantissa: 2,
}),
).toBe('-1.50 MB');
});
it('falls back to numbro for byte output without numericUnit', () => {
// Without numericUnit, the legacy numbro byte formatting is used
expect(formatNumber(1024, { output: 'byte', decimalBytes: false })).toBe(
'1 KB',
);
});
});
describe('numericUnit with data_rate output', () => {
it('formats fixed data rate units', () => {
expect(
formatNumber(42, {
output: 'data_rate',
numericUnit: NumericUnit.PacketsSec,
}),
).toBe('42 pkt/s');
expect(
formatNumber(100, {
output: 'data_rate',
numericUnit: NumericUnit.KilobytesSec,
mantissa: 1,
}),
).toBe('100.0 KB/s');
});
it('auto-scales data rate (IEC bytes/s)', () => {
expect(
formatNumber(1024, {
output: 'data_rate',
numericUnit: NumericUnit.BytesSecIEC,
}),
).toBe('1 KiB/s');
});
it('auto-scales data rate (SI bits/s)', () => {
expect(
formatNumber(1000, {
output: 'data_rate',
numericUnit: NumericUnit.BitsSecSI,
}),
).toBe('1 Kbit/s');
});
it('falls back to plain toFixed for data_rate without numericUnit', () => {
expect(formatNumber(1234.567, { output: 'data_rate', mantissa: 2 })).toBe(
'1234.57',
);
});
it('handles string-type numeric values', () => {
expect(
formatNumber('500', {
output: 'byte',
numericUnit: NumericUnit.Kibibytes,
}),
).toBe('500 KiB');
expect(
formatNumber('1024', {
output: 'data_rate',
numericUnit: NumericUnit.BytesSecIEC,
}),
).toBe('1 KiB/s');
});
});
describe('numericUnit with throughput output', () => {
it('formats fixed throughput units', () => {
expect(
formatNumber(100, {
output: 'throughput',
numericUnit: NumericUnit.Rps,
}),
).toBe('100 rps');
expect(
formatNumber(50, {
output: 'throughput',
numericUnit: NumericUnit.Iops,
}),
).toBe('50 iops');
expect(
formatNumber(200, {
output: 'throughput',
numericUnit: NumericUnit.Opm,
mantissa: 1,
}),
).toBe('200.0 opm');
});
it('falls back to plain toFixed for throughput without numericUnit', () => {
expect(formatNumber(9999, { output: 'throughput' })).toBe('9999');
});
});
describe('numericUnit ignored for non-data outputs', () => {
it('ignores numericUnit for number output', () => {
// numericUnit is only checked for byte/data_rate/throughput
expect(
formatNumber(1024, {
output: 'number',
numericUnit: NumericUnit.BytesIEC,
}),
).toBe('1024');
});
it('ignores numericUnit for percent output', () => {
expect(
formatNumber(0.5, {
output: 'percent',
numericUnit: NumericUnit.BytesIEC,
}),
).toBe('50%');
});
});
describe('NaN handling', () => {
it('returns "N/A" for NaN without options', () => {
expect(formatNumber(NaN)).toBe('N/A');
expect(formatNumber(NaN, { output: 'number', mantissa: 2 })).toBe('N/A');
});
it('returns a string unchanged if a number cannot be parsed from it', () => {
expect(formatNumber('not a number')).toBe('not a number');
expect(
formatNumber('not a number', { output: 'number', mantissa: 2 }),
).toBe('not a number');
});
});
});
describe('formatDurationMs', () => {
it('formats zero', () => {
expect(formatDurationMs(0)).toBe('0ms');
});
it('formats microseconds', () => {
expect(formatDurationMs(0.5)).toBe('500µs');
expect(formatDurationMs(0.003)).toBe('3µs');
expect(formatDurationMs(0.01)).toBe('10µs');
});
it('formats milliseconds', () => {
expect(formatDurationMs(1)).toBe('1ms');
expect(formatDurationMs(45)).toBe('45ms');
expect(formatDurationMs(999)).toBe('999ms');
expect(formatDurationMs(5.5)).toBe('5.5ms');
});
it('formats seconds', () => {
expect(formatDurationMs(1000)).toBe('1s');
expect(formatDurationMs(1500)).toBe('1.5s');
expect(formatDurationMs(30410)).toBe('30.41s');
});
it('formats minutes', () => {
expect(formatDurationMs(60000)).toBe('1min');
expect(formatDurationMs(90000)).toBe('1.5min');
});
it('formats hours', () => {
expect(formatDurationMs(3600000)).toBe('1h');
expect(formatDurationMs(7200000)).toBe('2h');
});
it('handles negative values', () => {
expect(formatDurationMs(-1500)).toBe('-1.5s');
});
it('handles sub-microsecond precision', () => {
expect(formatDurationMs(0.0005)).toBe('0.5µs');
});
});
describe('useLocalStorage', () => {
// Create a mock for localStorage
let localStorageMock: jest.Mocked<Storage>;
beforeEach(() => {
// Clear all mocks between tests
jest.clearAllMocks();
// Create localStorage mock
localStorageMock = {
getItem: jest.fn().mockImplementation((_: string) => null),
setItem: jest.fn(),
removeItem: jest.fn(),
clear: jest.fn(),
key: jest.fn(),
length: 0,
};
// Replace window.localStorage with our mock
Object.defineProperty(window, 'localStorage', {
value: localStorageMock,
writable: true,
});
});
afterAll(() => {
// Restore original implementations
jest.restoreAllMocks();
});
test('should initialize with initial value when localStorage is empty', () => {
// Mock localStorage.getItem to return null (empty)
localStorageMock.getItem.mockReturnValueOnce(null);
const initialValue = { test: 'value' };
const { result } = renderHook(() =>
utils.useLocalStorage('testKey', initialValue),
);
// Check if initialized with initial value
expect(result.current[0]).toEqual(initialValue);
// Verify localStorage was checked
expect(localStorageMock.getItem).toHaveBeenCalledWith('testKey');
});
test('should retrieve existing value from localStorage', () => {
// Mock localStorage to return existing value
const existingValue = { test: 'existing' };
localStorageMock.getItem.mockReturnValueOnce(JSON.stringify(existingValue));
const { result } = renderHook(() =>
utils.useLocalStorage('testKey', { test: 'default' }),
);
// Should use the value from localStorage, not the initial value
expect(result.current[0]).toEqual(existingValue);
expect(localStorageMock.getItem).toHaveBeenCalledWith('testKey');
});
test('should update localStorage when setValue is called', () => {
localStorageMock.getItem.mockReturnValueOnce(null);
const { result } = renderHook(() =>
utils.useLocalStorage('testKey', 'initial'),
);
// Update value
const newValue = 'updated';
act(() => {
result.current[1](newValue);
});
// Check if state updated
expect(result.current[0]).toBe(newValue);
// Check if localStorage was updated
expect(localStorageMock.setItem).toHaveBeenCalledWith(
'testKey',
JSON.stringify(newValue),
);
});
test('should handle functional updates', () => {
localStorageMock.getItem.mockReturnValueOnce(JSON.stringify(0));
const { result } = renderHook(() =>
utils.useLocalStorage<number>('testKey', 0),
);
// Update using function
act(() => {
result.current[1](prev => prev + 1);
});
// Check if state updated correctly
expect(result.current[0]).toBe(1);
// Check if localStorage was updated
expect(localStorageMock.setItem).toHaveBeenCalledWith(
'testKey',
JSON.stringify(1),
);
});
test('should handle storage event from another window', () => {
// Initial setup
localStorageMock.getItem.mockReturnValueOnce(JSON.stringify('initial'));
const { result } = renderHook(() =>
utils.useLocalStorage('testKey', 'initial'),
);
// Update mock to return new value when checked after event
localStorageMock.getItem.mockReturnValue(JSON.stringify('external update'));
// Dispatch storage event
act(() => {
window.dispatchEvent(
new StorageEvent('storage', {
key: 'testKey',
newValue: JSON.stringify('external update'),
}),
);
});
// State should be updated
expect(result.current[0]).toBe('external update');
});
test('should handle customStorage event from same window but different hook instance', () => {
// First hook instance
localStorageMock.getItem.mockReturnValueOnce(JSON.stringify('initial1'));
const { result: result1 } = renderHook(() =>
utils.useLocalStorage('sharedKey', 'initial1'),
);
// Second hook instance
localStorageMock.getItem.mockReturnValueOnce(JSON.stringify('initial1'));
const { result: result2 } = renderHook(() =>
utils.useLocalStorage('sharedKey', 'initial2'),
);
// Clear mock calls count
localStorageMock.getItem.mockClear();
// When the second hook checks localStorage after custom event
localStorageMock.getItem.mockReturnValue(
JSON.stringify('updated by hook 1'),
);
// Update value in the first instance
act(() => {
result1.current[1]('updated by hook 1');
});
// Manually trigger custom event (since it's happening within the same test)
act(() => {
const event = new CustomEvent<utils.CustomStorageChangeDetail>(
'customStorage',
{
detail: {
key: 'sharedKey',
instanceId: 'some-id', // Different from the instance updating
},
},
);
window.dispatchEvent(event);
});
// The second instance should have updated values
expect(result2.current[0]).toBe('updated by hook 1');
});
test('should not update if storage event is for a different key', () => {
// Initial setup
localStorageMock.getItem.mockReturnValueOnce(JSON.stringify('initial'));
const { result } = renderHook(() =>
utils.useLocalStorage('testKey', 'initial'),
);
// Clear the mock calls counter
localStorageMock.getItem.mockClear();
// Simulate storage event for a different key
act(() => {
window.dispatchEvent(
new StorageEvent('storage', {
key: 'differentKey',
newValue: JSON.stringify('different value'),
}),
);
});
// State should remain unchanged
expect(result.current[0]).toBe('initial');
// localStorage should not be accessed since key doesn't match
expect(localStorageMock.getItem).not.toHaveBeenCalled();
});
});
describe('stripTrailingSlash', () => {
it('should throw an error for nullish values', () => {
expect(() => stripTrailingSlash(null)).toThrow(
'URL must be a non-empty string',
);
expect(() => stripTrailingSlash(undefined)).toThrow(
'URL must be a non-empty string',
);
});
it('should throw an error for non-string values', () => {
expect(() => stripTrailingSlash(123 as any)).toThrow(
'URL must be a non-empty string',
);
expect(() => stripTrailingSlash({} as any)).toThrow(
'URL must be a non-empty string',
);
});
it('should remove trailing slash from URLs', () => {
expect(stripTrailingSlash('http://example.com/')).toBe(
'http://example.com',
);
expect(stripTrailingSlash('http://example.com/api/')).toBe(
'http://example.com/api',
);
});
it('should not modify URLs without trailing slash', () => {
expect(stripTrailingSlash('http://example.com')).toBe('http://example.com');
expect(stripTrailingSlash('http://example.com/api')).toBe(
'http://example.com/api',
);
});
it('should handle URLs with multiple trailing slashes', () => {
expect(stripTrailingSlash('http://example.com///')).toBe(
'http://example.com//',
);
});
});
describe('useQueryHistory', () => {
const mockGetItem = jest.fn();
const mockSetItem = jest.fn();
const mockRemoveItem = jest.fn();
const originalLocalStorage = window.localStorage;
beforeEach(() => {
mockGetItem.mockClear();
mockSetItem.mockClear();
mockRemoveItem.mockClear();
mockGetItem.mockReturnValue('["service = test3","service = test1"]');
Object.defineProperty(window, 'localStorage', {
value: {
getItem: (...args: string[]) => mockGetItem(...args),
setItem: (...args: string[]) => mockSetItem(...args),
removeItem: (...args: string[]) => mockRemoveItem(...args),
},
});
});
afterEach(() => {
jest.restoreAllMocks();
Object.defineProperty(window, 'localStorage', {
value: originalLocalStorage,
configurable: true,
});
});
it('adds new query', () => {
const { result } = renderHook(() => useQueryHistory('searchSQL'));
const setQueryHistory = result.current[1];
act(() => {
setQueryHistory('service = test2');
});
expect(mockSetItem).toHaveBeenCalledWith(
'QuerySearchHistory.searchSQL',
'["service = test2","service = test3","service = test1"]',
);
});
it('does not add duplicate query, but change the order to front', () => {
const { result } = renderHook(() => useQueryHistory('searchSQL'));
const setQueryHistory = result.current[1];
act(() => {
setQueryHistory('service = test1');
});
expect(mockSetItem).toHaveBeenCalledWith(
'QuerySearchHistory.searchSQL',
'["service = test1","service = test3"]',
);
});