refactor: owned action assets filter

mobile/lib/domain/models/asset/remote_asset.model.dart

@@ -52,6 +52,8 @@ class RemoteAsset extends BaseAsset {
 
   bool get isTrashed => deletedAt != null;
 
+  bool get isStacked => stackId != null;
+
   @override
   String toString() {
     return '''Asset {

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

@@ -3,25 +3,29 @@ 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/utils/asset_filter.dart';
 import 'package:immich_ui/immich_ui.dart';
 
 class FavoriteAction extends AssetAction<RemoteAsset> {
-  final bool shouldFavorite;
+  final bool favorite;
 
-  FavoriteAction({required super.assets}) : shouldFavorite = assets.any((asset) => !asset.isFavorite);
+  FavoriteAction({required super.assets}) : favorite = assets.any((asset) => !asset.isFavorite);
 
   @override
-  IconData get icon => shouldFavorite ? Icons.favorite_border_rounded : Icons.favorite_rounded;
+  IconData get icon => favorite ? Icons.favorite_border_rounded : Icons.favorite_rounded;
 
   @override
-  String label(ActionScope scope) => shouldFavorite ? scope.context.t.favorite : scope.context.t.unfavorite;
+  String label(ActionScope scope) => favorite ? scope.context.t.favorite : scope.context.t.unfavorite;
 
   @override
-  Iterable<RemoteAsset> filter(ActionScope scope) => assets
-      .where(
-        (asset) => asset is RemoteAsset && asset.ownerId == scope.authUser.id && asset.isFavorite == !shouldFavorite,
-      )
-      .cast<RemoteAsset>();
+  Iterable<RemoteAsset> filter(ActionScope scope) {
+    final owned = AssetFilter(assets).owned(scope.authUser.id);
+    if (favorite) {
+      return owned.notFavorites();
+    } else {
+      return owned.favorites();
+    }
+  }
 
   @override
   bool isVisible(ActionScope scope) => filter(scope).isNotEmpty;
@@ -31,8 +35,8 @@ class FavoriteAction extends AssetAction<RemoteAsset> {
     final ActionScope(:ref) = scope;
     final assets = filter(scope).map((asset) => asset.id).toList(growable: false);
 
-    await ref.read(assetServiceProvider).updateFavorite(assets, shouldFavorite);
-    final message = shouldFavorite
+    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);

mobile/lib/utils/asset_filter.dart

@@ -0,0 +1,28 @@
+import 'package:immich_mobile/domain/models/asset/base_asset.model.dart';
+
+extension type const AssetFilter<T extends BaseAsset>(Iterable<T> assets) implements Iterable<T> {
+  AssetFilter<T> where(bool Function(T asset) test) => AssetFilter(assets.where(test));
+  AssetFilter<T> whereNot(bool Function(T asset) test) => AssetFilter(assets.where((asset) => !test(asset)));
+
+  AssetFilter<T> type(AssetType type) => where((asset) => asset.type == type);
+  AssetFilter<T> favorites() => where(_isFavorite);
+  AssetFilter<T> notFavorites() => whereNot(_isFavorite);
+
+  AssetFilter<RemoteAsset> remote() => AssetFilter(assets.whereType<RemoteAsset>());
+  AssetFilter<RemoteAsset> owned(String ownerId) => remote().where((asset) => asset.ownerId == ownerId);
+  AssetFilter<RemoteAsset> visibility(AssetVisibility visibility) => remote().where(_hasVisibility(visibility));
+  AssetFilter<RemoteAsset> notVisibility(AssetVisibility visibility) => remote().whereNot(_hasVisibility(visibility));
+  AssetFilter<RemoteAsset> archived() => visibility(.archive);
+  AssetFilter<RemoteAsset> notArchived() => notVisibility(.archive);
+  AssetFilter<RemoteAsset> stacked() => remote().where(_isStacked);
+  AssetFilter<RemoteAsset> notStacked() => remote().whereNot(_isStacked);
+
+  AssetFilter<LocalAsset> local() => AssetFilter(assets.whereType<LocalAsset>());
+  AssetFilter<LocalAsset> backedUp() => local().where(_isBackedUp);
+}
+
+bool _isFavorite(BaseAsset asset) => asset.isFavorite;
+bool _isStacked(RemoteAsset asset) => asset.isStacked;
+bool _isBackedUp(LocalAsset asset) => asset.remoteAssetId != null;
+bool Function(RemoteAsset asset) _hasVisibility(AssetVisibility visibility) =>
+    (asset) => asset.visibility == visibility;

mobile/test/unit/factories/remote_asset_factory.dart

@@ -5,7 +5,14 @@ import '../../utils.dart';
 class RemoteAssetFactory {
   const RemoteAssetFactory();
 
-  static RemoteAsset create({String? id, String? name, String? ownerId, bool isFavorite = false}) {
+  static RemoteAsset create({
+    String? id,
+    String? name,
+    String? ownerId,
+    bool isFavorite = false,
+    AssetVisibility visibility = AssetVisibility.timeline,
+    String? stackId,
+  }) {
     id = TestUtils.uuid(id);
 
     return RemoteAsset(
@@ -17,6 +24,8 @@ class RemoteAssetFactory {
       createdAt: TestUtils.yesterday(),
       updatedAt: TestUtils.now(),
       isFavorite: isFavorite,
+      visibility: visibility,
+      stackId: stackId,
       isEdited: false,
     );
   }

mobile/test/unit/utils/asset_filter_test.dart

@@ -0,0 +1,200 @@
+import 'package:flutter_test/flutter_test.dart';
+import 'package:immich_mobile/domain/models/asset/base_asset.model.dart';
+import 'package:immich_mobile/utils/asset_filter.dart';
+
+import '../factories/local_asset_factory.dart';
+import '../factories/remote_asset_factory.dart';
+
+void main() {
+  group('AssetFilter', () {
+    group('type promotion', () {
+      test('a bare filter retains every BaseAsset', () {
+        final remoteAsset = RemoteAssetFactory.create();
+        final localAsset = LocalAssetFactory.create();
+
+        final AssetFilter<BaseAsset> filter = AssetFilter(<BaseAsset>[remoteAsset, localAsset]);
+
+        expect(filter.toList(), [remoteAsset, localAsset]);
+      });
+
+      test('remote keeps only remote assets', () {
+        final remoteAsset = RemoteAssetFactory.create();
+        final localAsset = LocalAssetFactory.create();
+
+        final AssetFilter<RemoteAsset> remoteOnly = AssetFilter(<BaseAsset>[remoteAsset, localAsset]).remote();
+
+        expect(remoteOnly.toList(), [remoteAsset]);
+      });
+
+      test('local keeps only local assets', () {
+        final remoteAsset = RemoteAssetFactory.create();
+        final localAsset = LocalAssetFactory.create();
+
+        final AssetFilter<LocalAsset> localOnly = AssetFilter(<BaseAsset>[remoteAsset, localAsset]).local();
+
+        expect(localOnly.toList(), [localAsset]);
+      });
+
+      test('owned promotes to RemoteAsset and drops local assets', () {
+        final remoteAsset = RemoteAssetFactory.create();
+        final localAsset = LocalAssetFactory.create();
+
+        final AssetFilter<RemoteAsset> remoteOnly = AssetFilter(<BaseAsset>[
+          remoteAsset,
+          localAsset,
+        ]).owned(remoteAsset.ownerId);
+
+        expect(remoteOnly.toList(), [remoteAsset]);
+      });
+
+      test('backedUp promotes to LocalAsset and drops remote assets', () {
+        final syncedPhoto = LocalAssetFactory.create().copyWith(remoteId: 'remote');
+        final offlinePhoto = LocalAssetFactory.create();
+        final remotePhoto = RemoteAssetFactory.create();
+
+        final AssetFilter<LocalAsset> syncedPhotos = AssetFilter(<BaseAsset>[
+          syncedPhoto,
+          offlinePhoto,
+          remotePhoto,
+        ]).backedUp();
+
+        expect(syncedPhotos.toList(), [syncedPhoto]);
+      });
+    });
+
+    group('named filters', () {
+      test('owned keeps only assets of the given owner', () {
+        final asset1 = RemoteAssetFactory.create();
+        final asset2 = RemoteAssetFactory.create();
+
+        final alexPhotos = AssetFilter([asset1, asset2]).owned(asset1.ownerId);
+
+        expect(alexPhotos.toList(), [asset1]);
+      });
+
+      test('favorites keeps only favorite assets', () {
+        final asset1 = RemoteAssetFactory.create(isFavorite: true);
+        final asset2 = RemoteAssetFactory.create(ownerId: asset1.ownerId);
+
+        final favorites = AssetFilter([asset1, asset2]).favorites();
+
+        expect(favorites.toList(), [asset1]);
+      });
+
+      test('type keeps only assets of the given type', () {
+        final image = RemoteAssetFactory.create();
+        final video = RemoteAssetFactory.create(ownerId: image.ownerId).copyWith(type: .video);
+
+        final videos = AssetFilter([image, video]).type(.video);
+
+        expect(videos.toList(), [video]);
+      });
+
+      test('visibility keeps only assets with the given visibility', () {
+        final locked = RemoteAssetFactory.create(visibility: AssetVisibility.locked);
+        final onTimeline = RemoteAssetFactory.create(ownerId: locked.ownerId);
+
+        final lockedPhotos = AssetFilter([locked, onTimeline]).visibility(.locked);
+
+        expect(lockedPhotos.toList(), [locked]);
+      });
+
+      test('archived keeps only archived assets', () {
+        final archived = RemoteAssetFactory.create(visibility: AssetVisibility.archive);
+        final onTimeline = RemoteAssetFactory.create(ownerId: archived.ownerId);
+
+        final archivedPhotos = AssetFilter([archived, onTimeline]).archived();
+
+        expect(archivedPhotos.toList(), [archived]);
+      });
+
+      test('stacked keeps only assets belonging to a stack', () {
+        final stacked = RemoteAssetFactory.create(stackId: 'stack');
+        final loose = RemoteAssetFactory.create(ownerId: stacked.ownerId);
+
+        final stackedPhotos = AssetFilter([stacked, loose]).stacked();
+
+        expect(stackedPhotos.toList(), [stacked]);
+      });
+    });
+
+    group('inversion', () {
+      test('notArchived keeps every non-archived visibility', () {
+        final archived = RemoteAssetFactory.create(visibility: AssetVisibility.archive);
+        final onTimeline = RemoteAssetFactory.create(ownerId: archived.ownerId, visibility: AssetVisibility.timeline);
+        final hidden = RemoteAssetFactory.create(ownerId: archived.ownerId, visibility: AssetVisibility.hidden);
+        final locked = RemoteAssetFactory.create(ownerId: archived.ownerId, visibility: AssetVisibility.locked);
+
+        final visiblePhotos = AssetFilter([archived, onTimeline, hidden, locked]).notArchived();
+
+        expect(visiblePhotos.toSet(), {onTimeline, hidden, locked});
+      });
+
+      test('notVisibility keeps every asset not at the target visibility', () {
+        final archived = RemoteAssetFactory.create(visibility: AssetVisibility.archive);
+        final onTimeline = RemoteAssetFactory.create(ownerId: archived.ownerId, visibility: AssetVisibility.timeline);
+        final locked = RemoteAssetFactory.create(ownerId: archived.ownerId, visibility: AssetVisibility.locked);
+
+        final toArchive = AssetFilter([archived, onTimeline, locked]).notVisibility(.archive);
+
+        expect(toArchive.toSet(), {onTimeline, locked});
+      });
+
+      test('notStacked keeps only assets without a stack', () {
+        final stacked = RemoteAssetFactory.create(stackId: 'stack');
+        final loose = RemoteAssetFactory.create(ownerId: stacked.ownerId);
+
+        final loosePhotos = AssetFilter([stacked, loose]).notStacked();
+
+        expect(loosePhotos.toList(), [loose]);
+      });
+
+      test('whereNot inverts an arbitrary predicate', () {
+        final favorite = RemoteAssetFactory.create(isFavorite: true);
+        final regular = RemoteAssetFactory.create(ownerId: favorite.ownerId);
+
+        final nonFavorites = AssetFilter([favorite, regular]).whereNot((asset) => asset.isFavorite);
+
+        expect(nonFavorites.toList(), [regular]);
+      });
+
+      test('notFavorites keeps only non-favorite assets', () {
+        final favorite = RemoteAssetFactory.create(isFavorite: true);
+        final regular = RemoteAssetFactory.create(ownerId: favorite.ownerId);
+
+        final nonFavorites = AssetFilter([favorite, regular]).notFavorites();
+
+        expect(nonFavorites.toList(), [regular]);
+      });
+    });
+
+    group('chaining', () {
+      test('combines predicates across owner, visibility and stack', () {
+        final asset = RemoteAssetFactory.create();
+        final wrongOwner = RemoteAssetFactory.create();
+        final archived = RemoteAssetFactory.create(ownerId: asset.ownerId, visibility: AssetVisibility.archive);
+        final stacked = RemoteAssetFactory.create(ownerId: asset.ownerId, stackId: 'stack-1');
+        final localPhoto = LocalAssetFactory.create();
+
+        final result = AssetFilter(<BaseAsset>[
+          asset,
+          wrongOwner,
+          archived,
+          stacked,
+          localPhoto,
+        ]).owned(asset.ownerId).notArchived().notStacked();
+
+        expect(result.toList(), [asset]);
+      });
+
+      test('a base filter after a promotion retains the promoted type', () {
+        final favorite = RemoteAssetFactory.create(isFavorite: true);
+        final regular = RemoteAssetFactory.create(ownerId: favorite.ownerId);
+
+        final AssetFilter<RemoteAsset> result = AssetFilter([favorite, regular]).owned(favorite.ownerId).favorites();
+
+        expect(result.toList(), [favorite]);
+      });
+    });
+  });
+}