config descriptor

configcatclient/config.py

@@ -1,5 +1,185 @@
-from configcatclient.constants import PREFERENCES, SALT, SEGMENTS, FEATURE_FLAGS, TARGETING_RULES, CONDITIONS, \
-    SEGMENT_CONDITION, SEGMENT_INDEX, INLINE_SALT, INLINE_SEGMENT
+from enum import IntEnum
+
+CONFIG_FILE_NAME = 'config_v6'
+SERIALIZATION_FORMAT_VERSION = 'v2'
+
+# Config
+PREFERENCES = 'p'
+SEGMENTS = 's'
+FEATURE_FLAGS = 'f'
+
+# Preferences
+BASE_URL = 'u'
+REDIRECT = 'r'
+SALT = 's'
+
+# Segment
+SEGMENT_NAME = 'n'  # The first 4 characters of the Segment's name
+SEGMENT_CONDITIONS = 'r'  # The list of segment rule conditions (has a logical AND relation between the items).
+
+# Segment Condition (User Condition)
+COMPARISON_ATTRIBUTE = 'a'  # The attribute of the user object that should be used to evaluate this rule
+COMPARATOR = 'c'
+
+# Feature flag (Evaluation Formula)
+SETTING_TYPE = 't'  # 0 = bool, 1 = string, 2 = int, 3 = double
+PERCENTAGE_RULE_ATTRIBUTE = 'a'  # Percentage rule evaluation hashes this attribute of the User object to calculate the buckets
+TARGETING_RULES = 'r'  # Targeting Rules (Logically connected by OR)
+PERCENTAGE_OPTIONS = 'p'  # Percentage Options without conditions
+VALUE = 'v'
+VARIATION_ID = 'i'
+INLINE_SALT = 'inline_salt'
+
+# Targeting Rule (Evaluation Rule)
+CONDITIONS = 'c'
+SERVED_VALUE = 's'  # Value and Variation ID
+TARGETING_RULE_PERCENTAGE_OPTIONS = 'p'
+
+# Condition
+USER_CONDITION = 't'
+SEGMENT_CONDITION = 's'  # Segment targeting rule
+PREREQUISITE_FLAG_CONDITION = 'd'  # Prerequisite flag targeting rule
+
+# Segment Condition
+SEGMENT_INDEX = 's'
+SEGMENT_COMPARATOR = 'c'
+INLINE_SEGMENT = 'inline_segment'
+
+# Prerequisite Flag Condition
+PREREQUISITE_FLAG_KEY = 'f'
+PREREQUISITE_COMPARATOR = 'c'
+
+# Percentage Option
+PERCENTAGE = 'p'
+
+# Value
+BOOL_VALUE = 'b'
+STRING_VALUE = 's'
+INT_VALUE = 'i'
+DOUBLE_VALUE = 'd'
+STRING_LIST_VALUE = 'l'
+
+
+def get_value(dictionary):
+    value = dictionary.get(VALUE)
+    if value is None:
+        raise ValueError('Value is missing.')
+
+    if value.get(BOOL_VALUE) is not None:
+        return value.get(BOOL_VALUE)
+    if value.get(STRING_VALUE) is not None:
+        return value.get(STRING_VALUE)
+    if value.get(INT_VALUE) is not None:
+        return value.get(INT_VALUE)
+    if value.get(DOUBLE_VALUE) is not None:
+        return value.get(DOUBLE_VALUE)
+
+    raise ValueError('Unknown value type.')
+
+
+class PrerequisiteComparator(IntEnum):
+    EQUALS = 0
+    NOT_EQUALS = 1
+
+
+class SegmentComparator(IntEnum):
+    IS_IN = 0
+    IS_NOT_IN = 1
+
+
+class Comparator(IntEnum):
+    IS_ONE_OF = 0
+    IS_NOT_ONE_OF = 1
+    CONTAINS_ANY_OF = 2
+    NOT_CONTAINS_ANY_OF = 3
+    IS_ONE_OF_SEMVER = 4
+    IS_NOT_ONE_OF_SEMVER = 5
+    LESS_THAN_SEMVER = 6
+    LESS_THAN_OR_EQUAL_SEMVER = 7
+    GREATER_THAN_SEMVER = 8
+    GREATER_THAN_OR_EQUAL_SEMVER = 9
+    EQUALS_NUMBER = 10
+    NOT_EQUALS_NUMBER = 11
+    LESS_THAN_NUMBER = 12
+    LESS_THAN_OR_EQUAL_NUMBER = 13
+    GREATER_THAN_NUMBER = 14
+    GREATER_THAN_OR_EQUAL_NUMBER = 15
+    IS_ONE_OF_HASHED = 16
+    IS_NOT_ONE_OF_HASHED = 17
+    BEFORE_DATETIME = 18
+    AFTER_DATETIME = 19
+    EQUALS_HASHED = 20
+    NOT_EQUALS_HASHED = 21
+    STARTS_WITH_ANY_OF_HASHED = 22
+    NOT_STARTS_WITH_ANY_OF_HASHED = 23
+    ENDS_WITH_ANY_OF_HASHED = 24
+    NOT_ENDS_WITH_ANY_OF_HASHED = 25
+    ARRAY_CONTAINS_ANY_OF_HASHED = 26
+    ARRAY_NOT_CONTAINS_ANY_OF_HASHED = 27
+
+
+COMPARATOR_TEXTS = [
+    'IS ONE OF',                 # IS_ONE_OF
+    'IS NOT ONE OF',             # IS_NOT_ONE_OF
+    'CONTAINS ANY OF',           # CONTAINS_ANY_OF
+    'NOT CONTAINS ANY OF',       # NOT_CONTAINS_ANY_OF
+    'IS ONE OF',                 # IS_ONE_OF_SEMVER
+    'IS NOT ONE OF',             # IS_NOT_ONE_OF_SEMVER
+    '<',                         # LESS_THAN_SEMVER
+    '<=',                        # LESS_THAN_OR_EQUAL_SEMVER
+    '>',                         # GREATER_THAN_SEMVER
+    '>=',                        # GREATER_THAN_OR_EQUAL_SEMVER
+    '=',                         # EQUALS_NUMBER
+    '!=',                        # NOT_EQUALS_NUMBER
+    '<',                         # LESS_THAN_NUMBER
+    '<=',                        # LESS_THAN_OR_EQUAL_NUMBER
+    '>',                         # GREATER_THAN_NUMBER
+    '>=',                        # GREATER_THAN_OR_EQUAL_NUMBER
+    'IS ONE OF',                 # IS_ONE_OF_HASHED
+    'IS NOT ONE OF',             # IS_NOT_ONE_OF_HASHED
+    'BEFORE',                    # BEFORE_DATETIME
+    'AFTER',                     # AFTER_DATETIME
+    'EQUALS',                    # EQUALS_HASHED
+    'NOT EQUALS',                # NOT_EQUALS_HASHED
+    'STARTS WITH ANY OF',        # STARTS_WITH_ANY_OF_HASHED
+    'NOT STARTS WITH ANY OF',    # NOT_STARTS_WITH_ANY_OF_HASHED
+    'ENDS WITH ANY OF',          # ENDS_WITH_ANY_OF_HASHED
+    'NOT ENDS WITH ANY OF',      # NOT_ENDS_WITH_ANY_OF_HASHED
+    'ARRAY CONTAINS ANY OF',     # ARRAY_CONTAINS_ANY_OF_HASHED
+    'ARRAY NOT CONTAINS ANY OF'  # ARRAY_NOT_CONTAINS_ANY_OF_HASHED
+]
+COMPARISON_VALUES = [
+    STRING_LIST_VALUE,  # IS_ONE_OF
+    STRING_LIST_VALUE,  # IS_NOT_ONE_OF
+    STRING_LIST_VALUE,  # CONTAINS_ANY_OF
+    STRING_LIST_VALUE,  # NOT_CONTAINS_ANY_OF
+    STRING_LIST_VALUE,  # IS_ONE_OF_SEMVER
+    STRING_LIST_VALUE,  # IS_NOT_ONE_OF_SEMVER
+    STRING_VALUE,       # LESS_THAN_SEMVER
+    STRING_VALUE,       # LESS_THAN_OR_EQUAL_SEMVER
+    STRING_VALUE,       # GREATER_THAN_SEMVER
+    STRING_VALUE,       # GREATER_THAN_OR_EQUAL_SEMVER
+    DOUBLE_VALUE,       # EQUALS_NUMBER
+    DOUBLE_VALUE,       # NOT_EQUALS_NUMBER
+    DOUBLE_VALUE,       # LESS_THAN_NUMBER
+    DOUBLE_VALUE,       # LESS_THAN_OR_EQUAL_NUMBER
+    DOUBLE_VALUE,       # GREATER_THAN_NUMBER
+    DOUBLE_VALUE,       # GREATER_THAN_OR_EQUAL_NUMBER
+    STRING_LIST_VALUE,  # IS_ONE_OF_HASHED
+    STRING_LIST_VALUE,  # IS_NOT_ONE_OF_HASHED
+    DOUBLE_VALUE,       # BEFORE_DATETIME
+    DOUBLE_VALUE,       # AFTER_DATETIME
+    STRING_VALUE,       # EQUALS_HASHED
+    STRING_VALUE,       # NOT_EQUALS_HASHED
+    STRING_LIST_VALUE,  # STARTS_WITH_ANY_OF_HASHED
+    STRING_LIST_VALUE,  # NOT_STARTS_WITH_ANY_OF_HASHED
+    STRING_LIST_VALUE,  # ENDS_WITH_ANY_OF_HASHED
+    STRING_LIST_VALUE,  # NOT_ENDS_WITH_ANY_OF_HASHED
+    STRING_LIST_VALUE,  # ARRAY_CONTAINS_ANY_OF_HASHED
+    STRING_LIST_VALUE   # ARRAY_NOT_CONTAINS_ANY_OF_HASHED
+]
+SEGMENT_COMPARATOR_TEXTS = ['IS IN SEGMENT', 'IS NOT IN SEGMENT']
+PREREQUISITE_COMPARATOR_TEXTS = ['EQUALS', 'DOES NOT EQUAL']
 
 
 def extend_config_with_inline_salt_and_segment(config):

