Merge pull request #365 from Countly/record_metrics

Record metrics

Author: turtledreams

CHANGELOG.md

@@ -1,6 +1,8 @@
 ## XX.XX.XX
 * Added a new function "addCustomNetworkRequestHeaders: customHeaderValues" for providing or overriding custom headers after init.
 * Default request method is now set to "POST"
+* Added a new function "recordMetrics: metricsOverride" to send a device metrics request.
+* Added a new Consent option "metrics" for controlling "recordMetrics" method. (This has no effect on Session metrics.)
 
 ## 25.4.1
 * Added fullscreen support for feedback widgets.

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

@@ -341,6 +341,10 @@ else if ("attemptToSendStoredRequests".equals(call.method)) {
                 Map<String, String> customHeaderValues = toMapString(args.getJSONObject(0));
                 Countly.sharedInstance().requestQueue().addCustomNetworkRequestHeaders(customHeaderValues);
                 result.success("addCustomNetworkRequestHeaders success!");
+            } else if ("recordMetrics".equals(call.method)) {
+                Map<String, String> metricsOverride = toMapString(args.getJSONObject(0));
+                Countly.sharedInstance().requestQueue().recordMetrics(metricsOverride);
+                result.success("recordMetrics success!");
             } else if ("setHttpPostForced".equals(call.method)) {
                 boolean isEnabled = args.getBoolean(0);
                 this.config.setHttpPostForced(isEnabled);

example/integration_test/networking_tests/record_metrics_test.dart

@@ -0,0 +1,111 @@
+import 'dart:convert';
+import 'dart:io';
+
+import 'package:countly_flutter/countly_flutter.dart';
+import 'package:flutter/foundation.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:integration_test/integration_test.dart';
+
+import '../utils.dart';
+import '../views_tests/auto_view_flow2_test.dart';
+
+/// Tests for recording custom metrics using the Countly SDK.
+/// Verifies that metrics are correctly sent in the network request.
+/// Covers scenarios with normal key-value pairs and edge cases like empty keys/values.
+void main() {
+  IntegrationTestWidgetsFlutterBinding.ensureInitialized();
+  testWidgets('recordMetrics_test', (WidgetTester tester) async {
+    CountlyConfig config = CountlyConfig(SERVER_URL, APP_KEY).setLoggingEnabled(true);
+    await Countly.initWithConfig(config);
+    await Future.delayed(const Duration(seconds: 2));
+
+    // Add custom headers
+    await Countly.instance.recordMetrics({'metric1': '100', 'metric2': '200', '_device': 'custom_device', '': 'empty_key', 'empty_value': ''});
+
+    var requestQueue = await getRequestQueue();
+    expect(requestQueue.length, 2);
+    validateBeginSessionRequest(requestQueue[0]);
+
+    Map<String, List<String>> queryParams = Uri.parse('?${requestQueue[1]}').queryParametersAll;
+    var rqMetrics = jsonDecode(queryParams['metrics']![0]);
+    Map<String, dynamic> customMetrics = {
+      'metric1': '100',
+      'metric2': '200',
+      '_device': 'custom_device',
+      '': 'empty_key',
+      'empty_value': '',
+    };
+
+    if(Platform.isAndroid) {
+      // Android SDK ignores empty key metrics
+      customMetrics.remove('');
+    }
+
+    validateMetrics(rqMetrics, customMetrics);
+  });
+}
+
+const _androidMetricKeys = {
+  '_os',
+  '_os_version',
+  '_app_version',
+  '_device',
+  '_device_type',
+  '_resolution',
+  '_density',
+  '_locale',
+  '_manufacturer',
+  '_carrier',
+  '_has_hinge',
+};
+
+const _iosMetricKeys = {'_os', '_os_version', '_app_version', '_device', '_device_type', '_resolution', '_density', '_locale'};
+
+const _webMetricKeys = {
+  '_os',
+  '_os_version',
+  '_app_version',
+  '_device',
+  '_locale',
+  '_browser',
+  '_browser_version',
+  '_ua',
+};
+
+void validateMetrics(Map<String, dynamic> metrics, Map<String, dynamic>? customMetrics) {
+  late Set<String> expectedKeys;
+
+  if (kIsWeb) {
+    expectedKeys = _webMetricKeys;
+  } else if (Platform.isAndroid) {
+    expectedKeys = _androidMetricKeys;
+  } else if (Platform.isIOS) {
+    expectedKeys = _iosMetricKeys;
+  } else {
+    throw UnsupportedError('Unknown platform in metric validation');
+  }
+
+  expectedKeys = expectedKeys.union(customMetrics?.keys.toSet() ?? {});
+
+  expect(metrics.length, equals(expectedKeys.length), reason: 'Metric key count mismatch');
+
+  for (final key in expectedKeys) {
+    if (customMetrics != null && customMetrics.containsKey(key)) {
+      expect(metrics[key], customMetrics[key]);
+    } else {
+      expect(
+        metrics.containsKey(key),
+        true,
+        reason: 'Missing metric key: $key',
+      );
+    }
+  }
+
+  for (final entry in (customMetrics ?? {}).entries) {
+    expect(
+      metrics[entry.key],
+      entry.value,
+      reason: 'Custom metric key-value mismatch for key: ${entry.key}',
+    );
+  }
+}

ios/Classes/CountlyFlutterPlugin.m

@@ -1396,6 +1396,12 @@ - (void)handleMethodCall:(FlutterMethodCall *)call result:(FlutterResult)result
             [Countly.sharedInstance addCustomNetworkRequestHeaders:customHeaderValues];
             result(nil);
         });
+    } else if ([@"recordMetrics" isEqualToString:call.method]) {
+        dispatch_async(dispatch_get_main_queue(), ^{
+            NSDictionary* metricsOverride = [command objectAtIndex:0];
+            [Countly.sharedInstance recordMetrics:metricsOverride];
+            result(nil);
+        });
     } else {
         result(FlutterMethodNotImplemented);
     }

lib/src/countly_flutter.dart

@@ -57,6 +57,7 @@ abstract class CountlyConsent {
   static const String feedback = 'feedback';
   static const String remoteConfig = 'remote-config';
   static const String content = 'content';
+  static const String metrics = 'metrics';
 }
 
 class Countly {
@@ -1711,6 +1712,21 @@ class Countly {
     await _channel.invokeMethod('addCustomNetworkRequestHeaders', <String, dynamic>{'data': json.encode(args)});
   }
 
+
+  /// Record device metrics manually as a standalone call
+  /// [Map<String, String> metricsOverride] - map of key value pairs to override the default metrics
+  Future<void> recordMetrics(Map<String, String> metricsOverride) async {
+    if (!_instance._countlyState.isInitialized) {
+      log('recordMetrics, "initWithConfig" must be called before "recordMetrics"', logLevel: LogLevel.ERROR);
+      return;
+    }
+
+    List<dynamic> args = [];
+    args.add(metricsOverride);
+
+    await _channel.invokeMethod('recordMetrics', <String, dynamic>{'data': json.encode(args)});
+  }
+
   /// starts a timed event
   /// returns error or success message
   @Deprecated('This function is deprecated, please use "startEvent" of events instead')