feat(mobile): use efficient sync (#8842)

* feat(mobile): use efficient sync

review feedback

* adapt to changed  server endpoints

* formatting

* fix memory lane bug

* fix: bad merge

* fix call not returning correct number of asset

---------

Co-authored-by: Alex Tran <alex.tran1502@gmail.com>

mobile/lib/pages/photos/photos.page.dart

@@ -33,7 +33,6 @@ class PhotosPage extends HookConsumerWidget {
       () {
         ref.read(websocketProvider.notifier).connect();
         Future(() => ref.read(assetProvider.notifier).getAllAsset());
-        ref.read(assetProvider.notifier).getPartnerAssets();
         ref.read(albumProvider.notifier).getAllAlbums();
         ref.read(sharedAlbumProvider.notifier).getAllSharedAlbums();
         ref.read(serverInfoProvider.notifier).getServerInfo();
@@ -85,9 +84,6 @@ class PhotosPage extends HookConsumerWidget {
     Future<void> refreshAssets() async {
       final fullRefresh = refreshCount.value > 0;
       await ref.read(assetProvider.notifier).getAllAsset(clear: fullRefresh);
-      if (timelineUsers.length > 1) {
-        await ref.read(assetProvider.notifier).getPartnerAssets();
-      }
       if (fullRefresh) {
         // refresh was forced: user requested another refresh within 2 seconds
         refreshCount.value = 0;

mobile/lib/pages/sharing/partner/partner_detail.page.dart

@@ -22,7 +22,7 @@ class PartnerDetailPage extends HookConsumerWidget {
 
     useEffect(
       () {
-        ref.read(assetProvider.notifier).getPartnerAssets(partner);
+        ref.read(assetProvider.notifier).getAllAsset();
         return null;
       },
       [],
@@ -78,8 +78,7 @@ class PartnerDetailPage extends HookConsumerWidget {
             ),
       body: MultiselectGrid(
         renderListProvider: assetsProvider(partner.isarId),
-        onRefresh: () =>
-            ref.read(assetProvider.notifier).getPartnerAssets(partner),
+        onRefresh: () => ref.read(assetProvider.notifier).getAllAsset(),
         deleteEnabled: false,
         favoriteEnabled: false,
       ),

mobile/lib/providers/app_life_cycle.provider.dart

@@ -56,11 +56,10 @@ class AppLifeCycleNotifier extends StateNotifier<AppLifeCycleEnum> {
       switch (_ref.read(tabProvider)) {
         case TabEnum.home:
           _ref.read(assetProvider.notifier).getAllAsset();
-          _ref.read(assetProvider.notifier).getPartnerAssets();
         case TabEnum.search:
         // nothing to do
         case TabEnum.sharing:
-          _ref.read(assetProvider.notifier).getPartnerAssets();
+          _ref.read(assetProvider.notifier).getAllAsset();
           _ref.read(sharedAlbumProvider.notifier).getAllSharedAlbums();
         case TabEnum.library:
           _ref.read(albumProvider.notifier).getAllAlbums();

mobile/lib/providers/asset.provider.dart

@@ -1,9 +1,9 @@
 import 'package:flutter/material.dart';
 import 'package:hooks_riverpod/hooks_riverpod.dart';
+import 'package:immich_mobile/providers/memory.provider.dart';
 import 'package:immich_mobile/services/album.service.dart';
 import 'package:immich_mobile/entities/exif_info.entity.dart';
 import 'package:immich_mobile/entities/store.entity.dart';
-import 'package:immich_mobile/entities/user.entity.dart';
 import 'package:immich_mobile/providers/db.provider.dart';
 import 'package:immich_mobile/providers/user.provider.dart';
 import 'package:immich_mobile/services/asset.service.dart';
@@ -23,17 +23,18 @@ class AssetNotifier extends StateNotifier<bool> {
   final UserService _userService;
   final SyncService _syncService;
   final Isar _db;
+  final StateNotifierProviderRef _ref;
   final log = Logger('AssetNotifier');
   bool _getAllAssetInProgress = false;
   bool _deleteInProgress = false;
-  bool _getPartnerAssetsInProgress = false;
 
   AssetNotifier(
     this._assetService,
     this._albumService,
     this._userService,
     this._syncService,
     this._db,
+    this._ref,
   ) : super(false);
 
   Future<void> getAllAsset({bool clear = false}) async {
@@ -49,9 +50,15 @@ class AssetNotifier extends StateNotifier<bool> {
         await clearAssetsAndAlbums(_db);
         log.info("Manual refresh requested, cleared assets and albums from db");
       }
+      final bool changedUsers = await _userService.refreshUsers();
       final bool newRemote = await _assetService.refreshRemoteAssets();
       final bool newLocal = await _albumService.refreshDeviceAlbums();
-      debugPrint("newRemote: $newRemote, newLocal: $newLocal");
+      debugPrint(
+        "changedUsers: $changedUsers, newRemote: $newRemote, newLocal: $newLocal",
+      );
+      if (newRemote) {
+        _ref.invalidate(memoryFutureProvider);
+      }
 
       log.info("Load assets: ${stopwatch.elapsedMilliseconds}ms");
     } finally {
@@ -60,27 +67,6 @@ class AssetNotifier extends StateNotifier<bool> {
     }
   }
 
-  Future<void> getPartnerAssets([User? partner]) async {
-    if (_getPartnerAssetsInProgress) return;
-    try {
-      final stopwatch = Stopwatch()..start();
-      _getPartnerAssetsInProgress = true;
-      if (partner == null) {
-        await _userService.refreshUsers();
-        final List<User> partners =
-            await _db.users.filter().isPartnerSharedWithEqualTo(true).findAll();
-        for (User u in partners) {
-          await _assetService.refreshRemoteAssets(u);
-        }
-      } else {
-        await _assetService.refreshRemoteAssets(partner);
-      }
-      log.info("Load partner assets: ${stopwatch.elapsedMilliseconds}ms");
-    } finally {
-      _getPartnerAssetsInProgress = false;
-    }
-  }
-
   Future<void> clearAllAsset() {
     return clearAssetsAndAlbums(_db);
   }
@@ -321,6 +307,7 @@ final assetProvider = StateNotifierProvider<AssetNotifier, bool>((ref) {
     ref.watch(userServiceProvider),
     ref.watch(syncServiceProvider),
     ref.watch(dbProvider),
+    ref,
   );
 });
 

mobile/lib/routing/tab_navigation_observer.dart

@@ -43,7 +43,7 @@ class TabNavigationObserver extends AutoRouterObserver {
 
     if (route.name == 'SharingRoute') {
       ref.read(sharedAlbumProvider.notifier).getAllSharedAlbums();
-      ref.read(assetProvider.notifier).getPartnerAssets();
+      Future(() => ref.read(assetProvider.notifier).getAllAsset());
     }
 
     if (route.name == 'LibraryRoute') {

mobile/lib/services/api.service.dart

@@ -23,6 +23,7 @@ class ApiService {
   late PersonApi personApi;
   late AuditApi auditApi;
   late SharedLinkApi sharedLinkApi;
+  late SyncApi syncApi;
   late SystemConfigApi systemConfigApi;
   late ActivityApi activityApi;
   late DownloadApi downloadApi;
@@ -53,6 +54,7 @@ class ApiService {
     personApi = PersonApi(_apiClient);
     auditApi = AuditApi(_apiClient);
     sharedLinkApi = SharedLinkApi(_apiClient);
+    syncApi = SyncApi(_apiClient);
     systemConfigApi = SystemConfigApi(_apiClient);
     activityApi = ActivityApi(_apiClient);
     downloadApi = DownloadApi(_apiClient);

mobile/lib/services/asset.service.dart

@@ -5,13 +5,14 @@ import 'dart:async';
 import 'package:flutter/material.dart';
 import 'package:hooks_riverpod/hooks_riverpod.dart';
 import 'package:immich_mobile/entities/asset.entity.dart';
+import 'package:immich_mobile/entities/etag.entity.dart';
 import 'package:immich_mobile/entities/exif_info.entity.dart';
-import 'package:immich_mobile/entities/store.entity.dart';
 import 'package:immich_mobile/entities/user.entity.dart';
 import 'package:immich_mobile/providers/api.provider.dart';
 import 'package:immich_mobile/providers/db.provider.dart';
 import 'package:immich_mobile/services/api.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';
 import 'package:maplibre_gl/maplibre_gl.dart';
@@ -21,46 +22,57 @@ final assetServiceProvider = Provider(
   (ref) => AssetService(
     ref.watch(apiServiceProvider),
     ref.watch(syncServiceProvider),
+    ref.watch(userServiceProvider),
     ref.watch(dbProvider),
   ),
 );
 
 class AssetService {
   final ApiService _apiService;
   final SyncService _syncService;
+  final UserService _userService;
   final log = Logger('AssetService');
   final Isar _db;
 
   AssetService(
     this._apiService,
     this._syncService,
+    this._userService,
     this._db,
   );
 
   /// Checks the server for updated assets and updates the local database if
   /// required. Returns `true` if there were any changes.
-  Future<bool> refreshRemoteAssets([User? user]) async {
-    user ??= Store.get<User>(StoreKey.currentUser);
+  Future<bool> refreshRemoteAssets() async {
+    final syncedUserIds = await _db.eTags.where().idProperty().findAll();
+    final List<User> syncedUsers = syncedUserIds.isEmpty
+        ? []
+        : await _db.users
+            .where()
+            .anyOf(syncedUserIds, (q, id) => q.idEqualTo(id))
+            .findAll();
     final Stopwatch sw = Stopwatch()..start();
     final bool changes = await _syncService.syncRemoteAssetsToDb(
-      user,
-      _getRemoteAssetChanges,
-      _getRemoteAssets,
+      users: syncedUsers,
+      getChangedAssets: _getRemoteAssetChanges,
+      loadAssets: _getRemoteAssets,
+      refreshUsers: _userService.getUsersFromServer,
     );
     debugPrint("refreshRemoteAssets full took ${sw.elapsedMilliseconds}ms");
     return changes;
   }
 
   /// Returns `(null, null)` if changes are invalid -> requires full sync
   Future<(List<Asset>? toUpsert, List<String>? toDelete)>
-      _getRemoteAssetChanges(User user, DateTime since) async {
-    final deleted = await _apiService.auditApi
-        .getAuditDeletes(since, EntityType.ASSET, userId: user.id);
-    if (deleted == null || deleted.needsFullSync) return (null, null);
-    final assetDto = await _apiService.assetApi
-        .getAllAssets(userId: user.id, updatedAfter: since);
-    if (assetDto == null) return (null, null);
-    return (assetDto.map(Asset.remote).toList(), deleted.ids);
+      _getRemoteAssetChanges(List<User> users, DateTime since) async {
+    final dto = AssetDeltaSyncDto(
+      updatedAfter: since,
+      userIds: users.map((e) => e.id).toList(),
+    );
+    final changes = await _apiService.syncApi.getDeltaSync(dto);
+    return changes == null || changes.needsFullSync
+        ? (null, null)
+        : (changes.upserted.map(Asset.remote).toList(), changes.deleted);
   }
 
   /// Returns the list of people of the given asset id.
@@ -85,38 +97,32 @@ class AssetService {
   }
 
   /// Returns `null` if the server state did not change, else list of assets
-  Future<List<Asset>?> _getRemoteAssets(User user) async {
+  Future<List<Asset>?> _getRemoteAssets(User user, DateTime until) async {
     const int chunkSize = 10000;
     try {
-      final DateTime now = DateTime.now().toUtc();
       final List<Asset> allAssets = [];
-      for (int i = 0;; i += chunkSize) {
-        final List<AssetResponseDto>? assets =
-            await _apiService.assetApi.getAllAssets(
+      DateTime? lastCreationDate;
+      String? lastId;
+      // will break on error or once all assets are loaded
+      while (true) {
+        final dto = AssetFullSyncDto(
+          limit: chunkSize,
+          updatedUntil: until,
+          lastId: lastId,
+          lastCreationDate: lastCreationDate,
           userId: user.id,
-          // updatedBefore is important! without it we could
-          // a) get the same Asset multiple times in different versions (when
-          // the asset is modified while the chunks are loaded from the server)
-          // b) miss assets when new assets are inserted in between the calls
-          updatedBefore: now,
-          skip: i,
-          take: chunkSize,
         );
-        if (assets == null) {
-          return null;
-        }
+        final List<AssetResponseDto>? assets =
+            await _apiService.syncApi.getFullSyncForUser(dto);
+        if (assets == null) return null;
         allAssets.addAll(assets.map(Asset.remote));
-        if (assets.length < chunkSize) {
-          break;
-        }
+        if (assets.isEmpty) break;
+        lastCreationDate = assets.last.fileCreatedAt;
+        lastId = assets.last.id;
       }
       return allAssets;
     } catch (error, stack) {
-      log.severe(
-        'Error while getting remote assets',
-        error,
-        stack,
-      );
+      log.severe('Error while getting remote assets', error, stack);
       return null;
     }
   }

mobile/lib/services/memory.service.dart

@@ -37,12 +37,16 @@ class MemoryService {
 
       List<Memory> memories = [];
       for (final MemoryLaneResponseDto(:title, :assets) in data) {
-        memories.add(
-          Memory(
-            title: title,
-            assets: await _db.assets.getAllByRemoteId(assets.map((e) => e.id)),
-          ),
-        );
+        final dbAssets =
+            await _db.assets.getAllByRemoteId(assets.map((e) => e.id));
+        if (dbAssets.isNotEmpty) {
+          memories.add(
+            Memory(
+              title: title,
+              assets: dbAssets,
+            ),
+          );
+        }
       }
 
       return memories.isNotEmpty ? memories : null;