configcatclient/configcatclient.py

@@ -3,7 +3,7 @@
 
 from . import utils
 from .configservice import ConfigService
-from .constants import TARGETING_RULES, VARIATION_ID, PERCENTAGE_OPTIONS, FEATURE_FLAGS, SERVED_VALUE
+from .config import TARGETING_RULES, VARIATION_ID, PERCENTAGE_OPTIONS, FEATURE_FLAGS, SERVED_VALUE
 from .evaluationdetails import EvaluationDetails
 from .evaluationlogbuilder import EvaluationLogBuilder
 from .interfaces import ConfigCatClientException

configcatclient/configfetcher.py

@@ -7,7 +7,7 @@
 
 from .config import extend_config_with_inline_salt_and_segment
 from .configentry import ConfigEntry
-from .constants import CONFIG_FILE_NAME, PREFERENCES, BASE_URL, REDIRECT
+from .config import CONFIG_FILE_NAME, PREFERENCES, BASE_URL, REDIRECT
 from .datagovernance import DataGovernance
 from .logger import Logger
 from .utils import get_utc_now_seconds_since_epoch

configcatclient/configservice.py

@@ -2,8 +2,8 @@
 from threading import Thread, Event, Lock
 
 from . import utils
+from .config import FEATURE_FLAGS, CONFIG_FILE_NAME, SERIALIZATION_FORMAT_VERSION
 from .configentry import ConfigEntry
