Merge pull request #355 from Countly/extended_array_support

feat: add array support to the user properties

Author: turtledreams

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## XX.XX.XX
-* Added mixed type of immutable lists, arrays to client given segmentations
+* ! Minor breaking change ! Unsupported types for user properties will now be omitted, they won't be converted to strings.
+
+* Added support for mixed type of immutable lists, arrays to client given segmentations and user properties.
+* Added array, list and JSONArray support to the user properties.
+
 * Mitigated issues where:
   * session was ending regardless of manual control after without merge, not anymore.
   * session was not starting even if consent is not required and automatic sessions are enabled after without merge, not anymore.

sdk/src/androidTest/java/ly/count/android/sdk/DeviceIdTests.java

@@ -303,7 +303,7 @@ public void sessionDurationScenario_1() throws InterruptedException {
         assertEquals(5, TestUtils.getCurrentRQ().length);
 
         TestUtils.validateRequest("ff_merge", TestUtils.map("old_device_id", "1234"), 1);
-        TestUtils.validateRequest("ff_merge", TestUtils.map("user_details", "{\"custom\":{\"prop2\":\"123\",\"prop1\":\"string\",\"prop3\":\"false\"}}"), 2);
+        TestUtils.validateRequest("ff_merge", TestUtils.map("user_details", "{\"custom\":{\"prop2\":123,\"prop1\":\"string\",\"prop3\":false}}"), 2);
         ModuleSessionsTests.validateSessionEndRequest(3, 3, "ff_merge");
 
         Thread.sleep(1000);
@@ -334,9 +334,9 @@ public void sessionDurationScenario_1() throws InterruptedException {
 
         assertEquals(9, TestUtils.getCurrentRQ().length);
 
-        TestUtils.validateRequest("ff", TestUtils.map("user_details", "{\"custom\":{\"prop4\":\"[sd]\"}}"), 5);
-        TestUtils.validateRequest("ff", TestUtils.map("user_details", "{\"custom\":{\"prop6\":\"{key=123}\",\"prop5\":\"{key=value}\",\"prop7\":\"{key=false}\"}}"), 6);
-        TestUtils.validateRequest("ff", TestUtils.map("user_details", "{\"custom\":{\"prop2\":\"456\",\"prop1\":\"string_a\",\"prop3\":\"true\"}}"), 7);
+        TestUtils.validateRequest("ff", TestUtils.map("user_details", "{\"custom\":{\"prop4\":[\"sd\"]}}"), 5);
+        TestUtils.validateRequest("ff", TestUtils.map("user_details", "{\"custom\":{}}"), 6);
+        TestUtils.validateRequest("ff", TestUtils.map("user_details", "{\"custom\":{\"prop2\":456,\"prop1\":\"string_a\",\"prop3\":true}}"), 7);
 
         TestUtils.validateRequest("ff_merge", TestUtils.map("old_device_id", "ff"), 8);
     }

sdk/src/androidTest/java/ly/count/android/sdk/ModuleUserProfileTests.java

@@ -2,17 +2,22 @@
 
 import androidx.test.core.app.ApplicationProvider;
 import androidx.test.ext.junit.runners.AndroidJUnit4;
+import java.util.Arrays;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.Random;
 import java.util.concurrent.ConcurrentHashMap;
+import org.json.JSONArray;
 import org.json.JSONException;
 import org.json.JSONObject;
 import org.junit.After;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
+import org.mockito.Mockito;
+import org.mockito.internal.util.collections.Sets;
 
 @RunWith(AndroidJUnit4.class)
 public class ModuleUserProfileTests {
@@ -514,7 +519,7 @@ public void internalLimit_setProperties() throws JSONException {
                 ModuleUserProfile.NAME_KEY, "name",
                 ModuleUserProfile.PICTURE_KEY, "picture"
             ), TestUtils.map(
-                "cu", "23", // because in user profiles, all values are stored as strings
+                "cu", 23, // because in user profiles, all values are stored as strings
                 "ha", "black")
         );
     }
@@ -567,12 +572,11 @@ public void internalLimit_setProperties_maxValueSize() throws JSONException {
                 ModuleUserProfile.PICTURE_KEY, "picture"
             ), TestUtils.map(
                 "custom1", "va", // because in user profiles, all values are stored as strings
-                "custom2", "23",
+                "custom2", 23,
                 "hair", "bl",
-                "custom3", "1234",
-                "custom4", "1234.5",
-                "custom5", "true",
-                "custom6", obj.toString()) // toString() is called on non-String values
+                "custom3", 1234,
+                "custom4", 1234.5,
+                "custom5", true)
         );
     }
 
