feat: implement bugsee data obscure from reported videos

Author: koukibadr

src/app/.env.dev

@@ -5,4 +5,5 @@ DAD_JOKES_BASE_URL='https://www.reddit.com/r/dadjokes'
 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
+DIAGNOSTIC_ENABLED=true
+IS_DATA_OBSCURE=true

src/app/.env.prod

@@ -5,4 +5,5 @@ DAD_JOKES_BASE_URL='https://www.reddit.com/r/dadjokes'
 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=720
-DIAGNOSTIC_ENABLED=false
+DIAGNOSTIC_ENABLED=false
+IS_DATA_OBSCURE=true

src/app/.env.staging

@@ -5,4 +5,5 @@ DAD_JOKES_BASE_URL='https://www.reddit.com/r/dadjokes'
 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
+DIAGNOSTIC_ENABLED=true
+IS_DATA_OBSCURE=true

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

@@ -5,8 +5,12 @@ final class BugseeConfigurationData {
   /// 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;
+
   const BugseeConfigurationData({
-    required this.isBugseeEnabled,
-    required this.isVideoCaptureEnabled,
+    this.isBugseeEnabled,
+    this.isVideoCaptureEnabled,
+    this.isDataObscrured,
   });
 }

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

@@ -13,18 +13,23 @@ abstract interface class BugseeRepository {
 
   /// Update the current video captured or not flag in shared prefs.
   Future setIsVideoCaptureEnabled(bool isVideoCaptureEnabled);
+
+  /// Update whether data is obscure in shared prefs.
+  Future setIsDataObscure(bool isDataObscure);
 }
 
 final class _BugseeRepository implements BugseeRepository {
   final String _bugseeEnabledKey = 'bugseeEnabledKey';
   final String _videoCaptureKey = 'videoCaptureKey';
+  final String _dataObscureKey = 'dataObscureKey';
 
   @override
   Future<BugseeConfigurationData> getBugseeConfiguration() async {
     final sharedPrefInstance = await SharedPreferences.getInstance();
     return BugseeConfigurationData(
       isBugseeEnabled: sharedPrefInstance.getBool(_bugseeEnabledKey),
       isVideoCaptureEnabled: sharedPrefInstance.getBool(_videoCaptureKey),
+      isDataObscrured: sharedPrefInstance.getBool(_dataObscureKey),
     );
   }
 
@@ -59,4 +64,20 @@ final class _BugseeRepository implements BugseeRepository {
       );
     }
   }
+
+  @override
+  Future setIsDataObscure(bool isDataObscured) async {
+    final sharedPrefInstance = await SharedPreferences.getInstance();
+
+    bool isSaved = await sharedPrefInstance.setBool(
+      _dataObscureKey,
+      isDataObscured,
+    );
+
+    if (!isSaved) {
+      throw PersistenceException(
+        message: 'Error while setting $_dataObscureKey $isDataObscured',
+      );
+    }
+  }
 }

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

@@ -0,0 +1,61 @@
+import 'package:equatable/equatable.dart';
+
+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;
+
+  /// 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.
+  /// enabled by default if `isBugseeEnabled == true`.
+  ///
+  /// cannot be true if `isBugseeEnabled == false`.
+  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;
+
+  /// indicate whether data is obscured in report videos
+  ///
+  /// cannot be true if `isBugseeEnabled == false`.
+  bool isDataObscured;
+
+  BugseeConfigState({
+    this.isRestartRequired = false,
+    this.isBugseeEnabled = false,
+    this.isVideoCaptureEnabled = false,
+    this.isConfigurationValid = false,
+    this.isDataObscured = false,
+  });
+
+  BugseeConfigState copyWith({
+    bool? isRestartRequired,
+    bool? isBugseeEnabled,
+    bool? isVideoCaptureEnabled,
+    bool? isConfigurationValid,
+    bool? isDataObscured,
+  }) =>
+      BugseeConfigState(
+        isRestartRequired: isRestartRequired ?? this.isRestartRequired,
+        isBugseeEnabled: isBugseeEnabled ?? this.isBugseeEnabled,
+        isConfigurationValid: isConfigurationValid ?? this.isConfigurationValid,
+        isDataObscured: isDataObscured ?? this.isDataObscured,
+        isVideoCaptureEnabled:
+            isVideoCaptureEnabled ?? this.isVideoCaptureEnabled,
+      );
+
+  @override
+  List<Object?> get props => [
+        isRestartRequired,
+        isBugseeEnabled,
+        isVideoCaptureEnabled,
+        isConfigurationValid,
+        isDataObscured,
+      ];
+}

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

