Merge branch 'error-badge'

Author: inetic

lib/app/app.dart

@@ -11,7 +11,7 @@ import 'package:stream_transform/stream_transform.dart';
 
 import '../generated/l10n.dart';
 import 'cubits/cubits.dart'
-    show LocaleCubit, LocaleState, MountCubit, ReposCubit;
+    show LocaleCubit, LocaleState, MountCubit, ReposCubit, ErrorCubit;
 import 'pages/pages.dart';
 import 'utils/dirs.dart';
 import 'utils/log.dart' as log;
@@ -74,6 +74,9 @@ Future<HomeWidget> _initHomeWidget(List<String> args) async {
   await log.init(dirs);
 
   final (server, session) = await _initServerAndSession(dirs, windowManager);
+
+  final errorCubit = ErrorCubit(session);
+
   final settings = await loadAndMigrateSettings(session);
   final localeCubit = LocaleCubit(settings);
 
@@ -85,6 +88,7 @@ Future<HomeWidget> _initHomeWidget(List<String> args) async {
     settings: settings,
     packageInfo: packageInfo,
     localeCubit: localeCubit,
+    errorCubit: errorCubit,
   );
 }
 
@@ -141,6 +145,7 @@ class HomeWidget extends StatefulWidget {
     required this.settings,
     required this.packageInfo,
     required this.localeCubit,
+    required this.errorCubit,
     super.key,
   });
 