@@ -613,7 +617,7 @@ public void internalLimit_setProperties_maxSegmentationValues() throws JSONExcep
         Countly.sharedInstance().userProfile().setProperties(TestUtils.map("a", "b", "c", "d", "f", 5, "level", 45, "age", 101));
         Countly.sharedInstance().userProfile().save();
 
-        validateUserProfileRequest(TestUtils.map(), TestUtils.map("f", "5", "age", "101"));
+        validateUserProfileRequest(TestUtils.map(), TestUtils.map("f", 5, "age", 101));
     }
 
     /**
@@ -694,6 +698,193 @@ public void setUserProperties_null() throws JSONException {
         validateUserProfileRequest(new HashMap<>(), new HashMap<>());
     }
 
+    /**
+     * "setProperties" with Array properties
+     * Validate that all primitive types arrays are successfully recorded
+     * And validate that Object arrays are not recorded
+     * But Generic type of Object array which its values are only primitive types are recorded
+     *
+     * @throws JSONException if the JSON is not valid
+     */
+    @Test
+    public void setProperties_validateSupportedArrays() throws JSONException {
+        int[] arr = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 };
+        boolean[] arrB = { true, false, true, false, true, false, true, false, true, false };
+        String[] arrS = { "1", "2", "3", "4", "5", "6", "7", "8", "9", "10" };
+        long[] arrL = { Long.MAX_VALUE, Long.MIN_VALUE };
+        double[] arrD = { Double.MAX_VALUE, Double.MIN_VALUE };
+        Long[] arrLO = { Long.MAX_VALUE, Long.MIN_VALUE };
+        Double[] arrDO = { Double.MAX_VALUE, Double.MIN_VALUE };
+        Boolean[] arrBO = { Boolean.TRUE, Boolean.FALSE };
+        Integer[] arrIO = { Integer.MAX_VALUE, Integer.MIN_VALUE };
+        Object[] arrObj = { "1", 1, 1.1d, true, 1.1f, Long.MAX_VALUE };
+        Object[] arrObjStr = { "1", "1", "1.1d", "true", "1.1f", "Long.MAX_VALUE" };
+
+        CountlyConfig countlyConfig = TestUtils.createBaseConfig();
+        Countly countly = new Countly().init(countlyConfig);
+
+        Map<String, Object> userProperties = TestUtils.map(
+            "arr", arr,
+            "arrB", arrB,
+            "arrS", arrS,
+            "arrL", arrL,
+            "arrD", arrD,
+            "arrLO", arrLO,
+            "arrDO", arrDO,
+            "arrBO", arrBO,
+            "arrIO", arrIO,
+            "arrObj", arrObj,
+            "arrObjStr", arrObjStr
+        );
+
+        countly.userProfile().setProperties(userProperties);
+        countly.userProfile().save();
+
+        Map<String, Object> expectedCustomProperties = TestUtils.map(
+            "arr", new JSONArray(arr),
+            "arrB", new JSONArray(arrB),
+            "arrS", new JSONArray(arrS),
+            "arrL", new JSONArray(arrL),
+            "arrD", new JSONArray(arrD),
+            "arrLO", new JSONArray(arrLO),
+            "arrDO", new JSONArray(arrDO),
+            "arrBO", new JSONArray(arrBO),
+            "arrIO", new JSONArray(arrIO)
+        );
+
+        validateUserProfileRequest(new HashMap<>(), expectedCustomProperties);
+    }
+
+    /**
+     * "setProperties" with List properties
+     * Validate that all primitive types Lists are successfully recorded
+     * And validate that List of Objects is not recorded
+     * But Generic type of Object list which its values are only primitive types are recorded
+     *
+     * @throws JSONException if the JSON is not valid
+     */
+    @Test
+    public void setProperties_validateSupportedLists() throws JSONException {
+        List<Integer> arr = Arrays.asList(1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
+        List<Boolean> arrB = Arrays.asList(true, false, true, false, true, false, true, false, true, false);
+        List<String> arrS = Arrays.asList("1", "2", "3", "4", "5", "6", "7", "8", "9", "10");
+        List<Long> arrLO = Arrays.asList(Long.MAX_VALUE, Long.MIN_VALUE);
+        List<Double> arrDO = Arrays.asList(Double.MAX_VALUE, Double.MIN_VALUE);
+        List<Boolean> arrBO = Arrays.asList(Boolean.TRUE, Boolean.FALSE);
+        List<Integer> arrIO = Arrays.asList(Integer.MAX_VALUE, Integer.MIN_VALUE);
+        List<Object> arrObj = Arrays.asList("1", 1, 1.1d, true, Long.MAX_VALUE);
+        List<Object> arrObjStr = Arrays.asList("1", "1", "1.1d", "true", "Long.MAX_VALUE");
+
+        CountlyConfig countlyConfig = TestUtils.createBaseConfig();
+        Countly countly = new Countly().init(countlyConfig);
+
+        Map<String, Object> userProperties = TestUtils.map(
+            "arr", arr,
+            "arrB", arrB,
+            "arrS", arrS,
+            "arrLO", arrLO,
+            "arrDO", arrDO,
+            "arrBO", arrBO,
+            "arrIO", arrIO,
+            "arrObj", arrObj,
+            "arrObjStr", arrObjStr
+        );
+
+        countly.userProfile().setProperties(userProperties);
+        countly.userProfile().save();
+
+        Map<String, Object> expectedCustomProperties = TestUtils.map(
+            "arr", new JSONArray(arr),
+            "arrB", new JSONArray(arrB),
+            "arrS", new JSONArray(arrS),
+            "arrLO", new JSONArray(arrLO),
+            "arrDO", new JSONArray(arrDO),
+            "arrBO", new JSONArray(arrBO),
+            "arrIO", new JSONArray(arrIO),
+            "arrObjStr", new JSONArray(arrObjStr),
+            "arrObj", new JSONArray(arrObj)
+        );
+
+        validateUserProfileRequest(new HashMap<>(), expectedCustomProperties);
+    }
+
+    /**
+     * "setProperties" with JSONArray properties
+     * Validate that all primitive types JSONArrays are successfully recorded
+     * And validate and JSONArray of Objects is not recorded
+     *
+     * @throws JSONException if the JSON is not valid
+     */
+    @Test
+    public void setProperties_validateSupportedJSONArrays() throws JSONException {
+        JSONArray arr = new JSONArray(Arrays.asList(1, 2, 3, 4, 5, 6, 7, 8, 9, 10));
+        JSONArray arrB = new JSONArray(Arrays.asList(true, false, true, false, true, false, true, false, true, false));
+        JSONArray arrS = new JSONArray(Arrays.asList("1", "2", "3", "4", "5", "6", "7", "8", "9", "10"));
+        JSONArray arrL = new JSONArray(Arrays.asList(Long.MAX_VALUE, Long.MIN_VALUE));
+        JSONArray arrD = new JSONArray(Arrays.asList(Double.MAX_VALUE, Double.MIN_VALUE));
+        JSONArray arrBO = new JSONArray(Arrays.asList(Boolean.TRUE, Boolean.FALSE));
+        JSONArray arrIO = new JSONArray(Arrays.asList(Integer.MAX_VALUE, Integer.MIN_VALUE));
+        JSONArray arrObj = new JSONArray(Arrays.asList("1", 1, 1.1d, true, Long.MAX_VALUE));
+
+        CountlyConfig countlyConfig = TestUtils.createBaseConfig();
+        Countly countly = new Countly().init(countlyConfig);
+
+        Map<String, Object> userProperties = TestUtils.map(
+            "arr", arr,
+            "arrB", arrB,
+            "arrS", arrS,
+            "arrL", arrL,
+            "arrD", arrD,
+            "arrBO", arrBO,
+            "arrIO", arrIO,
+            "arrObj", arrObj
+        );
+
+        // Record event with the created segmentation
+        countly.userProfile().setProperties(userProperties);
+        countly.userProfile().save();
+
+        // Prepare expected segmentation with JSONArrays
+        Map<String, Object> expectedCustomProperties = TestUtils.map(
+            "arr", arr,
+            "arrB", arrB,
+            "arrS", arrS,
+            "arrL", arrL,
+            "arrD", arrD,
+            "arrBO", arrBO,
+            "arrIO", arrIO,
+            "arrObj", arrObj
+        );
+
+        validateUserProfileRequest(new HashMap<>(), expectedCustomProperties);
+    }
+
+    /**
+     * "setProperties" with invalid data types
+     * Validate that unsupported data types are not recorded
+     *
+     * @throws JSONException if the JSON is not valid
+     */
+    @Test
+    public void setProperties_unsupportedDataTypes() throws JSONException {
+        CountlyConfig countlyConfig = TestUtils.createBaseConfig();
+        countlyConfig.setEventQueueSizeToSend(1);
+        Countly countly = new Countly().init(countlyConfig);
+
+        Map<String, Object> userProperties = TestUtils.map(
+            "a", TestUtils.map(),
+            "b", TestUtils.json(),
+            "c", new Object(),
+            "d", Sets.newSet(),
+            "e", Mockito.mock(ModuleLog.class)
+        );
+
+        countly.userProfile().setProperties(userProperties);
+        countly.userProfile().save();
+
+        validateUserProfileRequest(new HashMap<>(), new HashMap<>());
+    }
+
     protected static void validateUserProfileRequest(String deviceId, int idx, int size, Map<String, Object> predefined, Map<String, Object> custom) throws JSONException {
         Map<String, String>[] RQ = TestUtils.getCurrentRQ();
         Assert.assertEquals(size, RQ.length);

sdk/src/main/java/ly/count/android/sdk/ModuleUserProfile.java

@@ -32,7 +32,7 @@ public class ModuleUserProfile extends ModuleBase {
     String picture;
     static String picturePath;//protected only for testing
     String gender;
-    Map<String, String> custom;
+    Map<String, Object> custom;
     Map<String, JSONObject> customMods;
     int byear = 0;
 
@@ -219,12 +219,15 @@ void modifyCustomData(String key, Object value, String mod) {
                 return;
             }
 
-            Object truncatedValue;
+            Object valueAdded;
             String truncatedKey = UtilsInternalLimits.truncateKeyLength(key, _cly.config_.sdkInternalLimits.maxKeyLength, _cly.L, "[ModuleUserProfile] modifyCustomData");
             if (value instanceof String) {
-                truncatedValue = UtilsInternalLimits.truncateValueSize((String) value, _cly.config_.sdkInternalLimits.maxValueSize, _cly.L, "[ModuleUserProfile] modifyCustomData");
+                valueAdded = UtilsInternalLimits.truncateValueSize((String) value, _cly.config_.sdkInternalLimits.maxValueSize, _cly.L, "[ModuleUserProfile] modifyCustomData");
+            } else if (UtilsInternalLimits.isSupportedDataType(value)) {
+                valueAdded = value;
             } else {
-                truncatedValue = value;
+                L.w("[ModuleUserProfile] modifyCustomData, provided an unsupported type for key: [" + key + "], value: [" + value + "], type: [" + value.getClass().getSimpleName() + "], mod: [" + mod + "], omitting call");
+                return;
             }
 
             if (customMods == null) {
@@ -234,14 +237,14 @@ void modifyCustomData(String key, Object value, String mod) {
             JSONObject ob;
             if (!mod.equals("$pull") && !mod.equals("$push") && !mod.equals("$addToSet")) {
                 ob = new JSONObject();
-                ob.put(mod, truncatedValue);
+                ob.put(mod, valueAdded);
             } else {
                 if (customMods.containsKey(truncatedKey)) {
                     ob = customMods.get(truncatedKey);
                 } else {
                     ob = new JSONObject();
                 }
-                ob.accumulate(mod, truncatedValue);
+                ob.accumulate(mod, valueAdded);
             }
             customMods.put(truncatedKey, ob);
             isSynced = false;
@@ -264,7 +267,7 @@ void setPropertiesInternal(@NonNull Map<String, Object> data) {
 
         //todo recheck if in the future these can be <String, Object>
         Map<String, String> dataNamedFields = new HashMap<>();
-        Map<String, String> dataCustomFields = new HashMap<>();
+        Map<String, Object> dataCustomFields = new HashMap<>();
 
         for (Map.Entry<String, Object> entry : data.entrySet()) {
             String key = entry.getKey();
@@ -297,7 +300,11 @@ void setPropertiesInternal(@NonNull Map<String, Object> data) {
 
             if (!isNamed) {
                 String truncatedKey = UtilsInternalLimits.truncateKeyLength(key, _cly.config_.sdkInternalLimits.maxKeyLength, _cly.L, "[ModuleUserProfile] setPropertiesInternal");
-                dataCustomFields.put(truncatedKey, value.toString());
+                if (UtilsInternalLimits.isSupportedDataType(value)) {
+                    dataCustomFields.put(truncatedKey, value);
+                } else {
+                    L.w("[ModuleUserProfile] setPropertiesInternal, provided an unsupported type for key: [" + key + "], value: [" + value + "], type: [" + value.getClass().getSimpleName() + "], omitting call");
+                }
             }
         }
 

sdk/src/main/java/ly/count/android/sdk/UtilsInternalLimits.java

@@ -351,6 +351,18 @@ private static boolean isSupportedDataTypeBasic(@Nullable Object value) {
         return value instanceof String || value instanceof Integer || value instanceof Double || value instanceof Boolean || value instanceof Float || value instanceof Long;
     }
 
+    /**
+     * This function currently validates below segmentations:
+     * - Event segmentations (custom ones not internal keys)
+     * - Crash segmentations
+     * - View segmentations
+     * - User profile custom properties
+     * - User profile custom properties modifiers
+     * - Feedback widgets' results
+     *
+     * @param value to check
+     * @return true if the value is a supported data type
+     */
     static boolean isSupportedDataType(@Nullable Object value) {
         if (isSupportedDataTypeBasic(value)) {
             return true;