feat: respect BE network body limit (#593)

MoKamall · ahmedAlaaInstabug · web-flow · commit 335601c1a1ae · 2025-08-26T16:33:59.000+03:00
* feat: add network body max size APIs in Android

- Added `onNetworkLogBodyMaxSizeChange` method to `FeatureFlagsFlutterApi` in Dart.
- Implemented `getNetworkBodyMaxSize` method in `InstabugApi` to retrieve network log character limit.
- Updated `InstabugApiTest` with a new test for `getNetworkBodyMaxSize`.

* feat: add network body max size APIs in iOS

- Updated Instabug podspec to version 15.0.1.
- Added `getNetworkBodyMaxSize` method in `InstabugApi` for retrieving network log body size.
- Introduced a new test case for `getNetworkBodyMaxSize` in `InstabugApiTests`.
- Updated .gitignore files to include project-specific and Android-related paths.

* feat: add body size checks inside network manager and cache retrieved in feature flags manager

- Added `_networkBodyMaxSize` to `FeatureFlagsManager` for managing network body size limits.
- Introduced `didRequestBodyExceedSizeLimit` and `didResponseBodyExceedSizeLimit` methods in `NetworkManager` to validate request and response body sizes against the limit.
- Created `InstabugConstants` for standardized logging messages related to network body size limits.
- Implemented caching for network body size retrieval to optimize performance.

* feat: utilize network manager size checker APIs inside `network_logger.dart`

- Added early checks for request and response body size limits in `networkLogInternal`.
- Implemented truncation of request/response bodies with warning messages if size limits are exceeded.
- Logged truncation events using `InstabugLogger` for better visibility into network logging behavior.

* chore: add default value of 10KB as a fallback, add network body size specific tests

- Introduced a default network body max size of 10KB to improve logging consistency.
- Updated error handling to set the cached size to the default when native API retrieval fails.
- Added unit tests for `didRequestBodyExceedSizeLimit` and `didResponseBodyExceedSizeLimit` to ensure proper size limit checks for request and response bodies.

* chore: run `dart format .`, and add new `example/pubspec.lock`

* fix: reference the correct iOS SDK and the correct podfile setup

* fix: update network body max size handling and caching

- Changed the return type of `getNetworkBodyMaxSize` from `int?` to `double?` in the API and updated related method calls accordingly.
- Renamed `registerW3CFlagsListener` to `registerFeatureFlagsListener` for consistency across the codebase.
- Introduced a callback mechanism in `FeatureFlagsManager` to handle changes in network body max size, ensuring proper cache management in `NetworkManager`.
- Updated tests to reflect the new method names and ensure functionality remains intact.

* chore: update CHANGELOG to include backend network body size limit support

* fix: flutter and android tests

* fix: fix ios and flutter failing tests

* chore: run dart format

* fix: improve formatting to align with linter

* fix

* fix

* fix

---------

Co-authored-by: ahmed alaa &lt;154802748+ahmedAlaaInstabug@users.noreply.github.com&gt;
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -56,7 +56,7 @@ commands:
     steps:
       - run:
           name: Install Appium
-          command: npm install -g appium
+          command: npm install -g appium@2.19.0
       - when:
           condition:
             equal:
diff --git a/.gitignore b/.gitignore
@@ -80,6 +80,9 @@ android/gradlew.bat
 **/ios/ServiceDefinitions.json
 **/ios/Runner/GeneratedPluginRegistrant.*
 
+# Project specific
+/PRDs/
+
 # Exceptions to above rules.
 !**/ios/**/default.mode1v3
 !**/ios/**/default.mode2v3
diff --git a/packages/instabug_dio_interceptor/test/instabug_dio_interceptor_test.dart b/packages/instabug_dio_interceptor/test/instabug_dio_interceptor_test.dart
@@ -64,6 +64,9 @@ void main() {
         'isW3cExternalTraceIDEnabled': true,
       }),
     );
