-
Notifications
You must be signed in to change notification settings - Fork 85
Expand file tree
/
Copy pathofrep-web-provider.spec.ts
More file actions
1304 lines (1100 loc) · 58.1 KB
/
Copy pathofrep-web-provider.spec.ts
File metadata and controls
1304 lines (1100 loc) · 58.1 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 { ErrorCode } from '@openfeature/web-sdk';
import { BulkEvaluationStatus } from './model/evaluate-flags-response';
import { OFREPWebProvider } from './ofrep-web-provider';
import TestLogger from '../../test/test-logger';
import type { FlagCache } from './model/in-memory-cache';
import type { PersistedEntry } from './store/storage';
import { Storage } from './store/storage';
import { deriveAuthCredential } from './store/cache-key';
import {
ClientProviderEvents,
ClientProviderStatus,
OpenFeature,
StandardResolutionReasons,
} from '@openfeature/web-sdk';
import { http, HttpResponse } from 'msw';
// eslint-disable-next-line @nx/enforce-module-boundaries
import { server } from '../../../../shared/ofrep-core/src/test/mock-service-worker';
// eslint-disable-next-line @nx/enforce-module-boundaries
import { TEST_FLAG_METADATA, TEST_FLAG_SET_METADATA } from '../../../../shared/ofrep-core/src/test/test-constants';
describe('OFREPWebProvider', () => {
beforeAll(() => server.listen());
beforeEach(() => {
localStorage.clear();
});
afterEach(async () => {
server.resetHandlers();
await OpenFeature.close();
});
afterAll(() => server.close());
const endpointBaseURL = 'https://localhost:8080';
const defaultContext = {
targetingKey: '21640825-95e7-4335-b149-bd6881cf7875',
email: 'john.doe@openfeature.dev',
firstname: 'John',
lastname: 'Doe',
};
function createTestStorage(domain = ''): Storage {
return new Storage('local-cache-first', endpointBaseURL, () =>
deriveAuthCredential({ baseUrl: endpointBaseURL }),
domain,
);
}
it('declares itself domain-scoped', () => {
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL });
expect(provider.domainScoped).toBe(true);
});
it('does not read or write persisted storage before initialize', async () => {
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL, pollInterval: -1 }, new TestLogger());
const storeSpy = jest.spyOn(Storage.prototype, 'store');
const retrieveSpy = jest.spyOn(Storage.prototype, 'retrieve');
await provider.onContextChange?.(defaultContext, {
...defaultContext,
targetingKey: 'other-user',
});
expect(storeSpy).not.toHaveBeenCalled();
expect(retrieveSpy).not.toHaveBeenCalled();
storeSpy.mockRestore();
retrieveSpy.mockRestore();
});
it('uses the bound domain from initialize for persisted cache lookup', async () => {
const boolFlagCache: FlagCache = {
'bool-flag': {
key: 'bool-flag',
value: true,
metadata: TEST_FLAG_METADATA,
reason: StandardResolutionReasons.STATIC,
},
};
const storage = createTestStorage('billing');
await storage.store(defaultContext, boolFlagCache, null);
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL, pollInterval: -1 }, new TestLogger());
await provider.initialize(defaultContext, 'billing');
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._isUsingCache).toBe(true);
const otherDomainProvider = new OFREPWebProvider({ baseUrl: endpointBaseURL, pollInterval: -1 }, new TestLogger());
await otherDomainProvider.initialize(defaultContext, 'checkout');
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((otherDomainProvider as any)._isUsingCache).toBe(false);
});
it('should call the READY handler, when the provider is ready', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext(defaultContext);
OpenFeature.setProvider(providerName, provider);
const client = OpenFeature.getClient(providerName);
const readyHandler = jest.fn();
client.addHandler(ClientProviderEvents.Ready, readyHandler);
await new Promise((resolve) => setTimeout(resolve, 100));
expect(readyHandler).toHaveBeenCalled();
expect(client.providerStatus).toBe(ClientProviderStatus.READY);
});
it('should be in FATAL status if 401 error during initialise', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext({ ...defaultContext, errors: { 401: true } });
OpenFeature.setProvider(providerName, provider);
const client = OpenFeature.getClient(providerName);
const errorHandler = jest.fn();
client.addHandler(ClientProviderEvents.Error, errorHandler);
await new Promise((resolve) => setTimeout(resolve, 100));
expect(errorHandler).toHaveBeenCalled();
expect(client.providerStatus).toBe(ClientProviderStatus.FATAL);
});
it('should be in FATAL status if 403 error during initialise', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext({ ...defaultContext, errors: { 403: true } });
OpenFeature.setProvider(providerName, provider);
const client = OpenFeature.getClient(providerName);
const errorHandler = jest.fn();
const readyHandler = jest.fn();
client.addHandler(ClientProviderEvents.Error, errorHandler);
client.addHandler(ClientProviderEvents.Ready, readyHandler);
await new Promise((resolve) => setTimeout(resolve, 100));
expect(errorHandler).toHaveBeenCalled();
expect(readyHandler).not.toHaveBeenCalled();
expect(client.providerStatus).toBe(ClientProviderStatus.FATAL);
});
it('should be in ERROR status if 429 error during initialise', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext({ ...defaultContext, errors: { 429: true } });
OpenFeature.setProvider(providerName, provider);
const client = OpenFeature.getClient(providerName);
const errorHandler = jest.fn();
const readyHandler = jest.fn();
client.addHandler(ClientProviderEvents.Error, errorHandler);
client.addHandler(ClientProviderEvents.Ready, readyHandler);
await new Promise((resolve) => setTimeout(resolve, 100));
expect(errorHandler).toHaveBeenCalled();
expect(readyHandler).not.toHaveBeenCalled();
expect(client.providerStatus).toBe(ClientProviderStatus.ERROR);
});
it('should be in ERROR status if targetingKey is missing', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext({ ...defaultContext, errors: { targetingMissing: true } });
OpenFeature.setProvider(providerName, provider);
const client = OpenFeature.getClient(providerName);
const errorHandler = jest.fn();
const readyHandler = jest.fn();
client.addHandler(ClientProviderEvents.Error, errorHandler);
client.addHandler(ClientProviderEvents.Ready, readyHandler);
await new Promise((resolve) => setTimeout(resolve, 100));
expect(errorHandler).toHaveBeenCalled();
expect(readyHandler).not.toHaveBeenCalled();
expect(client.providerStatus).toBe(ClientProviderStatus.ERROR);
});
it('should be in ERROR status if invalid context', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext({ ...defaultContext, errors: { invalidContext: true } });
OpenFeature.setProvider(providerName, provider);
const client = OpenFeature.getClient(providerName);
const errorHandler = jest.fn();
const readyHandler = jest.fn();
client.addHandler(ClientProviderEvents.Error, errorHandler);
client.addHandler(ClientProviderEvents.Ready, readyHandler);
await new Promise((resolve) => setTimeout(resolve, 100));
expect(errorHandler).toHaveBeenCalled();
expect(readyHandler).not.toHaveBeenCalled();
expect(client.providerStatus).toBe(ClientProviderStatus.ERROR);
});
it('should be in ERROR status if parse error', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext({ ...defaultContext, errors: { parseError: true } });
OpenFeature.setProvider(providerName, provider);
const client = OpenFeature.getClient(providerName);
const errorHandler = jest.fn();
const readyHandler = jest.fn();
client.addHandler(ClientProviderEvents.Error, errorHandler);
client.addHandler(ClientProviderEvents.Ready, readyHandler);
await new Promise((resolve) => setTimeout(resolve, 100));
expect(errorHandler).toHaveBeenCalled();
expect(readyHandler).not.toHaveBeenCalled();
expect(client.providerStatus).toBe(ClientProviderStatus.ERROR);
});
it('should return a FLAG_NOT_FOUND error and flag set metadata if the flag does not exist', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
const client = OpenFeature.getClient(providerName);
const flag = client.getBooleanDetails('non-existent-flag', false);
expect(flag.errorCode).toBe('FLAG_NOT_FOUND');
expect(flag.value).toBe(false);
expect(flag.flagMetadata).toEqual(TEST_FLAG_SET_METADATA);
});
it('should return default value if API does not return a value', async () => {
const flagKey = 'flag-without-value';
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
const client = OpenFeature.getClient(providerName);
const flag = client.getNumberDetails(flagKey, 42);
expect(flag).toEqual({
flagKey,
value: 42,
variant: 'emptyVariant',
flagMetadata: TEST_FLAG_METADATA,
reason: 'DISABLED',
});
});
it('should return EvaluationDetails if the flag exists', async () => {
const flagKey = 'bool-flag';
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
const client = OpenFeature.getClient(providerName);
const flag = client.getBooleanDetails(flagKey, false);
expect(flag).toEqual({
flagKey,
value: true,
variant: 'variantA',
flagMetadata: TEST_FLAG_METADATA,
reason: 'STATIC',
});
});
it('should return ParseError if the API return the error', async () => {
const flagKey = 'parse-error';
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext({ ...defaultContext, errors: { flagInError: true } });
await OpenFeature.setProviderAndWait(providerName, provider);
const client = OpenFeature.getClient(providerName);
const flag = client.getBooleanDetails(flagKey, false);
expect(flag).toEqual({
flagKey,
value: false,
errorCode: 'PARSE_ERROR',
errorMessage: 'custom error details',
reason: 'ERROR',
flagMetadata: {},
});
});
it('should send a configuration changed event, when new flag is send', async () => {
const flagKey = 'object-flag';
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL, pollInterval: 50 }, new TestLogger());
await OpenFeature.setContext({ ...defaultContext, changeConfig: true });
await OpenFeature.setProviderAndWait(providerName, provider);
const client = OpenFeature.getClient(providerName);
const configChangedHandler = jest.fn();
const readyHandler = jest.fn();
const reconcilingHandler = jest.fn();
client.addHandler(ClientProviderEvents.Ready, readyHandler);
client.addHandler(ClientProviderEvents.ConfigurationChanged, configChangedHandler);
client.addHandler(ClientProviderEvents.Reconciling, reconcilingHandler);
const got1 = client.getObjectDetails(flagKey, {});
await new Promise((resolve) => setTimeout(resolve, 80));
expect(readyHandler).toHaveBeenCalledTimes(1);
expect(configChangedHandler).toHaveBeenCalledTimes(1);
expect(reconcilingHandler).not.toHaveBeenCalled();
const got2 = client.getObjectDetails(flagKey, {});
expect(got1).not.toEqual(got2);
});
it('should call reconciling handler, when context changed', async () => {
const flagKey = 'object-flag';
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL, cacheMode: 'disabled' }, new TestLogger());
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
const client = OpenFeature.getClient(providerName);
const configChangedHandler = jest.fn();
const readyHandler = jest.fn();
const reconcilingHandler = jest.fn();
client.addHandler(ClientProviderEvents.Ready, readyHandler);
client.addHandler(ClientProviderEvents.ConfigurationChanged, configChangedHandler);
client.addHandler(ClientProviderEvents.Reconciling, reconcilingHandler);
const got1 = client.getObjectDetails(flagKey, {});
await OpenFeature.setContext({ ...defaultContext, contextChanged: true });
await new Promise((resolve) => setTimeout(resolve, 80));
expect(readyHandler).toHaveBeenCalledTimes(1);
expect(reconcilingHandler).toHaveBeenCalledTimes(1);
expect(configChangedHandler).not.toHaveBeenCalled();
const got2 = client.getObjectDetails(flagKey, {});
expect(got1).not.toEqual(got2);
});
it('should call stale handler, when api is not responding', async () => {
const flagKey = 'object-flag';
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider(
{ baseUrl: endpointBaseURL, pollInterval: 50, cacheMode: 'disabled' },
new TestLogger(),
);
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
const client = OpenFeature.getClient(providerName);
const readyHandler = jest.fn();
const reconcilingHandler = jest.fn();
client.addHandler(ClientProviderEvents.Ready, readyHandler);
client.addHandler(ClientProviderEvents.Reconciling, reconcilingHandler);
const got1 = client.getObjectDetails(flagKey, {});
await OpenFeature.setContext({ ...defaultContext, errors: { 401: true } });
await new Promise((resolve) => setTimeout(resolve, 80));
expect(readyHandler).toHaveBeenCalledTimes(1);
expect(reconcilingHandler).toHaveBeenCalledTimes(1);
// Commenting those checks, because we are not able to retrieve the information
// of the provider being stale inside the provider itself.
// Because of that, we cannot manage the CACHED reason properly.
//
// const got2 = client.getObjectDetails(flagKey, {});
// expect(got1).not.toEqual(got2);
// expect(got2.reason).toBe('CACHED');
});
it('should send unconditional re-fetch on SSE inactivity resume (no If-None-Match)', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
// After init, provider should have an etag from the server response
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._etag).toBe('123');
// Spy on the OFREP API to verify the etag argument
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const spy = jest.spyOn((provider as any)._ofrepAPI, 'postBulkEvaluateFlags');
// Simulate inactivity resume: onRefetch(undefined) → unconditional re-fetch
// eslint-disable-next-line @typescript-eslint/no-explicit-any
await (provider as any)._handleSseRefetch(undefined);
// ADR-0008 guideline #3: inactivity resume must be fully unconditional
// (no If-None-Match, no flagConfigEtag, no flagConfigLastModified)
expect(spy).toHaveBeenCalledWith(
expect.anything(),
null, // etag must be null (no If-None-Match)
undefined, // no SSE metadata
);
spy.mockRestore();
});
it('should send etag on SSE-triggered re-fetch with metadata', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const spy = jest.spyOn((provider as any)._ofrepAPI, 'postBulkEvaluateFlags');
// Simulate SSE event with metadata (not an inactivity resume)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
await (provider as any)._handleSseRefetch({ flagConfigEtag: '"v2"' });
// SSE-triggered re-fetch should still include the etag
expect(spy).toHaveBeenCalledWith(
expect.anything(),
'123', // etag from previous response (If-None-Match)
{ flagConfigEtag: '"v2"' }, // SSE metadata
);
spy.mockRestore();
});
describe('SSE connection on init', () => {
let mockEventSourceInstances: { addEventListener: jest.Mock; close: jest.Mock; readyState: number }[];
let MockES: jest.Mock;
beforeEach(() => {
mockEventSourceInstances = [];
MockES = jest.fn((url: string) => {
const inst = { url, addEventListener: jest.fn(), close: jest.fn(), readyState: 1 };
mockEventSourceInstances.push(inst);
return inst;
});
(globalThis as Record<string, unknown>)['EventSource'] = MockES;
});
afterEach(() => {
delete (globalThis as Record<string, unknown>)['EventSource'];
});
it('connects SSE in network-first mode when server returns eventStreams', async () => {
server.use(
http.post('https://localhost:8080/ofrep/v1/evaluate/flags', () =>
HttpResponse.json({
flags: [],
metadata: {},
eventStreams: [{ type: 'sse', url: 'https://sse.example.com/stream' }],
}),
),
);
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL, cacheMode: 'network-first' }, new TestLogger());
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._sseManager).not.toBeUndefined();
expect(MockES).toHaveBeenCalledWith('https://sse.example.com/stream');
});
it('connects SSE after the background refresh following a local-cache-first cache hit', async () => {
// Seed the cache so initialize() hits the cache-first path.
const storage = createTestStorage();
const key = await storage.getStorageKey(defaultContext);
localStorage.setItem(
key,
JSON.stringify({
version: 2,
cacheKeyHash: key.split(':')[2],
etag: null,
writtenAt: new Date().toISOString(),
data: {},
}),
);
server.use(
http.post('https://localhost:8080/ofrep/v1/evaluate/flags', () =>
HttpResponse.json({
flags: [],
metadata: {},
eventStreams: [{ type: 'sse', url: 'https://sse.example.com/stream' }],
}),
),
);
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext(defaultContext);
OpenFeature.setProvider(providerName, provider);
// Wait for both the ready event and the background refresh to complete.
await new Promise((resolve) => setTimeout(resolve, 150));
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._sseManager).not.toBeUndefined();
expect(MockES).toHaveBeenCalledWith('https://sse.example.com/stream');
});
it('connects SSE from the persisted streams when the cache-first refresh returns 304', async () => {
// Seed the cache with an etag and the persisted event streams. This mirrors a warm
// start where the flags are unchanged: the background refresh sends If-None-Match
// and the server responds 304 (no body, no eventStreams), so SSE must be established
// from the persisted configuration rather than from a 200 response.
const storage = createTestStorage();
const key = await storage.getStorageKey(defaultContext);
localStorage.setItem(
key,
JSON.stringify({
version: 2,
cacheKeyHash: key.split(':')[2],
etag: '"cached-etag"',
writtenAt: new Date().toISOString(),
data: {},
eventStreams: [{ type: 'sse', url: 'https://sse.example.com/stream' }],
}),
);
server.use(
http.post('https://localhost:8080/ofrep/v1/evaluate/flags', () => new HttpResponse(null, { status: 304 })),
);
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext(defaultContext);
OpenFeature.setProvider(providerName, provider);
// Wait for both the ready event and the background refresh (304) to complete.
await new Promise((resolve) => setTimeout(resolve, 150));
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._sseManager).not.toBeUndefined();
expect(MockES).toHaveBeenCalledWith('https://sse.example.com/stream');
});
});
describe('changeDetection', () => {
it('should not start polling or SSE when changeDetection is none', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL, changeDetection: 'none' }, new TestLogger());
await OpenFeature.setContext({ ...defaultContext, changeConfig: true });
await OpenFeature.setProviderAndWait(providerName, provider);
const client = OpenFeature.getClient(providerName);
const configChangedHandler = jest.fn();
client.addHandler(ClientProviderEvents.ConfigurationChanged, configChangedHandler);
await new Promise((resolve) => setTimeout(resolve, 150));
expect(configChangedHandler).not.toHaveBeenCalled();
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._pollingIntervalId).toBeUndefined();
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._sseManager).toBeUndefined();
});
it('should not start polling after context change when changeDetection is none', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider(
{ baseUrl: endpointBaseURL, pollInterval: 50, changeDetection: 'none' },
new TestLogger(),
);
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
await OpenFeature.setContext({ ...defaultContext, contextChanged: true });
await new Promise((resolve) => setTimeout(resolve, 150));
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._pollingIntervalId).toBeUndefined();
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._sseManager).toBeUndefined();
});
it('should use polling and ignore eventStreams when changeDetection is polling', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider(
{ baseUrl: endpointBaseURL, pollInterval: 50, changeDetection: 'polling' },
new TestLogger(),
);
server.use(
http.post('https://localhost:8080/ofrep/v1/evaluate/flags', () =>
HttpResponse.json({
flags: [],
metadata: {},
eventStreams: [{ type: 'sse', url: 'https://sse.example.com/stream' }],
}),
),
);
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._sseManager).toBeUndefined();
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._pollingIntervalId).toBeDefined();
});
it('should ignore eventStreams on context change when changeDetection is polling', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider(
{ baseUrl: endpointBaseURL, pollInterval: 50, changeDetection: 'polling' },
new TestLogger(),
);
server.use(
http.post('https://localhost:8080/ofrep/v1/evaluate/flags', () =>
HttpResponse.json({
flags: [],
metadata: {},
eventStreams: [{ type: 'sse', url: 'https://sse.example.com/stream' }],
}),
),
);
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
await OpenFeature.setContext({ ...defaultContext, contextChanged: true });
await new Promise((resolve) => setTimeout(resolve, 100));
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._sseManager).toBeUndefined();
});
});
describe('SSE retry backoff', () => {
it('schedules exponential backoff retry after SSE fatal error when polling is disabled', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
jest.useFakeTimers();
try {
const mockConnect = jest.fn();
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(provider as any)._sseManager = { connect: mockConnect, disconnect: jest.fn(), dispose: jest.fn() };
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const fetchSpy = jest.spyOn(provider as any, '_fetchFlags').mockResolvedValue({
status: BulkEvaluationStatus.SUCCESS_WITH_CHANGES,
flags: [],
eventStreams: [{ type: 'sse', url: 'https://sse.example.com/stream' }],
});
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(provider as any)._handleSseError();
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._sseRetryCount).toBe(1);
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._sseRetryTimerId).toBeDefined();
await jest.advanceTimersByTimeAsync(1_000);
expect(fetchSpy).toHaveBeenCalledTimes(1);
expect(mockConnect).toHaveBeenCalledWith(
expect.arrayContaining([expect.objectContaining({ type: 'sse', url: 'https://sse.example.com/stream' })]),
);
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._sseRetryCount).toBe(0); // reset by _connectSseIfAvailable on success
} finally {
jest.useRealTimers();
}
});
it('reschedules backoff when _fetchFlags throws inside the retry timer', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
jest.useFakeTimers();
try {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(provider as any)._sseManager = { connect: jest.fn(), disconnect: jest.fn(), dispose: jest.fn() };
// eslint-disable-next-line @typescript-eslint/no-explicit-any
jest.spyOn(provider as any, '_fetchFlags').mockRejectedValue(new Error('503 Service Unavailable'));
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(provider as any)._handleSseError();
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._sseRetryCount).toBe(1);
// Fire the first retry — _fetchFlags throws → catch calls _handleSseError() again
await jest.advanceTimersByTimeAsync(1_000);
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._sseRetryCount).toBe(2);
// Next backoff timer must be scheduled
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._sseRetryTimerId).toBeDefined();
} finally {
jest.useRealTimers();
}
});
it('clears SSE retry timer on provider close', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
jest.useFakeTimers();
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(provider as any)._sseManager = { connect: jest.fn(), disconnect: jest.fn(), dispose: jest.fn() };
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(provider as any)._handleSseError();
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._sseRetryTimerId).toBeDefined();
jest.useRealTimers();
await provider.onClose?.();
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._sseRetryTimerId).toBeUndefined();
});
it('does not schedule backoff when changeDetection is none', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL, changeDetection: 'none' }, new TestLogger());
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
jest.useFakeTimers();
try {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(provider as any)._sseManager = { connect: jest.fn(), disconnect: jest.fn(), dispose: jest.fn() };
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(provider as any)._handleSseError();
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._sseRetryTimerId).toBeUndefined();
// eslint-disable-next-line @typescript-eslint/no-explicit-any
expect((provider as any)._sseRetryCount).toBe(0);
} finally {
jest.useRealTimers();
}
});
});
it('should not try to call the API before retry-after header', async () => {
const flagKey = 'object-flag';
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL, pollInterval: 100 }, new TestLogger());
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
const client = OpenFeature.getClient(providerName);
const reconcilingHandler = jest.fn();
const staleHandler = jest.fn();
client.addHandler(ClientProviderEvents.Reconciling, reconcilingHandler);
client.addHandler(ClientProviderEvents.Stale, staleHandler);
const got1 = client.getObjectDetails(flagKey, {});
await OpenFeature.setContext({ ...defaultContext, errors: { 429: true } });
await new Promise((resolve) => setTimeout(resolve, 800));
expect(reconcilingHandler).toHaveBeenCalledTimes(1);
expect(staleHandler).toHaveBeenCalledTimes(1);
await OpenFeature.setContext({ ...defaultContext });
expect(staleHandler).toHaveBeenCalledTimes(1);
expect(staleHandler).toHaveBeenCalledTimes(1);
await new Promise((resolve) => setTimeout(resolve, 400));
expect(reconcilingHandler).toHaveBeenCalledTimes(2);
});
it('should not poll when pollInterval is not set (default 0)', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext({ ...defaultContext, changeConfig: true });
await OpenFeature.setProviderAndWait(providerName, provider);
const client = OpenFeature.getClient(providerName);
const configChangedHandler = jest.fn();
client.addHandler(ClientProviderEvents.ConfigurationChanged, configChangedHandler);
// Wait long enough that polling would have fired if enabled
await new Promise((resolve) => setTimeout(resolve, 150));
expect(configChangedHandler).not.toHaveBeenCalled();
});
describe('visibility refresh', () => {
let mockDocument: { visibilityState: string; addEventListener: jest.Mock; removeEventListener: jest.Mock };
beforeEach(() => {
mockDocument = {
visibilityState: 'visible',
addEventListener: jest.fn(),
removeEventListener: jest.fn(),
};
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(globalThis as any).document = mockDocument;
});
afterEach(() => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
delete (globalThis as any).document;
});
it('should register visibility change listener by default', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
expect(mockDocument.addEventListener).toHaveBeenCalledWith('visibilitychange', expect.any(Function));
});
it('should not register visibility change listener when disableVisibilityRefresh is true', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider(
{ baseUrl: endpointBaseURL, disableVisibilityRefresh: true },
new TestLogger(),
);
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
expect(mockDocument.addEventListener).not.toHaveBeenCalled();
});
it('should refetch flags when visibility change fires and page is visible', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext({ ...defaultContext, changeConfig: true });
await OpenFeature.setProviderAndWait(providerName, provider);
const client = OpenFeature.getClient(providerName);
const configChangedHandler = jest.fn();
client.addHandler(ClientProviderEvents.ConfigurationChanged, configChangedHandler);
const handler = mockDocument.addEventListener.mock.calls[0][1];
mockDocument.visibilityState = 'visible';
handler();
await new Promise((resolve) => setTimeout(resolve, 100));
expect(configChangedHandler).toHaveBeenCalled();
});
it('should not emit STALE when a visibility-change refresh fails', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
const client = OpenFeature.getClient(providerName);
const staleHandler = jest.fn();
client.addHandler(ClientProviderEvents.Stale, staleHandler);
server.use(
http.post('https://localhost:8080/ofrep/v1/evaluate/flags', () => HttpResponse.json({}, { status: 401 })),
);
const handler = mockDocument.addEventListener.mock.calls[0][1];
mockDocument.visibilityState = 'visible';
handler();
await new Promise((resolve) => setTimeout(resolve, 100));
expect(staleHandler).not.toHaveBeenCalled();
});
it('should remove visibility change listener on close', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL }, new TestLogger());
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
expect(mockDocument.addEventListener).toHaveBeenCalledWith('visibilitychange', expect.any(Function));
await OpenFeature.clearProviders();
expect(mockDocument.removeEventListener).toHaveBeenCalledWith('visibilitychange', expect.any(Function));
});
});
describe('persistent local cache', () => {
/**
* Writes a PersistedEntry envelope to localStorage using the same Storage key
* that the provider will look up, so tests can seed the cache before
* constructing a provider.
*/
async function seedPersistentCache(
targetingKey: string,
cache: FlagCache,
etag: string | null = null,
writtenAt: Date = new Date(),
metadata?: Record<string, unknown>,
domain = '',
): Promise<void> {
const storage = createTestStorage(domain);
const key = await storage.getStorageKey({ targetingKey });
const entry: PersistedEntry = {
version: 2,
cacheKeyHash: key.split(':')[2],
etag,
writtenAt: writtenAt.toISOString(),
data: cache,
...(metadata !== undefined && { metadata }),
};
localStorage.setItem(key, JSON.stringify(entry));
}
const boolFlagCache: FlagCache = {
'bool-flag': {
key: 'bool-flag',
value: true,
metadata: TEST_FLAG_METADATA,
variant: 'variantA',
reason: StandardResolutionReasons.STATIC,
},
};
it('emits READY from persisted cache on init (cache-first), then refreshes from the network in the background', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
await seedPersistentCache(defaultContext.targetingKey, boolFlagCache);
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL, pollInterval: -1 }, new TestLogger());
await OpenFeature.setContext(defaultContext);
OpenFeature.setProvider(providerName, provider);
const client = OpenFeature.getClient(providerName);
const readyHandler = jest.fn(() => {
const atReady = client.getBooleanDetails('bool-flag', false);
expect(atReady.reason).toBe(StandardResolutionReasons.CACHED);
expect(atReady.value).toBe(true);
});
client.addHandler(ClientProviderEvents.Ready, readyHandler);
await new Promise((resolve) => setTimeout(resolve, 100));
expect(readyHandler).toHaveBeenCalled();
const details = client.getBooleanDetails('bool-flag', false);
expect(details.reason).toBe(StandardResolutionReasons.STATIC);
expect(details.value).toBe(true);
});
it('refreshes from the network in the background after a cache hit when polling is enabled', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
await seedPersistentCache(defaultContext.targetingKey, boolFlagCache);
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL, pollInterval: 50 }, new TestLogger());
await OpenFeature.setContext(defaultContext);
OpenFeature.setProvider(providerName, provider);
const client = OpenFeature.getClient(providerName);
const configChangedHandler = jest.fn();
client.addHandler(ClientProviderEvents.ConfigurationChanged, configChangedHandler);
await new Promise((resolve) => setTimeout(resolve, 150));
expect(configChangedHandler).toHaveBeenCalled();
const details = client.getBooleanDetails('bool-flag', false);
expect(details.reason).toBe(StandardResolutionReasons.STATIC);
expect(details.value).toBe(true);
});
it('does not read or write localStorage when cacheMode is disabled', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const storage = createTestStorage();
const seededKey = await storage.getStorageKey(defaultContext);
await seedPersistentCache(defaultContext.targetingKey, boolFlagCache);
expect(localStorage.getItem(seededKey)).not.toBeNull();
const provider = new OFREPWebProvider(
{ baseUrl: endpointBaseURL, cacheMode: 'disabled', pollInterval: -1 },
new TestLogger(),
);
await OpenFeature.setContext(defaultContext);
await OpenFeature.setProviderAndWait(providerName, provider);
const client = OpenFeature.getClient(providerName);
const details = client.getBooleanDetails('bool-flag', false);
expect(details.reason).toBe(StandardResolutionReasons.STATIC);
// The seeded entry must still be in storage — the disabled provider must not touch it.
expect(localStorage.getItem(seededKey)).not.toBeNull();
});
it('loads persisted cache for the new targeting key on context change, then aligns with the network', async () => {
const providerName = expect.getState().currentTestName || 'test-provider';
const user1 = defaultContext.targetingKey;
const user2 = '22222222-2222-4222-8222-222222222222';
const flagKey = 'per-user-cache-flag';
const ctx = (targetingKey: string) => ({ ...defaultContext, targetingKey, perUserCacheTest: true });
await seedPersistentCache(user1, {
[flagKey]: {
key: flagKey,
value: { user: 1 },
metadata: TEST_FLAG_METADATA,
reason: StandardResolutionReasons.STATIC,
},
});
await seedPersistentCache(user2, {
[flagKey]: {
key: flagKey,
value: { user: 2 },
metadata: TEST_FLAG_METADATA,
reason: StandardResolutionReasons.STATIC,
},
});
const provider = new OFREPWebProvider({ baseUrl: endpointBaseURL, pollInterval: -1 }, new TestLogger());
await OpenFeature.setContext(ctx(user1));
await OpenFeature.setProviderAndWait(providerName, provider);
const client = OpenFeature.getClient(providerName);
await new Promise((resolve) => setTimeout(resolve, 100));
expect(client.getObjectDetails(flagKey, {}).value).toEqual({ user: 1 });
expect(client.getObjectDetails(flagKey, {}).reason).toBe(StandardResolutionReasons.STATIC);
await OpenFeature.setContext(ctx(user2));
expect(client.getObjectDetails(flagKey, {}).value).toEqual({ user: 2 });
expect(client.getObjectDetails(flagKey, {}).reason).toBe(StandardResolutionReasons.CACHED);
await new Promise((resolve) => setTimeout(resolve, 100));
expect(client.getObjectDetails(flagKey, {}).value).toEqual({ user: 2 });