Merge pull request #324 from Countly/events

turtledreams · web-flow · commit ee11af130b3e · 2025-01-31T17:52:43.000+09:00
Events Interface
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,16 @@
+## XX.XX.XX
+* Added 'event' interface for events methods which are
+  * recordEvent(String key, [Map<String, Object>? segmentation, int? count, int? sum, int? duration])
+  * startEvent(String key)
+  * endEvent(String key, [Map<String, Object>? segmentation, int? count, int? sum])
+  * cancelEvent(String key)
+* Added 'cancelEvent' to cancel a timed event, it is accesible through 'events' interface
+
+* Deprecated the following methods from the Countly
+  * 'recordEvent(options)', instead use 'events.recordEvent(key, [segmentation, count, sum, duration])
+  * 'startEvent(key)', instead use 'events.startEvent(key)'
+  * 'endEvent(options)', instead use 'events.endEvent(key, [segmentation, count, sum])'
+
 ## 25.1.0
 * Improved content size management for better adaptability across devices.
 * Resolved an issue where the action bar overlapped with the content display.
diff --git a/android/src/main/java/ly/count/dart/countly_flutter/CountlyFlutterPlugin.java b/android/src/main/java/ly/count/dart/countly_flutter/CountlyFlutterPlugin.java
@@ -513,6 +513,10 @@ public void run() {
                 String startEvent = args.getString(0);
                 Countly.sharedInstance().events().startEvent(startEvent);
                 result.success("startEvent for: " + startEvent);
+            } else if ("cancelEvent".equals(call.method)) {
+                String cancelEvent = args.getString(0);
+                Countly.sharedInstance().events().cancelEvent(cancelEvent);
+                result.success("cancelEvent for: " + cancelEvent);
             } else if ("endEvent".equals(call.method)) {
                 String key = args.getString(0);
                 int count = Integer.parseInt(args.getString(1));
diff --git a/example/integration_test/event_tests/event_interface_test.dart b/example/integration_test/event_tests/event_interface_test.dart
@@ -0,0 +1,116 @@
+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 'event_utils.dart';
+import 'dart:convert';
+import 'dart:io';
+
+void main() {
+  const int MAX_INT = -1 >>> 1;
+
+  IntegrationTestWidgetsFlutterBinding.ensureInitialized();
+  testWidgets('Init SDK record some events and check what is in the queues with new interface', (WidgetTester tester) async {
+    // Initialize the SDK
+    CountlyConfig config = CountlyConfig(SERVER_URL, APP_KEY).setLoggingEnabled(true);
+    await Countly.initWithConfig(config);
+
+    Map<String, Object> segmentation = {
+      'nar': 'uto',
+      'sasuke': MAX_INT,
+      'sakura': false,
+      'itachi': double.maxFinite,
+      'kakaski': double.minPositive,
+      'hashirama': -MAX_INT,
+      'tobi': {'obito': 'uchiha', 'zetsu': 'white'},
+      'stringList': ['value1', 'value2', 'value3'],
+      'intList': [1, 2, 3],
+      'doubleList': [1.1, 2.2, 3.3],
+      'boolList': [true, false, true],
+      'mixedList': ['value1', 2, 3.3, true],
+      'mapList': [
+        {'key1': 'value1', 'key2': 2},
+        {'key1': 'value2', 'key2': 3},
+        {'key1': 'value3', 'key2': 4}
+      ],
+    };
+    await Countly.instance.events.recordEvent('event');
+    await Countly.instance.events.recordEvent('event_s', segmentation);
+    await Countly.instance.events.recordEvent('event_s_c_s', segmentation, 23, 90.1);
+    await Countly.instance.events.recordEvent('event_s_c_s_d', segmentation, 98, 13.2, 123);
+
+    await Countly.instance.events.startEvent('timed_event');
+    await Future.delayed(const Duration(milliseconds: 250));
+    await Countly.instance.events.endEvent('timed_event', segmentation);
+
+    await Countly.instance.events.startEvent('timed_event_s_c_s');
+    await Future.delayed(const Duration(milliseconds: 250));
+    await Countly.instance.events.endEvent('timed_event_s_c_s', segmentation, 45, 65.6);
+
+    // Get request and event queues from native side
+    List<String> requestList = await getRequestQueue(); // List of strings
+    List<String> eventList = await getEventQueue(); // List of json objects
+
+    // Some logs for debugging
+    print('RQ: $requestList');
+    print('EQ: $eventList');
+    print('RQ length: ${requestList.length}');
+    print('EQ length: ${eventList.length}');
+
+    expect(requestList.length, 1);
+    expect(eventList.length, Platform.isAndroid ? 7 : 6);
+
+    // begin session
+    Map<String, List<String>> queryParams = Uri.parse("?" + requestList[0]).queryParametersAll;
+    testCommonRequestParams(queryParams);
+
+    int n = 0;
+    Map<String, dynamic> currentEvent;
+    if (Platform.isAndroid) {
+      currentEvent = json.decode(eventList[n]);
+      // 1. orientation event
+      expect("[CLY]_orientation", currentEvent['key']);
+      expect(1, currentEvent['count']);
+      n++;
+    }
+
+    Map<String, Object> expectedSegmentation = {
+      "sasuke": MAX_INT,
+      "sakura": false,
+      "mapList": [],
+      "intList": [1, 2, 3],
+      "doubleList": [1.1, 2.2, 3.3],
+      "boolList": [true, false, true],
+      "mixedList": ["value1", 2, 3.3, true],
+      "itachi": double.maxFinite,
+      "stringList": ["value1", "value2", "value3"],
+      "kakaski": double.minPositive,
+      "nar": "uto",
+      "hashirama": -MAX_INT,
+    };
+
+    // 2. event
+    currentEvent = json.decode(eventList[n++]);
+    validateEvent(event: currentEvent, key: 'event');
+
+    // 3. event_s
+    currentEvent = json.decode(eventList[n++]);
+    validateEvent(event: currentEvent, key: 'event_s', segmentation: expectedSegmentation);
+
+    // 4. event_s_c_s
+    currentEvent = json.decode(eventList[n++]);
+    validateEvent(event: currentEvent, key: 'event_s_c_s', segmentation: expectedSegmentation, count: 23, sum: 90.1);
+
+    // 5. event_s_c_s_d
+    currentEvent = json.decode(eventList[n++]);
+    validateEvent(event: currentEvent, key: 'event_s_c_s_d', segmentation: expectedSegmentation, count: 98, sum: 13.2, dur: 123);
+
+    // 6. timed_event
+    currentEvent = json.decode(eventList[n++]);
+    validateEvent(event: currentEvent, key: 'timed_event', segmentation: expectedSegmentation, isTimed: true);
+
+    // 7. timed_event_s_c_s
+    currentEvent = json.decode(eventList[n++]);
+    validateEvent(event: currentEvent, key: 'timed_event_s_c_s', segmentation: expectedSegmentation, count: 45, sum: 65.6, isTimed: true);
+  });
+}
diff --git a/example/integration_test/event_tests/event_test.dart b/example/integration_test/event_tests/event_test.dart
@@ -52,7 +52,7 @@ void main() {
 
     // 4. event_c_s
     currentEvent = json.decode(eventList[n++]);
-    validateEvent(event: currentEvent, key: event_c_s['key'] as String, count: event_c_s['count'] as int, sum: event_c_s['sum'] as int);
+    validateEvent(event: currentEvent, key: event_c_s['key'] as String, count: event_c_s['count'] as int, sum: event_c_s['sum'] as double);
 
     // 5. event_c_d
     currentEvent = json.decode(eventList[n++]);
@@ -64,35 +64,35 @@ void main() {
 
     // 7. event_c_s_d
     currentEvent = json.decode(eventList[n++]);
-    validateEvent(event: currentEvent, key: event_c_s_d['key'] as String, count: event_c_s_d['count'] as int, sum: event_c_s_d['sum'] as int, dur: event_c_s_d['duration'] as int);
+    validateEvent(event: currentEvent, key: event_c_s_d['key'] as String, count: event_c_s_d['count'] as int, sum: event_c_s_d['sum'] as double, dur: event_c_s_d['duration'] as int);
 
     // 8. event_c_s_se
     currentEvent = json.decode(eventList[n++]);
-    validateEvent(event: currentEvent, key: event_c_s_se['key'] as String, count: event_c_s_se['count'] as int, sum: event_c_s_se['sum'] as int, segmentation: expectedSegmentation);
+    validateEvent(event: currentEvent, key: event_c_s_se['key'] as String, count: event_c_s_se['count'] as int, sum: event_c_s_se['sum'] as double, segmentation: expectedSegmentation);
 
     // 9. event_c_d_se
     currentEvent = json.decode(eventList[n++]);
     validateEvent(event: currentEvent, key: event_c_d_se['key'] as String, count: event_c_d_se['count'] as int, dur: event_c_d_se['duration'] as int, segmentation: expectedSegmentation);
 
     // 10. event_c_s_d_se
     currentEvent = json.decode(eventList[n++]);
-    validateEvent(event: currentEvent, key: event_c_s_d_se['key'] as String, count: event_c_s_d_se['count'] as int, sum: event_c_s_d_se['sum'] as int, dur: event_c_s_d_se['duration'] as int, segmentation: expectedSegmentation);
+    validateEvent(event: currentEvent, key: event_c_s_d_se['key'] as String, count: event_c_s_d_se['count'] as int, sum: event_c_s_d_se['sum'] as double, dur: event_c_s_d_se['duration'] as int, segmentation: expectedSegmentation);
 
     // 11. event_s
     currentEvent = json.decode(eventList[n++]);
-    validateEvent(event: currentEvent, key: event_s['key'] as String, sum: event_s['sum'] as int);
+    validateEvent(event: currentEvent, key: event_s['key'] as String, sum: event_s['sum'] as double);
 
     // 12. event_s_d
     currentEvent = json.decode(eventList[n++]);
-    validateEvent(event: currentEvent, key: event_s_d['key'] as String, sum: event_s_d['sum'] as int, dur: event_s_d['duration'] as int);
+    validateEvent(event: currentEvent, key: event_s_d['key'] as String, sum: event_s_d['sum'] as double, dur: event_s_d['duration'] as int);
 
     // 13. event_s_se
     currentEvent = json.decode(eventList[n++]);
-    validateEvent(event: currentEvent, key: event_s_se['key'] as String, sum: event_s_se['sum'] as int, segmentation: expectedSegmentation);
+    validateEvent(event: currentEvent, key: event_s_se['key'] as String, sum: event_s_se['sum'] as double, segmentation: expectedSegmentation);
 
     // 14. event_s_d_se
     currentEvent = json.decode(eventList[n++]);
-    validateEvent(event: currentEvent, key: event_s_d_se['key'] as String, sum: event_s_d_se['sum'] as int, dur: event_s_d_se['duration'] as int, segmentation: expectedSegmentation);
+    validateEvent(event: currentEvent, key: event_s_d_se['key'] as String, sum: event_s_d_se['sum'] as double, dur: event_s_d_se['duration'] as int, segmentation: expectedSegmentation);
 
     // 15. event_d
     currentEvent = json.decode(eventList[n++]);
@@ -116,7 +116,7 @@ void main() {
 
     // 20. timed_event_c_s
     currentEvent = json.decode(eventList[n++]);
-    validateEvent(event: currentEvent, key: timed_event_c_s['key'] as String, count: 1, sum: timed_event_c_s['sum'] as int, isTimed: true);
+    validateEvent(event: currentEvent, key: timed_event_c_s['key'] as String, count: 1, sum: timed_event_c_s['sum'] as double, isTimed: true);
 
     // 21. timed_event_c_d
     currentEvent = json.decode(eventList[n++]);
@@ -128,35 +128,35 @@ void main() {
 
     // 23. timed_event_c_s_d
     currentEvent = json.decode(eventList[n++]);
-    validateEvent(event: currentEvent, key: timed_event_c_s_d['key'] as String, count: 1, sum: timed_event_c_s_d['sum'] as int, dur: timed_event_c_s_d['duration'] as int, isTimed: true);
+    validateEvent(event: currentEvent, key: timed_event_c_s_d['key'] as String, count: 1, sum: timed_event_c_s_d['sum'] as double, dur: timed_event_c_s_d['duration'] as int, isTimed: true);
 
     // 24. timed_event_c_s_se
     currentEvent = json.decode(eventList[n++]);
-    validateEvent(event: currentEvent, key: timed_event_c_s_se['key'] as String, count: 1, sum: timed_event_c_s_se['sum'] as int, segmentation: expectedSegmentation, isTimed: true);
+    validateEvent(event: currentEvent, key: timed_event_c_s_se['key'] as String, count: 1, sum: timed_event_c_s_se['sum'] as double, segmentation: expectedSegmentation, isTimed: true);
 
     // 25. timed_event_c_d_se
     currentEvent = json.decode(eventList[n++]);
     validateEvent(event: currentEvent, key: timed_event_c_d_se['key'] as String, count: 1, dur: timed_event_c_d_se['duration'] as int, segmentation: expectedSegmentation, isTimed: true);
 
     // 26. timed_event_c_s_d_se
     currentEvent = json.decode(eventList[n++]);
-    validateEvent(event: currentEvent, key: timed_event_c_s_d_se['key'] as String, count: 1, sum: timed_event_c_s_d_se['sum'] as int, dur: timed_event_c_s_d_se['duration'] as int, segmentation: expectedSegmentation, isTimed: true);
+    validateEvent(event: currentEvent, key: timed_event_c_s_d_se['key'] as String, count: 1, sum: timed_event_c_s_d_se['sum'] as double, dur: timed_event_c_s_d_se['duration'] as int, segmentation: expectedSegmentation, isTimed: true);
 
     // 27. timed_event_s
     currentEvent = json.decode(eventList[n++]);
-    validateEvent(event: currentEvent, key: timed_event_s['key'] as String, sum: timed_event_s['sum'] as int, isTimed: true);
+    validateEvent(event: currentEvent, key: timed_event_s['key'] as String, sum: timed_event_s['sum'] as double, isTimed: true);
 
     // 28. timed_event_s_d
     currentEvent = json.decode(eventList[n++]);
-    validateEvent(event: currentEvent, key: timed_event_s_d['key'] as String, sum: timed_event_s_d['sum'] as int, dur: timed_event_s_d['duration'] as int, isTimed: true);
+    validateEvent(event: currentEvent, key: timed_event_s_d['key'] as String, sum: timed_event_s_d['sum'] as double, dur: timed_event_s_d['duration'] as int, isTimed: true);
 
     // 29. timed_event_s_se
     currentEvent = json.decode(eventList[n++]);
-    validateEvent(event: currentEvent, key: timed_event_s_se['key'] as String, sum: timed_event_s_se['sum'] as int, segmentation: expectedSegmentation, isTimed: true);
+    validateEvent(event: currentEvent, key: timed_event_s_se['key'] as String, sum: timed_event_s_se['sum'] as double, segmentation: expectedSegmentation, isTimed: true);
 
     // 30. timed_event_s_d_se
     currentEvent = json.decode(eventList[n++]);
-    validateEvent(event: currentEvent, key: timed_event_s_d_se['key'] as String, sum: timed_event_s_d_se['sum'] as int, dur: timed_event_s_d_se['duration'] as int, segmentation: expectedSegmentation, isTimed: true);
+    validateEvent(event: currentEvent, key: timed_event_s_d_se['key'] as String, sum: timed_event_s_d_se['sum'] as double, dur: timed_event_s_d_se['duration'] as int, segmentation: expectedSegmentation, isTimed: true);
 
     // 31. timed_event_d
     currentEvent = json.decode(eventList[n++]);
diff --git a/example/integration_test/event_tests/event_utils.dart b/example/integration_test/event_tests/event_utils.dart
@@ -45,42 +45,42 @@ var expectedSegmentation = {
   'boolList': boolList,
   'mixedList': mixedList,
   'normalString': 'normalString',
-  'nestedList' : [],
-  'mapList' : [],
+  'nestedList': [],
+  'mapList': [],
   'normalInt': 1,
   'normalDouble': 1.1,
   'normalBool': true,
 };
 
 var event = {'key': 'event'};
 var event_c = {'key': 'event_c', 'count': 1};
-var event_c_s = {'key': 'event_c_s', 'count': 1, 'sum': 3};
+var event_c_s = {'key': 'event_c_s', 'count': 1, 'sum': 3.0};
 var event_c_d = {'key': 'event_c_d', 'count': 1, 'duration': 3};
 var event_c_se = {'key': 'event_c_se', 'count': 1, 'segmentation': segment};
-var event_c_s_d = {'key': 'event_c_s_d', 'count': 1, 'sum': 3, 'duration': 3};
-var event_c_s_se = {'key': 'event_c_s_se', 'count': 1, 'sum': 3, 'segmentation': segment};
+var event_c_s_d = {'key': 'event_c_s_d', 'count': 1, 'sum': 3.0, 'duration': 3};
+var event_c_s_se = {'key': 'event_c_s_se', 'count': 1, 'sum': 3.0, 'segmentation': segment};
 var event_c_d_se = {'key': 'event_c_d_se', 'count': 1, 'duration': 3, 'segmentation': segment};
-var event_c_s_d_se = {'key': 'event_c_s_d_se', 'count': 1, 'sum': 3, 'duration': 3, 'segmentation': segment};
-var event_s = {'key': 'event_s', 'sum': 3};
-var event_s_d = {'key': 'event_s_d', 'sum': 3, 'duration': 3};
-var event_s_se = {'key': 'event_s_se', 'sum': 3, 'segmentation': segment};
-var event_s_d_se = {'key': 'event_s_d_se', 'sum': 3, 'duration': 3, 'segmentation': segment};
+var event_c_s_d_se = {'key': 'event_c_s_d_se', 'count': 1, 'sum': 3.0, 'duration': 3, 'segmentation': segment};
+var event_s = {'key': 'event_s', 'sum': 3.0};
+var event_s_d = {'key': 'event_s_d', 'sum': 3.0, 'duration': 3};
+var event_s_se = {'key': 'event_s_se', 'sum': 3.0, 'segmentation': segment};
+var event_s_d_se = {'key': 'event_s_d_se', 'sum': 3.0, 'duration': 3, 'segmentation': segment};
 var event_d = {'key': 'event_d', 'duration': 3};
 var event_d_se = {'key': 'event_d_se', 'duration': 3, 'segmentation': segment};
 var event_se = {'key': 'event_se', 'segmentation': segment};
 var timed_event = {'key': 'timed_event'};
 var timed_event_c = {'key': 'timed_event_c', 'count': 1};
-var timed_event_c_s = {'key': 'timed_event_c_s', 'count': 1, 'sum': 3};
+var timed_event_c_s = {'key': 'timed_event_c_s', 'count': 1, 'sum': 3.0};
 var timed_event_c_d = {'key': 'timed_event_c_d', 'count': 1, 'duration': 3};
 var timed_event_c_se = {'key': 'timed_event_c_se', 'count': 1, 'segmentation': segment};
-var timed_event_c_s_d = {'key': 'timed_event_c_s_d', 'count': 1, 'sum': 3, 'duration': 3};
-var timed_event_c_s_se = {'key': 'timed_event_c_s_se', 'count': 1, 'sum': 3, 'segmentation': segment};
+var timed_event_c_s_d = {'key': 'timed_event_c_s_d', 'count': 1, 'sum': 3.0, 'duration': 3};
+var timed_event_c_s_se = {'key': 'timed_event_c_s_se', 'count': 1, 'sum': 3.0, 'segmentation': segment};
 var timed_event_c_d_se = {'key': 'timed_event_c_d_se', 'count': 1, 'duration': 3, 'segmentation': segment};
-var timed_event_c_s_d_se = {'key': 'timed_event_c_s_d_se', 'count': 1, 'sum': 3, 'duration': 3, 'segmentation': segment};
-var timed_event_s = {'key': 'timed_event_s', 'sum': 3};
-var timed_event_s_d = {'key': 'timed_event_s_d', 'sum': 3, 'duration': 3};
-var timed_event_s_se = {'key': 'timed_event_s_se', 'sum': 3, 'segmentation': segment};
-var timed_event_s_d_se = {'key': 'timed_event_s_d_se', 'sum': 3, 'duration': 3, 'segmentation': segment};
+var timed_event_c_s_d_se = {'key': 'timed_event_c_s_d_se', 'count': 1, 'sum': 3.0, 'duration': 3, 'segmentation': segment};
+var timed_event_s = {'key': 'timed_event_s', 'sum': 3.0};
+var timed_event_s_d = {'key': 'timed_event_s_d', 'sum': 3.0, 'duration': 3};
+var timed_event_s_se = {'key': 'timed_event_s_se', 'sum': 3.0, 'segmentation': segment};
+var timed_event_s_d_se = {'key': 'timed_event_s_d_se', 'sum': 3.0, 'duration': 3, 'segmentation': segment};
 var timed_event_d = {'key': 'timed_event_d', 'duration': 3};
 var timed_event_d_se = {'key': 'timed_event_d_se', 'duration': 3, 'segmentation': segment};
 var timed_event_se = {'key': 'timed_event_se', 'segmentation': segment};
@@ -128,10 +128,11 @@ Future<void> generateEvents() async {
 }
 
 String idCounter = "";
-void validateEvent({dynamic event, String? key, int? count = 1, int? sum = 0, int? dur, dynamic segmentation, String? cvid = "", bool isTimed = false}) {
+void validateEvent({dynamic event, String? key, int? count = 1, double? sum = 0, int? dur, dynamic segmentation, String? cvid = "", bool isTimed = false}) {
   expect(event['key'], key);
   expect(event['count'], count);
-  expect(event['sum'], sum);
+  double sumDelta = event['sum'] - sum;
+  expect(true, -00.1 < sumDelta && sumDelta < 00.1);
   expect(event['dur'], isTimed || Platform.isIOS ? isNotNull : dur);
   expect(event['segmentation'], segmentation);
   expect(event['timestamp'], isNotNull);
diff --git a/example/lib/page_events.dart b/example/lib/page_events.dart
@@ -70,6 +70,13 @@ class EventsPage extends StatelessWidget {
     });
   }
 
+  void cancelEvent() {
+    Countly.startEvent('Timed Event With Cancel');
+    Timer(const Duration(seconds: 5), () {
+      Countly.instance.events.cancelEvent('Timed Event With Cancel');
+    });
+  }
+
   @override
   Widget build(BuildContext context) {
     return Scaffold(
@@ -89,6 +96,7 @@ class EventsPage extends StatelessWidget {
             MyButton(text: 'Timed event Sum: Start / Stop', color: 'grey', onPressed: endEventWithSum),
             MyButton(text: 'Timed event Segment: Start / Stop', color: 'grey', onPressed: endEventWithSegment),
             MyButton(text: 'Timed event Sum Segment: Start / Stop', color: 'grey', onPressed: endEventWithSumSegment),
+            MyButton(text: 'Timed event Start / Cancel', color: 'grey', onPressed: cancelEvent),
           ],
         )),
       ),
diff --git a/ios/Classes/CountlyFlutterPlugin.m b/ios/Classes/CountlyFlutterPlugin.m
@@ -311,6 +311,13 @@ - (void)handleMethodCall:(FlutterMethodCall *)call result:(FlutterResult)result
           result(@"startEvent!");
         });
 
+    } else if ([@"cancelEvent" isEqualToString:call.method]) {
+        dispatch_async(dispatch_get_main_queue(), ^{
+          NSString *eventName = [command objectAtIndex:0];
+          [Countly.sharedInstance cancelEvent:eventName];
+          result(@"cancelEvent!");
+        });
+
     } else if ([@"endEvent" isEqualToString:call.method]) {
         dispatch_async(dispatch_get_main_queue(), ^{
           NSString *key = [command objectAtIndex:0];
diff --git a/lib/countly_flutter.dart b/lib/countly_flutter.dart
@@ -1,6 +1,7 @@
 export 'src/content_builder.dart';
 export 'src/countly_config.dart';
 export 'src/countly_flutter.dart';
+export 'src/events.dart';
 export 'src/feedback.dart';
 export 'src/remote_config.dart';
 export 'src/sessions.dart';
diff --git a/lib/src/countly_flutter.dart b/lib/src/countly_flutter.dart
diff --git a/lib/src/events.dart b/lib/src/events.dart
diff --git a/lib/src/events_internal.dart b/lib/src/events_internal.dart
