-
Notifications
You must be signed in to change notification settings - Fork 13
Expand file tree
/
Copy pathfactory.py
More file actions
1414 lines (1226 loc) · 61.8 KB
/
Copy pathfactory.py
File metadata and controls
1414 lines (1226 loc) · 61.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
"""A module for Split.io Factories."""
import logging
import threading
from collections import Counter
from enum import Enum
import queue
from splitio.optional.loaders import asyncio
from splitio.client.client import Client, ClientAsync
from splitio.client import input_validator
from splitio.client.config import sanitize as sanitize_config, DEFAULT_DATA_SAMPLING, AuthenticateScheme
from splitio.client.manager import SplitManager, SplitManagerAsync
from splitio.client import util
from splitio.client.listener import ImpressionListenerWrapper, ImpressionListenerWrapperAsync
from splitio.engine.impressions.impressions import Manager as ImpressionsManager
from splitio.engine.impressions import set_classes, set_classes_async
from splitio.engine.impressions.strategies import StrategyDebugMode, StrategyNoneMode
from splitio.engine.telemetry import TelemetryStorageProducer, TelemetryStorageConsumer, \
TelemetryStorageProducerAsync, TelemetryStorageConsumerAsync
from splitio.engine.impressions.manager import Counter as ImpressionsCounter
from splitio.engine.impressions.unique_keys_tracker import UniqueKeysTracker, UniqueKeysTrackerAsync
from splitio.events.events_manager import EventsManager, EventsManagerAsync
from splitio.events.events_manager_config import EventsManagerConfig
from splitio.events.events_task import EventsTask, EventsTaskAsync
from splitio.events.events_delivery import EventsDelivery
from splitio.models.fallback_config import FallbackTreatmentCalculator
from splitio.models.notification import SdkInternalEventNotification
from splitio.models.events import SdkInternalEvent
# Storage
from splitio.storage.inmemmory import InMemorySplitStorage, InMemorySegmentStorage, \
InMemoryImpressionStorage, InMemoryEventStorage, InMemoryTelemetryStorage, LocalhostTelemetryStorage, \
InMemorySplitStorageAsync, InMemorySegmentStorageAsync, InMemoryImpressionStorageAsync, \
InMemoryEventStorageAsync, InMemoryTelemetryStorageAsync, LocalhostTelemetryStorageAsync, \
InMemoryRuleBasedSegmentStorage, InMemoryRuleBasedSegmentStorageAsync
from splitio.storage.adapters import redis
from splitio.storage.redis import RedisSplitStorage, RedisSegmentStorage, RedisImpressionsStorage, \
RedisEventsStorage, RedisTelemetryStorage, RedisSplitStorageAsync, RedisEventsStorageAsync,\
RedisSegmentStorageAsync, RedisImpressionsStorageAsync, RedisTelemetryStorageAsync, \
RedisRuleBasedSegmentsStorage, RedisRuleBasedSegmentsStorageAsync
from splitio.storage.pluggable import PluggableEventsStorage, PluggableImpressionsStorage, PluggableSegmentStorage, \
PluggableSplitStorage, PluggableTelemetryStorage, PluggableTelemetryStorageAsync, PluggableEventsStorageAsync, \
PluggableImpressionsStorageAsync, PluggableSegmentStorageAsync, PluggableSplitStorageAsync, \
PluggableRuleBasedSegmentsStorage, PluggableRuleBasedSegmentsStorageAsync
# APIs
from splitio.api.client import HttpClient, HttpClientAsync, HttpClientKerberos
from splitio.api.splits import SplitsAPI, SplitsAPIAsync
from splitio.api.segments import SegmentsAPI, SegmentsAPIAsync
from splitio.api.impressions import ImpressionsAPI, ImpressionsAPIAsync
from splitio.api.events import EventsAPI, EventsAPIAsync
from splitio.api.auth import AuthAPI, AuthAPIAsync
from splitio.api.telemetry import TelemetryAPI, TelemetryAPIAsync
from splitio.util.time import get_current_epoch_time_ms
# Tasks
from splitio.tasks.split_sync import SplitSynchronizationTask, SplitSynchronizationTaskAsync
from splitio.tasks.segment_sync import SegmentSynchronizationTask, SegmentSynchronizationTaskAsync
from splitio.tasks.impressions_sync import ImpressionsSyncTask, ImpressionsCountSyncTask,\
ImpressionsCountSyncTaskAsync, ImpressionsSyncTaskAsync
from splitio.tasks.events_sync import EventsSyncTask, EventsSyncTaskAsync
from splitio.tasks.telemetry_sync import TelemetrySyncTask, TelemetrySyncTaskAsync
# Synchronizer
from splitio.sync.synchronizer import SplitTasks, SplitSynchronizers, Synchronizer, \
LocalhostSynchronizer, RedisSynchronizer, PluggableSynchronizer,\
SynchronizerAsync, RedisSynchronizerAsync, LocalhostSynchronizerAsync
from splitio.sync.manager import Manager, RedisManager, ManagerAsync, RedisManagerAsync
from splitio.sync.split import SplitSynchronizer, LocalSplitSynchronizer, LocalhostMode,\
SplitSynchronizerAsync, LocalSplitSynchronizerAsync
from splitio.sync.segment import SegmentSynchronizer, LocalSegmentSynchronizer, SegmentSynchronizerAsync,\
LocalSegmentSynchronizerAsync
from splitio.sync.impression import ImpressionSynchronizer, ImpressionsCountSynchronizer, \
ImpressionsCountSynchronizerAsync, ImpressionSynchronizerAsync
from splitio.sync.event import EventSynchronizer, EventSynchronizerAsync
from splitio.sync.telemetry import TelemetrySynchronizer, InMemoryTelemetrySubmitter, \
LocalhostTelemetrySubmitter, RedisTelemetrySubmitter, LocalhostTelemetrySubmitterAsync, \
InMemoryTelemetrySubmitterAsync, TelemetrySynchronizerAsync, RedisTelemetrySubmitterAsync
# Recorder
from splitio.recorder.recorder import StandardRecorder, PipelinedRecorder, StandardRecorderAsync, PipelinedRecorderAsync
# Localhost stuff
from splitio.client.localhost import LocalhostEventsStorage, LocalhostImpressionsStorage, \
LocalhostImpressionsStorageAsync, LocalhostEventsStorageAsync
_LOGGER = logging.getLogger(__name__)
_INSTANTIATED_FACTORIES = Counter()
_INSTANTIATED_FACTORIES_LOCK = threading.RLock()
_MIN_DEFAULT_DATA_SAMPLING_ALLOWED = 0.1 # 10%
_MAX_RETRY_SYNC_ALL = 3
_UNIQUE_KEYS_CACHE_SIZE = 30000
class Status(Enum):
"""Factory Status."""
NOT_INITIALIZED = 'NOT_INITIALIZED'
READY = 'READY'
DESTROYED = 'DESTROYED'
WAITING_FORK = 'WAITING_FORK'
class TimeoutException(Exception):
"""Exception to be raised upon a block_until_ready call when a timeout expires."""
pass
class SplitFactoryBase(object): # pylint: disable=too-many-instance-attributes
"""Split Factory/Container class."""
def __init__(self, sdk_key, storages):
self._sdk_key = sdk_key
self._storages = storages
self._status = None
def _get_storage(self, name):
"""
Return a reference to the specified storage.
:param name: Name of the requested storage.
:type name: str
:return: requested factory.
:rtype: object
"""
return self._storages[name]
@property
def ready(self):
"""
Return whether the factory is ready.
:return: True if the factory is ready. False otherwhise.
:rtype: bool
"""
return self._status == Status.READY
def _update_instantiated_factories(self):
self._status = Status.DESTROYED
with _INSTANTIATED_FACTORIES_LOCK:
_INSTANTIATED_FACTORIES.subtract([self._sdk_key])
@property
def destroyed(self):
"""
Return whether the factory has been destroyed or not.
:return: True if the factory has been destroyed. False otherwise.
:rtype: bool
"""
return self._status == Status.DESTROYED
def _waiting_fork(self):
"""
Return whether the factory is waiting to be recreated by forking or not.
:return: True if the factory is waiting to be recreated by forking. False otherwise.
:rtype: bool
"""
return self._status == Status.WAITING_FORK
class SplitFactory(SplitFactoryBase): # pylint: disable=too-many-instance-attributes
"""Split Factory/Container class."""
def __init__( # pylint: disable=too-many-arguments
self,
sdk_key,
storages,
labels_enabled,
recorder,
internal_events_queue,
events_manager,
sync_manager=None,
sdk_ready_flag=None,
telemetry_producer=None,
telemetry_init_producer=None,
telemetry_submitter=None,
preforked_initialization=False,
fallback_treatment_calculator=None
):
"""
Class constructor.
:param storages: Dictionary of storages for all split models.
:type storages: dict
:param labels_enabled: Whether the impressions should store labels or not.
:type labels_enabled: bool
:param apis: Dictionary of apis client wrappers
:type apis: dict
:param sync_manager: Manager synchronization
:type sync_manager: splitio.sync.manager.Manager
:param sdk_ready_flag: Event to set when the sdk is ready.
:type sdk_ready_flag: threading.Event
:param recorder: StatsRecorder instance
:type recorder: StatsRecorder
:param preforked_initialization: Whether should be instantiated as preforked or not.
:type preforked_initialization: bool
"""
SplitFactoryBase.__init__(self, sdk_key, storages)
self._labels_enabled = labels_enabled
self._sync_manager = sync_manager
self._recorder = recorder
self._preforked_initialization = preforked_initialization
self._telemetry_evaluation_producer = telemetry_producer.get_telemetry_evaluation_producer()
self._telemetry_init_producer = telemetry_init_producer
self._telemetry_submitter = telemetry_submitter
self._ready_time = get_current_epoch_time_ms()
_LOGGER.debug("Running in threading mode")
self._sdk_internal_ready_flag = sdk_ready_flag
self._fallback_treatment_calculator = fallback_treatment_calculator
self._internal_events_queue = internal_events_queue
self._events_manager = events_manager
self._start_status_updater()
def _start_status_updater(self):
"""
Perform status updater
"""
if self._preforked_initialization:
self._status = Status.WAITING_FORK
return
# If we have a ready flag, it means we have sync tasks that need to finish
# before the SDK client becomes ready.
if self._sdk_internal_ready_flag is not None:
self._sdk_ready_flag = threading.Event()
self._status = Status.NOT_INITIALIZED
# add a listener that updates the status to READY once the flag is set.
ready_updater = threading.Thread(target=self._update_status_when_ready,
name='SDKReadyFlagUpdater', daemon=True)
ready_updater.start()
else:
self._status = Status.READY
self._internal_events_queue.put(SdkInternalEventNotification(SdkInternalEvent.SDK_READY, None))
def _update_status_when_ready(self):
"""Wait until the sdk is ready and update the status."""
self._sdk_internal_ready_flag.wait()
self._status = Status.READY
self._sdk_ready_flag.set()
self._internal_events_queue.put(SdkInternalEventNotification(SdkInternalEvent.SDK_READY, None))
self._telemetry_init_producer.record_ready_time(get_current_epoch_time_ms() - self._ready_time)
redundant_factory_count, active_factory_count = _get_active_and_redundant_count()
self._telemetry_init_producer.record_active_and_redundant_factories(active_factory_count, redundant_factory_count)
config_post_thread = threading.Thread(target=self._telemetry_submitter.synchronize_config(), name="PostConfigData")
config_post_thread.setDaemon(True)
config_post_thread.start()
def client(self):
"""
Return a new client.
This client is only a set of references to structures hold by the factory.
Creating one a fast operation and safe to be used anywhere.
"""
return Client(self, self._recorder, self._events_manager, self._labels_enabled, self._fallback_treatment_calculator)
def manager(self):
"""
Return a new manager.
This manager is only a set of references to structures hold by the factory.
Creating one a fast operation and safe to be used anywhere.
"""
return SplitManager(self)
def block_until_ready(self, timeout=None):
"""
Blocks until the sdk is ready or the timeout specified by the user expires.
When ready, the factory's status is updated accordingly.
:param timeout: Number of seconds to wait (fractions allowed)
:type timeout: int
"""
if self._sdk_internal_ready_flag is not None:
ready = self._sdk_ready_flag.wait(timeout)
if not ready:
self._telemetry_init_producer.record_bur_time_out()
raise TimeoutException('SDK Initialization: time of %d exceeded' % timeout)
def destroy(self, destroyed_event=None):
"""
Destroy the factory and render clients unusable.
Destroy frees up storage taken but split data, flushes impressions & events,
and invalidates the clients, making them return control.
:param destroyed_event: Event to signal when destroy process has finished.
:type destroyed_event: threading.Event
"""
if self.destroyed:
_LOGGER.info('Factory already destroyed.')
return
try:
_LOGGER.info('Factory destroy called, stopping tasks.')
self._events_manager.destroy()
if self._sync_manager is not None:
if destroyed_event is not None:
def _wait_for_tasks_to_stop():
self._sync_manager.stop(True)
destroyed_event.set()
wait_thread = threading.Thread(target=_wait_for_tasks_to_stop, daemon=True)
wait_thread.start()
else:
self._sync_manager.stop(False)
elif destroyed_event is not None:
destroyed_event.set()
finally:
self._update_instantiated_factories()
def resume(self):
"""
Function in charge of starting periodic/realtime synchronization after a fork.
"""
if not self._waiting_fork():
_LOGGER.warning('Cannot call resume')
return
self._sync_manager.recreate()
sdk_ready_flag = threading.Event()
self._sdk_internal_ready_flag = sdk_ready_flag
self._sync_manager._ready_flag = sdk_ready_flag
self._get_storage('impressions').clear()
self._get_storage('events').clear()
initialization_thread = threading.Thread(
target=self._sync_manager.start,
name="SDKInitializer",
daemon=True
)
initialization_thread.start()
self._preforked_initialization = False # reset for status updater
self._start_status_updater()
class SplitFactoryAsync(SplitFactoryBase): # pylint: disable=too-many-instance-attributes
"""Split Factory/Container async class."""
def __init__( # pylint: disable=too-many-arguments
self,
sdk_key,
storages,
labels_enabled,
recorder,
internal_events_queue,
events_manager,
sync_manager=None,
telemetry_producer=None,
telemetry_init_producer=None,
telemetry_submitter=None,
manager_start_task=None,
api_client=None,
fallback_treatment_calculator=None
):
"""
Class constructor.
:param storages: Dictionary of storages for all split models.
:type storages: dict
:param labels_enabled: Whether the impressions should store labels or not.
:type labels_enabled: bool
:param apis: Dictionary of apis client wrappers
:type apis: dict
:param sync_manager: Manager synchronization
:type sync_manager: splitio.sync.manager.Manager
:param sdk_ready_flag: Event to set when the sdk is ready.
:type sdk_ready_flag: threading.Event
:param recorder: StatsRecorder instance
:type recorder: StatsRecorder
:param preforked_initialization: Whether should be instantiated as preforked or not.
:type preforked_initialization: bool
"""
SplitFactoryBase.__init__(self, sdk_key, storages)
self._labels_enabled = labels_enabled
self._sync_manager = sync_manager
self._recorder = recorder
self._telemetry_evaluation_producer = telemetry_producer.get_telemetry_evaluation_producer()
self._telemetry_init_producer = telemetry_init_producer
self._telemetry_submitter = telemetry_submitter
self._ready_time = get_current_epoch_time_ms()
_LOGGER.debug("Running in asyncio mode")
self._internal_events_queue = internal_events_queue
self._events_manager = events_manager
self._manager_start_task = manager_start_task
self._status = Status.NOT_INITIALIZED
self._sdk_ready_flag = asyncio.Event()
self._ready_task = asyncio.get_running_loop().create_task(self._update_status_when_ready_async())
self._api_client = api_client
self._fallback_treatment_calculator = fallback_treatment_calculator
async def _update_status_when_ready_async(self):
"""Wait until the sdk is ready and update the status for async mode."""
if self._manager_start_task is not None:
await self._manager_start_task
self._manager_start_task = None
await self._telemetry_init_producer.record_ready_time(get_current_epoch_time_ms() - self._ready_time)
redundant_factory_count, active_factory_count = _get_active_and_redundant_count()
await self._telemetry_init_producer.record_active_and_redundant_factories(active_factory_count, redundant_factory_count)
try:
await self._telemetry_submitter.synchronize_config()
except Exception as e:
_LOGGER.error("Failed to post Telemetry config")
_LOGGER.debug(str(e))
self._status = Status.READY
self._sdk_ready_flag.set()
await self._internal_events_queue.put(SdkInternalEventNotification(SdkInternalEvent.SDK_READY, None))
def manager(self):
"""
Return a new manager.
This manager is only a set of references to structures hold by the factory.
Creating one a fast operation and safe to be used anywhere.
"""
return SplitManagerAsync(self)
async def block_until_ready(self, timeout=None):
"""
Blocks until the sdk is ready or the timeout specified by the user expires.
When ready, the factory's status is updated accordingly.
:param timeout: Number of seconds to wait (fractions allowed)
:type timeout: int
"""
try:
await asyncio.wait_for(asyncio.shield(self._sdk_ready_flag.wait()), timeout)
except asyncio.TimeoutError as e:
_LOGGER.error("Exception initializing SDK")
_LOGGER.debug(str(e))
await self._telemetry_init_producer.record_bur_time_out()
raise TimeoutException('SDK Initialization: time of %d exceeded' % timeout)
async def destroy(self, destroyed_event=None):
"""
Destroy the factory and render clients unusable.
Destroy frees up storage taken but split data, flushes impressions & events,
and invalidates the clients, making them return control.
:param destroyed_event: Event to signal when destroy process has finished.
:type destroyed_event: threading.Event
"""
if self.destroyed:
_LOGGER.info('Factory already destroyed.')
return
try:
_LOGGER.info('Factory destroy called, stopping tasks.')
if self._manager_start_task is not None and not self._manager_start_task.done():
self._manager_start_task.cancel()
if self._sync_manager is not None:
await self._sync_manager.stop(True)
if not self._ready_task.done():
self._ready_task.cancel()
self._ready_task = None
if isinstance(self._storages['splits'], RedisSplitStorageAsync):
await self._get_storage('splits').redis.close()
if isinstance(self._sync_manager, ManagerAsync) and isinstance(self._telemetry_submitter, InMemoryTelemetrySubmitterAsync):
await self._api_client.close_session()
except Exception as e:
_LOGGER.error('Exception destroying factory.')
_LOGGER.debug(str(e))
finally:
self._update_instantiated_factories()
def client(self):
"""
Return a new client.
This client is only a set of references to structures hold by the factory.
Creating one a fast operation and safe to be used anywhere.
"""
return ClientAsync(self, self._recorder, self._events_manager, self._labels_enabled, self._fallback_treatment_calculator)
def _wrap_impression_listener(listener, metadata):
"""
Wrap the impression listener if any.
:param listener: User supplied impression listener or None
:type listener: splitio.client.listener.ImpressionListener | None
:param metadata: SDK Metadata
:type metadata: splitio.client.util.SdkMetadata
"""
if listener is not None:
return ImpressionListenerWrapper(listener, metadata)
return None
def _wrap_impression_listener_async(listener, metadata):
"""
Wrap the impression listener if any.
:param listener: User supplied impression listener or None
:type listener: splitio.client.listener.ImpressionListener | None
:param metadata: SDK Metadata
:type metadata: splitio.client.util.SdkMetadata
"""
if listener is not None:
return ImpressionListenerWrapperAsync(listener, metadata)
return None
def _build_in_memory_factory(api_key, cfg, sdk_url=None, events_url=None, # pylint:disable=too-many-arguments,too-many-locals
auth_api_base_url=None, streaming_api_base_url=None, telemetry_api_base_url=None,
total_flag_sets=0, invalid_flag_sets=0):
"""Build and return a split factory tailored to the supplied config."""
if not input_validator.validate_factory_instantiation(api_key):
return None
extra_cfg = {}
extra_cfg['sdk_url'] = sdk_url
extra_cfg['events_url'] = events_url
extra_cfg['auth_url'] = auth_api_base_url
extra_cfg['streaming_url'] = streaming_api_base_url
extra_cfg['telemetry_url'] = telemetry_api_base_url
telemetry_storage = InMemoryTelemetryStorage()
telemetry_producer = TelemetryStorageProducer(telemetry_storage)
telemetry_consumer = TelemetryStorageConsumer(telemetry_storage)
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
telemetry_evaluation_producer = telemetry_producer.get_telemetry_evaluation_producer()
telemetry_init_producer = telemetry_producer.get_telemetry_init_producer()
authentication_params = None
if cfg.get("httpAuthenticateScheme") in [AuthenticateScheme.KERBEROS_SPNEGO, AuthenticateScheme.KERBEROS_PROXY]:
authentication_params = [cfg.get("kerberosPrincipalUser"),
cfg.get("kerberosPrincipalPassword")]
http_client = HttpClientKerberos(
sdk_url=sdk_url,
events_url=events_url,
auth_url=auth_api_base_url,
telemetry_url=telemetry_api_base_url,
timeout=cfg.get('connectionTimeout'),
authentication_scheme = cfg.get("httpAuthenticateScheme"),
authentication_params = authentication_params
)
else:
http_client = HttpClient(
sdk_url=sdk_url,
events_url=events_url,
auth_url=auth_api_base_url,
telemetry_url=telemetry_api_base_url,
timeout=cfg.get('connectionTimeout'),
)
sdk_metadata = util.get_metadata(cfg)
apis = {
'auth': AuthAPI(http_client, api_key, sdk_metadata, telemetry_runtime_producer),
'splits': SplitsAPI(http_client, api_key, sdk_metadata, telemetry_runtime_producer),
'segments': SegmentsAPI(http_client, api_key, sdk_metadata, telemetry_runtime_producer),
'impressions': ImpressionsAPI(http_client, api_key, sdk_metadata, telemetry_runtime_producer, cfg['impressionsMode']),
'events': EventsAPI(http_client, api_key, sdk_metadata, telemetry_runtime_producer),
'telemetry': TelemetryAPI(http_client, api_key, sdk_metadata, telemetry_runtime_producer),
}
internal_events_queue = queue.Queue()
events_manager = EventsManager(EventsManagerConfig(), EventsDelivery())
internal_events_task = EventsTask(events_manager.notify_internal_event, internal_events_queue)
storages = {
'splits': InMemorySplitStorage(internal_events_queue, cfg['flagSetsFilter'] if cfg['flagSetsFilter'] is not None else []),
'segments': InMemorySegmentStorage(internal_events_queue),
'rule_based_segments': InMemoryRuleBasedSegmentStorage(internal_events_queue),
'impressions': InMemoryImpressionStorage(cfg['impressionsQueueSize'], telemetry_runtime_producer),
'events': InMemoryEventStorage(cfg['eventsQueueSize'], telemetry_runtime_producer),
}
telemetry_submitter = InMemoryTelemetrySubmitter(telemetry_consumer, storages['splits'], storages['segments'], apis['telemetry'])
imp_counter = ImpressionsCounter()
unique_keys_tracker = UniqueKeysTracker(_UNIQUE_KEYS_CACHE_SIZE)
unique_keys_synchronizer, clear_filter_sync, unique_keys_task, \
clear_filter_task, impressions_count_sync, impressions_count_task, \
imp_strategy, none_strategy = set_classes('MEMORY', cfg['impressionsMode'], apis, imp_counter, unique_keys_tracker)
imp_manager = ImpressionsManager(
imp_strategy, none_strategy, telemetry_runtime_producer)
synchronizers = SplitSynchronizers(
SplitSynchronizer(apis['splits'], storages['splits'], storages['rule_based_segments']),
SegmentSynchronizer(apis['segments'], storages['splits'], storages['segments'], storages['rule_based_segments']),
ImpressionSynchronizer(apis['impressions'], storages['impressions'],
cfg['impressionsBulkSize']),
EventSynchronizer(apis['events'], storages['events'], cfg['eventsBulkSize']),
impressions_count_sync,
TelemetrySynchronizer(telemetry_submitter),
unique_keys_synchronizer,
clear_filter_sync,
)
tasks = SplitTasks(
SplitSynchronizationTask(
synchronizers.split_sync.synchronize_splits,
cfg['featuresRefreshRate'],
),
SegmentSynchronizationTask(
synchronizers.segment_sync.synchronize_segments,
cfg['segmentsRefreshRate'],
),
ImpressionsSyncTask(
synchronizers.impressions_sync.synchronize_impressions,
cfg['impressionsRefreshRate'],
),
EventsSyncTask(synchronizers.events_sync.synchronize_events, cfg['eventsPushRate']),
impressions_count_task,
TelemetrySyncTask(synchronizers.telemetry_sync.synchronize_stats, cfg['metricsRefreshRate']),
unique_keys_task,
clear_filter_task,
internal_events_task
)
synchronizer = Synchronizer(synchronizers, tasks)
preforked_initialization = cfg.get('preforkedInitialization', False)
sdk_ready_flag = threading.Event() if not preforked_initialization else None
manager = Manager(sdk_ready_flag, synchronizer, apis['auth'], cfg['streamingEnabled'],
sdk_metadata, telemetry_runtime_producer, streaming_api_base_url, api_key[-4:])
storages['events'].set_queue_full_hook(tasks.events_task.flush)
storages['impressions'].set_queue_full_hook(tasks.impressions_task.flush)
recorder = StandardRecorder(
imp_manager,
storages['events'],
storages['impressions'],
telemetry_evaluation_producer,
telemetry_runtime_producer,
_wrap_impression_listener(cfg['impressionListener'], sdk_metadata),
imp_counter=imp_counter,
unique_keys_tracker=unique_keys_tracker
)
telemetry_init_producer.record_config(cfg, extra_cfg, total_flag_sets, invalid_flag_sets)
internal_events_task.start()
if preforked_initialization:
synchronizer.sync_all(max_retry_attempts=_MAX_RETRY_SYNC_ALL)
synchronizer._split_synchronizers._segment_sync.shutdown()
return SplitFactory(api_key, storages, cfg['labelsEnabled'],
recorder, internal_events_queue, events_manager, manager, None, telemetry_producer, telemetry_init_producer, telemetry_submitter, preforked_initialization=preforked_initialization,
fallback_treatment_calculator=FallbackTreatmentCalculator(cfg['fallbackTreatments']))
initialization_thread = threading.Thread(target=manager.start, name="SDKInitializer", daemon=True)
initialization_thread.start()
return SplitFactory(api_key, storages, cfg['labelsEnabled'],
recorder, internal_events_queue, events_manager, manager, sdk_ready_flag,
telemetry_producer, telemetry_init_producer,
telemetry_submitter, fallback_treatment_calculator = FallbackTreatmentCalculator(cfg['fallbackTreatments']))
async def _build_in_memory_factory_async(api_key, cfg, sdk_url=None, events_url=None, # pylint:disable=too-many-arguments,too-many-localsa
auth_api_base_url=None, streaming_api_base_url=None, telemetry_api_base_url=None,
total_flag_sets=0, invalid_flag_sets=0):
"""Build and return a split factory tailored to the supplied config in async mode."""
if not input_validator.validate_factory_instantiation(api_key):
return None
extra_cfg = {}
extra_cfg['sdk_url'] = sdk_url
extra_cfg['events_url'] = events_url
extra_cfg['auth_url'] = auth_api_base_url
extra_cfg['streaming_url'] = streaming_api_base_url
extra_cfg['telemetry_url'] = telemetry_api_base_url
telemetry_storage = await InMemoryTelemetryStorageAsync.create()
telemetry_producer = TelemetryStorageProducerAsync(telemetry_storage)
telemetry_consumer = TelemetryStorageConsumerAsync(telemetry_storage)
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
telemetry_evaluation_producer = telemetry_producer.get_telemetry_evaluation_producer()
telemetry_init_producer = telemetry_producer.get_telemetry_init_producer()
http_client = HttpClientAsync(
sdk_url=sdk_url,
events_url=events_url,
auth_url=auth_api_base_url,
telemetry_url=telemetry_api_base_url,
timeout=cfg.get('connectionTimeout')
)
sdk_metadata = util.get_metadata(cfg)
apis = {
'auth': AuthAPIAsync(http_client, api_key, sdk_metadata, telemetry_runtime_producer),
'splits': SplitsAPIAsync(http_client, api_key, sdk_metadata, telemetry_runtime_producer),
'segments': SegmentsAPIAsync(http_client, api_key, sdk_metadata, telemetry_runtime_producer),
'impressions': ImpressionsAPIAsync(http_client, api_key, sdk_metadata, telemetry_runtime_producer, cfg['impressionsMode']),
'events': EventsAPIAsync(http_client, api_key, sdk_metadata, telemetry_runtime_producer),
'telemetry': TelemetryAPIAsync(http_client, api_key, sdk_metadata, telemetry_runtime_producer),
}
internal_events_queue = asyncio.Queue()
events_manager = EventsManagerAsync(EventsManagerConfig(), EventsDelivery())
internal_events_task = EventsTaskAsync(events_manager.notify_internal_event, internal_events_queue)
storages = {
'splits': InMemorySplitStorageAsync(internal_events_queue, cfg['flagSetsFilter'] if cfg['flagSetsFilter'] is not None else []),
'segments': InMemorySegmentStorageAsync(internal_events_queue),
'rule_based_segments': InMemoryRuleBasedSegmentStorageAsync(internal_events_queue),
'impressions': InMemoryImpressionStorageAsync(cfg['impressionsQueueSize'], telemetry_runtime_producer),
'events': InMemoryEventStorageAsync(cfg['eventsQueueSize'], telemetry_runtime_producer),
}
telemetry_submitter = InMemoryTelemetrySubmitterAsync(telemetry_consumer, storages['splits'], storages['segments'], apis['telemetry'])
imp_counter = ImpressionsCounter()
unique_keys_tracker = UniqueKeysTrackerAsync(_UNIQUE_KEYS_CACHE_SIZE)
unique_keys_synchronizer, clear_filter_sync, unique_keys_task, \
clear_filter_task, impressions_count_sync, impressions_count_task, \
imp_strategy, none_strategy = set_classes_async('MEMORY', cfg['impressionsMode'], apis, imp_counter, unique_keys_tracker)
imp_manager = ImpressionsManager(
imp_strategy, none_strategy, telemetry_runtime_producer)
synchronizers = SplitSynchronizers(
SplitSynchronizerAsync(apis['splits'], storages['splits'], storages['rule_based_segments']),
SegmentSynchronizerAsync(apis['segments'], storages['splits'], storages['segments'], storages['rule_based_segments']),
ImpressionSynchronizerAsync(apis['impressions'], storages['impressions'],
cfg['impressionsBulkSize']),
EventSynchronizerAsync(apis['events'], storages['events'], cfg['eventsBulkSize']),
impressions_count_sync,
TelemetrySynchronizerAsync(telemetry_submitter),
unique_keys_synchronizer,
clear_filter_sync,
)
tasks = SplitTasks(
SplitSynchronizationTaskAsync(
synchronizers.split_sync.synchronize_splits,
cfg['featuresRefreshRate'],
),
SegmentSynchronizationTaskAsync(
synchronizers.segment_sync.synchronize_segments,
cfg['segmentsRefreshRate'],
),
ImpressionsSyncTaskAsync(
synchronizers.impressions_sync.synchronize_impressions,
cfg['impressionsRefreshRate'],
),
EventsSyncTaskAsync(synchronizers.events_sync.synchronize_events, cfg['eventsPushRate']),
impressions_count_task,
TelemetrySyncTaskAsync(synchronizers.telemetry_sync.synchronize_stats, cfg['metricsRefreshRate']),
unique_keys_task,
clear_filter_task,
internal_events_task
)
synchronizer = SynchronizerAsync(synchronizers, tasks)
manager = ManagerAsync(synchronizer, apis['auth'], cfg['streamingEnabled'],
sdk_metadata, telemetry_runtime_producer, streaming_api_base_url, api_key[-4:])
storages['events'].set_queue_full_hook(tasks.events_task.flush)
storages['impressions'].set_queue_full_hook(tasks.impressions_task.flush)
recorder = StandardRecorderAsync(
imp_manager,
storages['events'],
storages['impressions'],
telemetry_evaluation_producer,
telemetry_runtime_producer,
_wrap_impression_listener_async(cfg['impressionListener'], sdk_metadata),
imp_counter=imp_counter,
unique_keys_tracker=unique_keys_tracker
)
await telemetry_init_producer.record_config(cfg, extra_cfg, total_flag_sets, invalid_flag_sets)
internal_events_task.start()
manager_start_task = asyncio.get_running_loop().create_task(manager.start())
return SplitFactoryAsync(api_key, storages, cfg['labelsEnabled'],
recorder, internal_events_queue, events_manager, manager,
telemetry_producer, telemetry_init_producer,
telemetry_submitter, manager_start_task=manager_start_task,
api_client=http_client, fallback_treatment_calculator=FallbackTreatmentCalculator(cfg['fallbackTreatments']))
def _build_redis_factory(api_key, cfg):
"""Build and return a split factory with redis-based storage."""
sdk_metadata = util.get_metadata(cfg)
redis_adapter = redis.build(cfg)
cache_enabled = cfg.get('redisLocalCacheEnabled', False)
cache_ttl = cfg.get('redisLocalCacheTTL', 5)
storages = {
'splits': RedisSplitStorage(redis_adapter, cache_enabled, cache_ttl, []),
'segments': RedisSegmentStorage(redis_adapter),
'rule_based_segments': RedisRuleBasedSegmentsStorage(redis_adapter),
'impressions': RedisImpressionsStorage(redis_adapter, sdk_metadata),
'events': RedisEventsStorage(redis_adapter, sdk_metadata),
'telemetry': RedisTelemetryStorage(redis_adapter, sdk_metadata)
}
telemetry_producer = TelemetryStorageProducer(storages['telemetry'])
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
telemetry_init_producer = telemetry_producer.get_telemetry_init_producer()
telemetry_submitter = RedisTelemetrySubmitter(storages['telemetry'])
data_sampling = cfg.get('dataSampling', DEFAULT_DATA_SAMPLING)
if data_sampling < _MIN_DEFAULT_DATA_SAMPLING_ALLOWED:
_LOGGER.warning("dataSampling cannot be less than %.2f, defaulting to minimum",
_MIN_DEFAULT_DATA_SAMPLING_ALLOWED)
data_sampling = _MIN_DEFAULT_DATA_SAMPLING_ALLOWED
imp_counter = ImpressionsCounter()
unique_keys_tracker = UniqueKeysTracker(_UNIQUE_KEYS_CACHE_SIZE)
unique_keys_synchronizer, clear_filter_sync, unique_keys_task, \
clear_filter_task, impressions_count_sync, impressions_count_task, \
imp_strategy, none_strategy = set_classes('REDIS', cfg['impressionsMode'], redis_adapter, imp_counter, unique_keys_tracker)
imp_manager = ImpressionsManager(
imp_strategy, none_strategy,
telemetry_runtime_producer)
synchronizers = SplitSynchronizers(None, None, None, None,
impressions_count_sync,
None,
unique_keys_synchronizer,
clear_filter_sync
)
tasks = SplitTasks(None, None, None, None,
impressions_count_task,
None,
unique_keys_task,
clear_filter_task
)
synchronizer = RedisSynchronizer(synchronizers, tasks)
recorder = PipelinedRecorder(
redis_adapter.pipeline,
imp_manager,
storages['events'],
storages['impressions'],
storages['telemetry'],
data_sampling,
_wrap_impression_listener(cfg['impressionListener'], sdk_metadata),
imp_counter=imp_counter,
unique_keys_tracker=unique_keys_tracker
)
manager = RedisManager(synchronizer)
initialization_thread = threading.Thread(target=manager.start, name="SDKInitializer", daemon=True)
initialization_thread.start()
telemetry_init_producer.record_config(cfg, {}, 0, 0)
internal_events_queue = queue.Queue()
events_manager = EventsManager(EventsManagerConfig(), EventsDelivery())
split_factory = SplitFactory(
api_key,
storages,
cfg['labelsEnabled'],
recorder,
internal_events_queue,
events_manager,
manager,
sdk_ready_flag=None,
telemetry_producer=telemetry_producer,
telemetry_init_producer=telemetry_init_producer,
fallback_treatment_calculator=FallbackTreatmentCalculator(cfg['fallbackTreatments'])
)
redundant_factory_count, active_factory_count = _get_active_and_redundant_count()
storages['telemetry'].record_active_and_redundant_factories(active_factory_count, redundant_factory_count)
telemetry_submitter.synchronize_config()
return split_factory
async def _build_redis_factory_async(api_key, cfg):
"""Build and return a split factory with redis-based storage."""
sdk_metadata = util.get_metadata(cfg)
redis_adapter = await redis.build_async(cfg)
cache_enabled = cfg.get('redisLocalCacheEnabled', False)
cache_ttl = cfg.get('redisLocalCacheTTL', 5)
storages = {
'splits': RedisSplitStorageAsync(redis_adapter, cache_enabled, cache_ttl),
'segments': RedisSegmentStorageAsync(redis_adapter),
'rule_based_segments': RedisRuleBasedSegmentsStorageAsync(redis_adapter),
'impressions': RedisImpressionsStorageAsync(redis_adapter, sdk_metadata),
'events': RedisEventsStorageAsync(redis_adapter, sdk_metadata),
'telemetry': await RedisTelemetryStorageAsync.create(redis_adapter, sdk_metadata)
}
telemetry_producer = TelemetryStorageProducerAsync(storages['telemetry'])
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
telemetry_init_producer = telemetry_producer.get_telemetry_init_producer()
telemetry_submitter = RedisTelemetrySubmitterAsync(storages['telemetry'])
data_sampling = cfg.get('dataSampling', DEFAULT_DATA_SAMPLING)
if data_sampling < _MIN_DEFAULT_DATA_SAMPLING_ALLOWED:
_LOGGER.warning("dataSampling cannot be less than %.2f, defaulting to minimum",
_MIN_DEFAULT_DATA_SAMPLING_ALLOWED)
data_sampling = _MIN_DEFAULT_DATA_SAMPLING_ALLOWED
imp_counter = ImpressionsCounter()
unique_keys_tracker = UniqueKeysTrackerAsync(_UNIQUE_KEYS_CACHE_SIZE)
unique_keys_synchronizer, clear_filter_sync, unique_keys_task, \
clear_filter_task, impressions_count_sync, impressions_count_task, \
imp_strategy, none_strategy = set_classes_async('REDIS', cfg['impressionsMode'], redis_adapter, imp_counter, unique_keys_tracker)
imp_manager = ImpressionsManager(
imp_strategy, none_strategy,
telemetry_runtime_producer)
synchronizers = SplitSynchronizers(None, None, None, None,
impressions_count_sync,
None,
unique_keys_synchronizer,
clear_filter_sync
)
tasks = SplitTasks(None, None, None, None,
impressions_count_task,
None,
unique_keys_task,
clear_filter_task
)
synchronizer = RedisSynchronizerAsync(synchronizers, tasks)
recorder = PipelinedRecorderAsync(
redis_adapter.pipeline,
imp_manager,
storages['events'],
storages['impressions'],
storages['telemetry'],
data_sampling,
_wrap_impression_listener_async(cfg['impressionListener'], sdk_metadata),
imp_counter=imp_counter,
unique_keys_tracker=unique_keys_tracker
)
manager = RedisManagerAsync(synchronizer)
await telemetry_init_producer.record_config(cfg, {}, 0, 0)
manager.start()
internal_events_queue = asyncio.Queue()
events_manager = EventsManagerAsync(EventsManagerConfig(), EventsDelivery())
split_factory = SplitFactoryAsync(
api_key,
storages,
cfg['labelsEnabled'],
recorder,
internal_events_queue,
events_manager,
manager,
telemetry_producer=telemetry_producer,
telemetry_init_producer=telemetry_init_producer,
telemetry_submitter=telemetry_submitter,
fallback_treatment_calculator=FallbackTreatmentCalculator(cfg['fallbackTreatments'])
)
redundant_factory_count, active_factory_count = _get_active_and_redundant_count()
await storages['telemetry'].record_active_and_redundant_factories(active_factory_count, redundant_factory_count)
await telemetry_submitter.synchronize_config()
return split_factory
def _build_pluggable_factory(api_key, cfg):
"""Build and return a split factory with pluggable storage."""
sdk_metadata = util.get_metadata(cfg)
if not input_validator.validate_pluggable_adapter(cfg):
raise Exception("Pluggable Adapter validation failed, exiting")
pluggable_adapter = cfg.get('storageWrapper')
storage_prefix = cfg.get('storagePrefix')
storages = {
'splits': PluggableSplitStorage(pluggable_adapter, storage_prefix, []),
'segments': PluggableSegmentStorage(pluggable_adapter, storage_prefix),
'rule_based_segments': PluggableRuleBasedSegmentsStorage(pluggable_adapter, storage_prefix),
'impressions': PluggableImpressionsStorage(pluggable_adapter, sdk_metadata, storage_prefix),
'events': PluggableEventsStorage(pluggable_adapter, sdk_metadata, storage_prefix),
'telemetry': PluggableTelemetryStorage(pluggable_adapter, sdk_metadata, storage_prefix)
}
telemetry_producer = TelemetryStorageProducer(storages['telemetry'])
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
telemetry_init_producer = telemetry_producer.get_telemetry_init_producer()
# Using same class as redis
telemetry_submitter = RedisTelemetrySubmitter(storages['telemetry'])
imp_counter = ImpressionsCounter()
unique_keys_tracker = UniqueKeysTracker(_UNIQUE_KEYS_CACHE_SIZE)
unique_keys_synchronizer, clear_filter_sync, unique_keys_task, \
clear_filter_task, impressions_count_sync, impressions_count_task, \
imp_strategy, none_strategy = set_classes('PLUGGABLE', cfg['impressionsMode'], pluggable_adapter, imp_counter, unique_keys_tracker, storage_prefix)
imp_manager = ImpressionsManager(
imp_strategy, none_strategy,
telemetry_runtime_producer)
synchronizers = SplitSynchronizers(None, None, None, None,
impressions_count_sync,