feat: add cloud id during native sync (#20418)

* use adjustment time in iOS for hash reset # Conflicts: # mobile/lib/infrastructure/repositories/local_album.repository.dart # mobile/lib/presentation/pages/drift_asset_troubleshoot.page.dart * migration * feat: sync cloudId and eTag on sync * fixes fixes * more fixes * re-sync updated eTags * add server version check & auto sync cloud ids on compatible servers * fix test * remove button from sync status page * chore: modify for testing * more changes * chore: add commas in toString * use cached provider in splash screen * read upload service provider to prevent reset * log errors from fetching cloud id mapping * WIP: migrate cloud id - debug log * ignore locked asset update * bulk update metadata * change log text --------- Co-authored-by: shenlong-tanwen <139912620+shalong-tanwen@users.noreply.github.com> Co-authored-by: Alex <alex.tran1502@gmail.com>
2026-05-18 03:10:24 +03:00 · 2026-01-15 00:04:11 +05:30
parent ed9448a6ee
commit 9fa8de7baa
46 changed files with 10913 additions and 121 deletions
@@ -0,0 +1,62 @@
+enum RemoteAssetMetadataKey {
+  mobileApp("mobile-app");
+
+  final String key;
+
+  const RemoteAssetMetadataKey(this.key);
+}
+
+abstract class RemoteAssetMetadataValue {
+  const RemoteAssetMetadataValue();
+
+  Map<String, dynamic> toJson();
+}
+
+class RemoteAssetMetadataItem {
+  final RemoteAssetMetadataKey key;
+  final RemoteAssetMetadataValue value;
+
+  const RemoteAssetMetadataItem({required this.key, required this.value});
+
+  Map<String, Object?> toJson() {
+    return {'key': key.key, 'value': value};
+  }
+}
+
+class RemoteAssetMobileAppMetadata extends RemoteAssetMetadataValue {
+  final String? cloudId;
+  final String? createdAt;
+  final String? adjustmentTime;
+  final String? latitude;
+  final String? longitude;
+
+  const RemoteAssetMobileAppMetadata({
+    this.cloudId,
+    this.createdAt,
+    this.adjustmentTime,
+    this.latitude,
+    this.longitude,
+  });
+
+  @override
+  Map<String, dynamic> toJson() {
+    final map = <String, Object?>{};
+    if (cloudId != null) {
+      map["iCloudId"] = cloudId;
+    }
+    if (createdAt != null) {
+      map["createdAt"] = createdAt;
+    }
+    if (adjustmentTime != null) {
+      map["adjustmentTime"] = adjustmentTime;
+    }
+    if (latitude != null) {
+      map["latitude"] = latitude;
+    }
+    if (longitude != null) {
+      map["longitude"] = longitude;
+    }
+
+    return map;
+  }
+}
@@ -3,6 +3,7 @@ part of 'base_asset.model.dart';
 class LocalAsset extends BaseAsset {
  final String id;
  final String? remoteAssetId;
+  final String? cloudId;
  final int orientation;

  final DateTime? adjustmentTime;
@@ -12,6 +13,7 @@ class LocalAsset extends BaseAsset {
  const LocalAsset({
    required this.id,
    String? remoteId,
+    this.cloudId,
    required super.name,
    super.checksum,
    required super.type,
@@ -53,12 +55,14 @@ class LocalAsset extends BaseAsset {
   width: ${width ?? "<NA>"},
   height: ${height ?? "<NA>"},
   durationInSeconds: ${durationInSeconds ?? "<NA>"},
-   remoteId: ${remoteId ?? "<NA>"}
+   remoteId: ${remoteId ?? "<NA>"},
+   cloudId: ${cloudId ?? "<NA>"},
+   checksum: ${checksum ?? "<NA>"},
   isFavorite: $isFavorite,
-  orientation: $orientation,
-  adjustmentTime: $adjustmentTime,
-  latitude: ${latitude ?? "<NA>"},
-  longitude: ${longitude ?? "<NA>"},
+   orientation: $orientation,
+   adjustmentTime: $adjustmentTime,
+   latitude: ${latitude ?? "<NA>"},
+   longitude: ${longitude ?? "<NA>"},
 }''';
  }

@@ -69,6 +73,7 @@ class LocalAsset extends BaseAsset {
    if (identical(this, other)) return true;
    return super == other &&
        id == other.id &&
+        cloudId == other.cloudId &&
        orientation == other.orientation &&
        adjustmentTime == other.adjustmentTime &&
        latitude == other.latitude &&
@@ -88,6 +93,7 @@ class LocalAsset extends BaseAsset {
  LocalAsset copyWith({
    String? id,
    String? remoteId,
+    String? cloudId,
    String? name,
    String? checksum,
    AssetType? type,
@@ -105,6 +111,7 @@ class LocalAsset extends BaseAsset {
    return LocalAsset(
      id: id ?? this.id,
      remoteId: remoteId ?? this.remoteId,
+      cloudId: cloudId ?? this.cloudId,
      name: name ?? this.name,
      checksum: checksum ?? this.checksum,
      type: type ?? this.type,
@@ -40,6 +40,9 @@ class HashService {
    _log.info("Starting hashing of assets");
    final Stopwatch stopwatch = Stopwatch()..start();
    try {
+      // Migrate hashes from cloud ID to local ID so we don't have to re-hash them
+      await _migrateHashes();
+
      // Sorted by backupSelection followed by isCloud
      final localAlbums = await _localAlbumRepository.getBackupAlbums();

@@ -75,6 +78,15 @@ class HashService {
    _log.info("Hashing took - ${stopwatch.elapsedMilliseconds}ms");
  }

+  Future<void> _migrateHashes() async {
+    final hashMappings = await _localAssetRepository.getHashMappingFromCloudId();
+    if (hashMappings.isEmpty) {
+      return;
+    }
+
+    await _localAssetRepository.updateHashes(hashMappings);
+  }
+
  /// Processes a list of [LocalAsset]s, storing their hash and updating the assets in the DB
  /// with hash for those that were successfully hashed. Hashes are looked up in a table
  /// [LocalAssetHashEntity] by local id. Only missing entries are newly hashed and added to the DB.
@@ -8,6 +8,7 @@ import 'package:immich_mobile/domain/models/store.model.dart';
 import 'package:immich_mobile/entities/store.entity.dart';
 import 'package:immich_mobile/extensions/platform_extensions.dart';
 import 'package:immich_mobile/infrastructure/repositories/local_album.repository.dart';
+import 'package:immich_mobile/infrastructure/repositories/local_asset.repository.dart';
 import 'package:immich_mobile/infrastructure/repositories/storage.repository.dart';
 import 'package:immich_mobile/infrastructure/repositories/trashed_local_asset.repository.dart';
 import 'package:immich_mobile/platform/native_sync_api.g.dart';
@@ -18,6 +19,7 @@ import 'package:logging/logging.dart';

 class LocalSyncService {
  final DriftLocalAlbumRepository _localAlbumRepository;
+  final DriftLocalAssetRepository _localAssetRepository;
  final NativeSyncApi _nativeSyncApi;
  final DriftTrashedLocalAssetRepository _trashedLocalAssetRepository;
  final LocalFilesManagerRepository _localFilesManager;
@@ -26,11 +28,13 @@ class LocalSyncService {

  LocalSyncService({
    required DriftLocalAlbumRepository localAlbumRepository,
+    required DriftLocalAssetRepository localAssetRepository,
    required DriftTrashedLocalAssetRepository trashedLocalAssetRepository,
    required LocalFilesManagerRepository localFilesManager,
    required StorageRepository storageRepository,
    required NativeSyncApi nativeSyncApi,
  }) : _localAlbumRepository = localAlbumRepository,
+       _localAssetRepository = localAssetRepository,
       _trashedLocalAssetRepository = trashedLocalAssetRepository,
       _localFilesManager = localFilesManager,
       _storageRepository = storageRepository,
@@ -47,6 +51,12 @@ class LocalSyncService {
          _log.warning("syncTrashedAssets cannot proceed because MANAGE_MEDIA permission is missing");
        }
      }
+
+      if (CurrentPlatform.isIOS) {
+        final assets = await _localAssetRepository.getEmptyCloudIdAssets();
+        await _mapIosCloudIds(assets);
+      }
+
      if (full || await _nativeSyncApi.shouldFullSync()) {
        _log.fine("Full sync request from ${full ? "user" : "native"}");
        return await fullSync();
@@ -63,8 +73,9 @@ class LocalSyncService {

      final deviceAlbums = await _nativeSyncApi.getAlbums();
      await _localAlbumRepository.updateAll(deviceAlbums.toLocalAlbums());
+      final newAssets = delta.updates.toLocalAssets();
      await _localAlbumRepository.processDelta(
-        updates: delta.updates.toLocalAssets(),
+        updates: newAssets,
        deletes: delta.deletes,
        assetAlbums: delta.assetAlbums,
      );
@@ -92,6 +103,8 @@ class LocalSyncService {
          }
          await updateAlbum(dbAlbum, album);
        }
+
+        await _mapIosCloudIds(newAssets);
      }
      await _nativeSyncApi.checkpointSync();
    } catch (e, s) {
@@ -130,9 +143,12 @@ class LocalSyncService {
    try {
      _log.fine("Adding device album ${album.name}");

-      final assets = album.assetCount > 0 ? await _nativeSyncApi.getAssetsForAlbum(album.id) : <PlatformAsset>[];
+      final assets = album.assetCount > 0
+          ? await _nativeSyncApi.getAssetsForAlbum(album.id).then((a) => a.toLocalAssets())
+          : <LocalAsset>[];

-      await _localAlbumRepository.upsert(album, toUpsert: assets.toLocalAssets());
+      await _localAlbumRepository.upsert(album, toUpsert: assets);
+      await _mapIosCloudIds(assets);
      _log.fine("Successfully added device album ${album.name}");
    } catch (e, s) {
      _log.warning("Error while adding device album", e, s);
@@ -202,13 +218,16 @@ class LocalSyncService {
        return false;
      }

-      final newAssets = await _nativeSyncApi.getAssetsForAlbum(deviceAlbum.id, updatedTimeCond: updatedTime);
+      final newAssets = await _nativeSyncApi
+          .getAssetsForAlbum(deviceAlbum.id, updatedTimeCond: updatedTime)
+          .then((a) => a.toLocalAssets());

      await _localAlbumRepository.upsert(
        deviceAlbum.copyWith(backupSelection: dbAlbum.backupSelection),
-        toUpsert: newAssets.toLocalAssets(),
+        toUpsert: newAssets,
      );

+      await _mapIosCloudIds(newAssets);
      return true;
    } catch (e, s) {
      _log.warning("Error on fast syncing local album: ${dbAlbum.name}", e, s);
@@ -240,6 +259,7 @@ class LocalSyncService {
      if (dbAlbum.assetCount == 0) {
        _log.fine("Device album ${deviceAlbum.name} is empty. Adding assets to DB.");
        await _localAlbumRepository.upsert(updatedDeviceAlbum, toUpsert: assetsInDevice);
+        await _mapIosCloudIds(assetsInDevice);
        return true;
      }

@@ -277,6 +297,7 @@ class LocalSyncService {
      }

      await _localAlbumRepository.upsert(updatedDeviceAlbum, toUpsert: assetsToUpsert, toDelete: assetsToDelete);
+      await _mapIosCloudIds(assetsToUpsert);

      return true;
    } catch (e, s) {
@@ -285,6 +306,29 @@ class LocalSyncService {
    return true;
  }

+  Future<void> _mapIosCloudIds(List<LocalAsset> assets) async {
+    if (!CurrentPlatform.isIOS || assets.isEmpty) {
+      return;
+    }
+
+    final assetIds = assets.map((a) => a.id).toList();
+    final cloudMapping = <String, String>{};
+    final cloudIds = await _nativeSyncApi.getCloudIdForAssetIds(assetIds);
+    for (int i = 0; i < cloudIds.length; i++) {
+      final cloudIdResult = cloudIds[i];
+      if (cloudIdResult.cloudId != null) {
+        cloudMapping[cloudIdResult.assetId] = cloudIdResult.cloudId!;
+      } else {
+        final asset = assets.firstWhereOrNull((a) => a.id == cloudIdResult.assetId);
+        _log.fine(
+          "Cannot fetch cloudId for asset with id: ${cloudIdResult.assetId}, name: ${asset?.name}, createdAt: ${asset?.createdAt}. Error: ${cloudIdResult.error ?? "unknown"}",
+        );
+      }
+    }
+
+    await _localAlbumRepository.updateCloudMapping(cloudMapping);
+  }
+
  bool _assetsEqual(LocalAsset a, LocalAsset b) {
    if (CurrentPlatform.isAndroid) {
      return a.updatedAt.isAtSameMomentAs(b.updatedAt) &&
@@ -118,6 +118,10 @@ class SyncStreamService {
        return _syncStreamRepository.deleteAssetsV1(data.cast());
      case SyncEntityType.assetExifV1:
        return _syncStreamRepository.updateAssetsExifV1(data.cast());
+      case SyncEntityType.assetMetadataV1:
+        return _syncStreamRepository.updateAssetsMetadataV1(data.cast());
+      case SyncEntityType.assetMetadataDeleteV1:
+        return _syncStreamRepository.deleteAssetsMetadataV1(data.cast());
      case SyncEntityType.partnerAssetV1:
        return _syncStreamRepository.updateAssetsV1(data.cast(), debugLabel: 'partner');
      case SyncEntityType.partnerAssetBackfillV1:
@@ -1,5 +1,6 @@
 import 'dart:async';

+import 'package:immich_mobile/domain/utils/migrate_cloud_ids.dart' as m;
 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';
@@ -22,8 +23,13 @@ class BackgroundSyncManager {
  final SyncCallback? onHashingComplete;
  final SyncErrorCallback? onHashingError;

+  final SyncCallback? onCloudIdSyncStart;
+  final SyncCallback? onCloudIdSyncComplete;
+  final SyncErrorCallback? onCloudIdSyncError;
+
  Cancelable<bool?>? _syncTask;
  Cancelable<void>? _syncWebsocketTask;
+  Cancelable<void>? _cloudIdSyncTask;
  Cancelable<void>? _deviceAlbumSyncTask;
  Cancelable<void>? _linkedAlbumSyncTask;
  Cancelable<void>? _hashTask;
@@ -38,6 +44,9 @@ class BackgroundSyncManager {
    this.onHashingStart,
    this.onHashingComplete,
    this.onHashingError,
+    this.onCloudIdSyncStart,
+    this.onCloudIdSyncComplete,
+    this.onCloudIdSyncError,
  });

  Future<void> cancel() async {
@@ -55,6 +64,12 @@ class BackgroundSyncManager {
    _syncWebsocketTask?.cancel();
    _syncWebsocketTask = null;

+    if (_cloudIdSyncTask != null) {
+      futures.add(_cloudIdSyncTask!.future);
+    }
+    _cloudIdSyncTask?.cancel();
+    _cloudIdSyncTask = null;
+
    if (_linkedAlbumSyncTask != null) {
      futures.add(_linkedAlbumSyncTask!.future);
    }
@@ -121,7 +136,6 @@ class BackgroundSyncManager {
        });
  }

-  // No need to cancel the task, as it can also be run when the user logs out
  Future<void> hashAssets() {
    if (_hashTask != null) {
      return _hashTask!.future;
@@ -192,6 +206,25 @@ class BackgroundSyncManager {
      _linkedAlbumSyncTask = null;
    });
  }
+
+  Future<void> syncCloudIds() {
+    if (_cloudIdSyncTask != null) {
+      return _cloudIdSyncTask!.future;
+    }
+
+    onCloudIdSyncStart?.call();
+
+    _cloudIdSyncTask = runInIsolateGentle(computation: m.syncCloudIds);
+    return _cloudIdSyncTask!
+        .whenComplete(() {
+          onCloudIdSyncComplete?.call();
+          _cloudIdSyncTask = null;
+        })
+        .catchError((error) {
+          onCloudIdSyncError?.call(error.toString());
+          _cloudIdSyncTask = null;
+        });
+  }
 }

 Cancelable<void> _handleWsAssetUploadReadyV1Batch(List<dynamic> batchData) => runInIsolateGentle(
@@ -0,0 +1,166 @@
+import 'package:drift/drift.dart';
+import 'package:hooks_riverpod/hooks_riverpod.dart';
+import 'package:immich_mobile/constants/constants.dart';
+import 'package:immich_mobile/domain/models/asset/asset_metadata.model.dart';
+import 'package:immich_mobile/domain/models/asset/base_asset.model.dart';
+import 'package:immich_mobile/extensions/platform_extensions.dart';
+import 'package:immich_mobile/infrastructure/entities/local_asset.entity.dart';
+import 'package:immich_mobile/infrastructure/repositories/db.repository.dart';
+import 'package:immich_mobile/infrastructure/repositories/local_album.repository.dart';
+import 'package:immich_mobile/platform/native_sync_api.g.dart';
+import 'package:immich_mobile/providers/api.provider.dart';
+import 'package:immich_mobile/providers/infrastructure/db.provider.dart';
+import 'package:immich_mobile/providers/infrastructure/sync.provider.dart';
+import 'package:immich_mobile/providers/server_info.provider.dart';
+import 'package:immich_mobile/providers/user.provider.dart';
+import 'package:logging/logging.dart';
+// ignore: import_rule_openapi
+import 'package:openapi/api.dart' hide AssetVisibility;
+
+Future<void> syncCloudIds(ProviderContainer ref) async {
+  if (!CurrentPlatform.isIOS) {
+    return;
+  }
+
+  final db = ref.read(driftProvider);
+  // Populate cloud IDs for local assets that don't have one yet
+  await _populateCloudIds(db);
+
+  final serverInfo = await ref.read(serverInfoProvider.notifier).getServerInfo();
+  final canUpdateMetadata = serverInfo.serverVersion.isAtLeast(major: 2, minor: 4);
+  if (!canUpdateMetadata) {
+    Logger(
+      'migrateCloudIds',
+    ).fine('Server version does not support asset metadata updates. Skipping cloudId migration.');
+    return;
+  }
+  final canBulkUpdateMetadata = serverInfo.serverVersion.isAtLeast(major: 2, minor: 5);
+
+  // Wait for remote sync to complete, so we have up-to-date asset metadata entries
+  try {
+    await ref.read(syncStreamServiceProvider).sync();
+  } catch (e, s) {
+    Logger('migrateCloudIds').fine('Failed to complete remote sync before cloudId migration.', e, s);
+    return;
+  }
+
+  // Fetch the mapping for backed up assets that have a cloud ID locally but do not have a cloud ID on the server
+  final currentUser = ref.read(currentUserProvider);
+  if (currentUser == null) {
+    Logger('migrateCloudIds').warning('Current user is null. Aborting cloudId migration.');
+    return;
+  }
+
+  final mappingsToUpdate = await _fetchCloudIdMappings(db, currentUser.id);
+  final assetApi = ref.read(apiServiceProvider).assetsApi;
+
+  if (canBulkUpdateMetadata) {
+    await _bulkUpdateCloudIds(assetApi, mappingsToUpdate);
+    return;
+  }
+  await _sequentialUpdateCloudIds(assetApi, mappingsToUpdate);
+}
+
+Future<void> _sequentialUpdateCloudIds(AssetsApi assetsApi, List<_CloudIdMapping> mappings) async {
+  for (final mapping in mappings) {
+    final item = AssetMetadataUpsertItemDto(
+      key: kMobileMetadataKey,
+      value: RemoteAssetMobileAppMetadata(
+        cloudId: mapping.localAsset.cloudId,
+        createdAt: mapping.localAsset.createdAt.toIso8601String(),
+        adjustmentTime: mapping.localAsset.adjustmentTime?.toIso8601String(),
+        latitude: mapping.localAsset.latitude?.toString(),
+        longitude: mapping.localAsset.longitude?.toString(),
+      ),
+    );
+    try {
+      await assetsApi.updateAssetMetadata(mapping.remoteAssetId, AssetMetadataUpsertDto(items: [item]));
+    } catch (error, stack) {
+      Logger('migrateCloudIds').warning('Failed to update metadata for asset ${mapping.remoteAssetId}', error, stack);
+    }
+  }
+}
+
+Future<void> _bulkUpdateCloudIds(AssetsApi assetsApi, List<_CloudIdMapping> mappings) async {
+  const batchSize = 10000;
+  for (int i = 0; i < mappings.length; i += batchSize) {
+    final endIndex = (i + batchSize > mappings.length) ? mappings.length : i + batchSize;
+    final batch = mappings.sublist(i, endIndex);
+    final items = <AssetMetadataBulkUpsertItemDto>[];
+    for (final mapping in batch) {
+      items.add(
+        AssetMetadataBulkUpsertItemDto(
+          assetId: mapping.remoteAssetId,
+          key: kMobileMetadataKey,
+          value: RemoteAssetMobileAppMetadata(
+            cloudId: mapping.localAsset.cloudId,
+            createdAt: mapping.localAsset.createdAt.toIso8601String(),
+            adjustmentTime: mapping.localAsset.adjustmentTime?.toIso8601String(),
+            latitude: mapping.localAsset.latitude?.toString(),
+            longitude: mapping.localAsset.longitude?.toString(),
+          ),
+        ),
+      );
+    }
+    try {
+      await assetsApi.updateBulkAssetMetadata(AssetMetadataBulkUpsertDto(items: items));
+    } catch (error, stack) {
+      Logger('migrateCloudIds').warning('Failed to bulk update metadata', error, stack);
+    }
+  }
+}
+
+Future<void> _populateCloudIds(Drift drift) async {
+  final query = drift.localAssetEntity.selectOnly()
+    ..addColumns([drift.localAssetEntity.id])
+    ..where(drift.localAssetEntity.iCloudId.isNull());
+  final ids = await query.map((row) => row.read(drift.localAssetEntity.id)!).get();
+  final cloudMapping = <String, String>{};
+  final cloudIds = await NativeSyncApi().getCloudIdForAssetIds(ids);
+  for (int i = 0; i < cloudIds.length; i++) {
+    final cloudIdResult = cloudIds[i];
+    if (cloudIdResult.cloudId != null) {
+      cloudMapping[cloudIdResult.assetId] = cloudIdResult.cloudId!;
+    } else {
+      Logger('migrateCloudIds').fine(
+        "Cannot fetch cloudId for asset with id: ${cloudIdResult.assetId}. Error: ${cloudIdResult.error ?? "unknown"}",
+      );
+    }
+  }
+  await DriftLocalAlbumRepository(drift).updateCloudMapping(cloudMapping);
+}
+
+typedef _CloudIdMapping = ({String remoteAssetId, LocalAsset localAsset});
+
+Future<List<_CloudIdMapping>> _fetchCloudIdMappings(Drift drift, String userId) async {
+  final query =
+      drift.remoteAssetEntity.select().join([
+        leftOuterJoin(
+          drift.localAssetEntity,
+          drift.localAssetEntity.checksum.equalsExp(drift.remoteAssetEntity.checksum),
+        ),
+        leftOuterJoin(
+          drift.remoteAssetCloudIdEntity,
+          drift.remoteAssetEntity.id.equalsExp(drift.remoteAssetCloudIdEntity.assetId),
+          useColumns: false,
+        ),
+      ])..where(
+        // Only select assets that have a local cloud ID but either no remote cloud ID or a mismatched eTag
+        drift.localAssetEntity.id.isNotNull() &
+            drift.localAssetEntity.iCloudId.isNotNull() &
+            drift.remoteAssetEntity.ownerId.equals(userId) &
+            // Skip locked assets as we cannot update them without unlocking first
+            drift.remoteAssetEntity.visibility.isNotValue(AssetVisibility.locked.index) &
+            (drift.remoteAssetCloudIdEntity.cloudId.isNull() |
+                ((drift.remoteAssetCloudIdEntity.adjustmentTime.isNotExp(drift.localAssetEntity.adjustmentTime)) &
+                    (drift.remoteAssetCloudIdEntity.latitude.isNotExp(drift.localAssetEntity.latitude)) &
+                    (drift.remoteAssetCloudIdEntity.longitude.isNotExp(drift.localAssetEntity.longitude)) &
+                    (drift.remoteAssetCloudIdEntity.createdAt.isNotExp(drift.localAssetEntity.createdAt)))),
+      );
+  return query.map((row) {
+    return (
+      remoteAssetId: row.read(drift.remoteAssetEntity.id)!,
+      localAsset: row.readTable(drift.localAssetEntity).toDto(),
+    );
+  }).get();
+}