add: setOnFeaturesUpdatedListener android listener and refactor instabug init method

Author: andrewdanieldev

android/src/main/java/com/instabug/reactlibrary/RNInstabugNetworkLoggerModule.java

@@ -136,6 +136,16 @@ public void run() {
         });
     }
 
+    @ReactMethod
+    public void resetNetworkLogsListener() {
+        MainThreadHandler.runOnMainThread(new Runnable() {
+            @Override
+            public void run() {
+                InternalAPM._registerNetworkLogSanitizer(null);
+            }
+        });
+    }
+
     @ReactMethod
     protected void updateNetworkLogSnapshot(String jsonString) {
 

examples/default/src/screens/apm/NetworkScreen.tsx

@@ -10,7 +10,6 @@ import { CustomButton } from '../../components/CustomButton';
 import axios from 'axios';
 import type { HomeStackParamList } from '../../navigation/HomeStack';
 import type { NativeStackScreenProps } from '@react-navigation/native-stack';
-import { ListTile } from '../../components/ListTile';
 
 export const NetworkScreen: React.FC<
   NativeStackScreenProps<HomeStackParamList, 'NetworkTraces'>
@@ -185,6 +184,11 @@ export const NetworkScreen: React.FC<
             />
 
             <CustomButton onPress={() => refetch()} title="Reload GraphQL" />
+            <CustomButton
+              onPress={() => navigation.navigate('HttpScreen')}
+              title="Go HTTP Screen"
+            />
+
             <View>
               {isLoading && <Text>Loading...</Text>}
               {isSuccess && <Text>GraphQL Data: {data.country.emoji}</Text>}
@@ -205,7 +209,6 @@ export const NetworkScreen: React.FC<
             ))}
           </HStack>
         </Section>
-        <ListTile title="HTTP Screen" onPress={() => navigation.navigate('HttpScreen')} />
       </Screen>
     </ScrollView>
   );

src/modules/Instabug.ts

@@ -27,6 +27,8 @@ import {
   WelcomeMessageMode,
 } from '../utils/Enums';
 import InstabugUtils, {
+  checkNetworkRequestHandlers,
+  resetNativeObfuscationListener,
   setApmNetworkFlagsIfChanged,
   stringifyIfNotString,
 } from '../utils/InstabugUtils';
@@ -107,20 +109,16 @@ export const init = async (config: InstabugConfig) => {
 
     // Add app state listener to handle background/foreground transitions
     addAppStateListener(async (nextAppState) => handleAppStateChange(nextAppState, config));
-  }
-
-  // Perform platform-specific checks and update interception mode
-  handleNetworkInterceptionMode(config);
 
-  // Log the current APM network flags and initialize Instabug
-  _logFlags();
+    handleNetworkInterceptionMode(config);
 
-  //Set APM networking flags for the first time
-  setApmNetworkFlagsIfChanged({
-    isNativeInterceptionFeatureEnabled: isNativeInterceptionFeatureEnabled,
-    hasAPMNetworkPlugin: hasAPMNetworkPlugin,
-    shouldEnableNativeInterception: shouldEnableNativeInterception,
-  });
+    //Set APM networking flags for the first time
+    setApmNetworkFlagsIfChanged({
+      isNativeInterceptionFeatureEnabled: isNativeInterceptionFeatureEnabled,
+      hasAPMNetworkPlugin: hasAPMNetworkPlugin,
+      shouldEnableNativeInterception: shouldEnableNativeInterception,
+    });
+  }
 
   // call Instabug native init method
   initializeNativeInstabug(config);
@@ -199,8 +197,9 @@ const handleNetworkInterceptionMode = (config: InstabugConfig) => {
     config.networkInterceptionMode = NetworkInterceptionMode.javascript; // Need to enable JS interceptor in all scenarios for Bugs & Crashes network logs
   } else if (Platform.OS === 'ios') {
     handleInterceptionModeForIOS(config);
+    //enable | disable native obfuscation and filtering synchronously
+    NetworkLogger.setNativeInterceptionEnabled(shouldEnableNativeInterception);
   }