@@ -1,10 +1,11 @@
 import 'dart:async';
 import 'dart:io';
-
 import 'package:app/access/bugsee/bugsee_configuration_data.dart';
 import 'package:app/access/bugsee/bugsee_repository.dart';
+import 'package:app/business/bugsee/bugsee_config_state.dart';
 import 'package:bugsee_flutter/bugsee_flutter.dart';
 import 'package:flutter/foundation.dart';
+import 'package:flutter_dotenv/flutter_dotenv.dart';
 import 'package:logger/logger.dart';
 import 'package:logger/web.dart';
 
@@ -18,25 +19,8 @@ abstract interface class BugseeManager {
     required BugseeRepository bugseeRepository,
   }) = _BugseeManager;
 
-  /// indicate if the app require a restart to reactivate the bugsee configurations
-  ///
-  /// `true` only if `isConfigurationValid == true` and bugsee is turned on
-  bool get isRestartRequired;
-
-  /// indicate if bugsee is enabled or not
-  /// by default bugsee is enabled if `isConfigurationValid == true`.
-  bool get isBugseeEnabled;
-
-  /// indicate whether video capturing is enabled or not.
-  /// enabled by default if `isBugseeEnabled == true`.
-  ///
-  /// cannot be true if `isBugseeEnabled == false`.
-  bool get 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 get isConfigurationValid;
+  /// Current BugseeManager state
+  BugseeConfigState get bugseeConfigState;
 
   /// initialize bugsee with given token
   /// bugsee is not available in debug mode
@@ -61,10 +45,13 @@ abstract interface class BugseeManager {
   });
 
   /// Manually update the current BugseeEnabled flag in shared prefs and in current manager singleton.
-  Future<void> setIsBugseeEnabled(bool isBugseeEnabled);
+  Future<void> setIsBugseeEnabled(bool value);
+
+  /// Manually update isDataObscured flag in shared prefs and in current state [bugseeConfigState].
+  Future<void> setIsDataObscured(bool value);
 
   /// Manually update the current enableVideoCapture flag in shared prefs and in current manager singleton.
-  Future<void> setIsVideoCaptureEnabled(bool isBugseeEnabled);
+  Future<void> setIsVideoCaptureEnabled(bool value);
 
   /// Manually shows the built-in capture log report screen of Bugsee.
   Future<void> showCaptureLogReport();
@@ -79,17 +66,11 @@ final class _BugseeManager implements BugseeManager {
     required this.bugseeRepository,
   });
 
-  @override
-  bool isRestartRequired = false;
-
-  @override
-  bool isBugseeEnabled = false;
-
-  @override
-  late bool isVideoCaptureEnabled = false;
+  bool _initialDataObscuredState = false;
+  BugseeConfigState _currentState = BugseeConfigState();
 
   @override
-  bool isConfigurationValid = true;
+  BugseeConfigState get bugseeConfigState => _currentState;
 
   late bool _isBugSeeInitialized;
   BugseeLaunchOptions? launchOptions;
