Merge pull request #360 from Countly/headers_after_init

Change network headers after init

Author: turtledreams

CHANGELOG.md

@@ -1,4 +1,5 @@
 ## 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"
 
 ## 25.4.1

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

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

example/integration_test/networking_tests/addCustomNetworkRequestHeaders_test.dart

@@ -0,0 +1,53 @@
+import 'dart:io';
+import 'dart:math';
+
+import 'package:countly_flutter/countly_flutter.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:integration_test/integration_test.dart';
+
+import '../utils.dart';
+
+/**
+ * Tests for adding custom network request headers before and after SDK initialization.
+ * Verifies that the headers are correctly sent with network requests.
+ * Covers scenarios of initial headers set during config and additional headers added later.
+ * Checks for header overriding and empty header values.
+ * Uses a local test server to capture and validate request headers.
+ */
+void main() {
+  IntegrationTestWidgetsFlutterBinding.ensureInitialized();
+  testWidgets('addCustomNetworkRequestHeaders_test', (WidgetTester tester) async {
+    List<HttpHeaders> headersArray = <HttpHeaders>[];
+    createServer(
+      <Map<String, List<String>>>[],
+      customHandler: (req, res) async {
+        // Print request headers for debugging
+        headersArray.add(req.headers);
+      },
+    );
+    // Initialize the SDK
+    CountlyConfig config = CountlyConfig("http://0.0.0.0:8080", APP_KEY).enableManualSessionHandling().setLoggingEnabled(true);
+    config.setCustomNetworkRequestHeaders({"Initial-Header": "InitialValue"});
+    await Countly.initWithConfig(config);
+    await Future.delayed(const Duration(seconds: 1));
+    for (var headers in headersArray) {
+      expect('InitialValue', headers.value('Initial-Header'));
+      expect(null, headers.value('X-Custom-Header-1'));
+      expect(null, headers.value('X-Custom-Header-2'));
+      expect(null, headers.value('X-Custom-Header-3'));
+    }
+    headersArray.clear();
+    // Add custom headers
+    await Countly.instance.addCustomNetworkRequestHeaders({"X-Custom-Header-1": "", "": "CustomValue2", "X-Custom-Header-3": "CustomValue3", "Initial-Header": "OverriddenValue"});
+    // Make a request to trigger headers being sent
+    await Countly.instance.sessions.beginSession();
+    await Future.delayed(const Duration(seconds: 2));
+
+    for (var headers in headersArray) {
+      expect('OverriddenValue', headers.value('Initial-Header'));
+      expect('', headers.value('X-Custom-Header-1'));
+      expect(null, headers.value(''));
+      expect('CustomValue3', headers.value('X-Custom-Header-3'));
+    }
+  });
+}

ios/Classes/CountlyFlutterPlugin.m

@@ -1390,7 +1390,13 @@ - (void)handleMethodCall:(FlutterMethodCall *)call result:(FlutterResult)result
             [Countly.sharedInstance attemptToSendStoredRequests];
         });
         result(@"attemptToSendStoredRequests: success");
-    }  else {
+    } else if ([@"addCustomNetworkRequestHeaders" isEqualToString:call.method]) {
+        dispatch_async(dispatch_get_main_queue(), ^{
+            NSDictionary* customHeaderValues = [command objectAtIndex:0];
+            [Countly.sharedInstance addCustomNetworkRequestHeaders:customHeaderValues];
+            result(nil);
+        });
+    } else {
         result(FlutterMethodNotImplemented);
     }
 }

lib/src/countly_flutter.dart

@@ -1692,6 +1692,25 @@ class Countly {
     await _channel.invokeMethod('attemptToSendStoredRequests');
   }
 
+  /// Add custom headers to all network requests made by the SDK.
+  Future<void> addCustomNetworkRequestHeaders(Map<String, String> customHeaderValues) async {
+    if (!_instance._countlyState.isInitialized) {
+      log('addCustomNetworkRequestHeaders, "initWithConfig" must be called before "addCustomNetworkRequestHeaders"', logLevel: LogLevel.ERROR);
+      return;
+    }
+
+    if (customHeaderValues.isEmpty) {
+      log('addCustomNetworkRequestHeaders, customHeaderValues cannot be empty', logLevel: LogLevel.WARNING);
+      return;
+    }
+
+    log('Calling "addCustomNetworkRequestHeaders" with headers count: [${customHeaderValues.length}]');
+    List<dynamic> args = [];
+    args.add(customHeaderValues);
+
+    await _channel.invokeMethod('addCustomNetworkRequestHeaders', <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')