feat: np new version

Author: arifBurakDemiray

CHANGELOG.md

@@ -1,3 +1,14 @@
+## 24.11.2-np
+* Improved view tracking capabilities in iOS.
+
+* Mitigated issues where:
+  * On Android 35 and above, the navigation bar was overlapping with the content display in Android.
+  * An automatically closed autoStopped view's duration could have increased when opening new views in Android.
+  * A concurrent modification error could have happen when starting multiple stopped views in iOS.
+
+* Updated underlying Android SDK version to 24.7.7
+* Updated underlying iOS SDK version to 24.7.9
+
 ## 24.11.1-np
 * Added content configuration interface that has `setGlobalContentCallback` to get notified about content changes.
 * Added support for localization of content blocks.
@@ -10,7 +21,6 @@
 * Mitigated issues where:
   * Passing the global content callback was not possible in Android.
   * The user provided URLSessionConfiguration was not applied to direct requests in iOS.
-  * A concurrent modification error could have happen when starting multiple stopped views in iOS.
 
 * Updated underlying Android SDK version to 24.7.6
 * Updated underlying iOS SDK version to 24.7.8

android/build.gradle

@@ -38,5 +38,5 @@ android {
 }
 
 dependencies {
-    implementation 'ly.count.android:sdk:24.7.6'
+    implementation 'ly.count.android:sdk:24.7.7'
 }

android/src/main/java/ly/count/dart/countly_flutter/CountlyFlutterPlugin.java

