Merge pull request #350 from splitio/dw-update-sync.split

updated logs and comments in sync.split

Author: chillaq

splitio/sync/split.py

@@ -28,16 +28,16 @@
 
 
 class SplitSynchronizer(object):
-    """Split changes synchronizer."""
+    """Feature Flag changes synchronizer."""
 
     def __init__(self, split_api, split_storage):
         """
         Class constructor.
 
-        :param split_api: Split API Client.
+        :param split_api: Feature Flag API Client.
         :type split_api: splitio.api.splits.SplitsAPI
 
-        :param split_storage: Split Storage.
+        :param split_storage: Feature Flag Storage.
         :type split_storage: splitio.storage.InMemorySplitStorage
         """
         self._api = split_api
@@ -50,7 +50,7 @@ def _fetch_until(self, fetch_options, till=None):
         """
         Hit endpoint, update storage and return when since==till.
 
-        :param fetch_options Fetch options for getting split definitions.
+        :param fetch_options Fetch options for getting feature flag definitions.
         :type fetch_options splitio.api.FetchOptions
 
         :param till: Passed till from Streaming.
@@ -71,7 +71,7 @@ def _fetch_until(self, fetch_options, till=None):
             try:
                 split_changes = self._api.fetch_splits(change_number, fetch_options)
             except APIException as exc:
-                _LOGGER.error('Exception raised while fetching splits')
+                _LOGGER.error('Exception raised while fetching feature flags')
                 _LOGGER.debug('Exception information: ', exc_info=True)
                 raise exc
 
@@ -90,7 +90,7 @@ def _attempt_split_sync(self, fetch_options, till=None):
         """
         Hit endpoint, update storage and return True if sync is complete.
 
-        :param fetch_options Fetch options for getting split definitions.
+        :param fetch_options Fetch options for getting feature flag definitions.
         :type fetch_options splitio.api.FetchOptions
 
         :param till: Passed till from Streaming.
@@ -143,9 +143,9 @@ def synchronize_splits(self, till=None):
 
     def kill_split(self, split_name, default_treatment, change_number):
         """
-        Local kill for split.
+        Local kill for feature flag.
 
-        :param split_name: name of the split to perform kill
+        :param split_name: name of the feature flag to perform kill
         :type split_name: str
         :param default_treatment: name of the default treatment to return
         :type default_treatment: str
@@ -169,9 +169,9 @@ def __init__(self, filename, split_storage, localhost_mode=LocalhostMode.LEGACY)
         """
         Class constructor.
 
-        :param filename: File to parse splits from.
+        :param filename: File to parse feature flags from.
         :type filename: str
-        :param split_storage: Split Storage.
+        :param split_storage: Feature flag Storage.
         :type split_storage: splitio.storage.InMemorySplitStorage
         :param localhost_mode: mode for localhost either JSON, YAML or LEGACY.
         :type localhost_mode: splitio.sync.split.LocalhostMode
