Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(mobile): DB repository for asset, backup, sync service #12953

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions mobile/analysis_options.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -64,19 +64,19 @@ custom_lint:
allowed:
# required / wanted
- lib/entities/*.entity.dart
- lib/repositories/{album,asset,backup,exif_info,user}.repository.dart
# acceptable exceptions for the time being
- lib/repositories/{album,asset,backup,etag,exif_info,user}.repository.dart
# acceptable exceptions for the time being (until Isar is fully replaced)
- integration_test/test_utils/general_helper.dart
- lib/main.dart
- lib/pages/common/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/widgets/asset_grid/asset_grid_data_structure.dart
- test/**.dart
# refactor to make the providers and services testable
- lib/pages/common/album_asset_selection.page.dart
# refactor the remaining providers
- lib/providers/{archive,asset,authentication,db,favorite,partner,trash,user}.provider.dart
- lib/providers/{album/album,album/shared_album,asset_viewer/asset_stack,asset_viewer/render_list,backup/backup,backup/manual_upload,search/all_motion_photos,search/recently_added_asset}.provider.dart
- lib/services/{asset,background,backup,immich_logger,sync}.service.dart
- lib/widgets/asset_grid/asset_grid_data_structure.dart
- lib/providers/{album/album,album/shared_album,asset_viewer/asset_stack,asset_viewer/render_list,backup/backup,search/all_motion_photos,search/recently_added_asset}.provider.dart

- import_rule_openapi:
message: openapi must only be used through ApiRepositories
Expand Down
27 changes: 24 additions & 3 deletions mobile/lib/interfaces/album.interface.dart
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,40 @@ import 'package:immich_mobile/entities/asset.entity.dart';
import 'package:immich_mobile/entities/user.entity.dart';

abstract interface class IAlbumRepository {
Future<int> count({bool? local});
Future<Album> create(Album album);
Future<Album?> getById(int id);

Future<Album?> get(int id);

Future<Album?> getByName(
String name, {
bool? shared,
bool? remote,
});

Future<List<Album>> getAll({
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the upcoming layout, I will need to get all albums, both shared and owned. Can it be done with this interface in a single invocation?

bool? shared,
bool? remote,
int? ownerId,
AlbumSort? sortBy,
});

Future<Album> update(Album album);

Future<void> delete(int albumId);
Future<List<Album>> getAll({bool? shared});

Future<void> deleteAllLocal();

Future<int> count({bool? local});

Future<void> addUsers(Album album, List<User> users);

Future<void> removeUsers(Album album, List<User> users);

Future<void> addAssets(Album album, List<Asset> assets);

Future<void> removeAssets(Album album, List<Asset> assets);

Future<Album> recalculateMetadata(Album album);
}

enum AlbumSort { remoteId, localId }
48 changes: 41 additions & 7 deletions mobile/lib/interfaces/asset.interface.dart
Original file line number Diff line number Diff line change
@@ -1,27 +1,61 @@
import 'package:immich_mobile/entities/album.entity.dart';
import 'package:immich_mobile/entities/asset.entity.dart';
import 'package:immich_mobile/entities/device_asset.entity.dart';
import 'package:immich_mobile/entities/user.entity.dart';

abstract interface class IAssetRepository {
Future<Asset?> getByRemoteId(String id);
Future<List<Asset>> getAllByRemoteId(Iterable<String> ids);
Future<List<Asset>> getByAlbum(Album album, {User? notOwnedBy});
Future<void> deleteById(List<int> ids);

Future<Asset?> getByOwnerIdChecksum(int ownerId, String checksum);

Future<List<Asset>> getAllByRemoteId(
Iterable<String> ids, {
AssetState? state,
});

Future<List<Asset?>> getAllByOwnerIdChecksum(
List<int> ids,
List<String> checksums,
);

Future<List<Asset>> getAll({
required int ownerId,
bool? remote,
int limit = 100,
AssetState? state,
AssetSort? sortBy,
int? limit,
});

Future<List<Asset>> getAllLocal();

Future<List<Asset>> getByAlbum(
Album album, {
Iterable<int> notOwnedBy = const [],
int? ownerId,
AssetState? state,
AssetSort? sortBy,
});

Future<Asset> update(Asset asset);

Future<List<Asset>> updateAll(List<Asset> assets);

Future<void> deleteAllByRemoteId(List<String> ids, {AssetState? state});

Future<void> deleteById(List<int> ids);

Future<List<Asset>> getMatches({
required List<Asset> assets,
required int ownerId,
bool? remote,
AssetState? state,
int limit = 100,
});

Future<List<DeviceAsset?>> getDeviceAssetsById(List<Object> ids);

Future<void> upsertDeviceAssets(List<DeviceAsset> deviceAssets);

Future<void> upsertDuplicatedAssets(Iterable<String> duplicatedAssets);

Future<List<String>> getAllDuplicatedAssetIds();
}

enum AssetSort { checksum, ownerIdChecksum }
10 changes: 10 additions & 0 deletions mobile/lib/interfaces/backup.interface.dart
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
import 'package:immich_mobile/entities/backup_album.entity.dart';

abstract interface class IBackupRepository {
Future<List<BackupAlbum>> getAll({BackupAlbumSort? sort});

Future<List<String>> getIdsBySelection(BackupSelection backup);

Future<List<BackupAlbum>> getAllBySelection(BackupSelection backup);

Future<void> updateAll(List<BackupAlbum> backupAlbums);

Future<void> deleteAll(List<int> ids);
}

enum BackupAlbumSort { id }
13 changes: 13 additions & 0 deletions mobile/lib/interfaces/etag.interface.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import 'package:immich_mobile/entities/etag.entity.dart';

abstract interface class IETagRepository {
Future<ETag?> get(int id);

Future<ETag?> getById(String id);

Future<List<String>> getAllIds();

Future<void> upsertAll(List<ETag> etags);

Future<void> deleteByIds(List<String> ids);
}
2 changes: 2 additions & 0 deletions mobile/lib/interfaces/exif_info.interface.dart
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,7 @@ abstract interface class IExifInfoRepository {

Future<ExifInfo> update(ExifInfo exifInfo);

Future<List<ExifInfo>> updateAll(List<ExifInfo> exifInfos);

Future<void> delete(int id);
}
18 changes: 16 additions & 2 deletions mobile/lib/interfaces/user.interface.dart
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
import 'package:immich_mobile/entities/user.entity.dart';

abstract interface class IUserRepository {
Future<List<User>> getByIds(List<String> ids);
Future<User?> get(String id);
Future<List<User>> getAll({bool self = true});

Future<List<User>> getByIds(List<String> ids);

Future<List<User>> getAll({bool self = true, UserSort? sort});

/// Returns all users whose assets can be accessed (self+partners)
Future<List<User>> getAllAccessible();

Future<List<User>> upsertAll(List<User> users);

Future<User> update(User user);

Future<void> deleteById(List<int> ids);

Future<User> me();
}

enum UserSort { id }
22 changes: 4 additions & 18 deletions mobile/lib/providers/asset.provider.dart
Original file line number Diff line number Diff line change
Expand Up @@ -275,28 +275,14 @@ class AssetNotifier extends StateNotifier<bool> {
return isSuccess ? remote.toList() : [];
}

Future<void> toggleFavorite(List<Asset> assets, [bool? status]) async {
Future<void> toggleFavorite(List<Asset> assets, [bool? status]) {
status ??= !assets.every((a) => a.isFavorite);
final newAssets = await _assetService.changeFavoriteStatus(assets, status);
for (Asset? newAsset in newAssets) {
if (newAsset == null) {
log.severe("Change favorite status failed for asset");
continue;
}
}
return _assetService.changeFavoriteStatus(assets, status);
}

Future<void> toggleArchive(List<Asset> assets, [bool? status]) async {
Future<void> toggleArchive(List<Asset> assets, [bool? status]) {
status ??= !assets.every((a) => a.isArchived);
final newAssets = await _assetService.changeArchiveStatus(assets, status);
int i = 0;
for (Asset oldAsset in assets) {
final newAsset = newAssets[i++];
if (newAsset == null) {
log.severe("Change archive status failed for asset ${oldAsset.id}");
continue;
}
}
return _assetService.changeArchiveStatus(assets, status);
}
}

Expand Down
9 changes: 7 additions & 2 deletions mobile/lib/providers/backup/backup.provider.dart
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import 'package:flutter/widgets.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/entities/album.entity.dart';
import 'package:immich_mobile/interfaces/album_media.interface.dart';
import 'package:immich_mobile/interfaces/backup.interface.dart';
import 'package:immich_mobile/interfaces/file_media.interface.dart';
import 'package:immich_mobile/models/backup/available_album.model.dart';
import 'package:immich_mobile/entities/backup_album.entity.dart';
Expand All @@ -17,6 +18,7 @@ import 'package:immich_mobile/models/backup/error_upload_asset.model.dart';
import 'package:immich_mobile/models/backup/success_upload_asset.model.dart';
import 'package:immich_mobile/providers/backup/error_backup_list.provider.dart';
import 'package:immich_mobile/repositories/album_media.repository.dart';
import 'package:immich_mobile/repositories/backup.repository.dart';
import 'package:immich_mobile/repositories/file_media.repository.dart';
import 'package:immich_mobile/services/background.service.dart';
import 'package:immich_mobile/services/backup.service.dart';
Expand Down Expand Up @@ -45,6 +47,7 @@ class BackupNotifier extends StateNotifier<BackUpState> {
this._db,
this._albumMediaRepository,
this._fileMediaRepository,
this._backupRepository,
this.ref,
) : super(
BackUpState(
Expand Down Expand Up @@ -95,6 +98,7 @@ class BackupNotifier extends StateNotifier<BackUpState> {
final Isar _db;
final IAlbumMediaRepository _albumMediaRepository;
final IFileMediaRepository _fileMediaRepository;
final IBackupRepository _backupRepository;
final Ref ref;

///
Expand Down Expand Up @@ -255,9 +259,9 @@ class BackupNotifier extends StateNotifier<BackUpState> {
state = state.copyWith(availableAlbums: availableAlbums);

final List<BackupAlbum> excludedBackupAlbums =
await _backupService.excludedAlbumsQuery().findAll();
await _backupRepository.getAllBySelection(BackupSelection.exclude);
final List<BackupAlbum> selectedBackupAlbums =
await _backupService.selectedAlbumsQuery().findAll();
await _backupRepository.getAllBySelection(BackupSelection.select);

final Set<AvailableAlbum> selectedAlbums = {};
for (final BackupAlbum ba in selectedBackupAlbums) {
Expand Down Expand Up @@ -767,6 +771,7 @@ final backupProvider =
ref.watch(dbProvider),
ref.watch(albumMediaRepositoryProvider),
ref.watch(fileMediaRepositoryProvider),
ref.watch(backupRepositoryProvider),
ref,
);
});
10 changes: 7 additions & 3 deletions mobile/lib/providers/backup/manual_upload.provider.dart
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ import 'package:easy_localization/easy_localization.dart';
import 'package:flutter/widgets.dart';
import 'package:fluttertoast/fluttertoast.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/entities/backup_album.entity.dart';
import 'package:immich_mobile/models/backup/backup_candidate.model.dart';
import 'package:immich_mobile/models/backup/success_upload_asset.model.dart';
import 'package:immich_mobile/repositories/backup.repository.dart';
import 'package:immich_mobile/repositories/file_media.repository.dart';
import 'package:immich_mobile/services/background.service.dart';
import 'package:immich_mobile/models/backup/backup_state.model.dart';
Expand All @@ -25,7 +27,6 @@ import 'package:immich_mobile/providers/app_life_cycle.provider.dart';
import 'package:immich_mobile/services/local_notification.service.dart';
import 'package:immich_mobile/widgets/common/immich_toast.dart';
import 'package:immich_mobile/utils/backup_progress.dart';
import 'package:isar/isar.dart';
import 'package:logging/logging.dart';
import 'package:permission_handler/permission_handler.dart';
import 'package:photo_manager/photo_manager.dart' show PMProgressHandler;
Expand All @@ -36,6 +37,7 @@ final manualUploadProvider =
ref.watch(localNotificationService),
ref.watch(backupProvider.notifier),
ref.watch(backupServiceProvider),
ref.watch(backupRepositoryProvider),
ref,
);
});
Expand All @@ -45,12 +47,14 @@ class ManualUploadNotifier extends StateNotifier<ManualUploadState> {
final LocalNotificationService _localNotificationService;
final BackupNotifier _backupProvider;
final BackupService _backupService;
final BackupRepository _backupRepository;
final Ref ref;

ManualUploadNotifier(
this._localNotificationService,
this._backupProvider,
this._backupService,
this._backupRepository,
this.ref,
) : super(
ManualUploadState(
Expand Down Expand Up @@ -206,9 +210,9 @@ class ManualUploadNotifier extends StateNotifier<ManualUploadState> {
}

final selectedBackupAlbums =
_backupService.selectedAlbumsQuery().findAllSync();
await _backupRepository.getAllBySelection(BackupSelection.select);
final excludedBackupAlbums =
_backupService.excludedAlbumsQuery().findAllSync();
await _backupRepository.getAllBySelection(BackupSelection.exclude);

// Get candidates from selected albums and excluded albums
Set<BackupCandidate> candidates =
Expand Down
4 changes: 2 additions & 2 deletions mobile/lib/repositories/activity_api.repository.dart
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ import 'package:immich_mobile/entities/user.entity.dart';
import 'package:immich_mobile/interfaces/activity_api.interface.dart';
import 'package:immich_mobile/models/activities/activity.model.dart';
import 'package:immich_mobile/providers/api.provider.dart';
import 'package:immich_mobile/repositories/base_api.repository.dart';
import 'package:immich_mobile/repositories/apibase.repository.dart';
import 'package:openapi/api.dart';

final activityApiRepositoryProvider = Provider(
(ref) => ActivityApiRepository(ref.watch(apiServiceProvider).activitiesApi),
);

class ActivityApiRepository extends BaseApiRepository
class ActivityApiRepository extends ApiBaseRepository
implements IActivityApiRepository {
final ActivitiesApi _api;

Expand Down
Loading
Loading