Merge pull request #43 from bugfender/feature/maximumLocalStorageSize

Feature/maximum local storage size

Author: Fran Montiel

README.md

@@ -75,6 +75,7 @@ Bugfender.init({
   // logUIEvents: true,
   // registerErrorHandler: true,
   // deviceName: 'Anonymous',
+  // maximumLocalStorageSize: 5 * 1024 * 1024, // Native specific
   // enableLogcatLogging: false, // Android specific
   // logBrowserEvents: true, // Web specific
   // build: '42', // Web specific

android/src/main/java/com/bugfender/react/RnBugfenderModule.java

@@ -60,8 +60,8 @@ public void setForceEnabled(boolean value) {
   }
 
   @ReactMethod
-  public void setMaximumLocalStorageSize(Integer sizeInMB) {
-    Bugfender.setMaximumLocalStorageSize(sizeInMB * 1024);
+  public void setMaximumLocalStorageSize(Integer sizeInBytes) {
+    Bugfender.setMaximumLocalStorageSize(sizeInBytes);
   }
 
   @ReactMethod

example/src/App.tsx

@@ -1,7 +1,7 @@
 import * as React from 'react';
 
-import { Button, Linking, StyleSheet, Text, View } from 'react-native';
-import { Bugfender, LogLevel, SDKOptionsBuilder } from '@bugfender/rn-bugfender';
+import {Button, Linking, StyleSheet, Text, View} from 'react-native';
+import {Bugfender, LogLevel, SDKOptionsBuilder} from '@bugfender/rn-bugfender';
 
 export default function App() {
 
@@ -27,6 +27,7 @@ export default function App() {
           logBrowserEvents: true,
         })
         .native({
+          maximumLocalStorageSize: 1024 * 1024,
           enableLogcatLogging: false,
         })
         .build()
@@ -94,7 +95,8 @@ export default function App() {
     throw new Error('Force crash' + 'Time: ' + hours + ':' + min + ':' + sec);
   }
 
-  function _onPressButton(): void {
+  async function _onPressButton(): Promise<void> {
+
     Bugfender.sendLog({
       level: LogLevel.Debug,
       tag: 'REACT',

src/bugfender.ts

@@ -1,18 +1,18 @@
-import { NativeModules, Platform } from 'react-native';
-import type { ISDKOptions } from './types/sdk-options';
-import type { UserFeedbackOptions, UserFeedbackResult } from './user-feedback';
-import { DefaultUserFeedbackOptions } from './user-feedback';
-import type { DeviceKeyValue } from './types/device';
-import type { ILogEntry } from './types/log';
-import { StringFormatter } from './string-formatter';
-import { LogLevel } from "./types/log";
-import { OverrideConsoleMethods } from "./override-console-methods";
-import { PrintToConsole } from "./print-to-console";
-import { SDKOptions } from "./sdk-options";
+import {NativeModules, Platform} from 'react-native';
+import type {ISDKOptions} from './types/sdk-options';
+import type {UserFeedbackOptions, UserFeedbackResult} from './user-feedback';
+import {DefaultUserFeedbackOptions} from './user-feedback';
+import type {DeviceKeyValue} from './types/device';
+import type {ILogEntry} from './types/log';
+import {StringFormatter} from './string-formatter';
+import {LogLevel} from "./types/log";
+import {OverrideConsoleMethods} from "./override-console-methods";
+import {PrintToConsole} from "./print-to-console";
+import {SDKOptions} from "./sdk-options";
 
 const LINKING_ERROR =
   `The package '@bugfender/rn-bugfender' doesn't seem to be linked. Make sure: \n\n` +
-  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
+  Platform.select({ios: "- You have run 'pod install'\n", default: ''}) +
   '- You rebuilt the app after installing the package\n' +
   '- You are not using Expo managed workflow\n';
 
@@ -38,41 +38,44 @@ class BugfenderClass {
     if (!this.initialized) {
       const validatedOptions = this.sdkOptions.init(options);
 
-      // Needs to be executed prior initialization
+      // region before init
       if (typeof options.deviceName !== 'undefined') {
         RnBugfender.overrideDeviceName(options.deviceName);
       }
-
-      // Library initialization
-      Platform.OS === 'ios'
-        ? RnBugfender.activateLogger(validatedOptions.appKey)
-        : RnBugfender.init(validatedOptions.appKey, false);
-
       if (typeof validatedOptions.apiURL !== 'undefined') {
         RnBugfender.setApiUrl(validatedOptions.apiURL);
       }
-
       if (typeof validatedOptions.baseURL !== 'undefined') {
         RnBugfender.setBaseUrl(validatedOptions.baseURL);
       }
+      // endregion before init
+
+      // region init
+      Platform.OS === 'ios'
+        ? RnBugfender.activateLogger(validatedOptions.appKey)
+        : RnBugfender.init(validatedOptions.appKey, validatedOptions.printToConsole ?? false);
+
+      if (validatedOptions.overrideConsoleMethods) {
+        this.overrideConsoleMethods.init(this.stringFormatter);
+      }
 
+      this.printToConsole.init(validatedOptions.printToConsole ?? true);
+      // endregion init
+
+      // region after init
       if (validatedOptions.enableLogcatLogging) {
         RnBugfender.enableLogcatLogging();
       }
-
       if (validatedOptions.logUIEvents) {
         RnBugfender.enableUIEventLogging();
       }
-
       if (validatedOptions.registerErrorHandler) {
         RnBugfender.enableCrashReporting();
       }
-
-      if (validatedOptions.overrideConsoleMethods) {
-        this.overrideConsoleMethods.init(this.stringFormatter);
-      }
-
-      this.printToConsole.init(validatedOptions.printToConsole ?? true);
+      RnBugfender.setMaximumLocalStorageSize(
+        validatedOptions.maximumLocalStorageSize
+      );
+      // endregion after init
 
       this.initialized = true;
     }

src/sdk-options.ts

@@ -28,6 +28,7 @@ export class SDKOptions {
       logUIEvents: true,
       registerErrorHandler: true,
       enableLogcatLogging: false,
+      maximumLocalStorageSize: 5 * 1024 * 1024,
       ...options,
     };
   }

src/types/sdk-options.ts

@@ -29,6 +29,8 @@ export interface ISDKWebOptions {
 }
 
 export interface ISDKNativeOptions {
+  /** Set the maximum size to store local log files in bytes (Native specific). Range accepted is from 1 MB to 50 MB. Defaults to 5 MB. **/
+  maximumLocalStorageSize?: number;
   /** Logs all logs written via Logcat (Android specific). Defaults to `false`. */
   enableLogcatLogging?: boolean;
 }
@@ -68,6 +70,7 @@ export class SDKOptionsBuilder {
       build: this.webOptions?.build,
       version: this.webOptions?.version,
       enableLogcatLogging: this.nativeOptions?.enableLogcatLogging,
+      maximumLocalStorageSize: this.nativeOptions?.maximumLocalStorageSize,
     };
 
     removeUndefinedAttributes(options);