feat: support bug reporting user consents (#1383)

AyaMahmoud148 · web-flow · commit 457f7e80973e · 2025-05-20T10:12:16.000+03:00
* feat: support bug reporting user consents

* fix: ios tests

* fix: add change log

* fix: userConsentTypo

* fix: action type ios nullability

* fix: ios nullability
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## [Unreleased]
+
+### Added
+
+- Add support for BugReporting user consents. ([#1383](https://github.com/Instabug/Instabug-React-Native/pull/1383))
+
 ## [14.3.0](https://github.com/Instabug/Instabug-React-Native/compare/v14.1.0...14.3.0)
 
 ### Added
diff --git a/android/src/main/java/com/instabug/reactlibrary/ArgsRegistry.java b/android/src/main/java/com/instabug/reactlibrary/ArgsRegistry.java
@@ -60,6 +60,7 @@ static Map<String, Object> getAll() {
             putAll(locales);
             putAll(placeholders);
             putAll(launchType);
+            putAll(userConsentActionType);
         }};
     }
 
@@ -142,6 +143,12 @@ static Map<String, Object> getAll() {
         put("reproStepsDisabled", ReproMode.Disable);
     }};
 
+    static final ArgsMap<String> userConsentActionType = new ArgsMap<String>() {{
+        put("dropAutoCapturedMedia",  com.instabug.bug.userConsent.ActionType.DROP_AUTO_CAPTURED_MEDIA);
+        put("dropLogs",  com.instabug.bug.userConsent.ActionType.DROP_LOGS);
+        put("noChat",  com.instabug.bug.userConsent.ActionType.NO_CHAT);
+    }};
+
     static final ArgsMap<Integer> sdkLogLevels = new ArgsMap<Integer>() {{
         put("sdkDebugLogsLevelNone", com.instabug.library.LogLevel.NONE);
         put("sdkDebugLogsLevelError", com.instabug.library.LogLevel.ERROR);
diff --git a/android/src/main/java/com/instabug/reactlibrary/RNInstabugBugReportingModule.java b/android/src/main/java/com/instabug/reactlibrary/RNInstabugBugReportingModule.java
@@ -2,6 +2,7 @@
 
 import android.annotation.SuppressLint;
 import android.annotation.TargetApi;
+import androidx.annotation.Nullable;
 
 import com.facebook.react.bridge.Arguments;
 import com.facebook.react.bridge.Callback;
@@ -21,6 +22,7 @@
 import com.instabug.reactlibrary.utils.ArrayUtil;
 import com.instabug.reactlibrary.utils.EventEmitterModule;
 import com.instabug.reactlibrary.utils.MainThreadHandler;
+import com.instabug.bug.userConsent.ActionType;
 
 import java.util.ArrayList;
 
@@ -415,4 +417,30 @@ public void run() {
             }
         });
     }
+
+    /**
+    * Adds a user consent item to the bug reporting
+    * @param key A unique identifier string for the consent item.
+    * @param description The text shown to the user describing the consent item.
+    * @param mandatory Whether the user must agree to this item before submitting a report.
+    * @param checked Whether the consent checkbox is pre-selected.
+    * @param actionType A string representing the action type to map to SDK behavior.
+    */
+    @ReactMethod
+    public void addUserConsent(String key, String description, boolean mandatory, boolean checked, @Nullable String actionType) {
+        MainThreadHandler.runOnMainThread(new Runnable() {
+            @Override
+            public void run() {
+            try {
+            String mappedActionType = ArgsRegistry.userConsentActionType.get(actionType);
+        BugReporting.addUserConsent(key, description, mandatory, checked, mappedActionType);
+            } catch (Exception e) {
+                e.printStackTrace();
+            }
+        }
+    });
+    
+    }
+    
+
 }
diff --git a/android/src/test/java/com/instabug/reactlibrary/RNInstabugBugReportingModuleTest.java b/android/src/test/java/com/instabug/reactlibrary/RNInstabugBugReportingModuleTest.java
@@ -362,4 +362,22 @@ public Object answer(InvocationOnMock invocation) {
         
         BugReporting.setCommentMinimumCharacterCount(count, type1);
     }
+    @Test
+    public void TestAddUserConsent() {
+               final Map<String, String> args = ArgsRegistry.userConsentActionType;
+               final String[] keysArray = args.keySet().toArray(new String[0]);
+       
+               final String key = "testKey";
+               final String description = "Consent description";
+               final boolean mandatory = true;
+               final boolean checked = true;
+               final String inputAction = keysArray[0];
+       
+               final String expectedMappedAction = args.get(inputAction);
+       
+               bugReportingModule.addUserConsent(key, description, mandatory, checked, inputAction);
+           
+               verify(BugReporting.class, VerificationModeFactory.times(1));
+               BugReporting.addUserConsent(key, description, mandatory, checked, expectedMappedAction);
+    }
 }
