Merge pull request #555 from Countly/fix_up_events_save

Fix up events save

Author: arifBurakDemiray

CHANGELOG.md

@@ -1,3 +1,6 @@
+## XX.XX.XX
+* Improved user properties auto-save conditions to flush event queue with every user property call.
+
 ## 26.1.2
 * Added `CountlyInitProvider` ContentProvider to register activity lifecycle callbacks before `Application.onCreate()`. This ensures the SDK captures the current activity in single-activity frameworks (Flutter, React Native) and apps with deferred initialization.
 * Added `CountlyConfig.setInitialActivity(Activity)` as an explicit way for wrapper SDKs to provide the host activity during initialization.

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

@@ -308,8 +308,8 @@ public void sessionDurationScenario_1() throws InterruptedException, JSONExcepti
         countly.deviceId().changeWithoutMerge("ff"); // this will generate a request with "end_session", "session_duration" fields and reset duration + begin_session
         assertEquals(6, TestUtils.getCurrentRQ().length); // not 5 anymore, it will send orientation event as well
 
-        TestUtils.validateRequest("ff_merge", TestUtils.map("old_device_id", "1234"), 1);
-        ModuleEventsTests.validateEventInRQ("ff_merge", "[CLY]_orientation", null, 1, 0.0d, 0.0d, "_CLY_", "_CLY_", "_CLY_", "_CLY_", 2, -1, 0, 1);
+        ModuleEventsTests.validateEventInRQ(TestUtils.commonDeviceId, "[CLY]_orientation", null, 1, 0.0d, 0.0d, "_CLY_", "_CLY_", "_CLY_", "_CLY_", 1, -1, 0, 1);
+        TestUtils.validateRequest("ff_merge", TestUtils.map("old_device_id", "1234"), 2);
         ModuleUserProfileTests.validateUserProfileRequest("ff_merge", 3, 6, TestUtils.map(), TestUtils.map("prop2", 123, "prop1", "string", "prop3", false));
         ModuleSessionsTests.validateSessionEndRequest(4, 3, "ff_merge");
 

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

@@ -53,7 +53,8 @@ public void eventSaveScenario_manualSessions() throws JSONException {
         countly.events().recordEvent("test_event3");
 
         countly.userProfile().setProperty("theme", "light_mode");
-        TestUtils.assertRQSize(3); // no request is generated on the way, not 2 anymore because of orientation event
+        // UPDATE: setProperty will trigger saving events
+        TestUtils.assertRQSize(4); // no request is generated on the way, not 2 anymore because of orientation event
 
         countly.sessions().endSession();
         // begin_session + first user property request + 3 events + user property request with light_mode + end_session
@@ -84,7 +85,7 @@ public void eventSaveScenario_onTimer() throws InterruptedException, JSONExcepti
         countly.events().recordEvent("test_event3");
 
         countly.userProfile().setProperty("theme", "light_mode");
-        TestUtils.assertRQSize(1); // no request is generated on the way
+        TestUtils.assertRQSize(2); // no request is generated on the way + UPDATE: user properties will trigger saving events
 
         Thread.sleep(3000);
 
@@ -112,7 +113,8 @@ public void eventSaveScenario_changeDeviceIDWithoutMerge() throws JSONException
         countly.events().recordEvent("test_event3");
 
         countly.userProfile().setProperty("theme", "light_mode");
-        TestUtils.assertRQSize(1); // no request is generated on the way
+        // UPDATE: this will trigger saving events
+        TestUtils.assertRQSize(2); // no request is generated on the way
 
         countly.deviceId().changeWithoutMerge("new_device_id"); // this will begin a new session
 
@@ -287,12 +289,12 @@ public void UP_203_CNR_A_events() throws JSONException {
 
         countly.events().recordEvent("A");
         countly.events().recordEvent("B");
-        sendSameData(countly);
-        countly.events().recordEvent("C");
-        sendSameData(countly);
-        countly.events().recordEvent("D");
-        sendSameData(countly);
-        countly.events().recordEvent("E");
+        sendSameData(countly); // UPDATE: this will trigger A&B
+        countly.events().recordEvent("C"); // remaining UP
+        sendSameData(countly); // UPDATE: this will trigger C
+        countly.events().recordEvent("D"); // remaining UP
+        sendSameData(countly); // UPDATE: this will trigger D
+        countly.events().recordEvent("E"); // remaining UP
 
         TestUtils.assertRQSize(6);
 
@@ -402,10 +404,10 @@ public void UP_207_CNR_M() throws JSONException {
         countly.sessions().beginSession();
         countly.events().recordEvent("A");
         countly.events().recordEvent("B");
-        sendSameData(countly);
+        sendSameData(countly); // UPDATE: this will trigger A&B
         countly.sessions().endSession();
         countly.events().recordEvent("C");
-        sendUserData(countly);
+        sendUserData(countly); // UPDATE: this will trigger C
         countly.sessions().endSession();
         countly.deviceId().changeWithMerge("merge_id");
         sendSameData(countly);
@@ -424,9 +426,9 @@ public void UP_207_CNR_M() throws JSONException {
 
         ModuleSessionsTests.validateSessionEndRequest(3, null, TestUtils.commonDeviceId);
 
-        TestUtils.validateRequest("merge_id", TestUtils.map("old_device_id", TestUtils.commonDeviceId), 4);
+        ModuleEventsTests.validateEventInRQ("C", 4, 0, 1);
 
-        ModuleEventsTests.validateEventInRQ("merge_id", "C", 5, 0, 1);
+        TestUtils.validateRequest("merge_id", TestUtils.map("old_device_id", TestUtils.commonDeviceId), 5);
 
         validateUserDataRequest(6, 8, "4", "merge_id");
 
@@ -477,9 +479,10 @@ public void UP_208_CR_CG_M() throws JSONException {
         ModuleUserProfileTests.validateUserProfileRequest(3, 9, TestUtils.map(), TestUtils.map("a12345", "4"));
 
         ModuleSessionsTests.validateSessionEndRequest(4, null, TestUtils.commonDeviceId);
-        TestUtils.validateRequest("merge_id", TestUtils.map("old_device_id", TestUtils.commonDeviceId), 5);
 
-        ModuleEventsTests.validateEventInRQ("merge_id", "C", 6, 0, 1);
+        ModuleEventsTests.validateEventInRQ("C", 5, 0, 1);
+
+        TestUtils.validateRequest("merge_id", TestUtils.map("old_device_id", TestUtils.commonDeviceId), 6);
 
         validateUserDataRequest(7, 9, "4", "merge_id");
 

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

@@ -254,9 +254,7 @@ void modifyCustomData(String key, Object value, String mod) {
             }
 
             customMods.put(truncatedKey, ob);
-            applyUserPropertyCacheLimit(customMods);
-
-            isSynced = false;
+            onUserPropertiesChanged(customMods);
         } catch (JSONException e) {
             e.printStackTrace();
         }
@@ -332,9 +330,15 @@ void setPropertiesInternal(@NonNull Map<String, Object> data) {
         }
 
         custom.putAll(dataCustomFields);
-        applyUserPropertyCacheLimit(custom);
+        onUserPropertiesChanged(custom);
+    }
 
+    private void onUserPropertiesChanged(Map<String, ?> sourceMap) {
+        applyUserPropertyCacheLimit(sourceMap);
         isSynced = false;
+        if (storageProvider.getEventQueueSize() > 0) {
+            _cly.moduleRequestQueue.sendEventsIfNeeded(true);
+        }
     }
 
     private void applyUserPropertyCacheLimit(Map<String, ?> map) {