feat: implement global bugsee exception handler

Author: koukibadr

src/app/.env.staging

@@ -8,5 +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=false
 ATTACH_LOG_FILE=true

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

@@ -2,6 +2,7 @@ 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/access/persistence_exception.dart';
 import 'package:app/business/bugsee/bugsee_config_state.dart';
 import 'package:app/business/logger/logger_manager.dart';
 import 'package:bugsee_flutter/bugsee_flutter.dart';
@@ -16,22 +17,20 @@ const String bugseeFilterRegex = r'.';
 
 /// Service related to initializing Bugsee service
 abstract interface class BugseeManager {
-  factory BugseeManager({
-    required Logger logger,
-    required LoggerManager loggerManager,
-    required BugseeRepository bugseeRepository,
-  }) = _BugseeManager;
+  factory BugseeManager() = _BugseeManager;
 
   /// Current BugseeManager state
   BugseeConfigState get bugseeConfigState;
-  bool get onPressExceptionActivated;
 
   /// Initialize bugsee with given token
   /// bugsee is not available in debug mode
   /// * [bugseeToken]: nullable bugsee token, if null bugsee won't be initialized make sure you provide
   /// [BUGSEE_TOKEN] in the env using `--dart-define` or `launch.json` on vscode
   Future<void> initialize({
     String? bugseeToken,
+    required Logger logger,
+    required LoggerManager loggerManager,
+    required BugseeRepository bugseeRepository,
   });
 
   /// Manually log a provided exception with a stack trace
@@ -47,14 +46,6 @@ abstract interface class BugseeManager {
     StackTrace? stackTrace,
     Map<String, dynamic>? traces,
     Map<String, Map<String, dynamic>?>? events,
-    Map<String, dynamic>? attributes,
-  });
-
-  /// Manually log an unhandled exception with a stack trace
-  /// (critical severity exception in Bugsee dashboard)
-  Future<void> logUnhandledException({
-    required Exception exception,
-    StackTrace? stackTrace,
   });
 
   /// Manually update the current BugseeEnabled flag in shared prefs and in current manager singleton.
