feat: implement custom attributes and attach file bugsee features

Author: koukibadr

build/steps-build-android.yml

@@ -89,8 +89,7 @@ steps:
     profileMode: false
     projectDirectory: '${{ parameters.pathToSrc }}/app'
     verboseMode: true
-    dartDefine: ENV=$(applicationEnvironment)
-    dartDefine: BUGSEE_TOKEN=$(AndroidBugseeToken)
+    dartDefineMulti: ENV=$(applicationEnvironment) BUGSEE_TOKEN=$(AndroidBugseeToken)
 
 - template: templates/flutter-diagnostics.yml
   parameters:

build/steps-build-ios.yml

@@ -95,8 +95,7 @@ steps:
     projectDirectory: '${{ parameters.pathToSrc }}/app'
     verboseMode: true
     exportOptionsPlist: '$(exportOptions.secureFilePath)'
-    dartDefine: ENV=$(applicationEnvironment)
-    dartDefine: BUGSEE_TOKEN=$(iOSBugseeToken)
+    dartDefineMulti: ENV=$(applicationEnvironment) BUGSEE_TOKEN=$(iOSBugseeToken)
 
 - template: templates/flutter-diagnostics.yml
   parameters:

src/app/.env.staging

@@ -8,4 +8,5 @@ REMOTE_CONFIG_FETCH_INTERVAL_MINUTES=1
 DIAGNOSTIC_ENABLED=true
 IS_DATA_OBSCURE=true
 DISABLE_LOG_COLLECTION=true
-FILTER_LOG_COLLECTION=true
+FILTER_LOG_COLLECTION=true
+ATTACH_LOG_FILE=true

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