diff --git a/examples/default/ios/InstabugTests/InstabugBugReportingTests.m b/examples/default/ios/InstabugTests/InstabugBugReportingTests.m
@@ -187,6 +187,27 @@ - (void) testSetCommentMinimumCharacterCount {
   [self.instabugBridge setCommentMinimumCharacterCount:limit reportTypes:reportTypesArr];
   OCMVerify([mock setCommentMinimumCharacterCountForReportTypes:reportTypes withLimit:limit.intValue]);
 }
+- (void)testAddUserConsentWithKey {
+  id mock = OCMClassMock([IBGBugReporting class]);
 
+  NSString *key = @"testKey";
+  NSString *description = @"Consent description";
+  BOOL mandatory = YES;
+  BOOL checked = NO;
+  NSNumber *actionType = @2;
+  IBGActionType mappedActionType = (IBGActionType)[actionType integerValue];
+
+  [self.instabugBridge addUserConsent:key
+                                  description:description
+                                    mandatory:mandatory
+                                      checked:checked
+                                   actionType:actionType];
+
+  OCMVerify([mock addUserConsentWithKey:key
+                                        description:description
+                                          mandatory:mandatory
+                                            checked:checked
+                                         actionType:mappedActionType]);
+}
 @end
 
diff --git a/ios/RNInstabug/ArgsRegistry.h b/ios/RNInstabug/ArgsRegistry.h
@@ -23,6 +23,7 @@ typedef NSDictionary<NSString*, NSNumber*> ArgsDictionary;
 + (ArgsDictionary *) locales;
 + (ArgsDictionary *)nonFatalExceptionLevel;
 + (ArgsDictionary *) launchType;
++ (ArgsDictionary *) userConsentActionTypes;
 
 + (NSDictionary<NSString *, NSString *> *) placeholders;
 
diff --git a/ios/RNInstabug/ArgsRegistry.m b/ios/RNInstabug/ArgsRegistry.m
@@ -21,7 +21,8 @@ + (NSMutableDictionary *) getAll {
     [all addEntriesFromDictionary:ArgsRegistry.nonFatalExceptionLevel];
     [all addEntriesFromDictionary:ArgsRegistry.placeholders];
     [all addEntriesFromDictionary:ArgsRegistry.launchType];
-
+    [all addEntriesFromDictionary:ArgsRegistry.userConsentActionTypes];
+    
     return all;
 }
 
@@ -110,7 +111,13 @@ + (ArgsDictionary *) actionTypes {
         @"addCommentToFeature": @(IBGActionAddCommentToFeature),
     };
 }
