[FSSDK-11458] Python - Add SDK Multi-Region Support for Data Hosting (#459)

* [FSSDK-11458] Python - Add SDK Multi-Region Support for Data Hosting

* Fix lint issues

* Fix lint issue

* Fix errors

* Add region on base test

* Update Region as enum

* Delete blank lines

* Fix lint issue

* Fix lint issue

* Fix test errors

* Add enum

* Fix region value

* Fix type issue

* Correct the event url

* Add region in params

* Fix region param

* Add region to create

* Fix test cases

* Fix test cases

* Fix lint

* Add region

* Fix test cases

* Fix tests

* Cast to string

* Fix tests

* Fix order

* Remove unnecessary region implementation

* Fix lint issues

* Fix test cases

* Fix error

* Implemented reviews and added new tests

* Fix test cases

* Implement comments

* Fix lint issue

Author: esrakartalOpt

optimizely/event/event_factory.py

@@ -42,7 +42,10 @@ class EventFactory:
   to record the events via the Optimizely Events API ("https://developers.optimizely.com/x/events/api/index.html")
   """
 
-    EVENT_ENDPOINT: Final = 'https://logx.optimizely.com/v1/events'
+    EVENT_ENDPOINTS: Final = {
+        'US': 'https://logx.optimizely.com/v1/events',
+        'EU': 'https://eu.logx.optimizely.com/v1/events'
+    }
     HTTP_VERB: Final = 'POST'
     HTTP_HEADERS: Final = {'Content-Type': 'application/json'}
     ACTIVATE_EVENT_KEY: Final = 'campaign_activated'
@@ -97,7 +100,11 @@ def create_log_event(
 
         event_params = event_batch.get_event_params()
 
-        return log_event.LogEvent(cls.EVENT_ENDPOINT, event_params, cls.HTTP_VERB, cls.HTTP_HEADERS)
+        region = user_context.region or 'US'  # Default to 'US' if None
+        region_key = str(region).upper()
+        endpoint = cls.EVENT_ENDPOINTS.get(region_key, cls.EVENT_ENDPOINTS['US'])
+
+        return log_event.LogEvent(endpoint, event_params, cls.HTTP_VERB, cls.HTTP_HEADERS)
 
     @classmethod
     def _create_visitor(cls, event: Optional[user_event.UserEvent], logger: Logger) -> Optional[payload.Visitor]:

optimizely/event/user_event.py

@@ -99,10 +99,11 @@ def __init__(
 class EventContext:
     """ Class respresenting User Event Context. """
 
-    def __init__(self, account_id: str, project_id: str, revision: str, anonymize_ip: bool):
+    def __init__(self, account_id: str, project_id: str, revision: str, anonymize_ip: bool, region: str):
         self.account_id = account_id
         self.project_id = project_id
         self.revision = revision
         self.client_name = CLIENT_NAME
         self.client_version = version.__version__
         self.anonymize_ip = anonymize_ip
+        self.region = region or 'US'

optimizely/event/user_event_factory.py

@@ -77,7 +77,11 @@ def create_impression_event(
             variation = project_config.get_variation_from_id_by_experiment_id(experiment_id, variation_id)
 
         event_context = user_event.EventContext(
-            project_config.account_id, project_config.project_id, project_config.revision, project_config.anonymize_ip,
+            project_config.account_id,
+            project_config.project_id,
+            project_config.revision,
+            project_config.anonymize_ip,
+            project_config.region
         )
 
         return user_event.ImpressionEvent(
@@ -117,7 +121,11 @@ def create_conversion_event(
     """
 
         event_context = user_event.EventContext(
-            project_config.account_id, project_config.project_id, project_config.revision, project_config.anonymize_ip,
+            project_config.account_id,
+            project_config.project_id,
+            project_config.revision,
+            project_config.anonymize_ip,
+            project_config.region
         )
 
         return user_event.ConversionEvent(

optimizely/event_builder.py

@@ -54,7 +54,10 @@ class EventBuilder:
     """ Class which encapsulates methods to build events for tracking
   impressions and conversions using the new V3 event API (batch). """
 
-    EVENTS_URL: Final = 'https://logx.optimizely.com/v1/events'
+    EVENTS_URLS: Final = {
+        'US': 'https://logx.optimizely.com/v1/events',
+        'EU': 'https://eu.logx.optimizely.com/v1/events'
+    }
     HTTP_VERB: Final = 'POST'
     HTTP_HEADERS: Final = {'Content-Type': 'application/json'}
 
@@ -266,7 +269,11 @@ def create_impression_event(
 
         params[self.EventParams.USERS][0][self.EventParams.SNAPSHOTS].append(impression_params)
 
-        return Event(self.EVENTS_URL, params, http_verb=self.HTTP_VERB, headers=self.HTTP_HEADERS)
+        region = project_config.region or 'US'
+        region_key = str(region).upper()
+        events_url = self.EVENTS_URLS.get(region_key, self.EVENTS_URLS['US'])
+
+        return Event(events_url, params, http_verb=self.HTTP_VERB, headers=self.HTTP_HEADERS)
 
     def create_conversion_event(
         self, project_config: ProjectConfig, event_key: str,
@@ -289,4 +296,9 @@ def create_conversion_event(
         conversion_params = self._get_required_params_for_conversion(project_config, event_key, event_tags)
 
         params[self.EventParams.USERS][0][self.EventParams.SNAPSHOTS].append(conversion_params)
-        return Event(self.EVENTS_URL, params, http_verb=self.HTTP_VERB, headers=self.HTTP_HEADERS)
+
+        region = project_config.region or 'US'
+        region_key = str(region).upper()
+        events_url = self.EVENTS_URLS.get(region_key, self.EVENTS_URLS['US'])
+
+        return Event(events_url, params, http_verb=self.HTTP_VERB, headers=self.HTTP_HEADERS)

optimizely/project_config.py

@@ -85,6 +85,9 @@ def __init__(self, datafile: str | bytes, logger: Logger, error_handler: Any):
         self.host_for_odp: Optional[str] = None
         self.all_segments: list[str] = []
 
+        region_value = config.get('region')
+        self.region: str = region_value or 'US'
+
         # Utility maps for quick lookup
         self.group_id_map: dict[str, entities.Group] = self._generate_key_map(self.groups, 'id', entities.Group)
         self.experiment_id_map: dict[str, entities.Experiment] = self._generate_key_map(

tests/test_config.py

@@ -154,6 +154,28 @@ def test_init(self):
         self.assertEqual(expected_variation_key_map, self.project_config.variation_key_map)
         self.assertEqual(expected_variation_id_map, self.project_config.variation_id_map)
 
+    def test_region_when_no_region(self):
+        """ Test that region defaults to 'US' when not specified in the config. """
+        config_dict = copy.deepcopy(self.config_dict_with_multiple_experiments)
+        opt_obj = optimizely.Optimizely(json.dumps(config_dict))
+        project_config = opt_obj.config_manager.get_config()
+        self.assertEqual(project_config.region, 'US')
+
+    def test_region_when_specified_in_datafile(self):
+        """ Test that region is set to 'US' when specified in the config. """
+        config_dict_us = copy.deepcopy(self.config_dict_with_multiple_experiments)
+        config_dict_us['region'] = 'US'
+        opt_obj_us = optimizely.Optimizely(json.dumps(config_dict_us))
+        project_config_us = opt_obj_us.config_manager.get_config()
+        self.assertEqual(project_config_us.region, 'US')
+
+        """ Test that region is set to 'EU' when specified in the config. """
+        config_dict_eu = copy.deepcopy(self.config_dict_with_multiple_experiments)
+        config_dict_eu['region'] = 'EU'
+        opt_obj_eu = optimizely.Optimizely(json.dumps(config_dict_eu))
+        project_config_eu = opt_obj_eu.config_manager.get_config()
+        self.assertEqual(project_config_eu.region, 'EU')
+
     def test_cmab_field_population(self):
         """ Test that the cmab field is populated correctly in experiments."""