chore: update Bugsee integration documentation and event caputring method

Author: koukibadr

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

@@ -45,7 +45,6 @@ abstract interface class BugseeManager {
     required Exception exception,
     StackTrace? stackTrace,
     Map<String, dynamic> traces,
-    Map<String, Map<String, dynamic>?> events,
   });
 
   /// Manually update the current BugseeEnabled flag in shared prefs and in current manager singleton.
@@ -76,7 +75,7 @@ abstract interface class BugseeManager {
   Future<void> inteceptExceptions(Object error, StackTrace stackTrace);
 
   /// Intercept all unhandled rending exception thrown by the Flutter framework
-  Future<void> inteceptRenderExceptions(FlutterErrorDetails error);
+  Future<void> inteceptRenderingExceptions(FlutterErrorDetails error);
 
   /// Manually add a map of attributes
   /// - the map entry key is the attribute name
@@ -97,6 +96,9 @@ abstract interface class BugseeManager {
 
   /// Manually remove an attribute by the given key attached using [addAttributes]
   Future<void> clearAttribute(String attribute);
+
+  /// Manually log Bugsee events that will be attached to the reported issues
+  void logEvents(Map<String, Map<String, dynamic>> events);
 }
 
 final class _BugseeManager implements BugseeManager {
@@ -260,15 +262,11 @@ final class _BugseeManager implements BugseeManager {
     required Exception exception,
     StackTrace? stackTrace,
     Map<String, dynamic> traces = const {},
-    Map<String, Map<String, dynamic>?> events = const {},
   }) async {
     if (_currentState.isBugseeEnabled) {
       for (var trace in traces.entries) {
         await Bugsee.trace(trace.key, trace.value);
       }
-      for (var event in events.entries) {
-        await Bugsee.event(event.key, event.value);
-      }
       await Bugsee.logException(exception, stackTrace);
     }
   }
@@ -404,10 +402,17 @@ final class _BugseeManager implements BugseeManager {
   }
 
   @override
-  Future<void> inteceptRenderExceptions(FlutterErrorDetails error) async {
+  Future<void> inteceptRenderingExceptions(FlutterErrorDetails error) async {
     await logException(
       exception: Exception(error.exception),
       stackTrace: error.stack,
     );
   }
+
+  @override
+  void logEvents(Map<String, Map<String, dynamic>> events) async {
+    for (var event in events.entries) {
+      Bugsee.event(event.key, event.value);
+    }
+  }
 }

src/app/lib/main.dart

@@ -41,7 +41,7 @@ Future<void> main() async {
   runZonedGuarded(
     () async {
       FlutterError.onError =
-          GetIt.I.get<BugseeManager>().inteceptRenderExceptions;
+          GetIt.I.get<BugseeManager>().inteceptRenderingExceptions;
       await initializeComponents();
       await registerBugseeManager();
       runApp(const App());

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

@@ -89,7 +89,7 @@ class _BugseeConfigurationWidgetState extends State<BugseeConfigurationWidget> {
               },
             ),
             DiagnosticSwitch(
-              label: 'Enabling log collection',
+              label: 'Log collection enabled',
               value: state.isLogCollectionEnabled,
               onChanged: (value) async {
                 await bugseeManager.setIsLogsCollectionEnabled(value);
@@ -99,7 +99,7 @@ class _BugseeConfigurationWidgetState extends State<BugseeConfigurationWidget> {
               },
             ),
             DiagnosticSwitch(
-              label: 'Enable log filter',
+              label: 'Filter log enabled',
               value: state.isLogFilterEnabled,
               onChanged: (value) async {
                 await bugseeManager.setIsLogFilterEnabeld(value);
@@ -109,7 +109,7 @@ class _BugseeConfigurationWidgetState extends State<BugseeConfigurationWidget> {
               },
             ),
             DiagnosticSwitch(
-              label: 'Attach log file',
+              label: 'Log file attached',
               value: state.attachLogFile,
               onChanged: (value) async {
                 bugseeManager.setAttachLogFileEnabled(value);
@@ -127,11 +127,10 @@ class _BugseeConfigurationWidgetState extends State<BugseeConfigurationWidget> {
           },
         ),
         DiagnosticButton(
-          label: 'Log Exception with events',
+          label: 'Add events to the exception',
           onPressed: () {
-            bugseeManager.logException(
-              exception: Exception(),
-              events: {
+            bugseeManager.logEvents(
+              {
                 'data': {
                   'date': DateTime.now().millisecondsSinceEpoch,
                   'id': Random().nextInt(20),