[FSSDK-8946] fix: make odp event identifiers required (#418)

* make odp event identifiers required

Author: andrewleap-optimizely

optimizely/optimizely.py

@@ -1369,25 +1369,29 @@ def _fetch_qualified_segments(self, user_id: str, options: Optional[list[str]] =
     def send_odp_event(
         self,
         action: str,
+        identifiers: dict[str, str],
         type: str = enums.OdpManagerConfig.EVENT_TYPE,
-        identifiers: Optional[dict[str, str]] = None,
         data: Optional[dict[str, str | int | float | bool | None]] = None
     ) -> None:
         """
         Send an event to the ODP server.
 
         Args:
             action: The event action name.
+            identifiers: A dictionary for identifiers. The caller must provide at least one key-value pair.
             type: The event type. Default 'fullstack'.
-            identifiers: An optional dictionary for identifiers.
             data: An optional dictionary for associated data. The default event data will be added to this data
             before sending to the ODP server.
         """
         if not self.is_valid:
             self.logger.error(enums.Errors.INVALID_OPTIMIZELY.format('send_odp_event'))
             return
 
-        self.odp_manager.send_event(type, action, identifiers or {}, data or {})
+        if not identifiers or not isinstance(identifiers, dict):
+            self.logger.error('ODP events must have at least one key-value pair in identifiers.')
+            return
+
+        self.odp_manager.send_event(type, action, identifiers, data or {})
 
     def close(self) -> None:
         if callable(getattr(self.event_processor, 'stop', None)):

tests/test_optimizely.py

@@ -5386,7 +5386,7 @@ def test_send_odp_event__send_event_with_static_config_manager(self):
             logger=mock_logger,
         )
         with mock.patch('requests.post', return_value=self.fake_server_response(status_code=200)):
-            client.send_odp_event(type='wow', action='great', identifiers={}, data={})
+            client.send_odp_event(type='wow', action='great', identifiers={'amazing': 'fantastic'}, data={})
             client.close()
         mock_logger.error.assert_not_called()
         mock_logger.debug.assert_called_with('ODP event queue: flushing batch size 1.')
@@ -5405,7 +5405,7 @@ def test_send_odp_event__send_event_with_polling_config_manager(self):
             client.config_manager.get_config()
 
         with mock.patch('requests.post', return_value=self.fake_server_response(status_code=200)):
-            client.send_odp_event(type='wow', action='great', identifiers={}, data={})
+            client.send_odp_event(type='wow', action='great', identifiers={'amazing': 'fantastic'}, data={})
             client.close()
 
         mock_logger.error.assert_not_called()
@@ -5419,14 +5419,14 @@ def test_send_odp_event__log_error_when_odp_disabled(self):
             settings=OptimizelySdkSettings(odp_disabled=True)
         )
         with mock.patch('requests.post', return_value=self.fake_server_response(status_code=200)):
-            client.send_odp_event(type='wow', action='great', identifiers={}, data={})
+            client.send_odp_event(type='wow', action='great', identifiers={'amazing': 'fantastic'}, data={})
             client.close()
         mock_logger.error.assert_called_with('ODP is not enabled.')
 
     def test_send_odp_event__log_debug_if_datafile_not_ready(self):
         mock_logger = mock.Mock()
         client = optimizely.Optimizely(sdk_key='test', logger=mock_logger)
-        client.send_odp_event(type='wow', action='great', identifiers={}, data={})
+        client.send_odp_event(type='wow', action='great', identifiers={'amazing': 'fantastic'}, data={})
 
         mock_logger.debug.assert_called_with('ODP event queue: cannot send before config has been set.')
         client.close()
@@ -5449,7 +5449,7 @@ def test_send_odp_event__log_error_if_odp_not_enabled_with_polling_config_manage
             client.config_manager.get_config()
 
         with mock.patch('requests.post', return_value=self.fake_server_response(status_code=200)):
-            client.send_odp_event(type='wow', action='great', identifiers={}, data={})
+            client.send_odp_event(type='wow', action='great', identifiers={'amazing': 'fantastic'}, data={})
             client.close()
 
         mock_logger.error.assert_called_with('ODP is not enabled.')
@@ -5458,15 +5458,33 @@ def test_send_odp_event__log_error_with_invalid_data(self):
         mock_logger = mock.Mock()
         client = optimizely.Optimizely(json.dumps(self.config_dict_with_audience_segments), logger=mock_logger)
 
-        client.send_odp_event(type='wow', action='great', identifiers={}, data={'test': {}})
+        client.send_odp_event(type='wow', action='great', identifiers={'amazing': 'fantastic'}, data={'test': {}})
         client.close()
 
         mock_logger.error.assert_called_with('ODP data is not valid.')
 
+    def test_send_odp_event__log_error_with_empty_identifiers(self):
+        mock_logger = mock.Mock()
+        client = optimizely.Optimizely(json.dumps(self.config_dict_with_audience_segments), logger=mock_logger)
+
+        client.send_odp_event(type='wow', action='great', identifiers={}, data={})
+        client.close()
+
+        mock_logger.error.assert_called_with('ODP events must have at least one key-value pair in identifiers.')
+
+    def test_send_odp_event__log_error_with_no_identifiers(self):
+        mock_logger = mock.Mock()
+        client = optimizely.Optimizely(json.dumps(self.config_dict_with_audience_segments), logger=mock_logger)
+
+        client.send_odp_event(type='wow', action='great', identifiers=None, data={})
+        client.close()
+
+        mock_logger.error.assert_called_with('ODP events must have at least one key-value pair in identifiers.')
+
     def test_send_odp_event__log_error_with_missing_integrations_data(self):
         mock_logger = mock.Mock()
         client = optimizely.Optimizely(json.dumps(self.config_dict_with_typed_audiences), logger=mock_logger)
-        client.send_odp_event(type='wow', action='great', identifiers={}, data={})
+        client.send_odp_event(type='wow', action='great', identifiers={'amazing': 'fantastic'}, data={})
 
         mock_logger.error.assert_called_with('ODP is not integrated.')
         client.close()