@@ -105,14 +86,18 @@ final class _BugseeManager implements BugseeManager {
     _isBugSeeInitialized = false;
 
     if (kDebugMode) {
-      isConfigurationValid = false;
+      _currentState = _currentState.copyWith(
+        isConfigurationValid: false,
+      );
       logger.i("BUGSEE: deactivated in debug mode");
       return;
     }
 
     if (bugseeToken == null ||
         !RegExp(bugseeTokenFormat).hasMatch(bugseeToken)) {
-      isConfigurationValid = false;
+      _currentState = _currentState.copyWith(
+        isConfigurationValid: false,
+      );
       logger.i(
         "BUGSEE: token is null or invalid, bugsee won't be initialized",
       );
@@ -123,9 +108,17 @@ final class _BugseeManager implements BugseeManager {
       await _launchBugseeLogger(bugseeToken);
     }
 
-    isBugseeEnabled = _isBugSeeInitialized;
-    isVideoCaptureEnabled = _isBugSeeInitialized &&
-        (bugseeConfigurationData.isVideoCaptureEnabled ?? true);
+    var isDataObscured = bugseeConfigurationData.isDataObscrured ??
+        bool.parse(dotenv.env['IS_DATA_OBSCURE'] ?? 'false');
+
+    _currentState = _currentState.copyWith(
+      isConfigurationValid: _isBugSeeInitialized,
+      isBugseeEnabled: _isBugSeeInitialized,
+      isVideoCaptureEnabled: _isBugSeeInitialized &&
+          (bugseeConfigurationData.isVideoCaptureEnabled ?? true),
+      isDataObscured: isDataObscured,
+    );
+    _initialDataObscuredState = isDataObscured;
   }
 
   Future _launchBugseeLogger(String bugseeToken) async {
@@ -158,7 +151,7 @@ final class _BugseeManager implements BugseeManager {
     required Exception exception,
     StackTrace? stackTrace,
   }) async {
-    if (isBugseeEnabled) {
+    if (_currentState.isBugseeEnabled) {
       await Bugsee.logException(exception, stackTrace);
     }
   }
@@ -168,32 +161,38 @@ final class _BugseeManager implements BugseeManager {
     required Exception exception,
     StackTrace? stackTrace,
   }) async {
-    if (isBugseeEnabled) {
+    if (_currentState.isBugseeEnabled) {
       await Bugsee.logUnhandledException(exception);
     }
   }
 
   @override
   Future<void> setIsBugseeEnabled(bool value) async {
-    if (isConfigurationValid) {
-      isBugseeEnabled = value;
-      await bugseeRepository.setIsBugseeEnabled(isBugseeEnabled);
-
-      isRestartRequired = _isBugSeeInitialized && isBugseeEnabled;
-      isVideoCaptureEnabled = isBugseeEnabled;
+    if (_currentState.isConfigurationValid) {
+      await bugseeRepository.setIsBugseeEnabled(value);
+      _currentState = _currentState.copyWith(
+        isBugseeEnabled: value,
+        isRestartRequired: value,
+        isVideoCaptureEnabled: value,
+        isDataObscured: value,
+      );
 
-      if (!isRestartRequired) {
+      if (!_currentState.isRestartRequired) {
         await Bugsee.stop();
       }
     }
   }
 
   @override
   Future<void> setIsVideoCaptureEnabled(bool value) async {
-    if (isBugseeEnabled) {
-      isVideoCaptureEnabled = value;
-      await bugseeRepository.setIsVideoCaptureEnabled(isVideoCaptureEnabled);
-      if (!isVideoCaptureEnabled) {
+    if (_currentState.isBugseeEnabled) {
+      _currentState = _currentState.copyWith(
+        isVideoCaptureEnabled: value,
+      );
+      await bugseeRepository.setIsVideoCaptureEnabled(
+        _currentState.isVideoCaptureEnabled,
+      );
+      if (!_currentState.isVideoCaptureEnabled) {
         await Bugsee.pause();
       } else {
         await Bugsee.resume();
@@ -203,8 +202,19 @@ final class _BugseeManager implements BugseeManager {
 
   @override
   Future<void> showCaptureLogReport() async {
-    if (isBugseeEnabled) {
+    if (_currentState.isBugseeEnabled) {
       await Bugsee.showReportDialog();
     }
   }
+
+  @override
+  Future<void> setIsDataObscured(bool value) async {
+    if (_currentState.isBugseeEnabled) {
+      await bugseeRepository.setIsDataObscure(value);
+      _currentState = _currentState.copyWith(
+        isRestartRequired: value != _initialDataObscuredState,
+        isDataObscured: value,
+      );
+    }
+  }
 }

src/app/lib/presentation/dad_jokes/dad_joke_list_item.dart

@@ -1,12 +1,15 @@
+import 'package:app/business/bugsee/bugsee_manager.dart';
 import 'package:app/business/dad_jokes/dad_joke.dart';
 import 'package:app/business/dad_jokes/dad_jokes_service.dart';
+import 'package:bugsee_flutter/bugsee_flutter.dart';
 import 'package:flutter/material.dart';
 import 'package:get_it/get_it.dart';
 
 /// A dad joke list item.
 final class DadJokeListItem extends StatelessWidget {
   /// The dad jokes service used to add or remove favorite.
   final _dadJokesService = GetIt.I<DadJokesService>();
+  final _bugseeManager = GetIt.I<BugseeManager>();
 
   /// The dad joke.
   final DadJoke dadJoke;
@@ -17,8 +20,14 @@ final class DadJokeListItem extends StatelessWidget {
   Widget build(BuildContext context) {
     return Card(
       child: ListTile(
-        title: Text(dadJoke.title),
-        subtitle: Text(dadJoke.text),
+        title: BugseeSecureView(
+          enabled: _bugseeManager.bugseeConfigState.isDataObscured,
+          child: Text(dadJoke.title),
+        ),
+        subtitle: BugseeSecureView(
+          enabled: _bugseeManager.bugseeConfigState.isDataObscured,
+          child: Text(dadJoke.text),
+        ),
         trailing: dadJoke.isFavorite
             ? const Icon(
                 Icons.favorite,