add proactive bug reporting

Author: ahmedAlaaInstabug

examples/default/src/App.tsx

@@ -3,11 +3,7 @@ import { StyleSheet } from 'react-native';
 
 import { GestureHandlerRootView } from 'react-native-gesture-handler';
 import { NavigationContainer, useNavigationContainerRef } from '@react-navigation/native';
-import {
-  BugReporting,
-  ProactiveReportingConfigs,
-  type SessionMetadata,
-} from 'instabug-reactnative';
+import { BugReporting, type SessionMetadata } from 'instabug-reactnative';
 import Instabug, {
   CrashReporting,
   InvocationEvent,
@@ -23,6 +19,7 @@ import { nativeBaseTheme } from './theme/nativeBaseTheme';
 import { navigationTheme } from './theme/navigationTheme';
 
 import { QueryClient, QueryClientProvider } from 'react-query';
+import { createProactiveReportingConfig } from 'instabug-reactnative';
 
 const queryClient = new QueryClient();
 
@@ -52,15 +49,15 @@ export const App: React.FC = () => {
     });
     CrashReporting.setNDKCrashesEnabled(true);
 
+    Instabug.setCodePushVersion('33');
+
+    Instabug.setCodePushVersion('33');
+
     Instabug.setReproStepsConfig({
       all: ReproStepsMode.enabled,
     });
 
-    const config = new ProactiveReportingConfigs.Builder()
-      .setGapBetweenModals(5)
-      .setModalDelayAfterDetection(5)
-      .isEnabled(true)
-      .build();
+    const config = createProactiveReportingConfig();
 
     BugReporting.setProactiveReportingConfigurations(config);
   }, []);

src/index.ts

@@ -2,7 +2,10 @@
 import type { InstabugConfig } from './models/InstabugConfig';
 import Report from './models/Report';
 import Trace from './models/Trace';
-import ProactiveReportingConfigs from './models/ProactiveReportingConfigs';
+import {
+  createProactiveReportingConfig,
+  type ProactiveReportingConfigOptions,
+} from './models/ProactiveReportingConfigs';
 
 // Modules
 import * as APM from './modules/APM';
