Refactor desktop window management and tray

2023-12-28 23:16:56 +03:30
parent 4345b97d72
commit a3a893d7aa
17 changed files with 334 additions and 253 deletions
--- a/lib/features/app/widget/app.dart
+++ b/lib/features/app/widget/app.dart
@@ -6,11 +6,15 @@ import 'package:hiddify/core/localization/locale_extensions.dart';
 import 'package:hiddify/core/localization/locale_preferences.dart';
 import 'package:hiddify/core/localization/translations.dart';
 import 'package:hiddify/core/model/constants.dart';
+import 'package:hiddify/core/preferences/general_preferences.dart';
 import 'package:hiddify/core/router/router.dart';
 import 'package:hiddify/core/theme/app_theme.dart';
 import 'package:hiddify/core/theme/theme_preferences.dart';
 import 'package:hiddify/features/app_update/notifier/app_update_notifier.dart';
-import 'package:hiddify/features/common/common_controllers.dart';
+import 'package:hiddify/features/connection/widget/connection_wrapper.dart';
+import 'package:hiddify/features/profile/notifier/profiles_update_notifier.dart';
+import 'package:hiddify/features/system_tray/widget/system_tray_wrapper.dart';
+import 'package:hiddify/features/window/widget/window_wrapper.dart';
 import 'package:hiddify/features/wrapper/shortcut/shortcut_wrapper.dart';
 import 'package:hiddify/utils/utils.dart';
 import 'package:hooks_riverpod/hooks_riverpod.dart';
