[FSSDK-8948] fix(odp): check odp identifiers not null or empty before sending (#342)

* fix(odp): check odp identifiers not null or empty before sending

* fixed as per comment

* refactored and removed additional message for identifiers

---------

Co-authored-by: mnoman09 <m.nomanshoaib09@gmail.com>

Author: mnoman09

OptimizelySDK.Tests/OdpTests/OdpEventManagerTests.cs

@@ -271,6 +271,43 @@ public void ShouldDiscardEventsWithInvalidData()
                 Times.Exactly(2));
         }
 
+        [Test]
+        public void ShouldDiscardEventsWithInvalidIdentifiersDictionary()
+        {
+            var eventWithemptyIdentifiers = new OdpEvent("t3", "a3",
+                new Dictionary<string, string>(),
+                new Dictionary<string, object>
+                {
+                    {
+                        "data1", $"data1-value1-1"
+                    },
+                    {
+                        "data2", 1
+                    },
+                });
+            var eventWithNullIdentifiers = new OdpEvent("t3", "a3",
+                null, new Dictionary<string, object>
+                {
+                    {
+                        "data1", $"data1-value1-1"
+                    },
+                    {
+                        "data2", 1
+                    },
+                });
+            var eventManager = new OdpEventManager.Builder().
+                WithOdpEventApiManager(_mockApiManager.Object).
+                WithLogger(_mockLogger.Object).
+                Build();
+            eventManager.UpdateSettings(_odpConfig);
+
+            eventManager.SendEvent(eventWithemptyIdentifiers);
+            eventManager.SendEvent(eventWithNullIdentifiers);
+
+            _mockLogger.Verify(l => l.Log(LogLevel.ERROR, Constants.ODP_INVALID_DATA_MESSAGE),
+                Times.Exactly(2));
+        }
+
         [Test]
         public void ShouldAddAdditionalInformationToEachEvent()
         {

OptimizelySDK/Odp/Constants.cs

@@ -1,5 +1,5 @@
 /* 
- * Copyright 2022 Optimizely
+ * Copyright 2022-2023 Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -65,7 +65,7 @@ public static class Constants
         /// <summary>
         /// Default message to log when an ODP Event contains invalid data
         /// </summary>
-        public const string ODP_INVALID_DATA_MESSAGE = "ODP data is not valid.";
+        public const string ODP_INVALID_DATA_MESSAGE = "ODP event send failed.";
 
         /// <summary>
         /// Default message to log when sending ODP event fails

OptimizelySDK/Odp/Entity/OdpEvent.cs

@@ -1,5 +1,5 @@
 /* 
- * Copyright 2022 Optimizely
+ * Copyright 2022-2023 Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -34,7 +34,7 @@ public class OdpEvent
         public string Action { get; }
 
         /// <summary>
-        /// Key-value map of user identifiers
+        /// Dictionary for identifiers. The caller must provide at least one key-value pair.
         /// </summary>
         public Dictionary<string, string> Identifiers { get; }
 

OptimizelySDK/Odp/IOdpManager.cs

@@ -1,5 +1,5 @@
 /* 
- * Copyright 2022 Optimizely
+ * Copyright 2022-2023 Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -51,7 +51,7 @@ public interface IOdpManager
         /// </summary>
         /// <param name="type">Type of event (typically `fullstack` from server-side SDK events)</param>
         /// <param name="action">Subcategory of the event type</param>
-        /// <param name="identifiers">Key-value map of user identifiers</param>
+        /// <param name="identifiers">Dictionary for identifiers. The caller must provide at least one key-value pair.</param>
         /// <param name="data">Event data in a key-value pair format</param>
         void SendEvent(string type, string action, Dictionary<string, string> identifiers,
             Dictionary<string, object> data

OptimizelySDK/Odp/OdpEventManager.cs

@@ -296,7 +296,7 @@ public void SendEvent(OdpEvent odpEvent)
                 return;
             }
 
-            if (InvalidDataFound(odpEvent.Data))
+            if (InvalidDataFound(odpEvent.Data) || !IsIdentifiersValid(odpEvent.Identifiers))
             {
                 _logger.Log(LogLevel.ERROR, Constants.ODP_INVALID_DATA_MESSAGE);
                 return;
@@ -380,6 +380,16 @@ public void UpdateSettings(OdpConfig odpConfig)
             }
         }
 
+        /// <summary>
+        /// ODP event identifiers should not be null or empty
+        /// </summary>
+        /// <param name="Identifiers">Identifiers to be analyzed</param>
+        /// <returns>True if identifiers dictionary is not null or empty otherwise False</returns>
+        private bool IsIdentifiersValid(Dictionary<string, string> Identifiers)
+        {
+            return Identifiers?.Count > 0;
+        }
+
         /// <summary>
         /// ODP event data has invalid types
         /// </summary>

OptimizelySDK/Odp/OdpManager.cs

@@ -116,7 +116,7 @@ public void IdentifyUser(string userId)
         /// </summary>
         /// <param name="type">Type of event (typically `fullstack` from server-side SDK events)</param>
         /// <param name="action">Subcategory of the event type</param>
-        /// <param name="identifiers">Key-value map of user identifiers</param>
+        /// <param name="identifiers">Dictionary for identifiers. The caller must provide at least one key-value pair.</param>
         /// <param name="data">Event data in a key-value pair format</param>
         public void SendEvent(string type, string action, Dictionary<string, string> identifiers,
             Dictionary<string, object> data

OptimizelySDK/Optimizely.cs

@@ -1356,7 +1356,7 @@ internal void IdentifyUser(string userId)
         /// </summary>
         /// <param name="type">Type of event (typically `fullstack` from server-side SDK events)</param>
         /// <param name="action">Subcategory of the event type</param>
-        /// <param name="identifiers">Key-value map of user identifiers</param>
+        /// <param name="identifiers">Dictionary for identifiers. The caller must provide at least one key-value pair.</param>
         /// <param name="data">Event data in a key-value pair format</param>
         public void SendOdpEvent(string type, string action, Dictionary<string, string> identifiers,
             Dictionary<string, object> data