@@ -22,7 +25,8 @@ export * from './utils/Enums';
 export {
   Report,
   Trace,
-  ProactiveReportingConfigs,
+  ProactiveReportingConfigOptions,
+  createProactiveReportingConfig,
   APM,
   BugReporting,
   CrashReporting,

src/models/ProactiveReportingConfigs.ts

@@ -1,71 +1,37 @@
-export default class ProactiveReportingConfigs {
-  public readonly gapBetweenModals: number; // Time in seconds
-  public readonly modalDelayAfterDetection: number; // Time in seconds
-  public readonly enabled: boolean;
+import { Logger } from '../utils/logger';
+import InstabugConstants from '../utils/InstabugConstants';
 
-  // Private constructor to ensure it can only be created through the builder
-  private constructor(
-    gapBetweenModals: number,
-    modalDelayAfterDetection: number,
-    enabled: boolean,
-  ) {
-    this.gapBetweenModals = gapBetweenModals;
-    this.modalDelayAfterDetection = modalDelayAfterDetection;
-    this.enabled = enabled;
-  }
-
-  // Static method to get the builder instance
-  static Builder = class {
-    public gapBetweenModals: number = 30; // Default: 30 seconds
-    public modalDelayAfterDetection: number = 15; // Default: 15 seconds
-    public enabled: boolean = true; // Default: enabled
-
-    // Logger method to handle logging
-    public logWarning(message: string): void {
-      console.warn(`Warning: ${message}`);
-    }
-    /**
-     * controls the time gap between showing 2 proactive reporting dialogs in seconds
-     */
-    setGapBetweenModals(gap: number): this {
-      if (gap <= 0) {
-        this.logWarning(
-          'gapBetweenModals must be a positive number. Using default value of 30 seconds.',
-        );
-        return this;
-      }
-      this.gapBetweenModals = gap;
-      return this;
-    }
+export interface ProactiveReportingConfigOptions {
+  gapBetweenModals: number;
+  modalDelayAfterDetection: number;
+  enabled: boolean;
+}
 
-    /**
-     * controls the time gap between detecting a frustrating experience
-     */
-    setModalDelayAfterDetection(delay: number): this {
-      if (delay <= 0) {
-        this.logWarning(
-          'modalDelayAfterDetection must be a positive number. Using default value of 15 seconds.',
-        );
-        return this;
-      }
-      this.modalDelayAfterDetection = delay;
-      return this;
-    }
+export function createProactiveReportingConfig(
+  {
+    gapBetweenModals = 24,
+    modalDelayAfterDetection = 20,
+    enabled = true,
+  }: ProactiveReportingConfigOptions = {
+    gapBetweenModals: 24,
+    modalDelayAfterDetection: 20,
+    enabled: true,
+  },
+) {
+  // Validation and defaults
+  if (gapBetweenModals <= 0) {
+    Logger.warn(InstabugConstants.GAP_MODEL_ERROR_MESSAGE);
+    gapBetweenModals = 24; // Use default value if invalid
+  }
 
-    /**
-     * controls the state of the feature
-     */
-    isEnabled(enabled: boolean): this {
-      this.enabled = enabled;
-      return this;
-    }
+  if (modalDelayAfterDetection <= 0) {
+    Logger.warn(InstabugConstants.MODAL_DETECTION_ERROR_MESSAGE);
+    modalDelayAfterDetection = 20; // Use default value if invalid
+  }
 
-    build(): ProactiveReportingConfigs {
-      return new ProactiveReportingConfigs(
-        this.gapBetweenModals,
-        this.modalDelayAfterDetection,
-        this.enabled,
-      );
-    }
+  return {
+    gapBetweenModals,
+    modalDelayAfterDetection,
+    enabled,
   };
 }

src/modules/BugReporting.ts

@@ -11,7 +11,7 @@ import type {
   RecordingButtonPosition,
   ReportType,
 } from '../utils/Enums';
-import type ProactiveReportingConfigs from '../models/ProactiveReportingConfigs';
+import type { ProactiveReportingConfigOptions } from '../models/ProactiveReportingConfigs';
 
 /**
  * Enables and disables manual invocation and prompt options for bug and feedback.
@@ -237,7 +237,7 @@ export const setCommentMinimumCharacterCount = (limit: number, reportTypes?: Rep
  ** prompts end users to submit their feedback after our SDK automatically detects a frustrating experience.
  * @param config configuration of proActive  bug report.
  */
-export const setProactiveReportingConfigurations = (config: ProactiveReportingConfigs) => {
+export const setProactiveReportingConfigurations = (config: ProactiveReportingConfigOptions) => {
   NativeBugReporting.setProactiveReportingConfigurations(
     config.enabled,
     config.gapBetweenModals,

src/utils/InstabugConstants.ts

@@ -5,6 +5,11 @@ const InstabugConstants = {
   MAX_NETWORK_BODY_SIZE_IN_BYTES: 1024 * 10, // 10 KB
   MAX_RESPONSE_BODY_SIZE_EXCEEDED_MESSAGE:
     'The response body has not been logged because it exceeds the maximum size of 10 Kb',
+  GAP_MODEL_ERROR_MESSAGE:
+    'gapBetweenModals must be a positive number. Using default value of 24 seconds.',
+  MODAL_DETECTION_ERROR_MESSAGE:
+    'modalDelayAfterDetection must be a positive number. Using default value of 20 seconds.',
+
   MAX_REQUEST_BODY_SIZE_EXCEEDED_MESSAGE:
     'The request body has not been logged because it exceeds the maximum size of 10 Kb',
   SET_USER_ATTRIBUTES_ERROR_TYPE_MESSAGE:

test/modules/BugReporting.spec.ts

@@ -9,8 +9,8 @@ import {
   InvocationOption,
   RecordingButtonPosition,
   ReportType,
-} from '../../src/utils/Enums';
-import ProactiveReportingConfigs from '../../src/models/ProactiveReportingConfigs';
+} from '../../src';
+import { createProactiveReportingConfig } from '../../src';
 
 describe('Testing BugReporting Module', () => {
   beforeEach(() => {
@@ -269,15 +269,11 @@ describe('Testing BugReporting Module', () => {
   });
 
   it('should call the native method setProactiveReportingConfigurations', () => {
-    const configs = new ProactiveReportingConfigs.Builder()
-      .setGapBetweenModals(2)
-      .setModalDelayAfterDetection(20)
-      .isEnabled(true)
-      .build();
+    const configs = createProactiveReportingConfig();
 
     BugReporting.setProactiveReportingConfigurations(configs);
 
     expect(NativeBugReporting.setProactiveReportingConfigurations).toBeCalledTimes(1);
-    expect(NativeBugReporting.setProactiveReportingConfigurations).toBeCalledWith(true, 2, 20);
+    expect(NativeBugReporting.setProactiveReportingConfigurations).toBeCalledWith(true, 24, 20);
   });
 });