Merge pull request #519 from Countly/session_user_props

Save user props before session calls

Author: arifBurakDemiray

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 25.4.6
+* Updated user properties caching mechanism according to sessions.
+
 ## 25.4.5
 * Added a new config flag `setUseSerialExecutor(boolean useSerial)` for selecting immediate request executor type.
 * Added a new config option `setWebviewDisplayOption(WebViewDisplayOption)` to control how Content and Feedback Widgets are displayed. 

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

@@ -120,6 +120,95 @@ public void eventSaveScenario_changeDeviceIDWithoutMerge() throws JSONException
         ModuleUserProfileTests.validateUserProfileRequest(2, 3, TestUtils.map(), TestUtils.map("theme", "light_mode"));
     }
 
+    /**
+     * Related user properties should not be saved with session calls,
+     * call order, user property before session, begin session, user property after begin session, update session, user property after update session, end session
+     * generated request order begin_session  + update_session + user properties + end_session
+     * manual sessions are enabled
+     * UPDATE: session calls now trigger saving properties like events as well
+     * UPDATED_REQUEST_ORDER: user property before session + begin_session  + user property after begin session + update_session + user property after update session + end_session
+     */
+    @Test
+    public void eventSaveScenario_sessionCallsTriggersSave_M() throws JSONException, InterruptedException {
+        Countly countly = new Countly().init(TestUtils.createBaseConfig().enableManualSessionControl().setTrackOrientationChanges(false));
+
+        TestUtils.assertRQSize(0);
+        countly.userProfile().setProperty("before_session", true);
+
+        countly.sessions().beginSession();
+        TestUtils.assertRQSize(2); // only begin session request, UPDATE: user property request before session
+        ModuleUserProfileTests.validateUserProfileRequest(0, 2, TestUtils.map(), TestUtils.map("before_session", true));
+        ModuleSessionsTests.validateSessionBeginRequest(1, TestUtils.commonDeviceId);
+
+        countly.userProfile().setProperty("after_begin_session", true);
+        TestUtils.assertRQSize(2); // still begin session, UPDATE: user property request after begin session
+        // no new user property request because it is validated along with begin session
+
+        Thread.sleep(2000);
+
+        countly.sessions().updateSession();
+        TestUtils.assertRQSize(4); // only begin session and update session requests, UPDATE: user property request after begin and update session
+
+        ModuleUserProfileTests.validateUserProfileRequest(2, 4, TestUtils.map(), TestUtils.map("after_begin_session", true));
+        ModuleSessionsTests.validateSessionUpdateRequest(3, 2, TestUtils.commonDeviceId);
+
+        countly.userProfile().setProperty("after_update_session", true);
+        TestUtils.assertRQSize(4); // still begin session and update session requests
+        // no new user property request because it is validated along with update session
+        Thread.sleep(2000);
+
+        countly.sessions().endSession();
+        TestUtils.assertRQSize(6); // begin, update, user properties and end session requests
+        ModuleUserProfileTests.validateUserProfileRequest(4, 6, TestUtils.map(), TestUtils.map("after_update_session", true));
+        ModuleSessionsTests.validateSessionEndRequest(5, 2, TestUtils.commonDeviceId);
+    }
+
+    /**
+     * Related user properties should be saved with automatic session calls,
+     * call order, user property before session, user property after begin session, session, user property after update session
+     * generated request order user_properties + begin_session  + user_properties + update_session + user properties + end_session
+     */
+    @Test
+    public void eventSaveScenario_sessionCallsTriggersSave_A() throws JSONException, InterruptedException {
+        CountlyConfig config = TestUtils.createBaseConfig(TestUtils.getContext()).setTrackOrientationChanges(false);
+        TestLifecycleObserver testLifecycleObserver = new TestLifecycleObserver();
+        config.lifecycleObserver = testLifecycleObserver;
+        config.setUpdateSessionTimerDelay(3);
+        Countly countly = new Countly().init(config);
+
+        TestUtils.assertRQSize(0);
+        countly.userProfile().setProperty("before_session", true);
+
+        testLifecycleObserver.bringToForeground();
+        countly.onStart(null);
+
+        TestUtils.assertRQSize(2);
+        ModuleUserProfileTests.validateUserProfileRequest(0, 2, TestUtils.map(), TestUtils.map("before_session", true));
+        ModuleSessionsTests.validateSessionBeginRequest(1, TestUtils.commonDeviceId);
+
+        countly.userProfile().setProperty("after_begin_session", true);
+        TestUtils.assertRQSize(2);
+
+        Thread.sleep(3000);
+
+        TestUtils.assertRQSize(4);
+
+        ModuleUserProfileTests.validateUserProfileRequest(2, 4, TestUtils.map(), TestUtils.map("after_begin_session", true));
+        ModuleSessionsTests.validateSessionUpdateRequest(3, 3, TestUtils.commonDeviceId);
+
+        countly.userProfile().setProperty("after_update_session", true);
+        TestUtils.assertRQSize(4);
+
+        Thread.sleep(2000);
+
+        testLifecycleObserver.goToBackground();
+        countly.onStop();
+
+        TestUtils.assertRQSize(6);
+        ModuleUserProfileTests.validateUserProfileRequest(4, 6, TestUtils.map(), TestUtils.map("after_update_session", true));
+        ModuleSessionsTests.validateSessionEndRequest(5, 2, TestUtils.commonDeviceId);
+    }
+
     /**
      * 1. 200_CNR_A
      * Init SDK

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

@@ -60,6 +60,8 @@ void beginSessionInternal() {
         String preparedMetrics = deviceInfo.getMetrics(_cly.context_, metricOverride, L);
         sessionRunning = true;
         prevSessionDurationStartTime_ = System.currentTimeMillis();
+        _cly.moduleUserProfile.saveInternal();
+
         requestQueueProvider.beginSession(_cly.moduleLocation.locationDisabled, _cly.moduleLocation.locationCountryCode, _cly.moduleLocation.locationCity, _cly.moduleLocation.locationGpsCoordinates, _cly.moduleLocation.locationIpAddress, preparedMetrics);
 
         if (_cly.moduleViews.trackOrientationChanges) {
@@ -85,6 +87,8 @@ void updateSessionInternal() {
         }
 
         if (!_cly.disableUpdateSessionRequests_) {
+            _cly.moduleUserProfile.saveInternal();
+
             requestQueueProvider.updateSession(roundedSecondsSinceLastSessionDurationUpdate());
         }
     }