SDK Behavior Settings #Tests

android/build.gradle

@@ -38,6 +38,6 @@ android {
 }
 
 dependencies {
-    implementation 'ly.count.android:sdk:25.4.1'
+    implementation 'ly.count.android:sdk:25.4.2'
     implementation 'com.google.firebase:firebase-messaging:24.0.3'
 }

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

@@ -72,6 +72,7 @@ public class CountlyFlutterPlugin implements MethodCallHandler, FlutterPlugin, A
     private final String COUNTLY_FLUTTER_SDK_NAME_NO_PUSH = "dart-flutterbnp-android";
 
     private final boolean BUILDING_WITH_PUSH_DISABLED = false;
+    private static final int DATA_SCHEMA_VERSIONS = 4;
 
     public void notifyPublicChannelRCDL(RequestResult downloadResult, String error, boolean fullValueUpdate, Map<String, RCData> downloadedValues, Integer requestID) {
         Map<String, Object> data = new HashMap<>();
@@ -1408,6 +1409,26 @@ else if ("getRequestQueue".equals(call.method)) {
                 CountlyStore countlyStore = new CountlyStore(context, new ModuleLog());
                 countlyStore.addRequest(args.getString(0), true);
                 result.success("storeRequest: success");
+            } else if ("setServerConfig".equals(call.method)) {
+                CountlyStore countlyStore = new CountlyStore(context, new ModuleLog());
+                JSONObject jsonObject = args.getJSONObject(0);
+                countlyStore.setServerConfig(jsonObject.toString());
+                // Why this added here, it is that because when it is set something in storage
+                // sdk assumes that it is an older version so it start migrations that needs to be done
+                // but in this case we only want to use setting server config and do not want migrations
+                // to mess up our process flow. So in here we are setting it to latest known to get away with it.
+                // Normally in a fresh install migrations are first to run and they run once.
+                countlyStore.setDataSchemaVersion(DATA_SCHEMA_VERSIONS);
+                result.success("setServerConfig: success");
+            } else if ("getServerConfig".equals(call.method)) {
+                CountlyStore countlyStore = new CountlyStore(context, new ModuleLog());
+                String sc = countlyStore.getServerConfig();
+                Map<String, Object> serverConfigMap = new HashMap<>();
+                try {
+                    serverConfigMap = toMap(new JSONObject(sc));
+                } catch (JSONException ignored) {
+                }
+                result.success(serverConfigMap);
             } else if ("addDirectRequest".equals(call.method)) {
                 JSONObject jsonObject = args.getJSONObject(0);
                 Map<String, String> requestMap = new HashMap<>();
@@ -1420,7 +1441,10 @@ else if ("getRequestQueue".equals(call.method)) {
             } else if ("halt".equals(call.method)) {
                 Countly.sharedInstance().halt();
                 result.success("halt: success");
-            } else if ("enterContentZone".equals(call.method)) {
+            } 
+            //------------------End------------------------------------
+
+            else if ("enterContentZone".equals(call.method)) {
                 Countly.sharedInstance().contents().enterContentZone();
                 result.success(null);
             } else if ("exitContentZone".equals(call.method)) {
@@ -1430,7 +1454,6 @@ else if ("getRequestQueue".equals(call.method)) {
                 Countly.sharedInstance().contents().refreshContentZone();
                 result.success(null);
             }
-            //------------------End------------------------------------
 
             else {
                 result.notImplemented();

example/integration_test/sbs_tests/SBS_000_base_test.dart

@@ -0,0 +1,31 @@
+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';
+import 'sbs_utils.dart';
+
+///This test calls all features possible
+///It is base test, tries to show how features working without SBS and defaults
+void main() {
+  IntegrationTestWidgetsFlutterBinding.ensureInitialized();
+  testWidgets('SBS_000_base', (WidgetTester tester) async {
+    List<Map<String, List<String>>> requestArray = <Map<String, List<String>>>[];
+    createServerWithConfig(requestArray, {});
+    // Initialize the SDK
+    CountlyConfig config = CountlyConfig('http://0.0.0.0:8080', APP_KEY).enableManualSessionHandling().setLoggingEnabled(true);
+    await Countly.initWithConfig(config);
+
+    await callAllFeatures();
+
+    List<String> RQ = await getRequestQueue();
+    List<String> EQ = await getEventQueue();
+    expect(RQ.length, 0);
+    expect(EQ.length, 0);
+    validateRequestCounts({'events': 3, 'location': 1, 'crash': 2, 'begin_session': 1, 'consent': 0, 'end_session': 1, 'session_duration': 2, 'apm': 2, 'user_details': Platform.isIOS ? 2 : 1}, requestArray);
+    validateInternalEventCounts({'orientation': 1, 'view': 6, 'nps': 1}, requestArray);
+    validateImmediateCounts({'hc': 1, 'sc': 1, 'feedback': 1, 'queue': 2, 'ab': 1, 'ab_opt_out': 1, 'rc': 1}, requestArray);
+  });
+}

example/integration_test/sbs_tests/SBS_200A_test.dart

@@ -0,0 +1,119 @@
+import 'dart:convert';
+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';
+import 'sbs_utils.dart';
+
+void main() {
+  IntegrationTestWidgetsFlutterBinding.ensureInitialized();
+  testWidgets('SBS_200A_test', (WidgetTester tester) async {
+    List<Map<String, List<String>>> requestArray = <Map<String, List<String>>>[];
+    createServerWithConfig(requestArray, {
+      'v': 1,
+      't': 1750748806695,
+      'c': {'lkl': 5, 'lvs': 5, 'lsv': 5, 'lbc': 5, 'ltlpt': 5, 'ltl': 5, 'rcz': false, 'ecz': true, 'czi': 16, 'bom': false, 'dort': 1}
+    });
+
+    // Initialize the SDK
+    CountlyConfig config = CountlyConfig('http://0.0.0.0:8080', APP_KEY).enableManualSessionHandling().setLoggingEnabled(true);
+
+    await Countly.initWithConfig(config);
+    await Future.delayed(const Duration(seconds: 2));
+
+    storeRequest({'first': 'true', 'device_id': 'device_id_200C', 'app_key': APP_KEY, 'timestamp': DateTime.now().subtract(const Duration(minutes: 65)).millisecondsSinceEpoch.toString()});
+    storeRequest({'second': 'true', 'device_id': 'device_id_200C', 'app_key': APP_KEY, 'timestamp': DateTime.now().subtract(const Duration(minutes: 45)).millisecondsSinceEpoch.toString()});
+
+    List<Map<String, List<String>>> RQ = await getRequestQueueParsed();
+    validateRequestCounts({'first': 1, 'second': 1}, RQ); // validate that requests are stored correctly
+
+    await callAllFeatures(disableEnterContent: true);
+    RQ = await getRequestQueueParsed();
+    expect(RQ.length, 0);
+
+    validateRequestCounts({'first': 0, 'second': 1, 'events': Platform.isAndroid ? 3 : 2, 'location': 1, 'crash': 2, 'begin_session': 1, 'end_session': 1, 'session_duration': 2, 'apm': 2, 'user_details': Platform.isIOS ? 2 : 1, 'consent': 0}, requestArray);
+    // validate that first request is deleted from the queue because of dort: 1
+    validateInternalEventCounts({'orientation': 1, 'view': Platform.isAndroid ? 6 : 5, 'nps': 1}, requestArray); // 6 android
+    // enter content zone is not called, but a content zone request is sent it is because server config is set cz to true
+    validateImmediateCounts({'hc': 1, 'sc': 1, 'feedback': 1, 'queue': 2, 'ab': 1, 'ab_opt_out': 1, 'rc': 1}, requestArray);
+
+    for (var queryParams in requestArray) {
+      if (queryParams.containsKey('method') || queryParams.containsKey('hc') || queryParams.containsKey('second')) {
+        continue; // skip immediate requests
+      }
+      testCommonRequestParams(queryParams); // checks general params
+      if (queryParams.containsKey('apm')) {
+        Map<String, dynamic> apm = json.decode(queryParams['apm']![0]);
+        expect(apm['name'].toString().length <= 5, isTrue);
+      } else if (queryParams.containsKey('crash')) {
+        Map<String, dynamic> crash = json.decode(queryParams['crash']![0]);
+        Map<String, dynamic> crashDetails = crash['_custom'];
+        expect(crashDetails.length <= 5, isTrue);
+        List<String> logs = (crash['_logs'] as String).split('\n').where((line) => line.trim().isNotEmpty).toList();
+        expect(logs.length <= 5, isTrue);
+        for (var log in logs) {
+          expect(log.length <= 5, isTrue);
+        }
+        // iOS crash limits are not applied to the stack trace
+        if (Platform.isAndroid) {
+          List<String> stackTraces = crash['_error'].split('\n');
+          for (var stackTrace in stackTraces) {
+            expect(stackTrace.length <= 5, isTrue);
+          }
+        }
+
+        for (var key in crashDetails.keys) {
+          expect(key.length <= 5, isTrue);
+          expect(crashDetails[key].toString().length <= 5, isTrue);
+        }
+      } else if (queryParams.containsKey('events')) {
+        var eventRaw = json.decode(queryParams['events']![0]);
+        for (var event in eventRaw) {
+          validateInternalLimitsForEvents(event, 5, 5, 5);
+        }
+      } else if (queryParams.containsKey('user_details')) {
+        Map<String, dynamic> userDetails = json.decode(queryParams['user_details']![0]);
+        if (userDetails['custom'] != null && userDetails['custom'].length <= 2) {
+          // operators are not truncated with segmentation values limit
+          expect((userDetails['custom'].values.where((v) => v is! Map).length ?? 0) <= 5, isTrue);
+          expect(userDetails['custom']['speci'], 'somet');
+          expect(userDetails['custom']['not_s'], 'somet');
+        }
+
+        // in iOS user data requests are formed in a different request
+        if (userDetails['custom'].length > 2) {
+          checkUnchangingUserData(userDetails, 5, 5);
+        }
+
+        if (Platform.isAndroid || (Platform.isIOS && userDetails['custom'] == null)) {
+          checkUnchangingUserPropeties(userDetails, 5);
+        }
+      }
+    }
+
+    await Countly.instance.content.refreshContentZone(); // this will not affect because refresh disabled
+    validateImmediateCounts({'hc': 1, 'sc': 1, 'feedback': 1, 'queue': 2, 'ab': 1, 'ab_opt_out': 1, 'rc': 1}, requestArray);
+
+    await Countly.instance.content.exitContentZone();
+    requestArray.clear();
+
+    sbsServerDelay = 11;
+
+    await Countly.instance.sessions.beginSession();
+    await Countly.instance.sessions.endSession(); // this will not be backed off because backoff disabled
+    await Future.delayed(const Duration(seconds: 10)); // wait for sdk to process and get the result from server
+
+    await Countly.instance.attemptToSendStoredRequests(); // this will take affect and trigger sending the requests
+    await Future.delayed(const Duration(seconds: 2));
+
+    validateRequestCounts({'begin_session': 1, 'end_session': 1}, requestArray);
+    expect(await getServerConfig(), {
+      'v': 1,
+      't': 1750748806695,
+      'c': {'lkl': 5, 'lvs': 5, 'lsv': 5, 'lbc': 5, 'ltlpt': 5, 'ltl': 5, 'rcz': false, 'ecz': true, 'czi': 16, 'bom': false, 'dort': 1}
+    });
+  });
+}

example/integration_test/sbs_tests/SBS_200B_test.dart

@@ -0,0 +1,50 @@
+import 'package:countly_flutter/countly_flutter.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:integration_test/integration_test.dart';
+
+import '../utils.dart';
+import 'sbs_utils.dart';
+
+/// Currently it is not possible to test SCUI, we only test its value validations
+void main() {
+  IntegrationTestWidgetsFlutterBinding.ensureInitialized();
+  testWidgets('SBS_200B_test', (WidgetTester tester) async {
+    List<Map<String, List<String>>> requestArray = <Map<String, List<String>>>[];
+    createServerWithConfig(requestArray, {
+      'v': 1,
+      't': 1750748806695,
+      'c': {'tracking': false, 'scui': 1}
+    });
+
+    // Initialize the SDK
+    CountlyConfig config = CountlyConfig('http://0.0.0.0:8080', APP_KEY).enableManualSessionHandling().setLoggingEnabled(true);
+
+    await Countly.initWithConfig(config);
+    await Future.delayed(const Duration(seconds: 2));
+
+    await callAllFeatures(disableSend: true);
+    List<String> RQ = await getRequestQueue();
+    List<String> EQ = await getEventQueue();
+    expect(RQ.length, 0);
+    expect(EQ.length, 0);
+
+    await Countly.instance.attemptToSendStoredRequests();
+    // check queues are empty and all requests are sent
+    await Future.delayed(const Duration(seconds: 10));
+
+    validateRequestCounts({'events': 0, 'location': 0, 'crash': 0, 'begin_session': 0, 'end_session': 0, 'session_duration': 0, 'apm': 0, 'user_details': 0, 'consent': 0}, requestArray);
+    validateInternalEventCounts({}, requestArray); // 6 android
+    // enter content zone is not called, but a content zone request is sent it is because server config is set cz to true
+    validateImmediateCounts({'hc': 1, 'sc': 1, 'feedback': 1, 'queue': 2, 'rc': 1}, requestArray); // ab and ab_opt_out are not called because they are not immediate methods
+
+    expect(await getServerConfig(), {
+      'v': 1,
+      't': 1750748806695,
+      'c': {'tracking': false, 'scui': 1}
+    });
+
+    await Future.delayed(const Duration(seconds: 60));
+    // wait one minute and ensure no sc requests sent
+    validateImmediateCounts({'hc': 1, 'sc': 1, 'feedback': 1, 'queue': 4, 'rc': 1}, requestArray);
+  });
+}

example/integration_test/sbs_tests/SBS_200C_test.dart

@@ -0,0 +1,87 @@
+import 'dart:convert';
+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';
+import 'sbs_utils.dart';
+
+/// use auto sessions for showing session update
+void main() {
+  IntegrationTestWidgetsFlutterBinding.ensureInitialized();
+  testWidgets('SBS_200C_test', (WidgetTester tester) async {
+    List<Map<String, List<String>>> requestArray = <Map<String, List<String>>>[];
+    createServerWithConfig(requestArray, {
+      'v': 1,
+      't': 1750748806695,
+      'c': {'networking': false, 'cr': true, 'rqs': 5, 'sui': 10}
+    });
+
+    setServerConfig({
+      'v': 1,
+      't': 1750748806695,
+      'c': {'networking': false, 'cr': true, 'rqs': 5, 'sui': 10}
+    });
+
+    // Initialize the SDK
+    CountlyConfig config = CountlyConfig('http://0.0.0.0:8080', APP_KEY).setLoggingEnabled(true).setDeviceId('device_id_200C');
+
+    await Countly.initWithConfig(config);
+    await Future.delayed(const Duration(seconds: 2));
+
+    await callAllFeatures(disableConsentCall: true);
+
+    // Validate that networking is disabled and no requests are sent
+    expect(requestArray.length, 1); // only SC request should be sent
+    validateImmediateCounts({'sc': 1}, requestArray);
+    requestArray.clear(); // clear requestArray to validate the next requests
+
+    // Validate that consent is required and not given and all called features are not created a request
+    List<Map<String, List<String>>> rq = await getRequestQueueParsed();
+    validateRequestCounts({'consent': 1, 'location': 1}, rq);
+    Map<String, dynamic> expectedConsent = {'push': false, 'views': false, 'attribution': false, 'content': false, 'users': false, 'feedback': false, 'apm': false, 'location': false, 'remote-config': false, 'sessions': false, 'crashes': false, 'events': false};
+
+    if (Platform.isAndroid) {
+      expectedConsent['scrolls'] = false; // Android has scrolls, content, star-rating, clicks consents extra
+      expectedConsent['content'] = false;
+      expectedConsent['star-rating'] = false;
+      expectedConsent['clicks'] = false;
+    }
+
+    expect(jsonDecode(rq[0]['consent']![0]), expectedConsent);
+    expect(rq[1]['location']![0], '');
+    expect(rq.length, 2);
+
+    // Validate that session update occurs in every 10 seconds
+    await Countly.giveConsent(['sessions']);
+    // after giving this
+    // one consent, one begin session and two duration requests should be sent
+    // however this adds up to 6 request
+    // because our RQ limit is 5 the first consent request where all false is dropped
+
+    await Future.delayed(const Duration(seconds: 25));
+    rq = await getRequestQueueParsed();
+    expect(rq.length, 5); // 5 request at max could be
+    expect(requestArray.length, 0); // none request sent after sc request
+
+    validateRequestCounts({'begin_session': 1, 'session_duration': 2, 'consent': 1, 'location': 2}, rq); // one location is in begin_session
+    expect(rq[0]['location']![0], ''); // first request is location request from previous validations, it was consent request before but now location
+
+    expect(rq[1]['begin_session']![0], '1'); // second request is begin session request from auto sessions
+    expect(rq[1]['location']![0], ''); // show location is disabled because no consent given with tied to session request
+
+    expectedConsent['sessions'] = true; // now sessions consent is true
+    expect(jsonDecode(rq[2]['consent']![0]), expectedConsent); // second request is consent request
+
+    expect(rq[3]['session_duration']![0], '5'); // fourth request is session duration request
+    expect(rq[4]['session_duration']![0], '10'); // fifth request is session duration request and it is 10
+
+    expect(await getServerConfig(), {
+      'v': 1,
+      't': 1750748806695,
+      'c': {'networking': false, 'cr': true, 'rqs': 5, 'sui': 10}
+    });
+  });
+}