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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃毀 feat(Mobile): Use client side hash to check if asset exists in remote before backup #9306

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 29 additions & 0 deletions mobile/lib/providers/backup/backup.provider.dart
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import 'package:cancellation_token_http/http.dart';
import 'package:collection/collection.dart';
import 'package:flutter/widgets.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/entities/asset.entity.dart';
import 'package:immich_mobile/models/backup/available_album.model.dart';
import 'package:immich_mobile/entities/backup_album.entity.dart';
import 'package:immich_mobile/models/backup/backup_state.model.dart';
Expand All @@ -19,11 +20,13 @@ import 'package:immich_mobile/models/server_info/server_disk_info.model.dart';
import 'package:immich_mobile/entities/store.entity.dart';
import 'package:immich_mobile/providers/app_life_cycle.provider.dart';
import 'package:immich_mobile/providers/db.provider.dart';
import 'package:immich_mobile/services/hash.service.dart';
import 'package:immich_mobile/services/server_info.service.dart';
import 'package:immich_mobile/utils/backup_progress.dart';
import 'package:immich_mobile/utils/diff.dart';
import 'package:isar/isar.dart';
import 'package:logging/logging.dart';
import 'package:openapi/api.dart';
import 'package:permission_handler/permission_handler.dart';
import 'package:photo_manager/photo_manager.dart';

Expand Down Expand Up @@ -286,12 +289,15 @@ class BackupNotifier extends StateNotifier<BackUpState> {
///
/// From all the selected and albums assets
/// Find the assets that are not overlapping between the two sets
/// Remove assets which are already present in remote server using SHA-1 checksum.
/// Those assets are unique and are used as the total assets
///
Future<void> _updateBackupAssetCount() async {
final duplicatedAssetIds = await _backupService.getDuplicatedAssetIds();
final Set<AssetEntity> assetsFromSelectedAlbums = {};
final Set<AssetEntity> assetsFromExcludedAlbums = {};
final Set<Asset> hashedSelectedAssets = {};
final hashService = HashService(_db, _backgroundService);

for (final album in state.selectedBackupAlbums) {
final assetCount = await album.albumEntity.assetCountAsync;
Expand All @@ -307,6 +313,7 @@ class BackupNotifier extends StateNotifier<BackUpState> {
assetsFromSelectedAlbums.addAll(assets);
}

// Extract all excluded assets
for (final album in state.excludedBackupAlbums) {
final assetCount = await album.albumEntity.assetCountAsync;

Expand All @@ -321,6 +328,28 @@ class BackupNotifier extends StateNotifier<BackUpState> {
assetsFromExcludedAlbums.addAll(assets);
}

// Hash all album assets, excluding assets in `assetsFromExcludedAlbums`
for (final album in state.selectedBackupAlbums) {
final result = await hashService.getHashedAssets(album.albumEntity,
excludedAssets:
assetsFromExcludedAlbums.toList().map((e) => e.id).toSet());
hashedSelectedAssets.addAll(result);
}

if (hashedSelectedAssets.isNotEmpty) {
final assetHashCheckResponse =
await _backupService.bulkUploadCheckRequest(hashedSelectedAssets);

if (assetHashCheckResponse?.results != null) {
final rejectedAssetIds = assetHashCheckResponse!.results
.where(
(e) => e.action == AssetBulkUploadCheckResultActionEnum.reject)
.map((e) => e.id);
assetsFromSelectedAlbums
.removeWhere((e) => rejectedAssetIds.contains(e.id));
}
}

final Set<AssetEntity> allUniqueAssets =
assetsFromSelectedAlbums.difference(assetsFromExcludedAlbums);
final allAssetsInDatabase = await _backupService.getDeviceBackupAsset();
Expand Down
19 changes: 19 additions & 0 deletions mobile/lib/services/backup.service.dart
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import 'dart:io';
import 'package:collection/collection.dart';
import 'package:flutter/material.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/entities/asset.entity.dart'
as immich_asset_entity;
import 'package:immich_mobile/entities/backup_album.entity.dart';
import 'package:immich_mobile/models/backup/current_upload_asset.model.dart';
import 'package:immich_mobile/entities/duplicated_asset.entity.dart';
Expand Down Expand Up @@ -51,6 +53,23 @@ class BackupService {
}
}

Future<AssetBulkUploadCheckResponseDto?> bulkUploadCheckRequest(
Set<immich_asset_entity.Asset> assets) async {
try {
final assetList = assets.toList();
final bulkUploadCheckRequest = assetList
.map((e) => AssetBulkUploadCheckItem(
checksum: e.checksum,
id: e.localId != null ? e.localId! : e.id.toString()))

Choose a reason for hiding this comment

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

Suggested change
id: e.localId != null ? e.localId! : e.id.toString()))
id: e.localId ?? e.id.toString()))

.toList();
return await _apiService.assetApi.checkBulkUpload(
AssetBulkUploadCheckDto(assets: bulkUploadCheckRequest));
} catch (e) {
debugPrint('Error [bulkUploadCheckRequest] ${e.toString()}');
return null;
}
}

Future<void> _saveDuplicatedAssetIds(List<String> deviceAssetIds) {
final duplicates = deviceAssetIds.map((id) => DuplicatedAsset(id)).toList();
return _db.writeTxn(() => _db.duplicatedAssets.putAll(duplicates));
Expand Down