-
Notifications
You must be signed in to change notification settings - Fork 13
Expand file tree
/
Copy pathinmemmory.py
More file actions
2210 lines (1780 loc) · 70.7 KB
/
inmemmory.py
File metadata and controls
2210 lines (1780 loc) · 70.7 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
"""In memory storage classes."""
import logging
import threading
import queue
from collections import Counter
from splitio.models.segments import Segment
from splitio.models.telemetry import HTTPErrors, HTTPLatencies, MethodExceptions, MethodLatencies, LastSynchronization, StreamingEvents, TelemetryConfig, TelemetryCounters, CounterConstants, \
HTTPErrorsAsync, HTTPLatenciesAsync, MethodExceptionsAsync, MethodLatenciesAsync, LastSynchronizationAsync, StreamingEventsAsync, TelemetryConfigAsync, TelemetryCountersAsync
from splitio.models.events import SdkInternalEvent
from splitio.events.events_metadata import EventsMetadata, SdkEventType
from splitio.models.notification import SdkInternalEventNotification
from splitio.storage import FlagSetsFilter, SplitStorage, SegmentStorage, ImpressionStorage, EventStorage, TelemetryStorage, RuleBasedSegmentsStorage
from splitio.optional.loaders import asyncio
MAX_SIZE_BYTES = 5 * 1024 * 1024
MAX_TAGS = 10
_LOGGER = logging.getLogger(__name__)
class FlagSets(object):
"""InMemory Flagsets storage."""
def __init__(self, flag_sets=[]):
"""Constructor."""
self.sets_feature_flag_map = {}
self._lock = threading.RLock()
for flag_set in flag_sets:
self.sets_feature_flag_map[flag_set] = set()
def flag_set_exist(self, flag_set):
"""
Check if a flagset exist in stored flagset
:param flag_set: set name
:type flag_set: str
:rtype: bool
"""
with self._lock:
return flag_set in self.sets_feature_flag_map.keys()
def get_flag_set(self, flag_set):
"""
fetch feature flags stored in a flag set
:param flag_set: set name
:type flag_set: str
:rtype: list(str)
"""
with self._lock:
return self.sets_feature_flag_map.get(flag_set)
def _add_flag_set(self, flag_set):
"""
Add new flag set to storage
:param flag_set: set name
:type flag_set: str
"""
with self._lock:
if not self.flag_set_exist(flag_set):
self.sets_feature_flag_map[flag_set] = set()
def _remove_flag_set(self, flag_set):
"""
Remove existing flag set from storage
:param flag_set: set name
:type flag_set: str
"""
with self._lock:
if self.flag_set_exist(flag_set):
del self.sets_feature_flag_map[flag_set]
def add_feature_flag_to_flag_set(self, flag_set, feature_flag):
"""
Add a feature flag to existing flag set
:param flag_set: set name
:type flag_set: str
:param feature_flag: feature flag name
:type feature_flag: str
"""
with self._lock:
if self.flag_set_exist(flag_set):
self.sets_feature_flag_map[flag_set].add(feature_flag)
def remove_feature_flag_to_flag_set(self, flag_set, feature_flag):
"""
Remove a feature flag from existing flag set
:param flag_set: set name
:type flag_set: str
:param feature_flag: feature flag name
:type feature_flag: str
"""
with self._lock:
if self.flag_set_exist(flag_set):
self.sets_feature_flag_map[flag_set].remove(feature_flag)
def update_flag_set(self, flag_sets, feature_flag_name, should_filter):
if flag_sets is not None:
for flag_set in flag_sets:
if not self.flag_set_exist(flag_set):
if should_filter:
continue
self._add_flag_set(flag_set)
self.add_feature_flag_to_flag_set(flag_set, feature_flag_name)
def remove_flag_set(self, flag_sets, feature_flag_name, should_filter):
if flag_sets is not None:
for flag_set in flag_sets:
self.remove_feature_flag_to_flag_set(flag_set, feature_flag_name)
if self.flag_set_exist(flag_set) and len(self.get_flag_set(flag_set)) == 0 and not should_filter:
self._remove_flag_set(flag_set)
class InMemoryRuleBasedSegmentStorage(RuleBasedSegmentsStorage):
"""InMemory implementation of a feature flag storage base."""
def __init__(self, internal_event_queue):
"""Constructor."""
self._lock = threading.RLock()
self._rule_based_segments = {}
self._change_number = -1
self._internal_event_queue = internal_event_queue
def clear(self):
"""
Clear storage
"""
with self._lock:
self._rule_based_segments = {}
self._change_number = -1
def get(self, segment_name):
"""
Retrieve a rule based segment.
:param segment_name: Name of the segment to fetch.
:type segment_name: str
:rtype: splitio.models.rule_based_segments.RuleBasedSegment
"""
with self._lock:
return self._rule_based_segments.get(segment_name)
def update(self, to_add, to_delete, new_change_number):
"""
Update rule based segment.
:param to_add: List of rule based segment. to add
:type to_add: list[splitio.models.rule_based_segments.RuleBasedSegment]
:param to_delete: List of rule based segment. to delete
:type to_delete: list[splitio.models.rule_based_segments.RuleBasedSegment]
:param new_change_number: New change number.
:type new_change_number: int
"""
[self._put(add_segment) for add_segment in to_add]
[self._remove(delete_segment) for delete_segment in to_delete]
self._set_change_number(new_change_number)
self._internal_event_queue.put(
SdkInternalEventNotification(
SdkInternalEvent.RB_SEGMENTS_UPDATED,
EventsMetadata(SdkEventType.SEGMENT_UPDATE, {})))
def _put(self, rule_based_segment):
"""
Store a rule based segment.
:param rule_based_segment: RuleBasedSegment object.
:type rule_based_segment: splitio.models.rule_based_segments.RuleBasedSegment
"""
with self._lock:
self._rule_based_segments[rule_based_segment.name] = rule_based_segment
def _remove(self, segment_name):
"""
Remove a rule based segment.
:param segment_name: Name of the rule based segment to remove.
:type segment_name: str
:return: True if the rule based segment was found and removed. False otherwise.
:rtype: bool
"""
with self._lock:
rule_based_segment = self._rule_based_segments.get(segment_name)
if not rule_based_segment:
_LOGGER.warning("Tried to delete nonexistant Rule based segment %s. Skipping", segment_name)
return False
self._rule_based_segments.pop(segment_name)
return True
def get_change_number(self):
"""
Retrieve latest rule based segment change number.
:rtype: int
"""
with self._lock:
return self._change_number
def _set_change_number(self, new_change_number):
"""
Set the latest change number.
:param new_change_number: New change number.
:type new_change_number: int
"""
with self._lock:
self._change_number = new_change_number
def get_segment_names(self):
"""
Retrieve a list of all rule based segments names.
:return: List of segment names.
:rtype: list(str)
"""
with self._lock:
return list(self._rule_based_segments.keys())
def get_large_segment_names(self):
"""
Retrieve a list of all excluded large segments names.
:return: List of segment names.
:rtype: list(str)
"""
pass
def contains(self, segment_names):
"""
Return whether the segment exists in storage
:param segment_names: rule based segment name
:type segment_names: str
:return: True if the segment exists. False otherwise.
:rtype: bool
"""
with self._lock:
return set(segment_names).issubset(self._rule_based_segments.keys())
def fetch_many(self, segment_names):
return {rb_segment_name: self.get(rb_segment_name) for rb_segment_name in segment_names}
class InMemoryRuleBasedSegmentStorageAsync(RuleBasedSegmentsStorage):
"""InMemory implementation of a feature flag storage base."""
def __init__(self):
"""Constructor."""
self._lock = asyncio.Lock()
self._rule_based_segments = {}
self._change_number = -1
async def clear(self):
"""
Clear storage
"""
async with self._lock:
self._rule_based_segments = {}
self._change_number = -1
async def get(self, segment_name):
"""
Retrieve a rule based segment.
:param segment_name: Name of the segment to fetch.
:type segment_name: str
:rtype: splitio.models.rule_based_segments.RuleBasedSegment
"""
async with self._lock:
return self._rule_based_segments.get(segment_name)
async def update(self, to_add, to_delete, new_change_number):
"""
Update rule based segment.
:param to_add: List of rule based segment. to add
:type to_add: list[splitio.models.rule_based_segments.RuleBasedSegment]
:param to_delete: List of rule based segment. to delete
:type to_delete: list[splitio.models.rule_based_segments.RuleBasedSegment]
:param new_change_number: New change number.
:type new_change_number: int
"""
[await self._put(add_segment) for add_segment in to_add]
[await self._remove(delete_segment) for delete_segment in to_delete]
await self._set_change_number(new_change_number)
async def _put(self, rule_based_segment):
"""
Store a rule based segment.
:param rule_based_segment: RuleBasedSegment object.
:type rule_based_segment: splitio.models.rule_based_segments.RuleBasedSegment
"""
async with self._lock:
self._rule_based_segments[rule_based_segment.name] = rule_based_segment
async def _remove(self, segment_name):
"""
Remove a rule based segment.
:param segment_name: Name of the rule based segment to remove.
:type segment_name: str
:return: True if the rule based segment was found and removed. False otherwise.
:rtype: bool
"""
async with self._lock:
rule_based_segment = self._rule_based_segments.get(segment_name)
if not rule_based_segment:
_LOGGER.warning("Tried to delete nonexistant Rule based segment %s. Skipping", segment_name)
return False
self._rule_based_segments.pop(segment_name)
return True
async def get_change_number(self):
"""
Retrieve latest rule based segment change number.
:rtype: int
"""
async with self._lock:
return self._change_number
async def _set_change_number(self, new_change_number):
"""
Set the latest change number.
:param new_change_number: New change number.
:type new_change_number: int
"""
async with self._lock:
self._change_number = new_change_number
async def get_segment_names(self):
"""
Retrieve a list of all excluded segments names.
:return: List of segment names.
:rtype: list(str)
"""
async with self._lock:
return list(self._rule_based_segments.keys())
async def get_large_segment_names(self):
"""
Retrieve a list of all excluded large segments names.
:return: List of segment names.
:rtype: list(str)
"""
pass
async def contains(self, segment_names):
"""
Return whether the segment exists in storage
:param segment_names: rule based segment name
:type segment_names: str
:return: True if the segment exists. False otherwise.
:rtype: bool
"""
async with self._lock:
return set(segment_names).issubset(self._rule_based_segments.keys())
async def fetch_many(self, segment_names):
return {rb_segment_name: await self.get(rb_segment_name) for rb_segment_name in segment_names}
class InMemorySplitStorageBase(SplitStorage):
"""InMemory implementation of a feature flag storage base."""
def get(self, feature_flag_name):
"""
Retrieve a feature flag.
:param feature_flag_name: Name of the feature to fetch.
:type feature_flag_name: str
:rtype: splitio.models.splits.Split
"""
pass
def fetch_many(self, feature_flag_names):
"""
Retrieve feature flags.
:param feature_flag_names: Names of the features to fetch.
:type feature_flag_name: list(str)
:return: A dict with feature flag objects parsed from queue.
:rtype: dict(feature_flag_name, splitio.models.splits.Split)
"""
pass
def update(self, to_add, to_delete, new_change_number):
"""
Update feature flag storage.
:param to_add: List of feature flags to add
:type to_add: list[splitio.models.splits.Split]
:param to_delete: List of feature flags to delete
:type to_delete: list[str]
:param new_change_number: New change number.
:type new_change_number: int
"""
pass
def get_change_number(self):
"""
Retrieve latest feature flag change number.
:rtype: int
"""
pass
def get_split_names(self):
"""
Retrieve a list of all feature flag names.
:return: List of feature flag names.
:rtype: list(str)
"""
pass
def get_all_splits(self):
"""
Return all the feature flags.
:return: List of all the feature flags.
:rtype: list
"""
pass
def get_splits_count(self):
"""
Return feature flags count.
:rtype: int
"""
pass
def is_valid_traffic_type(self, traffic_type_name):
"""
Return whether the traffic type exists in at least one feature flag in cache.
:param traffic_type_name: Traffic type to validate.
:type traffic_type_name: str
:return: True if the traffic type is valid. False otherwise.
:rtype: bool
"""
pass
def kill_locally(self, feature_flag_name, default_treatment, change_number):
"""
Local kill for feature flag
:param feature_flag_name: name of the feature flag to perform kill
:type feature_flag_name: str
:param default_treatment: name of the default treatment to return
:type default_treatment: str
:param change_number: change_number
:type change_number: int
"""
pass
def _increase_traffic_type_count(self, traffic_type_name):
"""
Increase by one the count for a specific traffic type name.
:param traffic_type_name: Traffic type to increase the count.
:type traffic_type_name: str
"""
self._traffic_types.update([traffic_type_name])
def _decrease_traffic_type_count(self, traffic_type_name):
"""
Decrease by one the count for a specific traffic type name.
:param traffic_type_name: Traffic type to decrease the count.
:type traffic_type_name: str
"""
self._traffic_types.subtract([traffic_type_name])
self._traffic_types += Counter()
class InMemorySplitStorage(InMemorySplitStorageBase):
"""InMemory implementation of a feature flag storage."""
def __init__(self, internal_event_queue, flag_sets=[]):
"""Constructor."""
self._lock = threading.RLock()
self._feature_flags = {}
self._change_number = -1
self._traffic_types = Counter()
self.flag_set = FlagSets(flag_sets)
self.flag_set_filter = FlagSetsFilter(flag_sets)
self._internal_event_queue = internal_event_queue
def clear(self):
"""
Clear storage
"""
with self._lock:
self._feature_flags = {}
self._change_number = -1
self._traffic_types = Counter()
self.flag_set = FlagSets(self.flag_set_filter.flag_sets)
def get(self, feature_flag_name):
"""
Retrieve a feature flag.
:param feature_flag_name: Name of the feature to fetch.
:type feature_flag_name: str
:rtype: splitio.models.splits.Split
"""
with self._lock:
return self._feature_flags.get(feature_flag_name)
def fetch_many(self, feature_flag_names):
"""
Retrieve feature flags.
:param feature_flag_names: Names of the features to fetch.
:type feature_flag_names: list(str)
:return: A dict with feature flag objects parsed from queue.
:rtype: dict(feature_flag_name, splitio.models.splits.Split)
"""
return {feature_flag_name: self.get(feature_flag_name) for feature_flag_name in feature_flag_names}
def update(self, to_add, to_delete, new_change_number):
"""
Update feature flag storage.
:param to_add: List of feature flags to add
:type to_add: list[splitio.models.splits.Split]
:param to_delete: List of feature flags to delete
:type to_delete: list[str]
:param new_change_number: New change number.
:type new_change_number: int
"""
[self._put(add_feature_flag) for add_feature_flag in to_add]
[self._remove(delete_feature_flag) for delete_feature_flag in to_delete]
self._set_change_number(new_change_number)
to_notify = []
[to_notify.append(feature.name) for feature in to_add]
to_notify.extend(to_delete)
self._internal_event_queue.put(
SdkInternalEventNotification(
SdkInternalEvent.FLAGS_UPDATED,
EventsMetadata(SdkEventType.FLAG_UPDATE, set(to_notify))))
def _put(self, feature_flag):
"""
Store a feature flag.
:param feature_flag: Split object.
:type feature_flag: splitio.models.split.Split
"""
with self._lock:
if feature_flag.name in self._feature_flags:
self._remove_from_flag_sets(self._feature_flags[feature_flag.name])
self._decrease_traffic_type_count(self._feature_flags[feature_flag.name].traffic_type_name)
self._feature_flags[feature_flag.name] = feature_flag
self._increase_traffic_type_count(feature_flag.traffic_type_name)
self.flag_set.update_flag_set(feature_flag.sets, feature_flag.name, self.flag_set_filter.should_filter)
def _remove(self, feature_flag_name):
"""
Remove a feature flag from storage.
:param feature_flag_name: Name of the feature to remove.
:type feature_flag_name: str
:return: True if the feature_flag was found and removed. False otherwise.
:rtype: bool
"""
with self._lock:
feature_flag = self._feature_flags.get(feature_flag_name)
if not feature_flag:
_LOGGER.warning("Tried to delete nonexistant feature flag %s. Skipping", feature_flag_name)
return False
self._feature_flags.pop(feature_flag_name)
self._decrease_traffic_type_count(feature_flag.traffic_type_name)
self._remove_from_flag_sets(feature_flag)
return True
def _remove_from_flag_sets(self, feature_flag):
"""
Remove flag sets associated to a feature flag
:param feature_flag: feature flag object
:type feature_flag: splitio.models.splits.Split
"""
self.flag_set.remove_flag_set(feature_flag.sets, feature_flag.name, self.flag_set_filter.should_filter)
def get_feature_flags_by_sets(self, sets):
"""
Get list of feature flag names associated to a set, if it does not exist will return empty list
:param set: flag set
:type set: str
:return: list of feature flag names
:rtype: list
"""
with self._lock:
sets_to_fetch = []
for flag_set in sets:
if not self.flag_set.flag_set_exist(flag_set):
_LOGGER.warning("Flag set %s is not part of the configured flag set list, ignoring it." % (flag_set))
continue
sets_to_fetch.append(flag_set)
to_return = set()
[to_return.update(self.flag_set.get_flag_set(flag_set)) for flag_set in sets_to_fetch]
return list(to_return)
def get_change_number(self):
"""
Retrieve latest feature flag change number.
:rtype: int
"""
with self._lock:
return self._change_number
def _set_change_number(self, new_change_number):
"""
Set the latest change number.
:param new_change_number: New change number.
:type new_change_number: int
"""
with self._lock:
self._change_number = new_change_number
def get_split_names(self):
"""
Retrieve a list of all feature flag names.
:return: List of feature flag names.
:rtype: list(str)
"""
with self._lock:
return list(self._feature_flags.keys())
def get_all_splits(self):
"""
Return all the feature flags.
:return: List of all the feature flags.
:rtype: list
"""
with self._lock:
return list(self._feature_flags.values())
def get_splits_count(self):
"""
Return feature flags count.
:rtype: int
"""
with self._lock:
return len(self._feature_flags)
def is_valid_traffic_type(self, traffic_type_name):
"""
Return whether the traffic type exists in at least one feature flag in cache.
:param traffic_type_name: Traffic type to validate.
:type traffic_type_name: str
:return: True if the traffic type is valid. False otherwise.
:rtype: bool
"""
with self._lock:
return traffic_type_name in self._traffic_types
def kill_locally(self, feature_flag_name, default_treatment, change_number):
"""
Local kill for feature flag
:param feature_flag_name: name of the feature flag to perform kill
:type feature_flag_name: str
:param default_treatment: name of the default treatment to return
:type default_treatment: str
:param change_number: change_number
:type change_number: int
"""
with self._lock:
if self.get_change_number() > change_number:
return
feature_flag = self._feature_flags.get(feature_flag_name)
if not feature_flag:
return
feature_flag.local_kill(default_treatment, change_number)
self._put(feature_flag)
self._internal_event_queue.put(
SdkInternalEventNotification(
SdkInternalEvent.FLAG_KILLED_NOTIFICATION,
EventsMetadata(SdkEventType.FLAG_UPDATE, {feature_flag_name})))
def is_flag_set_exist(self, flag_set):
"""
Return whether a flag set exists in at least one feature flag in cache.
:param flag_set: Flag set to validate.
:type flag_set: str
:return: True if the flag_set exist. False otherwise.
:rtype: bool
"""
return self.flag_set.flag_set_exist(flag_set)
class InMemorySplitStorageAsync(InMemorySplitStorageBase):
"""InMemory implementation of a feature flag async storage."""
def __init__(self, flag_sets=[]):
"""Constructor."""
self._lock = asyncio.Lock()
self._feature_flags = {}
self._change_number = -1
self._traffic_types = Counter()
self.flag_set = FlagSets(flag_sets)
self.flag_set_filter = FlagSetsFilter(flag_sets)
async def clear(self):
"""
Clear storage
"""
async with self._lock:
self._feature_flags = {}
self._change_number = -1
self._traffic_types = Counter()
self.flag_set = FlagSets(self.flag_set_filter.flag_sets)
async def get(self, feature_flag_name):
"""
Retrieve a feature flag.
:param feature_flag_name: Name of the feature to fetch.
:type feature_flag_name: str
:rtype: splitio.models.splits.Split
"""
async with self._lock:
return self._feature_flags.get(feature_flag_name)
async def fetch_many(self, feature_flag_names):
"""
Retrieve feature flags.
:param feature_flag_names: Names of the features to fetch.
:type feature_flag_name: list(str)
:return: A dict with feature flag objects parsed from queue.
:rtype: dict(feature_flag_name, splitio.models.splits.Split)
"""
return {feature_flag_name: await self.get(feature_flag_name) for feature_flag_name in feature_flag_names}
async def update(self, to_add, to_delete, new_change_number):
"""
Update feature flag storage.
:param to_add: List of feature flags to add
:type to_add: list[splitio.models.splits.Split]
:param to_delete: List of feature flags to delete
:type to_delete: list[str]
:param new_change_number: New change number.
:type new_change_number: int
"""
[await self._put(add_feature_flag) for add_feature_flag in to_add]
[await self._remove(delete_feature_flag) for delete_feature_flag in to_delete]
await self._set_change_number(new_change_number)
async def _put(self, feature_flag):
"""
Store a feature flag.
:param feature flag: Split object.
:type feature flag: splitio.models.split.Split
"""
async with self._lock:
if feature_flag.name in self._feature_flags:
await self._remove_from_flag_sets(self._feature_flags[feature_flag.name])
self._decrease_traffic_type_count(self._feature_flags[feature_flag.name].traffic_type_name)
self._feature_flags[feature_flag.name] = feature_flag
self._increase_traffic_type_count(feature_flag.traffic_type_name)
self.flag_set.update_flag_set(feature_flag.sets, feature_flag.name, self.flag_set_filter.should_filter)
async def _remove(self, feature_flag_name):
"""
Remove a feature flag from storage.
:param feature_flag_name: Name of the feature to remove.
:type feature_flag_name: str
:return: True if the feature flag was found and removed. False otherwise.
:rtype: bool
"""
async with self._lock:
feature_flag = self._feature_flags.get(feature_flag_name)
if not feature_flag:
_LOGGER.warning("Tried to delete nonexistant feature flag %s. Skipping", feature_flag_name)
return False
self._feature_flags.pop(feature_flag_name)
self._decrease_traffic_type_count(feature_flag.traffic_type_name)
await self._remove_from_flag_sets(feature_flag)
return True
async def _remove_from_flag_sets(self, feature_flag):
"""
Remove flag sets associated to a feature flag
:param feature_flag: feature flag object
:type feature_flag: splitio.models.splits.Split
"""
self.flag_set.remove_flag_set(feature_flag.sets, feature_flag.name, self.flag_set_filter.should_filter)
async def get_feature_flags_by_sets(self, sets):
"""
Get list of feature flag names associated to a set, if it does not exist will return empty list
:param set: flag set
:type set: str
:return: list of feature flag names
:rtype: list
"""
async with self._lock:
sets_to_fetch = []
for flag_set in sets:
if not self.flag_set.flag_set_exist(flag_set):
_LOGGER.warning("Flag set %s is not part of the configured flag set list, ignoring it." % (flag_set))
continue
sets_to_fetch.append(flag_set)
to_return = set()
[to_return.update(self.flag_set.get_flag_set(flag_set)) for flag_set in sets_to_fetch]
return list(to_return)
async def get_change_number(self):
"""
Retrieve latest feature flag change number.
:rtype: int
"""
async with self._lock:
return self._change_number
async def _set_change_number(self, new_change_number):
"""
Set the latest change number.
:param new_change_number: New change number.
:type new_change_number: int
"""
async with self._lock:
self._change_number = new_change_number
async def get_split_names(self):
"""
Retrieve a list of all feature flag names.
:return: List of feature flag names.
:rtype: list(str)
"""
async with self._lock:
return list(self._feature_flags.keys())
async def get_all_splits(self):
"""
Return all the feature flags.
:return: List of all the feature flags.
:rtype: list
"""
async with self._lock:
return list(self._feature_flags.values())
async def get_splits_count(self):
"""
Return feature flags count.
:rtype: int
"""
async with self._lock:
return len(self._feature_flags)
async def is_valid_traffic_type(self, traffic_type_name):
"""
Return whether the traffic type exists in at least one feature flag in cache.
:param traffic_type_name: Traffic type to validate.
:type traffic_type_name: str
:return: True if the traffic type is valid. False otherwise.
:rtype: bool
"""
async with self._lock:
return traffic_type_name in self._traffic_types
async def kill_locally(self, feature_flag_name, default_treatment, change_number):
"""
Local kill for feature flag
:param feature_flag_name: name of the feature flag to perform kill
:type feature_flag_name: str
:param default_treatment: name of the default treatment to return
:type default_treatment: str
:param change_number: change_number
:type change_number: int
"""
if await self.get_change_number() > change_number:
return
async with self._lock:
feature_flag = self._feature_flags.get(feature_flag_name)
if not feature_flag:
return
feature_flag.local_kill(default_treatment, change_number)
await self._put(feature_flag)
async def get_segment_names(self):
"""
Return a set of all segments referenced by feature flags in storage.
:return: Set of all segment names.
:rtype: set(string)
"""
return set([name for spl in await self.get_all_splits() for name in spl.get_segment_names()])
async def is_flag_set_exist(self, flag_set):
"""
Return whether a flag set exists in at least one feature flag in cache.
:param flag_set: Flag set to validate.
:type flag_set: str
:return: True if the flag_set exist. False otherwise.
:rtype: bool
"""
return self.flag_set.flag_set_exist(flag_set)
class InMemorySegmentStorage(SegmentStorage):
"""In-memory implementation of a segment storage."""
def __init__(self, internal_event_queue):
"""Constructor."""
self._segments = {}
self._change_numbers = {}
self._lock = threading.RLock()
self._internal_event_queue = internal_event_queue
def get(self, segment_name):
"""
Retrieve a segment.
:param segment_name: Name of the segment to fetch.
:type segment_name: str
:rtype: str
"""
with self._lock:
fetched = self._segments.get(segment_name)
if fetched is None:
_LOGGER.debug(
"Tried to retrieve nonexistant segment %s. Skipping",
segment_name
)
return fetched
def put(self, segment):
"""
Store a segment.
:param segment: Segment to store.
:type segment: splitio.models.segment.Segment
"""
with self._lock:
self._segments[segment.name] = segment
self._internal_event_queue.put(
SdkInternalEventNotification(
SdkInternalEvent.SEGMENTS_UPDATED,
EventsMetadata(SdkEventType.SEGMENT_UPDATE, {})))
def update(self, segment_name, to_add, to_remove, change_number=None):
"""
Update a segment. Create it if it doesn't exist.
:param segment_name: Name of the segment to update.
:type segment_name: str
:param to_add: Set of members to add to the segment.
:type to_add: set
:param to_remove: List of members to remove from the segment.
:type to_remove: Set
"""
with self._lock:
if segment_name not in self._segments:
self._segments[segment_name] = Segment(segment_name, to_add, change_number)
return
self._segments[segment_name].update(to_add, to_remove)
if change_number is not None:
self._segments[segment_name].change_number = change_number