@@ -62,7 +62,7 @@
  */
 public class CountlyFlutterPlugin implements MethodCallHandler, FlutterPlugin, ActivityAware, DefaultLifecycleObserver {
     private static final String TAG = "CountlyFlutterPlugin";
-    private final String COUNTLY_FLUTTER_SDK_VERSION_STRING = "24.11.1";
+    private final String COUNTLY_FLUTTER_SDK_VERSION_STRING = "24.11.2";
     private final String COUNTLY_FLUTTER_SDK_NAME = "dart-flutterb-android";
     private final String COUNTLY_FLUTTER_SDK_NAME_NO_PUSH = "dart-flutterbnp-android";
 

example/integration_test/experimental_tests/visibility_prev_names_recording_test.dart

@@ -48,7 +48,8 @@ void main() {
 
     // events and views in background and then after we come to foreground
     // depending on which view is started first after fg, we can have 9 or 10 events
-    expect(eventList.length, anyOf([9, 10]));
+    // But for android, we have 11 events or 12 because end view calls are not recorded to the RQ
+    expect(eventList.length, Platform.isAndroid ? anyOf([11, 12]) : anyOf([9, 10]));
 
     for (var entry in requestList.asMap().entries) {
       int index = entry.key;
@@ -64,13 +65,13 @@ void main() {
       // when going to bg
       if (index == 2) {
         expect(queryParams['end_session']?[0], '1');
-        expect(queryParams['session_duration']?[0], '2');
+        expect(queryParams['session_duration']?[0], anyOf(['2', '3']));
       }
       if (index == 1) {
         var rqEvents = jsonDecode(queryParams['events']![0]);
-        expect(rqEvents.length, 7);
+        expect(rqEvents.length, Platform.isAndroid ? 6 : 7);
 
-        // events nad views at initial fg
+        // events and views at initial fg
         checkEventAndViews(rqEvents, true);
         // events and views after going to bg and coming back to fg
         checkEventAndViews(
@@ -87,41 +88,60 @@ void main() {
 
 void checkEventAndViews(eventArray, isFGEvents) {
   if (isFGEvents) {
-    checkEvent(eventArray[0], 'E1_FG', true);
-    checkViewStart(eventArray[1], 'V1_FG', true);
-    checkEvent(eventArray[2], 'E2_FG', true);
-    checkViewStart((eventArray[3]), 'V2_FG', true);
-    checkEvent((eventArray[4]), 'E3_FG', true);
+    int index = 0;
+    if (Platform.isAndroid) {
+      // in Android 0th element is orientation event
+      index = 1;
+      expect(eventArray[0]['key'], "[CLY]_orientation");
+    }
+    checkEvent(eventArray[index], 'E1_FG', true);
+    checkViewStart(eventArray[index + 1], 'V1_FG', true);
+    checkEvent(eventArray[index + 2], 'E2_FG', true);
+    checkViewStart((eventArray[index + 3]), 'V2_FG', true);
+    checkEvent((eventArray[index + 4]), 'E3_FG', true);
     // closed in random order
-    try {
-      checkViewEnd((eventArray[5]), 'V2_FG', true);
-      checkViewEnd((eventArray[6]), 'V1_FG', true);
-    } catch (e) {
-      checkViewEnd((eventArray[5]), 'V1_FG', true);
-      checkViewEnd((eventArray[6]), 'V2_FG', true);
+    if (!Platform.isAndroid) {
+      try {
+        checkViewEnd((eventArray[5]), 'V2_FG', true);
+        checkViewEnd((eventArray[6]), 'V1_FG', true);
+      } catch (e) {
+        checkViewEnd((eventArray[5]), 'V1_FG', true);
+        checkViewEnd((eventArray[6]), 'V2_FG', true);
+      }
     }
   } else {
-    checkEvent(jsonDecode(eventArray[0]), 'E1_BG', false);
-    checkViewStart(jsonDecode(eventArray[1]), 'V1_BG', false);
-    checkEvent(jsonDecode(eventArray[2]), 'E2_BG', false);
-    checkViewStart(jsonDecode(eventArray[3]), 'V2_BG', false);
-    checkEvent(jsonDecode(eventArray[4]), 'E3_BG', false);
-    expect(jsonDecode(eventArray[5])['key'], '[CLY]_orientation');
-    checkViewEnd(jsonDecode(eventArray[6]), 'V2_BG', false);
+    int index = 0;
+    if (Platform.isAndroid) {
+      try {
+        checkViewEnd(jsonDecode(eventArray[index]), 'V2_FG', true);
+        checkViewEnd(jsonDecode(eventArray[index + 1]), 'V1_FG', true);
+      } catch (e) {
+        checkViewEnd(jsonDecode(eventArray[index]), 'V1_FG', true);
+        checkViewEnd(jsonDecode(eventArray[index + 1]), 'V2_FG', true);
+      }
+      index = 2;
+    }
+    checkEvent(jsonDecode(eventArray[index]), 'E1_BG', false);
+    checkViewStart(jsonDecode(eventArray[index + 1]), 'V1_BG', false);
+    checkEvent(jsonDecode(eventArray[index + 2]), 'E2_BG', false);
+    checkViewStart(jsonDecode(eventArray[index + 3]), 'V2_BG', false);
+    checkEvent(jsonDecode(eventArray[index + 4]), 'E3_BG', false);
+    expect(jsonDecode(eventArray[index + 5])['key'], '[CLY]_orientation');
+    checkViewEnd(jsonDecode(eventArray[index + 6]), 'V2_BG', false);
     // this part is random as autoStopped or normal view can start first
     try {
-      checkRestartedView(jsonDecode(eventArray[7]), 'V2_FG', true, false);
+      checkRestartedView(jsonDecode(eventArray[index + 7]), 'V2_FG', true, false);
 
-      expect(jsonDecode(eventArray[8])['segmentation']['name'], 'V2_FG');
-      expect(jsonDecode(eventArray[8])['segmentation']['fg_events'], false);
-      expect(jsonDecode(eventArray[8])['segmentation']['cly_v'], isNull);
-      expect(jsonDecode(eventArray[8])['segmentation']['visit'], isNull);
-      expect(jsonDecode(eventArray[8])['segmentation']['cly_pvn'], cvn_end);
+      expect(jsonDecode(eventArray[index + 8])['segmentation']['name'], 'V2_FG');
+      expect(jsonDecode(eventArray[index + 8])['segmentation']['fg_events'], false);
+      expect(jsonDecode(eventArray[index + 8])['segmentation']['cly_v'], isNull);
+      expect(jsonDecode(eventArray[index + 8])['segmentation']['visit'], isNull);
+      expect(jsonDecode(eventArray[index + 8])['segmentation']['cly_pvn'], cvn_end);
 
-      checkRestartedView(jsonDecode(eventArray[9]), 'V1_FG', true, false);
+      checkRestartedView(jsonDecode(eventArray[index + 9]), 'V1_FG', true, false);
     } catch (e) {
-      checkRestartedView(jsonDecode(eventArray[7]), 'V1_FG', true, false);
-      checkRestartedView(jsonDecode(eventArray[8]), 'V2_FG', true, false);
+      checkRestartedView(jsonDecode(eventArray[index + 7]), 'V1_FG', true, false);
+      checkRestartedView(jsonDecode(eventArray[index + 8]), 'V2_FG', true, false);
     }
   }
 }
@@ -138,7 +158,7 @@ void checkViewStart(view, name, isVisible) {
   expect(view['segmentation']['name'], name);
   expect(view['segmentation']['fg_events'], isVisible);
   expect(view['segmentation']['cly_v'], isVisible ? 1 : 0);
-  expect(view['segmentation']['visit'], 1);
+  expect(view['segmentation']['visit'], Platform.isAndroid ? '1' : 1);
   expect(view['segmentation']['cly_pvn'], cvn);
   cvn_end = cvn;
   cvn = name;
@@ -156,7 +176,7 @@ void checkRestartedView(view, name, isVisible, globalSegmentation) {
   expect(view['segmentation']['name'], name);
   expect(view['segmentation']['fg_events'], globalSegmentation);
   expect(view['segmentation']['cly_v'], isVisible ? 1 : 0);
-  expect(view['segmentation']['visit'], 1);
+  expect(view['segmentation']['visit'], Platform.isAndroid ? '1' : 1);
   expect(view['segmentation']['cly_pvn'], cvn);
   cvn_end = cvn;
   cvn = name;

example/integration_test/utils.dart

@@ -29,7 +29,7 @@ Future<List<String>> getEventQueue() async {
 void testCommonRequestParams(Map<String, List<String>> requestObject) {
   expect(requestObject['app_key']?[0], APP_KEY);
   expect(requestObject['sdk_name']?[0], "dart-flutterbnp-${Platform.isIOS ? "ios" : "android"}");
-  expect(requestObject['sdk_version']?[0], '24.11.1');
+  expect(requestObject['sdk_version']?[0], '24.11.2');
   expect(requestObject['av']?[0], Platform.isIOS ? '0.0.1' : '1.0.0');
   assert(requestObject['timestamp']?[0] != null);
 

example/integration_test/views_tests/auto_view_flow1_test.dart

@@ -0,0 +1,141 @@
+import 'dart:convert';
+import 'dart:math';
+import 'package:flutter_foreground_task/flutter_foreground_task.dart';
+import 'dart:io';
+
+import 'package:countly_flutter/countly_flutter.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:integration_test/integration_test.dart';
+import '../utils.dart';
+
+///
+/// This test is to check the flow of views is auto stopped and restarted
+/// and also when the app is in background and then comes to foreground
+/// and also to check if the previous view names are recorded
+///
+void main() {
+  IntegrationTestWidgetsFlutterBinding.ensureInitialized();
+  testWidgets('Start auto stopped views and stop views', (WidgetTester tester) async {
+    // Initialize the SDK
+    CountlyConfig config = CountlyConfig(SERVER_URL, APP_KEY);
+    await Countly.initWithConfig(config);
+
+    await Countly.instance.views.startView("V1");
+    await Countly.instance.views.startAutoStoppedView("V2");
+
+    FlutterForegroundTask.minimizeApp();
+    sleep(Duration(seconds: 2));
+
+    await Countly.instance.views.startAutoStoppedView("V4");
+    await Countly.instance.views.startView("V3");
+
+    sleep(Duration(seconds: 2));
+
+    FlutterForegroundTask.launchApp();
+    if (Platform.isIOS) {
+      printMessageMultipleTimes('waiting for 3 seconds, now go to foreground', 3);
+    }
+
+    sleep(Duration(seconds: 5));
+
+    // REQUESTS: begin session, events before going in to the background, and end session
+    // EVENTS: end view for V1, V2, start view of V4, end view for V4, start view V3, orientation, start view for V1, V2
+    List<String> requestList = await getRequestQueue();
+    List<String> eventList = await getEventQueue();
+
+    printQueues(requestList, eventList);
+    expect(requestList.length, Platform.isAndroid ? 4 : 3);
+    expect(eventList.length, Platform.isAndroid ? anyOf(8, 9) : 3); // 3 for iOS
+    validateBeginSessionRequest(requestList[0]); // validate begin session on 0th idx
+
+    Map<String, List<String>> queryParams = Uri.parse('?${requestList[1]}').queryParametersAll;
+    var rqEvents = jsonDecode(queryParams['events']![0]);
+    expect(rqEvents.length, Platform.isAndroid ? 3 : 4);
+    int index = 0;
+    if(Platform.isAndroid){
+      validateEvent("[CLY]_orientation", <String, dynamic>{'mode': 'portrait'}, eventGiven: rqEvents[index++]);
+    }
+    validateView("V1", true, true, viewGiven: rqEvents[index++]);
+    validateView("V2", false, true, viewGiven: rqEvents[index++]);
+    if(Platform.isIOS){
+      validateView("V1", false, false, viewGiven: rqEvents[index++]);
+      validateView("V2", false, false, viewGiven: rqEvents[index++]);
+    }
+
+    validateEndSessionRequest(requestList[2]); // validate end session on 2nd idx
+    if(Platform.isAndroid) {
+      validateBeginSessionRequest(requestList[3]); // validate begin session on 3rd idx
+    }
+
+    index = 0;
+    if (Platform.isAndroid) {
+      try {
+        validateView("V1", false, false, viewStr: eventList[index++]);
+        validateView("V2", false, false, viewStr: eventList[index++]);
+      } catch (e) {
+        index = 0;
+        validateView("V2", false, false, viewStr: eventList[index++]);
+        validateView("V1", false, false, viewStr: eventList[index++]);
+      }
+    }
+
+    validateView("V4", false, true, viewStr: eventList[index++]);
+    validateView("V4", false, false, viewStr: eventList[index++]);
+    validateView("V3", false, true, viewStr: eventList[index++]);
+    if(Platform.isAndroid){
+      validateEvent("[CLY]_orientation", <String, dynamic>{'mode': 'portrait'}, eventStr: eventList[index++]);
+    }
+
+    int iCached = index;
+    if (Platform.isAndroid) {
+      try {
+        validateView("V2", true, true, viewStr: eventList[index++]);
+        validateView("V2", false, false, viewStr: eventList[index++]);
+        validateView("V1", false, true, viewStr: eventList[index++]);
+      } catch (e) {
+        index = iCached;
+        validateView("V1", true, true, viewStr: eventList[index++]);
+        validateView("V2", false, true, viewStr: eventList[index++]);
+      }
+    }
+  });
+}
+
+void validateView(String name, bool start, bool visit, {String? viewStr, Map<String, dynamic>? viewGiven}) {
+  Map<String, dynamic> segmentation = <String, dynamic>{'name': name, 'segment': Platform.isAndroid ? 'Android' : 'iOS'};
+
+  if (visit) {
+    segmentation['visit'] = Platform.isAndroid ? '1': 1;
+  }
+  if (start) {
+    segmentation['start'] = Platform.isAndroid ? '1': 1;
+  }
+  validateEvent("[CLY]_view", segmentation, eventGiven: viewGiven, eventStr: viewStr);
+}
+
+void validateBeginSessionRequest(String request) {
+  Map<String, List<String>> queryParams = Uri.parse('?$request').queryParametersAll;
+  testCommonRequestParams(queryParams);
+
+  expect(queryParams['begin_session'], ['1']);
+  expect(queryParams['metrics'], isNotNull);
+}
+
+void validateEndSessionRequest(String request) {
+  Map<String, List<String>> queryParams = Uri.parse('?$request').queryParametersAll;
+  testCommonRequestParams(queryParams);
+
+  expect(queryParams['end_session'], ['1']);
+  expect(queryParams['metrics'], isNull);
+}
+
+void validateEvent(String key, Map<String, dynamic> segmentation, {String? eventStr, Map<String, dynamic>? eventGiven}) {
+  Map<String, dynamic> event = eventStr != null ? jsonDecode(eventStr) : eventGiven!;
+  print("================");
+  print(event);
+  expect(event['key'], key);
+  expect(segmentation.length, event['segmentation'].length);
+  for (var key in segmentation.keys) {
+    expect(event['segmentation'][key], segmentation[key]);
+  }
+}