-from .constants import CONFIG_FILE_NAME, FEATURE_FLAGS, SERIALIZATION_FORMAT_VERSION
 from .pollingmode import AutoPollingMode, LazyLoadingMode
 from .refreshresult import RefreshResult
 

configcatclient/evaluationlogbuilder.py

@@ -1,3 +1,4 @@
+from configcatclient.config import Comparator
 from configcatclient.utils import get_date_time
 
 
@@ -8,7 +9,6 @@ def __init__(self):
 
     @staticmethod
     def trunc_comparison_value_if_needed(comparator, comparison_value):
-        from configcatclient.rolloutevaluator import Comparator
         if comparator in [Comparator.IS_ONE_OF_HASHED,
                           Comparator.IS_NOT_ONE_OF_HASHED,
                           Comparator.EQUALS_HASHED,

configcatclient/localdictionarydatasource.py

@@ -1,4 +1,4 @@
-from .constants import VALUE, FEATURE_FLAGS, BOOL_VALUE, STRING_VALUE, INT_VALUE, DOUBLE_VALUE
+from .config import VALUE, FEATURE_FLAGS, BOOL_VALUE, STRING_VALUE, INT_VALUE, DOUBLE_VALUE
 from .overridedatasource import OverrideDataSource, FlagOverrides
 
 

configcatclient/localfiledatasource.py

@@ -1,5 +1,5 @@
-from .config import extend_config_with_inline_salt_and_segment
-from .constants import VALUE, FEATURE_FLAGS, BOOL_VALUE, STRING_VALUE, INT_VALUE, DOUBLE_VALUE
+from .config import extend_config_with_inline_salt_and_segment, VALUE, FEATURE_FLAGS, BOOL_VALUE, STRING_VALUE, \
+    INT_VALUE, DOUBLE_VALUE
 from .overridedatasource import OverrideDataSource, FlagOverrides
 import json
 import os