-  NetworkLogger.setNativeInterceptionEnabled(shouldEnableNativeInterception);
 
   if (config.networkInterceptionMode === NetworkInterceptionMode.javascript) {
     NetworkLogger.setEnabled(true);
@@ -239,7 +238,7 @@ function handleAndroidNativeInterception() {
 }
 
 /**
- * Control either to enable or disable the native interception for iOS.
+ * Control either to enable or disable the native interception for iOS after the init method is called.
  */
 function handleIOSNativeInterception(config: InstabugConfig) {
   console.log(
@@ -315,9 +314,9 @@ const initializeNativeInstabug = (config: InstabugConfig) => {
 /**
  * Refresh the APM network configurations.
  */
-function refreshAPMNetworkConfigs(config: InstabugConfig) {
+function refreshAPMNetworkConfigs(config: InstabugConfig, forceRefreshIOS: boolean = true) {
   handleNetworkInterceptionMode(config);
-  if (Platform.OS === 'ios') {
+  if (Platform.OS === 'ios' && forceRefreshIOS) {
     handleIOSNativeInterception(config);
   }
   _logFlags();
@@ -326,6 +325,12 @@ function refreshAPMNetworkConfigs(config: InstabugConfig) {
     hasAPMNetworkPlugin,
     shouldEnableNativeInterception,
   });
+  if (shouldEnableNativeInterception) {
+    checkNetworkRequestHandlers();
+  } else {
+    // remove any attached [NativeNetworkLogger] Listeners if exists, to avoid memory leaks.
+    resetNativeObfuscationListener();
+  }
 }
 
 /**
@@ -334,8 +339,8 @@ function refreshAPMNetworkConfigs(config: InstabugConfig) {
 function addOnFeatureUpdatedListener(config: InstabugConfig) {
   emitter.addListener(NativeEvents.IBG_ON_FEATURES_UPDATED_CALLBACK, (flags) => {
     const { cpNativeInterceptionEnabled, hasAPMPlugin } = flags;
-    console.log(`Andrew: addOnFeatureUpdatedListener -> 
-    isNativeInterceptionFeatureEnabled: ${cpNativeInterceptionEnabled}, 
+    console.log(`Andrew: addOnFeatureUpdatedListener ->
+    isNativeInterceptionFeatureEnabled: ${cpNativeInterceptionEnabled},
     hasAPMNetworkPlugin: ${hasAPMPlugin}.
     `);
     isNativeInterceptionFeatureEnabled = cpNativeInterceptionEnabled;
@@ -344,7 +349,6 @@ function addOnFeatureUpdatedListener(config: InstabugConfig) {
       config.networkInterceptionMode === NetworkInterceptionMode.native;
     refreshAPMNetworkConfigs(config);
   });
-
   NativeInstabug.setOnFeaturesUpdatedListener();
 }
 

src/modules/NetworkLogger.ts

@@ -2,7 +2,13 @@ import type { RequestHandler } from '@apollo/client';
 
 import InstabugConstants from '../utils/InstabugConstants';
 import xhr, { NetworkData, ProgressCallback } from '../utils/XhrNetworkInterceptor';
-import { isContentTypeNotAllowed, reportNetworkLog } from '../utils/InstabugUtils';
+import {
+  isContentTypeNotAllowed,
+  registerFilteringAndObfuscationListener,
+  registerFilteringListener,
+  registerObfuscationListener,
+  reportNetworkLog,
+} from '../utils/InstabugUtils';
 import {
   NativeNetworkLogger,
   NativeNetworkLoggerEvent,
@@ -18,6 +24,7 @@ let _networkDataObfuscationHandler: NetworkDataObfuscationHandler | null | undef
 let _requestFilterExpression = 'false';
 let _isNativeInterceptionEnabled = false;
 let _networkListener: NetworkListenerType | null = null;
+let hasFilterExpression = false;
 
 /**
  * Sets whether network logs should be sent with bug reports.
@@ -34,6 +41,9 @@ export const setEnabled = (isEnabled: boolean) => {
         try {
           if (_networkDataObfuscationHandler) {
             network = await _networkDataObfuscationHandler(network);
+            console.log(
+              `Andrew: xhr.setOnDoneCallback -> _networkDataObfuscationHandler ${network.url}`,
+            );
           }
 
           if (network.requestBodySize > InstabugConstants.MAX_NETWORK_BODY_SIZE_IN_BYTES) {
@@ -82,6 +92,12 @@ export const setNativeInterceptionEnabled = (isEnabled: boolean) => {
   _isNativeInterceptionEnabled = isEnabled;
 };
 
+export const getNetworkDataObfuscationHandler = () => _networkDataObfuscationHandler;
+
+export const getRequestFilterExpression = () => _requestFilterExpression;
+
+export const hasRequestFilterExpression = () => hasFilterExpression;
+
 /**
  * Obfuscates any response data.
  * @param handler
@@ -90,13 +106,16 @@ export const setNetworkDataObfuscationHandler = (
   handler?: NetworkDataObfuscationHandler | null | undefined,
 ) => {
   _networkDataObfuscationHandler = handler;
-  if (_isNativeInterceptionEnabled) {
-    _registerNetworkLogsListener(NetworkListenerType.obfuscation, async (networkSnapshot) => {
-      if (_networkDataObfuscationHandler) {
-        networkSnapshot = await _networkDataObfuscationHandler(networkSnapshot);
-      }
-      NativeNetworkLogger.updateNetworkLogSnapshot(JSON.stringify(networkSnapshot));
-    });
+  if (_isNativeInterceptionEnabled && Platform.OS === 'ios') {
+    if (hasFilterExpression) {
+      console.log(
+        'Andrew: setNetworkDataObfuscationHandler -> registerFilteringAndObfuscationListenerV2',
+      );
+      registerFilteringAndObfuscationListener(_requestFilterExpression);
+    } else {
+      console.log('Andrew: setNetworkDataObfuscationHandler -> registerObfuscationListener');
+      registerObfuscationListener();
+    }
   }
 };
 
@@ -106,23 +125,18 @@ export const setNetworkDataObfuscationHandler = (
  */
 export const setRequestFilterExpression = (expression: string) => {
   _requestFilterExpression = expression;
-
-  if (_isNativeInterceptionEnabled) {
-    _registerNetworkLogsListener(NetworkListenerType.filtering, async (networkSnapshot) => {
-      // eslint-disable-next-line no-new-func
-      const predicate = Function('network', 'return ' + _requestFilterExpression);
-      const value = predicate(networkSnapshot);
-      if (Platform.OS === 'ios') {
-        // For iOS True == Request will be saved, False == will be ignored
-        NativeNetworkLogger.setNetworkLoggingRequestFilterPredicateIOS(networkSnapshot.id, !value);
-      } else {
-        // For Android Setting the [url] to an empty string will ignore the request;
-        if (value) {
-          networkSnapshot.url = '';
-          NativeNetworkLogger.updateNetworkLogSnapshot(JSON.stringify(networkSnapshot));
-        }
-      }
-    });
+  hasFilterExpression = true;
+
+  if (_isNativeInterceptionEnabled && Platform.OS === 'ios') {
+    if (_networkDataObfuscationHandler) {
+      console.log(
+        'Andrew: setRequestFilterExpression -> registerFilteringAndObfuscationListenerV2',
+      );
+      registerFilteringAndObfuscationListener(_requestFilterExpression);
+    } else {
+      console.log('Andrew: setRequestFilterExpression -> registerFilteringListener');
+      registerFilteringListener(_requestFilterExpression);
+    }
   }
 };
 
@@ -148,23 +162,6 @@ export const apolloLinkRequestHandler: RequestHandler = (operation, forward) =>
   return forward(operation);
 };
 
-/**
- * @internal
- * Exported for internal/testing purposes only.
- */
-export function registerNetworkLogsListener(
-  type: NetworkListenerType,
-  handler?: (networkSnapshot: NetworkData) => void,
-) {
-  if (process.env.NODE_ENV === 'test') {
-    _registerNetworkLogsListener(type, handler);
-  } else {
-    console.error(
-      `${InstabugConstants.IBG_APM_TAG}: The \`registerNetworkLogsListener()\` method is intended solely for testing purposes.`,
-    );
-  }
-}
-
 /**
  * @internal
  * Exported for internal/testing purposes only.
@@ -179,7 +176,11 @@ export const resetNetworkListener = () => {
   }
 };
 
-const _registerNetworkLogsListener = (
+/**
+ * @internal
+ * Exported for internal/testing purposes only.
+ */
+export const registerNetworkLogsListener = (
   type: NetworkListenerType,
   handler?: (networkSnapshot: NetworkData) => void,
 ) => {

src/native/NativeNetworkLogger.ts

@@ -16,6 +16,8 @@ export interface NetworkLoggerNativeModule extends NativeModule {
 
   hasAPMNetworkPlugin(): Promise<boolean>; // Android only
 
+  resetNetworkLogsListener(): void; //Android only
+
   setNetworkLoggingRequestFilterPredicateIOS(id: string, value: boolean): void; // iOS only
 
   forceStartNetworkLoggingIOS(): void; // iOS only;