@@ -16,12 +16,15 @@ final class BugseeConfigurationData extends Equatable {
   /// Indicate whether logs are filtred during reports or not.
   final bool? isLogsFilterEnabled;
 
+  final bool? attachLogFileEnabled;
+
   const BugseeConfigurationData({
     this.isBugseeEnabled,
     this.isVideoCaptureEnabled,
     this.isDataObscured,
     this.isLogCollectionEnabled,
     this.isLogsFilterEnabled,
+    this.attachLogFileEnabled,
   });
 
   BugseeConfigurationData copyWith({
@@ -30,6 +33,7 @@ final class BugseeConfigurationData extends Equatable {
     bool? isDataObscured,
     bool? isLogCollectionEnabled,
     bool? isLogsFilterEnabled,
+    bool? attachLogFileEnabled,
   }) =>
       BugseeConfigurationData(
         isBugseeEnabled: isBugseeEnabled ?? this.isBugseeEnabled,
@@ -39,6 +43,7 @@ final class BugseeConfigurationData extends Equatable {
         isLogCollectionEnabled:
             isLogCollectionEnabled ?? this.isLogCollectionEnabled,
         isLogsFilterEnabled: isLogsFilterEnabled ?? this.isLogsFilterEnabled,
+        attachLogFileEnabled: attachLogFileEnabled ?? this.attachLogFileEnabled,
       );
 
   @override
@@ -48,5 +53,6 @@ final class BugseeConfigurationData extends Equatable {
         isDataObscured,
         isLogCollectionEnabled,
         isLogsFilterEnabled,
+        attachLogFileEnabled,
       ];
 }

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

@@ -0,0 +1,53 @@
+import 'package:bugsee_flutter/bugsee_flutter.dart';
+
+AndroidLaunchOptions androidLaunchOptions = AndroidLaunchOptions()
+  ..captureDeviceAndNetworkNames = false
+  ..captureLogs = false
+  ..crashReport = false
+  ..defaultBugPriority = BugseeSeverityLevel.blocker
+  ..defaultCrashPriority = BugseeSeverityLevel.critical
+  ..frameRate = BugseeFrameRate.low
+  ..maxDataSize = 20
+  ..maxNetworkBodySize = 20
+  ..maxRecordingTime = 20
+  ..monitorNetwork = false
+  ..notificationBarTrigger = false
+  ..reportDescriptionRequired = false
+  ..reportEmailRequired = false
+  ..reportLabelsEnabled = false
+  ..reportLabelsRequired = false
+  ..reportPrioritySelector = false
+  ..reportSummaryRequired = false
+  ..screenshotEnabled = false
+  ..serviceMode = false
+  ..shakeToReport = false
+  ..videoEnabled = false
+  ..videoMode = BugseeVideoMode.v1
+  ..videoQuality = BugseeVideoQuality.defaultQuality
+  ..videoScale = 0.5
+  ..viewHierarchyEnabled = false
+  ..wifiOnlyUpload = true;
+
+IOSLaunchOptions iOSLaunchOptions = IOSLaunchOptions()
+  ..captureDeviceAndNetworkNames = false
+  ..captureLogs = false
+  ..crashReport = false
+  ..defaultBugPriority = BugseeSeverityLevel.blocker
+  ..defaultCrashPriority = BugseeSeverityLevel.critical
+  ..frameRate = BugseeFrameRate.low
+  ..maxDataSize = 20
+  ..maxNetworkBodySize = 20
+  ..maxRecordingTime = 20
+  ..monitorNetwork = false
+  ..reportDescriptionRequired = false
+  ..reportEmailRequired = false
+  ..reportLabelsEnabled = false
+  ..reportLabelsRequired = false
+  ..reportPrioritySelector = false
+  ..reportSummaryRequired = false
+  ..screenshotEnabled = false
+  ..shakeToReport = false
+  ..videoEnabled = false
+  ..videoScale = 0.5
+  ..viewHierarchyEnabled = false
+  ..wifiOnlyUpload = true;

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

@@ -17,11 +17,14 @@ abstract interface class BugseeRepository {
   /// Update whether data is obscure in shared prefs.
   Future setIsDataObscure(bool isDataObscure);
 
-  /// Update whether [disableLogCollectionKey] flag.
+  /// Update the logCollection flag in shared prefs.
   Future setIsLogCollectionEnabled(bool isLogCollectionEnabled);
 
-  /// Update whether [disableLogFilterKey] flag.
+  /// Update the logFilter flag in shared prefs.
   Future setIsLogFilterEnabled(bool isLogFilterEnabled);
+
+  /// Update the attachFile boolean flag in shared prefs.
+  Future setAttachLogFileEnabled(bool attachLogFile);
 }
 
 final class _BugseeRepository implements BugseeRepository {
@@ -30,6 +33,7 @@ final class _BugseeRepository implements BugseeRepository {
   final String _dataObscureKey = 'dataObscureKey';
   final String _disableLogCollectionKey = 'disableLogCollectionKey';
   final String _disableLogFilterKey = 'disableLogFilterKey';
+  final String _attachLogFileKey = 'attachLogFileKey';
 
   @override
   Future<BugseeConfigurationData> getBugseeConfiguration() async {
@@ -41,6 +45,7 @@ final class _BugseeRepository implements BugseeRepository {
       isLogCollectionEnabled:
           sharedPrefInstance.getBool(_disableLogCollectionKey),
       isLogsFilterEnabled: sharedPrefInstance.getBool(_disableLogFilterKey),
+      attachLogFileEnabled: sharedPrefInstance.getBool(_attachLogFileKey),
     );
   }
 
@@ -125,4 +130,20 @@ final class _BugseeRepository implements BugseeRepository {
       );
     }
   }
+
+  @override
+  Future setAttachLogFileEnabled(bool attachLogFile) async {
+    final sharedPrefInstance = await SharedPreferences.getInstance();
+
+    bool isSaved = await sharedPrefInstance.setBool(
+      _attachLogFileKey,
+      attachLogFile,
+    );
+
+    if (!isSaved) {
+      throw PersistenceException(
+        message: 'Error while setting $_attachLogFileKey $attachLogFile',
+      );
+    }
+  }
 }

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

@@ -4,48 +4,56 @@ final class BugseeConfigState extends Equatable {
   /// Indicate if the app require a restart to reactivate the bugsee configurations
   ///
   /// `true` only if `isConfigurationValid == true` and bugsee is turned on
-  bool isRestartRequired;
+  final bool isRestartRequired;
 
   /// Indicate if bugsee is enabled or not
   /// by default bugsee is enabled if `isConfigurationValid == true`.
-  bool isBugseeEnabled;
+  final bool isBugseeEnabled;
 
   /// Indicate whether video capturing is enabled or not.
   /// enabled by default if `isBugseeEnabled == true`.
   ///
   /// cannot be true if `isBugseeEnabled == false`.
-  bool isVideoCaptureEnabled;
+  final bool isVideoCaptureEnabled;
 
   /// 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;
+  final bool isConfigurationValid;
 
   /// Indicate whether data is obscured in report videos
   ///
   /// cannot be true if `isBugseeEnabled == false`.
-  bool isDataObscured;
+  final 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;
+  final 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;
+  final bool isLogFilterEnabled;
 
-  BugseeConfigState({
+  /// Indicate whether Bugsee will attach the log file when reporting crashes/exceptions
+  /// or not
+  ///
+  /// The initial value is taken from [dotenv.env] and shared prefs.
+  /// By default it's enabled.
+  final bool attachLogFile;
+
+  const BugseeConfigState({
     this.isRestartRequired = false,
     this.isBugseeEnabled = false,
     this.isVideoCaptureEnabled = false,
     this.isConfigurationValid = false,
     this.isDataObscured = false,
     this.isLogCollectionEnabled = false,
     this.isLogFilterEnabled = false,
+    this.attachLogFile = false,
   });
 
   BugseeConfigState copyWith({
@@ -56,13 +64,15 @@ final class BugseeConfigState extends Equatable {
     bool? isDataObscured,
     bool? isLogCollectionEnabled,
     bool? isLogFilterEnabled,
+    bool? attachLogFile,
   }) =>
       BugseeConfigState(
         isRestartRequired: isRestartRequired ?? this.isRestartRequired,
         isBugseeEnabled: isBugseeEnabled ?? this.isBugseeEnabled,
         isConfigurationValid: isConfigurationValid ?? this.isConfigurationValid,
         isDataObscured: isDataObscured ?? this.isDataObscured,
         isLogFilterEnabled: isLogFilterEnabled ?? this.isLogFilterEnabled,
+        attachLogFile: attachLogFile ?? this.attachLogFile,
         isLogCollectionEnabled:
             isLogCollectionEnabled ?? this.isLogCollectionEnabled,
         isVideoCaptureEnabled: