-
Notifications
You must be signed in to change notification settings - Fork 13
Expand file tree
/
Copy pathredis.py
More file actions
1773 lines (1450 loc) · 62.6 KB
/
Copy pathredis.py
File metadata and controls
1773 lines (1450 loc) · 62.6 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
"""Redis storage module."""
import json
import logging
import threading
from splitio.models.impressions import Impression
from splitio.models import splits, segments, rule_based_segments
from splitio.models.telemetry import TelemetryConfig, TelemetryConfigAsync
from splitio.storage import SplitStorage, SegmentStorage, ImpressionStorage, EventStorage, \
ImpressionPipelinedStorage, TelemetryStorage, FlagSetsFilter, RuleBasedSegmentsStorage
from splitio.storage.adapters.redis import RedisAdapterException
from splitio.storage.adapters.cache_trait import decorate as add_cache, DEFAULT_MAX_AGE
from splitio.storage.adapters.cache_trait import LocalMemoryCache, LocalMemoryCacheAsync
from splitio.util.storage_helper import get_valid_flag_sets, combine_valid_flag_sets
_LOGGER = logging.getLogger(__name__)
MAX_TAGS = 10
class RedisRuleBasedSegmentsStorage(RuleBasedSegmentsStorage):
"""Redis-based storage for rule based segments."""
_RB_SEGMENT_KEY = 'SPLITIO.rbsegment.{segment_name}'
_RB_SEGMENT_TILL_KEY = 'SPLITIO.rbsegments.till'
def __init__(self, redis_client):
"""
Class constructor.
:param redis_client: Redis client or compliant interface.
:type redis_client: splitio.storage.adapters.redis.RedisAdapter
"""
self._redis = redis_client
self._pipe = self._redis.pipeline
def _get_key(self, segment_name):
"""
Use the provided feature_flag_name to build the appropriate redis key.
:param feature_flag_name: Name of the feature flag to interact with in redis.
:type feature_flag_name: str
:return: Redis key.
:rtype: str.
"""
return self._RB_SEGMENT_KEY.format(segment_name=segment_name)
def get(self, segment_name):
"""
Retrieve a rule based segment.
:param segment_name: Name of the segment to fetch.
:type segment_name: str
:rtype: str
"""
try:
raw = self._redis.get(self._get_key(segment_name))
_LOGGER.debug("Fetchting rule based segment [%s] from redis" % segment_name)
_LOGGER.debug(raw)
return rule_based_segments.from_raw(json.loads(raw)) if raw is not None else None
except RedisAdapterException:
_LOGGER.error('Error fetching rule based segment from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
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
"""
raise NotImplementedError('Only redis-consumer mode is supported.')
def get_change_number(self):
"""
Retrieve latest rule based segment change number.
:rtype: int
"""
try:
stored_value = self._redis.get(self._RB_SEGMENT_TILL_KEY)
_LOGGER.debug("Fetching rule based segment Change Number from redis: %s" % stored_value)
return json.loads(stored_value) if stored_value is not None else None
except RedisAdapterException:
_LOGGER.error('Error fetching rule based segment change number from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
def contains(self, segment_names):
"""
Return whether the segments exists in rule based segment in cache.
:param segment_names: segment name to validate.
:type segment_names: str
:return: True if segment names exists. False otherwise.
:rtype: bool
"""
return set(segment_names).issubset(self.get_segment_names())
def get_segment_names(self):
"""
Retrieve a list of all rule based segments names.
:return: List of segment names.
:rtype: list(str)
"""
try:
keys = self._redis.keys(self._get_key('*'))
_LOGGER.debug("Fetchting rule based segments names from redis: %s" % keys)
return [key.replace(self._get_key(''), '') for key in keys]
except RedisAdapterException:
_LOGGER.error('Error fetching rule based segments names from storage')
_LOGGER.debug('Error: ', exc_info=True)
return []
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 fetch_many(self, segment_names):
"""
Retrieve rule based segment.
:param segment_names: Names of the rule based segments to fetch.
:type segment_names: list(str)
:return: A dict with rule based segment objects parsed from redis.
:rtype: dict(segment_name, splitio.models.rule_based_segment.RuleBasedSegment)
"""
to_return = dict()
if len(segment_names) == 0:
return to_return
try:
keys = [self._get_key(segment_name) for segment_name in segment_names]
raw_rbs_segments = self._redis.mget(keys)
_LOGGER.debug("Fetchting rule based segment [%s] from redis" % segment_names)
_LOGGER.debug(raw_rbs_segments)
for i in range(len(raw_rbs_segments)):
rbs_segment = None
try:
rbs_segment = rule_based_segments.from_raw(json.loads(raw_rbs_segments[i]))
except (ValueError, TypeError):
_LOGGER.error('Could not parse rule based segment.')
_LOGGER.debug("Raw rule based segment that failed parsing attempt: %s", raw_rbs_segments[i])
to_return[segment_names[i]] = rbs_segment
except RedisAdapterException:
_LOGGER.error('Error fetching rule based segments from storage')
_LOGGER.debug('Error: ', exc_info=True)
return to_return
class RedisRuleBasedSegmentsStorageAsync(RuleBasedSegmentsStorage):
"""Redis-based storage for rule based segments."""
_RB_SEGMENT_KEY = 'SPLITIO.rbsegment.{segment_name}'
_RB_SEGMENT_TILL_KEY = 'SPLITIO.rbsegments.till'
def __init__(self, redis_client):
"""
Class constructor.
:param redis_client: Redis client or compliant interface.
:type redis_client: splitio.storage.adapters.redis.RedisAdapter
"""
self._redis = redis_client
self._pipe = self._redis.pipeline
def _get_key(self, segment_name):
"""
Use the provided feature_flag_name to build the appropriate redis key.
:param feature_flag_name: Name of the feature flag to interact with in redis.
:type feature_flag_name: str
:return: Redis key.
:rtype: str.
"""
return self._RB_SEGMENT_KEY.format(segment_name=segment_name)
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: str
"""
try:
raw = await self._redis.get(self._get_key(segment_name))
_LOGGER.debug("Fetchting rule based segment [%s] from redis" % segment_name)
_LOGGER.debug(raw)
return rule_based_segments.from_raw(json.loads(raw)) if raw is not None else None
except RedisAdapterException:
_LOGGER.error('Error fetching rule based segment from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
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
"""
raise NotImplementedError('Only redis-consumer mode is supported.')
async def get_change_number(self):
"""
Retrieve latest rule based segment change number.
:rtype: int
"""
try:
stored_value = await self._redis.get(self._RB_SEGMENT_TILL_KEY)
_LOGGER.debug("Fetching rule based segment Change Number from redis: %s" % stored_value)
return json.loads(stored_value) if stored_value is not None else None
except RedisAdapterException:
_LOGGER.error('Error fetching rule based segment change number from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
async def contains(self, segment_names):
"""
Return whether the segments exists in rule based segment in cache.
:param segment_names: segment name to validate.
:type segment_names: str
:return: True if segment names exists. False otherwise.
:rtype: bool
"""
return set(segment_names).issubset(await self.get_segment_names())
async def get_segment_names(self):
"""
Retrieve a list of all rule based segments names.
:return: List of segment names.
:rtype: list(str)
"""
try:
keys = await self._redis.keys(self._get_key('*'))
_LOGGER.debug("Fetchting rule based segments names from redis: %s" % keys)
return [key.replace(self._get_key(''), '') for key in keys]
except RedisAdapterException:
_LOGGER.error('Error fetching rule based segments names from storage')
_LOGGER.debug('Error: ', exc_info=True)
return []
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 fetch_many(self, segment_names):
"""
Retrieve rule based segment.
:param segment_names: Names of the rule based segments to fetch.
:type segment_names: list(str)
:return: A dict with rule based segment objects parsed from redis.
:rtype: dict(segment_name, splitio.models.rule_based_segment.RuleBasedSegment)
"""
to_return = dict()
if len(segment_names) == 0:
return to_return
try:
keys = [self._get_key(segment_name) for segment_name in segment_names]
raw_rbs_segments = await self._redis.mget(keys)
_LOGGER.debug("Fetchting rule based segment [%s] from redis" % segment_names)
_LOGGER.debug(raw_rbs_segments)
for i in range(len(raw_rbs_segments)):
rbs_segment = None
try:
rbs_segment = rule_based_segments.from_raw(json.loads(raw_rbs_segments[i]))
except (ValueError, TypeError):
_LOGGER.error('Could not parse rule based segment.')
_LOGGER.debug("Raw rule based segment that failed parsing attempt: %s", raw_rbs_segments[i])
to_return[segment_names[i]] = rbs_segment
except RedisAdapterException:
_LOGGER.error('Error fetching rule based segments from storage')
_LOGGER.debug('Error: ', exc_info=True)
return to_return
class RedisSplitStorageBase(SplitStorage):
"""Redis-based storage base for feature flags."""
_FEATURE_FLAG_KEY = 'SPLITIO.split.{feature_flag_name}'
_FEATURE_FLAG_TILL_KEY = 'SPLITIO.splits.till'
_TRAFFIC_TYPE_KEY = 'SPLITIO.trafficType.{traffic_type_name}'
_FLAG_SET_KEY = 'SPLITIO.flagSet.{flag_set}'
def _get_key(self, feature_flag_name):
"""
Use the provided feature_flag_name to build the appropriate redis key.
:param feature_flag_name: Name of the feature flag to interact with in redis.
:type feature_flag_name: str
:return: Redis key.
:rtype: str.
"""
return self._FEATURE_FLAG_KEY.format(feature_flag_name=feature_flag_name)
def _get_traffic_type_key(self, traffic_type_name):
"""
Use the provided traffic type name to build the appropriate redis key.
:param traffic_type: Name of the traffic type to interact with in redis.
:type traffic_type_name: str
:return: Redis key.
:rtype: str.
"""
return self._TRAFFIC_TYPE_KEY.format(traffic_type_name=traffic_type_name)
def _get_flag_set_key(self, flag_set):
"""
Use the provided flag set to build the appropriate redis key.
:param flag_set: Name of the flag set to interact with in redis.
:type flag_set: str
:return: Redis key.
:rtype: str.
"""
return self._FLAG_SET_KEY.format(flag_set=flag_set)
def get(self, feature_flag_name): # pylint: disable=method-hidden
"""
Retrieve a feature flag.
:param feature_flag_name: Name of the feature to fetch.
:type feature_flag_name: str
:return: A feature flag object parsed from redis if the key exists. None otherwise
: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 redis.
:rtype: dict(feature_flag_name, splitio.models.splits.Split)
"""
pass
def is_valid_traffic_type(self, traffic_type_name): # pylint: disable=method-hidden
"""
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 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[splitio.models.splits.Split]
:param new_change_number: New change number.
:type new_change_number: int
"""
raise NotImplementedError('Only redis-consumer mode is supported.')
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_splits_count(self):
"""
Return feature flags count.
:rtype: int
"""
return 0
def get_all_splits(self):
"""
Return all the feature flags in cache.
:return: List of all feature flags in cache.
:rtype: list(splitio.models.splits.Split)
"""
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
"""
raise NotImplementedError('Not supported for redis.')
class RedisSplitStorage(RedisSplitStorageBase):
"""Redis-based storage for feature flags."""
def __init__(self, redis_client, enable_caching=False, max_age=DEFAULT_MAX_AGE, config_flag_sets=[]):
"""
Class constructor.
:param redis_client: Redis client or compliant interface.
:type redis_client: splitio.storage.adapters.redis.RedisAdapter
"""
self._redis = redis_client
self.flag_set_filter = FlagSetsFilter(config_flag_sets)
self._pipe = self._redis.pipeline
if enable_caching:
self.get = add_cache(lambda *p, **_: p[0], max_age)(self.get)
self.is_valid_traffic_type = add_cache(lambda *p, **_: p[0], max_age)(self.is_valid_traffic_type) # pylint: disable=line-too-long
self.fetch_many = add_cache(lambda *p, **_: frozenset(p[0]), max_age)(self.fetch_many)
def get(self, feature_flag_name): # pylint: disable=method-hidden
"""
Retrieve a feature flag.
:param feature_flag_name: Name of the feature to fetch.
:type feature_flag_name: str
:return: A feature flag object parsed from redis if the key exists. None otherwise
:rtype: splitio.models.splits.Split
"""
try:
raw = self._redis.get(self._get_key(feature_flag_name))
_LOGGER.debug("Fetchting feature flag [%s] from redis" % feature_flag_name)
_LOGGER.debug(raw)
return splits.from_raw(json.loads(raw)) if raw is not None else None
except RedisAdapterException:
_LOGGER.error('Error fetching feature flag from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
def get_feature_flags_by_sets(self, flag_sets):
"""
Retrieve feature flags by flag set.
:param flag_set: Names of the flag set to fetch.
:type flag_set: str
:return: Feature flag names that are tagged with the flag set
:rtype: listt(str)
"""
try:
sets_to_fetch = get_valid_flag_sets(flag_sets, self.flag_set_filter)
if sets_to_fetch == []:
return []
keys = [self._get_flag_set_key(flag_set) for flag_set in sets_to_fetch]
pipe = self._pipe()
for key in keys:
pipe.smembers(key)
result_sets = pipe.execute()
_LOGGER.debug("Fetchting Feature flags by set [%s] from redis" % (keys))
_LOGGER.debug(result_sets)
return list(combine_valid_flag_sets(result_sets))
except RedisAdapterException:
_LOGGER.error('Error fetching feature flag from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
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 redis.
:rtype: dict(feature_flag_name, splitio.models.splits.Split)
"""
to_return = dict()
try:
keys = [self._get_key(feature_flag_name) for feature_flag_name in feature_flag_names]
raw_feature_flags = self._redis.mget(keys)
_LOGGER.debug("Fetchting feature flags [%s] from redis" % feature_flag_names)
_LOGGER.debug(raw_feature_flags)
for i in range(len(feature_flag_names)):
feature_flag = None
try:
feature_flag = splits.from_raw(json.loads(raw_feature_flags[i]))
except (ValueError, TypeError):
_LOGGER.error('Could not parse feature flag.')
_LOGGER.debug("Raw feature flag that failed parsing attempt: %s", raw_feature_flags[i])
to_return[feature_flag_names[i]] = feature_flag
except RedisAdapterException:
_LOGGER.error('Error fetching feature flags from storage')
_LOGGER.debug('Error: ', exc_info=True)
return to_return
def is_valid_traffic_type(self, traffic_type_name): # pylint: disable=method-hidden
"""
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
"""
try:
raw = self._redis.get(self._get_traffic_type_key(traffic_type_name))
count = json.loads(raw) if raw else 0
_LOGGER.debug("Fetching TrafficType [%s] count in redis: %s" % (traffic_type_name, count))
return count > 0
except RedisAdapterException:
_LOGGER.error('Error fetching feature flag from storage')
_LOGGER.debug('Error: ', exc_info=True)
return False
def get_change_number(self):
"""
Retrieve latest feature flag change number.
:rtype: int
"""
try:
stored_value = self._redis.get(self._FEATURE_FLAG_TILL_KEY)
_LOGGER.debug("Fetching feature flag Change Number from redis: %s" % stored_value)
return json.loads(stored_value) if stored_value is not None else None
except RedisAdapterException:
_LOGGER.error('Error fetching feature flag change number from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
def get_split_names(self):
"""
Retrieve a list of all feature flag names.
:return: List of feature flag names.
:rtype: list(str)
"""
try:
keys = self._redis.keys(self._get_key('*'))
_LOGGER.debug("Fetchting feature flag names from redis: %s" % keys)
return [key.replace(self._get_key(''), '') for key in keys]
except RedisAdapterException:
_LOGGER.error('Error fetching feature flag names from storage')
_LOGGER.debug('Error: ', exc_info=True)
return []
def get_all_splits(self):
"""
Return all the feature flags in cache.
:return: List of all feature flags in cache.
:rtype: list(splitio.models.splits.Split)
"""
keys = self._redis.keys(self._get_key('*'))
to_return = []
try:
_LOGGER.debug("Fetchting all feature flags from redis: %s" % keys)
raw_feature_flags = self._redis.mget(keys)
_LOGGER.debug(raw_feature_flags)
for raw in raw_feature_flags:
try:
to_return.append(splits.from_raw(json.loads(raw)))
except (ValueError, TypeError):
_LOGGER.error('Could not parse feature flag. Skipping')
_LOGGER.debug("Raw feature flag that failed parsing attempt: %s", raw)
except RedisAdapterException:
_LOGGER.error('Error fetching all feature flags from storage')
_LOGGER.debug('Error: ', exc_info=True)
return to_return
class RedisSplitStorageAsync(RedisSplitStorage):
"""Async Redis-based storage for feature flags."""
def __init__(self, redis_client, enable_caching=False, max_age=DEFAULT_MAX_AGE, config_flag_sets=[]):
"""
Class constructor.
"""
self.redis = redis_client
self._enable_caching = enable_caching
self.flag_set_filter = FlagSetsFilter(config_flag_sets)
self._pipe = self.redis.pipeline
if enable_caching:
self._feature_flag_cache = LocalMemoryCacheAsync(None, None, max_age)
self._traffic_type_cache = LocalMemoryCacheAsync(None, None, max_age)
async def get(self, feature_flag_name): # pylint: disable=method-hidden
"""
Retrieve a feature flag.
:param feature_flag_name: Name of the feature to fetch.
:type feature_flag_name: str
:param default_treatment: name of the default treatment to return
:type default_treatment: str
return: A feature flag object parsed from redis if the key exists. None otherwise
:param change_number: change_number
:rtype: splitio.models.splits.Split
:type change_number: int
"""
try:
raw_feature_flags = None
if self._enable_caching:
raw_feature_flags = await self._feature_flag_cache.get_key(feature_flag_name)
if raw_feature_flags is None:
raw_feature_flags = await self.redis.get(self._get_key(feature_flag_name))
if self._enable_caching:
await self._feature_flag_cache.add_key(feature_flag_name, raw_feature_flags)
_LOGGER.debug("Fetchting feature flag [%s] from redis" % feature_flag_name)
_LOGGER.debug(raw_feature_flags)
return splits.from_raw(json.loads(raw_feature_flags)) if raw_feature_flags is not None else None
except RedisAdapterException:
_LOGGER.error('Error fetching feature flag from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
async def get_feature_flags_by_sets(self, flag_sets):
"""
Retrieve feature flags by flag set.
:param flag_set: Names of the flag set to fetch.
:type flag_set: str
:return: Feature flag names that are tagged with the flag set
:rtype: listt(str)
"""
try:
sets_to_fetch = get_valid_flag_sets(flag_sets, self.flag_set_filter)
if sets_to_fetch == []:
return []
keys = [self._get_flag_set_key(flag_set) for flag_set in sets_to_fetch]
pipe = self._pipe()
[pipe.smembers(key) for key in keys]
result_sets = await pipe.execute()
_LOGGER.debug("Fetchting Feature flags by set [%s] from redis" % (keys))
_LOGGER.debug(result_sets)
return list(combine_valid_flag_sets(result_sets))
except RedisAdapterException:
_LOGGER.error('Error fetching feature flag from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
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 redis.
:rtype: dict(feature_flag_name, splitio.models.splits.Split)
"""
to_return = dict()
try:
raw_feature_flags = None
if self._enable_caching:
raw_feature_flags = await self._feature_flag_cache.get_key(frozenset(feature_flag_names))
if raw_feature_flags is None:
raw_feature_flags = await self.redis.mget([self._get_key(feature_flag_name) for feature_flag_name in feature_flag_names])
if self._enable_caching:
await self._feature_flag_cache.add_key(frozenset(feature_flag_names), raw_feature_flags)
for i in range(len(feature_flag_names)):
feature_flag = None
try:
feature_flag = splits.from_raw(json.loads(raw_feature_flags[i]))
except (ValueError, TypeError):
_LOGGER.error('Could not parse feature flag.')
_LOGGER.debug("Raw feature flag that failed parsing attempt: %s", raw_feature_flags[i])
to_return[feature_flag_names[i]] = feature_flag
except RedisAdapterException:
_LOGGER.error('Error fetching feature flags from storage')
_LOGGER.debug('Error: ', exc_info=True)
return to_return
async def is_valid_traffic_type(self, traffic_type_name): # pylint: disable=method-hidden
"""
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
"""
try:
raw_traffic_type = None
if self._enable_caching:
raw_traffic_type = await self._traffic_type_cache.get_key(traffic_type_name)
if raw_traffic_type is None:
raw_traffic_type = await self.redis.get(self._get_traffic_type_key(traffic_type_name))
if self._enable_caching:
await self._traffic_type_cache.add_key(traffic_type_name, raw_traffic_type)
count = json.loads(raw_traffic_type) if raw_traffic_type else 0
return count > 0
except RedisAdapterException:
_LOGGER.error('Error fetching traffic type from storage')
_LOGGER.debug('Error: ', exc_info=True)
return False
async def get_change_number(self):
"""
Retrieve latest feature flag change number.
:rtype: int
"""
try:
stored_value = await self.redis.get(self._FEATURE_FLAG_TILL_KEY)
return json.loads(stored_value) if stored_value is not None else None
except RedisAdapterException:
_LOGGER.error('Error fetching feature flag change number from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
async def get_split_names(self):
"""
Retrieve a list of all feature flag names.
:return: List of feature flag names.
:rtype: list(str)
"""
try:
keys = await self.redis.keys(self._get_key('*'))
return [key.replace(self._get_key(''), '') for key in keys]
except RedisAdapterException:
_LOGGER.error('Error fetching feature flag names from storage')
_LOGGER.debug('Error: ', exc_info=True)
return []
async def get_all_splits(self):
"""
Return all the feature flags in cache.
:return: List of all feature flags in cache.
:rtype: list(splitio.models.splits.Split)
"""
keys = await self.redis.keys(self._get_key('*'))
to_return = []
try:
raw_feature_flags = await self.redis.mget(keys)
for raw in raw_feature_flags:
try:
to_return.append(splits.from_raw(json.loads(raw)))
except (ValueError, TypeError):
_LOGGER.error('Could not parse feature flag. Skipping')
_LOGGER.debug("Raw feature flag that failed parsing attempt: %s", raw)
except RedisAdapterException:
_LOGGER.error('Error fetching all feature flags from storage')
_LOGGER.debug('Error: ', exc_info=True)
return to_return
class RedisSegmentStorageBase(SegmentStorage):
"""Redis based segment storage base class."""
_SEGMENTS_KEY = 'SPLITIO.segment.{segment_name}'
_SEGMENTS_TILL_KEY = 'SPLITIO.segment.{segment_name}.till'
def _get_till_key(self, segment_name):
"""
Use the provided segment_name to build the appropriate redis key.
:param segment_name: Name of the segment to interact with in redis.
:type segment_name: str
:return: Redis key.
:rtype: str.
"""
return self._SEGMENTS_TILL_KEY.format(segment_name=segment_name)
def _get_key(self, segment_name):
"""
Use the provided segment_name to build the appropriate redis key.
:param segment_name: Name of the segment to interact with in redis.
:type segment_name: str
:return: Redis key.
:rtype: str.
"""
return self._SEGMENTS_KEY.format(segment_name=segment_name)
def get(self, segment_name):
"""Retrieve a segment."""
pass
def update(self, segment_name, to_add, to_remove, change_number=None):
"""
Store a segment.
:param segment_name: Name of the segment to update.
:type segment_name: str
:param to_add: List of members to add to the segment.
:type to_add: list
:param to_remove: List of members to remove from the segment.
:type to_remove: list
"""
raise NotImplementedError('Only redis-consumer mode is supported.')
def get_change_number(self, segment_name):
"""
Retrieve latest change number for a segment.
:param segment_name: Name of the segment.
:type segment_name: str
:rtype: int
"""
pass
def set_change_number(self, segment_name, new_change_number):
"""
Set the latest change number.
:param segment_name: Name of the segment.
:type segment_name: str
:param new_change_number: New change number.
:type new_change_number: int
"""
raise NotImplementedError('Only redis-consumer mode is supported.')
def put(self, segment):
"""
Store a segment.
:param segment: Segment to store.
:type segment: splitio.models.segment.Segment
"""
raise NotImplementedError('Only redis-consumer mode is supported.')
def segment_contains(self, segment_name, key):
"""
Check whether a specific key belongs to a segment in storage.
:param segment_name: Name of the segment to search in.
:type segment_name: str
:param key: Key to search for.
:type key: str
:return: True if the segment contains the key. False otherwise.
:rtype: bool
"""
try:
res = self._redis.sismember(self._get_key(segment_name), key)
_LOGGER.debug("Checking Segment [%s] contain key [%s] in redis: %s" % (segment_name, key, res))
return bool(res)
except RedisAdapterException:
_LOGGER.error('Error testing members in segment stored in redis')
_LOGGER.debug('Error: ', exc_info=True)
return False
def get_segments_count(self):
"""
Return segment count.
:return: 0
:rtype: int
"""
return 0
def get_segments_keys_count(self):
"""
Return segment count.
:rtype: int
"""
return 0
class RedisSegmentStorage(RedisSegmentStorageBase):
"""Redis based segment storage class."""
def __init__(self, redis_client):
"""
Class constructor.
:param redis_client: Redis client or compliant interface.
:type redis_client: splitio.storage.adapters.redis.RedisAdapter
"""
self._redis = redis_client
def get(self, segment_name):
"""
Retrieve a segment.
:param segment_name: Name of the segment to fetch.
:type segment_name: str
:return: Segment object is key exists. None otherwise.
:rtype: splitio.models.segments.Segment
"""
try:
keys = (self._redis.smembers(self._get_key(segment_name)))
_LOGGER.debug("Fetchting Segment [%s] from redis" % segment_name)
_LOGGER.debug(keys)
till = self.get_change_number(segment_name)
if not keys or till is None:
return None
return segments.Segment(segment_name, keys, till)
except RedisAdapterException:
_LOGGER.error('Error fetching segment from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
def get_change_number(self, segment_name):
"""
Retrieve latest change number for a segment.
:param segment_name: Name of the segment.
:type segment_name: str
:rtype: int
"""
try:
stored_value = self._redis.get(self._get_till_key(segment_name))
_LOGGER.debug("Fetchting Change Number for Segment [%s] from redis: " % stored_value)
return json.loads(stored_value) if stored_value is not None else None
except RedisAdapterException:
_LOGGER.error('Error fetching segment change number from storage')
_LOGGER.debug('Error: ', exc_info=True)
return None
def segment_contains(self, segment_name, key):
"""
Check whether a specific key belongs to a segment in storage.
:param segment_name: Name of the segment to search in.
:type segment_name: str
:param key: Key to search for.
:type key: str
:return: True if the segment contains the key. False otherwise.
:rtype: bool
"""
try:
res = self._redis.sismember(self._get_key(segment_name), key)
_LOGGER.debug("Checking Segment [%s] contain key [%s] in redis: %s" % (segment_name, key, res))
return res
except RedisAdapterException:
_LOGGER.error('Error testing members in segment stored in redis')
_LOGGER.debug('Error: ', exc_info=True)
return None
class RedisSegmentStorageAsync(RedisSegmentStorageBase):
"""Redis based segment storage async class."""
def __init__(self, redis_client):