[MOB-10572] Add new APIs (#295)

* Add `Instabug.setEnabled` API

* Add Instabug.setEnabled unit test

* Deprecate enableAndroid and disableAndroid APIs

* Add `setDisclaimerText` API

* Add setDisclaimerText unit test

* Add `setCommentMinimumCharacterCount` API

* Add setCommentMinimumCharacterCount unit test

* Update CHANGELOG.md

* Add doc comment setCommentMinimumCharacterCount

* Keep annotations after doc comments

Author: DavidMina96

CHANGELOG.md

@@ -1,5 +1,8 @@
 ## Unreleased
 
+* Adds BugReporting.setDisclaimerText API
+* Adds BugReporting.setCommentMinimumCharacterCount API
+* Deprecates Instabug.enableAndroid and Instabug.disableAndroid APIs in favour of a new API Instabug.setEnabled, which works on both platforms
 * Fixes main thread violation on Android
 * Fixes an issue with request and response headers parameters type causing network requests not getting logged on iOS
 * Uses pigeon for internal communication between Flutter and the host platform

android/src/main/java/com/instabug/flutter/modules/BugReportingApi.java

@@ -149,4 +149,21 @@ public void reply(Void reply) {
             }
         });
     }
+
+    @Override
+    public void setDisclaimerText(@NonNull String text) {
+        BugReporting.setDisclaimerText(text);
+    }
+
+    @Override
+    public void setCommentMinimumCharacterCount(@NonNull Long limit, @Nullable List<String> reportTypes) {
+        int[] reportTypesArray = reportTypes == null ? new int[0] : new int[reportTypes.size()];
+        if(reportTypes != null){
+        for (int i = 0; i < reportTypes.size(); i++) {
+            String key = reportTypes.get(i);
+            reportTypesArray[i] = ArgsRegistry.getDeserializedValue(key);
+        }
+    }
+        BugReporting.setCommentMinimumCharacterCount(limit.intValue(), reportTypesArray);
+    }
 }

android/src/main/java/com/instabug/flutter/modules/InstabugApi.java

@@ -73,6 +73,18 @@ private void setCurrentPlatform() {
         }
     }
 
+    @Override
+    public void setEnabled(@NonNull Boolean isEnabled) {
+        try {
+            if(isEnabled)
+                Instabug.enable();
+            else
+                Instabug.disable();
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+    }
+
     public void start(@NonNull String token, @NonNull List<String> invocationEvents) {
         setCurrentPlatform();
 

ios/Classes/Modules/BugReportingApi.m

@@ -146,4 +146,23 @@ - (void)bindOnDismissCallbackWithError:(FlutterError *_Nullable *_Nonnull)error
     };
 }
 
+- (void)setDisclaimerTextText:(NSString *)text error:(FlutterError *_Nullable *_Nonnull)error {
+    [IBGBugReporting setDisclaimerText:text];
+}
+
+- (void)setCommentMinimumCharacterCountLimit:(NSNumber *)limit reportTypes:(nullable NSArray<NSString *> *)reportTypes error:(FlutterError *_Nullable *_Nonnull)error {
+    IBGBugReportingReportType resolvedTypes = 0;
+
+    if (![reportTypes count]) {
+        resolvedTypes = (ArgsRegistry.reportTypes[@"ReportType.bug"]).integerValue | (ArgsRegistry.reportTypes[@"ReportType.feedback"]).integerValue | (ArgsRegistry.reportTypes[@"ReportType.question"]).integerValue;
+    }
+    else {
+        for (NSString *reportType in reportTypes) {
+            resolvedTypes |= (ArgsRegistry.reportTypes[reportType]).integerValue;
+        }
+    }
+    
+    [IBGBugReporting setCommentMinimumCharacterCountForReportTypes:resolvedTypes withLimit:limit.intValue];
+}
+
 @end

ios/Classes/Modules/InstabugApi.m

