feat: customize logs, traces and events reported to Bugsee dashboard

Author: koukibadr

src/app/.env.staging

@@ -6,4 +6,6 @@ APP_STORE_URL_IOS=https://apps.apple.com/us/app/uno-calculator/id1464736591
 APP_STORE_URL_Android=https://play.google.com/store/apps/details?id=uno.platform.calculator
 REMOTE_CONFIG_FETCH_INTERVAL_MINUTES=1
 DIAGNOSTIC_ENABLED=true
-IS_DATA_OBSCURE=true
+IS_DATA_OBSCURE=true
+DISABLE_LOG_COLLECTION=true
+FILTER_LOG_COLLECTION=true

src/app/lib/access/bugsee/bugsee_configuration_data.dart

@@ -1,16 +1,52 @@
-final class BugseeConfigurationData {
+import 'package:equatable/equatable.dart';
+
+final class BugseeConfigurationData extends Equatable {
   /// Gets whether the Bugsee SDK is enabled or not. if [Null] it fallbacks to a new installed app so it will be enabled.
   final bool? isBugseeEnabled;
 
   /// Indicate whether the video capturing feature in Bugsee is enabled or not.
   final bool? isVideoCaptureEnabled;
 
   /// Indicate whether bugsee obscure application data in videos and images or not.
-  final bool? isDataObscrured;
+  final bool? isDataObscured;
+
+  /// Indicate whether logs are collected or not.
+  final bool? isLogCollectionEnabled;
+
+  /// Indicate whether logs are filtred during reports or not.
+  final bool? isLogsFilterEnabled;
 
   const BugseeConfigurationData({
     this.isBugseeEnabled,
     this.isVideoCaptureEnabled,
-    this.isDataObscrured,
+    this.isDataObscured,
+    this.isLogCollectionEnabled,
+    this.isLogsFilterEnabled,
   });
+
+  BugseeConfigurationData copyWith({
+    bool? isBugseeEnabled,
+    bool? isVideoCaptureEnabled,
+    bool? isDataObscured,
+    bool? isLogCollectionEnabled,
+    bool? isLogsFilterEnabled,
+  }) =>
+      BugseeConfigurationData(
+        isBugseeEnabled: isBugseeEnabled ?? this.isBugseeEnabled,
+        isVideoCaptureEnabled:
+            isVideoCaptureEnabled ?? this.isVideoCaptureEnabled,
+        isDataObscured: isDataObscured ?? this.isDataObscured,
+        isLogCollectionEnabled:
+            isLogCollectionEnabled ?? this.isLogCollectionEnabled,
+        isLogsFilterEnabled: isLogsFilterEnabled ?? this.isLogsFilterEnabled,
+      );
+
+  @override
+  List<Object?> get props => [
+        isBugseeEnabled,
+        isVideoCaptureEnabled,
+        isDataObscured,
+        isLogCollectionEnabled,
+        isLogsFilterEnabled,
+      ];
 }

src/app/lib/access/bugsee/bugsee_repository.dart

@@ -16,20 +16,31 @@ abstract interface class BugseeRepository {
 
   /// Update whether data is obscure in shared prefs.
   Future setIsDataObscure(bool isDataObscure);
+
+  /// Update whether [disableLogCollectionKey] flag.
+  Future setIsLogCollectionEnabled(bool isLogCollectionEnabled);
+
+  /// Update whether [disableLogFilterKey] flag.
+  Future setIsLogFilterEnabled(bool isLogFilterEnabled);
 }
 
 final class _BugseeRepository implements BugseeRepository {
   final String _bugseeEnabledKey = 'bugseeEnabledKey';
   final String _videoCaptureKey = 'videoCaptureKey';
   final String _dataObscureKey = 'dataObscureKey';
+  final String _disableLogCollectionKey = 'disableLogCollectionKey';
+  final String _disableLogFilterKey = 'disableLogFilterKey';
 
   @override
   Future<BugseeConfigurationData> getBugseeConfiguration() async {
     final sharedPrefInstance = await SharedPreferences.getInstance();
     return BugseeConfigurationData(
       isBugseeEnabled: sharedPrefInstance.getBool(_bugseeEnabledKey),
       isVideoCaptureEnabled: sharedPrefInstance.getBool(_videoCaptureKey),
-      isDataObscrured: sharedPrefInstance.getBool(_dataObscureKey),
+      isDataObscured: sharedPrefInstance.getBool(_dataObscureKey),
+      isLogCollectionEnabled:
+          sharedPrefInstance.getBool(_disableLogCollectionKey),
+      isLogsFilterEnabled: sharedPrefInstance.getBool(_disableLogFilterKey),
     );
   }
 
@@ -80,4 +91,38 @@ final class _BugseeRepository implements BugseeRepository {
       );
     }
   }