+    when(mHost.getNetworkBodyMaxSize()).thenAnswer(
+          (_) => Future.value(10240),
+    );
   });
 
   setUp(() {
@@ -78,6 +81,7 @@ void main() {
 
   test('onResponse Test', () async {
     try {
+
       await dio.get<dynamic>('/test');
       // ignore: deprecated_member_use
     } on DioError {
diff --git a/packages/instabug_flutter/CHANGELOG.md b/packages/instabug_flutter/CHANGELOG.md
@@ -11,6 +11,8 @@
 - Add support for user steps  ([#519](https://github.com/Instabug/Instabug-Flutter/pull/519))
 
 - Add support for App variant. ([#585](https://github.com/Instabug/Instabug-Flutter/pull/585))
+- 
+- Add support for respecting backend network body size limits. ([#593](https://github.com/Instabug/Instabug-Flutter/pull/593))
 
 ### Changed
 
@@ -25,7 +27,6 @@
 
 ### Added
 
-
 - Add support for xCode 16. ([#574](https://github.com/Instabug/Instabug-Flutter/pull/574))
 
 - Add support for BugReporting user consents. ([#573](https://github.com/Instabug/Instabug-Flutter/pull/573))
diff --git a/packages/instabug_flutter/android/src/main/java/com/instabug/flutter/modules/InstabugApi.java b/packages/instabug_flutter/android/src/main/java/com/instabug/flutter/modules/InstabugApi.java
@@ -528,6 +528,11 @@ public void reply(Void reply) {
 
                                         }
                                     });
+
+                            featureFlagsFlutterApi.onNetworkLogBodyMaxSizeChange(
+                                    (long) featuresState.getNetworkLogCharLimit(),
+                                    reply -> {}
+                            );
                         }
                     });
                 }
@@ -747,4 +752,20 @@ public void setFullscreen(@NonNull final Boolean isEnabled) {
         }
     }
 
+    @Override
+    public void getNetworkBodyMaxSize(@NonNull InstabugPigeon.Result<Double> result) {
+        ThreadManager.runOnMainThread(
+            new Runnable() {
+                @Override
+                public void run() {
+                    try {
+                        double networkCharLimit = InternalCore.INSTANCE.get_networkLogCharLimit();
+                        result.success(networkCharLimit);
+                    } catch (Exception e) {
+                        e.printStackTrace();
+                    }
+                }
+            }
+        );
+    }
 }
diff --git a/packages/instabug_flutter/android/src/test/java/com/instabug/flutter/InstabugApiTest.java b/packages/instabug_flutter/android/src/test/java/com/instabug/flutter/InstabugApiTest.java
@@ -779,4 +779,15 @@ public void testAutoMasking() {
         mInstabug.verify(() -> Instabug.setAutoMaskScreenshotsTypes(MaskingType.LABELS,MaskingType.MEDIA,MaskingType.TEXT_INPUTS,MaskingType.MASK_NOTHING));
     }
 
+
+    @Test
+    public void testGetNetworkBodyMaxSize() {
+        double expected = 10240;
+        InstabugPigeon.Result<Double> result = makeResult((actual) -> assertEquals((Double) expected, actual));
+
+        mockkObject(new InternalCore[]{InternalCore.INSTANCE}, false);
+        every(mockKMatcherScope -> InternalCore.INSTANCE.get_networkLogCharLimit()).returns((int) expected);
+
+        api.getNetworkBodyMaxSize(result);
+    }
 }
diff --git a/packages/instabug_flutter/example/.gitignore b/packages/instabug_flutter/example/.gitignore
@@ -39,3 +39,6 @@ app.*.symbols
 
 # Obfuscation related
 app.*.map.json
+
+# Android related
+/android/app/.cxx/
diff --git a/packages/instabug_flutter/example/android/settings.gradle b/packages/instabug_flutter/example/android/settings.gradle
@@ -20,7 +20,7 @@ pluginManagement {
 
 plugins {
     id "dev.flutter.flutter-plugin-loader" version "1.0.0"
-    id "com.android.application" version "8.1.0" apply false
+    id "com.android.application" version "8.2.1" apply false
     id "org.jetbrains.kotlin.android" version "1.8.22" apply false
 }
 
diff --git a/packages/instabug_flutter/example/ios/InstabugTests/InstabugApiTests.m b/packages/instabug_flutter/example/ios/InstabugTests/InstabugApiTests.m
@@ -650,4 +650,20 @@ - (void)testAutoMasking {
 
     OCMVerify([self.mInstabug setAutoMaskScreenshots: (IBGAutoMaskScreenshotOptionMaskNothing | IBGAutoMaskScreenshotOptionTextInputs | IBGAutoMaskScreenshotOptionLabels | IBGAutoMaskScreenshotOptionMedia)]);
 }
+- (void)testGetNetworkBodyMaxSize {
+    double expectedValue = 10240.0;
+    XCTestExpectation *expectation = [self expectationWithDescription:@"Call completion handler"];
+
+    OCMStub([self.mNetworkLogger getNetworkBodyMaxSize]).andReturn(expectedValue);
+
+    [self.api getNetworkBodyMaxSizeWithCompletion:^(NSNumber *actual, FlutterError *error) {
+        [expectation fulfill];
+        XCTAssertEqual(actual.doubleValue, expectedValue);
+        XCTAssertNil(error);
+    }];
+
+    OCMVerify([self.mNetworkLogger getNetworkBodyMaxSize]);
+    [self waitForExpectations:@[expectation] timeout:5.0];
+}
+
 @end
diff --git a/packages/instabug_flutter/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/packages/instabug_flutter/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme
@@ -68,6 +68,7 @@
       ignoresPersistentStateOnLaunch = "NO"
       debugDocumentVersioning = "YES"
       debugServiceExtension = "internal"
+      enableGPUValidationMode = "1"
       allowLocationSimulation = "YES">
       <BuildableProductRunnable
          runnableDebuggingMode = "0">
diff --git a/packages/instabug_flutter/ios/Classes/Modules/InstabugApi.m b/packages/instabug_flutter/ios/Classes/Modules/InstabugApi.m
@@ -609,4 +609,9 @@ - (void)setFullscreenIsEnabled:(NSNumber *)isEnabled error:(FlutterError *_Nulla
     // Empty implementation as requested
 }
 
+- (void)getNetworkBodyMaxSizeWithCompletion:(nonnull void (^)(NSNumber * _Nullable, FlutterError * _Nullable))completion {
+    completion(@(IBGNetworkLogger.getNetworkBodyMaxSize), nil);
+}
+
+
 @end
diff --git a/packages/instabug_flutter/ios/Classes/Util/IBGNetworkLogger+CP.h b/packages/instabug_flutter/ios/Classes/Util/IBGNetworkLogger+CP.h
@@ -49,6 +49,8 @@ NS_ASSUME_NONNULL_BEGIN
                     duration:(int64_t) duration
                 gqlQueryName:(NSString * _Nullable)gqlQueryName;
 
++ (double)getNetworkBodyMaxSize;
+
 @end
 
 NS_ASSUME_NONNULL_END
diff --git a/packages/instabug_flutter/lib/src/modules/instabug.dart b/packages/instabug_flutter/lib/src/modules/instabug.dart
@@ -196,7 +196,7 @@ class Instabug {
       debugLogsLevel.toString(),
       appVariant,
     );
-    return FeatureFlagsManager().registerW3CFlagsListener();
+    return FeatureFlagsManager().registerFeatureFlagsListener();
   }
 
   /// Sets a [callback] to be called wehenever a screen name is captured to mask
diff --git a/packages/instabug_flutter/lib/src/modules/network_logger.dart b/packages/instabug_flutter/lib/src/modules/network_logger.dart
@@ -6,6 +6,8 @@ import 'package:instabug_flutter/src/models/network_data.dart';
 import 'package:instabug_flutter/src/models/w3c_header.dart';
 import 'package:instabug_flutter/src/modules/apm.dart';
 import 'package:instabug_flutter/src/utils/feature_flags_manager.dart';
+import 'package:instabug_flutter/src/utils/instabug_constants.dart';
+import 'package:instabug_flutter/src/utils/instabug_logger.dart';
 import 'package:instabug_flutter/src/utils/iterable_ext.dart';
 import 'package:instabug_flutter/src/utils/network_manager.dart';
 import 'package:instabug_flutter/src/utils/w3c_header_utils.dart';
@@ -86,7 +88,36 @@ class NetworkLogger {
   Future<void> networkLogInternal(NetworkData data) async {
     final omit = await _manager.omitLog(data);
     if (omit) return;
-    final obfuscated = await _manager.obfuscateLog(data);
+
+    // Check size limits early to avoid processing large bodies
+    final requestExceeds = await _manager.didRequestBodyExceedSizeLimit(data);
+    final responseExceeds = await _manager.didResponseBodyExceedSizeLimit(data);
+
+    var processedData = data;
+    if (requestExceeds || responseExceeds) {
+      // Replace bodies with warning messages
+      processedData = data.copyWith(
+        requestBody: requestExceeds
+            ? InstabugConstants.getRequestBodyReplacementMessage(
+                data.requestBodySize,
+              )
+            : data.requestBody,
+        responseBody: responseExceeds
+            ? InstabugConstants.getResponseBodyReplacementMessage(
+                data.responseBodySize,
+              )
+            : data.responseBody,
+      );
+
+      // Log the truncation event.
+      final isBothExceeds = requestExceeds && responseExceeds;
+      InstabugLogger.I.e(
+        "Truncated network ${isBothExceeds ? 'request and response' : requestExceeds ? 'request' : 'response'} body",
+        tag: InstabugConstants.networkLoggerTag,
+      );
+    }
+
+    final obfuscated = await _manager.obfuscateLog(processedData);
     await _host.networkLog(obfuscated.toJson());
     await APM.networkLogAndroid(obfuscated);
   }
diff --git a/packages/instabug_flutter/lib/src/utils/feature_flags_manager.dart b/packages/instabug_flutter/lib/src/utils/feature_flags_manager.dart
@@ -9,6 +9,8 @@ typedef OnW3CFeatureFlagChange = void Function(
   bool isW3cCaughtHeaderEnabled,
 );
 
+typedef OnNetworkBodyMaxSizeChangeCallback = void Function();
+
 class FeatureFlagsManager implements FeatureFlagsFlutterApi {
   // Access the singleton instance
   factory FeatureFlagsManager() {
@@ -23,6 +25,10 @@ class FeatureFlagsManager implements FeatureFlagsFlutterApi {
   // Host API instance
   static InstabugHostApi _host = InstabugHostApi();
 
+  // Callback for network body max size changes
+  static OnNetworkBodyMaxSizeChangeCallback?
+      _onNetworkBodyMaxSizeChangeCallback;
+
   /// @nodoc
   @visibleForTesting
   // Setter for the host API
@@ -38,10 +44,21 @@ class FeatureFlagsManager implements FeatureFlagsFlutterApi {
     // since it breaks the singleton pattern
   }
 
+  /// Sets the callback for network body max size changes
+  // ignore: avoid_setters_without_getters
+  set onNetworkBodyMaxSizeChangeCallback(
+    OnNetworkBodyMaxSizeChangeCallback callback,
+  ) {
+    _onNetworkBodyMaxSizeChangeCallback = callback;
+  }
+
   // Internal state flags
   bool _isAndroidW3CExternalTraceID = false;
   bool _isAndroidW3CExternalGeneratedHeader = false;
   bool _isAndroidW3CCaughtHeader = false;
+  int _networkBodyMaxSize = 0;
+
+  int get networkBodyMaxSize => _networkBodyMaxSize;
 
   Future<W3cFeatureFlags> getW3CFeatureFlagsHeader() async {
     if (IBGBuildInfo.instance.isAndroid) {
@@ -64,9 +81,10 @@ class FeatureFlagsManager implements FeatureFlagsFlutterApi {
     );
   }
 
-  Future<void> registerW3CFlagsListener() async {
+  Future<void> registerFeatureFlagsListener() async {
     FeatureFlagsFlutterApi.setup(this); // Use 'this' instead of _instance
 
+    // W3C Feature Flags
     final featureFlags = await _host.isW3CFeatureFlagsEnabled();
     _isAndroidW3CCaughtHeader =
         featureFlags['isW3cCaughtHeaderEnabled'] ?? false;
@@ -75,6 +93,10 @@ class FeatureFlagsManager implements FeatureFlagsFlutterApi {
     _isAndroidW3CExternalGeneratedHeader =
         featureFlags['isW3cExternalGeneratedHeaderEnabled'] ?? false;
 
+    // Network Body Max Size
+    final networkBodyMaxSize = await _host.getNetworkBodyMaxSize();
+    _networkBodyMaxSize = networkBodyMaxSize?.toInt() ?? 0;
+
     return _host.registerFeatureFlagChangeListener();
   }
 
@@ -89,4 +111,10 @@ class FeatureFlagsManager implements FeatureFlagsFlutterApi {
     _isAndroidW3CExternalTraceID = isW3cExternalTraceIDEnabled;
     _isAndroidW3CExternalGeneratedHeader = isW3cExternalGeneratedHeaderEnabled;
   }
+
+  @override
+  void onNetworkLogBodyMaxSizeChange(int networkBodyMaxSize) {
+    _networkBodyMaxSize = networkBodyMaxSize;
+    _onNetworkBodyMaxSizeChangeCallback?.call();
+  }
 }
diff --git a/packages/instabug_flutter/lib/src/utils/instabug_constants.dart b/packages/instabug_flutter/lib/src/utils/instabug_constants.dart
@@ -0,0 +1,31 @@
+/// Constants used throughout the Instabug Flutter SDK
+class InstabugConstants {
+  InstabugConstants._();
+
+  // Network logging constants
+  static const String networkLoggerTag = 'NetworkLogger';
+  static const String networkManagerTag = 'NetworkManager';
+
+  // Network body replacement messages
+  static const String requestBodyReplacedPrefix = '[REQUEST_BODY_REPLACED]';
+  static const String responseBodyReplacedPrefix = '[RESPONSE_BODY_REPLACED]';
+  static const String exceedsLimitSuffix = 'exceeds limit';
+
+  /// Generates a request body replacement message
+  static String getRequestBodyReplacementMessage(int size) {
+    return '$requestBodyReplacedPrefix - Size: $size $exceedsLimitSuffix';
+  }
+
+  /// Generates a response body replacement message
+  static String getResponseBodyReplacementMessage(int size) {
+    return '$responseBodyReplacedPrefix - Size: $size $exceedsLimitSuffix';
+  }
+
+  /// Generates a network body size limit exceeded log message
+  static String getNetworkBodyLimitExceededMessage({
+    required String type,
+    required int bodySize,
+  }) {
+    return 'Network body size limit exceeded for $type - Size: $bodySize';
+  }
+}
diff --git a/packages/instabug_flutter/lib/src/utils/network_manager.dart b/packages/instabug_flutter/lib/src/utils/network_manager.dart
diff --git a/packages/instabug_flutter/pigeons/instabug.api.dart b/packages/instabug_flutter/pigeons/instabug.api.dart
diff --git a/packages/instabug_flutter/test/feature_flags_manager_test.dart b/packages/instabug_flutter/test/feature_flags_manager_test.dart
diff --git a/packages/instabug_flutter/test/instabug_test.dart b/packages/instabug_flutter/test/instabug_test.dart
diff --git a/packages/instabug_flutter/test/network_logger_test.dart b/packages/instabug_flutter/test/network_logger_test.dart
diff --git a/packages/instabug_flutter/test/network_manager_test.dart b/packages/instabug_flutter/test/network_manager_test.dart
diff --git a/packages/instabug_http_client/lib/instabug_http_client.dart b/packages/instabug_http_client/lib/instabug_http_client.dart

Original file line number	Diff line number	Diff line change
`@@ -528,6 +528,11 @@ public void reply(Void reply) {`
`528`	`528`
`529`	`529`	`}`
`530`	`530`	`});`
	`531`	`+`
	`532`	`+ featureFlagsFlutterApi.onNetworkLogBodyMaxSizeChange(`
	`533`	`+ (long) featuresState.getNetworkLogCharLimit(),`
	`534`	`+ reply -> {}`
	`535`	`+ );`
`531`	`536`	`}`
`532`	`537`	`});`
`533`	`538`	`}`
`@@ -747,4 +752,20 @@ public void setFullscreen(@NonNull final Boolean isEnabled) {`
`747`	`752`	`}`
`748`	`753`	`}`
`749`	`754`
	`755`	`+ @Override`
	`756`	`+ public void getNetworkBodyMaxSize(@NonNull InstabugPigeon.Result<Double> result) {`
	`757`	`+ ThreadManager.runOnMainThread(`
	`758`	`+ new Runnable() {`
	`759`	`+ @Override`
	`760`	`+ public void run() {`
	`761`	`+ try {`
	`762`	`+ double networkCharLimit = InternalCore.INSTANCE.get_networkLogCharLimit();`
	`763`	`+ result.success(networkCharLimit);`
	`764`	`+ } catch (Exception e) {`
	`765`	`+ e.printStackTrace();`
	`766`	`+ }`
	`767`	`+ }`
	`768`	`+ }`
	`769`	`+ );`
	`770`	`+ }`
`750`	`771`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ pluginManagement {`
`20`	`20`
`21`	`21`	`plugins {`
`22`	`22`	`id "dev.flutter.flutter-plugin-loader" version "1.0.0"`
`23`		`- id "com.android.application" version "8.1.0" apply false`
	`23`	`+ id "com.android.application" version "8.2.1" apply false`
`24`	`24`	`id "org.jetbrains.kotlin.android" version "1.8.22" apply false`
`25`	`25`	`}`
`26`	`26`