@@ -28,35 +32,48 @@ class App extends HookConsumerWidget with PresLogger {
    final themeMode = ref.watch(themePreferencesProvider);
    final theme = AppTheme(themeMode, locale.preferredFontFamily);

-    ref.watch(commonControllersProvider);
-
    final upgrader = ref.watch(upgraderProvider);

-    return ShortcutWrapper(
-      MaterialApp.router(
-        routerConfig: router,
-        locale: locale.flutterLocale,
-        supportedLocales: AppLocaleUtils.supportedLocales,
-        localizationsDelegates: GlobalMaterialLocalizations.delegates,
-        debugShowCheckedModeBanner: false,
-        themeMode: themeMode.flutterThemeMode,
-        theme: theme.light(),
-        darkTheme: theme.dark(),
-        title: Constants.appName,
-        builder: (context, child) {
-          child = UpgradeAlert(
-            upgrader: upgrader,
-            navigatorKey: router.routerDelegate.navigatorKey,
-            child: child ?? const SizedBox(),
-          );
-          if (kDebugMode && _debugAccessibility) {
-            return AccessibilityTools(
-              checkFontOverflows: true,
-              child: child,
-            );
-          }
-          return child;
-        },
+    ref.listen(
+      introCompletedProvider,
+      (_, completed) async {
+        if (completed) {
+          await ref.read(foregroundProfilesUpdateNotifierProvider.future);
+        }
+      },
+    );
+
+    return WindowWrapper(
+      TrayWrapper(
+        ShortcutWrapper(
+          ConnectionWrapper(
+            MaterialApp.router(
+              routerConfig: router,
+              locale: locale.flutterLocale,
+              supportedLocales: AppLocaleUtils.supportedLocales,
+              localizationsDelegates: GlobalMaterialLocalizations.delegates,
+              debugShowCheckedModeBanner: false,
+              themeMode: themeMode.flutterThemeMode,
+              theme: theme.light(),
+              darkTheme: theme.dark(),
+              title: Constants.appName,
+              builder: (context, child) {
+                child = UpgradeAlert(
+                  upgrader: upgrader,
+                  navigatorKey: router.routerDelegate.navigatorKey,
+                  child: child ?? const SizedBox(),
+                );
+                if (kDebugMode && _debugAccessibility) {
+                  return AccessibilityTools(
+                    checkFontOverflows: true,
+                    child: child,
+                  );
+                }
+                return child;
+              },
+            ),
+          ),
+        ),
      ),
    );
  }
--- a/lib/features/auto_start/notifier/auto_start_notifier.dart
+++ b/lib/features/auto_start/notifier/auto_start_notifier.dart
@@ -0,0 +1,37 @@
+import 'dart:io';
+
+import 'package:hiddify/core/app_info/app_info_provider.dart';
+import 'package:hiddify/utils/utils.dart';
+import 'package:launch_at_startup/launch_at_startup.dart';
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+
+part 'auto_start_notifier.g.dart';
+
+@Riverpod(keepAlive: true)
+class AutoStartNotifier extends _$AutoStartNotifier with InfraLogger {
+  @override
+  Future<bool> build() async {
+    if (!PlatformUtils.isDesktop) return false;
+
+    final appInfo = ref.watch(appInfoProvider).requireValue;
+    launchAtStartup.setup(
+      appName: appInfo.name,
+      appPath: Platform.resolvedExecutable,
+    );
+    final isEnabled = await launchAtStartup.isEnabled();
+    loggy.info("auto start is [${isEnabled ? "Enabled" : "Disabled"}]");
+    return isEnabled;
+  }
+
+  Future<void> enable() async {
+    loggy.debug("enabling auto start");
+    await launchAtStartup.enable();
+    state = const AsyncValue.data(true);
+  }
+
+  Future<void> disable() async {
+    loggy.debug("disabling auto start");
+    await launchAtStartup.disable();
+    state = const AsyncValue.data(false);
+  }
+}
--- a/lib/features/common/common_controllers.dart
+++ b/lib/features/common/common_controllers.dart
@@ -1,41 +0,0 @@
-import 'package:hiddify/core/preferences/general_preferences.dart';
-import 'package:hiddify/features/common/window/window_controller.dart';
-import 'package:hiddify/features/connection/notifier/connection_notifier.dart';
-import 'package:hiddify/features/profile/notifier/profiles_update_notifier.dart';
-import 'package:hiddify/features/system_tray/system_tray_controller.dart';
-import 'package:hiddify/utils/platform_utils.dart';
-import 'package:riverpod_annotation/riverpod_annotation.dart';
-
-part 'common_controllers.g.dart';
-
-// this is a temporary solution to keep providers running even when there are no active listeners
-// https://github.com/rrousselGit/riverpod/discussions/2730
-@Riverpod(keepAlive: true)
-void commonControllers(CommonControllersRef ref) {
-  ref.listen(
-    introCompletedProvider,
-    (_, completed) async {
-      if (completed) {
-        await ref.read(foregroundProfilesUpdateNotifierProvider.future);
-      }
-    },
-    fireImmediately: true,
-  );
-  ref.listen(
-    connectionNotifierProvider,
-    (previous, next) {},
-    fireImmediately: true,
-  );
-  if (PlatformUtils.isDesktop) {
-    ref.listen(
-      windowControllerProvider,
-      (previous, next) {},
-      fireImmediately: true,
-    );
-    ref.listen(
-      systemTrayControllerProvider,
-      (previous, next) {},
-      fireImmediately: true,
-    );
-  }
-}
--- a/lib/features/common/window/window_controller.dart
+++ b/lib/features/common/window/window_controller.dart
@@ -1,80 +0,0 @@
-import 'package:flutter/material.dart';
-import 'package:hiddify/core/app_info/app_info_provider.dart';
-import 'package:hiddify/core/model/constants.dart';
-import 'package:hiddify/core/preferences/general_preferences.dart';
-import 'package:hiddify/core/preferences/service_preferences.dart';
-import 'package:hiddify/features/connection/notifier/connection_notifier.dart';
-import 'package:hiddify/utils/utils.dart';
-import 'package:riverpod_annotation/riverpod_annotation.dart';
-import 'package:window_manager/window_manager.dart';
-
-part 'window_controller.g.dart';
-
-// TODO improve
-@Riverpod(keepAlive: true)
-class WindowController extends _$WindowController
-    with WindowListener, AppLogger {
-  @override
-  Future<bool> build() async {
-    await windowManager.ensureInitialized();
-    const size = Size(868, 668);
-    const minimumSize = Size(368, 568);
-    const windowOptions = WindowOptions(
-      size: size,
-      minimumSize: minimumSize,
-      center: true,
-    );
-    await windowManager.setPreventClose(true);
-    await windowManager.waitUntilReadyToShow(
-      windowOptions,
-      () async {
-        final version = await ref.watch(appInfoProvider.future);
-        await windowManager
-            .setTitle("${Constants.appName} ${version.presentVersion}");
-
-        if (ref.read(silentStartNotifierProvider)) {
-          loggy.debug("silent start is enabled, hiding window");
-          await windowManager.hide();
-        }
-        await Future.delayed(
-          const Duration(seconds: 3),
-          () async {
-            if (ref.read(startedByUserProvider)) {
-              loggy.debug("previously started by user, trying to connect");
-              return ref.read(connectionNotifierProvider.notifier).mayConnect();
-            }
-          },
-        );
-      },
-    );
-    windowManager.addListener(this);
-
-    ref.onDispose(() {
-      loggy.debug("disposing");
-      windowManager.removeListener(this);
-    });
-    return windowManager.isVisible();
-  }
-
-  Future<void> show() async {
-    await windowManager.show();
-    await windowManager.focus();
-    state = const AsyncData(true);
-  }
-
-  Future<void> hide() async {
-    await windowManager.close();
-  }
-
-  Future<void> quit() async {
-    loggy.debug("quitting");
-    await windowManager.close();
-    await windowManager.destroy();
-  }
-
-  @override
-  Future<void> onWindowClose() async {
-    await windowManager.hide();
-    state = const AsyncData(false);
-  }
-}
--- a/lib/features/connection/widget/connection_wrapper.dart
+++ b/lib/features/connection/widget/connection_wrapper.dart
@@ -0,0 +1,39 @@
+import 'package:flutter/material.dart';
+import 'package:hiddify/core/preferences/service_preferences.dart';
+import 'package:hiddify/features/connection/notifier/connection_notifier.dart';
+import 'package:hiddify/utils/custom_loggers.dart';
+import 'package:hiddify/utils/platform_utils.dart';
+import 'package:hooks_riverpod/hooks_riverpod.dart';
+
+class ConnectionWrapper extends StatefulHookConsumerWidget {
+  const ConnectionWrapper(this.child, {super.key});
+
+  final Widget child;
+
+  @override
+  ConsumerState<ConsumerStatefulWidget> createState() =>
+      _ConnectionWrapperState();
+}
+
+class _ConnectionWrapperState extends ConsumerState<ConnectionWrapper>
+    with AppLogger {
+  @override
+  Widget build(BuildContext context) {
+    ref.listen(connectionNotifierProvider, (_, __) {});
+
+    return widget.child;
+  }
+
+  @override
+  void initState() {
+    super.initState();
+    Future.delayed(const Duration(seconds: 2)).then(
+      (_) async {
+        if (ref.read(startedByUserProvider) && PlatformUtils.isDesktop) {
+          loggy.debug("previously started by user, trying to connect");
+          return ref.read(connectionNotifierProvider.notifier).mayConnect();
+        }
+      },
+    );
+  }
+}
--- a/lib/features/settings/widgets/general_setting_tiles.dart
+++ b/lib/features/settings/widgets/general_setting_tiles.dart
@@ -5,8 +5,8 @@ import 'package:hiddify/core/localization/translations.dart';
 import 'package:hiddify/core/preferences/general_preferences.dart';
 import 'package:hiddify/core/theme/app_theme_mode.dart';
 import 'package:hiddify/core/theme/theme_preferences.dart';
+import 'package:hiddify/features/auto_start/notifier/auto_start_notifier.dart';
 import 'package:hiddify/features/common/general_pref_tiles.dart';
-import 'package:hiddify/services/auto_start_service.dart';
 import 'package:hiddify/utils/utils.dart';
 import 'package:hooks_riverpod/hooks_riverpod.dart';

@@ -67,12 +67,12 @@ class GeneralSettingTiles extends HookConsumerWidget {
        if (PlatformUtils.isDesktop) ...[
          SwitchListTile(
            title: Text(t.settings.general.autoStart),
-            value: ref.watch(autoStartServiceProvider).asData!.value,
+            value: ref.watch(autoStartNotifierProvider).asData!.value,
            onChanged: (value) async {
              if (value) {
-                await ref.read(autoStartServiceProvider.notifier).enable();
+                await ref.read(autoStartNotifierProvider.notifier).enable();
              } else {
-                await ref.read(autoStartServiceProvider.notifier).disable();
+                await ref.read(autoStartNotifierProvider.notifier).disable();
              }
            },
          ),
--- a/lib/features/system_tray/notifier/system_tray_notifier.dart
+++ b/lib/features/system_tray/notifier/system_tray_notifier.dart
@@ -3,34 +3,30 @@ import 'dart:io';
 import 'package:hiddify/core/localization/translations.dart';
 import 'package:hiddify/core/model/constants.dart';
 import 'package:hiddify/core/router/router.dart';
-import 'package:hiddify/features/common/window/window_controller.dart';
 import 'package:hiddify/features/config_option/model/config_option_patch.dart';
 import 'package:hiddify/features/config_option/notifier/config_option_notifier.dart';
 import 'package:hiddify/features/connection/model/connection_status.dart';
 import 'package:hiddify/features/connection/notifier/connection_notifier.dart';
+import 'package:hiddify/features/window/notifier/window_notifier.dart';
 import 'package:hiddify/gen/assets.gen.dart';
 import 'package:hiddify/singbox/model/singbox_config_enum.dart';
 import 'package:hiddify/utils/utils.dart';
 import 'package:riverpod_annotation/riverpod_annotation.dart';
 import 'package:tray_manager/tray_manager.dart';

-part 'system_tray_controller.g.dart';
+part 'system_tray_notifier.g.dart';

@Riverpod(keepAlive: true)
-class SystemTrayController extends _$SystemTrayController
-    with TrayListener, AppLogger {
+class SystemTrayNotifier extends _$SystemTrayNotifier with AppLogger {
  @override
  Future<void> build() async {
-    if (!_initialized) {
-      loggy.debug('initializing');
-      await trayManager.setIcon(
-        _trayIconPath,
-        isTemplate: Platform.isMacOS,
-      );
-      if (!Platform.isLinux) await trayManager.setToolTip(Constants.appName);
-      trayManager.addListener(this);
-      _initialized = true;
-    }
+    if (!PlatformUtils.isDesktop) return;
+
+    await trayManager.setIcon(
+      _trayIconPath,
+      isTemplate: Platform.isMacOS,
+    );
+    if (!Platform.isLinux) await trayManager.setToolTip(Constants.appName);

    ConnectionStatus connection;
    try {
@@ -55,11 +51,13 @@ class SystemTrayController extends _$SystemTrayController

    loggy.debug('updating system tray');

-    final trayMenu = Menu(
+    final menu = Menu(
      items: [
        MenuItem(
          label: t.tray.dashboard,
-          onClick: handleClickShowApp,
+          onClick: (_) async {
+            await ref.read(windowNotifierProvider.notifier).open();
+          },
        ),
        MenuItem.separator(),
        MenuItem.checkbox(
@@ -71,7 +69,11 @@ class SystemTrayController extends _$SystemTrayController
          },
          checked: connection.isConnected,
          disabled: connection.isSwitching,
-          onClick: handleClickSetAsSystemProxy,
+          onClick: (_) async {
+            await ref
+                .read(connectionNotifierProvider.notifier)
+                .toggleConnection();
+          },
        ),
        MenuItem.submenu(
          label: t.settings.config.serviceMode,
@@ -102,7 +104,7 @@ class SystemTrayController extends _$SystemTrayController
                (e) => MenuItem(
                  label: e.$1,
                  onClick: (_) async {
-                    await ref.read(windowControllerProvider.notifier).show();
+                    await ref.read(windowNotifierProvider.notifier).open();
                    ref.read(routerProvider).go(e.$2);
                  },
                ),
@@ -113,46 +115,18 @@ class SystemTrayController extends _$SystemTrayController
        MenuItem.separator(),
        MenuItem(
          label: t.tray.quit,
-          onClick: handleClickExitApp,
+          onClick: (_) async {
+            return ref.read(windowNotifierProvider.notifier).quit();
+          },
        ),
      ],
    );
-    await trayManager.setContextMenu(trayMenu);
+
+    await trayManager.setContextMenu(menu);
  }

-  bool _initialized = false;
-
-  String get _trayIconPath {
+  static String get _trayIconPath {
    if (Platform.isWindows) return Assets.images.trayIconIco;
    return Assets.images.trayIconPng.path;
  }
-
-  @override
-  Future<void> onTrayIconMouseDown() async {
-    if (Platform.isMacOS) {
-      await trayManager.popUpContextMenu();
-    } else {
-      await ref.read(windowControllerProvider.notifier).show();
-    }
-  }
-
-  @override
-  Future<void> onTrayIconRightMouseDown() async {
-    super.onTrayIconRightMouseDown();
-    await trayManager.popUpContextMenu();
-  }
-
-  Future<void> handleClickShowApp(MenuItem menuItem) async {
-    await ref.read(windowControllerProvider.notifier).show();
-  }
-
-  Future<void> handleClickSetAsSystemProxy(MenuItem menuItem) async {
-    return ref.read(connectionNotifierProvider.notifier).toggleConnection();
-  }
-
-  Future<void> handleClickExitApp(MenuItem menuItem) async {
-    await ref.read(connectionNotifierProvider.notifier).abortConnection();
-    await trayManager.destroy();
-    return ref.read(windowControllerProvider.notifier).quit();
-  }
 }
--- a/lib/features/system_tray/widget/system_tray_wrapper.dart
+++ b/lib/features/system_tray/widget/system_tray_wrapper.dart
@@ -0,0 +1,53 @@
+import 'dart:io';
+
+import 'package:flutter/material.dart';
+import 'package:hiddify/features/system_tray/notifier/system_tray_notifier.dart';
+import 'package:hiddify/features/window/notifier/window_notifier.dart';
+import 'package:hiddify/utils/custom_loggers.dart';
+import 'package:hooks_riverpod/hooks_riverpod.dart';
+import 'package:tray_manager/tray_manager.dart';
+
+class TrayWrapper extends StatefulHookConsumerWidget {
+  const TrayWrapper(this.child, {super.key});
+
+  final Widget child;
+
+  @override
+  ConsumerState<ConsumerStatefulWidget> createState() => _TrayWrapperState();
+}
+
+class _TrayWrapperState extends ConsumerState<TrayWrapper>
+    with TrayListener, AppLogger {
+  @override
+  Widget build(BuildContext context) {
+    ref.listen(systemTrayNotifierProvider, (_, __) {});
+
+    return widget.child;
+  }
+
+  @override
+  void initState() {
+    super.initState();
+    trayManager.addListener(this);
+  }
+
+  @override
+  void dispose() {
+    trayManager.removeListener(this);
+    super.dispose();
+  }
+
+  @override
+  Future<void> onTrayIconMouseDown() async {
+    if (Platform.isMacOS) {
+      await trayManager.popUpContextMenu();
+    } else {
+      await ref.read(windowNotifierProvider.notifier).open();
+    }
+  }
+
+  @override
+  Future<void> onTrayIconRightMouseDown() async {
+    await trayManager.popUpContextMenu();
+  }
+}
--- a/lib/features/window/notifier/window_notifier.dart
+++ b/lib/features/window/notifier/window_notifier.dart
@@ -0,0 +1,54 @@
+import 'dart:ui';
+
+import 'package:hiddify/core/app_info/app_info_provider.dart';
+import 'package:hiddify/core/model/constants.dart';
+import 'package:hiddify/features/connection/notifier/connection_notifier.dart';
+import 'package:hiddify/utils/utils.dart';
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+import 'package:tray_manager/tray_manager.dart';
+import 'package:window_manager/window_manager.dart';
+
+part 'window_notifier.g.dart';
+
+const minimumWindowSize = Size(368, 568);
+const defaultWindowSize = Size(868, 668);
+
+@Riverpod(keepAlive: true)
+class WindowNotifier extends _$WindowNotifier with AppLogger {
+  @override
+  Future<void> build() async {
+    if (!PlatformUtils.isDesktop) return;
+
+    await windowManager.ensureInitialized();
+    await windowManager.setMinimumSize(minimumWindowSize);
+    await windowManager.setSize(defaultWindowSize);
+
+    final appInfo = await ref.watch(appInfoProvider.future);
+    await windowManager
+        .setTitle("${Constants.appName} v${appInfo.presentVersion}");
+  }
+
+  Future<void> open({bool focus = true}) async {
+    await windowManager.show();
+    if (focus) await windowManager.focus();
+  }
+
+  // TODO add option to quit or minimize to tray
+  Future<void> close() async {
+    await windowManager.hide();
+  }
+
+  Future<void> quit() async {
+    await ref
+        .read(connectionNotifierProvider.notifier)
+        .abortConnection()
+        .timeout(const Duration(seconds: 2))
+        .catchError(
+      (e) {
+        loggy.warning("error aborting connection on quit", e);
+      },
+    );
+    await trayManager.destroy();
+    await windowManager.destroy();
+  }
+}
--- a/lib/features/window/widget/window_wrapper.dart
+++ b/lib/features/window/widget/window_wrapper.dart
@@ -0,0 +1,54 @@
+import 'dart:async';
+
+import 'package:flutter/material.dart';
+import 'package:hiddify/features/window/notifier/window_notifier.dart';
+import 'package:hiddify/utils/custom_loggers.dart';
+import 'package:hiddify/utils/platform_utils.dart';
+import 'package:hooks_riverpod/hooks_riverpod.dart';
+import 'package:window_manager/window_manager.dart';
+
+class WindowWrapper extends StatefulHookConsumerWidget {
+  const WindowWrapper(this.child, {super.key});
+
+  final Widget child;
+
+  @override
+  ConsumerState<ConsumerStatefulWidget> createState() => _WindowWrapperState();
+}
+
+class _WindowWrapperState extends ConsumerState<WindowWrapper>
+    with WindowListener, AppLogger {
+  @override
+  Widget build(BuildContext context) {
+    ref.watch(windowNotifierProvider);
+
+    return widget.child;
+  }
+
+  @override
+  void initState() {
+    super.initState();
+    windowManager.addListener(this);
+    if (PlatformUtils.isDesktop) {
+      WidgetsBinding.instance.addPostFrameCallback((_) async {
+        await windowManager.setPreventClose(true);
+      });
+    }
+  }
+
+  @override
+  void dispose() {
+    windowManager.removeListener(this);
+    super.dispose();
+  }
+
+  @override
+  Future<void> onWindowClose() async {
+    await ref.read(windowNotifierProvider.notifier).close();
+  }
+
+  @override
+  void onWindowFocus() {
+    setState(() {});
+  }
+}
--- a/lib/features/wrapper/shortcut/shortcut_wrapper.dart
+++ b/lib/features/wrapper/shortcut/shortcut_wrapper.dart
@@ -3,7 +3,7 @@ import 'dart:io';
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 import 'package:hiddify/core/router/router.dart';
-import 'package:hiddify/features/common/window/window_controller.dart';
+import 'package:hiddify/features/window/notifier/window_notifier.dart';
 import 'package:hooks_riverpod/hooks_riverpod.dart';

 class ShortcutWrapper extends HookConsumerWidget {
@@ -44,13 +44,13 @@ class ShortcutWrapper extends HookConsumerWidget {
        actions: {
          CloseWindowIntent: CallbackAction(
            onInvoke: (_) async {
-              await ref.read(windowControllerProvider.notifier).hide();
+              await ref.read(windowNotifierProvider.notifier).close();
              return null;
            },
          ),
          QuitAppIntent: CallbackAction(
            onInvoke: (_) async {
-              await ref.read(windowControllerProvider.notifier).quit();
+              await ref.read(windowNotifierProvider.notifier).quit();
              return null;
            },
          ),