feat(mobile): people sync (#19777)

* feat(mobile): drift people sync

* merge main

---------

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

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

@@ -124,7 +124,21 @@ class DriftMemory {
 
   @override
   String toString() {
-    return 'Memory(id: $id, createdAt: $createdAt, updatedAt: $updatedAt, deletedAt: $deletedAt, ownerId: $ownerId, type: $type, data: $data, isSaved: $isSaved, memoryAt: $memoryAt, seenAt: $seenAt, showAt: $showAt, hideAt: $hideAt, assets: $assets)';
+    return '''Memory {
+    id: $id,
+    createdAt: $createdAt,
+    updatedAt: $updatedAt,
+    deletedAt: ${deletedAt ?? "<NA>"},
+    ownerId: $ownerId,
+    type: $type,
+    data: $data,
+    isSaved: $isSaved,
+    memoryAt: $memoryAt,
+    seenAt: ${seenAt ?? "<NA>"},
+    showAt: ${showAt ?? "<NA>"},
+    hideAt: ${hideAt ?? "<NA>"},
+    assets: $assets
+}''';
   }
 
   @override

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

@@ -1,7 +1,8 @@
 import 'dart:convert';
 
-class Person {
-  const Person({
+// TODO: Remove PersonDto once Isar is removed
+class PersonDto {
+  const PersonDto({
     required this.id,
     this.birthDate,
     required this.isHidden,
@@ -22,7 +23,7 @@ class Person {
     return 'Person(id: $id, birthDate: $birthDate, isHidden: $isHidden, name: $name, thumbnailPath: $thumbnailPath, updatedAt: $updatedAt)';
   }
 
-  Person copyWith({
+  PersonDto copyWith({
     String? id,
     DateTime? birthDate,
     bool? isHidden,
@@ -30,7 +31,7 @@ class Person {
     String? thumbnailPath,
     DateTime? updatedAt,
   }) {
-    return Person(
+    return PersonDto(
       id: id ?? this.id,
       birthDate: birthDate ?? this.birthDate,
       isHidden: isHidden ?? this.isHidden,
@@ -51,8 +52,8 @@ class Person {
     };
   }
 
-  factory Person.fromMap(Map<String, dynamic> map) {
-    return Person(
+  factory PersonDto.fromMap(Map<String, dynamic> map) {
+    return PersonDto(
       id: map['id'] as String,
       birthDate: map['birthDate'] != null
           ? DateTime.fromMillisecondsSinceEpoch(map['birthDate'] as int)
@@ -68,11 +69,11 @@ class Person {
 
   String toJson() => json.encode(toMap());
 
-  factory Person.fromJson(String source) =>
-      Person.fromMap(json.decode(source) as Map<String, dynamic>);
+  factory PersonDto.fromJson(String source) =>
+      PersonDto.fromMap(json.decode(source) as Map<String, dynamic>);
 
   @override
-  bool operator ==(covariant Person other) {
+  bool operator ==(covariant PersonDto other) {
     if (identical(this, other)) return true;
 
     return other.id == id &&
@@ -93,3 +94,109 @@ class Person {
         updatedAt.hashCode;
   }
 }
+
+// Model for a person stored in the server
+class Person {
+  final String id;
+  final DateTime createdAt;
+  final DateTime updatedAt;
+  final String ownerId;
+  final String name;
+  final String? faceAssetId;
+  final String thumbnailPath;
+  final bool isFavorite;
+  final bool isHidden;
+  final String? color;
+  final DateTime? birthDate;
+
+  const Person({
+    required this.id,
+    required this.createdAt,
+    required this.updatedAt,
+    required this.ownerId,
+    required this.name,
+    this.faceAssetId,
+    required this.thumbnailPath,
+    required this.isFavorite,
+    required this.isHidden,
+    required this.color,
+    this.birthDate,
+  });
+
+  Person copyWith({
+    String? id,
+    DateTime? createdAt,
+    DateTime? updatedAt,
+    String? ownerId,
+    String? name,
+    String? faceAssetId,
+    String? thumbnailPath,
+    bool? isFavorite,
+    bool? isHidden,
+    String? color,
+    DateTime? birthDate,
+  }) {
+    return Person(
+      id: id ?? this.id,
+      createdAt: createdAt ?? this.createdAt,
+      updatedAt: updatedAt ?? this.updatedAt,
+      ownerId: ownerId ?? this.ownerId,
+      name: name ?? this.name,
+      faceAssetId: faceAssetId ?? this.faceAssetId,
+      thumbnailPath: thumbnailPath ?? this.thumbnailPath,
+      isFavorite: isFavorite ?? this.isFavorite,
+      isHidden: isHidden ?? this.isHidden,
+      color: color ?? this.color,
+      birthDate: birthDate ?? this.birthDate,
+    );
+  }
+
+  @override
+  String toString() {
+    return '''Person {
+    id: $id,
+    createdAt: $createdAt,
+    updatedAt: $updatedAt,
+    ownerId: $ownerId,
+    name: $name,
+    faceAssetId: ${faceAssetId ?? "<NA>"},
+    thumbnailPath: $thumbnailPath,
+    isFavorite: $isFavorite,
+    isHidden: $isHidden,
+    color: ${color ?? "<NA>"},
+    birthDate: ${birthDate ?? "<NA>"}
+}''';
+  }
+
+  @override
+  bool operator ==(covariant Person other) {
+    if (identical(this, other)) return true;
+
+    return other.id == id &&
+        other.createdAt == createdAt &&
+        other.updatedAt == updatedAt &&
+        other.ownerId == ownerId &&
+        other.name == name &&
+        other.faceAssetId == faceAssetId &&
+        other.thumbnailPath == thumbnailPath &&
+        other.isFavorite == isFavorite &&
+        other.isHidden == isHidden &&
+        other.color == color &&
+        other.birthDate == birthDate;
+  }
+
+  @override
+  int get hashCode {
+    return id.hashCode ^
+        createdAt.hashCode ^
+        updatedAt.hashCode ^
+        ownerId.hashCode ^
+        name.hashCode ^
+        faceAssetId.hashCode ^
+        thumbnailPath.hashCode ^
+        isFavorite.hashCode ^
+        isHidden.hashCode ^
+        color.hashCode ^
+        birthDate.hashCode;
+  }
+}

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

@@ -1,5 +1,3 @@
-import 'dart:convert';
-
 // Model for a stack stored in the server
 class Stack {
   final String id;
@@ -32,34 +30,15 @@ class Stack {
     );
   }
 
-  Map<String, dynamic> toMap() {
-    return <String, dynamic>{
-      'id': id,
-      'createdAt': createdAt.millisecondsSinceEpoch,
-      'updatedAt': updatedAt.millisecondsSinceEpoch,
-      'ownerId': ownerId,
-      'primaryAssetId': primaryAssetId,
-    };
-  }
-
-  factory Stack.fromMap(Map<String, dynamic> map) {
-    return Stack(
-      id: map['id'] as String,
-      createdAt: DateTime.fromMillisecondsSinceEpoch(map['createdAt'] as int),
-      updatedAt: DateTime.fromMillisecondsSinceEpoch(map['updatedAt'] as int),
-      ownerId: map['ownerId'] as String,
-      primaryAssetId: map['primaryAssetId'] as String,
-    );
-  }
-
-  String toJson() => json.encode(toMap());
-
-  factory Stack.fromJson(String source) =>
-      Stack.fromMap(json.decode(source) as Map<String, dynamic>);
-
   @override
   String toString() {
-    return 'Stack(id: $id, createdAt: $createdAt, updatedAt: $updatedAt, ownerId: $ownerId, primaryAssetId: $primaryAssetId)';
+    return '''Stack {
+    id: $id,
+    createdAt: $createdAt,
+    updatedAt: $updatedAt,
+    ownerId: $ownerId,
+    primaryAssetId: $primaryAssetId
+}''';
   }
 
   @override

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

@@ -240,6 +240,10 @@ class SyncStreamService {
         return _syncStreamRepository.deleteUserMetadatasV1(
           data.cast(),
         );
+      case SyncEntityType.personV1:
+        return _syncStreamRepository.updatePeopleV1(data.cast());
+      case SyncEntityType.personDeleteV1:
+        return _syncStreamRepository.deletePeopleV1(data.cast());
       default:
         _logger.warning("Unknown sync data type: $type");
     }

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

@@ -0,0 +1,34 @@
+import 'package:drift/drift.dart';
+import 'package:immich_mobile/infrastructure/entities/user.entity.dart';
+import 'package:immich_mobile/infrastructure/utils/drift_default.mixin.dart';
+
+class PersonEntity extends Table with DriftDefaultsMixin {
+  const PersonEntity();
+
+  TextColumn get id => text()();
+
+  DateTimeColumn get createdAt => dateTime().withDefault(currentDateAndTime)();
+
+  DateTimeColumn get updatedAt => dateTime().withDefault(currentDateAndTime)();
+
+  TextColumn get ownerId =>
+      text().references(UserEntity, #id, onDelete: KeyAction.cascade)();
+
+  TextColumn get name => text()();
+
+  // TODO: foreign key refering to asset faces
+  TextColumn get faceAssetId => text().nullable()();
+
+  TextColumn get thumbnailPath => text()();
+
+  BoolColumn get isFavorite => boolean()();
+
+  BoolColumn get isHidden => boolean()();
+
+  TextColumn get color => text().nullable()();
+
+  DateTimeColumn get birthDate => dateTime().nullable()();
+
+  @override
+  Set<Column> get primaryKey => {id};
+}

mobile/lib/infrastructure/repositories/db.repository.dart

@@ -11,6 +11,7 @@ import 'package:immich_mobile/infrastructure/entities/local_asset.entity.dart';
 import 'package:immich_mobile/infrastructure/entities/memory.entity.dart';
 import 'package:immich_mobile/infrastructure/entities/memory_asset.entity.dart';
 import 'package:immich_mobile/infrastructure/entities/partner.entity.dart';
+import 'package:immich_mobile/infrastructure/entities/person.entity.dart';
 import 'package:immich_mobile/infrastructure/entities/remote_album.entity.dart';
 import 'package:immich_mobile/infrastructure/entities/remote_album_asset.entity.dart';
 import 'package:immich_mobile/infrastructure/entities/remote_album_user.entity.dart';
@@ -54,6 +55,7 @@ class IsarDatabaseRepository implements IDatabaseRepository {
     MemoryEntity,
     MemoryAssetEntity,
     StackEntity,
+    PersonEntity,
   ],
   include: {
     'package:immich_mobile/infrastructure/entities/merged_asset.drift',

mobile/lib/infrastructure/repositories/person.repository.dart

@@ -0,0 +1,36 @@
+import 'package:drift/drift.dart';
+import 'package:immich_mobile/domain/models/person.model.dart';
+import 'package:immich_mobile/infrastructure/entities/person.entity.drift.dart';
+import 'package:immich_mobile/infrastructure/repositories/db.repository.dart';
+
+class DriftPersonRepository extends DriftDatabaseRepository {
+  final Drift _db;
+  const DriftPersonRepository(this._db) : super(_db);
+
+  Future<List<Person>> getAll(String userId) {
+    final query = _db.personEntity.select()
+      ..where((e) => e.ownerId.equals(userId));
+
+    return query.map((person) {
+      return person.toDto();
+    }).get();
+  }
+}
+
+extension on PersonEntityData {
+  Person toDto() {
+    return Person(
+      id: id,
+      createdAt: createdAt,
+      updatedAt: updatedAt,
+      ownerId: ownerId,
+      name: name,
+      faceAssetId: faceAssetId,
+      thumbnailPath: thumbnailPath,
+      isFavorite: isFavorite,
+      isHidden: isHidden,
+      color: color,
+      birthDate: birthDate,
+    );
+  }
+}

mobile/lib/infrastructure/repositories/sync_api.repository.dart

@@ -57,6 +57,7 @@ class SyncApiRepository {
           SyncRequestType.stacksV1,
           SyncRequestType.partnerStacksV1,
           SyncRequestType.userMetadataV1,
+          SyncRequestType.peopleV1,
         ],
       ).toJson(),
     );
@@ -173,6 +174,8 @@ const _kResponseMap = <SyncEntityType, Function(Object)>{
   SyncEntityType.partnerStackDeleteV1: SyncStackDeleteV1.fromJson,
   SyncEntityType.userMetadataV1: SyncUserMetadataV1.fromJson,
   SyncEntityType.userMetadataDeleteV1: SyncUserMetadataDeleteV1.fromJson,
+  SyncEntityType.personV1: SyncPersonV1.fromJson,
+  SyncEntityType.personDeleteV1: SyncPersonDeleteV1.fromJson,
 };
 
 class _SyncAckV1 {

mobile/lib/infrastructure/repositories/sync_stream.repository.dart

@@ -9,6 +9,7 @@ import 'package:immich_mobile/infrastructure/entities/exif.entity.drift.dart';
 import 'package:immich_mobile/infrastructure/entities/memory.entity.drift.dart';
 import 'package:immich_mobile/infrastructure/entities/memory_asset.entity.drift.dart';
 import 'package:immich_mobile/infrastructure/entities/partner.entity.drift.dart';
+import 'package:immich_mobile/infrastructure/entities/person.entity.drift.dart';
 import 'package:immich_mobile/infrastructure/entities/remote_album.entity.drift.dart';
 import 'package:immich_mobile/infrastructure/entities/remote_album_asset.entity.drift.dart';
 import 'package:immich_mobile/infrastructure/entities/remote_album_user.entity.drift.dart';
@@ -511,6 +512,48 @@ class SyncStreamRepository extends DriftDatabaseRepository {
       rethrow;
     }
   }
+
+  Future<void> updatePeopleV1(Iterable<SyncPersonV1> data) async {
+    try {
+      await _db.batch((batch) {
+        for (final person in data) {
+          final companion = PersonEntityCompanion(
+            createdAt: Value(person.createdAt),
+            updatedAt: Value(person.updatedAt),
+            ownerId: Value(person.ownerId),
+            name: Value(person.name),
+            faceAssetId: Value(person.faceAssetId),
+            thumbnailPath: Value(person.thumbnailPath),
+            isFavorite: Value(person.isFavorite),
+            isHidden: Value(person.isHidden),
+            color: Value(person.color),
+            birthDate: Value(person.birthDate),
+          );
+
+          batch.insert(
+            _db.personEntity,
+            companion.copyWith(id: Value(person.id)),
+            onConflict: DoUpdate((_) => companion),
+          );
+        }
+      });
+    } catch (error, stack) {
+      _logger.severe('Error: updatePeopleV1', error, stack);
+      rethrow;
+    }
+  }
+
+  Future<void> deletePeopleV1(
+    Iterable<SyncPersonDeleteV1> data,
+  ) async {
+    try {
+      await _db.personEntity.deleteWhere(
+        (row) => row.id.isIn(data.map((e) => e.personId)),
+      );
+    } catch (error, stack) {
+      _logger.severe('Error: deletePeopleV1', error, stack);
+    }
+  }
 }
 
 extension on AssetTypeEnum {

mobile/lib/models/search/search_filter.model.dart

@@ -237,7 +237,7 @@ class SearchFilter {
   String? filename;
   String? description;
   String? language;
-  Set<Person> people;
+  Set<PersonDto> people;
   SearchLocationFilter location;
   SearchCameraFilter camera;
   SearchDateFilter date;
@@ -282,7 +282,7 @@ class SearchFilter {
     String? filename,
     String? description,
     String? language,
-    Set<Person>? people,
+    Set<PersonDto>? people,
     SearchLocationFilter? location,
     SearchCameraFilter? camera,
     SearchDateFilter? date,

mobile/lib/pages/search/search.page.dart

@@ -147,7 +147,7 @@ class SearchPage extends HookConsumerWidget {
     );
 
     showPeoplePicker() {
-      handleOnSelect(Set<Person> value) {
+      handleOnSelect(Set<PersonDto> value) {
         filter.value = filter.value.copyWith(
           people: value,
         );

mobile/lib/presentation/pages/dev/feat_in_development.page.dart

@@ -112,6 +112,7 @@ final _features = [
       await db.memoryEntity.deleteAll();
       await db.memoryAssetEntity.deleteAll();
       await db.stackEntity.deleteAll();
+      await db.personEntity.deleteAll();
     },
   ),
   _Feature(

mobile/lib/presentation/pages/dev/media_stat.page.dart

@@ -166,6 +166,10 @@ final _remoteStats = [
     name: 'Stacks',
     load: (db) => db.managers.stackEntity.count(),
   ),
+  _Stat(
+    name: 'People',
+    load: (db) => db.managers.personEntity.count(),
+  ),
 ];
 
 @RoutePage()

mobile/lib/presentation/pages/search/drift_search.page.dart

@@ -151,7 +151,7 @@ class DriftSearchPage extends HookConsumerWidget {
     );
 
     showPeoplePicker() {
-      handleOnSelect(Set<Person> value) {
+      handleOnSelect(Set<PersonDto> value) {
         filter.value = filter.value.copyWith(
           people: value,
         );

mobile/lib/providers/infrastructure/person.provider.dart

@@ -0,0 +1,7 @@
+import 'package:hooks_riverpod/hooks_riverpod.dart';
+import 'package:immich_mobile/infrastructure/repositories/person.repository.dart';
+import 'package:immich_mobile/providers/infrastructure/db.provider.dart';
+
+final driftPersonProvider = Provider<DriftPersonRepository>(
+  (ref) => DriftPersonRepository(ref.watch(driftProvider)),
+);

mobile/lib/providers/search/people.provider.dart

@@ -9,7 +9,7 @@ import 'package:riverpod_annotation/riverpod_annotation.dart';
 part 'people.provider.g.dart';
 
 @riverpod
-Future<List<Person>> getAllPeople(
+Future<List<PersonDto>> getAllPeople(
   Ref ref,
 ) async {
   final PersonService personService = ref.read(personServiceProvider);

mobile/lib/repositories/auth.repository.dart

@@ -34,6 +34,7 @@ class AuthRepository extends DatabaseRepository {
       _drift.userMetadataEntity.deleteAll(),
       _drift.partnerEntity.deleteAll(),
       _drift.stackEntity.deleteAll(),
+      _drift.personEntity.deleteAll(),
     ]);
     // Drift deletions - parent entities
     await Future.wait([

mobile/lib/repositories/person_api.repository.dart

@@ -13,19 +13,19 @@ class PersonApiRepository extends ApiRepository {
 
   PersonApiRepository(this._api);
 
-  Future<List<Person>> getAll() async {
+  Future<List<PersonDto>> getAll() async {
     final dto = await checkNull(_api.getAllPeople());
     return dto.people.map(_toPerson).toList();
   }
 
-  Future<Person> update(String id, {String? name}) async {
+  Future<PersonDto> update(String id, {String? name}) async {
     final dto = await checkNull(
       _api.updatePerson(id, PersonUpdateDto(name: name)),
     );
     return _toPerson(dto);
   }
 
-  static Person _toPerson(PersonResponseDto dto) => Person(
+  static PersonDto _toPerson(PersonResponseDto dto) => PersonDto(
         birthDate: dto.birthDate,
         id: dto.id,
         isHidden: dto.isHidden,

mobile/lib/services/person.service.dart

@@ -28,7 +28,7 @@ class PersonService {
     this._assetRepository,
   );
 
-  Future<List<Person>> getAllPeople() async {
+  Future<List<PersonDto>> getAllPeople() async {
     try {
       return await _personApiRepository.getAll();
     } catch (error, stack) {
@@ -48,7 +48,7 @@ class PersonService {
     return [];
   }
 
-  Future<Person?> updateName(String id, String name) async {
+  Future<PersonDto?> updateName(String id, String name) async {
     try {
       return await _personApiRepository.update(id, name: name);
     } catch (error, stack) {

mobile/lib/widgets/search/search_filter/people_picker.dart

@@ -14,8 +14,8 @@ import 'package:immich_mobile/widgets/common/search_field.dart';
 class PeoplePicker extends HookConsumerWidget {
   const PeoplePicker({super.key, required this.onSelect, this.filter});
 
-  final Function(Set<Person>) onSelect;
-  final Set<Person>? filter;
+  final Function(Set<PersonDto>) onSelect;
+  final Set<PersonDto>? filter;
 
   @override
   Widget build(BuildContext context, WidgetRef ref) {
@@ -24,7 +24,7 @@ class PeoplePicker extends HookConsumerWidget {
     final searchQuery = useState('');
     final people = ref.watch(getAllPeopleProvider);
     final headers = ApiService.getRequestHeaders();
-    final selectedPeople = useState<Set<Person>>(filter ?? {});
+    final selectedPeople = useState<Set<PersonDto>>(filter ?? {});
 
     return Column(
       children: [

mobile/test/domain/services/sync_stream_service_test.dart

@@ -105,6 +105,10 @@ void main() {
         .thenAnswer(successHandler);
     when(() => mockSyncStreamRepo.deleteUserMetadatasV1(any()))
         .thenAnswer(successHandler);
+    when(() => mockSyncStreamRepo.updatePeopleV1(any()))
+        .thenAnswer(successHandler);
+    when(() => mockSyncStreamRepo.deletePeopleV1(any()))
+        .thenAnswer(successHandler);
 
     sut = SyncStreamService(
       syncApiRepository: mockSyncApiRepo,