feat: album info sync (#21103)

* wip

* album creation

* fix: album api repository no invalidating after logging out

* add linkedRemoteAlbumId column and migration

* link/unlink remote album

* logic to find and add new assets to album

* pr feedback

* add toggle option to backup option page

* refactor: provider > service

* rename

* Handle page pop manually

* UI feedback for user creation and sync linked album

* uncomment migration

* remove unused method

mobile/lib/domain/models/album/local_album.model.dart

@@ -15,6 +15,7 @@ class LocalAlbum {
 
   final int assetCount;
   final BackupSelection backupSelection;
+  final String? linkedRemoteAlbumId;
 
   const LocalAlbum({
     required this.id,
@@ -23,6 +24,7 @@ class LocalAlbum {
     this.assetCount = 0,
     this.backupSelection = BackupSelection.none,
     this.isIosSharedAlbum = false,
+    this.linkedRemoteAlbumId,
   });
 
   LocalAlbum copyWith({
@@ -32,6 +34,7 @@ class LocalAlbum {
     int? assetCount,
     BackupSelection? backupSelection,
     bool? isIosSharedAlbum,
+    String? linkedRemoteAlbumId,
   }) {
     return LocalAlbum(
       id: id ?? this.id,
@@ -40,6 +43,7 @@ class LocalAlbum {
       assetCount: assetCount ?? this.assetCount,
       backupSelection: backupSelection ?? this.backupSelection,
       isIosSharedAlbum: isIosSharedAlbum ?? this.isIosSharedAlbum,
+      linkedRemoteAlbumId: linkedRemoteAlbumId ?? this.linkedRemoteAlbumId,
     );
   }
 
@@ -53,7 +57,8 @@ class LocalAlbum {
         other.updatedAt == updatedAt &&
         other.assetCount == assetCount &&
         other.backupSelection == backupSelection &&
-        other.isIosSharedAlbum == isIosSharedAlbum;
+        other.isIosSharedAlbum == isIosSharedAlbum &&
+        other.linkedRemoteAlbumId == linkedRemoteAlbumId;
   }
 
   @override
@@ -63,7 +68,8 @@ class LocalAlbum {
         updatedAt.hashCode ^
         assetCount.hashCode ^
         backupSelection.hashCode ^
-        isIosSharedAlbum.hashCode;
+        isIosSharedAlbum.hashCode ^
+        linkedRemoteAlbumId.hashCode;
   }
 
   @override
@@ -75,6 +81,7 @@ updatedAt: $updatedAt,
 assetCount: $assetCount,
 backupSelection: $backupSelection,
 isIosSharedAlbum: $isIosSharedAlbum
+linkedRemoteAlbumId: $linkedRemoteAlbumId,
 }''';
   }
 }

mobile/lib/domain/services/local_album.service.dart

@@ -22,4 +22,16 @@ class LocalAlbumService {
   Future<int> getCount() {
     return _repository.getCount();
   }
+
+  Future<void> unlinkRemoteAlbum(String id) async {
+    return _repository.unlinkRemoteAlbum(id);
+  }
+
+  Future<void> linkRemoteAlbum(String localAlbumId, String remoteAlbumId) async {
+    return _repository.linkRemoteAlbum(localAlbumId, remoteAlbumId);
+  }
+
+  Future<List<LocalAlbum>> getBackupAlbums() {
+    return _repository.getBackupAlbums();
+  }
 }

mobile/lib/domain/services/remote_album.service.dart

@@ -26,6 +26,10 @@ class RemoteAlbumService {
     return _repository.get(albumId);
   }
 
+  Future<RemoteAlbum?> getByName(String albumName, String ownerId) {
+    return _repository.getByName(albumName, ownerId);
+  }
+
   Future<List<RemoteAlbum>> sortAlbums(
     List<RemoteAlbum> albums,
     RemoteAlbumSortMode sortMode, {
@@ -80,7 +84,6 @@ class RemoteAlbumService {
 
   Future<RemoteAlbum> createAlbum({required String title, required List<String> assetIds, String? description}) async {
     final album = await _albumApiRepository.createDriftAlbum(title, description: description, assetIds: assetIds);
-
     await _repository.create(album, assetIds);
 
     return album;

mobile/lib/domain/services/sync_linked_album.service.dart

@@ -0,0 +1,101 @@
+import 'package:flutter/material.dart';
+import 'package:hooks_riverpod/hooks_riverpod.dart';
+import 'package:immich_mobile/domain/models/album/local_album.model.dart';
+import 'package:immich_mobile/infrastructure/repositories/local_album.repository.dart';
+import 'package:immich_mobile/infrastructure/repositories/remote_album.repository.dart';
+import 'package:immich_mobile/providers/infrastructure/album.provider.dart';
+import 'package:immich_mobile/repositories/drift_album_api_repository.dart';
+
+final syncLinkedAlbumServiceProvider = Provider(
+  (ref) => SyncLinkedAlbumService(
+    ref.watch(localAlbumRepository),
+    ref.watch(remoteAlbumRepository),
+    ref.watch(driftAlbumApiRepositoryProvider),
+  ),
+);
+
+class SyncLinkedAlbumService {
+  final DriftLocalAlbumRepository _localAlbumRepository;
+  final DriftRemoteAlbumRepository _remoteAlbumRepository;
+  final DriftAlbumApiRepository _albumApiRepository;
+
+  const SyncLinkedAlbumService(this._localAlbumRepository, this._remoteAlbumRepository, this._albumApiRepository);
+
+  Future<void> syncLinkedAlbums(String userId) async {
+    final selectedAlbums = await _localAlbumRepository.getBackupAlbums();
+
+    await Future.wait(
+      selectedAlbums.map((localAlbum) async {
+        final linkedRemoteAlbumId = localAlbum.linkedRemoteAlbumId;
+        if (linkedRemoteAlbumId == null) {
+          return;
+        }
+
+        final remoteAlbum = await _remoteAlbumRepository.get(linkedRemoteAlbumId);
+        if (remoteAlbum == null) {
+          return;
+        }
+
+        // get assets that are uploaded but not in the remote album
+        final assetIds = await _remoteAlbumRepository.getLinkedAssetIds(userId, localAlbum.id, linkedRemoteAlbumId);
+
+        if (assetIds.isNotEmpty) {
+          final album = await _albumApiRepository.addAssets(remoteAlbum.id, assetIds);
+          await _remoteAlbumRepository.addAssets(remoteAlbum.id, album.added);
+        }
+      }),
+    );
+  }
+
+  Future<void> manageLinkedAlbums(List<LocalAlbum> localAlbums, String ownerId) async {
+    for (final album in localAlbums) {
+      await _processLocalAlbum(album, ownerId);
+    }
+  }
+
+  /// Processes a single local album to ensure proper linking with remote albums
+  Future<void> _processLocalAlbum(LocalAlbum localAlbum, String ownerId) {
+    final hasLinkedRemoteAlbum = localAlbum.linkedRemoteAlbumId != null;
+
+    if (hasLinkedRemoteAlbum) {
+      return _handleLinkedAlbum(localAlbum);
+    } else {
+      return _handleUnlinkedAlbum(localAlbum, ownerId);
+    }
+  }
+
+  /// Handles albums that are already linked to a remote album
+  Future<void> _handleLinkedAlbum(LocalAlbum localAlbum) async {
+    final remoteAlbumId = localAlbum.linkedRemoteAlbumId!;
+    final remoteAlbum = await _remoteAlbumRepository.get(remoteAlbumId);
+
+    final remoteAlbumExists = remoteAlbum != null;
+    if (!remoteAlbumExists) {
+      return _localAlbumRepository.unlinkRemoteAlbum(localAlbum.id);
+    }
+  }
+
+  /// Handles albums that are not linked to any remote album
+  Future<void> _handleUnlinkedAlbum(LocalAlbum localAlbum, String ownerId) async {
+    final existingRemoteAlbum = await _remoteAlbumRepository.getByName(localAlbum.name, ownerId);
+
+    if (existingRemoteAlbum != null) {
+      return _linkToExistingRemoteAlbum(localAlbum, existingRemoteAlbum);
+    } else {
+      return _createAndLinkNewRemoteAlbum(localAlbum);
+    }
+  }
+
+  /// Links a local album to an existing remote album
+  Future<void> _linkToExistingRemoteAlbum(LocalAlbum localAlbum, dynamic existingRemoteAlbum) {
+    return _localAlbumRepository.linkRemoteAlbum(localAlbum.id, existingRemoteAlbum.id);
+  }
+
+  /// Creates a new remote album and links it to the local album
+  Future<void> _createAndLinkNewRemoteAlbum(LocalAlbum localAlbum) async {
+    debugPrint("Creating new remote album for local album: ${localAlbum.name}");
+    final newRemoteAlbum = await _albumApiRepository.createDriftAlbum(localAlbum.name, assetIds: []);
+    await _remoteAlbumRepository.create(newRemoteAlbum, []);
+    return _localAlbumRepository.linkRemoteAlbum(localAlbum.id, newRemoteAlbum.id);
+  }
+}

mobile/lib/domain/utils/background_sync.dart

@@ -1,5 +1,6 @@
 import 'dart:async';
 
+import 'package:immich_mobile/domain/utils/sync_linked_album.dart';
 import 'package:immich_mobile/providers/infrastructure/sync.provider.dart';
 import 'package:immich_mobile/utils/isolate.dart';
 import 'package:worker_manager/worker_manager.dart';
@@ -155,6 +156,11 @@ class BackgroundSyncManager {
       _syncWebsocketTask = null;
     });
   }
+
+  Future<void> syncLinkedAlbum() {
+    final task = runInIsolateGentle(computation: syncLinkedAlbumsIsolated);
+    return task.future;
+  }
 }
 
 Cancelable<void> _handleWsAssetUploadReadyV1Batch(List<dynamic> batchData) => runInIsolateGentle(

mobile/lib/domain/utils/sync_linked_album.dart

@@ -0,0 +1,11 @@
+import 'package:hooks_riverpod/hooks_riverpod.dart';
+import 'package:immich_mobile/domain/services/sync_linked_album.service.dart';
+import 'package:immich_mobile/providers/user.provider.dart';
+
+Future<void> syncLinkedAlbumsIsolated(ProviderContainer ref) {
+  final user = ref.read(currentUserProvider);
+  if (user == null) {
+    return Future.value();
+  }
+  return ref.read(syncLinkedAlbumServiceProvider).syncLinkedAlbums(user.id);
+}