Merge pull request #460 from Instabug/custom/ios-sdk-debug-logs

Mapping for `Instabug.setSdkDebugLogsLevel` [MOB-4367]

Author: Ali Abdelfattah

InstabugSample/ios/InstabugSampleTests/InstabugSampleTests.m

@@ -207,6 +207,15 @@ - (void)testSetReproStepsMode {
   OCMVerify([mock setReproStepsMode:reproStepsMode]);
 }
 
+- (void)testSetSdkDebugLogsLevel {
+  id mock = OCMClassMock([Instabug class]);
+  IBGSDKDebugLogsLevel sdkDebugLogsLevel = IBGSDKDebugLogsLevelVerbose;
+  
+  OCMStub([mock setSdkDebugLogsLevel:sdkDebugLogsLevel]);
+  [self.instabugBridge setSdkDebugLogsLevel:sdkDebugLogsLevel];
+  OCMVerify([mock setSdkDebugLogsLevel:sdkDebugLogsLevel]);
+}
+
 - (void)testSetUserAttribute {
   id mock = OCMClassMock([Instabug class]);
   NSString *key = @"key";

__tests__/index.spec.js

@@ -46,6 +46,7 @@ describe('Instabug Module', () => {
   const logDebug = sinon.spy(NativeModules.Instabug, 'logDebug');
   const clearLogs = sinon.spy(NativeModules.Instabug, 'clearLogs');
   const setReproStepsMode = sinon.spy(NativeModules.Instabug, 'setReproStepsMode');
+  const setSdkDebugLogsLevel = sinon.spy(NativeModules.Instabug, 'setSdkDebugLogsLevel');
   const setUserAttribute = sinon.spy(NativeModules.Instabug, 'setUserAttribute');
   const getUserAttribute = sinon.spy(NativeModules.Instabug, 'getUserAttribute');
   const removeUserAttribute = sinon.spy(NativeModules.Instabug, 'removeUserAttribute');
@@ -351,6 +352,13 @@ describe('Instabug Module', () => {
 
   });
 
+  it('should call the native method setSdkDebugLogsLevel', () => {
+    const debugLevel = Instabug.sdkDebugLogsLevel.sdkDebugLogsLevelVerbose;
+    Instabug.setSdkDebugLogsLevel(debugLevel);
+
+    expect(setSdkDebugLogsLevel.calledOnceWithExactly(debugLevel)).toBe(true);
+  });
+
   it('should call the native method setUserAttribute', () => {
 
     const key = 'age';

index.d.ts

@@ -146,6 +146,9 @@ export function setDidSelectPromptOptionHandler(
 export function setSessionProfilerEnabled(
   sessionProfilerEnabled: boolean
 ): void;
+export function setSdkDebugLogsLevel(
+  sdkDebugLogsLevel: sdkDebugLogsLevel
+): void;
 export function getUnreadMessagesCount(
   messageCountCallback: (count: number) => void
 ): void;
@@ -248,6 +251,12 @@ export enum invocationOptions {
   invocationOptionsCommentFieldRequired,
   invocationOptionsDisablePostSendingDialog
 }
+export enum sdkDebugLogsLevel {
+  sdkDebugLogsLevelVerbose,
+  sdkDebugLogsLevelDebug,
+  sdkDebugLogsLevelError,
+  sdkDebugLogsLevelNone,
+}
 export enum extendedBugReportMode {
   enabledWithRequiredFields,
   enabledWithOptionalFields,

index.js

@@ -144,6 +144,16 @@ const InstabugModule = {
     Instabug.setSessionProfilerEnabled(sessionProfilerEnabled);
   },
 
+  /**
+   * This API sets the verbosity level of logs used to debug The SDK. The defualt value in debug 
+   * mode is sdkDebugLogsLevelVerbose and in production is sdkDebugLogsLevelError.
+   * @param {sdkDebugLogsLevel} sdkDebugLogsLevel - The verbosity level of logs.
+   *
+   */
+  setSdkDebugLogsLevel(sdkDebugLogsLevel) {
+    Instabug.setSdkDebugLogsLevel(sdkDebugLogsLevel);
+  },
+
   /* istanbul ignore next */
   /**
    * @deprecated use {@link Replies.getUnreadRepliesCount}
@@ -811,6 +821,19 @@ const InstabugModule = {
     invocationOptionsDisablePostSendingDialog: Instabug.disablePostSendingDialog
   },
 
+  /**
+   * Verbosity level of the SDK debug logs. This has nothing to do with IBGLog,
+   * and only affect the logs used to debug the SDK itself.
+   * @readonly
+   * @enum {number}
+   */
+  sdkDebugLogsLevel: {
+    sdkDebugLogsLevelVerbose: Instabug.sdkDebugLogsLevelVerbose,
+    sdkDebugLogsLevelDebug: Instabug.sdkDebugLogsLevelDebug,
+    sdkDebugLogsLevelError: Instabug.sdkDebugLogsLevelError,
+    sdkDebugLogsLevelNone: Instabug.sdkDebugLogsLevelNone,
+  },
+
   /**
    *  The extended bug report mode
    * @readonly

ios/RNInstabug/InstabugReactBridge.h

@@ -32,6 +32,8 @@
 
 - (void)setSessionProfilerEnabled:(BOOL)sessionProfilerEnabled;
 
+- (void)setSdkDebugLogsLevel:(IBGSDKDebugLogsLevel)sdkDebugLogsLevel;
+
 - (void)setLocale:(IBGLocale)locale;
 
 - (void)setColorTheme:(IBGColorTheme)colorTheme;
@@ -98,5 +100,4 @@
 - (void)logError:(NSString *)log;
 - (void)clearLogs;
 
-
 @end

ios/RNInstabug/InstabugReactBridge.m

@@ -202,6 +202,10 @@ - (dispatch_queue_t)methodQueue {
     currentReport = nil;
 }
 
+RCT_EXPORT_METHOD(setSdkDebugLogsLevel:(IBGSDKDebugLogsLevel)sdkDebugLogsLevel) {
+    [Instabug setSdkDebugLogsLevel:sdkDebugLogsLevel];
+}
+
 RCT_EXPORT_METHOD(setLocale:(IBGLocale)locale) {
     [Instabug setLocale:locale];
 }
@@ -448,7 +452,12 @@ - (NSDictionary *)constantsToExport
               @"localeSwedish": @(IBGLocaleSwedish),
               @"localeTurkish": @(IBGLocaleTurkish),
 
-              
+              @"sdkDebugLogsLevelVerbose": @(IBGSDKDebugLogsLevelVerbose),
+              @"sdkDebugLogsLevelDebug": @(IBGSDKDebugLogsLevelDebug),
+              @"sdkDebugLogsLevelError": @(IBGSDKDebugLogsLevelError),
+              @"sdkDebugLogsLevelNone": @(IBGSDKDebugLogsLevelNone),
+
+
               @"emailFieldHidden": @(IBGBugReportingInvocationOptionEmailFieldHidden),
               @"emailFieldOptional": @(IBGBugReportingInvocationOptionEmailFieldOptional),
               @"commentFieldRequired": @(IBGBugReportingInvocationOptionCommentFieldRequired),

ios/RNInstabug/RCTConvert+InstabugEnums.m

@@ -47,6 +47,13 @@ @implementation RCTConvert (InstabugEnums)
                                       @"reproStepsEnabledWithNoScreenshots": @(IBGUserStepsModeEnabledWithNoScreenshots)
                                       }), IBGUserStepsModeEnabledWithNoScreenshots, integerValue)
 
+RCT_ENUM_CONVERTER(IBGSDKDebugLogsLevel, (@{
+                                      @"sdkDebugLogsLevelVerbose": @(IBGSDKDebugLogsLevelVerbose),
+                                      @"sdkDebugLogsLevelDebug": @(IBGSDKDebugLogsLevelDebug),
+                                      @"sdkDebugLogsLevelError": @(IBGSDKDebugLogsLevelError),
+                                      @"sdkDebugLogsLevelNone": @(IBGSDKDebugLogsLevelNone),
+                                      }), IBGSDKDebugLogsLevelError, integerValue)
+
 RCT_ENUM_CONVERTER(IBGExtendedBugReportMode, (@{
                                       @"enabledWithRequiredFields": @(IBGExtendedBugReportModeEnabledWithRequiredFields),
                                       @"enabledWithOptionalFields": @(IBGExtendedBugReportModeEnabledWithOptionalFields),

jest/mockInstabug.js

@@ -26,6 +26,7 @@ jest.mock('NativeModules', () => {
             logDebug: jest.fn(),
             clearLogs: jest.fn(),
             setReproStepsMode: jest.fn(),
+            setSdkDebugLogsLevel: jest.fn(),
             setUserAttribute: jest.fn(),
             getUserAttribute: jest.fn((_, cb) => cb('24')),
             removeUserAttribute: jest.fn(),