chore: migrate general bottom sheet favorite (#29361)

Co-authored-by: shenlong-tanwen <139912620+shalong-tanwen@users.noreply.github.com>

mobile/lib/presentation/actions/favorite.action.dart

@@ -3,8 +3,8 @@ import 'package:immich_mobile/domain/models/asset/base_asset.model.dart';
 import 'package:immich_mobile/generated/translations.g.dart';
 import 'package:immich_mobile/presentation/actions/action.dart';
 import 'package:immich_mobile/providers/infrastructure/asset.provider.dart';
+import 'package:immich_mobile/providers/infrastructure/toast.provider.dart';
 import 'package:immich_mobile/utils/asset_filter.dart';
-import 'package:immich_ui/immich_ui.dart';
 
 class FavoriteAction extends AssetAction<RemoteAsset> {
   final bool favorite;
@@ -26,13 +26,13 @@ class FavoriteAction extends AssetAction<RemoteAsset> {
 
   @override
   Future<void> onAction(ActionScope scope) async {
-    final ActionScope(:ref) = scope;
+    final ActionScope(:ref, :context) = scope;
     final assets = filter(scope).map((asset) => asset.id).toList(growable: false);
 
     await ref.read(assetServiceProvider).updateFavorite(assets, favorite);
     final message = favorite
-        ? StaticTranslations.instance.favorite_action_prompt(count: assets.length)
-        : StaticTranslations.instance.unfavorite_action_prompt(count: assets.length);
-    snackbar.success(message);
+        ? context.t.favorite_action_prompt(count: assets.length)
+        : context.t.unfavorite_action_prompt(count: assets.length);
+    ref.read(toastRepositoryProvider).success(message);
   }
 }

mobile/lib/presentation/widgets/action_buttons/favorite_action_button.widget.dart

@@ -1,61 +0,0 @@
-import 'package:flutter/material.dart';
-import 'package:fluttertoast/fluttertoast.dart';
-import 'package:hooks_riverpod/hooks_riverpod.dart';
-import 'package:immich_mobile/constants/enums.dart';
-import 'package:immich_mobile/domain/models/asset/base_asset.model.dart';
-import 'package:immich_mobile/extensions/translate_extensions.dart';
-import 'package:immich_mobile/presentation/widgets/action_buttons/base_action_button.widget.dart';
-import 'package:immich_mobile/providers/asset_viewer/asset_viewer.provider.dart';
-import 'package:immich_mobile/providers/infrastructure/action.provider.dart';
-import 'package:immich_mobile/providers/timeline/multiselect.provider.dart';
-import 'package:immich_mobile/widgets/common/immich_toast.dart';
-
-class FavoriteActionButton extends ConsumerWidget {
-  final ActionSource source;
-  final bool iconOnly;
-  final bool menuItem;
-
-  const FavoriteActionButton({super.key, required this.source, this.iconOnly = false, this.menuItem = false});
-
-  void _onTap(BuildContext context, WidgetRef ref) async {
-    if (!context.mounted) {
-      return;
-    }
-
-    final result = await ref.read(actionProvider.notifier).favorite(source);
-
-    if (source == ActionSource.viewer) {
-      if (result.success) {
-        final currentAsset = ref.read(assetViewerProvider).currentAsset;
-        if (currentAsset is RemoteAsset && !currentAsset.isFavorite) {
-          ref.read(assetViewerProvider.notifier).setAsset(currentAsset.copyWith(isFavorite: true));
-        }
-      }
-      return;
-    }
-
-    ref.read(multiSelectProvider.notifier).reset();
-
-    final successMessage = 'favorite_action_prompt'.t(context: context, args: {'count': result.count.toString()});
-
-    if (context.mounted) {
-      ImmichToast.show(
-        context: context,
-        msg: result.success ? successMessage : 'scaffold_body_error_occurred'.t(context: context),
-        gravity: ToastGravity.BOTTOM,
-        toastType: result.success ? ToastType.success : ToastType.error,
-      );
-    }
-  }
-
-  @override
-  Widget build(BuildContext context, WidgetRef ref) {
-    return BaseActionButton(
-      iconData: Icons.favorite_border_rounded,
-      label: "favorite".t(context: context),
-      iconOnly: iconOnly,
-      menuItem: menuItem,
-      onPressed: () => _onTap(context, ref),
-    );
-  }
-}

mobile/lib/presentation/widgets/action_buttons/unfavorite_action_button.widget.dart

@@ -1,61 +0,0 @@
-import 'package:flutter/material.dart';
-import 'package:fluttertoast/fluttertoast.dart';
-import 'package:hooks_riverpod/hooks_riverpod.dart';
-import 'package:immich_mobile/constants/enums.dart';
-import 'package:immich_mobile/domain/models/asset/base_asset.model.dart';
-import 'package:immich_mobile/extensions/translate_extensions.dart';
-import 'package:immich_mobile/presentation/widgets/action_buttons/base_action_button.widget.dart';
-import 'package:immich_mobile/providers/asset_viewer/asset_viewer.provider.dart';
-import 'package:immich_mobile/providers/infrastructure/action.provider.dart';
-import 'package:immich_mobile/providers/timeline/multiselect.provider.dart';
-import 'package:immich_mobile/widgets/common/immich_toast.dart';
-
-class UnFavoriteActionButton extends ConsumerWidget {
-  final ActionSource source;
-  final bool iconOnly;
-  final bool menuItem;
-
-  const UnFavoriteActionButton({super.key, required this.source, this.iconOnly = false, this.menuItem = false});
-
-  void _onTap(BuildContext context, WidgetRef ref) async {
-    if (!context.mounted) {
-      return;
-    }
-
-    final result = await ref.read(actionProvider.notifier).unFavorite(source);
-
-    if (source == ActionSource.viewer) {
-      if (result.success) {
-        final currentAsset = ref.read(assetViewerProvider).currentAsset;
-        if (currentAsset is RemoteAsset && currentAsset.isFavorite) {
-          ref.read(assetViewerProvider.notifier).setAsset(currentAsset.copyWith(isFavorite: false));
-        }
-      }
-      return;
-    }
-
-    ref.read(multiSelectProvider.notifier).reset();
-
-    final successMessage = 'unfavorite_action_prompt'.t(context: context, args: {'count': result.count.toString()});
-
-    if (context.mounted) {
-      ImmichToast.show(
-        context: context,
-        msg: result.success ? successMessage : 'scaffold_body_error_occurred'.t(context: context),
-        gravity: ToastGravity.BOTTOM,
-        toastType: result.success ? ToastType.success : ToastType.error,
-      );
-    }
-  }
-
-  @override
-  Widget build(BuildContext context, WidgetRef ref) {
-    return BaseActionButton(
-      iconData: Icons.favorite_rounded,
-      label: "unfavorite".t(context: context),
-      onPressed: () => _onTap(context, ref),
-      iconOnly: iconOnly,
-      menuItem: menuItem,
-    );
-  }
-}

mobile/lib/presentation/widgets/bottom_sheet/general_bottom_sheet.widget.dart

@@ -5,6 +5,7 @@ import 'package:immich_mobile/constants/enums.dart';
 import 'package:immich_mobile/domain/models/album/album.model.dart';
 import 'package:immich_mobile/presentation/actions/action.widget.dart';
 import 'package:immich_mobile/presentation/actions/asset_debug.action.dart';
+import 'package:immich_mobile/presentation/actions/favorite.action.dart';
 import 'package:immich_mobile/presentation/actions/timeline.action.dart';
 import 'package:immich_mobile/presentation/widgets/action_buttons/archive_action_button.widget.dart';
 import 'package:immich_mobile/presentation/widgets/action_buttons/bulk_tag_assets_action_button.widget.dart';
@@ -14,7 +15,6 @@ import 'package:immich_mobile/presentation/widgets/action_buttons/delete_permane
 import 'package:immich_mobile/presentation/widgets/action_buttons/download_action_button.widget.dart';
 import 'package:immich_mobile/presentation/widgets/action_buttons/edit_date_time_action_button.widget.dart';
 import 'package:immich_mobile/presentation/widgets/action_buttons/edit_location_action_button.widget.dart';
-import 'package:immich_mobile/presentation/widgets/action_buttons/favorite_action_button.widget.dart';
 import 'package:immich_mobile/presentation/widgets/action_buttons/move_to_lock_folder_action_button.widget.dart';
 import 'package:immich_mobile/presentation/widgets/action_buttons/share_action_button.widget.dart';
 import 'package:immich_mobile/presentation/widgets/action_buttons/share_link_action_button.widget.dart';
@@ -84,7 +84,7 @@ class _GeneralBottomSheetState extends ConsumerState<GeneralBottomSheet> {
     }
 
     final assets = multiselect.selectedAssets.toList(growable: false);
-    final actions = [AssetDebugAction(assets: assets)];
+    final actions = [AssetDebugAction(assets: assets), FavoriteAction(assets: assets)];
 
     return BaseBottomSheet(
       controller: sheetController,
@@ -101,7 +101,6 @@ class _GeneralBottomSheetState extends ConsumerState<GeneralBottomSheet> {
           isTrashEnable
               ? const TrashActionButton(source: ActionSource.timeline)
               : const DeletePermanentActionButton(source: ActionSource.timeline),
-          const FavoriteActionButton(source: ActionSource.timeline),
           const ArchiveActionButton(source: ActionSource.timeline),
           if (tagsEnabled) const BulkTagAssetsActionButton(source: ActionSource.timeline),
           const EditDateTimeActionButton(source: ActionSource.timeline),

mobile/lib/providers/infrastructure/action.provider.dart

@@ -156,28 +156,6 @@ class ActionNotifier extends Notifier<void> {
     }
   }
 
-  Future<ActionResult> favorite(ActionSource source) async {
-    final ids = _getOwnedRemoteIdsForSource(source);
-    try {
-      await _service.favorite(ids);
-      return ActionResult(count: ids.length, success: true);
-    } catch (error, stack) {
-      _logger.severe('Failed to favorite assets', error, stack);
-      return ActionResult(count: ids.length, success: false, error: error.toString());
-    }
-  }
-
-  Future<ActionResult> unFavorite(ActionSource source) async {
-    final ids = _getOwnedRemoteIdsForSource(source);
-    try {
-      await _service.unFavorite(ids);
-      return ActionResult(count: ids.length, success: true);
-    } catch (error, stack) {
-      _logger.severe('Failed to unfavorite assets', error, stack);
-      return ActionResult(count: ids.length, success: false, error: error.toString());
-    }
-  }
-
   Future<ActionResult> archive(ActionSource source) async {
     final ids = _getOwnedRemoteIdsForSource(source);
     try {

mobile/lib/services/action.service.dart

@@ -68,16 +68,6 @@ class ActionService {
     unawaited(context.pushRoute(SharedLinkEditRoute(assetsList: remoteIds)));
   }
 
-  Future<void> favorite(List<String> remoteIds) async {
-    await _assetApiRepository.updateFavorite(remoteIds, true);
-    await _remoteAssetRepository.updateFavorite(remoteIds, true);
-  }
-
-  Future<void> unFavorite(List<String> remoteIds) async {
-    await _assetApiRepository.updateFavorite(remoteIds, false);
-    await _remoteAssetRepository.updateFavorite(remoteIds, false);
-  }
-
   Future<void> archive(List<String> remoteIds) async {
     await _assetApiRepository.updateVisibility(remoteIds, .archive);
     await _remoteAssetRepository.updateVisibility(remoteIds, AssetVisibility.archive);

mobile/test/unit/presentation/actions/favorite_action_test.dart

@@ -1,6 +1,6 @@
-import 'package:flutter/material.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:immich_mobile/domain/models/asset/base_asset.model.dart';
+import 'package:immich_mobile/generated/translations.g.dart';
 import 'package:immich_mobile/presentation/actions/favorite.action.dart';
 import 'package:mocktail/mocktail.dart';
 
@@ -68,11 +68,22 @@ void main() {
       verify(() => assetService.updateFavorite([stale.id], true)).called(1);
     });
 
-    testWidgets('shows a confirmation snackbar on success', (tester) async {
-      await tester.pumpTestAction(context, FavoriteAction(assets: [owned()]));
-      await tester.pumpUntilFound(find.byType(SnackBar));
+    testWidgets('reports the favorite count through the toast repository', (tester) async {
+      final toast = context.repository.toast;
 
-      expect(find.byType(SnackBar), findsOneWidget);
+      await tester.pumpTestAction(context, FavoriteAction(assets: [owned(), owned()]));
+
+      final message = verify(() => toast.success(captureAny())).captured.single as String;
+      expect(message, StaticTranslations.instance.favorite_action_prompt(count: 2));
+    });
+
+    testWidgets('reports the unfavorite count through the toast repository', (tester) async {
+      final toast = context.repository.toast;
+
+      await tester.pumpTestAction(context, FavoriteAction(assets: [owned(isFavorite: true), owned(isFavorite: true)]));
+
+      final message = verify(() => toast.success(captureAny())).captured.single as String;
+      expect(message, StaticTranslations.instance.unfavorite_action_prompt(count: 2));
     });
   });
 }