feat: support switching to native network interception (#1120)

a7medev · web-flow · commit 35013f65c2c9 · 2024-02-06T14:48:59.000+02:00
diff --git a/android/src/main/java/com/instabug/reactlibrary/RNInstabugReactnativeModule.java b/android/src/main/java/com/instabug/reactlibrary/RNInstabugReactnativeModule.java
@@ -127,6 +127,7 @@ public void init(
             final String token,
             final ReadableArray invocationEventValues,
             final String logLevel,
+            final boolean useNativeNetworkInterception,
             @Nullable final String codePushVersion
     ) {
         MainThreadHandler.runOnMainThread(new Runnable() {
diff --git a/examples/default/ios/InstabugTests/InstabugSampleTests.m b/examples/default/ios/InstabugTests/InstabugSampleTests.m
@@ -70,14 +70,15 @@ - (void)testInit {
   NSString *appToken = @"app_token";
   NSString *codePushVersion = @"1.0.0(1)";
   NSArray *invocationEvents = [NSArray arrayWithObjects:[NSNumber numberWithInteger:floatingButtonInvocationEvent], nil];
+  BOOL useNativeNetworkInterception = YES;
   IBGSDKDebugLogsLevel sdkDebugLogsLevel = IBGSDKDebugLogsLevelDebug;
   
   OCMStub([mock setCodePushVersion:codePushVersion]);
 
-  [self.instabugBridge init:appToken invocationEvents:invocationEvents debugLogsLevel:sdkDebugLogsLevel codePushVersion:codePushVersion];
+  [self.instabugBridge init:appToken invocationEvents:invocationEvents debugLogsLevel:sdkDebugLogsLevel useNativeNetworkInterception:useNativeNetworkInterception codePushVersion:codePushVersion];
   OCMVerify([mock setCodePushVersion:codePushVersion]);
 
-  OCMVerify([self.mRNInstabug initWithToken:appToken invocationEvents:floatingButtonInvocationEvent debugLogsLevel:sdkDebugLogsLevel]);
+  OCMVerify([self.mRNInstabug initWithToken:appToken invocationEvents:floatingButtonInvocationEvent debugLogsLevel:sdkDebugLogsLevel useNativeNetworkInterception:useNativeNetworkInterception]);
 }
 
 - (void)testSetUserData {
diff --git a/examples/default/ios/InstabugTests/RNInstabugTests.m b/examples/default/ios/InstabugTests/RNInstabugTests.m
@@ -41,6 +41,19 @@ - (void)testInitWithoutLogsLevel {
   OCMVerify([self.mIBGNetworkLogger setEnabled:YES]);
 }
 
+- (void)testInitWithNativeNetworkInterception {
+  NSString *token = @"app-token";
+  IBGInvocationEvent invocationEvents = IBGInvocationEventFloatingButton | IBGInvocationEventShake;
+  BOOL useNativeNetworkInterception = YES;
+
+  [RNInstabug initWithToken:token invocationEvents:invocationEvents useNativeNetworkInterception:useNativeNetworkInterception];
+
+  OCMVerify([self.mInstabug startWithToken:token invocationEvents:invocationEvents]);
+  OCMVerify([self.mInstabug setCurrentPlatform:IBGPlatformReactNative]);
+  OCMVerify(never(), [self.mIBGNetworkLogger disableAutomaticCapturingOfNetworkLogs]);
+  OCMVerify([self.mIBGNetworkLogger setEnabled:YES]);
+}
+
 - (void)testInitWithLogsLevel {
   NSString *token = @"app-token";
   IBGInvocationEvent invocationEvents = IBGInvocationEventFloatingButton | IBGInvocationEventShake;
diff --git a/ios/RNInstabug/InstabugReactBridge.h b/ios/RNInstabug/InstabugReactBridge.h
@@ -27,7 +27,7 @@
 
 - (void)setEnabled:(BOOL)isEnabled;
 
-- (void)init:(NSString *)token invocationEvents:(NSArray *)invocationEventsArray debugLogsLevel:(IBGSDKDebugLogsLevel)sdkDebugLogsLevel codePushVersion:(NSString *)codePushVersion;
+- (void)init:(NSString *)token invocationEvents:(NSArray *)invocationEventsArray debugLogsLevel:(IBGSDKDebugLogsLevel)sdkDebugLogsLevel useNativeNetworkInterception:(BOOL)useNativeNetworkInterception codePushVersion:(NSString *)codePushVersion;
 
 - (void)setUserData:(NSString *)userData;
 
diff --git a/ios/RNInstabug/InstabugReactBridge.m b/ios/RNInstabug/InstabugReactBridge.m
@@ -40,6 +40,7 @@ - (dispatch_queue_t)methodQueue {
 RCT_EXPORT_METHOD(init:(NSString *)token
           invocationEvents:(NSArray *)invocationEventsArray
           debugLogsLevel:(IBGSDKDebugLogsLevel)sdkDebugLogsLevel
+          useNativeNetworkInterception:(BOOL)useNativeNetworkInterception
           codePushVersion:(NSString *)codePushVersion) {
     IBGInvocationEvent invocationEvents = 0;
 
@@ -51,7 +52,8 @@ - (dispatch_queue_t)methodQueue {
 
     [RNInstabug initWithToken:token
              invocationEvents:invocationEvents
-               debugLogsLevel:sdkDebugLogsLevel];
+               debugLogsLevel:sdkDebugLogsLevel
+ useNativeNetworkInterception:useNativeNetworkInterception];
 }
 
 RCT_EXPORT_METHOD(setReproStepsConfig:(IBGUserStepsMode)bugMode :(IBGUserStepsMode)crashMode:(IBGUserStepsMode)sessionReplayMode) {
diff --git a/ios/RNInstabug/RNInstabug.h b/ios/RNInstabug/RNInstabug.h
@@ -6,6 +6,14 @@
 @interface RNInstabug : NSObject
 
 + (void)initWithToken:(NSString *)token invocationEvents:(IBGInvocationEvent)invocationEvents debugLogsLevel:(IBGSDKDebugLogsLevel)debugLogsLevel;
+
++ (void)initWithToken:(NSString *)token invocationEvents:(IBGInvocationEvent)invocationEvents debugLogsLevel:(IBGSDKDebugLogsLevel)debugLogsLevel
+useNativeNetworkInterception:(BOOL)useNativeNetworkInterception;
+
++ (void)initWithToken:(NSString *)token
+     invocationEvents:(IBGInvocationEvent)invocationEvents
+useNativeNetworkInterception:(BOOL)useNativeNetworkInterception;
+
 + (void)initWithToken:(NSString *)token invocationEvents:(IBGInvocationEvent)invocationEvents;
 
 /**
diff --git a/ios/RNInstabug/RNInstabug.m b/ios/RNInstabug/RNInstabug.m
@@ -13,15 +13,19 @@ + (void)reset {
     didInit = NO;
 }
 
-+ (void)initWithToken:(NSString *)token invocationEvents:(IBGInvocationEvent)invocationEvents  {
++ (void)initWithToken:(NSString *)token
+     invocationEvents:(IBGInvocationEvent)invocationEvents
+useNativeNetworkInterception:(BOOL)useNativeNetworkInterception {
 
     didInit = YES;
 
     [Instabug setCurrentPlatform:IBGPlatformReactNative];
 
-    // Disable automatic network logging in the iOS SDK to avoid duplicate network logs coming
-    // from both the iOS and React Native SDKs
-    [IBGNetworkLogger disableAutomaticCapturingOfNetworkLogs];
+    if (!useNativeNetworkInterception) {
+        // Disable automatic network logging in the iOS SDK to avoid duplicate network logs coming
+        // from both the iOS and React Native SDKs
+        [IBGNetworkLogger disableAutomaticCapturingOfNetworkLogs];
+    }
 
     [Instabug startWithToken:token invocationEvents:invocationEvents];
 
@@ -37,6 +41,15 @@ + (void)initWithToken:(NSString *)token invocationEvents:(IBGInvocationEvent)inv
     IBGAPM.hotAppLaunchEnabled = NO;
 }
 
++ (void)initWithToken:(NSString *)token invocationEvents:(IBGInvocationEvent)invocationEvents {
+    [self initWithToken:token invocationEvents:invocationEvents useNativeNetworkInterception:NO];
+}
+
++ (void)initWithToken:(NSString *)token invocationEvents:(IBGInvocationEvent)invocationEvents debugLogsLevel:(IBGSDKDebugLogsLevel)debugLogsLevel useNativeNetworkInterception:(BOOL)useNativeNetworkInterception {
+    [Instabug setSdkDebugLogsLevel:debugLogsLevel];
+    [self initWithToken:token invocationEvents:invocationEvents useNativeNetworkInterception:useNativeNetworkInterception];
+}
+
 + (void)initWithToken:(NSString *)token
      invocationEvents:(IBGInvocationEvent)invocationEvents
        debugLogsLevel:(IBGSDKDebugLogsLevel)debugLogsLevel {
diff --git a/src/models/InstabugConfig.ts b/src/models/InstabugConfig.ts
@@ -1,4 +1,4 @@
-import type { InvocationEvent, LogLevel } from '../utils/Enums';
+import type { InvocationEvent, LogLevel, NetworkInterceptionMode } from '../utils/Enums';
 
 export interface InstabugConfig {
   /**
@@ -18,4 +18,15 @@ export interface InstabugConfig {
    * An optional code push version to be used for all reports.
    */
   codePushVersion?: string;
+
+  /**
+   * An optional network interception mode, this determines whether network interception
+   * is done in the JavaScript side or in the native Android and iOS SDK side.
+   *
+   * When set to `NetworkInterceptionMode.native`, configuring network logging
+   * should be done through native code not JavaScript (e.g. network request obfuscation).
+   *
+   * @default NetworkInterceptionMode.javascript
+   */
+  networkInterceptionMode?: NetworkInterceptionMode;
 }
diff --git a/src/modules/Instabug.ts b/src/modules/Instabug.ts
@@ -12,6 +12,7 @@ import {
   ColorTheme,
   Locale,
   LogLevel,
+  NetworkInterceptionMode,
   ReproStepsMode,
   StringKey,
   WelcomeMessageMode,
@@ -61,12 +62,19 @@ function reportCurrentViewForAndroid(screenName: string | null) {
 export const init = (config: InstabugConfig) => {
   InstabugUtils.captureJsErrors();
   captureUnhandledRejections();
-  NetworkLogger.setEnabled(true);
+
+  // Default networkInterceptionMode to JavaScript
+  config.networkInterceptionMode ??= NetworkInterceptionMode.javascript;
+
+  if (config.networkInterceptionMode === NetworkInterceptionMode.javascript) {
+    NetworkLogger.setEnabled(true);
+  }
 
   NativeInstabug.init(
     config.token,
     config.invocationEvents,
     config.debugLogsLevel ?? LogLevel.error,
+    config.networkInterceptionMode === NetworkInterceptionMode.native,
     config.codePushVersion,
   );
 
diff --git a/src/native/NativeInstabug.ts b/src/native/NativeInstabug.ts
@@ -23,6 +23,7 @@ export interface InstabugNativeModule extends NativeModule {
     token: string,
     invocationEvents: InvocationEvent[],
     debugLogsLevel: LogLevel,
+    useNativeNetworkInterception: boolean,
     codePushVersion?: string,
   ): void;
   show(): void;
diff --git a/src/utils/Enums.ts b/src/utils/Enums.ts
@@ -24,6 +24,14 @@ export enum InvocationEvent {
   floatingButton = constants.invocationEventFloatingButton,
 }
 
+/**
+ * The network interceptor to use.
+ */
+export enum NetworkInterceptionMode {
+  javascript,
+  native,
+}
+
 /**
  * Options added while invoking bug reporting.
  */
diff --git a/test/mocks/mockNetworkLogger.ts b/test/mocks/mockNetworkLogger.ts
@@ -0,0 +1 @@
+jest.mock('../../src/modules/NetworkLogger');
diff --git a/test/modules/Instabug.spec.ts b/test/modules/Instabug.spec.ts
@@ -1,4 +1,5 @@
 import '../mocks/mockInstabugUtils';
+import '../mocks/mockNetworkLogger';
 
 import { Platform, findNodeHandle, processColor } from 'react-native';
 
@@ -7,12 +8,14 @@ import waitForExpect from 'wait-for-expect';
 
 import Report from '../../src/models/Report';
 import * as Instabug from '../../src/modules/Instabug';
+import * as NetworkLogger from '../../src/modules/NetworkLogger';
 import { NativeEvents, NativeInstabug, emitter } from '../../src/native/NativeInstabug';
 import {
   ColorTheme,
   InvocationEvent,
   Locale,
   LogLevel,
+  NetworkInterceptionMode,
   ReproStepsMode,
   StringKey,
   WelcomeMessageMode,
@@ -239,13 +242,40 @@ describe('Instabug Module', () => {
       debugLogsLevel: LogLevel.debug,
       codePushVersion: '1.1.0',
     };
+    const usesNativeNetworkInterception = false;
+
+    Instabug.init(instabugConfig);
+
+    expect(NetworkLogger.setEnabled).toBeCalledWith(true);
+    expect(NativeInstabug.init).toBeCalledTimes(1);
+    expect(NativeInstabug.init).toBeCalledWith(
+      instabugConfig.token,
+      instabugConfig.invocationEvents,
+      instabugConfig.debugLogsLevel,
+      usesNativeNetworkInterception,
+      instabugConfig.codePushVersion,
+    );
+  });
+
+  it('init should disable JavaScript interceptor when using native interception mode', () => {
+    const instabugConfig = {
+      token: 'some-token',
+      invocationEvents: [InvocationEvent.floatingButton, InvocationEvent.shake],
+      debugLogsLevel: LogLevel.debug,
+      networkInterceptionMode: NetworkInterceptionMode.native,
+      codePushVersion: '1.1.0',
+    };
+
     Instabug.init(instabugConfig);
 
+    expect(NetworkLogger.setEnabled).not.toBeCalled();
     expect(NativeInstabug.init).toBeCalledTimes(1);
     expect(NativeInstabug.init).toBeCalledWith(
       instabugConfig.token,
       instabugConfig.invocationEvents,
       instabugConfig.debugLogsLevel,
+      // usesNativeNetworkInterception should be true when using native interception mode
+      true,
       instabugConfig.codePushVersion,
     );
   });