-
++ (ArgsDictionary *) userConsentActionTypes {
+    return @{
+        @"dropAutoCapturedMedia": @(IBGActionTypeDropAutoCapturedMedia),
+        @"dropLogs": @(IBGActionTypeDropLogs),
+        @"noChat": @(IBGActionTypeNoChat)
+    };
+}
 + (ArgsDictionary *) extendedBugReportStates {
     return @{
         @"enabledWithRequiredFields": @(IBGExtendedBugReportModeEnabledWithRequiredFields),
diff --git a/ios/RNInstabug/InstabugBugReportingBridge.h b/ios/RNInstabug/InstabugBugReportingBridge.h
@@ -51,4 +51,10 @@
 
 - (void)setCommentMinimumCharacterCount:(NSNumber *)limit reportTypes:(NSArray *)reportTypes;
 
+- (void)addUserConsent:(NSString *)key
+                  description:(NSString *)description
+                    mandatory:(BOOL)mandatory
+                      checked:(BOOL)checked
+                   actionType:(id)actionType;
+
 @end
diff --git a/ios/RNInstabug/InstabugBugReportingBridge.m b/ios/RNInstabug/InstabugBugReportingBridge.m
@@ -219,6 +219,21 @@ - (void) showBugReportingWithReportTypeAndOptionsHelper:(NSArray*)args {
    [IBGBugReporting setCommentMinimumCharacterCountForReportTypes:parsedReportTypes withLimit:limit.intValue];
 }
 
+RCT_EXPORT_METHOD(addUserConsent:(NSString *)key
+                  description:(NSString *)description
+                  mandatory:(BOOL)mandatory
+                  checked:(BOOL)checked
+                  actionType:(id)actionType) {
+    IBGActionType mappedActionType = (IBGActionType)[actionType integerValue];
+
+    [IBGBugReporting addUserConsentWithKey:key
+                               description:description
+                                 mandatory:mandatory
+                                   checked:checked
+                                actionType:mappedActionType];
+}
+
+
 @synthesize description;
 
 @synthesize hash;
diff --git a/ios/RNInstabug/RCTConvert+InstabugEnums.m b/ios/RNInstabug/RCTConvert+InstabugEnums.m
@@ -109,4 +109,11 @@ @implementation RCTConvert (InstabugEnums)
   integerValue
 );
 
+RCT_ENUM_CONVERTER(
+  IBGActionType,
+  ArgsRegistry.userConsentActionTypes,
+  IBGActionTypeNoChat,
+  integerValue
+);
+
 @end
diff --git a/src/modules/BugReporting.ts b/src/modules/BugReporting.ts
@@ -10,6 +10,7 @@ import type {
   InvocationOption,
   RecordingButtonPosition,
   ReportType,
+  userConsentActionType,
 } from '../utils/Enums';
 
 /**
@@ -169,6 +170,23 @@ export const setViewHierarchyEnabled = (isEnabled: boolean) => {
   NativeBugReporting.setViewHierarchyEnabled(isEnabled);
 };
 
+/**
+ * Adds a user consent item to the bug reporting form.
+ * @param key A unique identifier string for the consent item.
+ * @param description The text shown to the user describing the consent item.
+ * @param mandatory Whether the user must agree to this item before submitting a report.
+ * @param checked Whether the consent checkbox is pre-selected.
+ * @param actionType A string representing the action type to map to SDK behavior.
+ */
+export const addUserConsent = (
+  key: string,
+  description: string,
+  mandatory: boolean,
+  checked: boolean,
+  actionType?: userConsentActionType,
+) => {
+  NativeBugReporting.addUserConsent(key, description, mandatory, checked, actionType);
+};
 /**
  * Sets a block of code to be executed when a prompt option is selected.
  * @param handler - A callback that gets executed when a prompt option is selected.
diff --git a/src/native/NativeBugReporting.ts b/src/native/NativeBugReporting.ts
@@ -8,6 +8,7 @@ import type {
   InvocationOption,
   RecordingButtonPosition,
   ReportType,
+  userConsentActionType,
 } from '../utils/Enums';
 import { NativeModules } from './NativePackage';
 
@@ -48,6 +49,14 @@ export interface BugReportingNativeModule extends NativeModule {
   setOnSDKDismissedHandler(
     handler: (dismissType: DismissType, reportType: ReportType) => void,
   ): void;
+
+  addUserConsent(
+    key: string,
+    description: string,
+    mandatory: boolean,
+    checked: boolean,
+    actionType?: userConsentActionType,
+  ): void;
 }
 
 export const NativeBugReporting = NativeModules.IBGBugReporting;
diff --git a/src/native/NativeConstants.ts b/src/native/NativeConstants.ts
@@ -13,15 +13,20 @@ export type NativeConstants = NativeSdkDebugLogsLevel &
   NativeLocale &
   NativeNonFatalErrorLevel &
   NativeStringKey &
-  NativeLaunchType;
+  NativeLaunchType &
+  NativeUserConsentActionType;
 
 interface NativeSdkDebugLogsLevel {
   sdkDebugLogsLevelVerbose: any;
   sdkDebugLogsLevelDebug: any;
   sdkDebugLogsLevelError: any;
   sdkDebugLogsLevelNone: any;
 }
-
+interface NativeUserConsentActionType {
+  dropAutoCapturedMedia: any;
+  dropLogs: any;
+  noChat: any;
+}
 interface NativeInvocationEvent {
   invocationEventNone: any;
   invocationEventShake: any;
diff --git a/src/utils/Enums.ts b/src/utils/Enums.ts
@@ -12,6 +12,15 @@ export enum LogLevel {
   error = constants.sdkDebugLogsLevelError,
   none = constants.sdkDebugLogsLevelNone,
 }
+/**
+ * Enum representing the available user consent action types.
+ *
+ */
+export enum userConsentActionType {
+  dropAutoCapturedMedia = constants.dropAutoCapturedMedia,
+  dropLogs = constants.dropLogs,
+  noChat = constants.noChat,
+}
 
 /**
  * The event used to invoke the feedback form.
diff --git a/test/mocks/mockBugReporting.ts b/test/mocks/mockBugReporting.ts
@@ -23,6 +23,7 @@ const mockBugReporting: BugReportingNativeModule = {
   setVideoRecordingFloatingButtonPosition: jest.fn(),
   setDisclaimerText: jest.fn(),
   setCommentMinimumCharacterCount: jest.fn(),
+  addUserConsent: jest.fn(),
 };
 
 export default mockBugReporting;
