1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-04-21 15:36:26 +02:00

refactor(mobile): render list ()

* refactor(mobile): render list 2

* wip

* wip: asset selection page

* remove render_list provider

* remove dead code

* yaml format

* remove unused file

* woop woop more clean up

* woop woop more clean up 2

* fix: album selection doesn't load instantly
This commit is contained in:
Alex 2025-02-25 11:33:48 -06:00 committed by GitHub
parent 7c851893b4
commit d0381fddec
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
26 changed files with 134 additions and 140 deletions

View file

@ -75,12 +75,12 @@ custom_lint:
- lib/pages/album/album_asset_selection.page.dart
- lib/routing/router.dart
- lib/services/immich_logger.service.dart # not really a service... more a util
- lib/utils/{db,migration,renderlist_generator}.dart
- lib/utils/{db,migration}.dart
- lib/widgets/asset_grid/asset_grid_data_structure.dart
- test/**.dart
# refactor the remaining providers
- lib/providers/{asset,authentication,db,user}.provider.dart
- lib/providers/{asset_viewer/render_list,backup/backup,search/all_motion_photos,search/recently_added_asset}.provider.dart
- lib/providers/{db,user}.provider.dart
- lib/providers/backup/backup.provider.dart
- import_rule_openapi:
message: openapi must only be used through ApiRepositories

View file

@ -65,6 +65,9 @@ abstract interface class IAssetRepository implements IDatabaseRepository {
Stream<Asset?> watchAsset(int id, {bool fireImmediately = false});
Future<List<Asset>> getTrashAssets(int userId);
Future<List<Asset>> getRecentlyAddedAssets(int userId);
Future<List<Asset>> getMotionAssets(int userId);
}
enum AssetSort { checksum, ownerIdChecksum }

View file

@ -1,4 +1,5 @@
import 'package:immich_mobile/entities/album.entity.dart';
import 'package:immich_mobile/entities/asset.entity.dart';
import 'package:immich_mobile/widgets/asset_grid/asset_grid_data_structure.dart';
abstract class ITimelineRepository {
@ -16,4 +17,11 @@ abstract class ITimelineRepository {
List<int> userIds,
GroupAssetsBy groupAssetsBy,
);
Future<RenderList> getTimelineFromAssets(
List<Asset> assets,
GroupAssetsBy getGroupByOption,
);
Stream<RenderList> watchAssetSelectionTimeline(int userId);
}

View file

@ -6,11 +6,10 @@ import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/extensions/asyncvalue_extensions.dart';
import 'package:immich_mobile/extensions/build_context_extensions.dart';
import 'package:immich_mobile/models/albums/asset_selection_page_result.model.dart';
import 'package:immich_mobile/providers/asset_viewer/render_list.provider.dart';
import 'package:immich_mobile/providers/timeline.provider.dart';
import 'package:immich_mobile/widgets/asset_grid/asset_grid_data_structure.dart';
import 'package:immich_mobile/widgets/asset_grid/immich_asset_grid.dart';
import 'package:immich_mobile/entities/asset.entity.dart';
import 'package:isar/isar.dart';
@RoutePage()
class AlbumAssetSelectionPage extends HookConsumerWidget {
@ -18,16 +17,14 @@ class AlbumAssetSelectionPage extends HookConsumerWidget {
super.key,
required this.existingAssets,
this.canDeselect = false,
required this.query,
});
final Set<Asset> existingAssets;
final QueryBuilder<Asset, Asset, QAfterSortBy>? query;
final bool canDeselect;
@override
Widget build(BuildContext context, WidgetRef ref) {
final renderList = ref.watch(renderListQueryProvider(query));
final assetSelectionRenderList = ref.watch(assetSelectionTimelineProvider);
final selected = useState<Set<Asset>>(existingAssets);
final selectionEnabledHook = useState(true);
@ -83,7 +80,7 @@ class AlbumAssetSelectionPage extends HookConsumerWidget {
),
],
),
body: renderList.widgetWhen(
body: assetSelectionRenderList.widgetWhen(
onData: (data) => buildBody(data),
),
);

View file

@ -21,7 +21,6 @@ import 'package:immich_mobile/providers/auth.provider.dart';
import 'package:immich_mobile/widgets/album/album_viewer_appbar.dart';
import 'package:immich_mobile/routing/router.dart';
import 'package:immich_mobile/entities/asset.entity.dart';
import 'package:immich_mobile/providers/asset.provider.dart';
import 'package:immich_mobile/widgets/asset_grid/multiselect_grid.dart';
import 'package:immich_mobile/widgets/common/immich_toast.dart';
@ -63,7 +62,6 @@ class AlbumViewer extends HookConsumerWidget {
AlbumAssetSelectionRoute(
existingAssets: album.assets,
canDeselect: false,
query: getRemoteAssetQuery(ref),
),
);

View file

@ -4,6 +4,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/pages/album/album_viewer.dart';
import 'package:immich_mobile/providers/album/album.provider.dart';
import 'package:immich_mobile/providers/album/current_album.provider.dart';
import 'package:immich_mobile/providers/timeline.provider.dart';
@RoutePage()
class AlbumViewerPage extends HookConsumerWidget {
@ -16,6 +17,9 @@ class AlbumViewerPage extends HookConsumerWidget {
// Listen provider to prevent autoDispose when navigating to other routes from within the viewer page
ref.listen(currentAlbumProvider, (_, __) {});
// This call helps rendering the asset selection instantly
ref.listen(assetSelectionTimelineProvider, (_, __) {});
ref.listen(albumWatcher(albumId), (_, albumFuture) {
albumFuture.whenData(
(value) => ref.read(currentAlbumProvider.notifier).set(value),

View file

@ -8,7 +8,6 @@ import 'package:immich_mobile/extensions/build_context_extensions.dart';
import 'package:immich_mobile/models/albums/asset_selection_page_result.model.dart';
import 'package:immich_mobile/providers/album/album.provider.dart';
import 'package:immich_mobile/providers/album/album_title.provider.dart';
import 'package:immich_mobile/providers/asset.provider.dart';
import 'package:immich_mobile/routing/router.dart';
import 'package:immich_mobile/widgets/album/album_action_filled_button.dart';
import 'package:immich_mobile/widgets/album/album_title_text_field.dart';
@ -54,7 +53,6 @@ class CreateAlbumPage extends HookConsumerWidget {
AlbumAssetSelectionRoute(
existingAssets: selectedAssets.value,
canDeselect: true,
query: getRemoteAssetQuery(ref),
),
);
if (selectedAsset == null) {

View file

@ -3,16 +3,13 @@ import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/domain/models/store.model.dart';
import 'package:immich_mobile/entities/asset.entity.dart';
import 'package:immich_mobile/entities/store.entity.dart';
import 'package:immich_mobile/providers/db.provider.dart';
import 'package:immich_mobile/providers/memory.provider.dart';
import 'package:immich_mobile/providers/user.provider.dart';
import 'package:immich_mobile/services/album.service.dart';
import 'package:immich_mobile/services/asset.service.dart';
import 'package:immich_mobile/services/etag.service.dart';
import 'package:immich_mobile/services/exif.service.dart';
import 'package:immich_mobile/services/sync.service.dart';
import 'package:immich_mobile/services/user.service.dart';
import 'package:isar/isar.dart';
import 'package:logging/logging.dart';
final assetProvider = StateNotifierProvider<AssetNotifier, bool>((ref) {
@ -184,20 +181,3 @@ final assetWatcher =
final assetService = ref.watch(assetServiceProvider);
return assetService.watchAsset(asset.id, fireImmediately: true);
});
QueryBuilder<Asset, Asset, QAfterSortBy>? getRemoteAssetQuery(WidgetRef ref) {
final userId = ref.watch(currentUserProvider)?.isarId;
if (userId == null) {
return null;
}
return ref
.watch(dbProvider)
.assets
.where()
.remoteIdIsNotNull()
.filter()
.ownerIdEqualTo(userId)
.isTrashedEqualTo(false)
.stackPrimaryAssetIdIsNull()
.sortByFileCreatedAtDesc();
}

View file

@ -1,32 +0,0 @@
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/widgets/asset_grid/asset_grid_data_structure.dart';
import 'package:immich_mobile/providers/app_settings.provider.dart';
import 'package:immich_mobile/services/app_settings.service.dart';
import 'package:immich_mobile/entities/asset.entity.dart';
import 'package:immich_mobile/utils/renderlist_generator.dart';
import 'package:isar/isar.dart';
final renderListProvider =
FutureProvider.family<RenderList, List<Asset>>((ref, assets) {
final settings = ref.watch(appSettingsServiceProvider);
return RenderList.fromAssets(
assets,
GroupAssetsBy.values[settings.getSetting(AppSettingsEnum.groupAssetsBy)],
);
});
final renderListProviderWithGrouping =
FutureProvider.family<RenderList, (List<Asset>, GroupAssetsBy?)>(
(ref, args) {
final settings = ref.watch(appSettingsServiceProvider);
final grouping = args.$2 ??
GroupAssetsBy.values[settings.getSetting(AppSettingsEnum.groupAssetsBy)];
return RenderList.fromAssets(args.$1, grouping);
});
final renderListQueryProvider = StreamProvider.family<RenderList,
QueryBuilder<Asset, Asset, QAfterSortBy>?>(
(ref, query) =>
query == null ? const Stream.empty() : renderListGenerator(query, ref),
);

View file

@ -6,7 +6,7 @@ part of 'db.provider.dart';
// RiverpodGenerator
// **************************************************************************
String _$isarHash() => r'69d3a06aa7e69a4381478e03f7956eb07d7f7feb';
String _$isarHash() => r'f0e886fa20e56dd1dc0082fcc723016289bd03cb';
/// See also [isar].
@ProviderFor(isar)

View file

@ -6,7 +6,7 @@ part of 'store.provider.dart';
// RiverpodGenerator
// **************************************************************************
String _$storeRepositoryHash() => r'9f378b96e552151fa14a8c8ce2c30a5f38f436ed';
String _$storeRepositoryHash() => r'2f1c3e2e2db5082a40eb30a183a6c770f5b09d76';
/// See also [storeRepository].
@ProviderFor(storeRepository)

View file

@ -1,13 +1,7 @@
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/entities/asset.entity.dart';
import 'package:immich_mobile/providers/db.provider.dart';
import 'package:isar/isar.dart';
import 'package:immich_mobile/services/asset.service.dart';
final allMotionPhotosProvider = FutureProvider<List<Asset>>((ref) async {
return ref
.watch(dbProvider)
.assets
.filter()
.livePhotoVideoIdIsNotNull()
.findAll();
return ref.watch(assetServiceProvider).getMotionAssets();
});

View file

@ -1,6 +1,6 @@
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/models/search/search_result.model.dart';
import 'package:immich_mobile/providers/asset_viewer/render_list.provider.dart';
import 'package:immich_mobile/services/timeline.service.dart';
import 'package:immich_mobile/widgets/asset_grid/asset_grid_data_structure.dart';
import 'package:immich_mobile/models/search/search_filter.model.dart';
import 'package:immich_mobile/services/search.service.dart';
@ -44,14 +44,13 @@ class PaginatedSearchNotifier extends StateNotifier<SearchResult> {
}
@riverpod
AsyncValue<RenderList> paginatedSearchRenderList(
Future<RenderList> paginatedSearchRenderList(
PaginatedSearchRenderListRef ref,
) {
final result = ref.watch(paginatedSearchProvider);
return ref.watch(
renderListProviderWithGrouping(
(result.assets, GroupAssetsBy.none),
),
final timelineService = ref.watch(timelineServiceProvider);
return timelineService.getTimelineFromAssets(
result.assets,
GroupAssetsBy.none,
);
}

View file

@ -7,12 +7,12 @@ part of 'paginated_search.provider.dart';
// **************************************************************************
String _$paginatedSearchRenderListHash() =>
r'4585c832106b16b6d294055f47bbbe83e0802846';
r'9efb98fd73d4e57e1ccd97a902cd459e3f18f749';
/// See also [paginatedSearchRenderList].
@ProviderFor(paginatedSearchRenderList)
final paginatedSearchRenderListProvider =
AutoDisposeProvider<AsyncValue<RenderList>>.internal(
AutoDisposeFutureProvider<RenderList>.internal(
paginatedSearchRenderList,
name: r'paginatedSearchRenderListProvider',
debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product')
@ -22,7 +22,6 @@ final paginatedSearchRenderListProvider =
allTransitiveDependencies: null,
);
typedef PaginatedSearchRenderListRef
= AutoDisposeProviderRef<AsyncValue<RenderList>>;
typedef PaginatedSearchRenderListRef = AutoDisposeFutureProviderRef<RenderList>;
// ignore_for_file: type=lint
// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member

View file

@ -1,18 +1,9 @@
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/entities/asset.entity.dart';
import 'package:immich_mobile/providers/db.provider.dart';
import 'package:immich_mobile/providers/user.provider.dart';
import 'package:isar/isar.dart';
import 'package:immich_mobile/services/asset.service.dart';
final recentlyAddedAssetProvider = FutureProvider<List<Asset>>((ref) async {
final user = ref.read(currentUserProvider);
if (user == null) return [];
final assetService = ref.read(assetServiceProvider);
return ref
.watch(dbProvider)
.assets
.where()
.ownerIdEqualToAnyChecksum(user.isarId)
.sortByFileCreatedAtDesc()
.findAll();
return assetService.getRecentlyAddedAssets();
});

View file

@ -1,4 +1,5 @@
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/entities/asset.entity.dart';
import 'package:immich_mobile/providers/album/album.provider.dart';
import 'package:immich_mobile/providers/locale_provider.dart';
import 'package:immich_mobile/services/timeline.service.dart';
@ -53,3 +54,17 @@ final allVideosTimelineProvider = StreamProvider<RenderList>((ref) {
final timelineService = ref.watch(timelineServiceProvider);
return timelineService.watchAllVideosTimeline();
});
final assetSelectionTimelineProvider = StreamProvider<RenderList>((ref) {
final timelineService = ref.watch(timelineServiceProvider);
return timelineService.watchAssetSelectionTimeline();
});
final assetsTimelineProvider =
FutureProvider.family<RenderList, List<Asset>>((ref, assets) {
final timelineService = ref.watch(timelineServiceProvider);
return timelineService.getTimelineFromAssets(
assets,
null,
);
});

View file

@ -233,6 +233,25 @@ class AssetRepository extends DatabaseRepository implements IAssetRepository {
.isTrashedEqualTo(true)
.findAll();
}
@override
Future<List<Asset>> getRecentlyAddedAssets(int userId) {
return db.assets
.where()
.ownerIdEqualToAnyChecksum(userId)
.sortByFileCreatedAtDesc()
.findAll();
}
@override
Future<List<Asset>> getMotionAssets(int userId) {
return db.assets
.where()
.ownerIdEqualToAnyChecksum(userId)
.filter()
.livePhotoVideoIdIsNotNull()
.findAll();
}
}
Future<List<Asset>> _getMatchesImpl(

View file

@ -111,6 +111,28 @@ class TimelineRepository extends DatabaseRepository
return _watchRenderList(query, groupAssetByOption);
}
@override
Future<RenderList> getTimelineFromAssets(
List<Asset> assets,
GroupAssetsBy getGroupByOption,
) {
return RenderList.fromAssets(assets, getGroupByOption);
}
@override
Stream<RenderList> watchAssetSelectionTimeline(int userId) {
final query = db.assets
.where()
.remoteIdIsNotNull()
.filter()
.ownerIdEqualTo(userId)
.isTrashedEqualTo(false)
.stackPrimaryAssetIdIsNull()
.sortByFileCreatedAtDesc();
return _watchRenderList(query, GroupAssetsBy.none);
}
Stream<RenderList> _watchRenderList(
QueryBuilder<Asset, Asset, QAfterSortBy> query,
GroupAssetsBy groupAssetsBy,

View file

@ -67,7 +67,6 @@ import 'package:immich_mobile/routing/custom_transition_builders.dart';
import 'package:immich_mobile/routing/duplicate_guard.dart';
import 'package:immich_mobile/services/api.service.dart';
import 'package:immich_mobile/widgets/asset_grid/asset_grid_data_structure.dart';
import 'package:isar/isar.dart';
import 'package:maplibre_gl/maplibre_gl.dart';
part 'router.gr.dart';

View file

@ -83,7 +83,6 @@ class AlbumAssetSelectionRoute
Key? key,
required Set<Asset> existingAssets,
bool canDeselect = false,
required QueryBuilder<Asset, Asset, QAfterSortBy>? query,
List<PageRouteInfo>? children,
}) : super(
AlbumAssetSelectionRoute.name,
@ -91,7 +90,6 @@ class AlbumAssetSelectionRoute
key: key,
existingAssets: existingAssets,
canDeselect: canDeselect,
query: query,
),
initialChildren: children,
);
@ -106,7 +104,6 @@ class AlbumAssetSelectionRoute
key: args.key,
existingAssets: args.existingAssets,
canDeselect: args.canDeselect,
query: args.query,
);
},
);
@ -117,7 +114,6 @@ class AlbumAssetSelectionRouteArgs {
this.key,
required this.existingAssets,
this.canDeselect = false,
required this.query,
});
final Key? key;
@ -126,11 +122,9 @@ class AlbumAssetSelectionRouteArgs {
final bool canDeselect;
final QueryBuilder<Asset, Asset, QAfterSortBy>? query;
@override
String toString() {
return 'AlbumAssetSelectionRouteArgs{key: $key, existingAssets: $existingAssets, canDeselect: $canDeselect, query: $query}';
return 'AlbumAssetSelectionRouteArgs{key: $key, existingAssets: $existingAssets, canDeselect: $canDeselect}';
}
}

View file

@ -514,4 +514,14 @@ class AssetService {
Stream<Asset?> watchAsset(int id, {bool fireImmediately = false}) {
return _assetRepository.watchAsset(id, fireImmediately: fireImmediately);
}
Future<List<Asset>> getRecentlyAddedAssets() async {
final me = await _userRepository.me();
return _assetRepository.getRecentlyAddedAssets(me.isarId);
}
Future<List<Asset>> getMotionAssets() async {
final me = await _userRepository.me();
return _assetRepository.getMotionAssets(me.isarId);
}
}

View file

@ -1,5 +1,6 @@
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/entities/album.entity.dart';
import 'package:immich_mobile/entities/asset.entity.dart';
import 'package:immich_mobile/interfaces/timeline.interface.dart';
import 'package:immich_mobile/interfaces/user.interface.dart';
import 'package:immich_mobile/providers/app_settings.provider.dart';
@ -66,6 +67,29 @@ class TimelineService {
return _timelineRepository.watchAllVideosTimeline();
}
Future<RenderList> getTimelineFromAssets(
List<Asset> assets,
GroupAssetsBy? groupBy,
) {
GroupAssetsBy groupOption = GroupAssetsBy.none;
if (groupBy != null) {
groupOption = groupBy;
} else {
groupOption = _getGroupByOption();
}
return _timelineRepository.getTimelineFromAssets(
assets,
groupOption,
);
}
Stream<RenderList> watchAssetSelectionTimeline() async* {
final user = await _userRepository.me();
yield* _timelineRepository.watchAssetSelectionTimeline(user.isarId);
}
GroupAssetsBy _getGroupByOption() {
return GroupAssetsBy
.values[_appSettingsService.getSetting(AppSettingsEnum.groupAssetsBy)];

View file

@ -1,26 +0,0 @@
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/widgets/asset_grid/asset_grid_data_structure.dart';
import 'package:immich_mobile/providers/app_settings.provider.dart';
import 'package:immich_mobile/services/app_settings.service.dart';
import 'package:immich_mobile/entities/asset.entity.dart';
import 'package:isar/isar.dart';
Stream<RenderList> renderListGenerator(
QueryBuilder<Asset, Asset, QAfterSortBy> query,
StreamProviderRef<RenderList> ref,
) {
final settings = ref.watch(appSettingsServiceProvider);
final groupBy =
GroupAssetsBy.values[settings.getSetting(AppSettingsEnum.groupAssetsBy)];
return renderListGeneratorWithGroupBy(query, groupBy);
}
Stream<RenderList> renderListGeneratorWithGroupBy(
QueryBuilder<Asset, Asset, QAfterSortBy> query,
GroupAssetsBy groupBy,
) async* {
yield await RenderList.fromQuery(query, groupBy);
await for (final _ in query.watchLazy()) {
yield await RenderList.fromQuery(query, groupBy);
}
}

View file

@ -6,7 +6,7 @@ import 'package:flutter/material.dart';
import 'package:flutter_hooks/flutter_hooks.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/extensions/asyncvalue_extensions.dart';
import 'package:immich_mobile/providers/asset_viewer/render_list.provider.dart';
import 'package:immich_mobile/providers/timeline.provider.dart';
import 'package:immich_mobile/widgets/asset_grid/asset_grid_data_structure.dart';
import 'package:immich_mobile/widgets/asset_grid/immich_asset_grid_view.dart';
import 'package:immich_mobile/providers/app_settings.provider.dart';
@ -125,7 +125,7 @@ class ImmichAssetGrid extends HookConsumerWidget {
if (renderList != null) return buildAssetGridView(renderList!);
final renderListFuture = ref.watch(renderListProvider(assets!));
final renderListFuture = ref.watch(assetsTimelineProvider(assets!));
return renderListFuture.widgetWhen(
onData: (renderList) => buildAssetGridView(renderList),
);

View file

@ -6,7 +6,7 @@ import 'package:flutter_hooks/flutter_hooks.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/extensions/build_context_extensions.dart';
import 'package:immich_mobile/extensions/collection_extensions.dart';
import 'package:immich_mobile/providers/asset_viewer/render_list.provider.dart';
import 'package:immich_mobile/providers/timeline.provider.dart';
import 'package:immich_mobile/widgets/asset_grid/asset_grid_data_structure.dart';
import 'package:immich_mobile/widgets/asset_grid/immich_asset_grid.dart';
import 'package:immich_mobile/models/map/map_event.model.dart';
@ -126,7 +126,9 @@ class MapAssetGrid extends HookConsumerWidget {
// Place it just below the drag handle
heightFactor: 0.80,
child: assetsInBounds.value.isNotEmpty
? ref.watch(renderListProvider(assetsInBounds.value)).when(
? ref
.watch(assetsTimelineProvider(assetsInBounds.value))
.when(
data: (renderList) {
// Cache render list here to use it back during visibleItemsListener
cachedRenderList.value = renderList;

View file

@ -11,8 +11,6 @@ import 'package:immich_mobile/pages/search/search.page.dart';
import 'package:immich_mobile/providers/api.provider.dart';
import 'package:immich_mobile/providers/db.provider.dart';
import 'package:immich_mobile/providers/infrastructure/db.provider.dart';
import 'package:immich_mobile/providers/search/paginated_search.provider.dart';
import 'package:immich_mobile/widgets/asset_grid/asset_grid_data_structure.dart';
import 'package:isar/isar.dart';
import 'package:mocktail/mocktail.dart';
import 'package:openapi/api.dart';
@ -38,8 +36,6 @@ void main() {
registerFallbackValue(MockSmartSearchDto());
registerFallbackValue(MockMetadataSearchDto());
overrides = [
paginatedSearchRenderListProvider
.overrideWithValue(AsyncValue.data(RenderList.empty())),
dbProvider.overrideWithValue(db),
isarProvider.overrideWithValue(db),
apiServiceProvider.overrideWithValue(mockApiService),