refactor(mobile): device asset entity to use modified time (#17064)

* refactor: device asset entity to use modified time

* chore: cleanup

* refactor: remove album media dependency from hashservice

* refactor: return updated copy of asset

* add hash service tests

* chore: rename hash batch constants

* chore: log the number of assets processed during migration

* chore: more logs

* refactor: use lookup and more tests

* use sort approach

* refactor hash service to use for loop instead

* refactor: rename to getByIds

---------

Co-authored-by: shenlong-tanwen <[email protected]>

Author: shenlong-tanwen

mobile/analysis_options.yaml

@@ -61,6 +61,7 @@ custom_lint:
         # refactor to make the providers and services testable
         - lib/providers/backup/{backup,manual_upload}.provider.dart # uses only PMProgressHandler
         - lib/services/{background,backup}.service.dart # uses only PMProgressHandler
+        - test/**.dart
     - import_rule_isar:
       message: isar must only be used in entities and repositories
       restrict: package:isar
@@ -150,7 +151,6 @@ dart_code_metrics:
     - avoid-unnecessary-continue
     - avoid-unnecessary-nullable-return-type: false
     - binary-expression-operand-order
-    - move-variable-outside-iteration
     - pattern-fields-ordering
     - prefer-abstract-final-static-class
     - prefer-commenting-future-delayed

mobile/lib/constants/constants.dart

@@ -4,3 +4,6 @@ const double downloadFailed = -2;
 
 // Number of log entries to retain on app start
 const int kLogTruncateLimit = 250;
+
+const int kBatchHashFileLimit = 128;
+const int kBatchHashSizeLimit = 1024 * 1024 * 1024; // 1GB

mobile/lib/domain/interfaces/device_asset.interface.dart

@@ -0,0 +1,12 @@
+import 'dart:async';
+
+import 'package:immich_mobile/domain/interfaces/db.interface.dart';
+import 'package:immich_mobile/domain/models/device_asset.model.dart';
+
+abstract interface class IDeviceAssetRepository implements IDatabaseRepository {
+  Future<bool> updateAll(List<DeviceAsset> assetHash);
+
+  Future<List<DeviceAsset>> getByIds(List<String> localIds);
+
+  Future<void> deleteIds(List<String> ids);
+}

mobile/lib/domain/models/device_asset.model.dart

@@ -0,0 +1,44 @@
+import 'dart:typed_data';
+
+class DeviceAsset {
+  final String assetId;
+  final Uint8List hash;
+  final DateTime modifiedTime;
+
+  const DeviceAsset({
+    required this.assetId,
+    required this.hash,
+    required this.modifiedTime,
+  });
+
+  @override
+  bool operator ==(covariant DeviceAsset other) {
+    if (identical(this, other)) return true;
+
+    return other.assetId == assetId &&
+        other.hash == hash &&
+        other.modifiedTime == modifiedTime;
+  }
+
+  @override
+  int get hashCode {
+    return assetId.hashCode ^ hash.hashCode ^ modifiedTime.hashCode;
+  }
+
+  @override
+  String toString() {
+    return 'DeviceAsset(assetId: $assetId, hash: $hash, modifiedTime: $modifiedTime)';
+  }
+
+  DeviceAsset copyWith({
+    String? assetId,
+    Uint8List? hash,
+    DateTime? modifiedTime,
+  }) {
+    return DeviceAsset(
+      assetId: assetId ?? this.assetId,
+      hash: hash ?? this.hash,
+      modifiedTime: modifiedTime ?? this.modifiedTime,
+    );
+  }
+}

mobile/lib/entities/asset.entity.dart

@@ -6,6 +6,7 @@ import 'package:immich_mobile/extensions/string_extensions.dart';
 import 'package:immich_mobile/infrastructure/entities/exif.entity.dart'
     as entity;
 import 'package:immich_mobile/infrastructure/utils/exif.converter.dart';
+import 'package:immich_mobile/utils/diff.dart';
 import 'package:immich_mobile/utils/hash.dart';
 import 'package:isar/isar.dart';
 import 'package:openapi/api.dart';
@@ -358,23 +359,23 @@ class Asset {
       // take most values from newer asset
       // keep vales that can never be set by the asset not in DB
       if (a.isRemote) {
-        return a._copyWith(
+        return a.copyWith(
           id: id,
           localId: localId,
           width: a.width ?? width,
           height: a.height ?? height,
           exifInfo: a.exifInfo?.copyWith(assetId: id) ?? exifInfo,
         );
       } else if (isRemote) {
-        return _copyWith(
+        return copyWith(
           localId: localId ?? a.localId,
           width: width ?? a.width,
           height: height ?? a.height,
           exifInfo: exifInfo ?? a.exifInfo?.copyWith(assetId: id),
         );
       } else {
         // TODO: Revisit this and remove all bool field assignments
-        return a._copyWith(
+        return a.copyWith(
           id: id,
           remoteId: remoteId,
           livePhotoVideoId: livePhotoVideoId,
@@ -394,7 +395,7 @@ class Asset {
       // fill in potentially missing values, i.e. merge assets
       if (a.isRemote) {
         // values from remote take precedence
-        return _copyWith(
+        return copyWith(
           remoteId: a.remoteId,
           width: a.width,
           height: a.height,
@@ -416,7 +417,7 @@ class Asset {
         );
       } else {
         // add only missing values (and set isLocal to true)
-        return _copyWith(
+        return copyWith(
           localId: localId ?? a.localId,
           width: width ?? a.width,
           height: height ?? a.height,
@@ -427,7 +428,7 @@ class Asset {
     }
   }
 
-  Asset _copyWith({
+  Asset copyWith({
     Id? id,
     String? checksum,
     String? remoteId,
@@ -488,6 +489,9 @@ class Asset {
 
   static int compareById(Asset a, Asset b) => a.id.compareTo(b.id);
 
+  static int compareByLocalId(Asset a, Asset b) =>
+      compareToNullable(a.localId, b.localId);
+
   static int compareByChecksum(Asset a, Asset b) =>
       a.checksum.compareTo(b.checksum);
 

mobile/lib/infrastructure/entities/device_asset.entity.dart

@@ -0,0 +1,36 @@
+import 'dart:typed_data';
+
+import 'package:immich_mobile/domain/models/device_asset.model.dart';
+import 'package:immich_mobile/utils/hash.dart';
+import 'package:isar/isar.dart';
+
+part 'device_asset.entity.g.dart';
+
+@Collection(inheritance: false)
+class DeviceAssetEntity {
+  Id get id => fastHash(assetId);
+
+  @Index(replace: true, unique: true, type: IndexType.hash)
+  final String assetId;
+  @Index(unique: false, type: IndexType.hash)
+  final List<byte> hash;
+  final DateTime modifiedTime;
+
+  const DeviceAssetEntity({
+    required this.assetId,
+    required this.hash,
+    required this.modifiedTime,
+  });
+
+  DeviceAsset toModel() => DeviceAsset(
+        assetId: assetId,
+        hash: Uint8List.fromList(hash),
+        modifiedTime: modifiedTime,
+      );
+
+  static DeviceAssetEntity fromDto(DeviceAsset dto) => DeviceAssetEntity(
+        assetId: dto.assetId,
+        hash: dto.hash,
+        modifiedTime: dto.modifiedTime,
+      );
+}