feat: add odp integration w client and user context (#408)

* add main functionality for odp integraton w client and user context

Co-authored-by: Andy Leap <andrew.leap@optimizely.com>

Author: Mat001

README.md

@@ -24,6 +24,12 @@ documentation](https://docs.developers.optimizely.com/rollouts/docs).
 
 ## Getting Started
 
+### Requirements
+
+Version `4.0+`: Python 3.7+, PyPy 3.7+
+
+Version `3.0+`: Python 2.7+, PyPy 3.4+
+
 ### Installing the SDK
 
 The SDK is available through [PyPi](https://pypi.python.org/pypi?name=optimizely-sdk&:action=display).

optimizely/helpers/enums.py

@@ -199,13 +199,13 @@ class EventDispatchConfig:
     REQUEST_TIMEOUT: Final = 10
 
 
-class OdpRestApiConfig:
-    """ODP Rest API configs."""
+class OdpEventApiConfig:
+    """ODP Events API configs."""
     REQUEST_TIMEOUT: Final = 10
 
 
-class OdpGraphQLApiConfig:
-    """ODP GraphQL API configs."""
+class OdpSegmentApiConfig:
+    """ODP Segments API configs."""
     REQUEST_TIMEOUT: Final = 10
 
 

optimizely/helpers/sdk_settings.py

@@ -0,0 +1,55 @@
+# Copyright 2022, Optimizely
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+from typing import Optional
+
+from optimizely.helpers import enums
+from optimizely.odp.lru_cache import OptimizelySegmentsCache
+from optimizely.odp.odp_event_manager import OdpEventManager
+from optimizely.odp.odp_segment_manager import OdpSegmentManager
+
+
+class OptimizelySdkSettings:
+    """Contains configuration used for Optimizely Project initialization."""
+
+    def __init__(
+            self,
+            odp_disabled: bool = False,
+            segments_cache_size: int = enums.OdpSegmentsCacheConfig.DEFAULT_CAPACITY,
+            segments_cache_timeout_in_secs: int = enums.OdpSegmentsCacheConfig.DEFAULT_TIMEOUT_SECS,
+            odp_segments_cache: Optional[OptimizelySegmentsCache] = None,
+            odp_segment_manager: Optional[OdpSegmentManager] = None,
+            odp_event_manager: Optional[OdpEventManager] = None
+    ) -> None:
+        """
+        Args:
+          odp_disabled: Set this flag to true (default = False) to disable ODP features.
+          segments_cache_size: The maximum size of audience segments cache (optional. default = 10,000).
+            Set to zero to disable caching.
+          segments_cache_timeout_in_secs: The timeout in seconds of audience segments cache (optional. default = 600).
+            Set to zero to disable timeout.
+          odp_segments_cache: A custom odp segments cache. Required methods include:
+            `save(key, value)`, `lookup(key) -> value`, and `reset()`
+          odp_segment_manager: A custom odp segment manager. Required method is:
+            `fetch_qualified_segments(user_key, user_value, options)`.
+          odp_event_manager: A custom odp event manager. Required method is:
+            `send_event(type:, action:, identifiers:, data:)`
+        """
+
+        self.odp_disabled = odp_disabled
+        self.segments_cache_size = segments_cache_size
+        self.segments_cache_timeout_in_secs = segments_cache_timeout_in_secs
+        self.segments_cache = odp_segments_cache
+        self.odp_segment_manager = odp_segment_manager
+        self.odp_event_manager = odp_event_manager

optimizely/helpers/validator.py

@@ -21,6 +21,9 @@
 from optimizely.notification_center import NotificationCenter
 from optimizely.user_profile import UserProfile
 from . import constants
+from ..odp.lru_cache import OptimizelySegmentsCache
+from ..odp.odp_event_manager import OdpEventManager
+from ..odp.odp_segment_manager import OdpSegmentManager
 
 if TYPE_CHECKING:
     # prevent circular dependenacy by skipping import at runtime
@@ -67,10 +70,10 @@ def _has_method(obj: object, method: str) -> bool:
     method: Method whose presence needs to be determined.
 
   Returns:
-    Boolean depending upon whether the method is available or not.
+    Boolean depending upon whether the method is available and callable or not.
   """
 
-    return getattr(obj, method, None) is not None
+    return callable(getattr(obj, method, None))
 
 
 def is_config_manager_valid(config_manager: BaseConfigManager) -> bool:
@@ -312,3 +315,66 @@ def are_values_same_type(first_val: Any, second_val: Any) -> bool:
 def are_odp_data_types_valid(data: OdpDataDict) -> bool:
     valid_types = (str, int, float, bool, type(None))
     return all(isinstance(v, valid_types) for v in data.values())
+
+
+def is_segments_cache_valid(segments_cache: Optional[OptimizelySegmentsCache]) -> bool:
+    """ Given a segments_cache determine if it is valid or not i.e. provides a reset, lookup and save methods.
+
+    Args:
+      segments_cache: Provides cache methods: reset, lookup, save.
+
+    Returns:
+      Boolean depending upon whether segments_cache is valid or not.
+    """
+    if not _has_method(segments_cache, 'reset'):
+        return False
+
+    if not _has_method(segments_cache, 'lookup'):
+        return False
+
+    if not _has_method(segments_cache, 'save'):
+        return False
+
+    return True
+
+
+def is_segment_manager_valid(segment_manager: Optional[OdpSegmentManager]) -> bool:
+    """ Given a segments_manager determine if it is valid or not.
+
+    Args:
+      segment_manager: Provides methods fetch_qualified_segments and reset
+
+    Returns:
+      Boolean depending upon whether segments_manager is valid or not.
+    """
+    if not _has_method(segment_manager, 'fetch_qualified_segments'):
+        return False
+
+    if not _has_method(segment_manager, 'reset'):
+        return False
+
+    return True
+
+
+def is_event_manager_valid(event_manager: Optional[OdpEventManager]) -> bool:
+    """ Given an event_manager determine if it is valid or not.
+
+    Args:
+      event_manager: Provides send_event method
+
+    Returns:
+      Boolean depending upon whether event_manager is valid or not.
+    """
+    if not hasattr(event_manager, 'is_running'):
+        return False
+
+    if not _has_method(event_manager, 'send_event'):
+        return False
+
+    if not _has_method(event_manager, 'stop'):
+        return False
+
+    if not _has_method(event_manager, 'update_config'):
+        return False
+
+    return True

optimizely/odp/zaius_rest_api_manager.py optimizely/odp/odp_event_api_manager.pyoptimizely/odp/zaius_rest_api_manager.py renamed to optimizely/odp/odp_event_api_manager.py

@@ -20,7 +20,7 @@
 from requests.exceptions import RequestException, ConnectionError, Timeout
 
 from optimizely import logger as optimizely_logger
-from optimizely.helpers.enums import Errors, OdpRestApiConfig
+from optimizely.helpers.enums import Errors, OdpEventApiConfig
 from optimizely.odp.odp_event import OdpEvent, OdpEventEncoder
 
 """
@@ -37,7 +37,7 @@
 """
 
 
-class ZaiusRestApiManager:
+class OdpEventApiManager:
     """Provides an internal service for ODP event REST api access."""
 
     def __init__(self, logger: Optional[optimizely_logger.Logger] = None):
@@ -69,7 +69,7 @@ def send_odp_events(self, api_key: str, api_host: str, events: list[OdpEvent]) -
             response = requests.post(url=url,
                                      headers=request_headers,
                                      data=payload_dict,
-                                     timeout=OdpRestApiConfig.REQUEST_TIMEOUT)
+                                     timeout=OdpEventApiConfig.REQUEST_TIMEOUT)
 
             response.raise_for_status()
 

optimizely/odp/odp_event_manager.py

@@ -23,7 +23,7 @@
 from optimizely.helpers.enums import OdpEventManagerConfig, Errors, OdpManagerConfig
 from .odp_config import OdpConfig, OdpConfigState
 from .odp_event import OdpEvent, OdpDataDict
-from .zaius_rest_api_manager import ZaiusRestApiManager
+from .odp_event_api_manager import OdpEventApiManager
 
 
 class Signal(Enum):
@@ -45,7 +45,7 @@ class OdpEventManager:
     def __init__(
         self,
         logger: Optional[_logging.Logger] = None,
-        api_manager: Optional[ZaiusRestApiManager] = None
+        api_manager: Optional[OdpEventApiManager] = None
     ):
         """OdpEventManager init method to configure event batching.
 
@@ -54,7 +54,7 @@ def __init__(
             api_manager: Optional component which sends events to ODP.
         """
         self.logger = logger or _logging.NoOpLogger()
-        self.zaius_manager = api_manager or ZaiusRestApiManager(self.logger)
+        self.api_manager = api_manager or OdpEventApiManager(self.logger)
 
         self.odp_config: Optional[OdpConfig] = None
         self.api_key: Optional[str] = None
@@ -158,7 +158,7 @@ def _flush_batch(self) -> None:
 
         for i in range(1 + self.retry_count):
             try:
-                should_retry = self.zaius_manager.send_odp_events(self.api_key, self.api_host, self._current_batch)
+                should_retry = self.api_manager.send_odp_events(self.api_key, self.api_host, self._current_batch)
             except Exception as error:
                 should_retry = False
                 self.logger.error(Errors.ODP_EVENT_FAILED.format(f'Error: {error} {self._current_batch}'))

optimizely/odp/odp_manager.py

@@ -3,7 +3,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -15,7 +15,6 @@
 
 from typing import Optional, Any
 
-from optimizely import exceptions as optimizely_exception
 from optimizely import logger as optimizely_logger
 from optimizely.helpers.enums import Errors, OdpManagerConfig, OdpSegmentsCacheConfig
 from optimizely.helpers.validator import are_odp_data_types_valid
@@ -56,13 +55,8 @@ def __init__(
                 )
             self.segment_manager = OdpSegmentManager(segments_cache, logger=self.logger)
 
-        if event_manager:
-            self.event_manager = event_manager
-        else:
-            self.event_manager = OdpEventManager(self.logger)
-
+        self.event_manager = self.event_manager or OdpEventManager(self.logger)
         self.segment_manager.odp_config = self.odp_config
-        self.event_manager.start(self.odp_config)
 
     def fetch_qualified_segments(self, user_id: str, options: list[str]) -> Optional[list[str]]:
         if not self.enabled or not self.segment_manager:
@@ -94,17 +88,18 @@ def send_event(self, type: str, action: str, identifiers: dict[str, str], data:
             identifiers: A dictionary for identifiers.
             data: A dictionary for associated data. The default event data will be added to this data
             before sending to the ODP server.
-
-        Raises custom exception if error is detected.
         """
         if not self.enabled or not self.event_manager:
-            raise optimizely_exception.OdpNotEnabled(Errors.ODP_NOT_ENABLED)
+            self.logger.error(Errors.ODP_NOT_ENABLED)
+            return
 
         if self.odp_config.odp_state() == OdpConfigState.NOT_INTEGRATED:
-            raise optimizely_exception.OdpNotIntegrated(Errors.ODP_NOT_INTEGRATED)
+            self.logger.error(Errors.ODP_NOT_INTEGRATED)
+            return
 
         if not are_odp_data_types_valid(data):
-            raise optimizely_exception.OdpInvalidData(Errors.ODP_INVALID_DATA)
+            self.logger.error(Errors.ODP_INVALID_DATA)
+            return
 
         self.event_manager.send_event(type, action, identifiers, data)
 
@@ -122,5 +117,14 @@ def update_odp_config(self, api_key: Optional[str], api_host: Optional[str],
         if self.segment_manager:
             self.segment_manager.reset()
 
-        if self.event_manager:
+        if not self.event_manager:
+            return
+
+        if self.event_manager.is_running:
             self.event_manager.update_config()
+        elif self.odp_config.odp_state() == OdpConfigState.INTEGRATED:
+            self.event_manager.start(self.odp_config)
+
+    def close(self) -> None:
+        if self.enabled and self.event_manager:
+            self.event_manager.stop()

…imizely/odp/zaius_graphql_api_manager.py optimizely/odp/odp_segment_api_manager.pyoptimizely/odp/zaius_graphql_api_manager.py renamed to optimizely/odp/odp_segment_api_manager.py optimizely/odp/zaius_graphql_api_manager.py renamed to optimizely/odp/odp_segment_api_manager.py

@@ -20,7 +20,7 @@
 from requests.exceptions import RequestException, ConnectionError, Timeout, JSONDecodeError
 
 from optimizely import logger as optimizely_logger
-from optimizely.helpers.enums import Errors, OdpGraphQLApiConfig
+from optimizely.helpers.enums import Errors, OdpSegmentApiConfig
 
 """
  ODP GraphQL API
@@ -105,7 +105,7 @@
 """
 
 
-class ZaiusGraphQLApiManager:
+class OdpSegmentApiManager:
     """Interface for manging the fetching of audience segments."""
 
     def __init__(self, logger: Optional[optimizely_logger.Logger] = None):
@@ -130,10 +130,15 @@ def fetch_segments(self, api_key: str, api_host: str, user_key: str,
         request_headers = {'content-type': 'application/json',
                            'x-api-key': str(api_key)}
 
-        segments_filter = self.make_subset_filter(segments_to_check)
         query = {
-            'query': 'query {customer(' + str(user_key) + ': "' + str(user_value) + '") '
-            '{audiences' + segments_filter + ' {edges {node {name state}}}}}'
+            'query':
+                'query($userId: String, $audiences: [String]) {'
+                f'customer({user_key}: $userId) '
+                '{audiences(subset: $audiences) {edges {node {name state}}}}}',
+            'variables': {
+                'userId': str(user_value),
+                'audiences': segments_to_check
+            }
         }
 
         try:
@@ -146,7 +151,7 @@ def fetch_segments(self, api_key: str, api_host: str, user_key: str,
             response = requests.post(url=url,
                                      headers=request_headers,
                                      data=payload_dict,
-                                     timeout=OdpGraphQLApiConfig.REQUEST_TIMEOUT)
+                                     timeout=OdpSegmentApiConfig.REQUEST_TIMEOUT)
 
             response.raise_for_status()
             response_dict = response.json()
@@ -185,19 +190,3 @@ def fetch_segments(self, api_key: str, api_host: str, user_key: str,
             except KeyError:
                 self.logger.error(Errors.FETCH_SEGMENTS_FAILED.format('decode error'))
                 return None
-
-    @staticmethod
-    def make_subset_filter(segments: list[str]) -> str:
-        """
-        segments = []: (fetch none)
-         --> subsetFilter = "(subset:[])"
-        segments = ["a"]: (fetch one segment)
-         --> subsetFilter = '(subset:["a"])'
-
-         Purposely using .join() method to deal with special cases of
-         any words with apostrophes (i.e. don't). .join() method enquotes
-         correctly without conflicting with the apostrophe.
-        """
-        if segments == []:
-            return '(subset:[])'
-        return '(subset:["' + '", "'.join(segments) + '"]' + ')'