@@ -151,6 +156,7 @@ class HomeWidget extends StatefulWidget {
   final Settings settings;
   final PackageInfo packageInfo;
   final LocaleCubit localeCubit;
+  final ErrorCubit errorCubit;
 
   @override
   State<HomeWidget> createState() => _HomeWidgetState();
@@ -218,6 +224,7 @@ class _HomeWidgetState extends State<HomeWidget>
       mainPage: MainPage(
         localeCubit: widget.localeCubit,
         mountCubit: mountCubit,
+        errorCubit: widget.errorCubit,
         packageInfo: widget.packageInfo,
         receivedMedia: receivedMediaController.stream,
         reposCubit: reposCubit,

lib/app/cubits/cubits.dart

@@ -1,3 +1,4 @@
+export 'error.dart';
 export 'locale.dart';
 export 'connectivity_info.dart';
 export 'entry_bottom_sheet.dart';

lib/app/cubits/error.dart

@@ -0,0 +1,114 @@
+import 'dart:async';
+
+import 'package:flutter_bloc/flutter_bloc.dart';
+import 'package:equatable/equatable.dart';
+import 'package:ouisync/ouisync.dart' as native;
+import 'package:loggy/loggy.dart' show Loggy;
+import 'package:flutter/foundation.dart' show FlutterError, PlatformDispatcher;
+import 'utils.dart' show CubitActions;
+import '../utils/log.dart' show AppLogger;
+
+// Watch if an error happened in different parts of the app and the ouisync library.
+// Only captures errors that can't be gracefuly handled, the cubit indicates to
+// the user that the log should be captured.
+class ErrorCubit extends Cubit<ErrorCubitState> with CubitActions, AppLogger {
+  ErrorCubit(native.Session session) : super(ErrorCubitState(false)) {
+    // TODO: This may no longer be useful. Previously, when we were
+    // communicating with the library over FFI  we could detect panics through
+    // the state monitor. But now that we communicate with the service over the
+    // socket, when a panic happens the socket disconnects and thus we no
+    // longer receive events over it. However, we now receive
+    // `native.ClientException`s when the socket disconnects which is handled
+    // below.
+    unawaited(
+      _RustPanicDetectionRunner(this, loggy, session.rootStateMonitor).init(),
+    );
+
+    // These are printed in utils/log.dart. Here we just mark the state with
+    // error for the error badge indicator to light up.
+    final defaultFlutterOnError = FlutterError.onError;
+    FlutterError.onError = (details) {
+      _emitError();
+
+      if (defaultFlutterOnError != null) {
+        defaultFlutterOnError(details);
+      }
+    };
+
+    final defaultPlatformOnError = PlatformDispatcher.instance.onError;
+    PlatformDispatcher.instance.onError = (exception, stack) {
+      _emitError();
+
+      if (defaultPlatformOnError != null) {
+        return defaultPlatformOnError(exception, stack);
+      } else {
+        // We're not writing the log, returning `false` means someone else will.
+        return false;
+      }
+    };
+  }
+
+  void _emitError() {
+    emitUnlessClosed(ErrorCubitState(true));
+  }
+}
+
+class ErrorCubitState extends Equatable {
+  final bool errorHappened;
+
+  ErrorCubitState(this.errorHappened);
+
+  @override
+  List<Object> get props => [errorHappened];
+}
+
+class _RustPanicDetectionRunner {
+  final ErrorCubit _errorCubit;
+  final Loggy _loggy;
+  final native.StateMonitor _serviceStateMonitor;
+
+  _RustPanicDetectionRunner(
+    this._errorCubit,
+    this._loggy,
+    native.StateMonitor rootStateMonitor,
+  ) : _serviceStateMonitor = rootStateMonitor.child(
+        native.MonitorId.expectUnique("Service"),
+      );
+
+  Future<void> init() async {
+    try {
+      await _load();
+
+      await for (final _ in _serviceStateMonitor.changes) {
+        await _load();
+      }
+    } catch (e) {
+      _loggy.error("Rust panic detection: $e");
+      _errorCubit._emitError();
+    }
+  }
+
+  Future<void> _load() async {
+    final node = await _serviceStateMonitor.load();
+
+    if (node == null) {
+      throw "Failed to find Service node in state monitor";
+    }
+
+    final value = node.values['panic_counter'];
+
+    if (value == null) {
+      throw "Failed to find panic_counter value in Service state monitor node";
+    }
+
+    final count = int.tryParse(value);
+
+    if (count == null) {
+      throw "Failed to parse panic_counter value ($value)";
+    }
+
+    if (count > 0) {
+      throw "Detected panic in rust code";
+    }
+  }
+}

lib/app/cubits/state_monitor.dart

@@ -29,25 +29,3 @@ class StateMonitorCubit extends Cubit<StateMonitorNode?> with CubitActions {
   StateMonitorCubit child(MonitorId id) =>
       StateMonitorCubit(_monitor.child(id));
 }
-
-class StateMonitorIntCubit extends Cubit<int?> with CubitActions {
-  final StateMonitor _monitor;
-  final String _name;
-
-  StateMonitorIntCubit(this._monitor, this._name) : super(null) {
-    unawaited(_init());
-  }
-
-  Future<void> _init() async {
-    await _load();
-
-    await for (final _ in _monitor.changes) {
-      await _load();
-    }
-  }
-
-  Future<void> _load() async {
-    final node = await _monitor.load();
-    emitUnlessClosed(node?.parseIntValue(_name));
-  }
-}

lib/app/pages/main_page.dart

@@ -5,7 +5,7 @@ import 'package:build_context_provider/build_context_provider.dart';
 import 'package:collection/collection.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_bloc/flutter_bloc.dart';
-import 'package:ouisync/ouisync.dart' show EntryType, MonitorId, Session;
+import 'package:ouisync/ouisync.dart' show EntryType, Session;
 import 'package:package_info_plus/package_info_plus.dart';
 import 'package:path/path.dart' as system_path;
 import 'package:receive_sharing_intent/receive_sharing_intent.dart';
@@ -36,6 +36,7 @@ class MainPage extends StatefulWidget {
     required this.packageInfo,
     required this.receivedMedia,
     required this.reposCubit,
+    required this.errorCubit,
     required this.session,
     required this.settings,
     required this.windowManager,
@@ -48,6 +49,7 @@ class MainPage extends StatefulWidget {
   final PackageInfo packageInfo;
   final Stream<List<SharedMediaFile>> receivedMedia;
   final ReposCubit reposCubit;
+  final ErrorCubit errorCubit;
   final MountCubit mountCubit;
   final LocaleCubit localeCubit;
   final Dirs dirs;
@@ -58,7 +60,6 @@ class MainPage extends StatefulWidget {
 
 class _MainPageState extends State<MainPage>
     with TickerProviderStateMixin, AppLogger {
-  late final StateMonitorIntCubit panicCounter;
   late final PowerControl powerControl = PowerControl(
     widget.session,
     widget.settings,
@@ -85,13 +86,6 @@ class _MainPageState extends State<MainPage>
   void initState() {
     super.initState();
 
-    panicCounter = StateMonitorIntCubit(
-      widget.reposCubit.rootStateMonitor.child(
-        MonitorId.expectUnique("Service"),
-      ),
-      "panic_counter",
-    );
-
     upgradeExists = UpgradeExistsCubit(widget.session, widget.settings);
 
     sortListCubit = SortListCubit.create(
@@ -121,7 +115,6 @@ class _MainPageState extends State<MainPage>
     unawaited(upgradeExists.close());
     unawaited(sortListCubit.close());
     unawaited(powerControl.close());
-    unawaited(panicCounter.close());
 
     super.dispose();
   }
@@ -319,7 +312,7 @@ class _MainPageState extends State<MainPage>
     reposCubit: widget.reposCubit,
     repoPicker: RepositoriesBar(
       mount: widget.mountCubit,
-      panicCounter: panicCounter,
+      errorCubit: widget.errorCubit,
       powerControl: powerControl,
       reposCubit: widget.reposCubit,
       upgradeExists: upgradeExists,
@@ -331,7 +324,7 @@ class _MainPageState extends State<MainPage>
 
   Widget _buildAppSettingsIcon() => NotificationBadge(
     mount: widget.mountCubit,
-    panicCounter: panicCounter,
+    errorCubit: widget.errorCubit,
     powerControl: powerControl,
     upgradeExists: upgradeExists,
     moveDownwards: 5,
@@ -1009,7 +1002,7 @@ class _MainPageState extends State<MainPage>
         session: widget.session,
         localeCubit: widget.localeCubit,
         mount: widget.mountCubit,
-        panicCounter: panicCounter,
+        errorCubit: widget.errorCubit,
         powerControl: powerControl,
         reposCubit: widget.reposCubit,
         upgradeExists: upgradeExists,

lib/app/pages/settings_page.dart

@@ -14,7 +14,7 @@ class SettingsPage extends StatefulWidget {
     required this.session,
     required this.localeCubit,
     required this.mount,
-    required this.panicCounter,
+    required this.errorCubit,
     required this.powerControl,
     required this.reposCubit,
     required this.upgradeExists,
@@ -25,7 +25,7 @@ class SettingsPage extends StatefulWidget {
   final Session session;
   final LocaleCubit localeCubit;
   final MountCubit mount;
-  final StateMonitorIntCubit panicCounter;
+  final ErrorCubit errorCubit;
   final PowerControl powerControl;
   final ReposCubit reposCubit;
   final UpgradeExistsCubit upgradeExists;
@@ -73,7 +73,7 @@ class _SettingsPageState extends State<SettingsPage> {
       widget.session,
       localeCubit: widget.localeCubit,
       mount: widget.mount,
-      panicCounter: widget.panicCounter,
+      errorCubit: widget.errorCubit,
       powerControl: widget.powerControl,
       reposCubit: widget.reposCubit,
       connectivityInfo: connectivityInfo,

lib/app/utils/log.dart

@@ -56,20 +56,32 @@ ${'-' * (48 + package.appName.length)}''';
   };
 
   if (captureErrors) {
+    final defaultFlutterOnError = FlutterError.onError;
     FlutterError.onError = (details) {
       logger.error(
         'Unhandled flutter exception: ',
         details.exception,
         details.stack,
       );
 
-      FlutterError.presentError(details);
+      if (defaultFlutterOnError != null) {
+        defaultFlutterOnError(details);
+      } else {
+        FlutterError.presentError(details);
+      }
     };
 
     // NOTE: if sentry is used, it will override these methods but still call
     // them after processing the events, so they are not lost
+    final defaultPlatformOnError = PlatformDispatcher.instance.onError;
     PlatformDispatcher.instance.onError = (exception, stack) {
-      logger.error('Unhandled platform exception: ', exception, stack);
+      bool captured = false;
+      if (defaultPlatformOnError != null) {
+        captured = defaultPlatformOnError(exception, stack);
+      }
+      if (!captured) {
+        logger.error('Unhandled platform exception: ', exception, stack);
+      }
       return true;
     };
   }

lib/app/widgets/bars/repositories_bar.dart

@@ -15,15 +15,15 @@ class RepositoriesBar extends StatelessWidget
     implements PreferredSizeWidget {
   const RepositoriesBar({
     required this.mount,
-    required this.panicCounter,
+    required this.errorCubit,
     required this.powerControl,
     required this.reposCubit,
     required this.upgradeExists,
     super.key,
   });
 
   final MountCubit mount;
-  final StateMonitorIntCubit panicCounter;
+  final ErrorCubit errorCubit;
   final PowerControl powerControl;
   final ReposCubit reposCubit;
   final UpgradeExistsCubit upgradeExists;
@@ -110,7 +110,7 @@ class RepositoriesBar extends StatelessWidget
   // TODO: Why does the badge appear to move quickly after entering this screen?
   Widget _buildBackButton() => NotificationBadge(
     mount: mount,
-    panicCounter: panicCounter,
+    errorCubit: errorCubit,
     powerControl: powerControl,
     upgradeExists: upgradeExists,
     moveDownwards: 5,