@@ -184,9 +184,9 @@ def __init__(self, filename, split_storage, localhost_mode=LocalhostMode.LEGACY)
     @staticmethod
     def _make_split(split_name, conditions, configs=None):
         """
-        Make a split with a single all_keys matcher.
+        Make a Feature flag with a single all_keys matcher.
 
-        :param split_name: Name of the split.
+        :param split_name: Name of the feature flag.
         :type split_name: str.
         """
         return splits.from_raw({
@@ -248,12 +248,12 @@ def _make_whitelist_condition(whitelist, treatment):
     @classmethod
     def _read_splits_from_legacy_file(cls, filename):
         """
-        Parse a splits file and return a populated storage.
+        Parse a feature flags file and return a populated storage.
 
-        :param filename: Path of the file containing mocked splits & treatments.
+        :param filename: Path of the file containing mocked feature flags & treatments.
         :type filename: str.
 
-        :return: Storage populataed with splits ready to be evaluated.
+        :return: Storage populataed with feature flags ready to be evaluated.
         :rtype: InMemorySplitStorage
         """
         to_return = {}
@@ -266,7 +266,7 @@ def _read_splits_from_legacy_file(cls, filename):
                     definition_match = _LEGACY_DEFINITION_LINE_RE.match(line)
                     if not definition_match:
                         _LOGGER.warning(
-                            'Invalid line on localhost environment split '
+                            'Invalid line on localhost environment feature flag '
                             'definition. Line = %s',
                             line
                         )
@@ -283,12 +283,12 @@ def _read_splits_from_legacy_file(cls, filename):
     @classmethod
     def _read_splits_from_yaml_file(cls, filename):
         """
-        Parse a splits file and return a populated storage.
+        Parse a feature flags file and return a populated storage.
 
-        :param filename: Path of the file containing mocked splits & treatments.
+        :param filename: Path of the file containing mocked feature flags & treatments.
         :type filename: str.
 
-        :return: Storage populataed with splits ready to be evaluated.
+        :return: Storage populated with feature flags ready to be evaluated.
         :rtype: InMemorySplitStorage
         """
         try:
@@ -320,17 +320,17 @@ def _read_splits_from_yaml_file(cls, filename):
             raise ValueError("Error parsing file %s. Make sure it's readable." % filename) from exc
 
     def synchronize_splits(self, till=None):  # pylint:disable=unused-argument
-        """Update splits in storage."""
-        _LOGGER.info('Synchronizing splits now.')
+        """Update feature flags in storage."""
+        _LOGGER.info('Synchronizing feature flags now.')
         try:
             return self._synchronize_json() if self._localhost_mode == LocalhostMode.JSON else self._synchronize_legacy()
         except Exception as exc:
             _LOGGER.error(str(exc))
-            raise APIException("Error fetching splits information") from exc
+            raise APIException("Error fetching feature flags information") from exc
 
     def _synchronize_legacy(self):
         """
-        Update splits in storage for legacy mode.
+        Update feature flags in storage for legacy mode.
 
         :return: empty array for compatibility with json mode
         :rtype: []
@@ -352,7 +352,7 @@ def _synchronize_legacy(self):
 
     def _synchronize_json(self):
         """
-        Update splits in storage for json mode.
+        Update feature flags in storage for json mode.
 
         :return: segment names string array
         :rtype: [str]
@@ -370,24 +370,24 @@ def _synchronize_json(self):
                 if split['status'] == splits.Status.ACTIVE.value:
                     parsed = splits.from_raw(split)
                     self._split_storage.put(parsed)
-                    _LOGGER.debug("split %s is updated", parsed.name)
+                    _LOGGER.debug("feature flag %s is updated", parsed.name)
                     segment_list.update(set(parsed.get_segment_names()))
                 else:
                     self._split_storage.remove(split['name'])
 
                 self._split_storage.set_change_number(till)
             return segment_list
         except Exception as exc:
-            raise ValueError("Error reading splits from json.") from exc
+            raise ValueError("Error reading feature flags from json.") from exc
 
     def _read_splits_from_json_file(self, filename):
         """
-        Parse a splits file and return a populated storage.
+        Parse a feature flags file and return a populated storage.
 
-        :param filename: Path of the file containing split
+        :param filename: Path of the file containing feature flags
         :type filename: str.
 
-        :return: Tuple: sanitized split structure dict and till
+        :return: Tuple: sanitized feature flag structure dict and till
         :rtype: Tuple(Dict, int)
         """
         try:
@@ -403,7 +403,7 @@ def _sanitize_split(self, parsed):
         """
         implement Sanitization if neded.
 
-        :param parsed: splits, till and since elements dict
+        :param parsed: feature flags, till and since elements dict
         :type parsed: Dict
 
         :return: sanitized structure dict
@@ -418,7 +418,7 @@ def _sanitize_json_elements(self, parsed):
         """
         Sanitize all json elements.
 
-        :param parsed: splits, till and since elements dict
+        :param parsed: feature flags, till and since elements dict
         :type parsed: Dict
 
         :return: sanitized structure dict
@@ -435,9 +435,9 @@ def _sanitize_json_elements(self, parsed):
 
     def _sanitize_split_elements(self, parsed_splits):
         """
-        Sanitize all splits elements.
+        Sanitize all feature flags elements.
 
-        :param parsed_splits: splits array
+        :param parsed_splits: feature flags array
         :type parsed_splits: [Dict]
 
         :return: sanitized structure dict
@@ -446,7 +446,7 @@ def _sanitize_split_elements(self, parsed_splits):
         sanitized_splits = []
         for split in parsed_splits:
             if 'name' not in split or split['name'].strip() == '':
-                _LOGGER.warning("A split in json file does not have (Name) or property is empty, skipping.")
+                _LOGGER.warning("A feature flag in json file does not have (Name) or property is empty, skipping.")
                 continue
             for element in [('trafficTypeName', 'user', None, None, None, None),
                             ('trafficAllocation', 100, 0, 100,  None, None),
@@ -464,12 +464,12 @@ def _sanitize_split_elements(self, parsed_splits):
 
     def _sanitize_condition(self, split):
         """
-        Sanitize split and ensure a condition type ROLLOUT and matcher exist with ALL_KEYS elements.
+        Sanitize feature flag and ensure a condition type ROLLOUT and matcher exist with ALL_KEYS elements.
 
-        :param split: split dict object
+        :param split: feature flag dict object
         :type split: Dict
 
-        :return: sanitized split
+        :return: sanitized feature flag
         :rtype: Dict
         """
         found_all_keys_matcher = False
@@ -486,7 +486,7 @@ def _sanitize_condition(self, split):
                                     break
 
         if not found_all_keys_matcher:
-            _LOGGER.debug("Missing default rule condition for split: %s, adding default rule with 100%% off treatment", split['name'])
+            _LOGGER.debug("Missing default rule condition for feature flag: %s, adding default rule with 100%% off treatment", split['name'])
             split['conditions'].append(
             {
                 "conditionType": "ROLLOUT",