+
+  @override
+  Future setIsLogCollectionEnabled(bool isLogCollected) async {
+    final sharedPrefInstance = await SharedPreferences.getInstance();
+
+    bool isSaved = await sharedPrefInstance.setBool(
+      _disableLogCollectionKey,
+      isLogCollected,
+    );
+
+    if (!isSaved) {
+      throw PersistenceException(
+        message:
+            'Error while setting $_disableLogCollectionKey $isLogCollected',
+      );
+    }
+  }
+
+  @override
+  Future setIsLogFilterEnabled(bool isLogFilterEnabled) async {
+    final sharedPrefInstance = await SharedPreferences.getInstance();
+
+    bool isSaved = await sharedPrefInstance.setBool(
+      _disableLogFilterKey,
+      isLogFilterEnabled,
+    );
+
+    if (!isSaved) {
+      throw PersistenceException(
+        message:
+            'Error while setting $_disableLogFilterKey $isLogFilterEnabled',
+      );
+    }
+  }
 }

src/app/lib/business/bugsee/bugsee_config_state.dart

@@ -1,37 +1,51 @@
 import 'package:equatable/equatable.dart';
 
 final class BugseeConfigState extends Equatable {
-  /// indicate if the app require a restart to reactivate the bugsee configurations
+  /// Indicate if the app require a restart to reactivate the bugsee configurations
   ///
   /// `true` only if `isConfigurationValid == true` and bugsee is turned on
   bool isRestartRequired;
 
-  /// indicate if bugsee is enabled or not
+  /// Indicate if bugsee is enabled or not
   /// by default bugsee is enabled if `isConfigurationValid == true`.
   bool isBugseeEnabled;
 
-  /// indicate whether video capturing is enabled or not.
+  /// Indicate whether video capturing is enabled or not.
   /// enabled by default if `isBugseeEnabled == true`.
   ///
   /// cannot be true if `isBugseeEnabled == false`.
   bool isVideoCaptureEnabled;
 
-  /// indicate if bugsee configuration is valid
+  /// Indicate if bugsee configuration is valid
   /// config is valid if app in release mode and the provided token is valid
   /// following the [bugseeTokenFormat] regex.
   bool isConfigurationValid;
 
-  /// indicate whether data is obscured in report videos
+  /// Indicate whether data is obscured in report videos
   ///
   /// cannot be true if `isBugseeEnabled == false`.
   bool isDataObscured;
 
+  /// Indicate whether log will be collected during Bugsee reporting or not
+  /// by default logs are collected but filterd.
+  ///
+  /// This value is initialized from [dotenv.env] and shared prefs storage.
+  bool isLogCollectionEnabled;
+
+  /// Indicate whether log will be filterd or not
+  /// by default all logs are filted using [bugseeFilterRegex] defined in [BugseeManager]
+  ///
+  /// This value is initialized from [dotenv.env] map and shared prefs storage.
+  bool isLogFilterEnabled;
+
   BugseeConfigState({
     this.isRestartRequired = false,
     this.isBugseeEnabled = false,
     this.isVideoCaptureEnabled = false,
     this.isConfigurationValid = false,
     this.isDataObscured = false,
+    this.isLogCollectionEnabled = false,
+    this.isLogFilterEnabled = false,
   });
 
   BugseeConfigState copyWith({
@@ -40,12 +54,17 @@ final class BugseeConfigState extends Equatable {
     bool? isVideoCaptureEnabled,
     bool? isConfigurationValid,
     bool? isDataObscured,
+    bool? isLogCollectionEnabled,
+    bool? isLogFilterEnabled,
   }) =>
       BugseeConfigState(
         isRestartRequired: isRestartRequired ?? this.isRestartRequired,
         isBugseeEnabled: isBugseeEnabled ?? this.isBugseeEnabled,
         isConfigurationValid: isConfigurationValid ?? this.isConfigurationValid,
         isDataObscured: isDataObscured ?? this.isDataObscured,
+        isLogFilterEnabled: isLogFilterEnabled ?? this.isLogFilterEnabled,
+        isLogCollectionEnabled:
+            isLogCollectionEnabled ?? this.isLogCollectionEnabled,
         isVideoCaptureEnabled:
             isVideoCaptureEnabled ?? this.isVideoCaptureEnabled,
       );