@@ -13,6 +13,10 @@ extern void InitInstabugApi(id<FlutterBinaryMessenger> messenger) {
 
 @implementation InstabugApi
 
+- (void)setEnabledIsEnabled:(NSNumber *)isEnabled error:(FlutterError *_Nullable *_Nonnull)error {
+    Instabug.enabled = [isEnabled boolValue];
+}
+
 - (void)startToken:(NSString *)token invocationEvents:(NSArray<NSString *> *)invocationEvents error:(FlutterError *_Nullable *_Nonnull)error {
     SEL setPrivateApiSEL = NSSelectorFromString(@"setCurrentPlatform:");
     if ([[Instabug class] respondsToSelector:setPrivateApiSEL]) {

lib/src/modules/bug_reporting.dart

@@ -227,4 +227,26 @@ class BugReporting implements BugReportingFlutterApi {
       return _host.setShakingThresholdForAndroid(threshold);
     }
   }
+
+  /// Adds a disclaimer text within the bug reporting form,
+  /// which can include hyperlinked text.
+  /// [text] String text
+  static Future<void> setDisclaimerText(String text) async {
+    return _host.setDisclaimerText(text);
+  }
+
+  /// Sets a minimum number of characters as a requirement for
+  /// the comments field in the different report types.
+  /// [limit] int number of characters
+  /// [reportTypes] Optional list of ReportType. If it's not passed,
+  /// the limit will apply to all report types.
+  static Future<void> setCommentMinimumCharacterCount(
+    int limit, [
+    List<ReportType>? reportTypes,
+  ]) async {
+    return _host.setCommentMinimumCharacterCount(
+      limit,
+      reportTypes?.mapToString(),
+    );
+  }
 }

lib/src/modules/instabug.dart

@@ -129,6 +129,12 @@ class Instabug {
     Surveys.init();
   }
 
+  /// Enables or disables Instabug functionality.
+  /// [boolean] isEnabled
+  static Future<void> setEnabled(bool isEnabled) async {
+    return _host.setEnabled(isEnabled);
+  }
+
   /// Starts the SDK.
   /// This is the main SDK method that does all the magic. This is the only
   /// method that SHOULD be called.
@@ -341,6 +347,9 @@ class Instabug {
 
   /// Android Only
   /// Enables all Instabug functionality
+  @Deprecated(
+    "Use [Instabug.setEnabled(true)] instead. This will work on both Android and iOS. ",
+  )
   static Future<void> enableAndroid() async {
     if (IBGBuildInfo.I.isAndroid) {
       return _host.enableAndroid();
@@ -349,6 +358,9 @@ class Instabug {
 
   /// Android Only
   /// Disables all Instabug functionality
+  @Deprecated(
+    "Use [Instabug.setEnabled(false)] instead. This will work on both Android and iOS. ",
+  )
   static Future<void> disableAndroid() async {
     if (IBGBuildInfo.I.isAndroid) {
       return _host.disableAndroid();

pigeons/bug_reporting.api.dart

@@ -27,4 +27,9 @@ abstract class BugReportingHostApi {
   );
   void bindOnInvokeCallback();
   void bindOnDismissCallback();
+  void setDisclaimerText(String text);
+  void setCommentMinimumCharacterCount(
+    int limit,
+    List<String>? reportTypes,
+  );
 }

pigeons/instabug.api.dart

@@ -2,6 +2,7 @@ import 'package:pigeon/pigeon.dart';
 
 @HostApi()
 abstract class InstabugHostApi {
+  void setEnabled(bool isEnabled);
   void start(String token, List<String> invocationEvents);
 
   void show();

test/bug_reporting_test.dart

@@ -178,4 +178,25 @@ void main() {
       mHost.bindOnDismissCallback(),
     ).called(1);
   });
+
+  test('[setDisclaimerText] should call host method', () async {
+    const text = 'This is a disclaimer text!';
+
+    await BugReporting.setDisclaimerText(text);
+
+    verify(
+      mHost.setDisclaimerText(text),
+    ).called(1);
+  });
+
+  test('[setCommentMinimumCharacterCount] should call host method', () async {
+    const count = 20;
+    const reportTypes = [ReportType.bug];
+
+    await BugReporting.setCommentMinimumCharacterCount(count, reportTypes);
+
+    verify(
+      mHost.setCommentMinimumCharacterCount(count, reportTypes.mapToString()),
+    ).called(1);
+  });
 }