@@ -75,29 +66,26 @@ abstract interface class BugseeManager {
   /// Manually update isLogFilterEnabled flag in shared prefs.
   Future<void> setIsLogFilterEnabeld(bool value);
 
-  /// Manually update whether bugsee will catch exception when pressing
-  /// dadjoke item or not.
-  ///
-  /// By is set to `false`
-  void setOnPressExceptionActivated(bool value);
-
   /// Manually update whether Bugsee attach the log file with the reported
   /// exception or not.
   ///
   /// By default the log file is attached
   Future<void> setAttachLogFileEnabled(bool value);
+
+  //TODO add documentation
+  Future<void> inteceptor(Object error, StackTrace stackTrace);
+  Future<void> addAttributes(Map<String, dynamic> attributes);
+  Future<void> addEmailAttribute(String email);
+  Future<void> clearEmailAttribute();
+  Future<void> clearAttribute(String attribute);
 }
 
 final class _BugseeManager implements BugseeManager {
-  final Logger logger;
-  final LoggerManager loggerManager;
-  final BugseeRepository bugseeRepository;
-
-  _BugseeManager({
-    required this.logger,
-    required this.loggerManager,
-    required this.bugseeRepository,
-  });
+  late Logger logger;
+  late LoggerManager loggerManager;
+  late BugseeRepository bugseeRepository;
+
+  _BugseeManager();
 
   BugseeConfigState _currentState = const BugseeConfigState();
 
@@ -107,15 +95,19 @@ final class _BugseeManager implements BugseeManager {
   late bool _isBugSeeInitialized;
   late BugseeConfigurationData configurationData;
 
-  @override
-  bool onPressExceptionActivated = false;
-
   BugseeLaunchOptions? launchOptions;
 
   @override
   Future<void> initialize({
     String? bugseeToken,
+    required Logger logger,
+    required LoggerManager loggerManager,
+    required BugseeRepository bugseeRepository,
   }) async {
+    this.logger = logger;
+    this.loggerManager = loggerManager;
+    this.bugseeRepository = bugseeRepository;
+
     configurationData = await bugseeRepository.getBugseeConfiguration();
     configurationData = configurationData.copyWith(
       isLogCollectionEnabled: configurationData.isLogCollectionEnabled ??
@@ -231,7 +223,6 @@ final class _BugseeManager implements BugseeManager {
     StackTrace? stackTrace,
     Map<String, dynamic>? traces,
     Map<String, Map<String, dynamic>?>? events,
-    Map<String, dynamic>? attributes,
   }) async {
     if (_currentState.isBugseeEnabled) {
       if (traces != null) {
@@ -246,26 +237,10 @@ final class _BugseeManager implements BugseeManager {
         }
       }
 
-      if (attributes != null) {
-        for (var attribute in attributes.entries) {
-          await Bugsee.setAttribute(attribute.key, attribute.value);
-        }
-      }
-
       await Bugsee.logException(exception, stackTrace);
     }
   }
 
-  @override
-  Future<void> logUnhandledException({
-    required Exception exception,
-    StackTrace? stackTrace,
-  }) async {
-    if (_currentState.isBugseeEnabled) {
-      await Bugsee.logUnhandledException(exception);
-    }
-  }
-
   @override
   Future<void> setIsBugseeEnabled(bool value) async {
     if (_currentState.isConfigurationValid) {
@@ -345,11 +320,6 @@ final class _BugseeManager implements BugseeManager {
     }
   }
 
-  @override
-  void setOnPressExceptionActivated(bool value) {
-    onPressExceptionActivated = value;
-  }
-
   @override
   Future<void> setAttachLogFileEnabled(bool value) async {
     if (_currentState.isBugseeEnabled) {
@@ -360,4 +330,44 @@ final class _BugseeManager implements BugseeManager {
       );
     }
   }
+
+  @override
+  Future<void> inteceptor(
+    Object error,
+    StackTrace stackTrace,
+  ) async {
+    String? message = switch (error.runtimeType) {
+      const (PersistenceException) => (error as PersistenceException).message,
+      _ => null,
+    };
+    await logException(
+      exception: Exception(error),
+      stackTrace: stackTrace,
+      traces: {
+        'message': message,
+      },
+    );
+  }
+
+  @override
+  Future<void> addAttributes(Map<String, dynamic> attributes) async {
+    for (var attribute in attributes.entries) {
+      await Bugsee.setAttribute(attribute.key, attribute.value);
+    }
+  }
+
+  @override
+  Future<void> clearAttribute(String attribute) async {
+    await Bugsee.clearAttribute(attribute);
+  }
+
+  @override
+  Future<void> addEmailAttribute(String email) async {
+    await Bugsee.setEmail(email);
+  }
+
+  @override
+  Future<void> clearEmailAttribute() async {
+    await Bugsee.clearEmail();
+  }
 }

src/app/lib/main.dart

@@ -1,3 +1,4 @@
+import 'dart:async';
 import 'dart:io';
 
 import 'package:alice/alice.dart';
@@ -36,8 +37,14 @@ import 'package:logger/logger.dart';
 late Logger _logger;
 
 Future<void> main() async {
-  await initializeComponents();
-  runApp(const App());
+  _initializeBugseeManager();
+  runZonedGuarded(
+    () async {
+      await initializeComponents();
+      runApp(const App());
+    },
+    GetIt.I.get<BugseeManager>().inteceptor,
+  );
 }
 
 Future initializeComponents({bool? isMocked}) async {
@@ -119,17 +126,19 @@ Future _registerAndLoadLoggers() async {
   GetIt.I.registerSingleton(_logger);
 }
 
-Future _registerBugseeManager() async {
+void _initializeBugseeManager() {
   GetIt.I.registerSingleton<BugseeRepository>(BugseeRepository());
   GetIt.I.registerSingleton<BugseeManager>(
-    BugseeManager(
-      logger: GetIt.I.get<Logger>(),
-      loggerManager: GetIt.I.get<LoggerManager>(),
-      bugseeRepository: GetIt.I.get<BugseeRepository>(),
-    ),
+    BugseeManager(),
   );
+}
+
+Future _registerBugseeManager() async {
   GetIt.I.get<BugseeManager>().initialize(
         bugseeToken: const String.fromEnvironment('BUGSEE_TOKEN'),
+        logger: GetIt.I.get<Logger>(),
+        loggerManager: GetIt.I.get<LoggerManager>(),
+        bugseeRepository: GetIt.I.get<BugseeRepository>(),
       );
 }
 

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

@@ -39,16 +39,6 @@ final class DadJokeListItem extends StatelessWidget {
         titleAlignment: ListTileTitleAlignment.top,
         contentPadding: const EdgeInsets.all(16),
         onTap: () async {
-          if (_bugseeManager.onPressExceptionActivated) {
-            _bugseeManager.logException(
-              exception: Exception(),
-              attributes: {
-                'id': dadJoke.id,
-                'title': dadJoke.title,
-              },
-            );
-          }
-
           if (dadJoke.isFavorite) {
             await _dadJokesService.removeFavoriteDadJoke(dadJoke);
           } else {

src/app/lib/presentation/diagnostic/bugsee_configuration_widget.dart

@@ -20,13 +20,11 @@ class _BugseeConfigurationWidgetState extends State<BugseeConfigurationWidget> {
   final BugseeManager bugseeManager = GetIt.I.get<BugseeManager>();
 
   late BugseeConfigState state;
-  bool onPressItemLogException = false;
 
   @override
   void initState() {
     super.initState();
     state = bugseeManager.bugseeConfigState;
-    onPressItemLogException = bugseeManager.onPressExceptionActivated;
   }
 
   @override
@@ -113,17 +111,6 @@ class _BugseeConfigurationWidgetState extends State<BugseeConfigurationWidget> {
                 });
               },
             ),
-            DiagnosticSwitch(
-              label: 'Log exception on pressing dad joke item',
-              value: onPressItemLogException,
-              onChanged: (value) async {
-                bugseeManager.setOnPressExceptionActivated(value);
-                setState(() {
-                  onPressItemLogException =
-                      bugseeManager.onPressExceptionActivated;
-                });
-              },
-            ),
             DiagnosticSwitch(
               label: 'Attach log file',
               value: state.attachLogFile,
@@ -142,24 +129,6 @@ class _BugseeConfigurationWidgetState extends State<BugseeConfigurationWidget> {
             bugseeManager.logException(exception: Exception());
           },
         ),
-        DiagnosticButton(
-          label: 'Log an unhandled exception',
-          onPressed: () {
-            bugseeManager.logUnhandledException(exception: Exception());
-          },
-        ),
-        DiagnosticButton(
-          label: 'Log Exception with traces',
-          onPressed: () {
-            bugseeManager.logException(
-              exception: Exception(),
-              traces: {
-                'date': DateTime.now().millisecondsSinceEpoch,
-                'id': Random().nextInt(20),
-              },
-            );
-          },
-        ),
         DiagnosticButton(
           label: 'Log Exception with events',
           onPressed: () {
@@ -175,17 +144,29 @@ class _BugseeConfigurationWidgetState extends State<BugseeConfigurationWidget> {
           },
         ),
         DiagnosticButton(
-          label: 'Delete all attribute',
+          label: 'Add email attributes',
           onPressed: () {
-            bugseeManager.logException(
-              exception: Exception(),
-              events: {
-                'data': {
-                  'date': DateTime.now().millisecondsSinceEpoch,
-                  'id': Random().nextInt(20),
-                },
-              },
-            );
+            bugseeManager.addEmailAttribute('john.doe@nventive.com');
+          },
+        ),
+        DiagnosticButton(
+          label: 'Add name attribute',
+          onPressed: () {
+            bugseeManager.addAttributes({
+              'name': 'John Doe',
+            });
+          },
+        ),
+        DiagnosticButton(
+          label: 'Clear email attribute',
+          onPressed: () {
+            bugseeManager.clearEmailAttribute();
+          },
+        ),
+        DiagnosticButton(
+          label: 'Clear name attribute',
+          onPressed: () {
+            bugseeManager.clearAttribute('name');
           },
         ),
         DiagnosticButton(