[MOB-10573] Support setSdkDebugLogsLevel on Android (#304)

* Add setSdkDebugLogsLevel implementation on Android

* Deprecate setDebugEnabled API

* Remove setDebugEnabled from Android bridge

* Deprecate APM.setLogLevel

* Update CHANGELOG.md

* Remove setDebugEnabled from pigeon spec and iOS

* Add `setSdkDebugLogsLevel` Android test

Author: DavidMina96

CHANGELOG.md

@@ -1,10 +1,11 @@
 ## Unreleased
 
 * Bumps Instabug Android SDK to v11.7.0
+* Adds new string keys: okButtonText, audio, image, screenRecording, messagesNotificationAndOthers, insufficientContentTitle, insufficientContentMessage
 * Fixes APM network logging on Android
 * Fixes a NullPointerException when overriding a string key that doesn't exist on Android
 * Removes redundant native logs
-* Adds new string keys: okButtonText, audio, image, screenRecording, messagesNotificationAndOthers, insufficientContentTitle, insufficientContentMessage
+* Deprecates Instabug.setDebugEnabled and APM.setLogLevel APIs in favour of Instabug.setSdkDebugLogsLevel, which controls the verbosity of SDK logs on both platforms
 
 ## 11.5.0 (2022-11-24)
 

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

@@ -247,14 +247,10 @@ public void run() {
         );
     }
 
-    @Override
-    public void setDebugEnabled(@NonNull Boolean enabled) {
-        Instabug.setDebugEnabled(enabled);
-    }
-
     @Override
     public void setSdkDebugLogsLevel(@NonNull String level) {
-        // iOS Only
+        final int sdkLogLevel = ArgsRegistry.sdkLogLevels.get(level);
+        Instabug.setSdkDebugLogsLevel(sdkLogLevel);
     }
 
     @Override

android/src/main/java/com/instabug/flutter/util/ArgsRegistry.java

@@ -201,4 +201,11 @@ public T get(Object key) {
         put("CustomTextPlaceHolderKey.messagesNotificationAndOthers", Key.CHATS_MULTIPLE_MESSAGE_NOTIFICATION);
         put("CustomTextPlaceHolderKey.insufficientContentMessage", Key.COMMENT_FIELD_INSUFFICIENT_CONTENT);
     }};
+
+    public static final ArgsMap<Integer> sdkLogLevels = new ArgsMap<Integer>() {{
+        put("IBGSDKDebugLogsLevel.none", com.instabug.library.LogLevel.NONE);
+        put("IBGSDKDebugLogsLevel.error", com.instabug.library.LogLevel.ERROR);
+        put("IBGSDKDebugLogsLevel.debug", com.instabug.library.LogLevel.DEBUG);
+        put("IBGSDKDebugLogsLevel.verbose", com.instabug.library.LogLevel.VERBOSE);
+    }};
 }

android/src/test/java/com/instabug/flutter/InstabugApiTest.java

@@ -369,14 +369,13 @@ public void testGetUserAttributes() {
         mInstabug.verify(Instabug::getAllUserAttributes);
     }
 
-    @SuppressWarnings("deprecation")
     @Test
-    public void testSetDebugEnabled() {
-        boolean isEnabled = true;
+    public void testSetSdkDebugLogsLevel() {
+        String level = "IBGSDKDebugLogsLevel.debug";
 
-        api.setDebugEnabled(isEnabled);
+        api.setSdkDebugLogsLevel(level);
 
-        mInstabug.verify(() -> Instabug.setDebugEnabled(isEnabled));
+        mInstabug.verify(() -> Instabug.setSdkDebugLogsLevel(com.instabug.library.LogLevel.DEBUG));
     }
 
     @Test

ios/Classes/Modules/InstabugApi.m

@@ -140,10 +140,6 @@ - (void)getUserAttributesWithCompletion:(nonnull void (^)(NSDictionary<NSString
     completion(Instabug.userAttributes, nil);
 }
 
-- (void)setDebugEnabledEnabled:(NSNumber *)enabled error:(FlutterError *_Nullable *_Nonnull)error {
-    // Android Only
-}
-
 - (void)setSdkDebugLogsLevelLevel:(NSString *)level error:(FlutterError *_Nullable *_Nonnull)error {
     IBGSDKDebugLogsLevel resolvedLevel = (ArgsRegistry.sdkLogLevels[level]).integerValue;
     [Instabug setSdkDebugLogsLevel:resolvedLevel];

lib/src/modules/apm.dart

@@ -36,6 +36,9 @@ class APM {
 
   /// Sets log Level to determine level of details in a log
   /// [logLevel] Enum value to determine the level
+  @Deprecated(
+    "Use [Instabug.setSdkDebugLogsLevel] instead. ",
+  )
   static Future<void> setLogLevel(LogLevel logLevel) async {
     return _host.setLogLevel(logLevel.toString());
   }

lib/src/modules/instabug.dart

@@ -291,9 +291,17 @@ class Instabug {
   /// Android only
   /// Enable/disable SDK logs
   /// [debugEnabled] desired state of debug mode.
+  @Deprecated(
+    "Use [Instabug.setSdkDebugLogsLevel] instead. This will work on both Android and iOS. ",
+  )
   static Future<void> setDebugEnabled(bool debugEnabled) async {
     if (IBGBuildInfo.instance.isAndroid) {
-      return _host.setDebugEnabled(debugEnabled);
+      if (debugEnabled) {
+        return _host
+            .setSdkDebugLogsLevel(IBGSDKDebugLogsLevel.verbose.toString());
+      } else {
+        return _host.setSdkDebugLogsLevel(IBGSDKDebugLogsLevel.none.toString());
+      }
     }
   }
 

pigeons/instabug.api.dart

@@ -39,7 +39,6 @@ abstract class InstabugHostApi {
   @async
   Map<String, String>? getUserAttributes();
 
-  void setDebugEnabled(bool enabled);
   void setSdkDebugLogsLevel(String level);
 
   void setReproStepsMode(String mode);

test/apm_test.dart

@@ -61,6 +61,7 @@ void main() {
   test('[setLogLevel] should call host method', () async {
     const level = LogLevel.debug;
 
+    // ignore: deprecated_member_use_from_same_package
     await APM.setLogLevel(level);
 
     verify(

test/instabug_test.dart

@@ -270,14 +270,17 @@ void main() {
     ).called(1);
   });
 
-  test('[setDebugEnabled] should call host method', () async {
+  test('[setDebugEnabled] should call setSdkDebugLogsLevel host method',
+      () async {
     const enabled = true;
+    const level = IBGSDKDebugLogsLevel.verbose;
     when(mBuildInfo.isAndroid).thenReturn(true);
 
+    // ignore: deprecated_member_use_from_same_package
     await Instabug.setDebugEnabled(enabled);
 
     verify(
-      mHost.setDebugEnabled(enabled),
+      mHost.setSdkDebugLogsLevel(level.toString()),
     ).called(1);
   });